Doc: fix assorted misstatements of fact in catalog & system view docs.
authorTom Lane <tgl@sss.pgh.pa.us>
Sat, 9 May 2020 23:09:44 +0000 (19:09 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Sat, 9 May 2020 23:09:44 +0000 (19:09 -0400)
I made up a very crude hack to compare the docs with reality (as
embodied in the system catalogs) ... and indeed they don't match
everywhere.  Missing oid columns, wrong data types, wrong "references"
links, columns listed in the wrong order.  None of this seems quite
important enough to back-patch.

doc/src/sgml/catalogs.sgml
doc/src/sgml/information_schema.sgml
doc/src/sgml/monitoring.sgml

index ce33df9e581963abcd47c546071699b4de954655..fcadba331db55d81d523d185741e65a8ae8d698a 100644 (file)
@@ -3312,6 +3312,13 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
     </thead>
 
     <tbody>
+     <row>
+      <entry><structfield>oid</structfield></entry>
+      <entry><type>oid</type></entry>
+      <entry></entry>
+      <entry>Row identifier</entry>
+     </row>
+
      <row>
       <entry><structfield>evtname</structfield></entry>
       <entry><type>name</type></entry>
@@ -4879,7 +4886,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
      <row>
       <entry><structfield>partcollation</structfield></entry>
       <entry><type>oidvector</type></entry>
-      <entry><literal><link linkend="catalog-pg-opclass"><structname>pg_opclass</structname></link>.oid</literal></entry>
+      <entry><literal><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link>.oid</literal></entry>
       <entry>
        For each column in the partition key, this contains the OID of the
        collation to use for partitioning, or zero if the column is not
@@ -4938,6 +4945,13 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
     </thead>
 
     <tbody>
+     <row>
+      <entry><structfield>oid</structfield></entry>
+      <entry><type>oid</type></entry>
+      <entry></entry>
+      <entry>Row identifier</entry>
+     </row>
+
      <row>
       <entry><structfield>polname</structfield></entry>
       <entry><type>name</type></entry>
@@ -5480,6 +5494,13 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
     </thead>
 
     <tbody>
+     <row>
+      <entry><structfield>oid</structfield></entry>
+      <entry><type>oid</type></entry>
+      <entry></entry>
+      <entry>Row identifier</entry>
+     </row>
+
      <row>
       <entry><structfield>prpubid</structfield></entry>
       <entry><type>oid</type></entry>
@@ -6432,6 +6453,13 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
 
     <tbody>
 
+     <row>
+      <entry><structfield>oid</structfield></entry>
+      <entry><type>oid</type></entry>
+      <entry></entry>
+      <entry>Row identifier</entry>
+     </row>
+
      <row>
       <entry><structfield>stxrelid</structfield></entry>
       <entry><type>oid</type></entry>
@@ -6677,16 +6705,6 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
       <entry>If true, the subscription is enabled and should be replicating.</entry>
      </row>
 
-     <row>
-      <entry><structfield>subsynccommit</structfield></entry>
-      <entry><type>text</type></entry>
-      <entry></entry>
-      <entry>
-       Contains the value of the <varname>synchronous_commit</varname>
-       setting for the subscription workers.
-      </entry>
-     </row>
-
      <row>
       <entry><structfield>subconninfo</structfield></entry>
       <entry><type>text</type></entry>
@@ -6702,6 +6720,16 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
        for local replication origin name.</entry>
      </row>
 
+     <row>
+      <entry><structfield>subsynccommit</structfield></entry>
+      <entry><type>text</type></entry>
+      <entry></entry>
+      <entry>
+       Contains the value of the <varname>synchronous_commit</varname>
+       setting for the subscription workers.
+      </entry>
+     </row>
+
      <row>
       <entry><structfield>subpublications</structfield></entry>
       <entry><type>text[]</type></entry>
@@ -6894,6 +6922,13 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
     </thead>
 
     <tbody>
+     <row>
+      <entry><structfield>oid</structfield></entry>
+      <entry><type>oid</type></entry>
+      <entry></entry>
+      <entry>Row identifier</entry>
+     </row>
+
      <row>
       <entry><structfield>trftype</structfield></entry>
       <entry><type>oid</type></entry>
@@ -9447,7 +9482,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
       <entry>Name of policy</entry>
      </row>
      <row>
-      <entry><structfield>polpermissive</structfield></entry>
+      <entry><structfield>permissive</structfield></entry>
       <entry><type>text</type></entry>
       <entry></entry>
       <entry>Is the policy permissive or restrictive?</entry>
@@ -9844,7 +9879,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>database</structfield></entry>
-      <entry><type>text</type></entry>
+      <entry><type>name</type></entry>
       <entry><literal><link linkend="catalog-pg-database"><structname>pg_database</structname></link>.datname</literal></entry>
       <entry>The name of the database this slot is associated with, or
       null. Only logical slots have an associated database.</entry>
@@ -10297,7 +10332,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
      <row>
       <entry><structfield>data_type</structfield></entry>
       <entry><type>regtype</type></entry>
-      <entry><literal><link linkend="catalog-pg-authid"><structname>pg_type</structname></link>.oid</literal></entry>
+      <entry><literal><link linkend="catalog-pg-type"><structname>pg_type</structname></link>.oid</literal></entry>
       <entry>Data type of the sequence</entry>
      </row>
      <row>
@@ -11075,8 +11110,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>statistics_owner</structfield></entry>
-      <entry><type>oid</type></entry>
-      <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.oid</literal></entry>
+      <entry><type>name</type></entry>
+      <entry><literal><link linkend="catalog-pg-authid"><structname>pg_authid</structname></link>.rolname</literal></entry>
       <entry>Owner of the extended statistics</entry>
      </row>
 
@@ -11089,7 +11124,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>kinds</structfield></entry>
-      <entry><type>text[]</type></entry>
+      <entry><type>char[]</type></entry>
       <entry></entry>
       <entry>Types of extended statistics enabled for this record</entry>
      </row>
@@ -11120,7 +11155,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>most_common_vals</structfield></entry>
-      <entry><type>anyarray</type></entry>
+      <entry><type>text[]</type></entry>
       <entry></entry>
       <entry>
        A list of the most common combinations of values in the columns.
@@ -11130,7 +11165,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>most_common_val_nulls</structfield></entry>
-      <entry><type>anyarray</type></entry>
+      <entry><type>bool[]</type></entry>
       <entry></entry>
       <entry>
        A list of NULL flags for the most common combinations of values.
@@ -11140,7 +11175,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>most_common_freqs</structfield></entry>
-      <entry><type>real[]</type></entry>
+      <entry><type>float8[]</type></entry>
       <entry></entry>
       <entry>
        A list of the frequencies of the most common combinations,
@@ -11151,7 +11186,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
      <row>
       <entry><structfield>most_common_base_freqs</structfield></entry>
-      <entry><type>real[]</type></entry>
+      <entry><type>float8[]</type></entry>
       <entry></entry>
       <entry>
        A list of the base frequencies of the most common combinations,
index 7a995a1b64998d2f7df0df786069892092779cb6..3b32f0ae8121f92e8184875bda9a014e9131e44c 100644 (file)
@@ -4498,7 +4498,7 @@ ORDER BY c.ordinal_position;
 
      <row>
       <entry><literal>result_cast_char_octet_length</literal></entry>
-      <entry><type>character_data</type></entry>
+      <entry><type>cardinal_number</type></entry>
       <entry>Applies to a feature not available in <productname>PostgreSQL</productname></entry>
      </row>
 
@@ -4558,7 +4558,7 @@ ORDER BY c.ordinal_position;
 
      <row>
       <entry><literal>result_cast_datetime_precision</literal></entry>
-      <entry><type>character_data</type></entry>
+      <entry><type>cardinal_number</type></entry>
       <entry>Applies to a feature not available in <productname>PostgreSQL</productname></entry>
      </row>
 
index 6eb4df1d2e9d43841664bfeb1876cf8d1c0950b6..579ccd34d4f418a92c14e47f049d110ee5bc65b0 100644 (file)
@@ -2043,11 +2043,6 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
      <entry><type>timestamp with time zone</type></entry>
      <entry>Send time of last reply message received from standby server</entry>
     </row>
-    <row>
-     <entry><structfield>spill_bytes</structfield></entry>
-     <entry><type>bigint</type></entry>
-     <entry>Amount of decoded transaction data spilled to disk.</entry>
-    </row>
     <row>
      <entry><structfield>spill_txns</structfield></entry>
      <entry><type>bigint</type></entry>
@@ -2063,6 +2058,11 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
       may get spilled repeatedly, and this counter gets incremented on every
       such invocation.</entry>
     </row>
+    <row>
+     <entry><structfield>spill_bytes</structfield></entry>
+     <entry><type>bigint</type></entry>
+     <entry>Amount of decoded transaction data spilled to disk.</entry>
+    </row>
    </tbody>
    </tgroup>
   </table>
@@ -2242,7 +2242,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
     </row>
     <row>
      <entry><structfield>subname</structfield></entry>
-     <entry><type>text</type></entry>
+     <entry><type>name</type></entry>
      <entry>Name of the subscription</entry>
     </row>
     <row>
@@ -3294,7 +3294,7 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    <tbody>
     <row>
      <entry><structfield>name</structfield></entry>
-     <entry><type>name</type></entry>
+     <entry><type>text</type></entry>
      <entry>name of the SLRU</entry>
     </row>
     <row>