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

Update references to recovery.conf.

Browse Source 
Update references to recovery.conf to include postgresql.auto.conf used in newer versions.

Also update a broken recovery URL and point it to the current version (with a hint to select the proper version of PostgreSQL).
This commit is contained in:
David Steele 2024-02-16 11:37:31 +13:00 committed by GitHub
parent 273d5050f8
commit 68351785f6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/xml/release/2024/2.51.xml
View File

@ -25,4 +25,20 @@
</release-item> </release-item>
</release-improvement-list> </release-improvement-list>
</release-core-list> </release-core-list>
<release-doc-list>
<release-improvement-list>
<release-item>
<github-pull-request id="2281"/>
<release-item-contributor-list>
<release-item-ideator id="stephen.frost"/>
<release-item-contributor id="david.steele"/>
<release-item-reviewer id="stefan.fercot"/>
</release-item-contributor-list>
<p>Update references to <file>recovery.conf</file>.</p>
</release-item>
</release-improvement-list>
</release-doc-list>
</release> </release>

14
src/build/help/help.xml
View File

@ -1608,14 +1608,16 @@
</config-key> </config-key>
<config-key id="recovery-option" name="Recovery Option"> <config-key id="recovery-option" name="Recovery Option">
<summary>Set an option in <file>recovery.conf</file>.</summary> <summary>Set an option in <file>postgresql.auto.conf</file> or <file>recovery.conf</file>.</summary>
<text> <text>
<p>See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on recovery.conf options (replace X.X with your <postgres/> version). This option can be used multiple times.</p> <p>See <link url="https://www.postgresql.org/docs/current/runtime-config.html">Server Configuration</link> for details on <file>postgresql.auto.conf</file> or <file>recovery.conf</file> options (be sure to select your <postgres/> version). This option can be used multiple times.</p>
<p>For <postgres/> &gt;= 12, options will be written into <file>postgresql.auto.conf</file>. For all other versions, options will be written into <file>recovery.conf</file>.</p>
<admonition type="note">The <setting>restore_command</setting> option will be automatically generated but can be overridden with this option. Be careful about specifying your own <setting>restore_command</setting> as <backrest/> is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by <backrest/> and should not be set with this option.</admonition> <admonition type="note">The <setting>restore_command</setting> option will be automatically generated but can be overridden with this option. Be careful about specifying your own <setting>restore_command</setting> as <backrest/> is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by <backrest/> and should not be set with this option.</admonition>
<p>Since <backrest/> does not start <postgres/> after writing the <file>recovery.conf</file> file, it is always possible to edit/check <file>recovery.conf</file> before manually restarting.</p> <p>Since <backrest/> does not start <postgres/> after writing the <file>postgresql.auto.conf</file> or <file>recovery.conf</file> file, it is always possible to edit/check <file>postgresql.auto.conf</file> or <file>recovery.conf</file> before manually restarting.</p>
</text> </text>
<example>primary_conninfo=db.mydomain.com</example> <example>primary_conninfo=db.mydomain.com</example>
@ -2432,9 +2434,9 @@
<list-item><id>name</id> - recover the restore point specified in <br-option>--target</br-option>.</list-item> <list-item><id>name</id> - recover the restore point specified in <br-option>--target</br-option>.</list-item>
<list-item><id>xid</id> - recover to the transaction id specified in <br-option>--target</br-option>.</list-item> <list-item><id>xid</id> - recover to the transaction id specified in <br-option>--target</br-option>.</list-item>
<list-item><id>time</id> - recover to the time specified in <br-option>--target</br-option>.</list-item> <list-item><id>time</id> - recover to the time specified in <br-option>--target</br-option>.</list-item>
<list-item><id>preserve</id> - preserve the existing <file>recovery.conf</file> file.</list-item> <list-item><id>preserve</id> - preserve the existing <file>postgresql.auto.conf</file> or <file>recovery.conf</file> file.</list-item>
<list-item><id>standby</id> - add <setting>standby_mode=on</setting> to <file>recovery.conf</file> file so cluster will start in standby mode.</list-item> <list-item><id>standby</id> - add <setting>standby_mode=on</setting> to the <file>postgresql.auto.conf</file> or <file>recovery.conf</file> file so cluster will start in standby mode.</list-item>
<list-item><id>none</id> - no <file>recovery.conf</file> file is written so <postgres/> will attempt to achieve consistency using WAL segments present in <path>pg_xlog</path>/<path>pg_wal</path>. Provide the required WAL segments or use the <setting>archive-copy</setting> setting to include them with the backup.</list-item> <list-item><id>none</id> - no <file>postgresql.auto.conf</file> or <file>recovery.conf</file> file is written so <postgres/> will attempt to achieve consistency using WAL segments present in <path>pg_xlog</path>/<path>pg_wal</path>. Provide the required WAL segments or use the <setting>archive-copy</setting> setting to include them with the backup.</list-item>
</list> </list>
<admonition type="warning">Recovery <br-option>type=none</br-option> should be avoided because the timeline will not be incremented at the end of recovery. This can lead to, for example, <postgres/> attempting to archive duplicate WAL, which will be rejected, and may cause the disk to fill up and result in a <postgres/> panic. In addition, tools like <id>pg_rewind</id> may not work correctly or may cause corruption.</admonition> <admonition type="warning">Recovery <br-option>type=none</br-option> should be avoided because the timeline will not be incremented at the end of recovery. This can lead to, for example, <postgres/> attempting to archive duplicate WAL, which will be rejected, and may cause the disk to fill up and result in a <postgres/> panic. In addition, tools like <id>pg_rewind</id> may not work correctly or may cause corruption.</admonition>

3
test/src/module/command/helpTest.c
View File

@ -212,7 +212,8 @@ testRun(void)
" --link-all restore all symlinks [default=n]\n" " --link-all restore all symlinks [default=n]\n"
" --link-map modify the destination of a symlink\n" " --link-map modify the destination of a symlink\n"
" [current=/link1=/dest1, /link2=/dest2]\n" " [current=/link1=/dest1, /link2=/dest2]\n"
" --recovery-option set an option in recovery.conf\n" " --recovery-option set an option in postgresql.auto.conf or\n"
" recovery.conf\n"
" --set backup set to restore [default=latest]\n" " --set backup set to restore [default=latest]\n"
" --tablespace-map restore a tablespace into the specified\n" " --tablespace-map restore a tablespace into the specified\n"
" directory\n" " directory\n"