Features
Every BroadSQL feature, grouped by theme. For arguments and examples, follow a link into the command reference.
Connectivity
| Feature | Description |
|---|---|
| Multi-database support | Connect 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 environments | Group 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 / DISCONNECT | Open or close a connection, tested before switching so a bad URL or password is reported immediately. |
| ADD CONNECTION, EDIT CONNECTION, DEL CONNECTION | Manage connections from the command line, on any platform. |
| REACTIVATE CONNECTION | Bring a deactivated connection back to active, unchanged otherwise, by its ID. |
| COMPARE TABLE STRUCTURE | Compare a table's column structure between the current connection and another registered connection: types, sizes, nullability, and columns present on only one side. |
| CONFIG | A graphical connections manager (Windows only), with separate active and inactive connection views. |
| PING | Test a connection without opening it. |
Querying and browsing
| Feature | Description |
|---|---|
| Plain SQL passthrough | Anything 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 VIEWS | List tables or views matching a pattern. |
| DESCR | Show a table's column structure. |
| SHOW SCHEMAS / SHOW CATALOGS | List schemas or catalogs on the current connection. |
| FIND COLUMN | Find every table that has a column matching a name pattern (also available as SHOW COLUMN). |
| SHOW PK | Show a table's primary key columns. |
| ALL / CNT | Shortcut for SELECT * / SELECT COUNT(*) on a table. |
| SET LIST | Switch 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
| Feature | Description |
|---|---|
| PULL | Copy 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. |
| EXPORT | Toggle exporting every subsequent query's output to a file (XLSX, ODS, CSV, TXT, or legacy MDB). |
| DUMP | One-shot export of an entire table to a file. |
| BATCHLOAD | Load a CSV file into a table using batches of queries, for large files. |
| LOAD | Load a CSV file into a table one query at a time. |
| LINK TABLE | Create a linked table to a remote database (H2 targets only). |
Automation and scripting
| Feature | Description |
|---|---|
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 scripts | Commands that run automatically every time a given connection is opened. |
| SET AUTOCOMMIT | Toggle autocommit for the current connection. |
| SET SEPARATOR | Set 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 LINT | Save, 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 LINT | The 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 FIND | Run 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
| Feature | Description |
|---|---|
| Custom commands | Add 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 database | Not 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
| Feature | Description |
|---|---|
| Command activity log | A per-connection, per-day text trail of every command and its output, independent of BroadSQL's own internal application log. |
| SHOW DBINFO | Summarize the current database (name, version, driver). |
| SHOW DRIVERS | List every JDBC driver actually available in this installation, bundled or not. |
| SHOW GROUP | Show all environments defined for a given Database Group (also available as SHOW ENVIRONMENTS). |
| SHOW ALL GROUPS / SHOW ALL ENVIRONMENTS | List every Database Group, or every Environment, registered in the CDF. |
| SHOW ALL CONNECTIONS / SHOW CONNECTION | List every connection in the CDF, or show one connection's details. |
| SET MASTER PASSWORD / SET PASSWORD | Change the CDF's master password, or a single connection's password. |
Platforms
| Feature | Description |
|---|---|
| Windows | Primary, fully supported platform, including the graphical CONFIG connections manager. |
| Linux | Also supported, command-line only. See Installation for the one setup step it needs that Windows doesn't. |
BroadSQL