SQLlySQLly documentation
This is the practical tour: what each part of SQLly is for, how it behaves, and where to go next. Every topic has its own link, so you can bookmark the useful bit and skip the rest.
Not sure where to begin? Start with Why SQLly or IntelliSense, then follow the trail into results, safety, and the parts that make your daily SQL work less fiddly. Press / anywhere in the docs to search.
Start here
- Why SQLly
- The practical itch behind SQLly, and the kind of workbench it grew into.
- Live preview (in-tab demo) in-tab demo
- Take the workbench for a spin in your browser against sample data; it is a demo, not a cloud detour.
- Send feedback
- Show me what you see, or tell me when IntelliSense gets it wrong. I personally read every report.
Features
A guided tour of SQLly, arranged around the work you are here to do. Read the features overview.
- Query13 topics
- A place to write SQL with a little less busywork and a lot more context.
- Results20 topics
- Read the answer, shape it for the task, and take it with you when you are done.
- SQLly directives7 topics
- Small SQL comments that remember how a result looks: its columns, widths, formats, colors, pivot, and chart.
- Databases
- The 30 engines SQLly connects to today, from SQL Server and PostgreSQL to DuckDB, ClickHouse, Oracle and Redis, which tools work on each, and how to connect.
- Intelligence4 topics
- Tools that help SQLly explain your database in plain language without pretending it knows more than it does.
- Multi-modal schema5 topics
- Bring live databases, local DDL, work in progress, and Git context into one useful picture.
- Safety & guardrails6 topics
- Put a thoughtful pause in front of risky work while keeping ordinary reads pleasantly boring.
- Identity gates6 topics
- Use your operating system's identity check where a mistake would be expensive, and leave routine work alone.
- Server Explorer7 topics
- Keep connections and their schema close at hand, organized for the way you think about your work.
- Connection Organization7 topics
- Give every connection enough context that the right database is easy to spot before you touch it.
- Speed & access5 topics
- The engineering behind a responsive workbench, remote reach when you need it, and privacy when you do not.
- Platforms2 topics
- The same native SQLly workbench on the desktops where real database work happens.
- Themes
- Twelve color themes, each in Light and Dark, plus a System mode that follows your OS from day to night.
- Redis tools13 topics
- Redis tools: key view and streams, IntelliSense, Cluster and Sentinel, profiler, Pub/Sub, memory analysis, bulk actions, ACL users, and value formats.
- Files & sync2 topics
- Keep your SQLly world in plain files, then choose if and how those files travel with you.
- Tools2 topics
- The admin tools SQLly opens from the Object Explorer's right-click Tools menu - some for a whole server, some scoped to a single database.
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. Read the sqlly embedded overview.
- 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.
- Open SQLly on a query
- Launch SQLly straight into a query tab: the script, its connection and database, parameter values and the cursor, sent with the launch token for "Open in SQLly" buttons.
- 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.
Platform
How SQLly is built: the layers, the crates behind each one, and the tests that keep them honest. Read the platform overview.
- How the app is built
- One Rust workspace, a native GPU interface, a headless service core, and an engine subprocess - and how the pieces talk.
- The crates
- All fifteen crates with what each one does, what lives inside it, and how many tests stand behind it.