Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

backup_restore_* session settings

These settings are available in system.settings and are autogenerated from source.

backup_restore_batch_size_for_keeper_multi

Type
UInt64
Default
1000

Maximum size of batch for multi request to [Zoo]Keeper during backup or restore

backup_restore_batch_size_for_keeper_multiread

Type
UInt64
Default
10000

Maximum size of batch for multiread request to [Zoo]Keeper during backup or restore

backup_restore_failure_after_host_disconnected_for_seconds

Type
UInt64
Default
3600
Version history
VersionDefault valueComment
24.113600New setting.
24.103600New setting.

If a host during a BACKUP ON CLUSTER or RESTORE ON CLUSTER operation doesn’t recreate its ephemeral ‘alive’ node in ZooKeeper for this amount of time then the whole backup or restore is considered as failed. This value should be bigger than any reasonable time for a host to reconnect to ZooKeeper after a failure. Zero means unlimited.

backup_restore_finish_timeout_after_error_sec

Type
UInt64
Default
180
Version history
VersionDefault valueComment
24.11180New setting.
24.10180New setting.

How long the initiator should wait for other host to react to the ‘error’ node and stop their work on the current BACKUP ON CLUSTER or RESTORE ON CLUSTER operation.

backup_restore_keeper_fault_injection_probability

Type
Float
Default
0

Approximate probability of failure for a keeper request during backup or restore. Valid value is in interval [0.0f, 1.0f]

backup_restore_keeper_fault_injection_seed

Type
UInt64
Default
0

0 - random seed, otherwise the setting value

backup_restore_keeper_max_retries

Type
UInt64
Default
1000
Version history
VersionDefault valueComment
24.111000Should be big enough so the whole operation BACKUP or RESTORE operation won't fail because of a temporary [Zoo]Keeper failure in the middle of it.
24.101000Should be big enough so the whole operation BACKUP or RESTORE operation won't fail because of a temporary [Zoo]Keeper failure in the middle of it.

Max retries for [Zoo]Keeper operations in the middle of a BACKUP or RESTORE operation. Should be big enough so the whole operation won’t fail because of a temporary [Zoo]Keeper failure.

backup_restore_keeper_max_retries_while_handling_error

Type
UInt64
Default
20
Version history
VersionDefault valueComment
24.1120New setting.
24.1020New setting.

Max retries for [Zoo]Keeper operations while handling an error of a BACKUP ON CLUSTER or RESTORE ON CLUSTER operation.

backup_restore_keeper_max_retries_while_initializing

Type
UInt64
Default
20
Version history
VersionDefault valueComment
24.1120New setting.
24.1020New setting.

Max retries for [Zoo]Keeper operations during the initialization of a BACKUP ON CLUSTER or RESTORE ON CLUSTER operation.

backup_restore_keeper_retry_initial_backoff_ms

Type
UInt64
Default
100

Initial backoff timeout for [Zoo]Keeper operations during backup or restore

backup_restore_keeper_retry_max_backoff_ms

Type
UInt64
Default
5000

Max backoff timeout for [Zoo]Keeper operations during backup or restore

Cloud default value: 60000.

backup_restore_keeper_value_max_size

Type
UInt64
Default
1048576

Maximum size of data of a [Zoo]Keeper’s node during backup

backup_restore_s3_retry_attempts

Type
UInt64
Default
1000
Version history
VersionDefault valueComment
24.71000Setting for Aws::Client::RetryStrategy, Aws::Client does retries itself, 0 means no retries. It takes place only for backup/restore.

Setting for Aws::Client::RetryStrategy, Aws::Client does retries itself, 0 means no retries. It takes place only for backup/restore.

backup_restore_s3_retry_initial_backoff_ms

Type
UInt64
Default
25
Version history
VersionDefault valueComment
25.825New setting

Initial backoff delay in milliseconds before the first retry attempt during backup and restore. Each subsequent retry increases the delay exponentially, up to the maximum specified by backup_restore_s3_retry_max_backoff_ms

backup_restore_s3_retry_jitter_factor

Type
Float
Default
0.1
Version history
VersionDefault valueComment
25.80.1New setting

Jitter factor applied to the retry backoff delay in Aws::Client::RetryStrategy during backup and restore operations. The computed backoff delay is multiplied by a random factor in the range [1.0, 1.0 + jitter], up to the maximum backup_restore_s3_retry_max_backoff_ms. Must be in [0.0, 1.0] interval

backup_restore_s3_retry_max_backoff_ms

Type
UInt64
Default
5000
Version history
VersionDefault valueComment
25.85000New setting

Maximum delay in milliseconds between retries during backup and restore operations.

Navigation