db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-14 10:13:05 +02:00
Code Issues Releases Activity

Added archive-timeout option documentation to the user guide.

Browse Source 
Contributed by Cynthia Shang.
This commit is contained in:
Cynthia Shang 2016-09-28 12:29:29 -04:00 committed by David Steele
parent 76673a8e62
commit 48f968b344
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/xml/release.xml
View File

@ -137,6 +137,18 @@
</release-refactor-list>
</release-core-list>
<release-doc-list>
<release-feature-list>
<release-item>
<release-item-contributor-list>
<release-item-contributor id="shang.cynthia"/>
</release-item-contributor-list>
<p>Added <br-option>archive-timeout</br-option> option documentation to the user guide.</p>
</release-item>
</release-feature-list>
</release-doc-list>
<release-test-list>
<release-bug-list>
<release-item>

9
doc/xml/user-guide.xml
View File

@ -400,6 +400,8 @@
<exe-cmd>{[db-cluster-wait]}</exe-cmd>
</execute>
</execute-list>
<p>When archiving a WAL segment is expected to take more than 60 seconds (the default) then the <br-option>archive-timeout</br-option> option should be increased.</p>
</section>
<!-- SECTION => QUICKSTART - CHECK CONFIGURATION -->
@ -690,6 +692,13 @@
<p>Note that <id>pg_dump</id> and <id>pg_base_backup</id> do not take online backups so are not affected. It is safe to run them in conjunction with <backrest/>.</p>
</section>
<!-- SECTION => BACKUP - ARCHIVE-TIMEOUT -->
<section id="option-archive-timeout">
<title>Archive Timeout</title>
<p>During an online backup, <backrest/> waits for WAL segments that are required to make the backup consistent to be archived. This wait time is governed by the <br-option>archive-timeout</br-option> option which defaults to 60 seconds. If archiving an individual segment is known to take longer, then this option should be increased.</p>
</section>
</section>
<!-- SECTION => RETENTION -->