Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 5efbdd3

Browse files
committed
doc: Move some new options into better positions on man pages
1 parent 3b9b751 commit 5efbdd3

File tree

3 files changed

+50
-51
lines changed

3 files changed

+50
-51
lines changed

doc/src/sgml/ref/initdb.sgml

+20-21
Original file line numberDiff line numberDiff line change
@@ -334,27 +334,6 @@ PostgreSQL documentation
334334
</listitem>
335335
</varlistentry>
336336

337-
<varlistentry>
338-
<term><option>--wal-segsize=<replaceable>size</replaceable></option></term>
339-
<listitem>
340-
<para>
341-
Set the <firstterm>WAL segment size</firstterm>, in megabytes. This
342-
is the size of each individual file in the WAL log. The default size
343-
is 16 megabytes. The value must be a power of 2 between 1 and 1024
344-
(megabytes). This option can only be set during initialization, and
345-
cannot be changed later.
346-
</para>
347-
348-
<para>
349-
It may be useful to adjust this size to control the granularity of
350-
WAL log shipping or archiving. Also, in databases with a high volume
351-
of WAL, the sheer number of WAL files per directory can become a
352-
performance and management problem. Increasing the WAL file size
353-
will reduce the number of WAL files.
354-
</para>
355-
</listitem>
356-
</varlistentry>
357-
358337
<varlistentry>
359338
<term><option>-X <replaceable class="parameter">directory</replaceable></option></term>
360339
<term><option>--waldir=<replaceable class="parameter">directory</replaceable></option></term>
@@ -366,6 +345,26 @@ PostgreSQL documentation
366345
</listitem>
367346
</varlistentry>
368347

348+
<varlistentry>
349+
<term><option>--wal-segsize=<replaceable>size</replaceable></option></term>
350+
<listitem>
351+
<para>
352+
Set the <firstterm>WAL segment size</firstterm>, in megabytes. This
353+
is the size of each individual file in the WAL log. The default size
354+
is 16 megabytes. The value must be a power of 2 between 1 and 1024
355+
(megabytes). This option can only be set during initialization, and
356+
cannot be changed later.
357+
</para>
358+
359+
<para>
360+
It may be useful to adjust this size to control the granularity of
361+
WAL log shipping or archiving. Also, in databases with a high volume
362+
of WAL, the sheer number of WAL files per directory can become a
363+
performance and management problem. Increasing the WAL file size
364+
will reduce the number of WAL files.
365+
</para>
366+
</listitem>
367+
</varlistentry>
369368
</variablelist>
370369
</para>
371370

doc/src/sgml/ref/pg_dump.sgml

+15-15
Original file line numberDiff line numberDiff line change
@@ -789,21 +789,6 @@ PostgreSQL documentation
789789
</listitem>
790790
</varlistentry>
791791

792-
<varlistentry>
793-
<term><option>--lock-wait-timeout=<replaceable class="parameter">timeout</replaceable></option></term>
794-
<listitem>
795-
<para>
796-
Do not wait forever to acquire shared table locks at the beginning of
797-
the dump. Instead fail if unable to lock a table within the specified
798-
<replaceable class="parameter">timeout</replaceable>. The timeout may be
799-
specified in any of the formats accepted by <command>SET
800-
statement_timeout</command>. (Allowed formats vary depending on the server
801-
version you are dumping from, but an integer number of milliseconds
802-
is accepted by all versions.)
803-
</para>
804-
</listitem>
805-
</varlistentry>
806-
807792
<varlistentry>
808793
<term><option>--load-via-partition-root</option></term>
809794
<listitem>
@@ -819,6 +804,21 @@ PostgreSQL documentation
819804
</listitem>
820805
</varlistentry>
821806

807+
<varlistentry>
808+
<term><option>--lock-wait-timeout=<replaceable class="parameter">timeout</replaceable></option></term>
809+
<listitem>
810+
<para>
811+
Do not wait forever to acquire shared table locks at the beginning of
812+
the dump. Instead fail if unable to lock a table within the specified
813+
<replaceable class="parameter">timeout</replaceable>. The timeout may be
814+
specified in any of the formats accepted by <command>SET
815+
statement_timeout</command>. (Allowed formats vary depending on the server
816+
version you are dumping from, but an integer number of milliseconds
817+
is accepted by all versions.)
818+
</para>
819+
</listitem>
820+
</varlistentry>
821+
822822
<varlistentry>
823823
<term><option>--no-comments</option></term>
824824
<listitem>

doc/src/sgml/ref/pg_dumpall.sgml

+15-15
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,21 @@ PostgreSQL documentation
326326
</listitem>
327327
</varlistentry>
328328

329+
<varlistentry>
330+
<term><option>--load-via-partition-root</option></term>
331+
<listitem>
332+
<para>
333+
When dumping a <command>COPY</command> or <command>INSERT</command> statement for a partitioned table,
334+
target the root of the partitioning hierarchy which contains it rather
335+
than the partition itself. This may be useful when reloading data on
336+
a server where rows do not always fall into the same partitions as
337+
they did on the original server. This could happen, for example, if
338+
the partitioning column is of type text and the two system have
339+
different definitions of the collation used to partition the data.
340+
</para>
341+
</listitem>
342+
</varlistentry>
343+
329344
<varlistentry>
330345
<term><option>--lock-wait-timeout=<replaceable class="parameter">timeout</replaceable></option></term>
331346
<listitem>
@@ -342,21 +357,6 @@ PostgreSQL documentation
342357
</listitem>
343358
</varlistentry>
344359

345-
<varlistentry>
346-
<term><option>--load-via-partition-root</option></term>
347-
<listitem>
348-
<para>
349-
When dumping a <command>COPY</command> or <command>INSERT</command> statement for a partitioned table,
350-
target the root of the partitioning hierarchy which contains it rather
351-
than the partition itself. This may be useful when reloading data on
352-
a server where rows do not always fall into the same partitions as
353-
they did on the original server. This could happen, for example, if
354-
the partitioning column is of type text and the two system have
355-
different definitions of the collation used to partition the data.
356-
</para>
357-
</listitem>
358-
</varlistentry>
359-
360360
<varlistentry>
361361
<term><option>--no-comments</option></term>
362362
<listitem>

0 commit comments

Comments
 (0)