Skip to content

Commit 4351142

Browse files
michaelpqmichaelpq
committed
Doc: Fix various inconsistencies
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
1 parent cef82ed commit 4351142

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

‎doc/src/sgml/extend.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -856,7 +856,7 @@ SELECT pg_catalog.pg_extension_config_dump('my_config', 'WHERE NOT standard_entr
856856
dynamically from one version to the next, you should provide
857857
<firstterm>update scripts</firstterm> that make the necessary changes to go from
858858
one version to the next. Update scripts have names following the pattern
859-
<literal><replaceable>extension</replaceable>--<replaceable>oldversion</replaceable>--<replaceable>newversion</replaceable>.sql</literal>
859+
<literal><replaceable>extension</replaceable>--<replaceable>old_version</replaceable>--<replaceable>target_version</replaceable>.sql</literal>
860860
(for example, <literal>foo--1.0--1.1.sql</literal> contains the commands to modify
861861
version <literal>1.0</literal> of extension <literal>foo</literal> into version
862862
<literal>1.1</literal>).

‎doc/src/sgml/ref/copy.sgml

+12-12
Original file line numberDiff line numberDiff line change
@@ -1015,22 +1015,22 @@ COPY <replaceable class="parameter">table_name</replaceable> [ ( <replaceable cl
10151015
FROM { '<replaceable class="parameter">filename</replaceable>' | STDIN }
10161016
[ [ WITH ]
10171017
[ BINARY ]
1018-
[ DELIMITER [ AS ] '<replaceable class="parameter">delimiter</replaceable>' ]
1019-
[ NULL [ AS ] '<replaceable class="parameter">null string</replaceable>' ]
1018+
[ DELIMITER [ AS ] '<replaceable class="parameter">delimiter_character</replaceable>' ]
1019+
[ NULL [ AS ] '<replaceable class="parameter">null_string</replaceable>' ]
10201020
[ CSV [ HEADER ]
1021-
[ QUOTE [ AS ] '<replaceable class="parameter">quote</replaceable>' ]
1022-
[ ESCAPE [ AS ] '<replaceable class="parameter">escape</replaceable>' ]
1021+
[ QUOTE [ AS ] '<replaceable class="parameter">quote_character</replaceable>' ]
1022+
[ ESCAPE [ AS ] '<replaceable class="parameter">escape_character</replaceable>' ]
10231023
[ FORCE NOT NULL <replaceable class="parameter">column_name</replaceable> [, ...] ] ] ]
10241024

10251025
COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable class="parameter">column_name</replaceable> [, ...] ) ] | ( <replaceable class="parameter">query</replaceable> ) }
10261026
TO { '<replaceable class="parameter">filename</replaceable>' | STDOUT }
10271027
[ [ WITH ]
10281028
[ BINARY ]
1029-
[ DELIMITER [ AS ] '<replaceable class="parameter">delimiter</replaceable>' ]
1030-
[ NULL [ AS ] '<replaceable class="parameter">null string</replaceable>' ]
1029+
[ DELIMITER [ AS ] '<replaceable class="parameter">delimiter_character</replaceable>' ]
1030+
[ NULL [ AS ] '<replaceable class="parameter">null_string</replaceable>' ]
10311031
[ CSV [ HEADER ]
1032-
[ QUOTE [ AS ] '<replaceable class="parameter">quote</replaceable>' ]
1033-
[ ESCAPE [ AS ] '<replaceable class="parameter">escape</replaceable>' ]
1032+
[ QUOTE [ AS ] '<replaceable class="parameter">quote_character</replaceable>' ]
1033+
[ ESCAPE [ AS ] '<replaceable class="parameter">escape_character</replaceable>' ]
10341034
[ FORCE QUOTE { <replaceable class="parameter">column_name</replaceable> [, ...] | * } ] ] ]
10351035
</synopsis>
10361036

@@ -1046,13 +1046,13 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
10461046
<synopsis>
10471047
COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
10481048
FROM { '<replaceable class="parameter">filename</replaceable>' | STDIN }
1049-
[ [USING] DELIMITERS '<replaceable class="parameter">delimiter</replaceable>' ]
1050-
[ WITH NULL AS '<replaceable class="parameter">null string</replaceable>' ]
1049+
[ [USING] DELIMITERS '<replaceable class="parameter">delimiter_character</replaceable>' ]
1050+
[ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
10511051

10521052
COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
10531053
TO { '<replaceable class="parameter">filename</replaceable>' | STDOUT }
1054-
[ [USING] DELIMITERS '<replaceable class="parameter">delimiter</replaceable>' ]
1055-
[ WITH NULL AS '<replaceable class="parameter">null string</replaceable>' ]
1054+
[ [USING] DELIMITERS '<replaceable class="parameter">delimiter_character</replaceable>' ]
1055+
[ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
10561056
</synopsis></para>
10571057
</refsect1>
10581058
</refentry>

‎doc/src/sgml/ref/prepare.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ PREPARE <replaceable class="parameter">name</replaceable> [ ( <replaceable class
165165
To examine the query plan <productname>PostgreSQL</productname> is using
166166
for a prepared statement, use <xref linkend="sql-explain"/>, for example
167167
<programlisting>
168-
EXPLAIN EXECUTE <replaceable>stmt_name</replaceable>(<replaceable>parameter_values</replaceable>);
168+
EXPLAIN EXECUTE <replaceable>name</replaceable>(<replaceable>parameter_values</replaceable>);
169169
</programlisting>
170170
If a generic plan is in use, it will contain parameter symbols
171171
<literal>$<replaceable>n</replaceable></literal>, while a custom plan

‎doc/src/sgml/ref/set_role.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ RESET ROLE
6464

6565
<para>
6666
Using this command, it is possible to either add privileges or restrict
67-
one's privileges. If the session user role has the <literal>INHERITS</literal>
67+
one's privileges. If the session user role has the <literal>INHERIT</literal>
6868
attribute, then it automatically has all the privileges of every role that
6969
it could <command>SET ROLE</command> to; in this case <command>SET ROLE</command>
7070
effectively drops all the privileges assigned directly to the session user

0 commit comments

Comments
 (0)