![]() This PR imports the `sync` test suite from libSQL, and modifies the export structure match `better-sqlite3`, so that at least a few tests from the new test suite are passing. I also changed the `package.json` to expose `wrapper.js` as an entrypoint. I think the plain `index.js` was probably never meant to be exposed directly to clients, because the wrapper does some important transformation. It's also how libSQL-js is [structured](https://github.com/tursodatabase/libsql- js/blob/main/package.json#L20). ## DualTest test runner The test suite that I imported was previously run twice, with different environment variables: one run for libSQL-js, one run for better- sqlite3. This worked well with libSQL, because it's compatible with better-sqlite3. But Turso isn't there yet, so even though all tests need to run on better-sqlite3, not all tests are passing on Turso. To make it possible to run the test suite on both implementation, and to make it possible to track the progress of Turso, I've added a `DualTest` test runner that emulates the API of the Ava test runner, but instead of a single `test()` function, it exposes two methods: `both()`, and `onlySqlitePasses()`. The first one runs the test on both implementations, and the second one also runs it on both, but expects that Turso will fail. When Turso is completely compatible with better-sqlite3, it will be easy to remove the dual-test runner, since it has the same API as Ava. ## Future development ### Existing tests The existing tests were divided in two files: `better-sqlite3.spec.mjs`, and `dual-test.mjs` that are kept in sync manually. The first one is mostly a superset of the second one, with additional tests indicating behaviour that isn't implemented in Turso yet. I want to merge these test suites to also use the dual-test test runner. This will make it easier to evolve test suites and to track the progress of Turso. ### `SqliteError` Modifying the test called `errors` to `both()` will show that Turso is still missing an `SqliteError` type, to be compatible with better- sqlite3. I have the required changes in a stash and will open a PR shortly. ----- as part of https://github.com/tursodatabase/turso/issues/1900 Closes #1941 |
||
---|---|---|
.cargo | ||
.github | ||
antithesis-tests | ||
assets | ||
bindings | ||
cli | ||
core | ||
docs | ||
extensions | ||
fuzz | ||
licenses | ||
macros | ||
perf | ||
scripts | ||
simulator | ||
simulator-docker-runner | ||
sqlite3 | ||
stress | ||
testing | ||
tests | ||
vendored/sqlite3-parser | ||
.github.json | ||
.gitignore | ||
.python-version | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
COMPAT.md | ||
CONTRIBUTING.md | ||
db.sqlite | ||
dist-workspace.toml | ||
Dockerfile.antithesis | ||
flake.lock | ||
flake.nix | ||
LICENSE.md | ||
Makefile | ||
NOTICE.md | ||
PERF.md | ||
Pipfile | ||
Pipfile.lock | ||
pyproject.toml | ||
README.md | ||
rust-toolchain.toml | ||
turso.png | ||
uv.lock |
Turso Database
Turso Database is an in-process SQL database, compatible with SQLite.
Features and Roadmap
Turso Database is a work-in-progress, in-process OLTP database engine library written in Rust that has:
- SQLite compatibility [doc] for SQL dialect, file formats, and the C API
- Language bindings for JavaScript/WebAssembly, Rust, Go, Python, and Java
- Asynchronous I/O support on Linux with
io_uring
- OS support for Linux, macOS, and Windows
In the future, we will be also working on:
BEGIN CONCURRENT
for improved write throughput.- Indexing for vector search.
- Improved schema management including better
ALTER
support and strict column types by default.
Getting Started
Please see the Turso Database Manual for more information.
💻 Command Line
You can install the latest `turso` release with:
curl --proto '=https' --tlsv1.2 -LsSf \
https://github.com/tursodatabase/turso/releases/latest/download/turso_cli-installer.sh | sh
Then launch the shell to execute SQL statements:
Turso
Enter ".help" for usage hints.
Connected to a transient in-memory database.
Use ".open FILENAME" to reopen on a persistent database
turso> CREATE TABLE users (id INT PRIMARY KEY, username TEXT);
turso> INSERT INTO users VALUES (1, 'alice');
turso> INSERT INTO users VALUES (2, 'bob');
turso> SELECT * FROM users;
1|alice
2|bob
You can also build and run the latest development version with:
cargo run
🦀 Rust
cargo add turso
Example usage:
let db = Builder::new_local("sqlite.db").build().await?;
let conn = db.connect()?;
let res = conn.query("SELECT * FROM users", ()).await?;
✨ JavaScript
npm i @tursodatabase/turso
Example usage:
import { Database } from '@tursodatabase/turso';
const db = new Database('sqlite.db');
const stmt = db.prepare('SELECT * FROM users');
const users = stmt.all();
console.log(users);
🐍 Python
pip install pyturso
Example usage:
import turso
con = turso.connect("sqlite.db")
cur = con.cursor()
res = cur.execute("SELECT * FROM users")
print(res.fetchone())
🐹 Go
- Clone the repository
- Build the library and set your LD_LIBRARY_PATH to include turso's target directory
cargo build --package limbo-go
export LD_LIBRARY_PATH=/path/to/limbo/target/debug:$LD_LIBRARY_PATH
- Use the driver
go get github.com/tursodatabase/turso
go install github.com/tursodatabase/turso
Example usage:
import (
"database/sql"
_ "github.com/tursodatabase/turso"
)
conn, _ = sql.Open("sqlite3", "sqlite.db")
defer conn.Close()
stmt, _ := conn.Prepare("select * from users")
defer stmt.Close()
rows, _ = stmt.Query()
for rows.Next() {
var id int
var username string
_ := rows.Scan(&id, &username)
fmt.Printf("User: ID: %d, Username: %s\n", id, username)
}
☕️ Java
We integrated Turso Database into JDBC. For detailed instructions on how to use Turso Database with java, please refer to the README.md under bindings/java.
Contributing
We'd love to have you contribute to Turso Database! Please check out the contribution guide to get started.
FAQ
Is Turso Database ready for production use?
Turso Database is currently under heavy development and is not ready for production use.
How is Turso Database different from Turso's libSQL?
Turso Database is a project to build the next evolution of SQLite in Rust, with a strong open contribution focus and features like native async support, vector search, and more. The libSQL project is also an attempt to evolve SQLite in a similar direction, but through a fork rather than a rewrite.
Rewriting SQLite in Rust started as an unassuming experiment, and due to its incredible success, replaces libSQL as our intended direction. At this point, libSQL is production ready, Turso Database is not - although it is evolving rapidly. More details here.
Publications
- Pekka Enberg, Sasu Tarkoma, Jon Crowcroft Ashwin Rao (2024). Serverless Runtime / Database Co-Design With Asynchronous I/O. In EdgeSys ‘24. [PDF]
- Pekka Enberg, Sasu Tarkoma, and Ashwin Rao (2023). Towards Database and Serverless Runtime Co-Design. In CoNEXT-SW ’23. [PDF] [Slides]
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Turso Database by you, shall be licensed as MIT, without any additional terms or conditions.
Partners
Thanks to all the partners of Turso!
Contributors
Thanks to all the contributors to Turso Database!