This topic describes how to have a quick start with OBLOADER & OBDUMPER.
Step 1: Download the software
Note
OBLOADER & OBDUMPER are no longer distinguished by the community edition and enterprise edition since V4.2.1. You can download the software package from OceanBase Download Center.
Click here to download the package of the latest version, and decompress the package:
$ unzip ob-loader-dumper-4.2.1-RELEASE.zip
$ cd ob-loader-dumper-4.2.1-RELEASE
Step 2: Configure the running environment
Note
You must install Java 8 and configure the JAVA_HOME environment variable in the local environment. We recommend that you install JDK 1.8.0_3xx or later. For more information about environment configuration, see Prepare the environment.
This step aims to modify JVM parameters.
A small JVM memory size may affect the performance and stability of the import and export features. For example, a full garbage collection (GC) or GC crash may occur. We recommend that you modify the JVM memory size, which is -Xms4G -Xmx4G by default, to 60% of the available memory of the server. If you are good at Java performance tuning, you can modify the JVM parameters in the JAVA_OPTS option as needed.
Edit the configuration file that contains the
JAVA_OPTSoption.In Linux, edit the
obloaderandobdumperscripts in the{ob-loader-dumper}/bin/directory.In Windows, edit the
obloader.batandobdumper.batscripts in the{ob-loader-dumper}/bin/windows/directory.
Modify JVM parameters.
JAVA_OPTS="$JAVA_OPTS -server -Xms4G -Xmx4G -XX:MetaspaceSize=128M -XX:MaxMetaspaceSize=128M -Xss352K" JAVA_OPTS="$JAVA_OPTS -XX:+UnlockExperimentalVMOptions -XX:+UseG1GC -Xnoclassgc -XX:+DisableExplicitGC
Step 3: Prepare data
Notice
When you try the export feature of OBDUMPER, you do not need to prepare any data. You can directly go to Step 4.
When you try the import feature of OBLOADER, you can use existing data files or use the TPC-H tool to generate temporary data files. The format of content in the imported file must meet related specifications. Identify the data format in the file based on Is your data ready.
Step 4: Create a database
Notice
When you try the export feature of OBDUMPER, you also need to create tables and insert data into the tables after you create a database.
Deploy an OceanBase cluster by using OceanBase Cloud Platform (OCP) or OceanBase Deployer (OBD).
Create a test database.
Create a test table and insert data into the table. This operation is optional when you import data.
Step 5: Import and export data
Import data
./obloader -h 'IP address' -P'Port' -u'User' -t'Tenant' -c'Cluster' -p'Password' -D'Database name' --table 'Table name' --csv -f 'File path' --sys-password 'Password of the sys tenant' --external
Note
This example only imports data. For more information, see Command-line options of OBLOADER.
Export data
./obdumper -h 'IP address' -P'Port' -u'User' -t'Tenant' -c'Cluster' -p'Password' -D'Database name' --table 'Table name' --csv -f 'File path' --sys-password 'Password of the sys tenant' --skip-check-dir
Note
This example only exports data. For more information, see Command-line options of OBDUMPER.
Step 6: Congratulations
You have had a quick start with OBLOADER & OBDUMPER.
For more information, refer to the following steps:
Learn about the operating principles, major features, and differences from other tools of OBLOADER & OBDUMPER from the product introduction. For more information about the tools, see OBLOADER & OBDUMPER.
Welcome to join OceanBase community to discuss issues and requirements on import and export and future plans with OceanBase R&D engineers.