OBClient 内部命令参考

更新时间：2026-06-30 18:11:26

本文档提供 OBClient 命令行客户端所有内部命令的完整参考。这些命令可以在 OBClient 交互式会话中使用。

命令说明

还有一些可以在客户端内运行的命令。请注意，所有文本命令必须位于行的开头并以分号（;）结尾。

命令列表

命令	描述
`?, \?`	`help` 的同义词。
`clear, \c`	清除当前输入语句。
`connect, \r`	重新连接到服务器。可选参数是 db 和 host。
`conn`	`connect` 的别名，兼容 Oracle SQL*Plus。
`delimiter, \d`	设置语句分隔符。
`edit, \e`	使用 $EDITOR 编辑命令。
`ego, \G`	将命令发送到 OceanBase 服务器，垂直显示结果。
`exit, \q`	退出 obclient。与 quit 相同。
`go, \g`	将命令发送到 OceanBase 服务器。
`help, \h`	显示此帮助。
`nopager, \n`	禁用分页器，打印到 stdout。
`notee, \t`	不写入输出文件。
`pager, \P`	设置 PAGER [to_pager]。通过 PAGER 打印查询结果。
`print, \p`	打印当前命令。
`prompt, \R`	更改您的 obclient 提示符。
`quit, \q`	退出 obclient。
`rehash, #`	重建补全哈希。
`source, .`	执行 SQL 脚本文件。将文件名作为参数。
`status, \s`	从服务器获取状态信息。
`system, \!`	执行系统 shell 命令。仅在类 Unix 系统上工作。
`tee, \T`	设置输出文件 [to_outfile]。将所有内容追加到给定的输出文件。
`use, \u`	使用另一个数据库。将数据库名称作为参数。
`charset, \C`	切换到另一个字符集。处理多字节字符集的 binlog 时可能需要。
`warnings, \W`	在每个语句后显示警告。
`nowarning, \w`	不在每个语句后显示警告。

常用命令示例

help, \h, ?

显示帮助信息：

obclient> help;
obclient> \h;
obclient> ?;

clear, \c

清除当前输入语句：

obclient> SELECT * FROM users
    -> \c
obclient>

connect, \r, conn

重新连接到服务器：

obclient> connect;
obclient> \r;
obclient> conn testdb@localhost;

delimiter, \d

设置语句分隔符：

obclient> delimiter //
obclient> CREATE FUNCTION test() RETURNS INT
    -> BEGIN
    ->   RETURN 1;
    -> END
    -> //
obclient> delimiter ;

ego, \G

垂直显示查询结果：

obclient> SELECT * FROM users WHERE id = 1\G
*************************** 1. row ***************************
     id: 1
  name: Alice
email: alice@example.com

use, \u

切换到另一个数据库：

obclient> use testdb;
obclient> \u testdb;

source, .

执行 SQL 脚本文件：

obclient> source /path/to/script.sql;
obclient> . /path/to/script.sql;

status, \s

显示服务器状态信息：

obclient> status;
obclient> \s;

tee, \T 和 notee, \t

将所有输出追加到文件：

obclient> tee /path/to/output.log;
obclient> SELECT * FROM users;
obclient> notee;

设置分页器：

obclient> pager less;
obclient> SELECT * FROM large_table;
obclient> nopager;

prompt, \R

更改提示符：

obclient> prompt \u@\h [\d]>\_
root@localhost [testdb]>

prompt 命令特殊序列

prompt 命令重新配置默认提示符 \N [\d]>。用于定义提示符的字符串可以包含以下特殊序列：

选项	描述
`\c`	一个计数器，对您发出的每个语句递增。
`\D`	完整的当前日期。
`\d`	默认数据库。
`\h`	服务器主机。
`\l`	当前分隔符。
`\m`	当前时间的分钟。
`\n`	换行符。
`\O`	当前月份，三个字母格式（Jan, Feb, ...）。
`\o`	当前月份，数字格式。
`\P`	am/pm。
`\p`	当前 TCP/IP 端口或套接字文件。
`\R`	当前时间，24 小时制（0–23）。
`\r`	当前时间，标准 12 小时制（1–12）。
`\S`	分号。
`\s`	当前时间的秒。
`\t`	制表符。
`\U`	您的完整 user_name@host_name 帐户名。
`\u`	您的用户名。
`\v`	服务器版本。
`\w`	当前星期几，三个字母格式（Mon, Tue, ...）。
`\Y`	当前年份，四位数。
`\y`	当前年份，两位数。
`_`	空格。
`\`	空格（反斜杠后跟空格）。
`'`	单引号。
`"`	双引号。
`\\`	字面""反斜杠字符。
`\x`	x，对于上面未列出的任何"x"。