BroadSQLCommand reference
Every BroadSQL command: keyword, synonyms, and a one-line description. Generated from the source code at release time: click through for arguments, examples, and full notes.
Core commands
| Command | Synonyms | Description |
|---|---|---|
ADD CONNECTION |
ADD CO, ADDCO, AD CO, ADCO | Creates a new database connection |
ALL |
Displays all rows from a table | |
AUTOCOMMIT |
SHOW AUTOCOMMIT, SH AU, SHAU | Displays autocommit setting for the current connection |
CLS |
CLEAR | Clear screen |
CNT |
Displays result of a SELECT COUNT(*) for a table | |
CONFIG |
Displays the GUI for maintaining connections (Windows only) | |
CONNECT |
OPEN, CONN, CON | Opens a connection to a database |
DEL CONNECTION |
DEL CO, DELCO, DE CO, DECO | Deletes an existing database connection |
DESCR |
DESC, DESCRIBE | Describe the structure of the table |
DISCONNECT |
BYE, CLOSE | Closes the current connection |
DUMP |
Extract the full content of a table in a local file | |
EDIT CONNECTION |
ED CO, EDCO | Edit an existing database connection |
EXPORT |
EXP, EXTRACT, EXT | Turns export mode ON or OFF and, if ON, specifies the target file name. Supported formats: text files, CSV, MS Excel (XLSX), OpenDocument Spreadsheet (ODS), MS Access(MDB) |
HELP |
displays a list of supported command or help for a specified command | |
LIB DEL |
LI DE, LIDE | Delete a query in the library |
LIB LIST |
LI LI, LILI | Display list of files in the SQL library |
LIB RUN |
LI RU, LIRU | Executes a SQL query stored in the queries library |
LIB SHOW |
LI SH, LISH | Displays a SQL query from the library |
LINK TABLE |
LINKT | Create a link to a table from a remote database (not available for all databases) |
LOGOUT |
Prompts user for authentication | |
PING |
CHECK | Tests a database connection |
PRINT |
PRNT | Print text |
PULL |
Copies a query's current results into a table of an H2 database (AS H2), a tab of an Excel/ODS file (AS XLSX/AS ODS), or a whole flat file (AS CSV/AS TXT/AS JSON/AS MD/AS HTML). AS H2 reuses an existing connection by name, or creates and registers one automatically; MODE OVERWRITE (the default) drops and recreates the table each run, MODE APPEND KEY(<column>) only inserts rows newer than the target's current maximum key value (MODE MERGE not implemented yet). AS XLSX/AS ODS always erase and replace the named tab, leaving every other tab in the file untouched, and keep a 'QUERIES' info tab listing each tab's query, date, source connection, and row count. Every flat-file format (CSV/TXT/JSON/MD/HTML) always fully overwrites the whole file - no MODE clause, no per-file metadata, since a flat file has no second tab to hold it; AS CSV uses CsvSeparator from the INI file (semicolon if absent), AS TXT always uses a tab (neither honors SET SEP); AS JSON writes a single array of objects (numbers written exactly, ISO-8601 dates); AS MD writes a GitHub-Flavored-Markdown table; AS HTML writes a standalone <table> fragment meant to be pasted into an email/wiki page. This whole command is the recommended, unified replacement for EXPORT/DUMP's file output for a one-shot query/table extraction (EXPORT/DUMP remain fully supported, unchanged). | |
SET AUTOCOMMIT |
SE AU | Turns autocommit ON or OFF |
SET LIST |
SELI | Sets the display mode of query resuls: OFF=tab view (default), ON=form view |
SET MASTER PASSWORD |
SET MAPA | Change master password for Connections Definition File |
SET PASSWORD |
SE PA | change password of the current connection |
SET SCHEMA |
SE SC, SESC | Select a different schema |
SET SEPARATOR |
SEPARATOR, SEP, SET SEP | Specifies a columns separator for export to text files (default is pipe) |
SHOW ALL CONNECTIONS |
SH ALL CO, SH AL CO, SHALLCO, SHALCO | Displays list of all database connections in the CDF file |
SHOW CATALOGS |
SH CA, SHCA | Displays a list of catalogs in the current database |
SHOW COLUMN |
SH COL, SHCOL | Show tables having a column name that contain the input text |
SHOW CONNECTION |
SH CO, SHCO | Show details about a specified connection |
SHOW DBINFOS |
SH DBIN, SHDBIN | Displays current database properties |
SHOW DRIVERS |
SH DR, SHDR | List available JDBC drivers |
SHOW INSTANCES |
SH IN, SHIN | Show all instances for a given platform |
SHOW PK |
SHOW PRIMARY KEYS, SH PK, SHPK | Shows the primary keys for a given table name |
SHOW QUERY |
SH QU, SHQU | Display the current SQL query stored in memory |
SHOW SCHEMAS |
SH SC, SHSC | Displays a list of schemas in the current database |
SHOW TABLES |
SH TA, SHTA | Display all tables which schema and name match the entered pattern |
SHOW VIEWS |
SH VI, SHVI | Display all views which schema and name match the entered pattern |
VERSION |
VERS | Display current version of BroadSQL |