Features

Every BroadSQL feature, grouped by theme. For arguments and examples, follow a link into the command reference.

Connectivity

FeatureDescription
Multi-database supportConnect to H2, PostgreSQL, Apache Derby, HSQLDB, and SQLite out of the box, or any other JDBC-compatible database by adding its driver. See Technical requirements.
Encrypted connections vault (CDF)Every connection's URL and credentials live in an AES-encrypted H2 database, unlocked by a single master password. See Security.
Database Groups and environmentsGroup connections by product/system (e.g. Wiki1/JIRA) and by deployment platform (DEV/QA/LIVE), independently of each other; environments also carry a Production flag. See Getting started.
CONNECT / DISCONNECTOpen or close a connection, tested before switching so a bad URL or password is reported immediately.
ADD CONNECTION, EDIT CONNECTION, DEL CONNECTIONManage connections from the command line, on any platform.
REACTIVATE CONNECTIONBring a deactivated connection back to active, unchanged otherwise, by its ID.
COMPARE TABLE STRUCTURECompare a table's column structure between the current connection and another registered connection: types, sizes, nullability, and columns present on only one side.
CONFIGA graphical connections manager (Windows only), with separate active and inactive connection views.
PINGTest a connection without opening it.

Querying and browsing

FeatureDescription
Plain SQL passthroughAnything BroadSQL doesn't recognize as one of its own commands is sent straight to the connected database as SQL, no special syntax needed.
SHOW TABLES / SHOW VIEWSList tables or views matching a pattern.
DESCRShow a table's column structure.
SHOW SCHEMAS / SHOW CATALOGSList schemas or catalogs on the current connection.
FIND COLUMNFind every table that has a column matching a name pattern (also available as SHOW COLUMN).
SHOW PKShow a table's primary key columns.
ALL / CNTShortcut for SELECT * / SELECT COUNT(*) on a table.
SET LISTSwitch result display between tabular and one-field-per-line form view.
/ (last-query shortcut)Re-run the last query, e.g. against a different connection after CONNECT.
EDIT (Windows only)With no argument, edit the last query in Notepad; closing Notepad replaces the last query with what was saved, without running it. With a file name, opens that file in Notepad instead.

Export and data movement

FeatureDescription
PULLCopy a query's results into a local H2 table, a spreadsheet tab, or a flat file (CSV, TXT, JSON, Markdown, HTML), all through one unified syntax, with MODE APPEND KEY(...) for incremental loads.
EXPORTToggle exporting every subsequent query's output to a file (XLSX, ODS, CSV, TXT, or legacy MDB).
DUMPOne-shot export of an entire table to a file.
BATCHLOADLoad a CSV file into a table using batches of queries, for large files.
LOADLoad a CSV file into a table one query at a time.
LINK TABLECreate a linked table to a remote database (H2 targets only).

Automation and scripting

FeatureDescription
Script files (@<file>)Run every command in a text file in sequence, as if typed one by one. A relative path resolves against the install folder, e.g. @scripts\file.sql.
File macro (<@file>)Expand to a comma-separated, quoted list read from a file, inline inside a query.
Login scriptsCommands that run automatically every time a given connection is opened.
SET AUTOCOMMITToggle autocommit for the current connection.
SET SEPARATORSet the column separator used by EXPORT/DUMP text output.
LIB SHOW, LIB RUN, LIB LIST, LIB FIND, LIB EDIT, LIB DEL, LIB UNDO, LIB RESTORE, LIB LINTSave, browse, search, and edit queries in a personal library. Each entry can carry a short metadata header (description, instance, environment, tags, an alias, a status), shown as a grid by LIB LIST/LIB FIND and used to scope the default view to the current connection's instance and environment. LIB DEL archives rather than deletes, recoverable with LIB UNDO/LIB RESTORE.
SCRIPT LIST, SCRIPT SHOW, SCRIPT RUN, SCRIPT FIND, SCRIPT EDIT, SCRIPT DEL, SCRIPT UNDO, SCRIPT RESTORE, SCRIPT LINTThe same catalog, metadata, and safe delete tooling as the SQL library above, applied to a separate folder of scripts (still runnable directly with @<file>).
JS RUN, JS EVAL, JS LIST, JS FINDRun a plain JavaScript file, or a one-line snippet typed directly on the command line, that can open several independent database connections at once and drive them with ordinary loops and conditionals: a lower-friction alternative to a custom command JAR for a short automation. See Light scripting with JS.

Extensibility

FeatureDescription
Custom commandsAdd your own commands from a plain JAR file in extensions/, with full access to the console, the current connection, and the command interpreter, no BroadSQL rebuild needed. See Extending BroadSQL.
Any JDBC databaseNot limited to the five bundled drivers: add any vendor's driver JAR and register its type to connect to it. See Technical requirements.

Administration and diagnostics

FeatureDescription
Command activity logA per-connection, per-day text trail of every command and its output, independent of BroadSQL's own internal application log.
SHOW DBINFOSummarize the current database (name, version, driver).
SHOW DRIVERSList every JDBC driver actually available in this installation, bundled or not.
SHOW GROUPShow all environments defined for a given Database Group (also available as SHOW ENVIRONMENTS).
SHOW ALL GROUPS / SHOW ALL ENVIRONMENTSList every Database Group, or every Environment, registered in the CDF.
SHOW ALL CONNECTIONS / SHOW CONNECTIONList every connection in the CDF, or show one connection's details.
SET MASTER PASSWORD / SET PASSWORDChange the CDF's master password, or a single connection's password.

Platforms

FeatureDescription
WindowsPrimary, fully supported platform, including the graphical CONFIG connections manager.
LinuxAlso supported, command-line only. See Installation for the one setup step it needs that Windows doesn't.