Special Commands
pgxcli supports PostgreSQL-style backslash commands. Type them directly at the prompt.
Session Commands
These control your session:
| Command | Description |
|---|---|
\q, \quit, \exit | Quit pgxcli (case-insensitive) |
\c <database> | Switch to a different database on the same server |
\connect <database> | Same as \c |
\conninfo | Show current connection details (database, user, host, port) |
Switching Databases
\c other_db
pgxcli closes the current connection and opens a new one to other_db. The server, user, and port stay the same.
Connection Info
\conninfo
Outputs something like:
You are connected to database "mydb" as user "postgres" on Host "localhost" at port 5432
Catalog Commands
These come from the pgxspecial library and work like their psql equivalents. pgxcli provides autocompletion for these meta commands to help you discover them quickly:
| Command | Description |
|---|---|
\d [pattern] | Describe a table, view, or other object |
\dt [pattern] | List tables |
\dv [pattern] | List views |
\di [pattern] | List indexes |
\ds [pattern] | List sequences |
\df [pattern] | List functions |
\l | List all databases |
\dn | List schemas |
\du | List roles |
\dx | List installed extensions |
Commands with [pattern] accept an optional filter. For example, \dt public.* lists only tables in the public schema.
Change the Working Directory
Use \cd to change the working directory used for local paths:
\cd migrations
\cd ../sql
\cd "directory with spaces"
Running \cd without a directory changes to your home directory. Paths may be absolute, relative to the current working directory, or start with ~ to refer to your home directory.
Press Tab after \cd to complete directory names. Hidden directories are suggested when the name being completed starts with ..
Built-in Commands
These are pgxcli-specific:
| Command | Description |
|---|---|
\clear, /clear |
SQL Execution
Anything that isn't a special command is treated as SQL and sent to the database.
