Skip to content

Commit

Permalink
add Brief description how clickhouse-backup works to ReadMe.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Slach committed Jan 8, 2024
1 parent feb82f8 commit 1ef1953
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,13 @@ Build from the sources:
GO111MODULE=on go get github.com/Altinity/clickhouse-backup/cmd/clickhouse-backup
```

## Brief description how clickhouse-backup works

Data files is immutable in `clickhouse-server`.
During backup operation `clickhouse-backup` create file system hard-links to exists `clickhouse-server` data parts via executing `ALTER TABLE ... FREZZE` query.
During restore operation `clickhouse-backup` copy hard-links to `detached` folder and execute `ALTER TABLE ... ATTACH PART` query for each data part and each table in backup.
More detailed description available here https://www.youtube.com/watch?v=megsNh9Q-dw

## Common CLI Usage

### CLI command - tables
Expand Down

0 comments on commit 1ef1953

Please sign in to comment.