创建数据源 - 开发者中心 ODC V4.4.2

本文档旨在介绍如何创建数据源。

背景信息

ODC 支持与 OceanBase 和数据库建立连接，连接成功后，您可以通过 ODC 对所连接的数据源（数据库对象和资源）进行编辑和管理。ODC 支持连接专有云和公有云环境中的 OceanBase 数据库（OceanBase MySQL/Oracle、OB Cloud MySQL/Oracle、OB Sharding MySQL）、MySQL、Oracle、Doris、PostgreSQL，以及对象存储数据（阿里云 OSS/腾讯云 COS/华为云 OBS/AWS S3）。

前提条件

数据源功能限制和版本要求请参见使用限制。

已部署 Web 版 ODC。
登录 Web 版 ODC 以进入数据源管理页面。
获取数据源实例的连接信息或连接串。OceanBase MySQL 类型连接串示例：

连接串（mysql -h 主机名 -P 端口号 -u 数据库用户名@租户名 # 集群名 -D 默认数据库 -p ' 数据库密码 '）
```
-hxxx.x.x.x -P8080 -uodc@mysql_tenant#odc_cluster -Dodc -p'******'
```

操作步骤

新建单个数据源

新建 OceanBase 数据源

新建 MySQL 数据源

新建 Oracle 数据源

新建 Doris 数据源

新建 PostgreSQL 数据源

新建对象存储数据源

说明

ODC V4.2.2 及之后的版本支持创建 OceanBase 类型的数据源，以通过 ODC 即可管理 OceanBase 数据库中的数据。OceanBase 数据源功能限制请参见使用限制。
ODC 支持的 OceanBase 数据库类型包括：
- 独立部署/专有云（OceanBase MySQL/OceanBase Oracle）：用户在自己环境中搭建的数据库实例。
- 公有云（OB Cloud MySQL/OB Cloud Oracle）：阿里云上的数据库实例。
- 逻辑库（OceanBase MySQL Sharding）：逻辑库仅支持 MySQL 模式。

示例：在 ODC 中创建 OceanBase MySQL 类型的数据源 obmysql4.2.0，并将数据源绑定到项目 odc_4.2.0。

信息项	示例值
项目名称	odc_4.2.0
数据源名称	obmysql4.2.0
主机 IP	xxx.x.x.x
端口	8080
集群名	odc_cluster
租户名	mysql_tenant
数据库用户名	odc
数据库密码	******
sys 租户账号	test
sys 租户密码	******

在弹出的 新建数据源 面板中填写或选择以下信息。

说明

如已拥有 OceanBase 数据库连接串，则以下信息均可从连接串中直接获取或直接使用页签中提供的智能解析工具进行填充。

信息项	说明
数据源类型	默认显示选择的数据源类型。
智能解析	在文本框中粘贴连接串信息，ODC 会自动识别连接串并在窗口中填充各项连接信息。
连接地址	主机 IP：连接的数据库所在服务器的 IP 信息。端口：连接的数据库所在服务器的端口号信息。集群名：连接的数据库所在集群的名称（逻辑库无需填写）。租户名：连接的数据库所在租户的名称（逻辑库无需填写）。说明主机名和端口号可从连接的数据库所在租户信息页面获取，如在公有云或 OCP 上创建的租户。仅通过 OBProxy 连接 OceanBase 数据库的用户需要填写集群名。
数据库账号	数据库用户名：在租户中创建的账号（OceanBase MySQL 模式下，该账户必须具有访问默认数据库的权限）。数据库密码：在租户中创建的账号的密码。单击数据库密码框后的测试连接按钮，测试是否能够连接到目标数据库。说明如配置信息有误，会出现异常提示，例如用户或密码不对、网络异常等。您只可连接本租户下的数据库，否则会报出测试失败的错误。保存前，可以单击测试连接进行数据库连接测试，如果数据库用户名和密码正确，则会显示连接成功。ODC V4.0.0 及之后版本支持不填账号密码即可保存连接。
环境	您可根据需求选择环境类型：开发/测试/生产等。
项目	您可以将创建的数据源绑定到指定项目/不绑定项目。数据源绑定项目后，用户创建的数据库将自动移入项目。说明数据库系统的内置数据库是否自动同步到项目是通过系统配置项 `odc.connect.database.sync.block-internal-database` 确定。该配置项默认为 true，表示不会自动将内置的数据库转移到绑定的项目。ODC 识别的数据库系统内置数据库如下： OceanBase Oracle：`SYS`。 OceanBase MySQL：`information_schema`, `mysql`, `test`, `oceanbase`。 MySQL：`information_schema`, `mysql`, `test`。
高级设置	sys 租户账号：选择是否使用 sys 租户账号查询租户视图，勾选后输入账号和密码。数据库类型为物理库时，请输入拥有查询 sys 租户视图权限的账号和密码，当连接地址中已指定租户为 sys 时，该项被自动填充。账户：拥有 `sys` 租户视图查看权限的账号。密码：账号对应的密码。输入账户和密码信息后，单击密码框后的测试连接按钮测试账户信息是否正确。 SSL：选择是否启用 SSL 加密 SSL 链路，以保证客户端和服务器之间数据的安全传输。通过 ODC 启用 SSL 前，须确认 OBServer 端已开启 SSL；如通过 OBProxy 连接，同样需保证 OBProxy 已开启 SSL。如何在 Server 端开启 SSL，请参见 OBServer 传输加密和公有云 OceanBase SSL 链路加密。连接初始化脚本：支持通过 SQL 语句配置连接会话。示例：`set session ob_query_timeout=60000000` 驱动属性：支持配置驱动属性连接到 OceanBase 数据库并实现指定功能。说明 ODC V2.3.0 及之后的版本，导入导出功能需在创建连接的高级配置中设置 root@sys 用户。 ODC V2.4.1 及之后的版本，导入导出功能查询视图信息时取消 root@sys 账号强依赖（如未配置 root@sys 账号，ODC 部分对象如存储过程和函数等不支持导出功能；如配置 root@sys 账号，通过访问 sys 租户下的视图信息得到最优的数据路由策略，可提升导出速度）。 sys 租户账号和密码为集群租户下用户的账号和密码 (账号请勿填入“@sys#集群”)。例如：账号为 `root`。通过非加密方式（`REQUIRE NONE`）创建的用户（默认为 `REQUIRE NONE`）可根据需求选择是否开启 SSL。如果勾选启用 SSL，则会创建一个 SSL 连接；如不勾选，则创建的为普通连接。通过 SSL 连接方式（`REQUIRE SSL`）创建的用户勾选启用 SSL 后，即可创建 SSL 连接；如不勾选，则会连接失败。通过 `REQUIRE SSL` 创建的用户可不上传证书但必须勾选启用 SSL，否则连接失败。推荐上传证书以验证通信双方身份（非必须）：上传 CA 证书，客户端会校验服务端的身份；上传客户端密钥和客户端证书，服务端会校验客户端的身份。通过 x509 加密方式（`REQUIRE X509`）创建的用户必须启用 SSL 且上传 CA 证书以及客户端密钥和客户端证书，客户端和服务端会校验对方身份；不勾选启用 SSL 或不上传证书均无法成功创建连接。

指定上述信息后，单击面板右下角的确定按钮。
在弹窗中自定义数据源名后，单击确定按钮，即可将当前的配置信息持久保存在 ODC 数据源列表中。

说明

在 新建数据源 面板右下方，单击 复制连接串 按钮将当前编辑的连接信息复制为连接串格式。以方便获取当前配置的连接信息。
如无需保存当前的连接配置，可单击取消按钮，ODC 会弹出弹窗以确认是否退出当前新建连接窗口。

创建完成后，可在数据源列表中查看创建的数据源。

说明

ODC V4.2.2 及之后的版本支持创建 MySQL 类型的数据源，以通过 ODC 即可管理 MySQL 数据库中的数据。MySQL 数据源功能限制请参见使用限制。

示例：在 ODC 中创建 MySQL 类型的数据源，并将数据源绑定到项目 odc_4.2.0。

信息项	示例值
项目名称	odc_4.2.0
数据源名称	mysql4.2.2
主机 IP	xxx.x.x.x
端口	8080
数据库用户名	odc
数据库密码	******

在弹出的 新建数据源 面板中填写或选择以下信息。

说明

如已拥有 MySQL 数据库连接串，则以下信息均可从连接串中直接获取或直接使用页签中提供的智能解析工具进行填充。

信息项	说明
数据源类型	默认显示选择的数据源类型。
智能解析	在文本框中粘贴连接串信息，ODC 会自动识别连接串并在窗口中填充各项连接信息。
连接地址	主机 IP：连接的数据库所在服务器的 IP 信息。端口：连接的数据库所在服务器的端口号信息。
数据库账号	数据库用户名：MySQL 数据库用户名。数据库密码：在 MySQL 数据库中创建的账号密码。单击数据库密码框后的测试连接按钮，测试是否能够连接到目标数据库。说明如配置信息有误，会出现异常提示，例如用户或密码不对、网络异常等。保存前，可以单击测试连接进行数据库连接测试，如果数据库用户名和密码正确，则会显示连接成功。ODC V4.0.0 及之后版本支持不填账号密码即可保存连接。
环境	您可根据需求选择环境类型：开发/测试/生产等。
项目	您可以将创建的数据源绑定到指定项目/不绑定项目。数据源绑定项目后，用户创建的数据库将自动移入项目。说明数据库系统的内置数据库是否自动同步到项目是通过系统配置项 `odc.connect.database.sync.block-internal-database` 确定。该配置项默认为 true，表示不会自动将内置的数据库转移到绑定的项目。ODC 识别的数据库系统内置数据库如下： OceanBase Oracle：`SYS`。 OceanBase MySQL：`information_schema`, `mysql`, `test`, `oceanbase`。 MySQL：`information_schema`, `mysql`, `test`。
高级设置	连接初始化脚本：支持通过 SQL 语句配置连接会话。示例：`set session ob_query_timeout=60000000` 驱动属性：支持配置驱动属性连接到 OceanBase 数据库并实现指定功能。说明使用 ODC V4.2.2 版本新建 MySQL 类型数据源时，仅支持设置连接初始化脚本和驱动属性。

指定上述信息后，单击面板右下角的确定按钮。
在弹窗中自定义数据源名后，单击确定按钮，即可将当前的配置信息持久保存在 ODC 数据源列表中。

说明

在 新建数据源面板右下方，单击 复制连接串 按钮将当前编辑的连接信息复制为连接串格式。以方便获取当前配置的连接信息。
如无需保存当前的连接配置，可单击取消按钮，ODC 会弹出弹窗以确认是否退出当前新建连接窗口。

创建完成后，可在数据源列表中查看创建的数据源。

说明

ODC V4.2.4 及之后的版本支持创建 Oracle 类型的数据源，以通过 ODC 即可管理 Oracle 数据库中的数据。Oracle 数据源功能限制请参见使用限制。

示例：在 ODC 中创建 Oracle 类型的数据源。

信息项	示例值
数据源名称	oracle4.2.4
主机 IP	xxx.x.x.x
端口	8080
数据库 SID	test
数据库用户名	odc
数据库密码	******

在弹出的 新建数据源 面板中填写或选择以下信息。

信息项	说明
数据源类型	默认显示选择的数据源类型。
连接地址	主机 IP/域名：连接的数据库所在服务器的 IP 信息。端口：连接的数据库所在服务器的端口号信息。数据库：SID（实例名）/服务名（SERVICE_NAME）。
数据库账号	角色：默认/SYSDBA/SYSOPER。数据库用户名：Oracle 数据库用户名。数据库密码：在 Oracle 数据库中创建的账号密码。单击数据库密码框后的测试连接按钮，测试是否能够连接到目标数据库。说明如配置信息有误，会出现异常提示，例如用户或密码不对、网络异常等。保存前，可以单击测试连接进行数据库连接测试，如果数据库用户名和密码正确，则会显示连接成功。ODC V4.0.0 及之后版本支持不填账号密码即可保存连接。
环境	您可根据需求选择环境类型：开发/测试/生产等。
项目	您可以将创建的数据源绑定到指定项目/不绑定项目。数据源绑定项目后，用户创建的数据库将自动移入项目。
高级设置	连接初始化脚本：支持通过 SQL 语句配置连接会话。示例：`set session ob_query_timeout=60000000` 驱动属性：支持配置驱动属性连接到 OceanBase 数据库并实现指定功能。

指定上述信息后，单击面板右下角的确定按钮。
在弹窗中输入数据源名后，单击确定按钮，即可将当前的配置信息持久保存在 ODC 数据源列表中。

说明

ODC 支持创建 Doris 类型的数据源，以通过 ODC 即可管理 Doris 数据库中的数据。Doris 数据源功能限制请参见使用限制。

在弹出的 新建数据源 面板中填写或选择以下信息。

信息项	说明
数据源类型	默认显示选择的数据源类型。
连接地址	主机 IP/域名：连接的数据库所在服务器的 IP 信息。端口：连接的数据库所在服务器的端口号信息。
数据库账号	数据库用户名：MySQL 数据库用户名。数据库密码：在 MySQL 数据库中创建的账号密码。单击数据库密码框后的测试连接按钮，测试是否能够连接到目标数据库。说明如配置信息有误，会出现异常提示，例如用户或密码不对、网络异常等。保存前，可以单击测试连接进行数据库连接测试，如果数据库用户名和密码正确，则会显示连接成功。ODC V4.0.0 及之后版本支持不填账号密码即可保存连接。
环境	您可根据需求选择环境类型：开发/测试/生产等。
项目	您可以将创建的数据源绑定到指定项目/不绑定项目。数据源绑定项目后，用户创建的数据库将自动移入项目。
高级设置	连接初始化脚本：支持通过 SQL 语句配置连接会话。示例：`set session ob_query_timeout=60000000` 驱动属性：支持配置驱动属性连接到 OceanBase 数据库并实现指定功能。

指定上述信息后，单击面板右下角的确定按钮。
在弹窗中输入数据源名后，单击确定按钮，即可将当前的配置信息持久保存在 ODC 数据源列表中。

说明

ODC V4.3.2 及之后的版本支持创建 PostgreSQL 类型的数据源，以通过 ODC 即可管理 PostgreSQL 数据库中的数据。PostgreSQL 数据源功能限制请参见使用限制。

在弹出的 新建数据源 面板中填写或选择以下信息。

信息项	说明
数据源类型	默认显示选择的数据源类型。
连接地址	主机 IP/域名：连接的数据库所在服务器的 IP 信息。端口：连接的数据库所在服务器的端口号信息。数据库：PostgreSQL 数据库。
数据库账号	数据库用户名：MySQL 数据库用户名。数据库密码：在 MySQL 数据库中创建的账号密码。单击数据库密码框后的测试连接按钮，测试是否能够连接到目标数据库。说明如配置信息有误，会出现异常提示，例如用户或密码不对、网络异常等。保存前，可以单击测试连接进行数据库连接测试，如果数据库用户名和密码正确，则会显示连接成功。ODC V4.0.0 及之后版本支持不填账号密码即可保存连接。
环境	您可根据需求选择环境类型：开发/测试/生产等。
项目	您可以将创建的数据源绑定到指定项目/不绑定项目。数据源绑定项目后，用户创建的数据库将自动移入项目。
高级设置	连接初始化脚本：支持通过 SQL 语句配置连接会话。示例：`set session ob_query_timeout=60000000` 驱动属性：支持配置驱动属性连接到 OceanBase 数据库并实现指定功能。

指定上述信息后，单击面板右下角的确定按钮。
在弹窗中输入数据源名后，单击确定按钮，即可将当前的配置信息持久保存在 ODC 数据源列表中。

说明

通过 ODC 创建的对象存储数据源仅支持数据归档任务。
ODC V4.3.3 及之后的版本支持的对象存储数据源类型包括：阿里云 OSS、腾讯云 COS、华为云 OBS 和 AWS S3。
ODC V4.3.2 及之后的版本支持创建 PostgreSQL 类型的数据源，以通过 ODC 即可管理 PostgreSQL 数据库中的数据。PostgreSQL 数据源功能限制请参见使用限制。

示例：在 ODC 中创建阿里云 OSS 类型的数据源。

在弹出的 新建数据源 面板中填写或选择以下信息。

信息项	说明
数据源类型	默认显示选择的数据源类型。
文件 URL	访问对象文件的路径地址。例如 `oss://odc-sample/bucketname`。
Endpoint	对外服务的访问域名。例如：`oss-cn-hangzhou.aliyuncs.com`。
访问密钥	OSS 用户访问密钥 ID 和访问密钥。
环境	您可根据需求选择环境类型：开发/测试/生产等。
项目	您可以将创建的数据源绑定到指定项目/不绑定项目。数据源绑定项目后，用户创建的数据库将自动移入项目。

指定上述信息后，单击面板右下角的确定按钮。
在弹窗中输入数据源名后，单击确定按钮，即可将当前的配置信息持久保存在 ODC 数据源列表中。

批量导入数据源

ODC V4.2.0 及之后的版本支持通过上传配置文件，批量导入数据源。操作步骤如下：

在 数据源 页面中单击 新建数据源 > 批量导入。

在弹出的 批量导入 面板中单击 下载模板，填写需要导入的数据源信息。

信息项	说明
数据源名称	必填项。指定该连接的名称。名称不可包含空格且不可重复。
数据源类型	必填项。选择 OB Oracle/OB MySQL/Cloud OB Oracle/Cloud OB MySQL/ODP(Sharding) OB MySQL。
主机 IP	必填项。指定连接的数据库所在服务器的 IP 信息。主机 IP 可从连接的数据库所在租户信息页面获取，如在公有云或 OCP 上创建的租户。
端口	必填项。指定连接的数据库所在服务器的端口号信息。端口号可从连接的数据库所在租户信息页面获取，如在公有云或 OCP 上创建的租户。
集群名	非必填项。指定连接的数据库所在集群的名称（逻辑库无需填写）。
租户名	必填项。指定连接的数据库所在租户的名称（逻辑库无需填写）。租户名不可包含空格。
数据库用户名	必填项。在租户中创建的账号（MySQL 模式下，该账户必须具有访问默认数据库的权限）。
数据库密码	指定在租户中创建的账号的密码。密码位空表示密码为空字符串。
环境	根据需求选择环境类型：开发/测试/生产等。
sys 租户账号	非必填项。指定拥有 sys 租户视图查看权限的账号。
sys 租户密码	非必填项。指定账号对应的密码。

单击 批量导入 面板中的文件池进入文件资源管理器以选择需要导入的文件，或者直接将文件拖入文件池中以完成文件上传。
单击导入，完成批量导入数据源信息，并可以在数据源列表中查看导入的数据源信息。