doc: Make SQL command names in the catalog documentation links
authorPeter Eisentraut
Thu, 3 Sep 2020 11:15:53 +0000 (13:15 +0200)
committerPeter Eisentraut
Thu, 3 Sep 2020 11:17:22 +0000 (13:17 +0200)
In passing, fix the initdb references to be  rather than
, which is what we normally use.

Author: Dagfinn Ilmari Mannsåker 
Discussion: https://www.postgresql.org/message-id/flat/[email protected]

doc/src/sgml/catalogs.sgml

index 85084a7c2333a09eabd3b95125937dc4095a34cd..508bea3bc6442a083bb345f12d9ef0a2c39c0c09 100644 (file)
@@ -1966,9 +1966,9 @@ SCRAM-SHA-256$<iteration count>:&l
       
        Size of the on-disk representation of this table in pages (of size
        BLCKSZ).  This is only an estimate used by the
-       planner.  It is updated by <command>VACUUM>,
-       <command>ANALYZE>, and a few DDL commands such as
-       <command>CREATE INDEX>.
+       planner.  It is updated by <xref linkend="sql-vacuum"/>,
+       <xref linkend="sql-analyze"/>, and a few DDL commands such as
+       <xref linkend="sql-createindex"/>.
       
      
 
@@ -1978,9 +1978,9 @@ SCRAM-SHA-256$<iteration count>:&l
       
       
        Number of live rows in the table.  This is only an estimate used by
-       the planner.  It is updated by <command>VACUUM>,
-       <command>ANALYZE>, and a few DDL commands such as
-       <command>CREATE INDEX>.
+       the planner.  It is updated by <xref linkend="sql-vacuum"/>,
+       <xref linkend="sql-analyze"/>, and a few DDL commands such as
+       <xref linkend="sql-createindex"/>.
        If the table has never yet been vacuumed or
        analyzed, reltuples
        contains -1 indicating that the row count is
@@ -1995,9 +1995,9 @@ SCRAM-SHA-256$<iteration count>:&l
       
        Number of pages that are marked all-visible in the table's
        visibility map.  This is only an estimate used by the
-       planner.  It is updated by <command>VACUUM>,
-       <command>ANALYZE>, and a few DDL commands such as
-       <command>CREATE INDEX>.
+       planner.  It is updated by <xref linkend="sql-vacuum"/>,
+       <xref linkend="sql-analyze"/>, and a few DDL commands such as
+       <xref linkend="sql-createindex"/>.
       
      
 
@@ -2241,8 +2241,8 @@ SCRAM-SHA-256$<iteration count>:&l
    lazily: they are guaranteed to be true if that's the correct state, but
    may not be reset to false immediately when the condition is no longer
    true.  For example, relhasindex is set by
-   <command>CREATE INDEX>, but it is never cleared by
-   <command>DROP INDEX.  Instead, VACUUM> clears
+   <xref linkend="sql-createindex"/>, but it is never cleared by
+   <xref linkend="sql-dropindex"/>.  Instead, > clears
    relhasindex if it finds the table has no indexes.  This
    arrangement avoids race conditions and improves concurrency.
   
@@ -2419,8 +2419,8 @@ SCRAM-SHA-256$<iteration count>:&l
   
 
   
-   User-defined constraint triggers (created with <command>CREATE CONSTRAINT
-   TRIGGER>) also give rise to an entry in this table.
+   User-defined constraint triggers (created with <link linkend="sql-createtrigger">
+   CREATE CONSTRAINT TRIGGER>) also give rise to an entry in this table.
   
 
   
@@ -3425,7 +3425,7 @@ SCRAM-SHA-256$<iteration count>:&l
        the referenced object (see
        pg_extension).
        The dependent object can be dropped only via
-       <command>DROP EXTENSION> on the referenced object.
+       <xref linkend="sql-dropextension"/> on the referenced object.
        Functionally this dependency type acts the same as
        an INTERNAL dependency, but it's kept separate for
        clarity and to simplify pg_dump.
@@ -3456,7 +3456,7 @@ SCRAM-SHA-256$<iteration count>:&l
        There is no dependent object; this type of entry is a signal
        that the system itself depends on the referenced object, and so
        that object must never be deleted.  Entries of this type are
-       created only by <command>initdb>.  The columns for the
+       created only by <application>initdb>.  The columns for the
        dependent object contain zeroes.
       
      
@@ -4285,7 +4285,7 @@ SCRAM-SHA-256$<iteration count>:&l
       
        If true, the index is currently valid for queries.  False means the
        index is possibly incomplete: it must still be modified by
-       <command>INSERT/UPDATE> operations, but it cannot safely
+       <xref linkend="sql-insert"/>/> operations, but it cannot safely
        be used for queries. If it is unique, the uniqueness property is not
        guaranteed true either.
       
@@ -4309,7 +4309,7 @@ SCRAM-SHA-256$<iteration count>:&l
       
       
        If true, the index is currently ready for inserts.  False means the
-       index must be ignored by <command>INSERT/UPDATE>
+       index must be ignored by <xref linkend="sql-insert"/>/>
        operations.
       
      
@@ -4330,8 +4330,8 @@ SCRAM-SHA-256$<iteration count>:&l
       
       
        If true this index has been chosen as replica identity
-       using <command>ALTER TABLE ... REPLICA IDENTITY USING INDEX
-       ...>
+       using <link linkend="sql-altertable-replica-identity">ALTER TABLE ...
+       REPLICA IDENTITY USING INDEX ...>
       
      
 
@@ -4504,11 +4504,11 @@ SCRAM-SHA-256$<iteration count>:&l
   
    Objects can have initial privileges either by having those privileges set
    when the system is initialized (by initdb) or when the
-   object is created during a <command>CREATE EXTENSION> and the
-   extension script sets initial privileges using the <command>GRANT>
+   object is created during a <xref linkend="sql-createextension"/> and the
+   extension script sets initial privileges using the <xref linkend="sql-grant"/>
    system.  Note that the system will automatically handle recording of the
    privileges during the extension script and that extension authors need
-   only use the <command>GRANT and REVOKE>
+   only use the <xref linkend="sql-grant"/> and >
    statements in their script to have the privileges recorded.  The
    privtype column indicates if the initial privilege was
    set by initdb or during a
@@ -5564,10 +5564,10 @@ SCRAM-SHA-256$<iteration count>:&l
       
       
        The command type to which the policy is applied:
-       r for <command>SELECT>,
-       a for <command>INSERT>,
-       w for <command>UPDATE>,
-       d for <command>DELETE>,
+       r for <xref linkend="sql-select"/>,
+       a for <xref linkend="sql-insert"/>,
+       w for <xref linkend="sql-update"/>,
+       d for <xref linkend="sql-delete"/>,
        or * for all
       
      
@@ -6075,7 +6075,7 @@ SCRAM-SHA-256$<iteration count>:&l
        pubinsert bool
       
       
-       If true, <command>INSERT> operations are replicated for
+       If true, <xref linkend="sql-insert"/> operations are replicated for
        tables in the publication.
       
      
@@ -6085,7 +6085,7 @@ SCRAM-SHA-256$<iteration count>:&l
        pubupdate bool
       
       
-       If true, <command>UPDATE> operations are replicated for
+       If true, <xref linkend="sql-update"/> operations are replicated for
        tables in the publication.
       
      
@@ -6095,7 +6095,7 @@ SCRAM-SHA-256$<iteration count>:&l
        pubdelete bool
       
       
-       If true, <command>DELETE> operations are replicated for
+       If true, <xref linkend="sql-delete"/> operations are replicated for
        tables in the publication.
       
      
@@ -6105,7 +6105,7 @@ SCRAM-SHA-256$<iteration count>:&l
        pubtruncate bool
       
       
-       If true, <command>TRUNCATE> operations are replicated for
+       If true, <xref linkend="sql-truncate"/> operations are replicated for
        tables in the publication.
       
      
@@ -6408,9 +6408,9 @@ SCRAM-SHA-256$<iteration count>:&l
        ev_type char
       
       
-       Event type that the rule is for: 1 = <command>SELECT>, 2 =
-       <command>UPDATE, 3 = INSERT>, 4 =
-       <command>DELETE>
+       Event type that the rule is for: 1 = <xref linkend="sql-select"/>, 2 =
+       <xref linkend="sql-update"/>, 3 = >, 4 =
+       <xref linkend="sql-delete"/>
       
      
 
@@ -6832,7 +6832,7 @@ SCRAM-SHA-256$<iteration count>:&l
        There is no dependent object; this type of entry is a signal
        that the system itself depends on the referenced object, and so
        that object must never be deleted.  Entries of this type are
-       created only by <command>initdb>.  The columns for the
+       created only by <application>initdb>.  The columns for the
        dependent object contain zeroes.
       
      
@@ -7336,9 +7336,9 @@ SCRAM-SHA-256$<iteration count>:&l
 
   
    The pg_statistic_ext entry is filled in
-   completely during <command>CREATE STATISTICS>, but the actual
+   completely during <xref linkend="sql-createstatistics"/>, but the actual
    statistical values are not computed then.
-   Subsequent <command>ANALYZE> commands compute the desired values
+   Subsequent <xref linkend="sql-analyze"/> commands compute the desired values
    and populate an entry in the
    pg_statistic_ext_data
    catalog.
@@ -7590,8 +7590,9 @@ SCRAM-SHA-256$<iteration count>:&l
 
   
    This catalog only contains tables known to the subscription after running
-   either CREATE SUBSCRIPTION or
-   ALTER SUBSCRIPTION ... REFRESH PUBLICATION.
+   either  or
+   ALTER SUBSCRIPTION ... REFRESH
+   PUBLICATION.
   
 
   
@@ -8837,7 +8838,7 @@ SCRAM-SHA-256$<iteration count>:&l
        (references pg_proc.oid)
       
       
-       Custom <command>ANALYZE> function, or 0 to use the standard function
+       Custom <xref linkend="sql-analyze"/> function, or 0 to use the standard function
       
      
 
@@ -10324,7 +10325,7 @@ SCRAM-SHA-256$<iteration count>:&l
        indexdef text
       
       
-       Index definition (a reconstructed <command>CREATE INDEX>
+       Index definition (a reconstructed <xref linkend="sql-createindex"/>
        command)
       
      
@@ -10779,7 +10780,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        definition text
       
       
-       Materialized view definition (a reconstructed <command>SELECT> query)
+       Materialized view definition (a reconstructed <xref linkend="sql-select"/> query)
       
      
     
@@ -10949,7 +10950,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
       
        The query string submitted by the client to create this
        prepared statement. For prepared statements created via SQL,
-       this is the <command>PREPARE> statement submitted by
+       this is the <xref linkend="sql-prepare"/> statement submitted by
        the client. For prepared statements created via the
        frontend/backend protocol, this is the text of the prepared
        statement itself.
@@ -10983,7 +10984,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
       
       
        true if the prepared statement was created
-       via the <command>PREPARE> SQL command;
+       via the <xref linkend="sql-prepare"/> SQL command;
        false if the statement was prepared via the
        frontend/backend protocol
       
@@ -12114,7 +12115,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        reset_val text
       
       
-       Value that <command>RESET> would reset the parameter to
+       Value that <xref linkend="sql-reset"/> would reset the parameter to
        in the current session
       
      
@@ -12172,7 +12173,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
       These settings cannot be changed directly; they reflect internally
       determined values.  Some of them may be adjustable by rebuilding the
       server with different configuration options, or by changing options
-      supplied to <command>initdb>.
+      supplied to <application>initdb>.
      
     
    
@@ -12247,7 +12248,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
     
      
       These settings can be set from postgresql.conf,
-      or within a session via the <command>SET> command; but only superusers
+      or within a session via the <xref linkend="sql-set"/> command; but only superusers
       can change them via SET.  Changes in
       postgresql.conf will affect existing sessions
       only if no session-local value has been established with SET.
@@ -12260,7 +12261,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
     
      
       These settings can be set from postgresql.conf,
-      or within a session via the <command>SET> command.  Any user is
+      or within a session via the <xref linkend="sql-set"/> command.  Any user is
       allowed to change their session-local value.  Changes in
       postgresql.conf will affect existing sessions
       only if no session-local value has been established with SET.
@@ -12276,7 +12277,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
   
    The pg_settings view cannot be inserted into or
-   deleted from, but it can be updated.  An <command>UPDATE> applied
+   deleted from, but it can be updated.  An <xref linkend="sql-update"/> applied
    to a row of pg_settings is equivalent to executing
    the  command on that named
    parameter. The change only affects the value used by the current
@@ -12620,7 +12621,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        If greater than zero, the estimated number of distinct values in the
        column.  If less than zero, the negative of the number of distinct
        values divided by the number of rows.  (The negated form is used when
-       <command>ANALYZE> believes that the number of distinct values is
+       <xref linkend="sql-analyze"/> believes that the number of distinct values is
        likely to increase as the table grows; the positive form is used when
        the column seems to have a fixed number of possible values.)  For
        example, -1 indicates a unique column in which the number of distinct
@@ -12718,7 +12719,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
   
    The maximum number of entries in the array fields can be controlled on a
-   column-by-column basis using the ALTER TABLE SET STATISTICS
+   column-by-column basis using the ALTER
+   TABLE SET STATISTICS
    command, or globally by setting the
     run-time parameter.
   
@@ -12843,7 +12845,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        than zero, the estimated number of distinct values in the combination.
        If less than zero, the negative of the number of distinct values divided
        by the number of rows.
-       (The negated form is used when <command>ANALYZE> believes that
+       (The negated form is used when <xref linkend="sql-analyze"/> believes that
        the number of distinct values is likely to increase as the table grows;
        the positive form is used when the column seems to have a fixed number
        of possible values.)  For example, -1 indicates a unique combination of
@@ -12908,8 +12910,8 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
 
   
    The maximum number of entries in the array fields can be controlled on a
-   column-by-column basis using the <command>ALTER TABLE SET STATISTICS
-   command, or globally by setting the
+   column-by-column basis using the <link linkend="sql-altertable">ALTER
+   TABLE SET STATISTICS command, or globally by setting the
     run-time parameter.
   
 
@@ -13471,7 +13473,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
        definition text
       
       
-       View definition (a reconstructed <command>SELECT> query)
+       View definition (a reconstructed <xref linkend="sql-select"/> query)