通过 OBClient 连接数据库

更新时间：2024-08-01 18:41:06

OBClient 是一个交互式和批处理查询工具，通过 OBClient 您可以连接 OceanBase 数据库的 MySQL 和 Oracle 租户。

前提条件

请确认已下载并安装了 OBClient 应用。如果未下载 OBClient 应用，您可以单击以下链接下载使用：

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

操作步骤

打开一个命令行终端。
连接数据库。

支持通过 OBProxy 连接数据库或者直接连接数据库。
- 通过 OBProxy 连接的方式
```
obclient -h10.10.10.1 -uusername@obtenant#obdemo -P2883 -ppassword -c -A oceanbase
```
  或者
```
obclient -h10.10.10.1 -uobdemo:obtenant:username -P2883 -ppassword -c -A oceanbase
```
  参数说明：
  - -h：提供 OceanBase 数据库连接 IP，通常是一个 OBProxy 地址。
  - -u：提供租户的连接账户，格式有两种：用户名@租户名#集群名 或者 集群名:租户名:用户名。MySQL 租户的管理员用户名默认是 root，Oracle 租户的管理员用户名默认是 sys。
  - -P：提供 OceanBase 数据库连接端口，也是 OBProxy 的监听端口，默认是 2883，可以自定义。
  - -c：表示在 MySQL 运行环境中不要忽略注释。
  - -A：表示在 MySQL 连接数据库时不自动获取统计信息。
  - 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 -ppassword -c -A oceanbase
```
  参数说明：
  - -h：提供 OceanBase 数据库连接IP，通常是一个 OBServer 的 IP 地址。
  - -u：提供租户的连接账户，格式：用户名@租户名。MySQL 租户的管理员用户名默认是 root，Oracle 租户的管理员用户名默认是 sys。
  - -P：提供 OceanBase 数据库连接端口，默认是 2881，可以自定义。
  - -p：提供账户密码，为了安全可以不提供，改为在后面提示符下输入，密码文本不可见。
  - -c：表示在 MySQL 运行环境中不要忽略注释。
  - -A：表示在 MySQL 连接数据库时不自动获取统计信息。
  - oceanbase：访问的数据库的名称，可以更改为业务数据库。
  - 普通租户通过直连方式连接时，需要确保该租户的资源分布在该 OBServer上，如果该租户的资源未分布在该 OBServer 上，则无法通过直连该 OBServer 连接到该租户。
  示例：
```
obclient -h10.10.10.1 -u******@obtenant -P2881 -p****** -c -A oceanbase
```
连接成功后，默认会有如下命令行提示符。
```
obclient>
```
如果需要退出 OBClient 命令行，输入 exit 后回车，或者按快捷键 Ctrl + D 。

示例

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

$obclient -h10.10.10.1 -u******@obmysql#obdemo -P2883 -p****** -c -A
Welcome to the OceanBase monitor.  Commands end with ; or \g.
Your OceanBase connection id is 127778
Server version: 5.6.25 OceanBase 3.2.0 (...) (Built Jun 19 2021 11:36:47)

<省略>

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

obclient> SELECT SYSDATE() FROM dual;
+---------------------+
| SYSDATE()           |
+---------------------+
| 2021-06-29 15:31:50 |
+---------------------+
1 row in set (0.01 sec)

obclient> exit
Bye

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

$obclient -h10.10.10.1 -u******@t_oracle0_91#obdoc -P2883 -p****** -c -A sys
Welcome to the OceanBase monitor.  Commands end with ; or \g.
Your OceanBase connection id is 3221576024
Server version: 5.7.25 OceanBase 3.2.0 (...)  (Built Jun 18 2021 15:39:59)

<省略>

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

obclient> SELECT SYSDATE FROM dual;
+-----------+
| SYSDATE   |
+-----------+
| 29-JUN-21 |
+-----------+
1 row in set (0.00 sec)

obclient> exit
Bye