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 |
COMPARE TABLE STRUCTURE |
CM TA ST, CMTAST |
Compares the column structure of a table between the current connection and another connection |
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) |
FIND COLUMN |
FI COL, FICOL, SHOW COLUMN, SH COL, SHCOL |
Show tables having a column name that contain the input text |
FIX INSTANCE ENVIRONMENT SWAP |
FIX IE, FIXIE |
One-time fix: swaps CONNECTIONS.INSTANCE_ID/ENVIRONMENT_ID and the INSTANCE/ENVIRONMENT reference tables, correcting a long-standing data inversion. Takes a backup first. Run once per CDF only. |
HELP |
|
displays a list of supported command or help for a specified command |
JS EVAL |
JS EV, JSEV |
Runs a short piece of JavaScript typed directly on the command line |
JS FIND |
JS FI, JSFI |
Full-text, case-insensitive search across the whole JS scripts catalog (content, not just file names), regardless of instance or environment |
JS LIST |
JS LI, JSLI |
Display list of files in the JS scripts catalog, scoped to the current connection's instance and environment by default |
JS RUN |
JS RU, JSRU |
Runs a saved .js script from the JS scripts catalog, optionally passing positional arguments |
LIB DEL |
LI DE, LIDE |
Archives (soft-deletes) a query in the library, after confirmation; see LIB UNDO / LIB RESTORE |
LIB EDIT |
LI ED, LIED |
Opens a library entry in Notepad for editing, and saves it back on close; pre-fills a metadata skeleton for a new entry |
LIB FIND |
LI FI, LIFI |
Full-text, case-insensitive search across the whole SQL library (content, not just file names), regardless of instance or environment |
LIB LINT |
LI LN, LILN |
Checks the SQL library for consistency issues: non-contiguous %N parameters, unknown @instance/@environment ids, duplicate @alias values |
LIB LIST |
LI LI, LILI |
Display list of files in the SQL library, scoped to the current connection's instance and environment by default |
LIB RESTORE |
LI RS, LIRS |
Restores a specific archived (LIB DEL) library entry |
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 |
LIB UNDO |
LI UN, LIUN |
Restores the most recently archived (LIB DEL) library entry |
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 - the source query may use JOIN, but BroadSQL cannot always verify an outer join's key is never NULL, so add FORCE to proceed past that check when needed (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). |
REACTIVATE CONNECTION |
REACT CO, REACO |
Reactivates an inactive database connection |
SCRIPT DEL |
SC DE, SCDE |
Archives (soft-deletes) a script in the scripts catalog, after confirmation; see SCRIPT UNDO / SCRIPT RESTORE |
SCRIPT EDIT |
SC ED, SCED |
Opens a scripts catalog entry in Notepad for editing, and saves it back on close; pre-fills a metadata skeleton for a new entry |
SCRIPT FIND |
SC FI, SCFI |
Full-text, case-insensitive search across the whole scripts catalog (content, not just file names), regardless of instance or environment |
SCRIPT LINT |
SC LN, SCLN |
Checks the scripts catalog for consistency issues: unknown @instance/@environment ids, duplicate @alias values |
SCRIPT LIST |
SC LI, SCLI |
Display list of files in the scripts catalog, scoped to the current connection's instance and environment by default |
SCRIPT RESTORE |
SC RS, SCRS |
Restores a specific archived (SCRIPT DEL) scripts catalog entry |
SCRIPT RUN |
SC RU, SCRU |
Runs a saved script from the scripts catalog: sugar for @<resolved path>, no %N parameter substitution |
SCRIPT SHOW |
SC SH, SCSH |
Displays a script from the scripts catalog |
SCRIPT UNDO |
SC UN, SCUN |
Restores the most recently archived (SCRIPT DEL) scripts catalog entry |
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 ALL ENVIRONMENTS |
SHALENV, SHOW ALL ENVTS |
Show the globally configured Environments |
SHOW ALL GROUPS |
SHALGR |
Show all configured Database Groups |
SHOW CATALOGS |
SH CA, SHCA |
Displays a list of catalogs in the current database |
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 GROUP |
SHOW ENVIRONMENTS, SH ENV, SHENV, SHOW ENVTS |
Show all environments for a given Database Group |
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 |
BroadSQL