diff --git a/README.rst b/README.rst index 5960216a1..bf9e59cce 100644 --- a/README.rst +++ b/README.rst @@ -45,7 +45,7 @@ Web resources Licence ------- -© Copyright 2011-2023 EnterpriseDB UK Limited +© Copyright 2011-2024 EnterpriseDB UK Limited Barman is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free diff --git a/barman/version.py b/barman/version.py index d79201dec..26390cc6e 100644 --- a/barman/version.py +++ b/barman/version.py @@ -20,4 +20,4 @@ This module contains the current Barman version. """ -__version__ = "3.10.1" +__version__ = "3.11.0" diff --git a/doc/barman-cloud-backup-delete.1 b/doc/barman-cloud-backup-delete.1 index 896694984..157ad24d1 100644 --- a/doc/barman-cloud-backup-delete.1 +++ b/doc/barman-cloud-backup-delete.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-delete.1.md b/doc/barman-cloud-backup-delete.1.md index af5cd77e3..9c5214ba0 100644 --- a/doc/barman-cloud-backup-delete.1.md +++ b/doc/barman-cloud-backup-delete.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-backup-keep.1 b/doc/barman-cloud-backup-keep.1 index 4e79ea89a..a64d61a45 100644 --- a/doc/barman-cloud-backup-keep.1 +++ b/doc/barman-cloud-backup-keep.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-keep.1.md b/doc/barman-cloud-backup-keep.1.md index 6f973979c..3cdee7dfe 100644 --- a/doc/barman-cloud-backup-keep.1.md +++ b/doc/barman-cloud-backup-keep.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-backup-list.1 b/doc/barman-cloud-backup-list.1 index 9aaa598fc..678c7bb2f 100644 --- a/doc/barman-cloud-backup-list.1 +++ b/doc/barman-cloud-backup-list.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-LIST" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-BACKUP\-LIST" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-list.1.md b/doc/barman-cloud-backup-list.1.md index 0161ce38c..cc4d5b15b 100644 --- a/doc/barman-cloud-backup-list.1.md +++ b/doc/barman-cloud-backup-list.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-LIST(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-BACKUP-LIST(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-backup-show.1 b/doc/barman-cloud-backup-show.1 index 5513ac783..41606e6dc 100644 --- a/doc/barman-cloud-backup-show.1 +++ b/doc/barman-cloud-backup-show.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-SHOW" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-BACKUP\-SHOW" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-show.1.md b/doc/barman-cloud-backup-show.1.md index ef5c1b453..1ce4eff3a 100644 --- a/doc/barman-cloud-backup-show.1.md +++ b/doc/barman-cloud-backup-show.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-SHOW(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-BACKUP-SHOW(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-backup.1 b/doc/barman-cloud-backup.1 index 6bca25dad..ab8ebb895 100644 --- a/doc/barman-cloud-backup.1 +++ b/doc/barman-cloud-backup.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-BACKUP" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup.1.md b/doc/barman-cloud-backup.1.md index b90d2915b..0c179a7da 100644 --- a/doc/barman-cloud-backup.1.md +++ b/doc/barman-cloud-backup.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-BACKUP(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-check-wal-archive.1 b/doc/barman-cloud-check-wal-archive.1 index 30599b06c..1289c3d46 100644 --- a/doc/barman-cloud-check-wal-archive.1 +++ b/doc/barman-cloud-check-wal-archive.1 @@ -1,7 +1,7 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-CHECK\-WAL\-ARCHIVE" "1" "June 12, 2024" "Barman User manuals" "Version -3.10.1" +.TH "BARMAN\-CLOUD\-CHECK\-WAL\-ARCHIVE" "1" "August 22, 2024" "Barman User manuals" "Version +3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-check-wal-archive.1.md b/doc/barman-cloud-check-wal-archive.1.md index 9d890867a..173b280df 100644 --- a/doc/barman-cloud-check-wal-archive.1.md +++ b/doc/barman-cloud-check-wal-archive.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-restore.1 b/doc/barman-cloud-restore.1 index a0590c500..15b033e56 100644 --- a/doc/barman-cloud-restore.1 +++ b/doc/barman-cloud-restore.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-RESTORE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-RESTORE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-restore.1.md b/doc/barman-cloud-restore.1.md index d515104bc..2e37bd4a9 100644 --- a/doc/barman-cloud-restore.1.md +++ b/doc/barman-cloud-restore.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-RESTORE(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-RESTORE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-wal-archive.1 b/doc/barman-cloud-wal-archive.1 index 46578e1b3..5ec6d55f8 100644 --- a/doc/barman-cloud-wal-archive.1 +++ b/doc/barman-cloud-wal-archive.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-WAL\-ARCHIVE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-WAL\-ARCHIVE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-wal-archive.1.md b/doc/barman-cloud-wal-archive.1.md index 06d1a1e74..6c21f69e6 100644 --- a/doc/barman-cloud-wal-archive.1.md +++ b/doc/barman-cloud-wal-archive.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-WAL-ARCHIVE(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-WAL-ARCHIVE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-cloud-wal-restore.1 b/doc/barman-cloud-wal-restore.1 index 6effdd39e..6ef18a040 100644 --- a/doc/barman-cloud-wal-restore.1 +++ b/doc/barman-cloud-wal-restore.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-WAL\-RESTORE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-CLOUD\-WAL\-RESTORE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-wal-restore.1.md b/doc/barman-cloud-wal-restore.1.md index 697f816ab..b3ca9c38a 100644 --- a/doc/barman-cloud-wal-restore.1.md +++ b/doc/barman-cloud-wal-restore.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-WAL-RESTORE(1) Barman User manuals | Version 3.10.1 +% BARMAN-CLOUD-WAL-RESTORE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-wal-archive.1 b/doc/barman-wal-archive.1 index 682948c48..7230fce6d 100644 --- a/doc/barman-wal-archive.1 +++ b/doc/barman-wal-archive.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-WAL\-ARCHIVE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-WAL\-ARCHIVE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-wal-archive.1.md b/doc/barman-wal-archive.1.md index 8b3208605..c67db7276 100644 --- a/doc/barman-wal-archive.1.md +++ b/doc/barman-wal-archive.1.md @@ -1,6 +1,6 @@ -% BARMAN-WAL-ARCHIVE(1) Barman User manuals | Version 3.10.1 +% BARMAN-WAL-ARCHIVE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman-wal-restore.1 b/doc/barman-wal-restore.1 index e3f626bf4..b4b3a0701 100644 --- a/doc/barman-wal-restore.1 +++ b/doc/barman-wal-restore.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-WAL\-RESTORE" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN\-WAL\-RESTORE" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP diff --git a/doc/barman-wal-restore.1.md b/doc/barman-wal-restore.1.md index bcfcc4bfb..e4605212b 100644 --- a/doc/barman-wal-restore.1.md +++ b/doc/barman-wal-restore.1.md @@ -1,6 +1,6 @@ -% BARMAN-WAL-RESTORE(1) Barman User manuals | Version 3.10.1 +% BARMAN-WAL-RESTORE(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 # NAME diff --git a/doc/barman.1 b/doc/barman.1 index 3834b62b8..fd1b51308 100644 --- a/doc/barman.1 +++ b/doc/barman.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN" "1" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN" "1" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP @@ -98,6 +98,14 @@ present in the configuration file. .RS .RE .TP +.B \-\-incremental [BACKUP_ID] +performs a block\-level incremental backup. +A \f[C]BACKUP_ID\f[] or backup ID shortcut of a previous backup must be +provided, which references a previous backup in the catalog to be used +as the parent backup from which the incremental is taken. +.RS +.RE +.TP .B \-\-reuse\-backup [INCREMENTAL_TYPE] Overrides \f[C]reuse_backup\f[] option behaviour. Possible values for \f[C]INCREMENTAL_TYPE\f[] are: @@ -179,6 +187,14 @@ archived before timing out .RS .RE .TP +.B \-\-keepalive\-interval +an interval, in seconds, at which a hearbeat query will be sent to the +server to keep the libpq connection alive during an Rsync backup. +Default is 60. +A value of 0 disables it. +.RS +.RE +.TP .B \-\-manifest forces the creation of a backup manifest file at the end of a backup. Overrides value of the parameter \f[C]autogenerate_manifest\f[], from @@ -377,49 +393,48 @@ either directly or by retention policy. .TP .B list\-backups \f[I]SERVER_NAME\f[] Show available backups for \f[C]SERVER_NAME\f[]. -This command is useful to retrieve a backup ID. +This command is useful to retrieve a backup ID and the backup type. For example: .RS .RE .IP .nf \f[C] -servername\ 20111104T102647\ \-\ Fri\ Nov\ \ 4\ 10:26:48\ 2011\ \-\ Size:\ 17.0\ MiB\ \-\ WAL\ Size:\ 100\ B +servername\ 20111104T102647\ \-\ F\ \-\ Fri\ Nov\ \ 4\ 10:26:48\ 2011\ \-\ Size:\ 17.0\ MiB\ \-\ WAL\ Size:\ 100\ B \f[] .fi +.PP +In this case, \f[I]20111104T102647\f[] is the backup ID, and \f[C]F\f[] +is the backup type label for a full backup taken with +\f[C]pg_basebackup\f[]. +The backup type label displayed by this command uses one of the +following values: \- \f[C]F\f[]: for full backups taken with +\f[C]pg_basebackup\f[] \- \f[C]I\f[]: for incremental backups taken with +\f[C]pg_basebackup\f[] \- \f[C]R\f[]: for backups taken with +\f[C]rsync\f[] \- \f[C]S\f[]: for cloud snapshot backups list\-files +\f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[] : List all +the files in a particular backup, identified by the server name and the +backup ID. +See the Backup ID shortcuts section below for available shortcuts. .IP .nf \f[C] -In\ this\ case,\ *20111104T102647*\ is\ the\ backup\ ID. +\-\-target\ *TARGET_TYPE* +:\ \ \ \ Possible\ values\ for\ TARGET_TYPE\ are: + +\ \ \ \ \ \-\ *data*:\ lists\ just\ the\ data\ files; +\ \ \ \ \ \-\ *standalone*:\ lists\ the\ base\ backup\ files,\ including\ required +\ \ \ \ \ \ \ WAL\ files; +\ \ \ \ \ \-\ *wal*:\ lists\ all\ the\ WAL\ files\ between\ the\ start\ of\ the\ base +\ \ \ \ \ \ \ backup\ and\ the\ end\ of\ the\ log\ /\ the\ start\ of\ the\ following\ base +\ \ \ \ \ \ \ backup\ (depending\ on\ whether\ the\ specified\ base\ backup\ is\ the\ most +\ \ \ \ \ \ \ recent\ one\ available); +\ \ \ \ \ \-\ *full*:\ same\ as\ data\ +\ wal. + +\ \ \ \ The\ default\ value\ is\ `standalone`. \f[] .fi .TP -.B list\-files \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[] -List all the files in a particular backup, identified by the server name -and the backup ID. -See the Backup ID shortcuts section below for available shortcuts. -.RS -.TP -.B \-\-target \f[I]TARGET_TYPE\f[] -Possible values for TARGET_TYPE are: -.RS -.IP \[bu] 2 -\f[I]data\f[]: lists just the data files; -.IP \[bu] 2 -\f[I]standalone\f[]: lists the base backup files, including required WAL -files; -.IP \[bu] 2 -\f[I]wal\f[]: lists all the WAL files between the start of the base -backup and the end of the log / the start of the following base backup -(depending on whether the specified base backup is the most recent one -available); -.IP \[bu] 2 -\f[I]full\f[]: same as data + wal. -.PP -The default value is \f[C]standalone\f[]. -.RE -.RE -.TP .B list\-servers Show all the configured servers, and their descriptions. .RS @@ -653,6 +668,16 @@ and has no effect otherwise. .RS .RE .TP +.B \-\-local\-staging\-path \f[I]STAGING_PATH\f[] +A path to a location on the barman host where the chain of backups will +be combined before being copied to the destination directory. +Contents created inside the staging path are removed at the end of the +recovery process. +This option is \f[I]required\f[] when recovering from incremental +backups (backup_method=postgres) and has no effect otherwise. +.RS +.RE +.TP .B \-\-recovery\-conf\-filename \f[I]RECOVERY_CONF_FILENAME\f[] The name of the file where Barman should write the PostgreSQL recovery options when recovering backups for PostgreSQL versions 12 and later. @@ -739,21 +764,30 @@ server Show detailed information about a particular backup, identified by the server name and the backup ID. See the Backup ID shortcuts section below for available shortcuts. -For example: +The following example is from a block\-level incremental backup (which +requires Postgres version >= 17): .RS .RE .IP .nf \f[C] -Backup\ 20150828T130001: +Backup\ 20240814T017504: \ \ Server\ Name\ \ \ \ \ \ \ \ \ \ \ \ :\ quagmire \ \ Status\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ DONE \ \ PostgreSQL\ Version\ \ \ \ \ :\ 90402 \ \ PGDATA\ directory\ \ \ \ \ \ \ :\ /srv/postgresql/9.4/main/data +\ \ Estimated\ Cluster\ Size\ :\ 22.4\ MiB + +\ \ Server\ information: +\ \ \ \ Checksums\ \ \ \ \ \ \ \ \ \ \ \ :\ on +\ \ \ \ WAL\ summarizer\ \ \ \ \ \ \ :\ on \ \ Base\ backup\ information: -\ \ \ \ Disk\ usage\ \ \ \ \ \ \ \ \ \ \ :\ 12.4\ TiB\ (12.4\ TiB\ with\ WALs) -\ \ \ \ Incremental\ size\ \ \ \ \ :\ 4.9\ TiB\ (\-60.02%) +\ \ \ \ Backup\ Method\ \ \ \ \ \ \ \ :\ postgres +\ \ \ \ Backup\ Type\ \ \ \ \ \ \ \ \ \ :\ incremental +\ \ \ \ Backup\ Size\ \ \ \ \ \ \ \ \ \ :\ 22.3\ MiB\ (54.3\ MiB\ with\ WALs) +\ \ \ \ WAL\ Size\ \ \ \ \ \ \ \ \ \ \ \ \ :\ 32.0\ MiB +\ \ \ \ Resources\ saved\ \ \ \ \ :\ 19.5\ MiB\ (86.80%) \ \ \ \ Timeline\ \ \ \ \ \ \ \ \ \ \ \ \ :\ 1 \ \ \ \ Begin\ WAL\ \ \ \ \ \ \ \ \ \ \ \ :\ 0000000100000CFD000000AD \ \ \ \ End\ WAL\ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ 0000000100000D0D00000008 @@ -761,6 +795,8 @@ Backup\ 20150828T130001: \ \ \ \ WAL\ compression\ ratio:\ 79.51% \ \ \ \ Begin\ time\ \ \ \ \ \ \ \ \ \ \ :\ 2015\-08\-28\ 13:00:01.633925+00:00 \ \ \ \ End\ time\ \ \ \ \ \ \ \ \ \ \ \ \ :\ 2015\-08\-29\ 10:27:06.522846+00:00 +\ \ \ \ Copy\ time\ \ \ \ \ \ \ \ \ \ \ \ :\ 1\ second +\ \ \ \ Estimated\ throughput\ :\ 2.0\ MiB/s \ \ \ \ Begin\ Offset\ \ \ \ \ \ \ \ \ :\ 1575048 \ \ \ \ End\ Offset\ \ \ \ \ \ \ \ \ \ \ :\ 13853016 \ \ \ \ Begin\ XLOG\ \ \ \ \ \ \ \ \ \ \ :\ CFD/AD180888 @@ -777,8 +813,54 @@ Backup\ 20150828T130001: \ \ \ \ Retention\ Policy\ \ \ \ \ :\ not\ enforced \ \ \ \ Previous\ Backup\ \ \ \ \ \ :\ 20150821T130001 \ \ \ \ Next\ Backup\ \ \ \ \ \ \ \ \ \ :\ \-\ (this\ is\ the\ latest\ base\ backup) +\ \ \ \ Root\ Backup\ \ \ \ \ \ \ \ \ \ :\ 20240814T015504 +\ \ \ \ Parent\ Backup\ \ \ \ \ \ \ \ :\ 20240814T016504 +\ \ \ \ Backup\ chain\ size\ \ \ \ :\ 3 +\ \ \ \ Children\ Backup(s)\ \ \ :\ 20240814T018515 \f[] .fi +.RS +.PP +\f[B]NOTE:\f[] Depending on the version of your Postgres Server and/or +the type of the backup, the output of \f[C]barman\ show\-backup\f[] +command may be different. +For example, fields like "Root Backup", "Parent Backup", "Backup chain +size", and "Children Backup(s)" only make sense when showing information +about a block\-level incremental backup taken with +\f[C]backup_method\ =\ postgres\f[] and using Postgres 17 or newer, thus +those fields are omitted for other kind of backups or older versions of +Postgres. +.PP +Also note that \f[C]show\-backup\f[] relies on the backup metadata so if +a backup was created with Barman version 3.10 or earlier, the backup +will not contain the fields added in version 3.11 (which are those added +after the introduction of "incremental" backups in PostgreSQL 17). +.PP +These are the possible values for the field "Backup Type": +.IP \[bu] 2 +\f[C]rsync\f[]: for a backup taken with \f[C]rsync\f[]; +.IP \[bu] 2 +\f[C]full\f[]: for a full backup taken with \f[C]pg_basebackup\f[]; +.IP \[bu] 2 +\f[C]incremental\f[]: for an incremental backup taken with +\f[C]pg_basebackup\f[]; +.IP \[bu] 2 +\f[C]snapshot\f[]: for a snapshot\-based backup taken in the cloud. +.PP +Below you can find a list of fields that may be shown or omitted +depending on the type of the backup: +.IP \[bu] 2 +\f[C]Resources\ saved\f[]: available for "rsync" and "incremental" +backups; +.IP \[bu] 2 +\f[C]Root\ Backup\f[], \f[C]Parent\ Backup\f[], +\f[C]Backup\ chain\ size\f[]: available for "incremental" backups only; +.IP \[bu] 2 +\f[C]Children\ Backup(s)\f[]: available for "full" and "incremental" +backups; +.IP \[bu] 2 +\f[C]Snapshot\ information\f[]: available for "snapshot" backups only. +.RE .TP .B show\-servers \f[I]SERVER_NAME\f[] Show information about \f[C]SERVER_NAME\f[], including: @@ -932,7 +1014,17 @@ same ast \f[I]first\f[]. Latest failed backup, in chronological order. .RS .RE -.SH EXIT STATUS +.TP +.B last\-full +Latest full\-backup eligible for a block\-level incremental backup using +the \f[C]\-\-incremental\f[] option. +.RS +.RE +.TP +.B latest\-full +same as \f[I]last\-full\f[] # EXIT STATUS +.RS +.RE .TP .B 0 Success diff --git a/doc/barman.1.d/00-header.md b/doc/barman.1.d/00-header.md index bb32fc98c..fe87d894b 100644 --- a/doc/barman.1.d/00-header.md +++ b/doc/barman.1.d/00-header.md @@ -1,3 +1,3 @@ -% BARMAN(1) Barman User manuals | Version 3.10.1 +% BARMAN(1) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 diff --git a/doc/barman.5 b/doc/barman.5 index bb130dc2a..9a4876983 100644 --- a/doc/barman.5 +++ b/doc/barman.5 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN" "5" "June 12, 2024" "Barman User manuals" "Version 3.10.1" +.TH "BARMAN" "5" "August 22, 2024" "Barman User manuals" "Version 3.11.0" .hy .SH NAME .PP @@ -121,6 +121,15 @@ The option is ignored if the backup method is not rsync. Scope: Global/Server/Model. .RE .TP +.B aws_await_snapshots_timeout +The length of time in seconds to wait for snapshots to be created in AWS +before timing out. +Positive integer, default 3600. +.RS +.PP +Scope: Global/Server/Model. +.RE +.TP .B aws_profile The name of the AWS profile to use when authenticating with AWS (e.g. INI section in AWS credentials file). @@ -509,6 +518,16 @@ Requires \f[C]archiver\f[] to be enabled. Scope: Server. .RE .TP +.B keepalive_interval +An interval, in seconds, at which a hearbeat query will be sent to the +server to keep the libpq connection alive during an Rsync backup. +Default is 60. +A value of 0 disables it. +.RS +.PP +Scope: Global/Server/Model. +.RE +.TP .B last_backup_maximum_age This option identifies a time frame that must contain the latest backup. If the latest backup is older than the time frame, barman check command @@ -549,6 +568,18 @@ Syntax is the same as last_backup_maximum_age (above). Scope: Global/Server/Model. .RE .TP +.B local_staging_path +A path to a location on the local host where incremental backups will be +combined during the recovery. +This location must have enough available space to temporarily hold the +new synthetic backup. +This option is \f[I]required\f[] when recovering from an incremental +backup and has no effect otherwise. +.RS +.PP +Scope: Global/Server/Model. +.RE +.TP .B lock_directory_cleanup enables automatic cleaning up of the \f[C]barman_lock_directory\f[] from unused lock files. diff --git a/doc/barman.5.d/00-header.md b/doc/barman.5.d/00-header.md index 901effe7c..c21df4c28 100644 --- a/doc/barman.5.d/00-header.md +++ b/doc/barman.5.d/00-header.md @@ -1,3 +1,3 @@ -% BARMAN(5) Barman User manuals | Version 3.10.1 +% BARMAN(5) Barman User manuals | Version 3.11.0 % EnterpriseDB -% June 12, 2024 +% August 22, 2024 diff --git a/doc/manual/00-head.en.md b/doc/manual/00-head.en.md index 83b052cbb..d04df8379 100644 --- a/doc/manual/00-head.en.md +++ b/doc/manual/00-head.en.md @@ -1,6 +1,6 @@ % Barman Manual % EnterpriseDB UK Limited -% June 12, 2024 (3.10.1) +% August 22, 2024 (3.11.0) **Barman** (Backup and Recovery Manager) is an open-source administration tool for disaster recovery of PostgreSQL servers written in Python. It allows your organisation to perform remote backups of multiple servers in business critical environments to reduce risk and help DBAs during the recovery phase.