On this page

Desk

Overview

Desk runs BroadSQL commands and SQL in a web browser on your own computer: the same engine, the same connections and the same Production confirmations as the console, with results as grids and a journal of everything you run.

Desk is an extension by UpAndCoding. It is not part of the free BroadSQL distribution. It has no web server of its own: it is shown by ShaWeR, the free web runtime, which owns the address, the port and the sign-in. The Desk download includes ShaWeR.

Requirements

RequirementDetail
BroadSQL5.6.0, Windows x64 or Linux x64: the BroadSQL releases this Desk version supports. BroadSQL refuses to load Desk with any other release, and says which ones it supports. Desk runs in the Java included in BroadSQL.
ShaWeRRequired: Desk has no web server of its own, ShaWeR shows it. Any ShaWeR that provides Web API 1.1, not one particular ShaWeR version. The Desk download includes ShaWeR, as a separate extension: extensions/broadsql-shawer.jar.
LicenceA valid Desk licence key (see Licence).
BrowserChrome, Edge or Firefox, on the same computer as BroadSQL.

Each Desk version declares the BroadSQL releases it supports, and is loaded only by those. With any other release, BroadSQL starts without Desk and SHOW EXTENSION ERRORS; names the releases that Desk version supports. The table below is the declaration each published Desk version carries.

Desk releaseRelease dateBroadSQL versions it supports

Release publication is pending; no compatibility is published yet.

Installation

Latest version: 1.1.0.

Download BroadSQL-Desk-1.1.0.zip SHA-256 checksum

SHA-256: f0eb746c04d7cb71713a7a63912d7903674680c5e75a725123b3449591f4fe9f

The ZIP holds two separate extensions: extensions/broadsql-desk.jar (Desk) and extensions/broadsql-shawer.jar (ShaWeR).

  1. Close BroadSQL.
  2. Extract the ZIP into the BroadSQL installation folder. Both JAR files go to extensions/.
  3. Start BroadSQL and enter the master password.
  4. Check with SHOW EXTENSIONS;: Desk and ShaWeR are listed as Loaded, with their versions and licence status.

To update, close BroadSQL and extract the new ZIP over the old files. Your licence and settings are kept.

To uninstall, close BroadSQL and delete extensions/broadsql-desk.jar. Delete extensions/broadsql-shawer.jar too if no other extension uses ShaWeR. Your licence and settings stay in place.

Getting started

Install your licence key once:

DESK LICENCE INSTALL "C:\Users\me\Downloads\BroadSQL-Desk-DL-2026-7K3M9Q.licence";

Connect, then open Desk:

CONNECT WORLD;
DESK;

Use your own connection instead of WORLD, or connect later from Desk. DESK answers:

Starting BroadSQL Desk 1.0.0...
BroadSQL Desk 1.0.0 started.
BroadSQL Desk: http://127.0.0.1:8080/C6MVER39XDZS9KT7/launch?token=...
Licence DL-2026-CEWZ1K: valid until 2026-12-31 (inclusive).

The version and the address are those of your installation; the address holds the installation's Instance ID and stays the same when ShaWeR or BroadSQL restarts. If ShaWeR is not running, DESK starts it first: the port opens at that moment, and SHAWER STATUS; shows its details. Your browser opens Desk through a link that works once, within two minutes, and DESK prints the address. When no browser can be opened (a Linux server, an SSH session, an X11 display that refuses the connection), DESK prints the link instead: open it in a browser. This is not an error: Desk runs, and the console stays available. A second DESK says BroadSQL Desk 1.0.0 is already running. and gives a new link. On a Linux server over SSH, 127.0.0.1 is the server: see ShaWeR, Troubleshooting to reach it from your computer.

When DESK prints an address instead of a link (links turned off, or two-factor authentication required), open the address and sign in with a ShaWeR user: see ShaWeR, Getting started.

TaskAction
Run SQL or a commandType it, then Enter. Shift+Enter adds a line; Tab completes.
CancelEsc stops the running command.
Change connectionChoose the Database Group or Environment in the top bar, or use CONNECT or ENV. Switching rolls back uncommitted changes. A connection that belongs to no Database Group is under No Database Group, at the end of the list.
Query another Environment onceRun on... runs the latest query there; the current connection stays selected.
Inspect a gridClick a column heading to sort, filter rows, double-click a cell to copy it.
Copy or export displayed rowsCopy rows, or CSV of rows shown. For every row, use DUMP.
Run a ScriptSelect it in Library, enter its parameters, Run. See Arguments and parameters.
Find earlier workRecent, Kept and Exports in the side panel, with search. They are yours: each signed in user has their own, and they are still there after you sign in again or after BroadSQL restarts.
Keep or reuse a blockKeep, Run again, Copy command. Session record downloads the journal.
Remove a blockRemove; Undo restores it. Database changes are not undone.
See who you are signed in asThe header, at its right end: Connected as and your user name.
Sign outSign out, next to it.
Open this documentationThe BroadSQL Desk title of the header is a link to it.
More shortcutsF1.

Desk and the console have separate connections, variables and transactions: commit in one before you rely on the change in the other. Configuration, password changes and Script editing stay in the console.

What is yours, and what everybody shares. Several people can sign in to the same BroadSQL instance, each with their own ShaWeR user. Each of them has their own:

  • Recent, the commands they ran, which is also what the Up key and Ctrl+R find;
  • Kept, the blocks they marked Keep;
  • Exports, the files and tables they exported with DUMP or PULL;
  • journal, so one person never sees another person's commands, results or output.

These are kept in the installation and are still there after signing out, after closing the browser and after BroadSQL restarts. A block you kept comes back with the text it printed, marked from an earlier session; its rows are not kept, so Run again reads them from the database. What everybody shares is the Scripts Library, by design, and the one connection Desk works on: one command runs at a time, and only the person who started it can stop it. Choosing another connection changes it for everybody who is signed in, exactly as it always did.

The console itself is not a named user: a session opened with a link from DESK shows console and has its own Recent, Kept, Exports and journal, separate from every ShaWeR user's. What was typed at the console is not put into anybody's Recent.

Signing out. The Sign out button of the header ends the browser session itself, on the server: another tab of the same browser cannot go on using it, a remembered sign-in on that browser is forgotten, and you are returned to the BroadSQL sign-in page. It is not the same as DESK STOP, which stops Desk itself for everybody, nor the same as closing the tab, which stops nothing. The name shown next to it is the user the session was opened with, read from that session; a session opened by a link from the console shows console.

DESK STOP; closes Desk and rolls back its uncommitted changes. Closing the browser tab does not stop it; LOGOUT and EXIT do. ShaWeR keeps running for other web extensions until SHAWER STOP;.

Configuration

Desk reads these optional keys from the BroadSQL INI file: conf/broadsql.ini.

[Web]
WebOpenBrowser=OFF
WebMaxRowsOnScreen=2000
KeyDefaultValuesEffect
WebWorkspaceONON, OFFOFF disables Desk on this installation: DESK refuses to start it.
WebOpenBrowserONON, OFFOFF: DESK prints the link and opens no browser.
WebConfirmationTimeout12010 to 3600Seconds a question in the browser (a Production confirmation, a prompt) waits. Unanswered, the change is refused.
WebMaxRowsOnScreen10001 to 5000Rows a query shows in Desk. Exports are not limited.

ON and OFF are not case sensitive. A missing key means its default. An invalid value means its default too, and DESK says so. WebWorkspace and WebOpenBrowser are read each time you type DESK. WebConfirmationTimeout and WebMaxRowsOnScreen apply when Desk opens: after a change, type DESK STOP; then DESK;. No restart of BroadSQL is needed.

The port, HTTP or HTTPS, sessions and sign-in are ShaWeR settings: see ShaWeR, Configuration.

Retired keys: WebPort is still read, as a deprecated name of ShawerPort; use ShawerPort. WebContextPath is ignored.

Commands

Type these commands in the BroadSQL console.

CommandAction
DESK;Open Desk, starting ShaWeR first if needed, or reopen it without clearing its journal.
DESK STATUS;Show whether Desk is running, its address, and its licence status. SHAWER STATUS; shows ShaWeR's details.
DESK STOP;Close Desk and roll back its uncommitted changes. ShaWeR keeps running.
DESK LICENCE;Show the installed licence: holder, ID, dates, validity and file.
DESK LICENCE INSTALL "<file>";Check a licence file, then install it, replacing the current one.

WEB and GUI are other names of DESK. DESK LICENSE is accepted for DESK LICENCE.

Licence

Desk requires a valid licence key. Licence keys are not yet made available to the public. If you are interested, email (enable JavaScript to see this email address).

A licence key is a file. DESK LICENCE INSTALL "<file>"; checks it, then copies it as BroadSQL-Desk.licence into the licences folder: the conf folder of the installation, or the folder named by LicencesPath. An invalid file is refused and changes nothing. The licence it replaces is kept as BroadSQL-Desk.licence.previous.

DESK LICENCE; shows the installed licence. Desk warns when it expires within 30 days. After its last valid day, DESK no longer opens Desk; a Desk already open keeps working until DESK STOP, LOGOUT or EXIT.

BroadSQL itself and ShaWeR need no licence.

Troubleshooting

ProblemAction
DESK is an unknown commandSHOW EXTENSIONS; lists the extension JARs BroadSQL found and their status; SHOW EXTENSION ERRORS; says why one is not loaded.
Desk is not loaded with this BroadSQL releaseSHOW EXTENSION ERRORS; lists the releases this Desk supports. Use one of them, or a Desk version that supports yours.
Desk says it needs ShaWeRExtract the Desk ZIP again so that extensions/broadsql-shawer.jar exists, then restart BroadSQL.
A Web API version is not providedInstall the ShaWeR included in your Desk download.
BroadSQL Desk is turned off (WebWorkspace=OFF in the INI file).Set WebWorkspace=ON, or remove the key.
No licence is installed, or it is refusedRun DESK LICENCE;, then install an unchanged licence file valid today.
ShaWeR did not startRead the lines DESK printed: a port in use (ShawerPort), a certificate or a setting.
The link expired, or the browser session endedType DESK; again. Enter the master password first if the console asks for it.
A command is refused in DeskRun it in the console.
No browser opensDESK printed a link: open it within two minutes, or type DESK; again for a new one. Over SSH, forward the port first: see ShaWeR, Troubleshooting.

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