BroadSQLUser guide
- Getting started
- Technical requirements: supported databases, adding a JDBC driver and database type, and behavior that differs by database
- Application settings: the
BroadSQL.ini/broadsqlux.inifile, every setting it supports - Export: copy query results into H2, spreadsheets or flat files with PULL, EXPORT and DUMP
- Import: preview, validate and insert CSV data with LOAD
- Scripts and the Scripts Library: Scripts (text files of SQL and BroadSQL commands), the Scripts Library, running them with
@andLIB RUN, and browsing, searching, editing and archive-based delete with undo, with a shared metadata format and environment safeguards - Light scripting with JS: running a JavaScript file or one-line snippet (
JS RUN/JS EVAL) that can hold several database connections open at once and drive them with ordinary loops and conditionals, a lower-friction alternative to a custom command JAR - Command reference: every command, its arguments and examples (generated from the source code, always up to date)
- Patterns & List Sources: macro syntax usable inside any SQL query, list sources such as
<@csv:...>,<@excel:...>,<@last:...>, and<@clipboard>, and execution shortcuts such as@<file>,/, and/ <environment> - Command activity log: keep a per-connection, per-day trail of every command and its output
- AI and BroadSQL: BroadSQL's current position on AI, including what it does not send to an AI provider
- Extending BroadSQL with custom commands
Business case: importing data prepared in a spreadsheet
A business user prepares new records in Excel. Save the sheet as UTF-8 CSV with column headers, then follow Import to preview and insert the records with LOAD. Existing rows are not updated; inspect the target and validate the file before authorizing execution.