diff options
Diffstat (limited to 'doc/src/sgml/ref/pg_basebackup.sgml')
| -rw-r--r-- | doc/src/sgml/ref/pg_basebackup.sgml | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index 84b45ae7a00..ede68db9388 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -189,6 +189,27 @@ PostgreSQL documentation </varlistentry> <varlistentry> + <term><option>-r <replaceable class="parameter">rate</replaceable></option></term> + <term><option>--max-rate=<replaceable class="parameter">rate</replaceable></option></term> + <listitem> + <para> + The maximum transfer rate of data transferred from the server. Values are + in kilobytes per second. Use a suffix of <literal>M</> to indicate megabytes + per second. A suffix of <literal>k</> is also accepted, and has no effect. + Valid values are between 32 kilobytes per second and 1024 megabytes per second. + </para> + <para> + The purpose is to limit the impact of <application>pg_basebackup</application> + on the running server. + </para> + <para> + This option always affects transfer of the data directory. Transfer of + WAL files is only affected if the collection method is <literal>fetch</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>-R</option></term> <term><option>--write-recovery-conf</option></term> <listitem> |