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

Document the relationship between db-timeout and protocol-timeout.

Browse Source 
Contributed by Cynthia Shang.
Suggested by James Chanco Jr.
This commit is contained in:
David Steele 2019-09-13 12:28:39 -04:00
parent 15d04ca19c
commit f57e119b25
3 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/xml/reference.xml
View File

@ -157,7 +157,7 @@
<config-key id="db-timeout" name="Database Timeout">
<summary>Database query timeout.</summary>
<text>Sets the timeout, in seconds, for queries against the database. This includes the <code>pg_start_backup()</code> and <code>pg_stop_backup()</code> functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set <setting>startfast=y</setting> and you know that the database cluster will not generate many WAL segments during the backup).</text>
<text>Sets the timeout, in seconds, for queries against the database. This includes the <code>pg_start_backup()</code> and <code>pg_stop_backup()</code> functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set <setting>startfast=y</setting> and you know that the database cluster will not generate many WAL segments during the backup). <admonition type="note">The <br-option>db-timeout</br-option> option must be less than the <br-option>protocol-timeout</br-option> option.</admonition></text>
<example>600</example>
</config-key>
@ -223,7 +223,7 @@
<config-key id="protocol-timeout" name="Protocol Timeout">
<summary>Protocol timeout.</summary>
<text>Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message. The <br-option>protocol-timeout</br-option> option must be greater than the <br-option>db-timeout</br-option> option.</text>
<text>Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message. <admonition type="note">The <br-option>protocol-timeout</br-option> option must be greater than the <br-option>db-timeout</br-option> option.</admonition></text>
<example>630</example>
</config-key>

13
doc/xml/release.xml
View File

@ -32,6 +32,19 @@
</release-item>
</release-development-list>
</release-core-list>
<release-doc-list>
<release-improvement-list>
<release-item>
<release-item-contributor-list>
<release-item-ideator id="james.chanco.jr"/>
<release-item-contributor id="cynthia.shang"/>
</release-item-contributor-list>
<p>Document the relationship between <br-option>db-timeout</br-option> and <br-option>protocol-timeout</br-option>.</p>
</release-item>
</release-improvement-list>
</release-doc-list>
</release>
<release date="2019-09-03" version="2.17" title="C Migrations and Bug Fixes">

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

@ -1015,7 +1015,8 @@ static ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
"Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and "
"pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should "
"be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you "
"know that the database cluster will not generate many WAL segments during the backup)."
"know that the database cluster will not generate many WAL segments during the backup). \n"
"NOTE: The db-timeout option must be less than the protocol-timeout option."
)
CFGDEFDATA_OPTION_COMMAND_LIST
@ -2574,8 +2575,8 @@ static ConfigDefineOptionData configDefineOptionData[] = CFGDEFDATA_OPTION_LIST
CFGDEFDATA_OPTION_HELP_DESCRIPTION
(
"Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the "
"protocol layer. This prevents processes from waiting indefinitely for a message. The protocol-timeout option must "
"be greater than the db-timeout option."
"protocol layer. This prevents processes from waiting indefinitely for a message. \n"
"NOTE: The protocol-timeout option must be greater than the db-timeout option."
)
CFGDEFDATA_OPTION_COMMAND_LIST