]> granicus.if.org Git - postgresql/commitdiff
Doc: Fix various inconsistencies
authorMichael Paquier <michael@paquier.xyz>
Wed, 16 Oct 2019 04:09:52 +0000 (13:09 +0900)
committerMichael Paquier <michael@paquier.xyz>
Wed, 16 Oct 2019 04:09:52 +0000 (13:09 +0900)
This fixes multiple areas of the documentation:
- COPY for its past compatibility section.
- SET ROLE mentioning INHERITS instead of INHERIT
- PREPARE referring to stmt_name, that is not present.
- Extension documentation about format name with upgrade scripts.

Backpatch down to 9.4 for the relevant parts.

Author: Alexander Lakhin
Discussion: https://postgr.es/m/bf95233a-9943-b341-e2ff-a860c28af481@gmail.com
Backpatch-through: 9.4

doc/src/sgml/extend.sgml
doc/src/sgml/ref/copy.sgml
doc/src/sgml/ref/prepare.sgml
doc/src/sgml/ref/set_role.sgml

index 8dc2b893f7eb353821fab83866e1c1087a36e024..a3046f22d050f8f356d07a22a7d22419a18f5f3c 100644 (file)
@@ -856,7 +856,7 @@ SELECT pg_catalog.pg_extension_config_dump('my_config', 'WHERE NOT standard_entr
      dynamically from one version to the next, you should provide
      <firstterm>update scripts</firstterm> that make the necessary changes to go from
      one version to the next.  Update scripts have names following the pattern
-     <literal><replaceable>extension</replaceable>--<replaceable>oldversion</replaceable>--<replaceable>newversion</replaceable>.sql</literal>
+     <literal><replaceable>extension</replaceable>--<replaceable>old_version</replaceable>--<replaceable>target_version</replaceable>.sql</literal>
      (for example, <literal>foo--1.0--1.1.sql</literal> contains the commands to modify
      version <literal>1.0</literal> of extension <literal>foo</literal> into version
      <literal>1.1</literal>).
index 5e2992ddacc5f42a9d1fd98011fd6acaaa0416cc..3e6f9cd5324b39ca1ed4f9e684a4ea12900ab4ed 100644 (file)
@@ -1015,22 +1015,22 @@ COPY <replaceable class="parameter">table_name</replaceable> [ ( <replaceable cl
     FROM { '<replaceable class="parameter">filename</replaceable>' | STDIN }
     [ [ WITH ]
           [ BINARY ]
-          [ DELIMITER [ AS ] '<replaceable class="parameter">delimiter</replaceable>' ]
-          [ NULL [ AS ] '<replaceable class="parameter">null string</replaceable>' ]
+          [ DELIMITER [ AS ] '<replaceable class="parameter">delimiter_character</replaceable>' ]
+          [ NULL [ AS ] '<replaceable class="parameter">null_string</replaceable>' ]
           [ CSV [ HEADER ]
-                [ QUOTE [ AS ] '<replaceable class="parameter">quote</replaceable>' ]
-                [ ESCAPE [ AS ] '<replaceable class="parameter">escape</replaceable>' ]
+                [ QUOTE [ AS ] '<replaceable class="parameter">quote_character</replaceable>' ]
+                [ ESCAPE [ AS ] '<replaceable class="parameter">escape_character</replaceable>' ]
                 [ FORCE NOT NULL <replaceable class="parameter">column_name</replaceable> [, ...] ] ] ]
 
 COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable class="parameter">column_name</replaceable> [, ...] ) ] | ( <replaceable class="parameter">query</replaceable> ) }
     TO { '<replaceable class="parameter">filename</replaceable>' | STDOUT }
     [ [ WITH ]
           [ BINARY ]
-          [ DELIMITER [ AS ] '<replaceable class="parameter">delimiter</replaceable>' ]
-          [ NULL [ AS ] '<replaceable class="parameter">null string</replaceable>' ]
+          [ DELIMITER [ AS ] '<replaceable class="parameter">delimiter_character</replaceable>' ]
+          [ NULL [ AS ] '<replaceable class="parameter">null_string</replaceable>' ]
           [ CSV [ HEADER ]
-                [ QUOTE [ AS ] '<replaceable class="parameter">quote</replaceable>' ]
-                [ ESCAPE [ AS ] '<replaceable class="parameter">escape</replaceable>' ]
+                [ QUOTE [ AS ] '<replaceable class="parameter">quote_character</replaceable>' ]
+                [ ESCAPE [ AS ] '<replaceable class="parameter">escape_character</replaceable>' ]
                 [ FORCE QUOTE { <replaceable class="parameter">column_name</replaceable> [, ...] | * } ] ] ]
 </synopsis>
 
@@ -1046,13 +1046,13 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
 <synopsis>
 COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
     FROM { '<replaceable class="parameter">filename</replaceable>' | STDIN }
-    [ [USING] DELIMITERS '<replaceable class="parameter">delimiter</replaceable>' ]
-    [ WITH NULL AS '<replaceable class="parameter">null string</replaceable>' ]
+    [ [USING] DELIMITERS '<replaceable class="parameter">delimiter_character</replaceable>' ]
+    [ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
 
 COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
     TO { '<replaceable class="parameter">filename</replaceable>' | STDOUT }
-    [ [USING] DELIMITERS '<replaceable class="parameter">delimiter</replaceable>' ]
-    [ WITH NULL AS '<replaceable class="parameter">null string</replaceable>' ]
+    [ [USING] DELIMITERS '<replaceable class="parameter">delimiter_character</replaceable>' ]
+    [ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
 </synopsis></para>
  </refsect1>
 </refentry>
index 9f786cd3adc28efb89b8647b90abdcb7f1fc2eee..4e5e96a4014d09c29f135fdfe92bc2bddc0f1fc6 100644 (file)
@@ -165,7 +165,7 @@ PREPARE <replaceable class="parameter">name</replaceable> [ ( <replaceable class
    To examine the query plan <productname>PostgreSQL</productname> is using
    for a prepared statement, use <xref linkend="sql-explain"/>, for example
 <programlisting>
-EXPLAIN EXECUTE <replaceable>stmt_name</replaceable>(<replaceable>parameter_values</replaceable>);
+EXPLAIN EXECUTE <replaceable>name</replaceable>(<replaceable>parameter_values</replaceable>);
 </programlisting>
    If a generic plan is in use, it will contain parameter symbols
    <literal>$<replaceable>n</replaceable></literal>, while a custom plan
index 9ab0d6af04cb64a5ca6f77ad8bec275da4876453..a4842f363c8be325f3955e59adaded43e6752e0d 100644 (file)
@@ -64,7 +64,7 @@ RESET ROLE
 
   <para>
    Using this command, it is possible to either add privileges or restrict
-   one's privileges.  If the session user role has the <literal>INHERITS</literal>
+   one's privileges.  If the session user role has the <literal>INHERIT</literal>
    attribute, then it automatically has all the privileges of every role that
    it could <command>SET ROLE</command> to; in this case <command>SET ROLE</command>
    effectively drops all the privileges assigned directly to the session user