Documentation

BroadSQL is a command-line workbench for every database you manage, and for the APIs in front of them. Start from what you want to do.

Press / on any page to search. Paste an error message to find what it means.

LearnGet startedStart BroadSQL, try the WORLD sample, add your first connection: ten minutes. DoHow do I…Twenty short answers: compare environments, export to Excel, load a CSV, run a Script by name. Look upCommand referenceThe exact syntax of every command, its arguments and examples, the syntax shortcuts and a cheat sheet. FixTroubleshootingProblems by symptom, and BroadSQL's error messages with what to do. UpgradeUpgrading BroadSQLWhat changed since your release, and who it affects. Latest release: BroadSQL 5.5.0. ConnectConnect to your databasePostgreSQL, Oracle, SQL Server, MySQL, MariaDB, Db2, SQLite, H2: driver, URL and first test.

Guides

User guide

Everyday work at the prompt: connections and environments, exploring a database, the console, list sources and the activity log.

Scripting

Reusable SQL automation: Scripts with variables, typed parameters and error control, the Scripts Library and the Editor.

Import / Export

Move data between databases, files, spreadsheets and local H2 datasets, and load CSV files into tables.

Scripts Gallery

Ready-made Scripts to download: diagnostics, data checks and a reconciliation routine.

API Client Experimental

Call the HTTP APIs in front of your databases from the same prompt, and keep their results.

Developers

JavaScript scripting (experimental), custom commands, bundled libraries and how credentials are protected.

Releases

The latest published release is BroadSQL 5.5.0. Upgrading BroadSQL says what each change since your release means for you, and the release notes keep the record of each release.

What "experimental" means

An experimental feature may change significantly in a later release, and its long-term compatibility is not guaranteed yet: do not assume that what you configure or script with it today will work unchanged later. The Universal API Client and JavaScript scripting are marked experimental.

Found something wrong or unclear on this page? Tell us, with the page address.