---
title: "旁路导入 - 导数工具 V4.3.3 | OceanBase 文档中心"
description: 旁路导入 背景信息 OceanBase 数据库支持旁路导入的方式向数据库插入数据，即 OceanBase 数据库支持向 data 文件中直接写入数据的功能。旁路导入可以绕过 SQL 层的接口，直接在 data 文件中直接分配空间并插入数据，从而提高数据导入的效率。 使用场景 旁路导入功能可以在下述场景中使用： 数据迁…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*eAudSaxX8P0AAAAAAAAAAAAADiGDAQ/original) 导数工具V 4.3.3

# 旁路导入

更新时间：2026-04-13 12:00:53

[编辑](https://github.com/oceanbase/obdumper-loader-doc/edit/V4.3.3/zh-CN/500.OBLOADER/210.obloader-bypass-import.md)  

## 背景信息

OceanBase 数据库支持旁路导入的方式向数据库插入数据，即 OceanBase 数据库支持向 `data` 文件中直接写入数据的功能。旁路导入可以绕过 SQL 层的接口，直接在 `data` 文件中直接分配空间并插入数据，从而提高数据导入的效率。

## 使用场景

旁路导入功能可以在下述场景中使用：

- 数据迁移与同步。对于数据迁移和同步，通常需要将大量的各种格式的数据从不同的数据源向 OceanBase 数据库进行迁移，传统的 SQL 接口性能可能在时效性上无法得到满足。
 - 传统 ETL。当数据在源端进行了抽取和转化之后，在装载到目标端时，通常需要在短时间内加载大量的数据，使用旁路导入技术，会提升数据导入的性能。

从文本文件或者其他数据源向 OceanBase 数据库加载数据，利用旁路导入技术，也能够提升加载数据效率。

## 注意事项

- 旁路写入需要使用 RPC 端口传输数据，并非 SQL 协议端口。
 - 基于表粒度进行整体提交，并非会话级/事务级的提交操作。
 - 暂不支持重试或者断点续传。
 - 暂不支持 bit 类型数据。
 - 暂不支持虚拟生成列。
 - 对于数据量较小的导入任务，不建议使用旁路导入。
 - 指定 `--replace-data` 命令行选项时，仍无法处理唯一索引冲突。
 - 参数 `--thread` 命令行选项与 `--parallel` 命令行选项的区别：

     - `--thread` 表示客户端到服务端的连接池，由客户端维护。
     - `--parallel` 为 OBServer 可以调用的工作线程数，用于写入数据与排序。
     - 使用时，建议 `--thread` 与 `--parallel` 保持一致。

## 旁路导入模式相关命令行选项

#### 注意

OBLOADER 旁路导入模式支持连接 OBServer 和 ODP。对应的版本要求：

- 连接 OBServer 时：要求 OBServer 必须为 V4.2.1.x 系列中的 V4.2.1.7 及之后版本、V4.2.4.0 至 V4.3.0 之间的版本、V4.3.0.x 系列中的 V4.3.0.1 及之后版本。
 - 连接 ODP 时：要求 ODP V4.3.0 及之后版本，且 OBServer 必须为 V4.2.1 及之后版本。

| 命令行选项 | 说明 | 云数据库 OceanBase & ODP | OceanBase 数据库 & ODP | OceanBase 数据库 & OBServer |
| --- | --- | --- | --- | --- |
| --direct | 标识使用旁路导入。 | 必选 | 必选 | 必选 |
| --parallel | 服务端并发度。默认值 1，建议与租户 CPU 规格一致。   **建议指定该选项以保证性能稳定。** | 非必选 | 非必选 | 非必选 |
| --rpc-port | 服务端 inner rpc port。获取方式：   - 连接 ODP 服务端时：      - 云数据库 OceanBase 环境下，ODP RPC Port 默认 3307。     - OceanBase 数据库环境下，默认端口 2885；如果需要自定义，可以在启动 ODP 时通过 `-s` 选项进行指定。 - 连接 OBServer 服务端时，sys 租户下查询系统视图 DBA_OB_SERVERS 即可获取 OBServer 的 RPC 端口，默认端口 2882。 | 必选 | 必选 | 必选 |
| -u(--user) | 数据库用户名。   #### 注意    目标端为 OceanBase 数据库 Oracle 兼容模式时，用户名需要大写。 | 必选 | 必选 | 必选 |
| -P(--port) | SQL 端口号。 | 必选 | 必选 | 必选 |
| -c(--cluster) | 数据库的集群名。 | 非必选 | 必选 | - |
| -t(--tenant) | 指定连接 OceanBase 数据库的租户名。   #### 注意    云上旁路导入时，您需要搭配 `--public-cloud -t <tenant>` 使用。 | 必选 | 必选 | - |
| --public-cloud | 用于标识从云数据库 OceanBase 部署的 OceanBase 集群中导入数据库对象或者表数据。   #### 注意    云上旁路导入时，您需要搭配 `--public-cloud -t <tenant>` 使用。 | 必选 | - | - |
| --no-sys | 用于标识不依赖 sys 租户。仅用于 OceanBase 数据库 V4.0.0 之前的版本。 | 非必选 | 非必选 | 非必选 |
| --sys-user | 用于标识依赖 sys 租户的 user。若不填，默认为 root。仅用于 OceanBase 数据库 V4.0.0 之前的版本。 | 非必选   与 --no-sys 互斥 | 非必选   与 --no-sys 互斥 | 非必选   与 --no-sys 互斥 |
| --sys-password | 用于标识依赖 sys 租户的密码。仅用于 OceanBase 数据库 V4.0.0 之前的版本。 | 非必选   与 --no-sys 互斥 | 非必选   与 --no-sys 互斥 | 非必选   与 --no-sys 互斥 |

## 旁路导入模式相关参数

您可以在 `{ob-loader-dumper}/conf` 目录下的 `session.config.json` 文件中配置旁路导入参数。

示例：

```JSON
"direct_path_load": {
    "task_timeout_ms": "25920000",
    "heartbeat_timeout_ms": "60000000",
    "heartbeat_interval_ms": "30000000"
}

```

- task_timeout_ms：配置操作的超时时间。如果在配置的时限内未完成操作，则被视为超时。单位为毫秒。
 - heartbeat_timeout_ms：设置心跳超时时间，用于检测导入操作的活跃状态。单位为毫秒。
 - heartbeat_interval_ms：设置心跳间隔时间，用于指定两次心跳之间的时间间隔。单位为毫秒。

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线
