通过 ODC 连接 OceanBase 数据库

ODC 支持连接 OceanBase 数据库的 MySQL 租户。本文主要介绍该连接方式的前提条件和连接操作。

前提条件

确保已部署 OceanBase 开发者中心（ODC），并获取 Web 版 ODC 网址。部署详细操作，请参考 ODC 部署。

操作步骤

以在 Web 版 ODC 中创建个人连接（mysql@tenant）为例。具体操作步骤如下：

1. 进入 ODC 登录界面，在登录界面输入注册的账号、密码和验证码后，单击 登录。

   

2. 在 ODC 首页的 个人连接 页签的右上角单击 新建连接 创建个人连接。

   

   说明

   ODC 第一次运行时，加载时间会比较长，请耐心等待。

3. 在创建连接页签需填写或选择以下信息，如已拥有 OceanBase 数据库连接串，则以下信息均可从连接串中直接获取（mysql -h 主机名 -P 端口号 -u 数据库用户名@租户名 # 集群名 -D 默认数据库 -p '数据库密码'）或直接使用页签中提供的智能解析工具进行填充：

   

   信息项	说明
   数据库类型	选择 物理库 或 逻辑库。 物理库：普通数据库。 逻辑库：ODP (Sharding)。
   所属区域	选择连接示例所在的区域 独立部署/专有云。
   连接名称	指定该连接的名称。
   设置标签	通过标签，可为连接增加提示说明类信息。 单击 连接名称 文本框后的 设置标签 按钮为当前连接指定标签，在弹出的下拉列表中可进行设置标签和管理标签的操作： 设置标签：在下拉列表中选择目标标签完成设置。若列表为空请先新建标签。 管理标签：单击列表最下方的 新建标签 按钮或单击列表上方的设置图标以弹出 标签管理 窗口。在标签管理窗口可对已创建的标签进行编辑和删除操作。同时，可单击上方的 新建标签 按钮指定新标签的名称和图标颜色。
   智能解析	在文本框中粘贴连接串信息，ODC 会自动识别连接串并在窗口中填充各项连接信息。
   连接模式	选择 MySQL （逻辑库仅支持 MySQL 模式）。
   连接地址	主机 IP ：连接的数据库所在服务器的 IP 信息。 端口 ：连接的数据库所在服务器的端口号信息。 集群名 ：连接的数据库所在集群的名称（逻辑库无需填写）。 租户名 ：连接的数据库所在租户的名称（逻辑库无需填写）。 说明 主机名和端口号可从连接的数据库所在租户信息页面获取，如在公有云或 OCP 上创建的租户。
   数据库账号	数据库用户名：在租户中创建的账号（MySQL 模式下，该账户必须具有访问默认数据库的权限）。 数据库密码：在租户中创建的账号的密码。单击数据库密码框后的 测试连接 按钮，测试是否能够连接到目标数据库。 保存密码：关闭该项，连接信息中将不保存数据库密码信息，每次进入连接或测试连接时，需在弹出的密码弹窗中输入数据库密码以进入连接；开启该项，连接信息将保存数据库密码信息，每次进入连接无需输入数据库密码。 说明 如配置信息有误，会出现异常提示，例如用户或密码不对、网络异常等。 用户只可连接本租户下的数据库，否则会报出测试失败的错误。 ODC V4.0.0 及之后版本支持不填账号密码即可保存连接。
   默认数据库/schema（可选）	连接 MySQL 租户中的数据库时，需填写该连接使用的默认数据库。 说明 MySQL 模式下，如不指定默认库，则默认连接 information_schema 库。 如 information_schema 库连接失败，请将默认数据库设置为该用户有权限的库。
   SQL 查询超时	支持自定义 SQL 超时时间，SQL 查询超过指定的时间时查询自动终止（默认 60s）。
   sys 租户账号设置	选择是否 使用 sys 租户账号查询租户视图，勾选后输入 账号 和 密码。 数据库类型为物理库时，请输入拥有查询 sys 租户视图权限的账号和密码，当 连接地址 中已指定 租户 为 sys 时，该项被自动填充。 账户 ：拥有 sys 租户视图查看权限的账号。 密码 ：账号对应的密码。 输入账户和密码信息后，单击密码框后的 测试连接 按钮测试账户信息是否正确。 说明 自 ODC V2.3.0 之后版本，导入导出功能需在创建连接的高级配置中设置 root@sys 用户。 自 ODC V2.4.1 之后版本，导入导出功能查询视图信息时取消 root@sys 账号强依赖（如未配置 root@sys 账号，ODC 部分对象如存储过程和函数等不支持导出功能；如配置 root@sys 账号，通过访问 sys 租户下的视图信息得到最优的数据路由策略，可提升导出速度）。 sys 租户账号和密码 为集群租户下用户的账号和密码 (账号请勿填入“@sys#集群”)。例如：账号为 root。

4. 单击页面下方的 保存 按钮，即可将当前的配置信息持久保存在 ODC 连接列表中。再次登录 ODC 时，可在连接配置列表中直接选择该连接，保存连接配置时不要求测试连接一定成功。

   说明

   保存前，可以单击测试连接进行数据库连接测试，如果数据库用户名和密码正确，则会提示连接成功。

相关文档

关于 ODC 其他功能的介绍及使用，您可以登录 OceanBase 数据库官网文档中心 参阅对应版本的 ODC 产品文档。