db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-10-30 23:37:45 +02:00
Code Issues Releases Activity

Clarify behavior of --repo-retention-full-type.

Browse Source 
Make some clarifications and add explicit documentation for repo-retention-full-type=count.
This commit is contained in:
David Steele
2025-03-24 12:21:31 -06:00
committed by GitHub
parent 5d2c67c3c6
commit 84eb9a742d
3 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/xml/release/2025/2.55.0.xml
View File

@@ -219,6 +219,19 @@
<p>Caveat <br-setting>--tablespace-map-all</br-setting> regarding tablespace creation.</p>
</release-item>
<release-item>
<github-issue id="2562"/>
<github-pull-request id="2583"/>
<release-item-contributor-list>
<release-item-ideator id="antoine.beaupre"/>
<release-item-contributor id="david.steele"/>
<release-item-reviewer id="antoine.beaupre"/>
</release-item-contributor-list>
<p>Clarify behavior of <br-setting>--repo-retention-full-type</br-setting>.</p>
</release-item>
<release-item>
<github-pull-request id="2542"/>

5
doc/xml/release/contributor.xml
View File

@@ -90,6 +90,11 @@
<contributor-id type="github">andr-sokolov</contributor-id>
</contributor>
<contributor id="antoine.beaupre">
<contributor-name-display>Antoine Beaupr&amp;eacute;</contributor-name-display>
<contributor-id type="github">anarcat</contributor-id>
</contributor>
<contributor id="antoine.millet">
<contributor-name-display>Antoine Millet</contributor-name-display>
<contributor-id type="github">NaPs</contributor-id>

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

@@ -900,7 +900,13 @@
<summary>Retention type for full backups.</summary>
<text>
<p>Determines whether the <setting>repo-retention-full</setting> setting represents a time period (days) or count of full backups to keep. If set to <setting>time</setting> then full backups older than <setting>repo-retention-full</setting> will be removed from the repository if there is at least one backup that is equal to or greater than the <setting>repo-retention-full</setting> setting. For example, if <setting>repo-retention-full</setting> is 30 (days) and there are 2 full backups: one 25 days old and one 35 days old, no full backups will be expired because expiring the 35 day old backup would leave only the 25 day old backup, which would violate the 30 day retention policy of having at least one backup 30 days old before an older one can be expired. Archived WAL older than the oldest full backup remaining will be automatically expired unless <setting>repo-retention-archive-type</setting> and <setting>repo-retention-archive</setting> are explicitly set.</p>
<p>Determines whether the <setting>repo-retention-full</setting> setting represents a time period (days) or count of full backups to keep.</p>
<p>If set to <setting>time</setting> then full backups older than <setting>repo-retention-full</setting> will be removed from the repository if there is at least one other backup that is equal to or greater than the <setting>repo-retention-full</setting> setting. For example, if <setting>repo-retention-full</setting> is 30 (days) and there are 2 full backups: one 25 days old and one 35 days old, no full backups will be expired because expiring the 35 day old backup would leave only the 25 day old backup, which would violate the 30 day retention policy of having at least one backup 30 days old before an older one can be expired. Archived WAL older than the oldest full backup remaining will be automatically expired unless <setting>repo-retention-archive-type</setting> and <setting>repo-retention-archive</setting> are explicitly set.</p>
<p>If set to <setting>count</setting> then full backups that exceed <setting>repo-retention-full</setting> will be expired. For example, if <setting>repo-retention-full</setting> is <setting>4</setting> and a fifth full backup is completed, then the oldest full backup will be expired to keep the count at 4.</p>
<p>Note that a backup must be successfully completed before it will be considered for retention. For example, if <setting>repo-retention-full-type</setting> is <setting>count</setting> and <setting>repo-retention-full</setting> is <setting>2</setting>, then there must be 3 complete full backups before the oldest will be expired.</p>
</text>
<example>time</example>