使用示例 | OceanBase 文档中心

本篇旨在介绍 OBDUMPER 支持的常见业务场景并提供对应的使用示例。

下表为示例中使用的数据库信息：

数据库信息	示例值
集群名	cluster_a
OceanBase DataBase Proxy (ODP) 主机地址	xx.x.x.x
OceanBase DataBase Proxy (ODP) 端口号	2883
集群的租户名	mysql
sys 租户下 root/proxyro 用户名	u*
sys 租户下 root/proxyro 用户的密码	******
业务租户下的用户账号（要求读写权限）	test
业务租户下的用户密码	******
Schema 名称	USERA

导出 DDL 定义文件

场景描述：将 Schema USERA 中所有已支持的对象定义语句导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。

示例语句：

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

说明

--sys-user 选项用于连接 sys 租户下拥有特定权限的用户。导出时如果未指定 --sys-user 选项，默认指定的是 --sys-user root。

任务结果示例：

...
All Dump Tasks Finished:
---------------------------------------------------
|  No.#  | Type   | Name     | Count   | Status   |  
---------------------------------------------------     
|  1     | TABLE  | table    | 1->1    | SUCCESS  |                
---------------------------------------------------

Total Count: 4          End Time: 2023-04-28 15:32:49
...

导出内容示例：

在 {ob-loader-dumper}/output/data/chz/TABLE 目录下查看 table-schema.sql 表。

[xxx@xxx /ob-loader-dumper-4.2.0-RELEASE/bin]
$cat /home/admin/obloaderobdumper/output/data/chz/TABLE/table-schema.sql
create table if not exists `table` (
        `id` int(11) comment 'table id',
        `name` varchar(120) comment 'table name',
        `type` varchar(128) not null default 'COLLABORATION' comment 'organization type, enum values: COLLABORATION, PRIVACY'
)
default charset=gbk
default collate=gbk_chinese_ci;

导出 CSV 数据文件

场景描述：将 Schema USERA 中所有表中的数据按照 CSV 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。CSV 数据文件（后缀名 .csv）请参考 RFC 4180 规范，CSV 数据文件以纯文本形式存储，可通过文本编辑器或者 Excel 等工具直接打开。

示例语句：

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

任务结果示例：

...
All Dump Tasks Finished:
----------------------------------------------------
|  No.#  | Type   | Name       | Count  | Status   | 
----------------------------------------------------      
|  1     | TABLE  | table      | 4      | SUCCESS  |                
----------------------------------------------------

Total Count: 4          End Time: 2023-04-28 15:32:49
...

导出内容示例：

在 {ob-loader-dumper}/output/data/chz/TABLE 目录下查看 table.1.0.csv 表。

[xxx@xxx /ob-loader-dumper-4.2.0-RELEASE/bin]
$cat table.1.0.csv
'id','name','type'
1001,'xiaoning','COLLABORATION'
1002,'xiaohong','COLLABORATION'
1001,'xiaoning','COLLABORATION'
1002,'xiaohong','COLLABORATION'

导出 SQL 数据文件

场景描述：将 Schema USERA 中所有表中的数据按照 SQL 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。SQL 数据文件（后缀名 .sql）存储的是 Insert SQL 语句，可通过文本编辑器或者 SQL 编辑器等工具直接打开。

示例语句：

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

任务结果示例：

...
All Dump Tasks Finished:
----------------------------------------------------
|  No.#  | Type   | Name       | Count  | Status   | 
----------------------------------------------------      
|  1     | TABLE  | table      | 4      | SUCCESS  |                
----------------------------------------------------

Total Count: 4          End Time: 2023-04-28 15:32:49
...

导出内容示例：

在 {ob-loader-dumper}/output/data/chz/TABLE 目录下查看 table.1.0.sql 表。

[xxx@xxx /ob-loader-dumper-4.2.0-RELEASE/bin]
$cat table.1.0.sql
INSERT INTO `chz`.`table` (`id`,`name`,`type`) VALUES (1001,'xiaoning','COLLABORATION');
INSERT INTO `chz`.`table` (`id`,`name`,`type`) VALUES (1002,'xiaohong','COLLABORATION');
INSERT INTO `chz`.`table` (`id`,`name`,`type`) VALUES (1001,'xiaoning','COLLABORATION');
INSERT INTO `chz`.`table` (`id`,`name`,`type`) VALUES (1002,'xiaohong','COLLABORATION');

导出 CUT 数据文件

场景描述：将 Schema USERA 中所有表中的数据按照 CUT 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。同时指定导出数据的列分隔字符串为 |@|。CUT 数据文件（后缀名 .dat）中的数据是以单个字符或者字符串分隔，可通过文本编辑器等工具直接打开。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA --table '*' -f /output --cut --column-splitter '|@|' --trail-delimiter

任务结果示例：

...
All Dump Tasks Finished:
----------------------------------------------------
|  No.#  | Type   | Name       | Count  | Status   |
----------------------------------------------------       
|  1     | TABLE  | table      | 4      | SUCCESS  |                
----------------------------------------------------

Total Count: 4          End Time: 2023-04-28 15:32:49
...

导出内容示例：

在 {ob-loader-dumper}/output/data/chz/TABLE 目录下查看 table.1.0.dat 表。

[xxx@xxx /ob-loader-dumper-4.2.0-RELEASE/bin]
$cat table.1.0.dat
1001|xiaoning|COLLABORATION|
1002|xiaohong|COLLABORATION|
1001|xiaoning|COLLABORATION|
1002|xiaohong|COLLABORATION|

导出数据文件到 Amazon S3

场景描述：将 Schema USERA 中所有表中的数据按照 CSV 格式导出到 Amazon S3 云存储空间中。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA --csv --table '*' --skip-check-dir --upload-behavior 'FAST' -f /output --storage-uri 's3://obloaderdumper/obdumper?region=cn-north-1&access-key=******&secret-key=******'

参数说明：

参数	说明
`s3`	S3 云存储类型。
`obloaderdumper`	S3 存储空间的名称。
`/obdumper`	S3 存储空间的资源路径。
`region=cn-north-1`	S3 bucket 所在的物理位置。
`access-key=******`	S3 的访问账号。
`secret-key=******`	S3 的访问密钥。

任务结果示例：

...
All Dump Tasks Finished:

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

Total Count: 3          End Time: 2023-05-10 18:46:26
...

说明

--storage-uri 必须与 --f 选项搭配使用。
OBDUMPER 首先需要导出 OceanBase 数据库对象定义和表数据到指定的 --f 路径下，再将其上传到 --storage-uri 指定的 S3 存储空间中，上传完成后，--f 路径下的数据会被自动删除。

导出数据文件到 Aliyun OSS

场景描述：将 Schema USERA 中所有表中的数据按照 CSV 格式导出到 Aliyun OSS 云存储空间中。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA --csv --table '*' --skip-check-dir --upload-behavior 'FAST' -f /output --storage-uri 'oss://antsys-oceanbasebackup/backup_obloader_obdumper/obdumper?endpoint=https://cn-hangzhou-alipay-b.oss-cdn.aliyun-inc.com&access-key=******&secret-key=******'

参数说明：

参数	说明
`oss`	OSS 云存储类型。
`antsys-oceanbasebackup`	OSS 存储空间的名称。
`/backup_obloader_obdumper/obdumper`	OSS 存储空间的资源路径。
`region=cn-north-1`	OSS bucket 所在的物理位置。
`endpoint=https://cn-hangzhou-alipay-b.oss-cdn.aliyun-inc.com`	OSS host 所在地域的 Endpoint
`access-key=******`	OSS 的访问账号。
`secret-key=******`	OSS 的访问密钥。

任务结果示例：

...
All Dump Tasks Finished:

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

Total Count: 3          End Time: 2023-05-10 18:40:48
...

说明

自定义导出文件名

场景描述：将 Schema USERA 中 table 表的数据按照 CSV 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。同时指定导出的文件名称为 filetest。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA --csv --table 'table' --file-name 'filetest.txt' -f /output

任务结果示例：

...
All Dump Tasks Finished:
----------------------------------------------------
|  No.#  | Type   | Name       | Count  | Status   | 
----------------------------------------------------      
|  1     | TABLE  | table      | 4      | SUCCESS  |                
----------------------------------------------------

Total Count: 4          End Time: 2023-04-28 15:32:49
...

导出内容示例：

在 {ob-loader-dumper}/output/data/chz/TABLE 目录下查看 filetest.txt 表。

[xxx@xxx /ob-loader-dumper-4.2.0-RELEASE/bin]
$cat filetest.txt
1001,'xiaoning','COLLABORATION'
1002,'xiaohong','COLLABORATION'
1001,'xiaoning','COLLABORATION'
1002,'xiaohong','COLLABORATION'

导出数据时使用控制文件

场景描述：将 Schema USERA 中 table 表的数据按照 CSV 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。同时指定控制文件的路径为 /output，为导出的数据进行预处理。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA --table'table' -f /output --csv --ctl-path /output

说明

要求数据库中定义的表名与其对应的控制文件名大小写一致，否则 OBLOADER 无法识别控制文件。控制文件的定义规则可参考预处理函数。

导出表中指定列的数据

场景描述：将 Schema USERA 中 table 表的数据按照 CSV 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。同时指定 --exclude-column-names 选项忽略表中不需要被导出的列。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA -f /output --table'table' --csv --exclude-column-names 'deptno'

导出自定义查询结果集

场景描述：将 --query-sql 选项指定的查询语句执行的结果集按照 CSV 格式导出到 /output 目录中（OceanBase 4.0.0 之前的版本要求提供 sys 租户的密码）。

示例语句：

$./obdumper -h xx.x.x.x -P 2883 -u test -p ****** --sys-user **u*** --sys-password ****** -c cluster_a -t mysql -D USERA -f /output --csv --query-sql 'select deptno,dname from dept where deptno<3000'

说明

用户需要保证 SQL 查询语句的语法正确性以及查询性能。

公共云导出模式和数据

场景描述：用户无法提供 sys 租户密码时，将公共云 Schema USERA 中所有已定义的数据库对象和表数据导出到 /output 目录中。

示例语句：

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

私有云导出模式和数据

场景描述：用户无法提供 sys 租户密码时，将私有云 Schema USERA 中所有已定义的数据库对象和表数据导出到 /output 目录中。

示例语句：

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

注意

在公共云或者私有云环境中无法提供 sys 租户密码时，导出数据库对象定义功能可能存在缺陷。例如：MySQL 租户无法导出序列定义；OceanBase 2.2.70 之前的版本，无法导出表组定义；OceanBase 2.2.70 之前的版本，无法导出唯一索引的分区信息。