在 TablePlus 中连接 OceanBase 数据库

TablePlus 是一款现代化、原生的数据库管理工具，它提供了便捷、友好的图形用户界面，可用于管理各种关系型数据库，如 MySQL、PostgreSQL、SQLite 等。本文以 OB Cloud 事务型实例的 MySQL 租户和 macOS 操作系统为例，介绍如何在 TablePlus 中连接 OceanBase 数据库。

前提条件

• 您已下载并安装 TablePlus，详情请参见 TablePlus 官方网站。

• 请确保待连接的 OBServer 节点 IP 与 TablePlus 所在机器保持网络连通。

• 您已安装 OceanBase 数据库并且创建了 MySQL 模式租户。

操作步骤

步骤一：获取数据库连接串

联系 OceanBase 数据库部署人员或者管理员获取相应的数据库连接串，例如：

obclient -h$host -P$port -u$user_name -p$password -D$database_name

参数说明：

• $host：提供 OceanBase 数据库连接 IP。OceanBase 数据库代理（OceanBase Database Proxy，ODP）连接方式使用的是一个 ODP 地址；直连方式使用的是 OBServer 节点的 IP 地址。

• $port：提供 OceanBase 数据库连接端口。ODP 连接的方式默认是 2883，在部署 ODP 时可自定义；直连方式默认是 2881，在部署 OceanBase 数据库时可自定义。

• $database_name：需要访问的数据库名称。

  注意

  连接租户的用户需要拥有该数据库的 CREATE、INSERT、DROP 和 SELECT 权限。更多有关用户权限的信息，请参见 MySQL 模式下的权限分类。

• $user_name：提供租户的连接账户。ODP 连接的常用格式：用户名@租户名#集群名 或者 集群名:租户名:用户名；直连方式格式：用户名@租户名。

• $password：提供账户密码。

更多连接串的信息，请参见 通过 OBClient 连接 OceanBase 租户。

示例如下：

obclient -hxxx.xxx.xxx.xxx -P2881 -utest_user001@mysql001 -p****** -Dtest

步骤二：在 TablePlus 中创建 OceanBase 数据源进行连接

1. 在您的本地打开 TablePlus 后，在界面右侧，单击鼠标右键，然后选择 New > Connection。

2. 在弹出框中选择 MySQL，然后单击 Create。

3. 在 MySQL Connection 对话框中，根据 步骤一：获取 OceanBase 数据库连接串 获取的连接串完成如下配置：

   配置项	说明
   Name	自定义的 Connection 名称。
   Host/IP	取自连接串中 -h 参数，OceanBase 数据库连接地址。
   Port	取自连接串中 -P 参数，OB Cloud 云数据库连接端口。
   User	取自连接串中 -u 参数，账号名称，例如：test。
   Password	取自连接串中 -p 参数，账号密码。
   Database	取自连接串中 -D 参数，需要访问的数据库名称。

4. 单击 Test，测试是否能够成功连接。当输入框底色变为绿色，则表示连接成功。

5. 测试连接成功后，单击 Connect，完成连接。

后续操作

完成连接后，您可开始使用 TablePlus。有关 TablePlus 的详细操作指南，请参见 TablePlus 官方使用文档。