---
title: "旁路导入 - OB Cloud 云数据库 master | OceanBase 文档中心"
description: 旁路导入 本文为您介绍如何通过 OB Cloud 云数据库控制台开启和关闭旁路导入端口。 概述 OB Cloud 云数据库支持通过旁路导入的方式向数据库中插入数据。该功能可以绕过传统的 SQL 层接口，直接向数据库的文件写入数据，从而提高数据导入的效率。详情请参见 旁路导入概述 。 前提条件 在使用旁路导入时，进行如…
image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*qbZXRo_94ZEAAAAAAAAAAAAADiGDAQ/original) OB Cloud 云数据库

# 旁路导入

更新时间：2026-04-01 16:57:53

本文为您介绍如何通过 OB Cloud 云数据库控制台开启和关闭旁路导入端口。

## 概述

OB Cloud 云数据库支持通过旁路导入的方式向数据库中插入数据。该功能可以绕过传统的 SQL 层接口，直接向数据库的文件写入数据，从而提高数据导入的效率。详情请参见 [旁路导入概述](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000003977059)。

## 前提条件

在使用旁路导入时，进行如下检查，只有满足下述情况时，才可以进行开启旁路导入端口的操作。

- 您已具备集群实例的读写权限。
 - 当前集群为事务型实例，并且处于运行中状态。
 - 当前租户为运行中状态。
 - 主地址的私网地址为运行状态。

## 开启旁路导入

1. 登录 [OB Cloud 云数据库控制台](https://console-cn.oceanbase.com/)。
 2. 在 **实例列表** 页面，单击目标集群实例的名称，进入 **实例工作台**。
 3. 在左侧导航栏，单击 **数据库代理**。
 4. 在 **数据库代理** 页面主地址的私网地址区域，单击 **旁路导入端口** 右侧的 **开启**。

   ![migration179-zh](https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/doc/img/oms/oceanbase-cloud/migration179-zh.png)
 5. 在二次确认弹窗中，单击 **确定**。

## 导入数据

1. 下载最新版本的 [OceanBase 导数工具](https://www.oceanbase.com/softwarecenter)。

   OceanBase 导数工具的详情请参见 [产品介绍](https://www.oceanbase.com/docs/common-oceanbase-dumper-loader-1000000003972546)。
 2. 查看和设置环境变量。

      1. 查看 Java 和 PATH 相关的环境变量。

        ```shell
        [root@iZbxxxx rpc]# env | grep JAVA
        JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.382.b05-2.0.3.al8.x86_64
        [root@iZbxxxx rpc]# env | grep PATH
        PATH=/root/ob-loader-dumper-4.3.0-RELEASE/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin

        ```
      2. 设置 Java 和 PATH 环境变量。

        ```shell
        [root@iZbxxxx rpc]# export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.382.b05-2.0.3.al8.x86_64
        [root@iZbxxxx rpc]# export PATH=/root/ob-loader-dumper-4.3.0-RELEASE/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin:$PATH

        ```
 3. 通过旁路导入方式导入数据。

   #### 说明

   导入的文件内容格式需要符合规范，详情请参见 [导入数据支持的文件格式与编码格式](https://www.oceanbase.com/docs/common-oceanbase-cloud-1000000000927507)。

   ```shell
   [root@iZbxxxx rpc]# obloader -h<host> -u<user_name> -p<pass_word> -D <db_name> --table '<table_name>' -f output1 -t <tenant_name> --public-cloud --csv --direct --rpc-port 3307 -P3306

   ```

   | **参数** | **描述** |
   | --- | --- |
   | -h | 指定 OceanBase 数据库的主机地址。 |
   | -u | 用于连接 OceanBase 数据库的用户名、租户名和集群名，格式为 `<user>@<tenant>#<cluster>`。例如，`-u user@tenant#cluster`。 |
   | -p | 指定连接 OceanBase 数据库的用户密码。 |
   | -D | 指定需要导入数据库对象定义和表数据的 OceanBase 数据库的名称。 |
   | --table | 对 OceanBase 数据库中的指定表进行操作。例如，`--table 'example'`。 |
   | -f | 指定待导入文件名的前缀。例如，该条命令表示待导入的数据被保存在以`output1`为前缀命名的文件中。 |
   | -t | 该参数搭配 `--public-cloud` 使用，指定连接 OceanBase 数据库的租户名。 |
   | --public-cloud | 用于标识从云数据库 OceanBase 部署的 OceanBase 集群中导入数据库对象或者表数据。 |
   | --csv | 指定待导入的数据文件格式为 CSV。您可以根据待导入数据的实际格式进行指定，例如，`--sql`、`--par` 和`--orc`等。 |
   | --direct | 指定使用旁路导入模式。该参数与 `--rpc-port`、`--parallel` 搭配使用。 |
   | --parallel | 用于旁路导入时加载数据的并行度。该参数可选，默认值为 1，与 `--rpc-port`、`--direct` 搭配使用。 |
   | --rpc-port 3307 | 用于连接 OBServer RPC 的端口。 表示虽然连接数据库的端口为 3306（由 -P3306 指定），但是实际的数据导入通过 3307 端口的 RPC 服务完成，以提高导入性能。 |
   | -P 3306 | 指定连接 OceanBase 数据库的主机端口。 |

## 关闭旁路导入

1. 登录 [OB Cloud 云数据库控制台](https://console-cn.oceanbase.com/)。
 2. 在 **实例列表** 页面，单击目标集群实例的名称，进入 **实例工作台**。
 3. 在左侧导航栏，单击 **数据库代理**。
 4. 在 **数据库代理** 页面主地址的私网地址区域，单击 **旁路导入端口** 右侧的 **关闭**。

   #### 注意

   关闭旁路导入端口前，请确保该旁路导入端口上没有任何其他服务连接。

   ![migration180-zh](https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/doc/img/oms/oceanbase-cloud/migration180-zh.png)
 5. 在二次确认弹窗中，单击 **确定**。

 上一篇 下一篇 ![有帮助](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) 咨询热线
