| tenant-type |

| tenant-type | | slug | obclient-interactive-commands-reference |

This topic provides a complete reference for all internal commands of the OBClient command-line client. These commands can be used in interactive OBClient sessions.

Command description

There are also some commands that can be run within the client. Note that all text commands must start at the beginning of a line and end with a semicolon (;).

Command list

Examples of common commands

help, \h, ?

Displays help information:

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

clear, \c

Clears the current input statement:

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

connect, \r, conn

Reconnects to the server:

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

delimiter, \d

Sets the statement delimiter:

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

ego, \G

Displays query results vertically:

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

use, \u

Switches to another database:

obclient> use testdb;
obclient> \u testdb;

source, .

Execute an SQL script file:

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

status, \s

Display server status information:

obclient> status;
obclient> \s;

tee, \T and notee, \t

Append all output to a file:

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

pager, \P and nopager, \n

Set the pager:

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

prompt, \R

Change the prompt:

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

Special sequences in the prompt command

The prompt command allows you to change the default prompt \N [\d]>. The string used to define the prompt can contain the following special sequences: