Backups documentation added id setting

This commit is contained in:
Maksim Kita 2024-02-21 15:01:27 +03:00
parent c1754d3cd1
commit d0ad87348a

View File

@ -80,6 +80,7 @@ The BACKUP and RESTORE statements take a list of DATABASE and TABLE names, a des
- ASYNC: backup or restore asynchronously - ASYNC: backup or restore asynchronously
- PARTITIONS: a list of partitions to restore - PARTITIONS: a list of partitions to restore
- SETTINGS: - SETTINGS:
- `id`: id of backup or restore operation, randomly generated UUID is used, if not specified manually. If there is already running operation with the same `id` exception is thrown.
- [`compression_method`](/docs/en/sql-reference/statements/create/table.md/#column-compression-codecs) and compression_level - [`compression_method`](/docs/en/sql-reference/statements/create/table.md/#column-compression-codecs) and compression_level
- `password` for the file on disk - `password` for the file on disk
- `base_backup`: the destination of the previous backup of this source. For example, `Disk('backups', '1.zip')` - `base_backup`: the destination of the previous backup of this source. For example, `Disk('backups', '1.zip')`
@ -206,7 +207,7 @@ end_time: 2022-08-30 09:21:46
1 row in set. Elapsed: 0.002 sec. 1 row in set. Elapsed: 0.002 sec.
``` ```
Along with `system.backups` table, all backup and restore operations are also tracked in the system log table [backup_log](../operations/system-tables/backup_log.md): Along with `system.backups` table, all backup and restore operations are also tracked in the system log table [backup_log](../operations/system-tables/backup_log.md):
``` ```
SELECT * SELECT *
FROM system.backup_log FROM system.backup_log
@ -222,7 +223,7 @@ event_time_microseconds: 2023-08-18 11:13:43.097414
id: 7678b0b3-f519-4e6e-811f-5a0781a4eb52 id: 7678b0b3-f519-4e6e-811f-5a0781a4eb52
name: Disk('backups', '1.zip') name: Disk('backups', '1.zip')
status: CREATING_BACKUP status: CREATING_BACKUP
error: error:
start_time: 2023-08-18 11:13:43 start_time: 2023-08-18 11:13:43
end_time: 1970-01-01 03:00:00 end_time: 1970-01-01 03:00:00
num_files: 0 num_files: 0
@ -252,7 +253,7 @@ compressed_size: 0
files_read: 0 files_read: 0
bytes_read: 0 bytes_read: 0
2 rows in set. Elapsed: 0.075 sec. 2 rows in set. Elapsed: 0.075 sec.
``` ```
## Configuring BACKUP/RESTORE to use an S3 Endpoint ## Configuring BACKUP/RESTORE to use an S3 Endpoint
@ -271,7 +272,7 @@ Creating an S3 bucket is covered in [Use S3 Object Storage as a ClickHouse disk]
The destination for a backup will be specified like this: The destination for a backup will be specified like this:
``` ```
S3('<S3 endpoint>/<directory>', '<Access key ID>', '<Secret access key>) S3('<S3 endpoint>/<directory>', '<Access key ID>', '<Secret access key>')
``` ```
```sql ```sql