Command-line options

OBDUMPER allows you to specify the information required for export in command-line options. For more information about the options and their scenarios and examples, see Options and Scenarios and examples.

Options

Connection options

OBDUMPER can read data from and write data to an OceanBase database only after connecting to the database. You can connect to an OceanBase database by specifying the following options:

• -h host_name , --host= host_name

  The host IP address for connecting to ODP or a physical OceanBase Database node.
  
  

• -P port_num , --port= port_num

  The host port for connecting to ODP or a physical OceanBase Database node.
  
  

• -c cluster_name , --cluster= cluster_name

  The OceanBase cluster to connect to. If this option is not specified, a physical node of the database is connected. Relevant options, such as -h and -P, specify the IP address and port of the physical node. If this option is specified, ODP is connected. Relevant options, such as -h and -P, specify the IP address and port of ODP.
  
  

• -t tenant_name , --tenant= tenant_name

  The OceanBase Database tenant to connect to. For more information about tenants, see the official OceanBase documentation.
  
  

• -u user_name , --user= user_name

  The username for connecting to OceanBase Database. If you specify an incorrect username, OBDUMPER cannot connect to the database.
  
  

• -p ' password' , --password=' password'

  The user password for connecting to OceanBase Database. If no password is set for the current database account, you do not need to specify this option. To specify this option on the command line, you must enclose the value in single quotation marks (' '), for example, -p'******'.

  Note

  If you are using Windows OS, enclose the value in double quotation marks (" "). This rule also applies to string values of other options.

• -D database_name , --database= database_name

  Exports database object definitions and table data from the specified database.
  
  

• --sys-user sys_username

  The username of a user with required privileges in the sys tenant, for example, root or proxyro. OBDUMPER requires such a user to query metadata in system tables. The default value is root. You do not need to specify this option for OceanBase Database V4.0.0 and later.
  
  

• --sys-password 'sys_password'

  The password of a user with required privileges in the sys tenant. This option is used with the --sys-user option. By default, the password of the root user in the sys tenant is left empty. When you specify this option on the command line, enclose the value in single quotation marks (' '), for example, --sys-password '******'. You do not need to specify this option for OceanBase Database V4.0.0 and later.

  Note

  If this option is not specified, OBDUMPER cannot query metadata in system tables, and the export features and performance may be greatly affected.

• --public-cloud

  Exports database objects or table data in an OceanBase cluster deployed in the public cloud to a file. If you specify this option on the command line, you do not need to specify the -t or -c connection option. OBDUMPER turns on the --no-sys option by default. For more information about the --no-sys option, see the option description below.
  
  

• --no-sys

  Specifies to export database objects or table data to OceanBase clusters deployed in the private cloud when you cannot provide the password of the sys tenant. Unlike the --public-cloud option, when you use the --no-sys option, you need to specify the -t connection option on the command line and also need to add the -c option to connect to the ODP service. In OceanBase Database V4.0.0 or an earlier version, if you do not specify the --public-cloud or --no-sys option, you must specify the --sys-user and --sys-password options in OBDUMPER.
  
  

• --logical-database

  Specifies to export data by using ODP (sharding). If you specify the --logical-database option on the command line, the definition of a random physical database shard is exported and the shard cannot be directly imported into the database. You need to manually convert the exported physical shard to a logical one before you import it to the database for business use.

Feature options

• -f ' file_path ' , --file-path= ' file_path '

  The absolute path on a local disk for storing data files.
  
  

• --file-encoding ' encode_name '

  The character set used during file export, which is not the database character set. When you specify this option on the command line, enclose the value in single quotation marks (' '), for example, --file-encoding 'GBK'. The default value is UTF-8.
  
  

• --ctl-path ' control_path '

  The absolute path on a local disk for storing control files. You can configure built-in preprocessing functions in a control file. Data will be preprocessed by these functions before being exported. For example, the functions can perform case conversion and check the data for empty values. For the use of control files, see Data processing. When you specify this option on the command line, enclose the value in single quotation marks (' '), for example, --ctl-path '/home/controls/'.
  
  

• --log-path ' log_path '

  The output directory for the operational logs of OBDUMPER. If this option is not specified, OBDUMPER operational logs are stored in the directory specified by the -f option. Redirection is not required for log output, unless otherwise specified.
  
  

• --ddl

  Exports DDL files. A DDL file stores database object definitions. The file is named in the format of object name-schema.sql. When this option is specified, only the database object definitions are exported, and table data is not exported. We recommend that you set the --thread option to a value less than 4 for exporting the definitions of multiple table objects. High concurrency affects access to views in the sys tenant, resulting in timeout errors during data export.
  
  

• --sql

  Exports data files in the SQL format. In an SQL file, data is stored in the format of INSERT statements. The file is named in the format of table name.sql. Each line of table data corresponds to an executable INSERT statement in an SQL file. An SQL file is different from a DDL file in terms of content format. We recommend that you use this option together with the --table option. When this option is used with the --all option, OBDUMPER exports only table data but not database object definitions.
  
  

• --orc

  Exports data files in the ORC format. An ORC file stores data in the column-oriented format. The file is named in the format of table name.orc. For more information about ORC format definitions, see ORC Specification v1.
  
  

• --par

  Exports data files in the Parquet format. A Parquet file stores data in the column-oriented format. The file is named in the format of table name.parquet. For more information about Parquet format definitions, see File Format of Apache Parquet.
  
  

• --csv

  Exports data files in the CSV format. In a CSV file, data is stored in the standard CSV format. The file is named in the format of table name.csv. For CSV format specifications, see the definitions in RFC 4180. Delimiter errors are the most common errors that occur in CSV files. Single or double quotation marks are usually used as the delimiter. If data in the file contains the delimiter, you must specify escape characters. For more information, see symbol options in the CSV format. We strongly recommend that you use the CSV format. We recommend that you use this option together with the --table option. When this option is used with the --all option, OBDUMPER exports only table data but not database object definitions.
  
  

• --cut

  Exports data files in the CUT format. A CUT file is a format that uses a character string as the separator string. A CUT file is named in the format of table name.dat. We recommend that you use this option together with the --table option. When this option is used with the --all option, OBDUMPER exports only table data but not database object definitions.

  Notice

  In a CUT file, each data record is stored in an entire line. When a single character is used as the field separator, if the data contains special characters such as separators, carriage returns, and line breaks, OBDUMPER will escape these special characters. For example, if the data is abc|def and the separator is |, the exported data is abc|def.

• --table-group '*table_group_name [,table_group_name...]*'|--table-group '*'

  Exports table group definitions. This option is similar to the --table option, except that this option does not support data export.
  
  

• --all

  Exports all database object definitions and table data. When this option is used with the --ddl option, all database object definitions are exported. When this option is used with the --csv, --sql, or --cut option, data in all tables is exported in the specified format. To export all database object definitions and table data, you can specify the --all and --ddl options along with a data format option.

  Notice

  The --all option is mutually exclusive with any database object options. It cannot be specified together with other database object options. If both the --all option and a database object option are specified, the --all option will be executed first.

• --table ' table_name [, table_name...] ' | --table ' * '

  Exports table definitions or table data. When this option is used with the --ddl option, only table definitions are exported. When this option is used with any data format option, only table data is exported. To specify multiple tables, separate the table names with commas (,). By default, for OceanBase Database in Oracle mode, the table names are in uppercase, and for OceanBase Database in MySQL mode, the table names are in lowercase. For example, for OceanBase Database in Oracle mode, both --table 'test' and --table 'TEST' indicate the table named TEST. For OceanBase Database in MySQL mode, both --table 'test' and --table 'TEST' indicate the table named test. If table names are case-sensitive, enclose them in brackets ([ ]). For example, --table '[test]' indicates the table named test, while --table '[TEST]' indicates the table named TEST. If the table name is specified as an asterisk, all table definitions or table data is exported.

  Note

  You can use OBDUMPER V4.1.0 and later versions to export temporary table definitions from Oracle tenants of OceanBase Database.

• --view ' view_name [, view_name...] ' | --view ' * '

  Exports view definitions. This option is similar to the --table option, except that this option does not support data export.
  
  

• --trigger ' trigger_name [, trigger_name...] ' | --trigger ' * '

  Exports trigger definitions. This option is similar to the --table option, except that this option does not support data export. This option is supported only for OceanBase Database in Oracle mode.
  
  

• --sequence ' sequence_name [, sequence_name...] ' | --sequence ' * '

  Exports sequence definitions. This option is similar to the --table option, except that this option does not support data export.

  Notice

  OBDUMPER V4.0.0 and earlier versions apply to Oracle tenants of OceanBase Database only. OBDUMPER 4.1.0 and later versions apply to both MySQL and Oracle tenants of OceanBase Database.

• --synonym ' synonym_name [, synonym_name...] ' | --synonym ' * '

  Exports synonym definitions. This option is similar to the --table option, except that this option does not support data export. This option is supported only for OceanBase Database in Oracle mode.
  
  

• --type ' type_name [, type_name...] ' | --type ' * '

  Exports type definitions. This option is similar to the --table option, except that this option does not support data export. This option is supported only for OceanBase Database in Oracle mode.

  Note

  You can export type definitions only in OceanBase Database V2.2.77 and later.

• --type-body ' typebody_name [, typebody_name...] ' | --type-body ' * '

  Exports type body definitions. This option is similar to the --table option, except that this option does not support data export. This option is supported only for OceanBase Database in Oracle mode.

  Note

  This option must be used with the --type option. The exported type body is saved as a type file.

• --package ' package_name [, package_name...] ' | --package ' * '

  Exports package definitions. This option is similar to the --table option, except that this option does not support data export. This option is supported only for OceanBase Database in Oracle mode.
  
  

• --package-body ' packagebody_name [, packagebody_name...] ' | --package-body ' * '

  Exports package body definitions. This option is similar to the --table option, except that this option does not support data export. This option is supported only for OceanBase Database in Oracle mode.
  
  

• --function ' function_name [, function_name...] ' | --function ' * '

  Exports function definitions. This option is similar to the --table option, except that this option does not support data export.

  Note

  Function definitions can be exported in all versions of OceanBase Database in Oracle mode. Function definitions can be exported in V2.2.30 and later of OceanBase Database in MySQL mode.

• --procedure ' procedure_name [, procedure_name...] ' | --procedure ' * '

  Exports stored procedure definitions. This option is similar to the --table option, except that this option does not support data export.

  Note

  Stored procedure definitions can be exported in all versions of OceanBase Database in Oracle mode. Stored procedure definitions can be exported in V2.2.30 and later of OceanBase Database in MySQL mode.

• --drop-object

  Inserts a DROP statement before the database object creation statement for the export of a DDL file. This option can be used only with the --ddl option.
  
  

• --snapshot

  Exports data of a historical version. This option can be used only with a data format option. You can export data of a historical version to ensure the global consistency of the exported data. If this option is not specified, the real-time data exported from the memory may not be a globally consistent data snapshot.
  
  

• --where ' where_condition_string '

  Exports data that satisfies the specified conditions. This option can be used only with a data format option and cannot be used with the --query-sql option.
  
  

• --partition ' partition_name [, partition_name...] '

  Exports data of specified partitions. The option specifies the partition names. Separate multiple partition names with commas (,). This option can be used only with a data format option and cannot be used with the --query-sql option.

  Notice

  When you specify a partition to export, you must specify the subpartition name for a subpartitioned table. You cannot export a partition by specifying only the partition name. For a template-based subpartition, its name is in the format of partition name+s+subpartition name.

• --query-sql ' select_statement '

  Exports the result set of a custom query statement. This option cannot be used with the --partition or --where option. You must ensure the correctness and query performance of the custom query statement. When you export the result set of a large query, you may wait for a long time before the database responds. To preprocess data to be exported by using a control file, you need to use the --table and --ctl-path options. The --table option must be set to the table name exactly the same as that specified in --ctl-path. If preprocessing is not required, you can specify any table name for the --table option.
  
  

• --flashback-scn ' scn_number '

  Exports data after a system change number (SCN) transaction point. This option can be used only with a data format option and cannot be used with the --query-sql option.
  
  

• --flashback-timestamp ' timestamp_string '

  Exports data after a flashback point in time. This option can be used only with a data format option and cannot be used with the --query-sql option. This option is supported only for OceanBase Database in Oracle mode.
  
  

• --nls-date-format ' date-format-string '

  The nls_date_format session variable in Oracle mode of OceanBase Database. This option does not indicate to export data of the DATE data type in the specified format. The default value is YYYY-MM-DD HH24:MI:SS.
  
  

• --nls-timestamp-format ' timestamp-format-string '

  The nls_timestamp_format session variable in Oracle mode of OceanBase Database. This option does not indicate to export data of the TIMESTAMP data type in the specified format. The default value is YYYY-MM-DD HH24:MI:SS: FF9.
  
  

• --nls-timestamp-tz-format ' timestamp-tz-format-string '

  The nls_timestamp_tz_format session variable in Oracle mode of OceanBase Database. This option does not indicate to export data of the TIMESTAMP WITH TIME ZONE data type in the specified format. The default value is YYYY-MM-DD HH24:MI:SS:FF9 TZR.
  
  

• --retry

  Resumes the export task from the location of the last export failure.

  Notice

  The CHECKPOINT.bin file is a savepoint file generated when the tool runs, and is located in the directory specified in the -f option. You cannot use this option if the CHECKPOINT.bin file does not exist.

• --distinct

  Filters duplicate data in a table. This option can be used only with the --cut option.

  Notice

  This option is deprecated. Do not use it.

• --with-trim

  Deletes the space characters on the left and right sides of the data. This option can be used only with the --cut or --csv option.
  
  

• --weak-read

  Exports data from the follower replica. OBDUMPER of versions earlier than V3.1.0 can be used only with ODP V3.1.2 and later. For OBDUMPER V3.1.0 and later, you must configure ob.proxy.route.policy=follower_first in the conf/session.properties file. For more information about the usage of the session.properties file, see Set session-level variables in Scenario and examples under OBDUMPER.
  
  

• --file-name ' file_name '

  Merges subfiles exported from a table into one large file.

  Note

  • If this option is specified, the file name can contain an extension, for example, --file-name test.txt.
  • If you set this option to a custom path, you cannot use OBLOADER to import the entire directory of the exported data. This is because the directory structure generated by OBDUMPER is changed to the custom path and OBLOADER cannot recognize it.

  The following table provides some examples.

  Usage	Description	Example
  --file-name {file_name}	Merges sub-files exported from one table or schema. Sub-files exported from the single table are merged into one file, which is named as the value of file_name. The paths of the exported schema and record files remain unchanged.	Specify the following options: -f='/home/admin/foo' --file-name='custom.dat' --table='t_origin' Task result: All record files of the t_origin table are merged into the custom.dat file in the /home/admin/foo/data/{schema}/TABLE/ directory.
  --file-name {*}	Merges sub-files exported from one or more tables into one or more files. Sub-files exported from the specified tables are merged into n files that are named after the corresponding tables, where n equals the number of the corresponding tables. The paths of the exported schemas and record files remain unchanged.	Specify the following options: -f='/home/admin/foo' --file-name='*' --table='*' Task result: All record files are merged into the files of the corresponding table names in the /home/admin/foo/data/{database}/TABLE directory. All schema files are in their original positions. Note We recommend that you do not use --file-name '*' with the --skip-check-dir option, because the --skip-check-dir option merges existing data files of the same table names in the path, resulting in issues such as data duplication.
  --file-name {file_path}	Merges sub-files exported from a single table or a single schema. You can specify a relative or absolute path. Use this option only when --ddl is not specified. The file name for exporting a schema is different from that for exporting records. Merges sub-files exported from a single table into one file and moves the file to the file path specified by file_path. If you specify --ddl but do not specify any data format, only the exported schema file is moved to the file path specified by file_path.	To export a schema, specify the following options: --table='custom' -f='/home/admin/foo' --file-name='/home/admin/bar/custom.ddl' Task result: The DDL statements for the custom table are exported to the custom.ddl file in the /home/admin/bar/ directory. To export record files, specify the following options: --table='custom' -f='/home/admin/foo' --file-name='/home/admin/bar/custom.dat' Task result: The exported record files are merged into the custom.dat file in the /home/admin/bar/ directory.
  --file-name {directory_path}	A directory must end with a slash (/) and cannot contain \*. Merges sub-files exported from one or more tables into one or more files. You can specify a relative or absolute path. Sub-files exported from the specified tables are merged into n files that are named after the corresponding tables, where n equals the number of the corresponding tables. The files are then stored in the directory specified by directory_path.	Specify the following options: -f='/home/admin/foo' --file-name='/home/admin/bar/' --table='*' Task result: All record files are grouped and merged by table name and moved together with all schema files to the /home/admin/bar/ directory.

• --max-file-size int_num

  The maximum size of data that a process can export. Data export stops when the size of the exported data reaches the specified maximum size.
  
  

• --skip-check-dir

  Skips checking on whether the data export directory is empty. When the export directory is not empty, the tool stops exporting.
  
  

• --remove-newline

  Forcibly deletes carriage returns or line breaks in the data before the data export. For example, ***\r***, ***\n***, and \r\n will be deleted. This option only modifies the data retrieved to the memory, and does not modify the data in the source table. This option can be used only with the --cut option.

  Notice

  If data in the source table contains carriage returns or line breaks, the data exported with this option specified will be inconsistent with that in the source table. Before using this option, ensure that the removal of \r, \n, and \r\n does not affect the business. If you do not need to delete carriage returns or line breaks in the data, to avoid data inconsistency, do not specify this option in the command.

• --retain-empty-files

  Generates an empty file for each empty table. If this option is not specified, no file is generated for an empty table during data export.
  
  

• --add-extra-message

  Exports additional information in table definitions. For example, when you specify the --add-extra-message option on the command line to export table definitions, OBDUMPER exports the name of the table group to which each table belongs. By default, OBDUMPER does not export the additional information contained in table definitions.
  
  

• --exclude-table ' table_name [, table_name...] '

  Excludes the specified tables from the export of table definitions or table data. Fuzzy match on table names is supported,

  for example, --exclude-table 'test1,test*,*test,te*st'

  The preceding example specifies to exclude the following tables from the export of table definitions and table data:

  • test1
  • All tables with a table name starting with test
  • All tables with a table name ending with test
  • All tables with a table name starting with te and ending with st
    
    

• --exclude-data-types ' datatype [, datatype...] '

  Excludes the specified data types from the export of data.
  
  

• --include-column-names ' column_name [, column_name...] '

  Includes the specified columns in the export of table data. Data of the columns is exported in the specified order.
  
  

• --exclude-column-names ' column_name [, column_name...] '

  Excludes the specified columns from the export of table data. Fuzzy match on column names is not supported.

  Notice

  The letter case of the specified column name must be the same as that of the column name in the table definition.

• --skip-header

  Skips headers of CSV files when the files are exported. This option can be used only with the --csv option.
  
  

• --trail-delimiter

  Truncates the last column separator in a line. This option can be used only with the --cut or --csv option.
  
  

• --null-string ' null_replacer_string '

  Replaces NULL with the specified character. This option can be used only with the --cut or --csv option. The default value is \N.
  
  

• --empty-string ' empty_replacer_string '

  Replaces an empty string (' ') with the specified character. This option can be used only with the --cut or --csv option. The default value is \E.
  
  

• --line-separator ' line_separator_string '

  The custom line break for the data file. The default value of this option depends on the system platform. Valid values: \\r, \\n, and \\r\\n.

  Note

  This option can be used only with the --cut or --csv option.

• --column-separator ' column_separator_char '

  The column separator. This option can be used only with the --csv option and supports a single character only. The default value is a comma (,).
  
  

• --escape-character ' escape_char '

  The escape character. This option can be used only with the --cut or --csv option and supports a single character only. The default value is a backslash ().
  
  

• --column-delimiter ' column_delimiter_char '

  The column delimiter. This option can be used only with the --csv option and supports a single character only. The default value is a single quotation mark (').
  
  

• --column-splitter ' split_string '

  The column separator string. This option can be used only with the --cut option.
  
  

• --fetch-size ' int_num '

  The number of rows read from the database cursor in Oracle mode of OceanBase Database. The default value is 1000. For more information, see OceanBase FetchSize.

  Note

  To use this option, you must install the OceanBase JDBC driver.

• --upload-behavior ' upload_behavior_string '

  The upload mode for exporting data to cloud storage space. This option supports the FAST and COMPLETE upload modes. FAST: Data files are uploaded immediately after they are exported to the local disk. COMPLETE: Data files are uploaded in batches after all of them are exported. This mode is applicable to scenarios where sub-files need to be merged and moved.

  Note

  • If the --upload-behavior 'FAST' and --file-name options are both specified, the --file-name option takes effect.
  • If the --upload-behavior 'COMPLETE' and --file-name options are both specified, the --upload-behavior 'COMPLETE' option takes effect.

• --storage-uri ' storage_uri_string '

  The URI of the storage space. OBDUMPER V4.2.0 and later allow you to export data to Alibaba Cloud Object Storage Service (OSS) and Amazon Simple Storage Service (S3).

  The syntax of 'storage_uri_string' is as follows:

  [scheme://host]path[?parameters]
  
  parameters: key[=value],...
  

  The following table describes the components.

  Component	Description
  scheme	The storage scheme. Alibaba Cloud OSS and Amazon S3 are supported. If the scheme is not Alibaba Cloud OSS or Amazon S3, an error is returned.
  host_name	The name of the storage space. When you export data to Alibaba Cloud OSS or Amazon S3, the host parameter specifies the bucket. For more information, see OSS Bucket.
  path	The data storage path in the storage space. The path must start with a slash (/).
  parameters	The parameters required for the request. The value can be a single key or multiple key-value pairs.

  Example: Export data to Amazon S3

  --storage-uri 's3://bucket/path?region={region}&access-key={accessKey}&secret-key={secretKey}'