Data Export & Import

The Export and Import tools provide functionality for backing up and restoring GreptimeDB databases. These tools can handle both schema and data, allowing for complete or selective backup and restoration operations.

Export Tool

Command Syntax

greptime cli data export [OPTIONS]

Options

Option	Required	Default	Description
--addr	Yes	-	Server address to connect
--output-dir	Yes	-	Directory to store exported data
--database	No	all databasses	Name of the database to export
--export-jobs, -j	No	1	Number of parallel export jobs(multiple databases can be exported in parallel)
--max-retry	No	3	Maximum retry attempts per job
--target, -t	No	all	Export target (schema/data/all)
--start-time	No	-	Start of time range for data export
--end-time	No	-	End of time range for data export
--auth-basic	No	-	Use the <username>:<password> format
--timeout	No	0	The timeout for a single call to the DB, default is 0 which means never timeout (e.g., 30s, 10min 20s)
--proxy <PROXY>	No	-	The proxy server address to connect, if set, will override the system proxy. The default behavior will use the system proxy if neither proxy nor no_proxy is set.
--no-proxy	No	-	Disable proxy server, if set, will not use any proxy
--s3	No	-	If export data to s3
--ddl-local-dir	No	-	If both ddl_local_dir and remote storage (s3/oss) are set, ddl_local_dir will be only used for exported SQL files, and the data will be exported to remote storage. Note that ddl_local_dir export sql files to LOCAL file system, this is useful if export client don't have direct access to remote storage. If remote storage is set but ddl_local_dir is not set, both SQL&data will be exported to remote storage.
--s3-bucket	Yes*	-	The s3 bucket name if s3 is set, this is required
--s3-root	Yes*	-	If s3 is set, this is required
--s3-endpoint	No*	-	The s3 endpoint if s3 is set, this is required
--s3-access-key	Yes*	-	The s3 access key if s3 is set, this is required
--s3-secret-key	Yes*	-	The s3 secret key if s3 is set, this is required
--s3-region	Yes*	-	The s3 region if s3 is set, this is required
--oss	No	-	If export data to oss
--oss-bucket	Yes*	-	The oss bucket name if oss is set, this is required
--oss-endpoint	No*	-	The oss endpoint if oss is set, this is required
--oss-access-key-id	Yes*	-	The oss access key id if oss is set, this is required
--oss-access-key-secret	Yes*	-	The oss access key secret if oss is set, this is required

Export Targets

• schema: Exports table schemas only (SHOW CREATE TABLE)
• data: Exports table data only (COPY DATABASE TO)
• all: Exports both schemas and data (default)

Import Tool

Command Syntax

greptime cli data import [OPTIONS]

Options

Option	Required	Default	Description
--addr	Yes	-	Server address to connect
--input-dir	Yes	-	Directory containing backup data
--database	No	all databases	Name of the database to import
--import-jobs, -j	No	1	Number of parallel import jobs (multiple databases can be imported in parallel)
--max-retry	No	3	Maximum retry attempts per job
--target, -t	No	all	Import target (schema/data/all)
--auth-basic	No	-	Use the <username>:<password> format

Import Targets

• schema: Imports table schemas only
• data: Imports table data only
• all: Imports both schemas and data (default)