通过 MySQL 客户端连接 OceanBase 租户

需要使用 OceanBase 数据库的 MySQL 租户时，可以使用 MySQL 客户端连接该租户。本节主要介绍该连接方式的前提条件、连接操作和示例。

前提条件

通过 MySQL 客户端连接数据库前，需要确认以下信息：

• 确保本地已正确安装 MySQL 客户端。OceanBase 数据库当前版本支持的 MySQL 客户端版本包括 V5.5、V5.6 和 V5.7。

• 确保环境变量 PATH 中包含了 MySQL 客户端命令所在目录。

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

连接操作

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

2. 使用 MySQL 命令连接 MySQL 租户。

   • 通过 ODP 连接的方式

     $mysql -h10.10.10.1 -uusername@obmysql#obdemo -P2883 -p****** -c -A oceanbase
     

     或者

     $mysql -h10.10.10.1 -uobdemo:obmysql:username -P2883 -p****** -c -A oceanbase
     

     参数说明：

     • -h：提供 OceanBase 数据库连接 IP，通常是一个 ODP 地址。

     • -u：提供租户的连接账户，格式有：用户名@租户名#集群名、集群名:租户名:用户名、集群名-租户名-用户名 或者 集群名.租户名.用户名。使用 My SQL 客户端仅支持连接 MySQL 租户，MySQL 租户的管理员用户名默认是 root。

       说明

       • 当使用 ODP 连接 OceanBase 集群时，可以通过以下方式获取集群名：
         先通过直连的方式连接 OceanBase 数据库；然后使用 SHOW PARAMETERS LIKE 'cluster'; 命令来获取集群的名称，该命令会返回结果中 VALUE 的值对应 OceanBase 集群的名称。
       • 如果 ODP 代理多个集群，连接时必须指定集群名；如果 ODP 只代理一个集群，连接时则不需指定集群名。

     • -P：提供 OceanBase 数据库连接端口，也是 ODP 的监听端口，默认为 2883，在部署 ODP 时可自定义。

     • -c：表示在 MySQL 运行环境中不要忽略注释。

       说明

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

     • -A：表示在 MySQL 连接数据库时不自动获取统计信息。

     • oceanbase：访问的数据库的名称，可以更改为业务数据库。

     示例：

     $mysql -h10.10.10.1 -u******@obmysql#obdemo -P2883 -p****** -c -A oceanbase
     

     或者

     $mysql -h10.10.10.1 -uobdemo:obmysql:****** -P2883 -p****** -c -A oceanbase
     

   • 通过直连方式

     $mysql -h10.10.10.1 -uusername@obmysql -P2881 -p****** -c -A oceanbase
     

     参数说明：

     • -h：提供 OceanBase 数据库连接 IP，通常是一个 OBServer 节点的 IP 地址。

     • -u：提供租户的连接账户，格式为：用户名@租户名。使用 MySQL 客户端仅支持连接 MySQL 租户，MySQL 租户的管理员用户名默认是 root。

       注意

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

     • -P：提供 OceanBase 数据库连接端口，默认是 2881，在部署 OceanBase 数据库时可自定义。

     • -p：提供账户密码，为了安全可以不提供，改为在后面提示符下输入，密码文本不可见。

     • -c：表示在 MySQL 运行环境中不要忽略注释。

       说明

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

     • -A：表示在 MySQL 连接数据库时不自动获取统计信息。

     • oceanbase：访问的数据库的名称，可以更改为业务数据库。

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

     示例：

     $mysql -h10.10.10.1 -u******@obmysql -P2881 -p****** -c -A oceanbase
     

3. 连接成功后，默认会有命令行提示符。

   MySQL [oceanbase]> 
   

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

连接示例

通过 MySQL 客户端连接 OceanBase 数据库的 MySQL 租户。

$mysql -h10.10.10.1 -u******@obmysql#obdemo -P2883 -p****** -c -A oceanbase
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MySQL connection id is 5751
Server version: 5.6.25 OceanBase 4.0.0 (r10100032022041510-a09d3134c10665f03fd56d7f8bdd413b2b771977) (Built Apr 15 2022 02:16:22)
<...>
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

MySQL [oceanbase]> SHOW DATABASES;
+--------------------+
| Database           |
+--------------------+
| oceanbase          |
| information_schema |
| mysql              |
| test               |
+--------------------+
4 rows in set

MySQL [oceanbase]> exit
Bye

更多信息

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