You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ReadMe.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,23 +78,24 @@ Build from the sources (required go 1.21+):
78
78
GO111MODULE=on go install github.com/Altinity/clickhouse-backup/v2/cmd/clickhouse-backup@latest
79
79
```
80
80
81
-
## Brief description how clickhouse-backup works
81
+
## Brief description of how clickhouse-backup works
82
82
83
83
Data files are immutable in the `clickhouse-server`.
84
84
During a backup operation, `clickhouse-backup` creates file system hard links to existing `clickhouse-server` data parts via executing the `ALTER TABLE ... FREEZE` query.
85
85
During the restore operation, `clickhouse-backup` copies the hard links to the `detached` folder and executes the `ALTER TABLE ... ATTACH PART` query for each data part and each table in the backup.
86
86
A more detailed description is available here: https://www.youtube.com/watch?v=megsNh9Q-dw
87
87
88
-
## Default Config
88
+
## Default Config File
89
89
90
90
By default, the config file is located at `/etc/clickhouse-backup/config.yml`, but it can be redefined via the `CLICKHOUSE_BACKUP_CONFIG` environment variable or via `--config` command line parameter.
91
91
All options can be overwritten via environment variables.
92
-
Use `clickhouse-backup default-config` to print default config.
92
+
Use `clickhouse-backup default-config` to print the default config.
93
93
94
-
## Explain config parameters
95
-
Following values is not default, it just explains which each config parameter actually means
96
-
Use `clickhouse-backup print-config` to print current config.
97
-
Each config parameter can be overrides via environment variables, environment variable name provides after comment character `#`.
94
+
## Configurable Parameters
95
+
96
+
Use `clickhouse-backup print-config` to print the current config.
97
+
Environment variables can override each config parameter defined in the config file. Their names should be UPPERCASE, and exact names are provided after the comment character `#.`
98
+
The following values are not defaults; they explain what each config parameter with an example.
0 commit comments