turso README

The project's README from github.com/tursodatabase/turso. As one markdown file: README.md.

Turso Database

Turso Database

An in-process SQL database, compatible with SQLite, and now with a Postgres frontend too.

Crate NPM PyPI Maven Central

Chat with the Core Developers on Discord

Chat with other users of Turso (and Turso Cloud) on Discord


About

Turso is an in-process SQL database written in Rust, compatible with SQLite. It runs in production today at multiple organizations.

Turso is also a virtual machine. Like SQLite, it compiles SQL into bytecode for that machine, the VDBE, and then runs the bytecode. That design is what lets one engine host more than one SQL dialect. SQLite is the first and primary frontend that compiles to it, and Postgres is now a frontend of its own, with its own dialect and wire protocol. More will follow. Our goal is to be for databases what LLVM is to compilers, with one modern and reliable core, and many frontends compiled down onto it.

How general is that core? General enough to run Doom on it.

See the FAQ for where the project stands on its way to 1.0.

Features and Roadmap

The database has the following experimental features:

The following features are on our current roadmap:

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 interactive shell:

$ tursodb

This will start the Turso interactive shell where you can 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, 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

If you like docker, we got you covered. Simply run this in the root folder:

make docker-cli-build && \
make docker-cli-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/database

Example usage:

import { connect } from '@tursodatabase/database';

const db = await connect('sqlite.db');
const stmt = db.prepare('SELECT * FROM users');
const users = stmt.all();
console.log(users);
🐍 Python
uv 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
go get turso.tech/database/tursogo
go install turso.tech/database/tursogo

Example usage:

import (
    "database/sql"
    _ "turso.tech/database/tursogo"
)

conn, _ = sql.Open("turso", "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)
}
️#️⃣ .NET

Example usage:

using Turso;

using var connection = new TursoConnection("Data Source=:memory:");
connection.Open();

connection.ExecuteNonQuery("CREATE TABLE t(a, b)");
var rowsAffected = connection.ExecuteNonQuery("INSERT INTO t(a, b) VALUES (1, 2), (3, 4)");
Console.WriteLine($"RowsAffected: {rowsAffected}");

using var command = connection.CreateCommand();
command.CommandText = "SELECT * FROM t";
using var reader = command.ExecuteReader();
while (reader.Read())
{
    var a = reader.GetInt32(0);
    var b = reader.GetInt32(1);
    Console.WriteLine($"Value1: {a}, Value2: {b}");
}
☕️ 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.

🤖 MCP Server Mode

The Turso CLI includes a built-in Model Context Protocol (MCP) server that allows AI assistants to interact with your databases.

Start the MCP server with:

tursodb your_database.db --mcp

Configuration

Add Turso to your MCP client configuration:

{
  "mcpServers": {
    "turso": {
      "command": "/path/to/.turso/tursodb",
      "args": ["/path/to/your/database.db", "--mcp"]
    }
  }
}

Available Tools

The MCP server provides nine tools for database interaction:

  1. open_database - Open a new database
  2. current_database - Describe the current database
  3. list_tables - List all tables in the database
  4. describe_table - Describe the structure of a specific table
  5. execute_query - Execute read-only SELECT queries
  6. insert_data - Insert new data into tables
  7. update_data - Update existing data in tables
  8. delete_data - Delete data from tables
  9. schema_change - Execute schema modification statements (CREATE TABLE, ALTER TABLE, DROP TABLE)

Once connected, you can ask your AI assistant:

  • "Show me all tables in the database"
  • "What's the schema for the users table?"
  • "Find all posts with more than 100 upvotes"
  • "Insert a new user with name 'Alice' and email '[email protected]'"

MCP Clients

Claude Code

If you're using Claude Code, you can easily connect to your Turso MCP server using the built-in MCP management commands:

Quick Setup

  1. Add the MCP server to Claude Code:

    claude mcp add my-database -- tursodb ./path/to/your/database.db --mcp
    
  2. Restart Claude Code to activate the connection

  3. Start querying your database through natural language!

Command Breakdown

claude mcp add my-database -- tursodb ./path/to/your/database.db --mcp
#              ↑            ↑       ↑                           ↑
#              |            |       |                           |
#              Name         |       Database path               MCP flag
#                          Separator
  • my-database - Choose any name for your MCP server
  • -- - Required separator between Claude options and your command
  • tursodb - The Turso database CLI
  • ./path/to/your/database.db - Path to your SQLite database file
  • --mcp - Enables MCP server mode

Example Usage

# For a local project database
cd /your/project
claude mcp add my-project-db -- tursodb ./data/app.db --mcp

# For an absolute path
claude mcp add analytics-db -- tursodb /Users/you/databases/analytics.db --mcp

# For a specific project (local scope)
claude mcp add project-db --local -- tursodb ./database.db --mcp

Managing MCP Servers

# List all configured MCP servers
claude mcp list

# Get details about a specific server
claude mcp get my-database

# Remove an MCP server
claude mcp remove my-database
Claude Desktop

For Claude Desktop, add the configuration to your claude_desktop_config.json file:

{
  "mcpServers": {
    "turso": {
      "command": "/path/to/.turso/tursodb",
      "args": ["./path/to/your/database.db", "--mcp"]
    }
  }
}
Cursor

For Cursor, configure MCP in your settings:

  1. Open Cursor settings
  2. Navigate to Extensions → MCP
  3. Add a new server with:
    • Name: turso
    • Command: /path/to/.turso/tursodb
    • Args: ["./path/to/your/database.db", "--mcp"]

Alternatively, you can add it to your Cursor configuration file directly.

Direct JSON-RPC Usage

The MCP server runs as a single process that handles multiple JSON-RPC requests over stdin/stdout. Here's how to interact with it directly:

Example with In-Memory Database

cat << 'EOF' | tursodb --mcp
{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "client", "version": "1.0"}}}
{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "schema_change", "arguments": {"query": "CREATE TABLE users (id INTEGER, name TEXT, email TEXT)"}}}
{"jsonrpc": "2.0", "id": 3, "method": "tools/call", "params": {"name": "list_tables", "arguments": {}}}
{"jsonrpc": "2.0", "id": 4, "method": "tools/call", "params": {"name": "insert_data", "arguments": {"query": "INSERT INTO users VALUES (1, 'Alice', '[email protected]')"}}}
{"jsonrpc": "2.0", "id": 5, "method": "tools/call", "params": {"name": "execute_query", "arguments": {"query": "SELECT * FROM users"}}}
EOF

Example with Existing Database

# Working with an existing database file
cat << 'EOF' | tursodb mydb.db --mcp
{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "client", "version": "1.0"}}}
{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "list_tables", "arguments": {}}}
EOF

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?

Yes — Turso powers production applications today at multiple organizations, including Turso Cloud, the Kin AI assistant, and Spice.ai. Reliability is our top priority: Turso is extensively tested by a collection of tools including a native Deterministic Simulation Testing suite and Antithesis.

That said, we have not yet reached 1.0. The project is under active development, and some features are explicitly marked experimental. Our bar is SQLite-level reliability — one of the most rigorously tested pieces of software in the world — and until we declare 1.0, we recommend the same discipline you would apply to any database: keep independent backups.

How compatible is Turso Database with SQLite?

Turso is compatible with SQLite at the SQL dialect, file format, and C API levels, and existing SQLite database files work as-is. We are not at 100% yet, so some differences are still expected — COMPAT.md tracks the details — but the gap is closing quickly, and full compatibility is a requirement for 1.0.

Is Turso a SQLite database or a Postgres database?

It is one engine with more than one SQL frontend. SQLite is the original and primary frontend, with its dialect, its file format, and its C API, and if that is what you use, nothing changes for you. Postgres is a newer and still experimental frontend that speaks the Postgres dialect and wire protocol. They share everything below the SQL: the storage, the concurrency, the query compiler, and the VM. Postgres is additive.

What do you mean by "the LLVM of databases"?

Like SQLite, Turso compiles a query into bytecode for a virtual machine called the VDBE, and runs that bytecode. SQL is just one language that compiles to it. Our goal is to make that VM a general target, with one modern and rigorously tested core, and many database frontends compiled onto it: SQLite, Postgres, and others over time. LLVM did this for compilers, where a stable intermediate representation let many languages share one backend, and we think databases deserve the same. The bytecode is general enough to run Doom, if you want proof.

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. Both run in production today: libSQL has been battle-tested for longer, while Turso Database is where our development effort is focused and is evolving rapidly. More details here.

Publications

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!

turso (tursodatabase/turso)

Searching Database…

24.8K ·GitHub
这是什么?Turso 是一个用 Rust 编写的进程内 SQL 数据库,兼容 SQLite,并提供实验性的 Postgres 前端。和 SQLite 一样,它直接运行在你的应用程序内部,目前已在多家机构的正式生产环境中使用。
它是像 SQLite 那样嵌入到我的应用里,还是作为服务器运行?是嵌入式的,和 SQLite 一样——引擎在你的进程里运行,而不是一个需要连接的服务器。它还附带一个带交互式 SQL 命令行的 CLI,可以直接在终端里使用。
我怎么把它跑起来?先安装最新版本的 'turso',然后用 'tursodb' 启动交互式命令行,直接输入 SQL 即可。你也可以从源码构建开发版本,或者用 Docker 运行。
我能从 Python 或 JavaScript 里用它吗,还是只能用 Rust?核心是 Rust 编写的,但官方为 Go、JavaScript、Java(通过 JDBC)、.NET、Python 和 Rust 本身提供了绑定,另外还支持 WebAssembly。
它可以直接用于生产环境,还是仍处于实验阶段?它已经过生产环境验证(确定性模拟测试、Antithesis),支撑着真实的应用,但还没有发布 1.0:部分功能明确标记为实验性,所以请务必自行做好独立备份。
它在所有桌面操作系统上都能运行吗?浏览器里也可以吗?可以——Linux、macOS 和 Windows 都有原生支持,还能通过 WebAssembly 在浏览器里运行。在 Linux 上,它还可以通过 io_uring 使用异步 I/O。
它能打开我现有的 SQLite 数据库文件吗?可以——兼容性涵盖 SQL 方言、文件格式和 C API(跟进 SQLite 3.50.4),现有文件可以直接使用。不过还没做到 100% 兼容:剩余的差异记录在 COMPAT.md 里,完全兼容是发布 1.0 的必要条件。
这个实验性的 Postgres 支持到底能给我带来什么?它在同一个引擎上提供了第二个前端:Turso 能说 Postgres 的 SQL 方言和通信协议,而存储、并发、查询编译器和虚拟机则与 SQLite 前端共用。Postgres 是额外叠加的——SQLite 的使用体验完全不变。
我能把它接上 Claude Code 或 Cursor 吗?可以。CLI 内置了 MCP 服务器模式:运行 'tursodb ./path/to/your/database.db --mcp',然后在 Claude Code、Claude Desktop 或 Cursor 里注册即可。它提供九个工具,可用于列出表、查看表结构、执行 SELECT 查询、插入、更新、删除数据以及修改表结构。
为什么团队把它称为'数据库界的 LLVM'?查询会被编译成内部虚拟机(VDBE)的字节码,各种 SQL 方言只是它的前端——SQLite 是主前端,Postgres 现在是第二个,未来还会更多。一个经过严格测试的核心,上面跑着多种前端;它甚至通用到可以运行 Doom。
What are similar projects?libsql, surrealdb, wcdb, usql, pglite, duckdb, SQLite.swift, apsw
Size
259.1 MB
Stars
24.8K
Age
3y
Commits · 90 Days