Doc: subdivide System Information Functions and Operators.
authorTom Lane <tgl@sss.pgh.pa.us>
Wed, 7 Dec 2022 18:56:48 +0000 (13:56 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Wed, 7 Dec 2022 18:56:48 +0000 (13:56 -0500)
Provide <sect2> subdivisions in 9.26 System Information Functions and
Operators.  This is useful because it adds a mini-TOC at the top of
the page to aid jumping to portions of what's become quite a long
section.  Also, now that several of the subsections contain multiple
tables, it's hard to see the overall structure without headings.

Discussion: https://postgr.es/m/4026789.1670426602@sss.pgh.pa.us

doc/src/sgml/func.sgml

index 2052d3c84452cd5ea5745cbe1eb1fd83b6930635..e57ffce9713d2f47741ae1a123599cded8dc923b 100644 (file)
@@ -22168,6 +22168,14 @@ SELECT * FROM pg_ls_dir('.') WITH ORDINALITY AS t(ls,n);
  <sect1 id="functions-info">
   <title>System Information Functions and Operators</title>
 
+   <para>
+    The functions described in this section are used to obtain various
+    information about a <productname>PostgreSQL</productname> installation.
+   </para>
+
+  <sect2 id="functions-info-session">
+   <title>Session Information Functions</title>
+
   <para>
    <xref linkend="functions-info-session-table"/> shows several
    functions that extract session and system information.
@@ -22711,6 +22719,11 @@ SELECT * FROM pg_ls_dir('.') WITH ORDINALITY AS t(ls,n);
     does not, since it unifies users and roles into a single kind of entity.)
    </para>
 
+  </sect2>
+
+  <sect2 id="functions-info-access">
+   <title>Access Privilege Inquiry Functions</title>
+
   <indexterm>
    <primary>privilege</primary>
    <secondary>querying</secondary>
@@ -23256,6 +23269,11 @@ SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');
     </tgroup>
    </table>
 
+  </sect2>
+
+  <sect2 id="functions-info-schema">
+   <title>Schema Visibility Inquiry Functions</title>
+
   <para>
    <xref linkend="functions-info-schema-table"/> shows functions that
    determine whether a certain object is <firstterm>visible</firstterm> in the
@@ -23483,6 +23501,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
     type name in this way &mdash; if the name can be recognized at all, it must be visible.
    </para>
 
+  </sect2>
+
+  <sect2 id="functions-info-catalog">
+   <title>System Catalog Information Functions</title>
+
   <para>
    <xref linkend="functions-info-catalog-table"/> lists functions that
    extract information from the system catalogs.
@@ -24421,6 +24444,11 @@ SELECT collation for ('foo' COLLATE "de_DE");
    </tgroup>
   </table>
 
+  </sect2>
+
+  <sect2 id="functions-info-object">
+   <title>Object Information and Addressing Functions</title>
+
   <para>
    <xref linkend="functions-info-object-table"/> lists functions related to
    database object identification and addressing.
@@ -24554,6 +24582,11 @@ SELECT collation for ('foo' COLLATE "de_DE");
     </tgroup>
    </table>
 
+  </sect2>
+
+  <sect2 id="functions-info-comment">
+   <title>Comment Information Functions</title>
+
    <indexterm>
     <primary>comment</primary>
     <secondary sortas="database objects">about database objects</secondary>
@@ -24648,6 +24681,11 @@ SELECT collation for ('foo' COLLATE "de_DE");
     </tgroup>
    </table>
 
+  </sect2>
+
+  <sect2 id="functions-info-snapshot">
+   <title>Transaction ID and Snapshot Information Functions</title>
+
    <para>
     The functions shown in <xref linkend="functions-pg-snapshot"/>
     provide server transaction information in an exportable form.  The main
@@ -25003,6 +25041,11 @@ SELECT collation for ('foo' COLLATE "de_DE");
     </tgroup>
    </table>
 
+  </sect2>
+
+  <sect2 id="functions-info-commit-timestamp">
+   <title>Committed Transaction Information Functions</title>
+
    <para>
     The functions shown in <xref linkend="functions-commit-timestamp"/>
     provide information about when past transactions were committed.
@@ -25075,6 +25118,11 @@ SELECT collation for ('foo' COLLATE "de_DE");
     </tgroup>
    </table>
 
+  </sect2>
+
+  <sect2 id="functions-info-controldata">
+   <title>Control Data Functions</title>
+
    <para>
     The functions shown in <xref linkend="functions-controldata"/>
     print information initialized during <command>initdb</command>, such
@@ -25413,6 +25461,8 @@ SELECT collation for ('foo' COLLATE "de_DE");
     </tgroup>
    </table>
 
+  </sect2>
+
   </sect1>
 
   <sect1 id="functions-admin">