在 DBeaver 中连接 OB Cloud 云数据库

DBeaver 是一款通用的数据库客户端工具，支持常见的关系型数据库、非关系型数据库、分布式数据库等等。本文介绍如何使用 DBeaver 连接 OB Cloud 云数据库。

前提条件

• 您已下载并安装 DBeaver。

• 您已注册 OB Cloud 云数据库账号，并创建事务型实例与目标租户。详情请参见 创建集群实例 和 创建租户。

• MySQL 模式租户已创建数据库及账号，Oracle 兼容模式租户仅需创建账号。账号已具备读写权限。详情请参见 创建账号 和 创建数据库（仅 MySQL）。

• 您具备项目管理员或实例管理员角色，可对项目中实例进行读写操作；如无权限，请联系组织管理员添加。

• （仅 Oracle 兼容模式租户） 您已在 OceanBase 软件中心 下载 OceanBase JDBC 驱动程序，供下文在 DBeaver 驱动管理器中添加。

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

1. 登录 OB Cloud 云数据库控制台。在实例列表页面，展开目标事务型实例的信息，在目标租户下，单击 连接 > 获取连接串。

2. 在弹出框中选择 公网连接。

3. 在 使用公共网络连接 页面完成如下设置，生成连接串：

   1. （可选）若租户没有已生成的公网地址，在 步骤 1: 获取公网地址 下，单击 获取公网地址 获取公网地址。若已有公网地址，可跳过此步骤。生成地址后，单击 下一步。

   2. 在 步骤 2: 安全设置 下，完成以下配置后，单击 下一步：

      • 添加 IP 地址白名单组：单击 添加，按需配置 IP 白名单，然后单击 确定。

      • 下载证书：单击 下载 CA 证书 下载证书并完成认证。

   3. 在 步骤 3: 访问数据库 下，根据租户类型完成相应配置：

      • MySQL 模式租户：选择前提条件中创建的数据库和账号，并选择 MySQL CLI 作为连接方式。完成后，复制连接串，供后续配置使用。

      • Oracle 兼容模式租户：选择前提条件中创建的账号，并选择 OBClient 作为连接方式。完成后，复制连接串，供后续配置使用。

步骤二：在 DBeaver 中连接 OB Cloud 云数据库

MySQL 模式租户

1. 打开 DBeaver 应用程序，单击 进入 选择您的数据库 页面。

   

2. 选择 MySQL，然后单击 下一步，进入到 连接设置 页面。

3. 在 连接设置 页面的 主要 页签下，根据 步骤一：获取 OB Cloud 云数据库连接串 获取的连接串完成如下配置：

   配置项	说明
   连接方式	选择 主机。
   服务器地址	取自连接串中 -h 参数，OB Cloud 云数据库连接地址，例如，t5******.aws-ap-southeast-1.oceanbase.cloud。
   端口	取自连接串中 -P 参数，OB Cloud 云数据库连接端口。
   数据库	取自连接串中 -D 参数，需要访问的数据库名称。
   用户名	取自连接串中 -u 参数，账号名称，例如：test。
   密码	取自连接串中 -p 参数，账号密码。

   

4. 单击 测试连接。当弹窗中显示 已连接，表示已成功连接 OB Cloud 数据库。

   

   说明

   若您之前未安装 MySQL 驱动，此时会弹窗提示您缺少驱动。您可根据界面提示完成安装驱动后重新测试连接。

5. 单击 确定 关闭弹窗后，单击 完成。

6. 在 数据库导航 栏下，双击刚刚添加的数据库名称。展开后若如下所示，即代表您已成功连接 OB Cloud 数据库。

   

Oracle 兼容模式租户

1. 配置驱动

1. 在 DBeaver 顶部菜单栏选择 数据库 > 驱动管理器。

2. 在 驱动管理器 弹窗中，单击 新建。

3. 在 创建新驱动 弹窗的 库 页签下，单击 添加文件，选择前提条件中已下载的 OceanBase JDBC 驱动 JAR 文件。

   

4. 切换到 设置 页签，填写如下信息：

   配置项	说明
   驱动名称	自定义名称，例如：OceanBase - Oracle。
   驱动类型	选择 Generic。
   类名	com.oceanbase.jdbc.Driver
   URL 模板	jdbc:oceanbase://{host}:{port}[/{database}]
   默认端口	与 步骤一 中连接串里的端口一致，Oracle 兼容模式租户公网连接时常见为 1521。

   

5. 单击 确定，完成驱动配置。

2. 建立连接

1. 在 DBeaver 界面，单击 进入 选择您的数据库 页面。

2. 选择您在上一小节配置的驱动名称（例如 OceanBase - Oracle），单击 下一步，进入 连接设置 页面。

3. 在 连接设置 页面的 主要 页签下，根据 步骤一 中 Oracle 兼容模式租户 获取的连接串完成如下配置：

   配置项	说明
   连接方式	选择 主机。
   服务器地址	取自连接串中 -h 参数，OB Cloud 云数据库连接地址，例如，t5******.aws-ap-southeast-1.oceanbase.cloud。
   端口	取自连接串中 -P 参数，OB Cloud 云数据库连接端口。
   数据库/模式	选填；若连接串中含 -D 参数，可填写对应需要访问的数据库或 Schema 名称。
   用户名	取自连接串中 -u 参数，账号名称（Oracle 模式下账号名常为大写，例如：TEST）。
   密码	取自连接串中 -p 参数，账号密码。

   

4. 单击 测试连接。当弹窗中显示 已连接，表示已成功连接 OB Cloud 数据库。

5. 单击 确定 关闭弹窗后，单击 完成。

6. 在 数据库导航 栏下，双击刚刚添加的连接。展开后若能看到预期对象，即表示已成功连接 OB Cloud 数据库。

后续操作

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