Skip to content

Commit 40ee46a

Browse files
vbwagnervbwagner
committed
Documentation updates from Lakhin
1 parent 05fd963 commit 40ee46a

13 files changed

+133
-12
lines changed

‎doc/src/sgml/catalogs.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1314,7 +1314,7 @@
13141314
<literal>md5</> followed by a 32-character hexadecimal MD5 hash.
13151315
The MD5 hash will be of the user's password concatenated to their
13161316
user name. For example, if user <literal>joe</> has password
1317-
<literal>xyzzy</>, <productname>PostgreSQL</> will store the md5
1317+
<literal>xyzzy</>, <productname>&productname;</> will store the md5
13181318
hash of <literal>xyzzyjoe</>. If the password is encrypted with
13191319
SCRAM-SHA-256, it is built with 4 fields separated by a colon. The
13201320
first field is a salt encoded in base-64. The second field is the

‎doc/src/sgml/client-auth.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -905,8 +905,8 @@ omicron bryanh guest1
905905
</indexterm>
906906

907907
<para>
908-
The password-based authentication methods are <literal>md5</>
909-
<literal>scram</> and <literal>password</>. These methods operate
908+
The password-based authentication methods are <literal>md5</>,
909+
<literal>scram</>, and <literal>password</>. These methods operate
910910
similarly except for the way that the password is sent across the
911911
connection, namely MD5-hashed, SCRAM-SHA-256 and clear-text respectively.
912912
</para>

‎doc/src/sgml/contrib.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ CREATE EXTENSION <replaceable>module_name</> FROM unpackaged;
143143
&pgrowlocks;
144144
&pgstatstatements;
145145
&pgstattuple;
146+
&pgtransfer;
146147
&pgtrgm;
147148
&pgvariables;
148149
&pgvisibility;

‎doc/src/sgml/filelist.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@
150150
<!ENTITY pgstandby SYSTEM "pgstandby.sgml">
151151
<!ENTITY pgstatstatements SYSTEM "pgstatstatements.sgml">
152152
<!ENTITY pgstattuple SYSTEM "pgstattuple.sgml">
153+
<!ENTITY pgtransfer SYSTEM "pgtransfer.sgml">
153154
<!ENTITY pgtrgm SYSTEM "pgtrgm.sgml">
154155
<!ENTITY pgvariables SYSTEM "pg_variables.sgml">
155156
<!ENTITY pgvisibility SYSTEM "pgvisibility.sgml">

‎doc/src/sgml/func.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1374,7 +1374,7 @@
13741374
</indexterm>
13751375
</entry>
13761376
<entry><literal>'Post' || 'greSQL'</literal></entry>
1377-
<entry><literal>&productname;</literal></entry>
1377+
<entry><literal>PostgreSQL</literal></entry>
13781378
</row>
13791379

13801380
<row>

‎doc/src/sgml/pghintplan.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -728,11 +728,11 @@ postgres=# WHERE aid IN (SELECT bid FROM pgbench_accounts a2 LIMIT 10);
728728
<para>IndexScan(table[ index...])</para>
729729
<para>Forces index scan on the table. Restricts to specified indexes if any.</para>
730730
<para>IndexOnlyScan(table[ index...])</para>
731-
<para>Forces index only scan on the table. Restricts to specfied indexes
731+
<para>Forces index only scan on the table. Restricts to specified indexes
732732
if any. Index scan may be used if index only scan is not
733733
available. Available for PostgreSQL 9.2 and later.</para>
734734
<para>BitmapScan(table[ index...])</para>
735-
<para>Forces bitmap scan on the table. Restricts to specfied indexes if any.</para>
735+
<para>Forces bitmap scan on the table. Restricts to specified indexes if any.</para>
736736
<para>NoSeqScan(table)</para>
737737
<para>Forces not to do sequential scan on the table.</para>
738738
<para>NoTidScan(table)</para>
@@ -769,7 +769,7 @@ postgres=# WHERE aid IN (SELECT bid FROM pgbench_accounts a2 LIMIT 10);
769769
<para>Row number correction</para>
770770
<para>Rows(table table[ table...] correction)</para>
771771
<para>Corrects row number of a result of the joins consist of the
772-
specfied tables. The available correction methods are absolute
772+
specified tables. The available correction methods are absolute
773773
(#&lt;n&gt;), addition (+&lt;n&gt;), subtract
774774
(-&lt;n&gt;) and multiplication (*&lt;n&gt;). &lt;n&gt;
775775
should be a string that strtod() can read.</para>

‎doc/src/sgml/ref/alter_table.sgml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ ALTER TABLE ALL IN TABLESPACE <replaceable class="PARAMETER">name</replaceable>
6969
SET WITHOUT OIDS
7070
SET TABLESPACE <replaceable class="PARAMETER">new_tablespace</replaceable>
7171
SET { LOGGED | UNLOGGED }
72+
SET CONSTANT
7273
SET ( <replaceable class="PARAMETER">storage_parameter</replaceable> = <replaceable class="PARAMETER">value</replaceable> [, ... ] )
7374
RESET ( <replaceable class="PARAMETER">storage_parameter</replaceable> [, ... ] )
7475
INHERIT <replaceable class="PARAMETER">parent_table</replaceable>
@@ -545,6 +546,18 @@ ALTER TABLE ALL IN TABLESPACE <replaceable class="PARAMETER">name</replaceable>
545546
</listitem>
546547
</varlistentry>
547548

549+
<varlistentry>
550+
<term><literal>SET CONSTANT</literal></term>
551+
<listitem>
552+
<para>
553+
This form changes the table into read-only mode. No data can be modified
554+
or added to constant tables, and they are not processed by
555+
<link linkend="autovacuum">autovacuum</link>. Constant tables cannot be
556+
changed back to read-write mode.
557+
</para>
558+
</listitem>
559+
</varlistentry>
560+
548561
<varlistentry>
549562
<term><literal>SET ( <replaceable class="PARAMETER">storage_parameter</replaceable> = <replaceable class="PARAMETER">value</replaceable> [, ... ] )</literal></term>
550563
<listitem>

‎doc/src/sgml/ref/create_role.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ CREATE ROLE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replac
258258
to be encrypted with SCRAM-SHA-256, and <literal>plain</> to use
259259
an unencrypted password. If the password string is already in
260260
MD5-encrypted or SCRAM-SHA-256 format, then it is stored encrypted
261-
even if another protocol is specified.
261+
even if another method is specified.
262262
</para>
263263
</listitem>
264264
</varlistentry>

‎doc/src/sgml/ref/create_table.sgml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ doc/src/sgml/ref/create_table.sgml
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED ] TABLE [ IF NOT EXISTS ] <replaceable class="PARAMETER">table_name</replaceable> ( [
24+
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED | CONSTANT ] TABLE [ IF NOT EXISTS ] <replaceable class="PARAMETER">table_name</replaceable> ( [
2525
{ <replaceable class="PARAMETER">column_name</replaceable> <replaceable class="PARAMETER">data_type</replaceable> [ COLLATE <replaceable>collation</replaceable> ] [ <replaceable class="PARAMETER">column_constraint</replaceable> [ ... ] ]
2626
| <replaceable>table_constraint</replaceable>
2727
| LIKE <replaceable>source_table</replaceable> [ <replaceable>like_option</replaceable> ... ] }
@@ -32,7 +32,7 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED ] TABLE [ IF NOT EXI
3232
[ ON COMMIT { PRESERVE ROWS | DELETE ROWS | DROP } ]
3333
[ TABLESPACE <replaceable class="PARAMETER">tablespace_name</replaceable> ]
3434

35-
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED ] TABLE [ IF NOT EXISTS ] <replaceable class="PARAMETER">table_name</replaceable>
35+
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED | CONSTANT ] TABLE [ IF NOT EXISTS ] <replaceable class="PARAMETER">table_name</replaceable>
3636
OF <replaceable class="PARAMETER">type_name</replaceable> [ (
3737
{ <replaceable class="PARAMETER">column_name</replaceable> WITH OPTIONS [ <replaceable class="PARAMETER">column_constraint</replaceable> [ ... ] ]
3838
| <replaceable>table_constraint</replaceable> }
@@ -187,6 +187,20 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED ] TABLE [ IF NOT EXI
187187
</listitem>
188188
</varlistentry>
189189

190+
<varlistentry id="SQL-CREATETABLE-CONSTANT">
191+
<term><literal>CONSTANT</></term>
192+
<listitem>
193+
<para>
194+
If specified, the table is created as read-only. No data can be modified
195+
or added to constant tables, and they are not processed by
196+
<link linkend="autovacuum">autovacuum</link>. Constant tables cannot be
197+
changed to read-write mode, so there is no much sense to create them as
198+
constant; use <xref linkend="sql-createtableas"> or
199+
<xref linkend="sql-altertable"> instead.
200+
</para>
201+
</listitem>
202+
</varlistentry>
203+
190204
<varlistentry>
191205
<term><literal>IF NOT EXISTS</></term>
192206
<listitem>

‎doc/src/sgml/ref/create_table_as.sgml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ doc/src/sgml/ref/create_table_as.sgml
2121

2222
<refsynopsisdiv>
2323
<synopsis>
24-
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED ] TABLE [ IF NOT EXISTS ] <replaceable>table_name</replaceable>
24+
CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED | CONSTANT ] TABLE [ IF NOT EXISTS ] <replaceable>table_name</replaceable>
2525
[ (<replaceable>column_name</replaceable> [, ...] ) ]
2626
[ WITH ( <replaceable class="PARAMETER">storage_parameter</replaceable> [= <replaceable class="PARAMETER">value</replaceable>] [, ... ] ) | WITH OIDS | WITHOUT OIDS ]
2727
[ ON COMMIT { PRESERVE ROWS | DELETE ROWS | DROP } ]
@@ -90,6 +90,18 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } | UNLOGGED ] TABLE [ IF NOT EXI
9090
</listitem>
9191
</varlistentry>
9292

93+
<varlistentry>
94+
<term><literal>CONSTANT</></term>
95+
<listitem>
96+
<para>
97+
If specified, the table is created as read-only. No data can be modified
98+
or added to constant tables, and they are not processed by
99+
<link linkend="autovacuum">autovacuum</link>. Constant tables cannot be
100+
changed to read-write mode.
101+
</para>
102+
</listitem>
103+
</varlistentry>
104+
93105
<varlistentry>
94106
<term><literal>IF NOT EXISTS</></term>
95107
<listitem>

‎doc/src/sgml/ref/pg_dump.sgml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -959,6 +959,36 @@ doc/src/sgml/ref/pg_dump.sgml
959959
</variablelist>
960960
</para>
961961

962+
<para>
963+
The following command-line options control data transfer between
964+
databases when <xref linkend="pgtransfer"> extension is used.
965+
966+
<variablelist>
967+
<varlistentry>
968+
<term><option>--copy-mode-transfer</></term>
969+
<listitem>
970+
<para>
971+
Use this option to physically copy files, for example when database files
972+
and directory specified by <option>--transfer-dir</option> are located on
973+
different file systems.
974+
</para>
975+
</listitem>
976+
</varlistentry>
977+
978+
<varlistentry>
979+
<term><option>--transfer-dir</></term>
980+
<listitem>
981+
<para>
982+
Directory to transfer data files to. Data files includes that of the
983+
table, its indexes and TOAST. By default hard links are created instead
984+
of copying files. Note that deleting the table by <command>DROP</command>
985+
command makes such links invalid.
986+
</para>
987+
</listitem>
988+
</varlistentry>
989+
</variablelist>
990+
</para>
991+
962992
<para>
963993
The following command-line options control the database connection parameters.
964994

‎doc/src/sgml/ref/pg_restore.sgml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -644,6 +644,46 @@
644644
</variablelist>
645645
</para>
646646

647+
<para>
648+
The following command-line options control data transfer between
649+
databases when <xref linkend="pgtransfer"> extension is used.
650+
651+
<variablelist>
652+
<varlistentry>
653+
<term><option>--copy-mode-transfer</></term>
654+
<listitem>
655+
<para>
656+
Use this option to physically copy files, for example when database files
657+
and directory specified by <option>--transfer-dir</option> are located on
658+
different file systems.
659+
</para>
660+
</listitem>
661+
</varlistentry>
662+
663+
<varlistentry>
664+
<term><option>--generate-wal</></term>
665+
<listitem>
666+
<para>
667+
Generate WAL records for all transferred files. When restoring on primary
668+
server without this option, changes will not be replicated to standby
669+
server.
670+
</para>
671+
</listitem>
672+
</varlistentry>
673+
674+
<varlistentry>
675+
<term><option>--transfer-dir</></term>
676+
<listitem>
677+
<para>
678+
Directory to transfer data files from. Data files includes that of the
679+
table, its indexes and TOAST. By default files are moved instead of
680+
copying them.
681+
</para>
682+
</listitem>
683+
</varlistentry>
684+
</variablelist>
685+
</para>
686+
647687
<para>
648688
<application>pg_restore</application> also accepts
649689
the following command line arguments for connection parameters:

‎doc/src/sgml/ref/select_into.sgml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ doc/src/sgml/ref/select_into.sgml
2424
[ WITH [ RECURSIVE ] <replaceable class="parameter">with_query</replaceable> [, ...] ]
2525
SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replaceable> [, ...] ) ] ]
2626
* | <replaceable class="parameter">expression</replaceable> [ [ AS ] <replaceable class="parameter">output_name</replaceable> ] [, ...]
27-
INTO [ TEMPORARY | TEMP | UNLOGGED ] [ TABLE ] <replaceable class="parameter">new_table</replaceable>
27+
INTO [ TEMPORARY | TEMP | UNLOGGED | CONSTANT ] [ TABLE ] <replaceable class="parameter">new_table</replaceable>
2828
[ FROM <replaceable class="parameter">from_item</replaceable> [, ...] ]
2929
[ WHERE <replaceable class="parameter">condition</replaceable> ]
3030
[ GROUP BY <replaceable class="parameter">expression</replaceable> [, ...] ]
@@ -75,6 +75,16 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replac
7575
</listitem>
7676
</varlistentry>
7777

78+
<varlistentry>
79+
<term><literal>CONSTANT</></term>
80+
<listitem>
81+
<para>
82+
If specified, the table is created as read-only. Refer to
83+
<xref linkend="sql-createtable"> for details.
84+
</para>
85+
</listitem>
86+
</varlistentry>
87+
7888
<varlistentry>
7989
<term><replaceable class="PARAMETER">new_table</replaceable></term>
8090
<listitem>

0 commit comments

Comments
 (0)