通过 OBClient 连接 OceanBase 租户

本文主要介绍通过 OBClient 连接 OceanBase 数据库 MySQL 租户的前提条件、连接操作和示例。

前提条件

• 请确认已下载并安装了 OBClient 应用。如果未下载 OBClient 应用，您可以访问 软件中心 下载对应版本的 OBClient。

• 连接租户前，请确认当前客户端在租户白名单中，租户白名单的查询及设置具体操作请参见 查看和设置租户白名单。

连接操作

通过直连方式

使用 OBClient 客户端命令通过直连方式连接 OceanBase 数据库的格式如下：

obclient -h$host -P$port -u$user_name -p****** [-c] [-A] [$database_name]

参数说明：

• -h：指定 OceanBase 数据库的连接 IP。$host 应该被实际的 IP 替换，使用直连方式通常是一个 OBServer 节点的 IP 地址。

  注意

  普通租户通过直连方式连接时，需要确保该租户的资源分布在该 OBServer 节点上，如果该租户的资源未分布在该 OBServer 节点上，则无法通过直连该 OBServer 节点连接到该租户。

• -P：指定 OceanBase 数据库连接端口。$port 应该被实际的端口替换，使用直连方式默认是 2881，在部署 OceanBase 数据库时可自定义。

• -u：指定 OceanBase 数据库的连接账户。$user_name 格式为：用户名@租户名。MySQL 租户的管理员用户名默认是 root。

  注意

  在使用直连方式连接 OceanBase 数据库时，连接参数 -u 后应填写正确的 用户名@租户名，不要指定集群名。如果在 -u 中包含了集群名，会导致连接报错。

• -p: 指定连接 OceanBase 数据库的密码。****** 应该被实际的密码字符串替换。

  说明

  出于安全考虑，建议不在命令行直接输入密码，尤其是在脚本或历史记录可见的环境下，可以省略此选项并在提示时输入密码。

• -c：可选项，表示在 OBClient 运行环境中不要忽略注释。

  说明

  Hint 是特殊的注释，不受 -c 影响。

• -A: 可选项，表示在 OBClient 连接数据库时不自动获取统计信息。

• $database_name：可选项，指定连接 OceanBase 数据库后要使用的默认数据库。如果不提供，默认不会直接进入任何数据库，需要在连接后手动选择。

示例如下：

obclient -h10.10.10.1 -P2881 -uuser001@obtenant -p****** -c -A oceanbase

连接示例

1. 打开一个命令行终端。

2. 使用 OBClient 客户端直连 OceanBase 数据库的 MySQL 模式租户。

   obclient -hxxx.xx.xxx.xxx -P2881 -uroot@mysql001 -p****** -A oceanbase
   

3. 如果需要退出 OBClient 命令行，输入 exit 后回车，或者按快捷键 Ctrl + D。

相关文档

通过 OBClient 连接 OceanBase 数据库 Oracle 租户的操作示例请参见 通过 OBClient 连接 OceanBase 租户。