Turborel Studio is in alpha, meaning, version 0.0.0. Its version is the number of the Turborel release it is made for, and the alpha is made for Turborel 0.0.0. Anything may change from one build to the next, its files and behaviour alike. See VERSIONING.md. The latest Turborel alpha is built for Linux, macOS and Windows as the pre-release nightly, and as the image
ghcr.io/turborel/turborel:nightly.
Turborel Studio is the desktop database IDE for
Turborel, a relational database
system. It opens both of Turborel's modes: a Turborel server,
turboreld, through Turborel's own client library, turborel-client;
and an embedded database, in a folder or in memory, opened in Studio's
own process through the turborel crate's embedded library. It gives a
person who works with the database one window for it:
- server connections, and embedded databases opened, made new, or made in memory as a scratch database that is never saved;
- a Connections and Object Explorer tree of the catalog;
- tabbed SQL worksheets, each with its results and messages, completion, and a plan viewer;
- a results grid that reads a query's rows a page at a time;
- editing a table's rows, importing and exporting them, and dialogs that write DDL;
- schema diagrams and models, designed offline and compared with a live schema, and schema compare;
- an analyzer of indexes, plans and statements, and reports;
- an assistant, off until the user turns it on;
- live sessions, a workspace shared with others as it is worked in;
- a monitor of the server or the database: its sessions, what each runs and waits on, the statements run and the tables' and indexes' sizes and use, its settings, plug-ins, users and replication.
It runs on Linux, macOS and Windows, built with Tauri: a Rust backend
over turborel-client and the turborel crate, and a front end in
TypeScript and React. Passwords
and keys stay in the operating system's keychain, and the webview never
sees them (SECURITY.md).
Studio is built in milestones, M0 to M12. CONFORMANCE.md says what it supports of Turborel, row by row, and TODO.md what is open.
- Linux, macOS or Windows, with the platform's webview: WebKitGTK 4.1 on Linux, WKWebView on macOS, WebView2 on Windows (RULES.md D3).
- For server connections, a Turborel server of the same release (running the server). An embedded or in-memory database needs no server: Studio holds Turborel's engine itself, at the commit it is pinned to (Versions). A database another alpha build of Turborel made may not open with it, and Studio says so.
No build is published yet. Studio's installers are made only once the
owner says, with Turborel's release (VERSIONING.md).
Until then, build it from source, as
Installing says: Rust (the toolchain
rust-toolchain.toml names), Node.js 24 or later, and the platform's
webview and its build dependencies.
npm ci
npm exec -- tauri build
doc/ is the manual: a User's Guide and Appendices, published at https://turborel.com/docs/studio/. Each chapter is written as the milestone that fills it lands. The SQL Studio runs, and the server, are described in Turborel's own manual, The Turborel Documentation Set.
Read CONTRIBUTING.md before making a change: how a
change is made, its commit message, pull requests and issues. Every
change passes cargo xtask verify. RULES.md says how Studio
is designed, written and verified, CONFORMANCE.md what
it supports of Turborel, and TODO.md lists open work.
Report a vulnerability privately, never in a public issue, as SECURITY.md says.
The code is under the BSD-2-Clause Plus Patent License, in LICENSE. The name Turborel and its logos, Studio's icon among them, are not: TRADEMARK.md says how they may be used.