Skip to main content
Version: 2.3.x

Backup and Restore

The CnosDB backup and restore tool is a command line tool for exporting, importing, and migrating CnosDB cluster data.This tool supports the backup of metadata and user data, as well as data migration between clusters.

tip

数据导出后会产生多个文件:meta_data.src,schema_data.src 以及 数据文件。

The meta_data.src, schema_data.src file will be exported to the node running the cnosdb-imexport command.

The data file is exported to the requested node and vice versa.

Install​

Make sure you have installed CnosDB backup and restore tools on your system.You can get this tool from official channels and install it according to the relevant documents.

Command Overview​

cnosdb-imexport <COMMAND>

Parameter Description​

NameDescription
exportFull export data
importFull import data
migrateMigrating data
helpPrint help information

export​

Export metadata and user data

Usage​

cnosdb-imexport export [OPTIONS] --src <SRC> --path <PATH>

Options​

NameDescription
-s, --src <SRC>(Required) Connection information of the source cluster (example: root:123456@127.0.0.1:8902)
-p, --path <PATH>(Required) Data storage path
-c, --conn <CONN>(Optional) Connection configuration for cloud storage
-h, --helpPrint help information

Example​

Backup data to local directory​

cnosdb-imexport export --src <user>:<password>@<ip>:<port> --path file:///backup

import​

Import metadata and user data

Usage​

cnosdb-imexport import [OPTIONS] --path <PATH> --dst <DST>

Options​

NameDescription
-p, --path <PATH>(Required) Data storage path
-d, --dst <DST>(Required) Connection information of the source cluster (example: root:123456@127.0.0.1:8902)
-c, --conn <CONN>(Optional) Connection configuration for cloud storage
-h, --helpPrint help information

Example​

Restore data backed up locally to the specified cluster​

cnosdb-imexport import  --path ./backup --dst <user>:<password>@<ip>:<port>

migrate​

Migrate data between clusters

Usage​

cnosdb-imexport migrate [OPTIONS] --src <SRC> --dst <DST> --path <PATH>

Options​

NameDescription
s, --src <SRC>(Required) Connection information of the source cluster (example: root:123456@127.0.0.1:8902)
-d, --dst <DST>(Required) Connection information of the source cluster (example: root:123456@127.0.0.1:8902)
-p, --path <PATH>(Required) Data temporary storage directory
-c, --conn <CONN>(Optional) Connection configuration for cloud storage
-h, --helpPrint help information

Example​

Migrate data to other clusters​

cnosdb-imexport migrate --src <user>:<passowrd>@<ip>:<port> --dst <user>:<passowrd>@<ip>:<port> --path file:///staging

Backup DDL statements​

dump command

cnosdb-cli dump-ddl [--tenant TENANT]

When a tenant is specified, only users, roles, databases, and tables related to the tenant will be dumped.

restore command

cnosdb-cli [--error-stop] restore-dump-ddl DUMP_FILE

When --error-stop is specified, recovery will be interrupted in case of errors during recovery process

cnosdb-cli supports more parameters, the parameters can be referred to in the documentation, where the parameters should be placed before dump-ddl and restore-dump-ddl

Example​

dump

cnosdb-cli --host 127.0.0.1 --port 8902 dump-ddl --tenant cnosdb > dump.sql

restore

cnosdb-cli --host 127.0.0.1 --port 8902 restore-dump-ddl dump.sql