Need help with clickhouse-backup?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

AlexAkulov
384 Stars 87 Forks MIT License 331 Commits 35 Opened issues

Description

Tool for easy ClickHouse backup and restore with cloud storages support

Services available

!
?

Need anything else?

Contributors list

clickhouse-backup

Build GoDoc Telegram Docker Image

Tool for easy ClickHouse backup and restore with cloud storages support

Features

  • Easy creating and restoring backups of all or specific tables
  • Efficient storing of multiple backups on the file system
  • Uploading and downloading with streaming compression
  • Works with AWS, GCS, Azure, Tencent COS, FTP
  • Support of Atomic Database Engine
  • Support of multi disks installations

TODO: - Support of incremental backups on remote storages - Smart restore for replicated tables

Limitations

  • ClickHouse above 1.1.54390 is supported
  • Only MergeTree family tables engines

Installation

  • Download the latest binary from the releases page and decompress with:
tar -zxvf clickhouse-backup.tar.gz
  • Use the official tiny Docker image and run it on host where installed
    clickhouse-server
    :
docker run -u $(id -u clickhouse) --rm -it --network host -v "/var/lib/clickhouse:/var/lib/clickhouse" \
   -e CLICKHOUSE_PASSWORD="password" \
   -e S3_BUCKET="clickhouse-backup" \
   -e S3_ACCESS_KEY="access_key" \
   -e S3_SECRET_KEY="secret" \
   alexakulov/clickhouse-backup --help
  • Build from the sources:
GO111MODULE=on go get github.com/AlexAkulov/clickhouse-backup/cmd/clickhouse-backup

Usage

NAME:
   clickhouse-backup - Tool for easy backup of ClickHouse with cloud support

USAGE: clickhouse-backup [-t, --tables=.

]

VERSION: unknown

DESCRIPTION: Run as 'root' or 'clickhouse' user

COMMANDS: tables Print list of tables create Create new backup upload Upload backup to remote storage list Print list of backups download Download backup from remote storage restore Create schema and restore data from backup delete Delete specific backup default-config Print default config freeze Freeze tables clean Remove data in 'shadow' folder server Run API server help, h Shows a list of commands or help for one command

GLOBAL OPTIONS: --config FILE, -c FILE Config FILE name. (default: "/etc/clickhouse-backup/config.yml") --help, -h show help --version, -v print the version

Default Config

Config file location can be defined by

$CLICKHOUSE_BACKUP_CONFIG

All options can be overwritten via environment variables

general:
  remote_storage: s3             # REMOTE_STORAGE
  max_file_size: 1099511627776   # MAX_FILE_SIZE
  disable_progress_bar: false    # DISABLE_PROGRESS_BAR
  backups_to_keep_local: 0       # BACKUPS_TO_KEEP_LOCAL
  backups_to_keep_remote: 0      # BACKUPS_TO_KEEP_REMOTE
  log_level: info                # LOG_LEVEL
clickhouse:
  username: default              # CLICKHOUSE_USERNAME
  password: ""                   # CLICKHOUSE_PASSWORD
  host: localhost                # CLICKHOUSE_HOST
  port: 9000                     # CLICKHOUSE_PORT
  disk_mapping: {}               # CLICKHOUSE_DISK_MAPPING
  skip_tables:                   # CLICKHOUSE_SKIP_TABLES
    - system.*
  timeout: 5m                    # CLICKHOUSE_TIMEOUT
  freeze_by_part: false          # CLICKHOUSE_FREEZE_BY_PART
  secure: false                  # CLICKHOUSE_SECURE
  skip_verify: false             # CLICKHOUSE_SKIP_VERIFY
  sync_replicated_tables: true   # CLICKHOUSE_SYNC_REPLICATED_TABLES

azblob: endpoint_suffix: "core.windows.net" # AZBLOB_ENDPOINT_SUFFIX account_name: "" # AZBLOB_ACCOUNT_NAME account_key: "" # AZBLOB_ACCOUNT_KEY sas: "" # AZBLOB_SAS container: "" # AZBLOB_CONTAINER path: "" # AZBLOB_PATH compression_level: 1 # AZBLOB_COMPRESSION_LEVEL compression_format: tar # AZBLOB_COMPRESSION_FORMAT sse_key: "" # AZBLOB_SSE_KEY s3: access_key: "" # S3_ACCESS_KEY secret_key: "" # S3_SECRET_KEY bucket: "" # S3_BUCKET endpoint: "" # S3_ENDPOINT region: us-east-1 # S3_REGION acl: private # S3_ACL force_path_style: false # S3_FORCE_PATH_STYLE path: "" # S3_PATH disable_ssl: false # S3_DISABLE_SSL part_size: 536870912 # S3_PART_SIZE compression_level: 1 # S3_COMPRESSION_LEVEL

supports 'none', 'tar', 'lz4', 'bzip2', 'gzip', 'sz', 'xz'

compression_format: tar # S3_COMPRESSION_FORMAT

empty (default), AES256, or aws:kms

sse: AES256 # S3_SSE disable_cert_verification: false # S3_DISABLE_CERT_VERIFICATION storage_class: STANDARD # S3_STORAGE_CLASS gcs: credentials_file: "" # GCS_CREDENTIALS_FILE credentials_json: "" # GCS_CREDENTIALS_JSON bucket: "" # GCS_BUCKET path: "" # GCS_PATH compression_level: 1 # GCS_COMPRESSION_LEVEL compression_format: tar # GCS_COMPRESSION_FORMAT cos: url: "" # COS_URL timeout: 2m # COS_TIMEOUT secret_id: "" # COS_SECRET_ID secret_key: "" # COS_SECRET_KEY path: "" # COS_PATH compression_format: tar # COS_COMPRESSION_FORMAT compression_level: 1 # COS_COMPRESSION_LEVEL api: listen: "localhost:7171" # API_LISTEN enable_metrics: true # API_ENABLE_METRICS enable_pprof: false # API_ENABLE_PPROF username: "" # API_USERNAME password: "" # API_PASSWORD secure: false # API_SECURE certificate_file: "" # API_CERTIFICATE_FILE private_key_file: "" # API_PRIVATE_KEY_FILE ftp: address: "" # FTP_ADDRESS timeout: 2m # FTP_TIMEOUT username: "" # FTP_USERNAME password: "" # FTP_PASSWORD tls: false # FTP_TLS path: "" # FTP_PATH compression_format: tar # FTP_COMPRESSION_FORMAT compression_level: 1 # FTP_COMPRESSION_LEVEL debug: false # FTP_DEBUG

ATTENTION!

Never change files permissions in

/var/lib/clickhouse/backup
. This path contains hard links. Permissions on all hard links to the same data on disk are always identical. That means that if you change the permissions/owner/attributes on a hard link in backup path, permissions on files with which ClickHouse works will be changed too. That might lead to data corruption.

API

Use the

clickhouse-backup server
command to run as a REST API server. In general, the API attempts to mirror the CLI commands.

GET /backup/tables

Print list of tables:

curl -s localhost:7171/backup/tables | jq .

POST /backup/create

Create new backup:

curl -s localhost:7171/backup/create -X POST | jq .
* Optional query argument
table
works the same as the
--table value
CLI argument. * Optional query argument
name
works the same as specifying a backup name with the CLI. * Full example:
curl -s 'localhost:7171/backup/create?table=default.billing&name=billing_test' -X POST

Note: this operation is async, so the API will return once the operation has been started.

POST /backup/upload

Upload backup to remote storage:

curl -s localhost:7171/backup/upload/ -X POST | jq .
* Optional query argument
diff-from
works the same as the
--diff-from
CLI argument.

Note: this operation is async, so the API will return once the operation has been started.

GET /backup/list

Print list of backups:

curl -s localhost:7171/backup/list | jq .

Note: The

Size
field is not populated for local backups.

POST /backup/download

Download backup from remote storage:

curl -s localhost:7171/backup/download/ -X POST | jq .

Note: this operation is async, so the API will return once the operation has been started.

POST /backup/restore

Create schema and restore data from backup:

curl -s localhost:7171/backup/restore/ -X POST | jq .
* Optional query argument
table
works the same as the
--table value
CLI argument. * Optional query argument
schema
works the same the
--schema
CLI argument (restore schema only). * Optional query argument
data
works the same the
--data
CLI argument (restore data only).

POST /backup/delete

Delete specific remote backup:

curl -s localhost:7171/backup/delete/remote/ -X POST | jq .

Delete specific local backup:

curl -s localhost:7171/backup/delete/local/ -X POST | jq .

POST /backup/freeze

Freeze tables:

curl -s localhost:7171/backup/freeze -X POST | jq .

POST /backup/clean

Remove data in 'shadow' folder:

curl -s localhost:7171/backup/clean -X POST | jq .

GET /backup/status

Display list of current async operations:

curl -s localhost:7171/backup/status | jq .

API Configuration

GET /backup/config

Get the current running configuration:

curl -s localhost:7171/backup/config | jq -r .Result > current_config.yml

GET /backup/config/default

Get the default configuration:

curl -s localhost:7171/backup/config/default | jq -r .Result > default_config.yml

POST /backup/config

Update the current running configuration:

curl -v localhost:7171/backup/config -X POST --data-binary '@new_config.yml'

Be sure to check return code for config parsing/validation errors.

Examples

Simple cron script for daily backup and uploading

#!/bin/bash
BACKUP_NAME=my_backup_$(date -u +%Y-%m-%dT%H-%M-%S)
clickhouse-backup create $BACKUP_NAME
clickhouse-backup upload $BACKUP_NAME

More use cases of clickhouse-backup

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.