On this page

Release Notes 5.6.0

Published November 22, 2026

New features

  • A startup option BroadSQL does not know now stops it with a message naming it, instead of being ignored: a mistyped option can no longer start BroadSQL in a different mode than the one asked for
  • An installation whose starting script is older than its program file is now refused with a message naming the script to replace, instead of starting in a way nobody asked for
  • ShaWeR, the free shared web runtime, has a download of its own on broadsql.com: using an extension that needs it no longer means downloading BroadSQL Desk, which needs a licence
  • Each person signed in to BroadSQL Desk now has their own Recent, Kept, History and Exports, kept between sessions and after a restart; nobody sees or can reach another person's blocks or exports, and the Scripts Library stays shared by everybody
  • The BroadSQL Desk title in the header is a link to the Desk documentation
  • The sign-in page is a BroadSQL page headed "Sign in to BroadSQL <Instance ID>", in the website's own identity, with links to the public documentation; ShaWeR is no longer presented as the product people sign in to
  • A browser that asks for an application it is not signed in to goes straight to the sign-in page and straight back to that application; the intermediate page saying that a sign-in was needed and the list of applications in the way are gone
  • BroadSQL Desk shows the user the browser session was opened with, and has a Sign out button that ends the session on the server, so another tab of the same browser cannot keep using it
  • An optional Remember me box on the sign-in form, off by default, lets a browser be closed and reopened without signing in again for ShawerRememberDays days (14 by default, 0 to remove it); the password and the two-factor code stay required, the limit is absolute, and signing out or SHAWER SESSIONS REVOKE forgets it
  • BroadSQL runs unattended on Linux as a systemd service: ./broadsql.sh --service, the master password handed to it by systemd from a root-owned file, the unit template and an installation script in the Linux package, and ServiceStartupCommands choosing what it starts
  • An official extension declares the BroadSQL releases it supports in its own manifest, as a release, a range or a release and everything after it, and that declaration is the only one BroadSQL reads; no compatibility file ships in a distribution any more
  • The web address of ShaWeR and Desk holds the installation's own Instance ID instead of a random part, so it is the same after a restart and a bookmark keeps working
  • ShawerPublicUrl and ShawerTrustedProxies let a reverse proxy such as Nginx serve ShaWeR and Desk at a stable public address with a normal browser sign-in; off by default, and the listener still binds to 127.0.0.1 only
  • The settings file is conf/broadsql.ini on Windows and on Linux; on Linux an installation with only broadsqlux.ini keeps working from it and BroadSQL asks to rename it; VERSION shows the settings file read
  • jlinehistoryfile is history by default, the file history of the installation folder; an empty value designates the installation folder itself, which BroadSQL reports, keeping the history for the session only
  • PURGE CONNECTION, PURGE GROUP and PURGE ENVIRONMENT delete an inactive record from the CDF for good, after a confirmation, without a connection
  • SHOW EXTENSIONS lists the installed extension JARs, loaded or not, with their version, status and licence status
  • SHOW ALL ENVIRONMENTS shows whether each Environment is active; SHOW EXTENSION ERRORS is listed under Extensions in HELP
  • SHOW CONNECTION shows the connection in a two column table (field and value) with one space on each side of every separator; a URL longer than the terminal continues on the following lines of its row, so the separators stay aligned and no character is cut
  • LIB LINT lists its findings in a table of FILE, ERROR TYPE and MESSAGE, without the prompt on every line; a group of duplicate Scripts keeps every file name
  • SHOW ACTIVE CONNECTIONS is another name of SHOW ALL CONNECTIONS
  • SHOW ENVIRONMENTS is the name of the command that lists the Environments of the current connection's Database Group, SHOW ENV its short form; SHOW GROUP and the other former names keep working
  • HELP lists EDITOR with the Scripts commands (HELP SCRIPTS) and LOGOUT with the session commands (HELP SESSION)
  • The Alt+D shortcut (delete the next word) is removed; Ctrl+Delete deletes the next word and Ctrl+Backspace the previous one
  • A text script argument written without quotes (continent=Asia) is refused with the way to write it, and a database error caused by a text inserted without quotes is followed by a hint naming the variable
  • A relative jlinehistoryfile or scripthistoryvault is relative to the installation folder, as every path setting, instead of .broadsql in the home folder; empty, they keep their per-user default; a history left at its former place is reported at startup and never moved
  • On Windows, BroadSQL.bat (or connect.bat) is the recommended way to start BroadSQL: it needs neither PowerShell nor administrator rights; in PowerShell type .\BroadSQL.bat; BroadSQL.ps1 stays optional and runs only where the PowerShell execution policy allows scripts; an installation folder whose path holds a semicolon, from which Java cannot start, is explained by BroadSQL.bat
  • Session activity logs are named after the LogFileNamePattern, the start date and time and a Log ID (BROADSQL_20261028_100708_WWQP3HGCG4.log; the shipped LogFileNamePattern is now BROADSQL instead of CONSOLE), the Log ID being 10 random upper case Base32 characters (A to Z, 2 to 7), instead of _SESSION_ and the 36-character Session ID; the Session ID stays in the header; a new file never replaces an existing one; SHOW SESSIONS shows the Log ID and finds a session by it; files of earlier releases are still listed and retained
  • EDITOR is the name of the command that opens the BroadSQL Editor; EDIT, ED and SCRIPT EDITOR remain as aliases, with the same arguments; TAB completes a Script of the Scripts Library after each of them
  • New setting LicencesPath: the folder of installed licence files, such as the licence of an optional extension (a folder, never a file name; each licence keeps its own name in it); empty, the default, is the conf folder where BroadSQL.ini is; an absolute path is used as given, a relative one is relative to the installation folder, and no other folder is ever searched
  • The website documentation has an Extensions menu, after Commands: the catalog of BroadSQL extensions and the pages of BroadSQL Desk (overview, getting started, the DESK command, download, compatibility, licence)
  • Java is included: BroadSQL is published as two self-contained packages, one ZIP for Windows x64 and one for Linux x64, each with the Java runtime of its own system (Eclipse Temurin 21, exactly the same version in both, in the runtime folder); the launchers always use it, whatever Java, JAVA_HOME or PATH the computer has, so you do not install Java on Windows or on Linux; Windows x64 and Linux x64 are the supported systems
  • SHOW DRIVERS names the source of a driver you supplied External (Bundled for those distributed with BroadSQL) instead of drivers folder
  • CONFIG lists each connection's database type (DB Type) instead of its status, read from the saved connection without connecting
  • BroadSQL Editor: Favorite Scripts; Add to Favorites from a Script's context menu or File > Favorite, a Favorites view listing them by the moment they were added, newest first, kept across restarts and following renamed or moved Scripts
  • HELP lists the commands of an extension JAR under Extension Commands; HELP EXT lists them alone
  • An extension JAR may declare BroadSQL-Extension-Packages (only those commands are loaded), and BroadSQL-Extension-Id with BroadSQL-Supported-Versions (the BroadSQL releases it was tested with; with any other release it is refused at startup, the supported releases named)
  • SHOW EXTENSION ERRORS says when an extension JAR is damaged, or not on BroadSQL's classpath because it is outside the extensions folder
  • LIB LINT warns when a TEXT, DATE or TIMESTAMP parameter is written without quotes in a SQL statement

Problems solved

  • BroadSQL as a Linux service now starts: the --service option was discarded by the startup command line, so the service asked for the master password at a terminal it does not have and stopped
  • The scripts that start BroadSQL now hand every option to BroadSQL exactly as it was typed, instead of reading the first argument as the name of a connection whatever it was: that is what stopped the Linux service option from reaching BroadSQL, and what let a mistyped option start the console instead of being refused
  • Installing BroadSQL as a Linux service no longer takes the installation away from the account that installed it: the installer keeps every owner and gives the service account write access to conf, logs and shawer only
  • The Sample databases page now gives the script path that works: @./samples/sql/cinema-hsqldb.sql, counted from the installation folder, instead of a reference BroadSQL looked for in the Scripts Library
  • The documentation link in BroadSQL Desk's header now opens the Desk page instead of answering not found
  • A ShaWeR setting that is invalid or deprecated is reported again when DESK starts it, as a warning, instead of being silently replaced by its default; the advice that goes with a working configuration stays out of the concise DESK output
  • Closing a SQLite connection while Autocommit is ON no longer fails with "database in auto-commit mode": DISCONNECT, CONNECT elsewhere, LOGOUT and EXIT now close it cleanly
  • Starting BroadSQL Desk with DESK no longer prints ShaWeR's own start messages about HTTPS and about there being no ShaWeR user yet; SHAWER START and SHAWER STATUS still give them in full
  • The Sample databases page now describes what the installation really contains: the WORLD database, ready to open, and the SQL that builds the CINEMA and LIBRARY samples
  • The commands typed at the BroadSQL console are no longer put into the Recent of the people signed in to BroadSQL Desk
  • BroadSQL Desk can now reach a connection that belongs to no Database Group, through a "No Database Group" entry of the connection chooser
  • The internal $CDF configuration database is no longer offered in the BroadSQL Desk connection chooser, and is refused by the server rather than merely hidden
  • DUMP / and PULL / export the data of the connection that is active now: after CONNECT or an Environment switch the remembered query runs again there instead of the rows still held in memory being written, which exported the previous database's data into the new file; the rows held are never a fallback, an error on the new connection is reported and nothing is written
  • The License page states that BroadSQL itself never needs a licence and that extensions, such as BroadSQL Desk, may require a licence, free or not
  • Technical requirements says how the Java heap can be changed: the Linux launcher reads BROADSQL_JAVA_OPTS, Windows has no such variable, and the heap maximum is still not presented as a required amount of physical RAM
  • In CDF maintenance, an ordinary query holding a quoted value such as SELECT * FROM CONNECTIONS WHERE ID = 'FIXER' is kept in the command history; only a line naming a secret column or table of the CDF is left out
  • SQL statements typed in CDF maintenance are kept in the command history, except a line that holds a quoted value or names a secret; answers to questions are no longer kept
  • On Linux and over SSH, Left, Right, Home, End, Insert and Delete never type fragments such as [F or [D into the line, whatever form the terminal sends
  • DELETE GROUP is another name of DEL GROUP: it was sent to the open connection as SQL
  • ADD CONNECTION no longer lists every database type whose driver is missing; it names the missing driver of the type chosen only
  • After CNT or ALL, / and REPEAT / run that count or that listing again, not the query typed before
  • Every folder or file setting of BroadSQL.ini (ScriptsLibrary, DefaultFolder, JsScripts, CustomExtensionsFolder, LogFolderName, ServersFileName, jlinehistoryfile, scripthistoryvault, LicencesPath) accepts a Windows path written with single backslashes, as well as doubled ones; a single backslash used to disappear (C:\DevEnv\scripts was read as C:DevEnvscripts) and a folder such as C:\users could stop BroadSQL from starting; other settings keep the properties meaning of a backslash
  • DUMP / and DUMP / OPEN export every row of the previous result: MaxRowsOnScreen limits only the display; a result cut at that limit is exported by running its read-only query again on the same connection, without any message about MaxRowsOnScreen; a query that can change data, or a result of another connection, is refused and nothing is written
  • Ctrl+Backspace and Ctrl+Delete delete the whole word before and after the cursor in the console, in the Windows console (Command Prompt, PowerShell, Windows Terminal) as in Linux terminals; they used to delete one character in the Windows console, and Ctrl+Delete cleared the line in Linux terminals
  • The Script history of the BroadSQL Editor and the LIB commands is written by one writer at a time; a LIB DEL and an Editor save at the same moment can no longer lose a history entry

Installing BroadSQL 5.6.0

See Installation.

Upgrading from previous releases

  • The single ZIP for every system, which needed Java 21 on the computer, is no longer published: download the ZIP of your system, unzip it into a new folder and copy your conf, drivers, extensions, scripts and jsscripts folders into it (never the runtime folder); a Java installed only for BroadSQL can then be removed

Known issues

None known at release time.

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