Quick start

This topic describes how to quickly get started with OBLOADER.

Step 1: Download the software

Click here to download the package of the latest version and run the following commands to decompress the package:

unzip ob-loader-dumper-4.2.x-RELEASE.zip
cd ob-loader-dumper-4.2.x-RELEASE

Step 2: Configure the runtime environment

A small JVM memory size may affect the performance and stability of the import and export features. You can use the --mem parameter to specify the JVM memory size, for example, --mem 4G.

Step 3: Prepare data

You can use OBLOADER to import existing data files or temporary data files generated by using the TPC-H tool. The format of content in the imported file must meet the related specifications. Identify the data format in the file based on Is your data ready?

Step 4: Create a database

1. Deploy an OceanBase cluster by using OceanBase Cloud Platform (OCP) or OceanBase Deployer (obd).

2. Create a test database.

3. Create a test table and insert data into the table. This operation is optional when you import data.

Step 5: View configuration files

Configuration files of OBLOADER include the connection configuration file session.config.json and log configuration file log4j2.xml.

Connection configuration file

The connection configuration file session.config.json stored in the {ob-loader-dumper}/conf directory configures database connection parameters. OBLOADER builds a JDBC URL to connect to the target database based on the JDBC parameters in the connection configuration file. Then, it sequentially executes SQL statements for initialization in the established connection. You can modify JDBC parameters and SQL statements for initialization in the connection configuration file. Default connection configurations apply to most scenarios. However, in special cases, you must manually modify parameters to adapt to different OceanBase Database versions and extract, transform, and load (ETL) scenarios. For more information about the connection configuration file, see Connection settings.

Log configuration file

In the log configuration file log4j2.xml stored in the {ob-loader-dumper}/conf directory, you can view the log output path and log format, and adjust the log level during self-service troubleshooting. For more information, see the How do I customize log file names for an export job? section in FAQ.

Step 6: Import data

./obloader -h 'IP address' -P'Port number' -u'User'@'Tenant'#'Cluster' -p'Password' -D'Database name' --table 'Table name' --csv -f 'File path' --sys-password 'Password of the sys tenant' --external

The following table describes the database information used in the examples.

Import DDL definition files

Scenario: Import all supported database object definitions in the /output directory to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --ddl --all -f /output

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 1 -> 1      | SUCCESS  |                
---------------------------------------------------------

Total Count: 1          End Time: 2023-05-11 16:02:08
...

Import CSV data files

Scenario: Import all supported CSV data files in the /output directory to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided. For more information about CSV data file (.csv file) specifications, see RFC 4180. CSV data files store data in the form of plain text. You can open CSV data files by using a text editor or Excel.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --csv --table '*' -f /output

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 1 -> 1      | SUCCESS  |                
---------------------------------------------------------

Total Count: 1          End Time: 2023-05-11 16:02:08
...

Import SQL data files

Scenario: Import all supported SQL data files in the /output directory to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided. SQL data files (.sql files) store INSERT SQL statements. You can open SQL data files by using a text editor or SQL editor.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --sql --table '*' -f /output

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 1 -> 1      | SUCCESS  |                
---------------------------------------------------------

Total Count: 1          End Time: 2023-05-11 16:02:08
...

Import POS data files

Scenario: Import all supported POS data files in the /output directory to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided. You must specify the path where the control file resides during the import. POS data files (.dat files by default) organize data based on a byte offset position with a fixed length. To import a POS data file, you must define the fixed length of each field by using a control file. You can open POS data files by using a text editor.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** 
-D USERA --table '*' -f /output --pos --ctl-path /output

Import CUT data files

Scenario: Import all supported CUT data files in the /output directory to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided. To import a CUT data file, you must specify the path of the control file and use |@| as the column delimiter string. A CUT data file (.dat file) uses a character or character string to separate values. You can open CUT data files by using a text editor.

Sample command:

$./obloader -h127.1 -P2881 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --table '*' -f /output --cut --column-splitter '|@|' --ctl-path /output

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 1 -> 1      | SUCCESS  |                
---------------------------------------------------------

Total Count: 1          End Time: 2023-05-11 16:02:08
...

Import data files from Amazon S3 to OceanBase Database

Scenario: Import all supported CSV data files in an Amazon Simple Storage Service (S3) bucket to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --csv --table '*' -f 's3://obloaderdumper/obdumper?region=cn-north-1&access-key=******&secret-key=******'

The -f 's3://obloaderdumper/obdumper?region=cn-north-1&access-key=******&secret-key=******' option specifies the storage path. The following table describes the components of a storage path.

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 3 -> 3      | SUCCESS  |                
---------------------------------------------------------

Total Count: 3          End Time: 2023-05-11 16:02:08
...

Import data files from Alibaba Cloud OSS to OceanBase Database

Scenario: Import all supported CSV data files in an Alibaba Cloud Object Storage Service (OSS) bucket to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --csv --table '*' -f 'oss://antsys-oceanbasebackup/backup_obloader_obdumper/obdumper?endpoint=https://cn-hangzhou-alipay-b.oss-cdn.aliyun-inc.com&access-key=******&secret-key=******'

The -f 'oss://antsys-oceanbasebackup/backup_obloader_obdumper/obdumper?endpoint=https://cn-hangzhou-alipay-b.oss-cdn.aliyun-inc.com&access-key=******&secret-key=******' option specifies the storage URL. The following table describes the components of a storage URL.

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 3 -> 3      | SUCCESS  |                
---------------------------------------------------------

Total Count: 3          End Time: 2023-05-11 16:02:08
...

Import data files from Apache Hadoop to OceanBase Database

Scenario: Import all supported CSV data files in an Apache Hadoop Distributed File System (HDFS) namespace to the USERA schema. In OceanBase Database of a version earlier than V4.0.0, the password of the sys tenant must be provided.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** --sys-user **u*** --sys-password ****** -D USERA --csv --table '*' -f 'hdfs://***.*.*.*:9000/chang/parquet?hdfs-site-file=/data/0/zeyang/hdfs-site.xml&core-site-file=/data/0/zeyang/core-site.xml'

The -f 'hdfs://***.*.*.*:9000/chang/parquet?hdfs-site-file=/data/0/zeyang/hdfs-site.xml&core-site-file=/data/0/zeyang/core-site.xml' option specifies the storage URL. The following table describes the components of a storage URL.

Sample return result:

...
All Load Tasks Finished:

---------------------------------------------------------
|  No.#  | Type   | Name       | Count       | Status   | 
---------------------------------------------------------     
|  1     | TABLE  | table      | 3 -> 3      | SUCCESS  |                
---------------------------------------------------------

Total Count: 3          End Time: 2023-05-11 16:02:08
...

Import database object definitions and table data to ApsaraDB for OceanBase

Scenario: Import all database object definitions and table data in the /output directory to the USERA schema in ApsaraDB for OceanBase without specifying the password of the sys tenant.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test -p ****** -D USERA --ddl --csv --public-cloud --all -f /output

Import database object definitions and table data to OceanBase Database

Scenario: Import all database object definitions and table data in the /output directory to the USERA schema in OceanBase Database without specifying the password of the sys tenant.

Sample command:

$./obloader -h xx.x.x.x -P 2883 -u test@mysql#cluster_a -p ****** -D USERA --ddl --csv --no-sys --all -f /output

Step 7: Congratulations

You have got started with OBLOADER.

For more information, refer to the following steps:

• Learn about the operating principles, major features, and differences from other tools of OBLOADER from the product introduction. For more information about the tools, see OceanBase Loader and Dumper.

• Join the OceanBase community to discuss issues and requirements on import and export and plans with OceanBase R&D engineers.