db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-03-03 14:52:21 +02:00
Code Issues Releases Activity

Update out-of-date description for the spool-path option.

Browse Source
This commit is contained in:
David Steele 2018-04-17 17:38:25 -04:00
parent cf0ec44ede
commit e9790fd3b1
4 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/xml/reference.xml
View File

@ -174,11 +174,11 @@
<!-- CONFIG - GENERAL SECTION - LOG-PATH KEY -->
<config-key id="spool-path" name="Spool Path">
<summary>Path where WAL segments are spooled during async archiving.</summary>
<summary>Path where transient data is stored.</summary>
<text>When asynchronous archiving is enabled <backrest/> needs a local directory to store WAL segments before they are compressed and moved to the repository. Depending on the volume of WAL generated this directory could become very large so be sure to plan accordingly.
<text>This path is used to store acknowledgements from the asynchronous <cmd>archive-push</cmd> process. These files are generally very small (zero to a few hundred bytes) so not much space is required.
The <setting>archive-queue-max</setting> option can be used to limit the amount of WAL that will be spooled locally.</text>
The data stored in the spool path is not strictly temporary since it can and should survive a reboot. However, loss of the data in the spool path is not a problem. <backrest/> will simply recheck each WAL segment to ensure it is safely archived.</text>
<example>/backup/db/spool</example>
</config-key>

4
doc/xml/release.xml
View File

@ -99,6 +99,10 @@
<release-item>
<p>Remove documentation describing <code>info --output=json</code> as experimental.</p>
</release-item>
<release-item>
<p>Update out-of-date description for the <br-option>spool-path</br-option> option.</p>
</release-item>
</release-improvement-list>
<release-development-list>

11
src/config/define.auto.c
View File

@ -3313,14 +3313,15 @@ static ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
CFGDEFDATA_OPTION_SECURE(false)
CFGDEFDATA_OPTION_HELP_SECTION("general")
CFGDEFDATA_OPTION_HELP_SUMMARY("Path where WAL segments are spooled during async archiving.")
CFGDEFDATA_OPTION_HELP_SUMMARY("Path where transient data is stored.")
CFGDEFDATA_OPTION_HELP_DESCRIPTION
(
"When asynchronous archiving is enabled pgBackRest needs a local directory to store WAL segments before they are "
"compressed and moved to the repository. Depending on the volume of WAL generated this directory could become very "
"large so be sure to plan accordingly.\n"
"This path is used to store acknowledgements from the asynchronous archive-push process. These files are generally "
"very small (zero to a few hundred bytes) so not much space is required.\n"
"\n"
"The archive-queue-max option can be used to limit the amount of WAL that will be spooled locally."
"The data stored in the spool path is not strictly temporary since it can and should survive a reboot. Loss of the "
"data in the spool path is not an issue. pgBackRest will simply recheck each WAL segment to ensure it is safely "
"archived."
)
CFGDEFDATA_OPTION_COMMAND_LIST

4
test/src/module/help/helpTest.c
View File

@ -125,8 +125,8 @@ testRun()
" --process-max max processes to use for compress/transfer\n"
" [default=1]\n"
" --protocol-timeout protocol timeout [default=1830]\n"
" --spool-path path where WAL segments are spooled during async\n"
" archiving [default=/var/spool/pgbackrest]\n"
" --spool-path path where transient data is stored\n"
" [default=/var/spool/pgbackrest]\n"
" --stanza defines the stanza\n"
"\n"
"Log Options:\n"