Skip to content
BroadSQL BroadSQL
Why BroadSQL
Features Benefits Why is BroadSQL free? Who it's for
Evaluate
Compare License
Docs Articles
Downloads

What's New

  • What's new ?

Release Notes

  • All release notes
  • Release Notes 5.4.5
  • Release Notes 5.4.0
  • Release Notes 5.3.0
  • Release Notes 5.2.4
  • Release Notes 5.1.0

Getting Started

  • Getting started
  • Installation
  • Technical requirements
  • Application settings

Commands Reference

  • All commands

User Guide

  • User guide
  • Connections, Database Groups and Environments
  • Exploring a database
  • Interactive console & shortcuts
  • Patterns & List Sources
  • Command activity log
  • Glossary
  • AI and BroadSQL

Scripting

  • Scripting overview
  • Running Scripts
  • Variables
  • Arguments and parameters
  • Output and error handling
  • Nested Scripts and run lifecycle
  • Exporting Script results
  • Scripts Library
  • BroadSQL Editor
  • Examples

Import / Export

  • Import / Export overview
  • Exporting data
  • Files and spreadsheets
  • Local H2 datasets
  • Script and API results
  • Importing data

API Client

  • API Client overview
  • API sources and configuration
  • Running API requests
  • Parameters, variables and authentication
  • Working with API results
  • Examples and troubleshooting

Developers

  • JavaScript scripting
  • Extending BroadSQL
  • Third-party dependencies
  • Security
Documentation

Documentation

BroadSQL is a command-line workbench for every database you manage, and for the APIs in front of them. The documentation is organized by domain, in the order you usually need it.

Latest release: BroadSQL 5.4.5. What's new ? lists every change since then, and how to check it; the release notes keep the detailed record of every release.

What's new

What changed since the last published release, by area, with how to see it.

Release notes

What each published release shipped, newest first.

Getting started

Install BroadSQL, check the requirements, configure it, add your first connection and run your first query.

Commands reference

The exact syntax of every command, with its arguments, aliases and examples.

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, named arguments 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.

API Client

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

Developers

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

BroadSQL BroadSQL

A command-line workbench for every database you manage, and the APIs in front of them.

© UpAndCoding.com, 2008 to 2026

Product
  • Features
  • Benefits
  • Who it's for
  • Compare
  • Why is BroadSQL free?
  • License
Documentation
  • Documentation
  • Command reference
  • What's new ?
  • Release notes
Resources
  • Articles
  • Source code
  • Downloads
About us
  • Contact
  • Privacy