通过 OBClient 连接 OceanBase 租户

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

前提条件

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

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

连接操作

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

2. 连接数据库。

   支持通过 ODP 连接数据库或者直接连接数据库。

   • 通过 ODP 连接的方式

     obclient -h10.10.10.1 -uusername@obtenant#obdemo -P2883 -p****** -c -A oceanbase
     

     或者

     obclient -h10.10.10.1 -uobdemo:obtenant:username -P2883 -p****** -c -A oceanbase
     

     参数说明：

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

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

       说明

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

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

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

       说明

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

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

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

     示例如下：

     obclient -h10.10.10.1 -u*****@obtenant#obdemo -P2883 -p****** -c -A oceanbase
     

     或者

     obclient -h10.10.10.1 -uobdemo:obtenant:***** -P2883 -p****** -c -A oceanbase
     

   • 通过直连方式

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

     参数说明：

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

     • -u：提供租户的连接账户，格式：用户名@租户名。MySQL 租户的管理员用户名默认是 root。

       注意

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

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

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

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

       说明

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

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

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

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

     示例：

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

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

   obclient>
   

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

连接示例

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

$obclient -h10.10.10.1 -u******@obmysql#obdemo -P2883 -p****** -c -A sys
Welcome to the OceanBase.  Commands end with ; or \g.
Your OceanBase connection id is 3221684181
Server version: OceanBase 4.0.0.0 (r100000302022111120-7cef93737c5cd03331b5f29130c6e80ac950d33b) (Built Nov 11 2022 20:38:33)

Copyright (c) 2000, 2018, OceanBase and/or its affiliates. All rights reserved.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

obclient> SELECT SYSDATE() FROM dual;
+---------------------+
| SYSDATE()           |
+---------------------+
| 2022-09-28 16:18:18 |
+---------------------+
1 row in set

obclient> exit
Bye

相关文档

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