Updated on 2024-05-07 GMT+08:00

Backup and Restoration

operation_mode

Parameter description: Specifies whether the system enters the backup and restoration mode.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: Boolean

  • on indicates that the system is in the backup and restoration mode.
  • off indicates that the system is not in the backup and restoration mode.

Default value: off

enable_cbm_tracking

Parameter description: Specifies whether to enable cbm tracking. To perform full or incremental backup for the cluster by using Roach, set this parameter to on. Otherwise, the backup will fail.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: Boolean

  • on: The cbm tracking is enabled.
  • off: The cbm tracking is disabled.

Default value: off

max_size_for_xlog_retention

Parameter description: Specifies when to forcibly push the backup replication slot to prevent the disk from being full and the cluster from being read-only because logs cannot be recycled during backup. It is recommended that the value of this parameter be a little smaller than the value of datastorage_threshold_value_check of the CM Server component to prevent the cluster from entering the read-only state.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: –100 to 2147483647

  • The value 0 indicates that this function is disabled.
  • A negative value indicates that the backup replication slot is forcibly pushed when the disk usage exceeds 80% and log recycling is blocked due to backup operations. For example, –80 indicates that the backup replication slot is forcibly pushed when the disk usage exceeds 80%.
  • A positive value indicates that the backup replication slot is triggered based on the size of stacked logs. For example, 32 indicates that the backup replication slot is forcibly pushed when the redo position of the current checkpoint exceeds 32 log segments (the size of each log segment is 16 MB) and logs are recycled because the backup operation is blocked.

Default value: 0

max_cbm_retention_time

Parameter description: Specifies the interval at which CBM backup files are forcibly recycled. If CBM files cannot be recycled during backup, the disk will be full and the cluster will be read-only. You are advised to set this parameter based on the full backup interval.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: 86400 to 2147483647

  • The unit is second.
  • The minimum value is 1 day.
  • The default value is 2 weeks.

Default value: 1209600