SQLly Embedded

Host SQLly inside your own web app: what is in the package, how the bridge, your app and sqlly.app fit together, and where to start.

SQLly Embedded puts the browser build of SQLly inside your own web app. Your users get the full workbench on a page of your site: the SQL editor with IntelliSense, the object explorer, results grid, charts, and execution plans. Your server keeps every database password. You decide which connections each group of users sees, and the SQLly bridge enforces your license.

What you run

The package also includes a sample admin app (Node.js, no dependencies) that does everything your app would: an admin screen for profiles, labels and users, and a sign-in page that opens SQLly for each user. Run it to see the whole flow, then replace it with your own app, or start from its code.

In this section

How it works

The theory of operation: the bridge, the engine per session, launch tokens, the signed license grant, check-ins, seats, the Origin rule, and where credentials live.

Quick start

Run the SQLly Embedded package on localhost in five minutes: start the bridge and the sample app, link a license, add a profile, and open SQLly as a user.

Sample app tour

A screen-by-screen tour of the sample admin app that ships with SQLly Embedded: status and licensing, profiles and connections, labels, users, and launching SQLly.

Build your own app

Step by step: drive the SQLly Embedded bridge from your own web app - store profiles, mint launch tokens, serve the browser build, release seats and link installs.

API reference

Every endpoint of the SQLly Embedded bridge's management API, generated from its OpenAPI (swagger.json) document, plus the sqlly.app linking endpoints.

Licensing

Plans, seats, sessions, instances, domains, check-ins, grace periods, offline license files, every license state the bridge can be in, and how to fix each one.

Going to production

TLS, reverse proxies, the licensed domain, service managers, backups, Content-Security-Policy and isolation headers, and a production checklist for SQLly Embedded.

Pick a path

• Evaluating? Read How it works, then follow the Quick start. Every sqlly.app account includes a free three-month trial (one user, one bridge), so you don't need to buy anything to try it.
• Integrating? Take the sample app tour to see what your app needs to provide, then work through Build your own app with the API reference (or load swagger.json into your API tooling).
• Deploying? Read Licensing for seats, domains and what each license state means, then Going to production.

The short version

• Credentials never reach the browser. A profile's passwords live in the bridge's state directory. The browser only receives the connection list (names, engines, labels) and sends queries over the bridge's WebSocket.
• Seats are concurrent users. A user holds a seat while SQLly is open for them, or while they hold an unexpired launch token. It frees the moment they're done. Paid plans allow four tabs per user.
• One domain per license, with every subdomain included. The bridge only accepts browsers whose Origin is on that domain (plus localhost while you develop).
• Every engine SQLly supports works through the bridge: SQL Server, Azure SQL, PostgreSQL, MySQL, MariaDB, SQLite, DuckDB, ClickHouse, Oracle, libSQL/Turso, Redis and Valkey, and the cloud variants.
• Connected or offline. Connected licenses check in with sqlly.app every 20 minutes. Offline licenses are a signed file the bridge verifies locally and never phone home.