58.5. Backup Schedules #
58.5.1. Creating a Backup Schedule #
In the navigation panel, go to Backup → Schedule.
In the top-right corner of the page, click Create task.
Specify parameters of the new backup schedule (parameters marked with an asterisk are required):
Name.
Set cron-string execution: Allows specifying the interval for creating backups in the crontab format.
If you turn on this toggle, in Execution, enter the string.
Execution: The type of the backup schedule.
Possible values:
Once: Create the backup at the specified date and time.
Repeated: Create the backup at the specified interval.
For this value, specify the following parameters:
Interval: The unit of measurement of the interval.
Possible values:
Minutes
Hours
Days
Repeat every: The interval for creating the backup by minutes or hours.
This parameter is available only if you select Minutes or Hours from Interval.
Execution days: Days when the backup is created.
Cron total line: The string in the crontab format that specifies the interval for creating the backup.
This parameter is available only if you turn off Set cron-string execution.
Date and time / Time: The date and/or time when the backup is created.
This parameter is available only if you select Once from Execution or Days from Interval.
Start and Repeat until: The start and end date and time for creating the backup at the specified interval.
These parameters are available only if you turn on Set cron-string execution or select Repeated from Execution.
Description: The description of the backup schedule.
Instance: The instance for which the backup is created.
Storage: The storage where the backup is located.
You can use a local or S3 storage. The local storage must be located on the same server as the instance for which the backup is created.
User and Password: The name and password of the DBMS user on behalf of which the backup is created.
Database: The database for connecting to the instance.
Backup mode: The backup creation mode.
Possible values:
FULL
PAGE
PTRACK
DELTA
For more information about backup modes, refer to the official Postgres Pro documentation on pg_probackup.
Threads: The number of parallel threads that are started at backup creation.
Waiting (sec): The waiting timeout in seconds for WAL segment archiving and streaming.
Create a standalone backup: Specifies whether to create a streaming backup that includes WAL records required for restoring the instance later.
Replication slot: The replication slot that is used for transferring WAL records.
Create temporary replication slot: Specifies whether to create a temporary replication slot for transferring WAL records of the instance for which the backup is created.
If you enable this checkbox, WAL segments are available even when they are switched at backup creation.
Click Next, and then specify additional parameters if required:
External directories: The path to directories located outside of the instance data directory that are also included in the backup.
You can enter multiple directories separated by commas.
Include log catalog: Specifies whether the backup includes the catalog with instance activity logs.
Don't check copy: Specifies whether to skip the automatic verification of the created backup.
If you enable this checkbox, the backup is created faster.
Smooth execution of the checkpoint: Specifies whether backup creation starts only after the scheduled checkpoint.
Disable block-level verification: Specifies whether to disable the block-level checksum verification for faster consistency checking at backup creation.
Log level: The logging level at backup creation.
Each level includes all the levels that follow it. The lower the level, the fewer messages are sent. The off level disables logging.
PPEM displays all possible values. However, supported values depend on the installed pg_probackup version:
Table 58.2. Supported Log Level Values
Log level
verboseloginfonoticewarningerroroff2.8.10 or higher
Yes
Yes
Yes
Yes
No
No
No
2.8.9 or higher
Yes
Yes
Yes
No
No
No
No
If an unsupported value is selected, a warning is displayed, and the verbose value is selected.
Compression level: The file compression level at backup creation.
You can enter a value from 0 to 9, where 0 disables file compression, and 9 enables the highest file compression level.
Compression algorithm: The algorithm used for compressing files.
Possible values:
zlib
lz4
zstd
pglz
This parameter is available only if you enter a value greater than 0 in Compression level.
Pinning: Backup pinning parameters.
Possible values:
Do not pin: Do not pin the backup.
If you select this value, parameters specified in Storage parameters are used.
ttl: After the backup is created, it cannot be deleted from a storage during the specified number of days.
For this value, in Retention period, days, enter the number of days.
expire-time: The backup cannot be deleted from a storage until the specified date and time.
For this value, in Retention period until, specify the date and time.
Storage parameters: Storage parameters of the backup catalog.
Available parameters:
Full backups, pcs.: The maximum number of full backups.
For example, if you enter
3, the catalog can contain a maximum of three full backups.To disable this limitation, enter
0. In this case, the number of backups in the catalog is not limited.Retention window, days: The number of days (24 hours) covered by backups.
For example, if you enter
7, the catalog must always contain backups required for restoring the data for the last seven days, including today.To disable this limitation, enter
0. In this case, backups can be deleted from the catalog at any moment.WAL depth, pcs.: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
For example, if you enter
3, the catalog must always contain at least three backups on each timeline.To disable this limitation, enter
0. In this case, point-in-time recovery is not available.Expired copies: The management policy for expired backups.
Possible values:
Merge: Merge expired backups with new ones if possible.
Delete: Delete expired backups from the catalog.
Remove expired WAL: Delete WAL of expired backups from the catalog.
You can enable all checkboxes simultaneously.
Full backups, pcs, Retention window, days, and WAL depth, pcs are applied only if you enable Merge and/or Delete in Expired copies.
Values of Full backups, pcs. and Retention window, days are considered simultaneously when deleting expired backups from the catalog.
For example, if you enter
3in Full backups, pcs. and7in Retention window, days, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past seven days, including today.The following priority is applied:
backup parameters are applied first
instance parameters are applied second
storage parameters are applied third
For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Save.
58.5.2. Viewing Backup Schedules #
In the navigation panel, go to Backup → Schedule.
The table of backup schedules with the following columns will be displayed:
Task: The unique name of the backup schedule.
Instance: The instance for which the backup is created.
Storage: The storage where the backup is located.
You can use a local or S3 storage. The local storage must be located on the same server as the instance for which the backup is created.
Compression level: The file compression level at backup creation.
You can enter a value from 0 to 9, where 0 disables file compression, and 9 enables the highest file compression level.
Last execution: The date and time of the last backup creation.
Schedule: The string in the crontab format that specifies the interval for creating a backup.
User: The user that created the backup schedule.
Actions.
For more information about available actions, refer to the corresponding instructions.
58.5.3. Editing a Backup Schedule #
Go to backup schedules in one of the following ways:
Using the backup section:
In the navigation panel, go to Backup → Schedule.
Click
next to the task.
Using the task console section:
In the navigation panel, go to Task console → Schedule.
Click
next to the task of the Creating a backup type. To determine the type of the task, refer to the Parameters column.
Edit schedule parameters.
For more information about these parameters, refer to Section 58.5.1.
When editing a schedule using the task console section, the following additional parameters are displayed:
Type: The type of the task.
Operation • Object: The operation description and the name of the object on which the operation is executed.
To go to the detailed object view, click the name of the object.
Click Save.
58.5.4. Executing a Backup Schedule #
You can manually execute a backup schedule to instantly start the backup creation.
To execute a backup schedule:
In the navigation panel, go to Backup → Schedule.
Click
next to the backup schedule.
58.5.5. Deactivating and Activating a Backup Schedule #
You can deactivate a backup schedule to temporarily stop backup creation. Backup schedules are activated by default.
To deactivate or activate a backup schedule:
In the navigation panel, go to Backup → Schedule.
Click
→ Deactivate or Activate next to the backup schedule.
58.5.6. Deleting a Backup Schedule #
Important
Deleted backup schedules cannot be restored.
When you delete a backup schedule, associated backups are not deleted.
To delete a backup schedule:
In the navigation panel, go to Backup → Schedule.
Click
→ Delete next to the backup schedule. Click Delete.