From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Fri, 28 Jan 2005 23:13:26 +0000 (+0000)
Subject: Add documentation for format_type(), which somehow escaped it before.
X-Git-Tag: REL8_0_1~9
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=d8595c9850fda5d1b40b0dc84bd818d80dc1d37e;p=thirdparty%2Fpostgresql.git

Add documentation for format_type(), which somehow escaped it before.
---

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index d427d5026a3..927d72d14b3 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.234.4.2 2005/01/26 20:42:26 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.234.4.3 2005/01/28 23:13:26 tgl Exp $
 PostgreSQL documentation
 -->
 
@@ -8505,6 +8505,10 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
     this way &mdash; if the name can be recognized at all, it must be visible.
    </para>
 
+   <indexterm zone="functions-info">
+    <primary>format_type</primary>
+   </indexterm>
+
    <indexterm zone="functions-info">
     <primary>pg_get_viewdef</primary>
    </indexterm>
@@ -8554,6 +8558,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
      </thead>
 
      <tbody>
+      <row>
+       <entry><literal><function>format_type</function>(<parameter>type_oid</parameter>, <parameter>typemod</>)</literal></entry>
+       <entry><type>text</type></entry>
+       <entry>get SQL name of a data type</entry>
+      </row>
       <row>
        <entry><literal><function>pg_get_viewdef</function>(<parameter>view_name</parameter>)</literal></entry>
        <entry><type>text</type></entry>
@@ -8643,6 +8652,12 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
     </tgroup>
    </table>
 
+  <para>
+   <function>format_type</function> returns the SQL name of a data type that
+   is identified by its type OID and possibly a type modifier.  Pass NULL
+   for the type modifier if no specific modifier is known.
+  </para>
+
   <para>
    <function>pg_get_viewdef</function>,
    <function>pg_get_ruledef</function>,