diff options
| -rw-r--r-- | doc/src/sgml/ref/dropdb.sgml | 16 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_basebackup.sgml | 108 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_dumpall.sgml | 23 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_rewind.sgml | 34 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pgbench.sgml | 44 |
5 files changed, 112 insertions, 113 deletions
diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index 28b18bfcb0c..ded85b0e232 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -77,23 +77,23 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>-i</option></term> - <term><option>--interactive</option></term> + <term><option>-f</option></term> + <term><option>--force</option></term> <listitem> <para> - Issues a verification prompt before doing anything destructive. + Attempt to terminate all existing connections to the target database + before dropping it. See <xref linkend="sql-dropdatabase"/> for more + information on this option. </para> </listitem> </varlistentry> <varlistentry> - <term><option>-f</option></term> - <term><option>--force</option></term> + <term><option>-i</option></term> + <term><option>--interactive</option></term> <listitem> <para> - Attempt to terminate all existing connections to the target database - before dropping it. See <xref linkend="sql-dropdatabase"/> for more - information on this option. + Issues a verification prompt before doing anything destructive. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index e3cc08e485e..cf099ccbcab 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -500,39 +500,51 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>--no-slot</option></term> + <term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term> <listitem> <para> - This option prevents the creation of a temporary replication slot - during the backup even if it's supported by the server. + Specifies the checksum algorithm that should be applied to each file + included in the backup manifest. Currently, the available + algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>, + <literal>SHA224</literal>, <literal>SHA256</literal>, + <literal>SHA384</literal>, and <literal>SHA512</literal>. + The default is <literal>CRC32C</literal>. </para> <para> - Temporary replication slots are created by default if no slot name - is given with the option <option>-S</option> when using log streaming. + If <literal>NONE</literal> is selected, the backup manifest will + not contain any checksums. Otherwise, it will contain a checksum + of each file in the backup using the specified algorithm. In addition, + the manifest will always contain a <literal>SHA256</literal> + checksum of its own contents. The <literal>SHA</literal> algorithms + are significantly more CPU-intensive than <literal>CRC32C</literal>, + so selecting one of them may increase the time required to complete + the backup. </para> <para> - The main purpose of this option is to allow taking a base backup when - the server is out of free replication slots. Using replication slots - is almost always preferred, because it prevents needed WAL from being - removed by the server during the backup. + Using a SHA hash function provides a cryptographically secure digest + of each file for users who wish to verify that the backup has not been + tampered with, while the CRC32C algorithm provides a checksum which is + much faster to calculate and good at catching errors due to accidental + changes but is not resistant to targeted modifications. Note that, to + be useful against an adversary who has access to the backup, the backup + manifest would need to be stored securely elsewhere or otherwise + verified not to have been modified since the backup was taken. + </para> + <para> + <xref linkend="app-pgverifybackup" /> can be used to check the + integrity of a backup against the backup manifest. </para> </listitem> </varlistentry> <varlistentry> - <term><option>--no-verify-checksums</option></term> + <term><option>--manifest-force-encode</option></term> <listitem> <para> - Disables verification of checksums, if they are enabled on the server - the base backup is taken from. - </para> - <para> - By default, checksums are verified and checksum failures will result - in a non-zero exit status. However, the base backup will not be - removed in such a case, as if the <option>--no-clean</option> option - had been used. Checksum verifications failures will also be reported - in the <link linkend="monitoring-pg-stat-database-view"> - <structname>pg_stat_database</structname></link> view. + Forces all filenames in the backup manifest to be hex-encoded. + If this option is not specified, only non-UTF8 filenames are + hex-encoded. This option is mostly intended to test that tools which + read a backup manifest file properly handle this case. </para> </listitem> </varlistentry> @@ -576,51 +588,39 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>--manifest-force-encode</option></term> + <term><option>--no-slot</option></term> <listitem> <para> - Forces all filenames in the backup manifest to be hex-encoded. - If this option is not specified, only non-UTF8 filenames are - hex-encoded. This option is mostly intended to test that tools which - read a backup manifest file properly handle this case. + This option prevents the creation of a temporary replication slot + during the backup even if it's supported by the server. + </para> + <para> + Temporary replication slots are created by default if no slot name + is given with the option <option>-S</option> when using log streaming. + </para> + <para> + The main purpose of this option is to allow taking a base backup when + the server is out of free replication slots. Using replication slots + is almost always preferred, because it prevents needed WAL from being + removed by the server during the backup. </para> </listitem> </varlistentry> <varlistentry> - <term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term> + <term><option>--no-verify-checksums</option></term> <listitem> <para> - Specifies the checksum algorithm that should be applied to each file - included in the backup manifest. Currently, the available - algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>, - <literal>SHA224</literal>, <literal>SHA256</literal>, - <literal>SHA384</literal>, and <literal>SHA512</literal>. - The default is <literal>CRC32C</literal>. - </para> - <para> - If <literal>NONE</literal> is selected, the backup manifest will - not contain any checksums. Otherwise, it will contain a checksum - of each file in the backup using the specified algorithm. In addition, - the manifest will always contain a <literal>SHA256</literal> - checksum of its own contents. The <literal>SHA</literal> algorithms - are significantly more CPU-intensive than <literal>CRC32C</literal>, - so selecting one of them may increase the time required to complete - the backup. - </para> - <para> - Using a SHA hash function provides a cryptographically secure digest - of each file for users who wish to verify that the backup has not been - tampered with, while the CRC32C algorithm provides a checksum which is - much faster to calculate and good at catching errors due to accidental - changes but is not resistant to targeted modifications. Note that, to - be useful against an adversary who has access to the backup, the backup - manifest would need to be stored securely elsewhere or otherwise - verified not to have been modified since the backup was taken. + Disables verification of checksums, if they are enabled on the server + the base backup is taken from. </para> <para> - <xref linkend="app-pgverifybackup" /> can be used to check the - integrity of a backup against the backup manifest. + By default, checksums are verified and checksum failures will result + in a non-zero exit status. However, the base backup will not be + removed in such a case, as if the <option>--no-clean</option> option + had been used. Checksum verifications failures will also be reported + in the <link linkend="monitoring-pg-stat-database-view"> + <structname>pg_stat_database</structname></link> view. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 40ca31bfdfe..541269d376d 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -288,18 +288,6 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term> - <listitem> - <para> - Use the specified value of extra_float_digits when dumping - floating-point data, instead of the maximum available precision. - Routine dumps made for backup purposes should not use this option. - </para> - </listitem> - </varlistentry> - - - <varlistentry> <term><option>--exclude-database=<replaceable class="parameter">pattern</replaceable></option></term> <listitem> <para> @@ -319,6 +307,17 @@ PostgreSQL documentation </varlistentry> <varlistentry> + <term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term> + <listitem> + <para> + Use the specified value of extra_float_digits when dumping + floating-point data, instead of the maximum available precision. + Routine dumps made for backup purposes should not use this option. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>--if-exists</option></term> <listitem> <para> diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml index 391e5db2e2f..9ae1bf3ab6e 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -179,23 +179,6 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>--no-ensure-shutdown</option></term> - <listitem> - <para> - <application>pg_rewind</application> requires that the target server - is cleanly shut down before rewinding. By default, if the target server - is not shut down cleanly, <application>pg_rewind</application> starts - the target server in single-user mode to complete crash recovery first, - and stops it. - By passing this option, <application>pg_rewind</application> skips - this and errors out immediately if the server is not cleanly shut - down. Users are expected to handle the situation themselves in that - case. - </para> - </listitem> - </varlistentry> - - <varlistentry> <term><option>-R</option></term> <term><option>--write-recovery-conf</option></term> <listitem> @@ -269,6 +252,23 @@ PostgreSQL documentation </varlistentry> <varlistentry> + <term><option>--no-ensure-shutdown</option></term> + <listitem> + <para> + <application>pg_rewind</application> requires that the target server + is cleanly shut down before rewinding. By default, if the target server + is not shut down cleanly, <application>pg_rewind</application> starts + the target server in single-user mode to complete crash recovery first, + and stops it. + By passing this option, <application>pg_rewind</application> skips + this and errors out immediately if the server is not cleanly shut + down. Users are expected to handle the situation themselves in that + case. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>-V</option></term> <term><option>--version</option></term> <listitem><para>Display version information, then exit.</para></listitem> diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index f5a51d3732d..aa2076de407 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -336,26 +336,26 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d </varlistentry> <varlistentry> - <term><option>--partitions=<replaceable>NUM</replaceable></option></term> + <term><option>--partition-method=<replaceable>NAME</replaceable></option></term> <listitem> <para> Create a partitioned <literal>pgbench_accounts</literal> table with - <replaceable>NUM</replaceable> partitions of nearly equal size for - the scaled number of accounts. - Default is <literal>0</literal>, meaning no partitioning. + <replaceable>NAME</replaceable> method. + Expected values are <literal>range</literal> or <literal>hash</literal>. + This option requires that <option>--partitions</option> is set to non-zero. + If unspecified, default is <literal>range</literal>. </para> </listitem> </varlistentry> <varlistentry> - <term><option>--partition-method=<replaceable>NAME</replaceable></option></term> + <term><option>--partitions=<replaceable>NUM</replaceable></option></term> <listitem> <para> Create a partitioned <literal>pgbench_accounts</literal> table with - <replaceable>NAME</replaceable> method. - Expected values are <literal>range</literal> or <literal>hash</literal>. - This option requires that <option>--partitions</option> is set to non-zero. - If unspecified, default is <literal>range</literal>. + <replaceable>NUM</replaceable> partitions of nearly equal size for + the scaled number of accounts. + Default is <literal>0</literal>, meaning no partitioning. </para> </listitem> </varlistentry> @@ -671,16 +671,6 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d </varlistentry> <varlistentry> - <term><option>--show-script</option><replaceable>scriptname</replaceable></term> - <listitem> - <para> - Show the actual code of builtin script <replaceable>scriptname</replaceable> - on stderr, and exit immediately. - </para> - </listitem> - </varlistentry> - - <varlistentry> <term><option>-t</option> <replaceable>transactions</replaceable></term> <term><option>--transactions=</option><replaceable>transactions</replaceable></term> <listitem> @@ -750,13 +740,13 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d </varlistentry> <varlistentry> - <term><option>--random-seed=</option><replaceable>SEED</replaceable></term> + <term><option>--random-seed=</option><replaceable>seed</replaceable></term> <listitem> <para> Set random generator seed. Seeds the system random number generator, which then produces a sequence of initial generator states, one for each thread. - Values for <replaceable>SEED</replaceable> may be: + Values for <replaceable>seed</replaceable> may be: <literal>time</literal> (the default, the seed is based on the current time), <literal>rand</literal> (use a strong random source, failing if none is available), or an unsigned decimal integer value. @@ -764,7 +754,7 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d (<literal>random...</literal> functions) or implicitly (for instance option <option>--rate</option> uses it to schedule transactions). When explicitly set, the value used for seeding is shown on the terminal. - Any value allowed for <replaceable>SEED</replaceable> may also be + Any value allowed for <replaceable>seed</replaceable> may also be provided through the environment variable <literal>PGBENCH_RANDOM_SEED</literal>. To ensure that the provided seed impacts all possible uses, put this option @@ -804,6 +794,16 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d </listitem> </varlistentry> + <varlistentry> + <term><option>--show-script=</option><replaceable>scriptname</replaceable></term> + <listitem> + <para> + Show the actual code of builtin script <replaceable>scriptname</replaceable> + on stderr, and exit immediately. + </para> + </listitem> + </varlistentry> + </variablelist> </para> |