From 213335c14529a8d5e2007ec0c256f4cf64d62d3b Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Thu, 17 Sep 2015 20:56:58 -0400 Subject: [PATCH] Order some new options on man pages more sensibly, minor improvements --- doc/src/sgml/ref/alter_database.sgml | 24 ++++++------- doc/src/sgml/ref/create_database.sgml | 24 ++++++------- doc/src/sgml/ref/create_policy.sgml | 2 +- doc/src/sgml/ref/pg_ctl-ref.sgml | 4 +-- doc/src/sgml/ref/pg_dump.sgml | 50 +++++++++++++-------------- doc/src/sgml/ref/pg_receivexlog.sgml | 2 +- doc/src/sgml/ref/pg_restore.sgml | 16 ++++----- doc/src/sgml/ref/pg_rewind.sgml | 21 ++++++----- doc/src/sgml/ref/pgupgrade.sgml | 4 +-- doc/src/sgml/ref/vacuumdb.sgml | 48 ++++++++++++------------- 10 files changed, 99 insertions(+), 96 deletions(-) diff --git a/doc/src/sgml/ref/alter_database.sgml b/doc/src/sgml/ref/alter_database.sgml index 787cfff167..cfc28cf9a7 100644 --- a/doc/src/sgml/ref/alter_database.sgml +++ b/doc/src/sgml/ref/alter_database.sgml @@ -25,9 +25,9 @@ ALTER DATABASE name [ [ WITH ] where option can be: - IS_TEMPLATE istemplate ALLOW_CONNECTIONS allowconn CONNECTION LIMIT connlimit + IS_TEMPLATE istemplate ALTER DATABASE name RENAME TO new_name @@ -110,17 +110,6 @@ ALTER DATABASE name RESET ALL - - istemplate - - - If true, then this database can be cloned by any user with CREATEDB - privileges; if false, then only superusers or the owner of the - database can clone it. - - - - allowconn @@ -140,6 +129,17 @@ ALTER DATABASE name RESET ALL + + istemplate + + + If true, then this database can be cloned by any user with CREATEDB + privileges; if false, then only superusers or the owner of the + database can clone it. + + + + new_name diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 0d187e29f5..138996bedc 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -28,9 +28,9 @@ CREATE DATABASE name [ LC_COLLATE [=] lc_collate ] [ LC_CTYPE [=] lc_ctype ] [ TABLESPACE [=] tablespace_name ] - [ IS_TEMPLATE [=] istemplate ] [ ALLOW_CONNECTIONS [=] allowconn ] [ CONNECTION LIMIT [=] connlimit ] ] + [ IS_TEMPLATE [=] istemplate ] @@ -149,17 +149,6 @@ CREATE DATABASE name - - istemplate - - - If true, then this database can be cloned by any user with CREATEDB - privileges; if false (the default), then only superusers or the owner - of the database can clone it. - - - - allowconn @@ -180,6 +169,17 @@ CREATE DATABASE name + + + istemplate + + + If true, then this database can be cloned by any user with CREATEDB + privileges; if false (the default), then only superusers or the owner + of the database can clone it. + + + diff --git a/doc/src/sgml/ref/create_policy.sgml b/doc/src/sgml/ref/create_policy.sgml index 629ed801f2..7b4f9438cd 100644 --- a/doc/src/sgml/ref/create_policy.sgml +++ b/doc/src/sgml/ref/create_policy.sgml @@ -34,7 +34,7 @@ CREATE POLICY name ON The CREATE POLICY command defines a new policy for a - table. Note that row level security must also be enabled on the table using + table. Note that row-level security must also be enabled on the table using ALTER TABLE in order for created policies to be applied. diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 2df65db0bd..eaa0cc8b37 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -427,10 +427,10 @@ PostgreSQL documentation Name of the event source for pg_ctl to use for logging to the event log when running as a Windows service. The default is PostgreSQL. Note that this only controls - the logging from pg_ctl itself - once + the logging from pg_ctl itself; once started, the server will use the event source specified by . Should the server fail during - early startup, it may also log using the default event + early startup, it might also log using the default event source PostgreSQL. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index cfaec96740..9d84f8b4cc 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -707,13 +707,13 @@ PostgreSQL documentation This option is relevant only when dumping the contents of a table - which has row security. By default, pg_dump will set - ROW_SECURITY to OFF, to ensure + which has row security. By default, pg_dump will set + to off, to ensure that all data is dumped from the table. If the user does not have sufficient privileges to bypass row security, then an error is thrown. This parameter instructs pg_dump to set - row_security to 'ON' instead, allowing the user to dump the contents - of the table which they have access to. + to on instead, allowing the user + to dump the parts of the contents of the table that they have access to. @@ -862,27 +862,6 @@ PostgreSQL documentation - - - - - Use the specified synchronized snapshot when making a dump of the - database (see - for more - details). - - - This option is useful when needing to synchronize the dump with - a logical replication slot (see ) - or with a concurrent session. - - - In the case of a parallel dump, the snapshot name defined by this - option is used rather than taking a new snapshot. - - - - @@ -918,6 +897,27 @@ PostgreSQL documentation + + + + + Use the specified synchronized snapshot when making a dump of the + database (see + for more + details). + + + This option is useful when needing to synchronize the dump with + a logical replication slot (see ) + or with a concurrent session. + + + In the case of a parallel dump, the snapshot name defined by this + option is used rather than taking a new snapshot. + + + + diff --git a/doc/src/sgml/ref/pg_receivexlog.sgml b/doc/src/sgml/ref/pg_receivexlog.sgml index 0e6ec1c414..0dcba4d54f 100644 --- a/doc/src/sgml/ref/pg_receivexlog.sgml +++ b/doc/src/sgml/ref/pg_receivexlog.sgml @@ -50,7 +50,7 @@ PostgreSQL documentation Unlike the standby's WAL receiver, pg_receivexlog - flushes WAL data only when a WAL file is closed, by default. + by default flushes WAL data only when a WAL file is closed. --synchronous option must be specified to flush WAL data in real time and ensure it's safely flushed to disk. diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index a5a939443d..66d09f4209 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -520,25 +520,25 @@ - + + This option is relevant only when restoring the contents of a table - which has row security. By default, pg_restore will set - ROW_SECURITY to OFF, to ensure + which has row security. By default, pg_restore will set + to off, to ensure that all data is restored in to the table. If the user does not have sufficient privileges to bypass row security, then an error is thrown. This parameter instructs pg_restore to set - row_security to 'ON' instead, allowing the user to attempt to restore - the contents of the table with row security enabled. This may still + to on instead, allowing the user to attempt to restore + the contents of the table with row security enabled. This might still fail if the user does not have the right to insert the rows from the dump into the table. - Note that this option currently also requires the dump be in INSERT - format as COPY TO does not support row security. + Note that this option currently also requires the dump be in INSERT + format, as COPY TO does not support row security. - diff --git a/doc/src/sgml/ref/pg_rewind.sgml b/doc/src/sgml/ref/pg_rewind.sgml index 43c05d570c..9cdfa902f5 100644 --- a/doc/src/sgml/ref/pg_rewind.sgml +++ b/doc/src/sgml/ref/pg_rewind.sgml @@ -81,6 +81,16 @@ PostgreSQL documentation recovery.conf file in the target data directory with a suitable restore_command. + + + pg_rewind requires that the target server either has + the option is enabled + in postgresql.conf or that data checksums were enabled when + the cluster was initialized with initdb. Neither of these + are currently on by default. + must also be enabled. That is the + default. + @@ -159,13 +169,13 @@ PostgreSQL documentation - Display version information, then exit + Display version information, then exit. - Show help, then exit + Show help, then exit. @@ -185,13 +195,6 @@ PostgreSQL documentation Notes - - pg_rewind requires that the wal_log_hints - option is enabled in postgresql.conf, or that data checksums - were enabled when the cluster was initialized with initdb. - full_page_writes must also be enabled. - - How it works diff --git a/doc/src/sgml/ref/pgupgrade.sgml b/doc/src/sgml/ref/pgupgrade.sgml index babeb0269b..eb113c2629 100644 --- a/doc/src/sgml/ref/pgupgrade.sgml +++ b/doc/src/sgml/ref/pgupgrade.sgml @@ -414,8 +414,8 @@ pg_upgrade.exe servers - If you have Streaming Replication () or Log-Shipping () or Log-Shipping (see ) standby servers, follow these steps to upgrade them. You will not be running pg_upgrade on the standby servers, but rather rsync. Do not diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index e38c34aea3..92b8984b7a 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -133,6 +133,30 @@ PostgreSQL documentation + + + + + + Execute the vacuum or analyze commands in parallel by running + njobs + commands simultaneously. This option reduces the time of the + processing but it also increases the load on the database server. + + + vacuumdb will open + njobs connections to the + database, so make sure your + setting is high enough to accommodate all connections. + + + Note that using this mode together with the + (FULL) option might cause deadlock failures if + certain system catalogs are processed in parallel. + + + + @@ -203,30 +227,6 @@ PostgreSQL documentation - - - - - - Execute the vacuum or analyze commands in parallel by running - njobs - commands simultaneously. This option reduces the time of the - processing but it also increases the load on the database server. - - - vacuumdb will open - njobs connections to the - database, so make sure your - setting is high enough to accommodate all connections. - - - Note that using this mode together with the - (FULL) option might cause deadlock failures if - certain system catalogs are processed in parallel. - - - -