Skip to main content
Version: Nightly

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

OptionRequiredDefaultDescription
--addrYes-Server address to connect
--output-dirYes-Directory to store exported data
--databaseNoall databassesName of the database to export
--export-jobs, -jNo1Number of parallel export jobs(multiple databases can be exported in parallel)
--max-retryNo3Maximum retry attempts per job
--target, -tNoallExport target (schema/data/all)
--start-timeNo-Start of time range for data export
--end-timeNo-End of time range for data export
--auth-basicNo-Use the <username>:<password> format
--timeoutNo0The timeout for a single call to the DB, default is 0 which means never timeout (e.g., 30s, 10min 20s)

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

OptionRequiredDefaultDescription
--addrYes-Server address to connect
--input-dirYes-Directory containing backup data
--databaseNoall databasesName of the database to import
--import-jobs, -jNo1Number of parallel import jobs (multiple databases can be imported in parallel)
--max-retryNo3Maximum retry attempts per job
--target, -tNoallImport target (schema/data/all)
--auth-basicNo-Use the <username>:<password> format

Import Targets

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