OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Loader and Dumper

V4.3.3

  • Document Overview
  • Introduction
  • Technical mechanism
  • Preparations
    • Prepare the environment
    • Prepare data
    • Download OBLOADER & OBDUMPER
  • User Guide (OBLOADER)
    • Quick start
    • Command-line options
    • Direct load
    • Data processing
      • Define control files
      • Preprocessing functions
      • Case expressions
    • Use cases of command-line options
    • Performance tuning
    • Error handling
    • FAQ
  • User Guide (OBDUMPER)
    • Quick start
    • Command-line options
    • Data processing
      • Define control files
      • Preprocessing functions
      • Case expressions
    • Performance tuning
    • FAQ
  • Security features
  • Connection settings
  • Self-service troubleshooting
  • Release Note
    • Release Note
      • 4.x
        • OBLOADER & OBDUMPER V4.3.3
        • OBLOADER & OBDUMPER V4.3.2.1
        • OBLOADER & OBDUMPER V4.3.2
        • OBLOADER & OBDUMPER V4.3.1.1
        • OBLOADER & OBDUMPER V4.3.1
        • OBLOADER & OBDUMPER V4.3.0
        • OBLOADER & OBDUMPER V4.2.8.2
        • OBLOADER & OBDUMPER V4.2.8.1
        • OBLOADER & OBDUMPER V4.2.8
        • OBLOADER & OBDUMPER V4.2.6
        • OBLOADER & OBDUMPER V4.2.7
        • OBLOADER & OBDUMPER V4.2.5
        • OBLOADER & OBDUMPER V4.2.4
        • OBLOADER & OBDUMPER V4.2.1
        • OBLOADER \& OBDUMPER V4.1.0
        • OBLOADER \& OBDUMPER V4.0.0
      • 3.x
        • OBLOADER \& OBDUMPER V3.1.0
        • OBLOADER \& OBDUMPER V3.0.0
    • Version rules

Download PDF

Document Overview Introduction Technical mechanism Prepare the environment Prepare data Download OBLOADER & OBDUMPER Quick start Command-line options Direct load Define control files Preprocessing functionsCase expressions Use cases of command-line options Performance tuning Error handling FAQ Quick start Command-line options Define control files Preprocessing functionsCase expressions Performance tuning FAQ Security features Connection settings Self-service troubleshooting Version rules
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Loader and Dumper
  3. V4.3.3
iconOceanBase Loader and Dumper
V 4.3.3
  • V 4.3.5
  • V 4.3.4.1
  • V 4.3.4
  • V 4.3.3.1
  • V 4.3.3
  • V 4.3.2.1
  • V 4.3.2
  • V 4.3.1
  • V 4.2.8
  • V 4.2.7
  • V 4.2.6
  • V 4.2.5 and earlier

Direct load

Last Updated:2025-06-13 03:35:22  Updated
share
What is on this page
Background information
Scenarios
Considerations
Command-line options for direct load
Parameters for direct load

folded

share

Background information

OceanBase Database allows you to insert data into a database by using direct load. In other words, OceanBase Database can directly write data into data files. With the direct load feature, you can get around APIs at the SQL layer and directly allocate space and insert data into data files, thereby improving the data import efficiency.

Scenarios

The direct load feature applies to the following scenarios:

  • Data migration and synchronization: In data migration or synchronization, a large amount of data in different formats often needs to be migrated from different data sources to OceanBase Database. Conventional SQL APIs cannot meet the requirement on timeliness.

  • Conventional extract, transform, and load (ETL): After data is extracted and transformed in the source, a large amount of data often needs to be loaded to the target within a short time. The direct load technology can improve the import performance.

  • Data load from text files or other data sources to OceanBase Database: Direct load can accelerate the data load process.

Considerations

  • In direct load, the remote procedure call (RPC) port instead of the SQL port is used to transmit data.

  • Data to be imported is submitted at the table level instead of the session or transaction level.

  • Retry or resumable transmission is not supported.

  • Bit data types are not supported.

  • Virtual generated columns are not supported.

  • We recommend that you do not import a small amount of data in direct load mode.

  • The --replace-data option cannot help address unique index conflicts.

  • The differences between the --thread and --parallel options are as follows:

    • --thread specifies the thread pool for connections from the client to the server, and is maintained on the client.

    • --parallel specifies the number of worker threads that can be called by the OBServer node for data writing and sorting.

    • We recommend that you specify consistent values for --thread and --parallel.

Command-line options for direct load

Notice

When you use OBLOADER for direct load, you can connect to an OBServer node directly or through OceanBase Database Proxy (ODP). The version requirements are as follows:

  • OBServer node: OceanBase Database V4.2.0 or later.
  • In the case of connection through ODP, the version of ODP must be V4.3.0 or later, and that of the OBServer node must be OceanBase Database V4.2.1 or later.

Command-line option Description ApsaraDB for OceanBase & ODP OceanBase Database & ODP OceanBase Database
--direct Specifies to enable direct load. Required Required Required
--parallel The degree of parallelism (DOP) on the server. The default value is 1. We recommend that the value be consistent with the number of CPU cores of the tenant.
We recommend that you specify this option to ensure performance stability.
Optional Optional Optional
--rpc-port The inner RPC port of the server. You can obtain the RPC port as follows:
  • In the case of connection through ODP:
    • In ApsaraDB for OceanBase, the RPC port of ODP is 3307 by default.
    • In OceanBase Database, the RPC port of ODP is 2885 by default. You can change the port by using the -s option when you start ODP.
  • In the case of direct connection to an OBServer node, you can query the DBA_OB_SERVER system view in the sys tenant for the RPC port of the OBServer node, which is 2882 by default.
Required Required Required
-u(--user) The database username. Required Required Required
-P(--port) The SQL port number. Required Required Required
-c(--cluster) The name of the cluster. Optional Required -
-t(--tenant) The tenant name for connecting to OceanBase Database.

Notice

You must use this option with the --public-cloud -t <tenant> option in direct load from cloud storage.

Required Required -
--public-cloud Imports database object definitions or table data from an ApsaraDB for OceanBase cluster.

Notice

You must use this option with the --public-cloud -t <tenant> option in direct load from cloud storage.

Required - -
--no-sys Specifies that the import does not rely on the sys tenant. This option applies only to OceanBase Database of a version earlier than V4.0.0. Optional Optional Optional
--sys-user The user on which the import relies in the sys tenant. If this option is not specified, the default value root takes effect. This option applies only to OceanBase Database of a version earlier than V4.0.0. Optional
This option is mutually exclusive with the --no-sys option.
Optional
This option is mutually exclusive with the --no-sys option.
Optional
This option is mutually exclusive with the --no-sys option.
--sys-password The password of the user on which the import relies in the sys tenant. This option applies only to OceanBase Database of a version earlier than V4.0.0. Optional
This option is mutually exclusive with the --no-sys option.
Optional
This option is mutually exclusive with the --no-sys option.
Optional
This option is mutually exclusive with the --no-sys option.

Parameters for direct load

You can configure parameters for direct load in the session.config.json file in the {ob-loader-dumper}/conf directory.

Here is an example:

"direct_path_load": {
    "task_timeout_ms": "25920000", 
    "heartbeat_timeout_ms": "60000000",
    "heartbeat_interval_ms": "30000000" 
}
  • task_timeout_ms: the timeout period of an import operation, in ms. If an import operation is not completed within the configured period, it is considered timed out.

  • heartbeat_timeout_ms: the heartbeat timeout period in ms, which is used to detect the active status of an import operation.

  • heartbeat_interval_ms: the interval between two heartbeats, in ms.

Previous topic

Command-line options
Last

Next topic

Define control files
Next
What is on this page
Background information
Scenarios
Considerations
Command-line options for direct load
Parameters for direct load