通过 DBeaver 连接 OceanBase 数据库

DBeaver 是一款通用的数据库客户端工具，其原理是使用各个数据库提供的 JDBC 驱动连接数据库，支持常见的关系型数据库、非关系型数据库、分布式数据库等等。

使用 DBeaver 自带的 OceanBase 驱动或 MySQL 驱动均可连接 OceanBase 数据库的 MySQL 租户，本文将以 OceanBase 驱动为例介绍如何使用 DBeaver 连接 OceanBase 数据库的 MySQL 租户。

前提条件

• 请确保已获取并安装 DBeaver，您可访问 DBeaver 官方下载地址 下载系统对应的 DBeaver。

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

• 您已安装 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

步骤二：通过 DBeaver 控制台连接 OceanBase 数据库

1. （可选）更换驱动文件版本。

   DBeaver 中 OceanBase 驱动默认的驱动文件为 mysql-connector-java-5.1.44，本篇文档中以 mysql-connector-java-5.1.47 版本为例，您可参考如下步骤更换驱动文件。

   1. 访问 MySQL 官方 JDBC 驱动下载 页面下载 5.1.47 版本驱动文件。

   2. 单击 数据库 > 驱动管理器，搜索 OceanBase，选中 OceanBase 驱动后单击 编辑，进入到编辑驱动页面。

   3. 选择 库 页签，选中 OceanBase 驱动自带的驱动文件，单击 删除。

   4. 单击 添加文件，将下载的驱动文件添加到库中，单击 确定 即可完成驱动文件的更换。

2. 单击 数据库 > 新建数据库连接，进入到 选择您的数据库 页面。您也可以单击 文件 下方的连接符 直接进入到 选择您的数据库 页面。

   

3. 在 选择您的数据库 页面选择 OceanBase，单击 下一步，进入到 连接设置 页面，填写 Host、Port、Tenant、用户名和密码，之后单击 测试连接。

   

   说明

   您可通过 IP 直连或 OBProxy 代理两种方式连接数据库。直连时 Port 填写配置的 mysql_port 进行连接，默认端口为 2881。使用 OBProxy 连接时，Port 填写配置的 proxy_port，默认端口为 2883。

4. 当 连接测试 弹窗中显示 已连接，表示可成功连接，单击 确定 后，单击 完成 即可连接到 OceanBase 数据库。

   

5. 双击 数据库导航 栏中的数据库名称，展开后如下图，即代表已成功连接 OceanBase 数据库。

   

更多信息

如果在通过 DBeaver 连接 OceanBase 数据库的过程中遇到问题，建议您查阅 DBeaver 客户端官方的使用文档。