Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 750d917

Browse files
committed
Add documentation for format_type(), which somehow escaped it before.
1 parent a9fec25 commit 750d917

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

doc/src/sgml/func.sgml

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.236 2005/01/26 20:42:19 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.237 2005/01/28 23:12:59 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -8505,6 +8505,10 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
85058505
this way &mdash; if the name can be recognized at all, it must be visible.
85068506
</para>
85078507

8508+
<indexterm zone="functions-info">
8509+
<primary>format_type</primary>
8510+
</indexterm>
8511+
85088512
<indexterm zone="functions-info">
85098513
<primary>pg_get_viewdef</primary>
85108514
</indexterm>
@@ -8554,6 +8558,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
85548558
</thead>
85558559

85568560
<tbody>
8561+
<row>
8562+
<entry><literal><function>format_type</function>(<parameter>type_oid</parameter>, <parameter>typemod</>)</literal></entry>
8563+
<entry><type>text</type></entry>
8564+
<entry>get SQL name of a data type</entry>
8565+
</row>
85578566
<row>
85588567
<entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>)</literal></entry>
85598568
<entry><type>text</type></entry>
@@ -8643,6 +8652,12 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
86438652
</tgroup>
86448653
</table>
86458654

8655+
<para>
8656+
<function>format_type</function> returns the SQL name of a data type that
8657+
is identified by its type OID and possibly a type modifier. Pass NULL
8658+
for the type modifier if no specific modifier is known.
8659+
</para>
8660+
86468661
<para>
86478662
<function>pg_get_viewdef</function>,
86488663
<function>pg_get_ruledef</function>,

0 commit comments

Comments
 (0)