@tursodatabase/database

Turso Database for JavaScript in Node

About

This package is the Turso embedded database library for JavaScript in Node.

Turso Database runs in production today at multiple organizations. It has not yet reached 1.0, so as with any database we recommend keeping backups — see the FAQ for where the project stands.

Features

• SQLite compatible: SQLite query language and file format support (status).
• In-process: No network overhead, runs directly in your Node.js process
• TypeScript support: Full TypeScript definitions included
• Cross-platform: Supports Linux (x86 and arm64), macOS, Windows (browser is supported in the separate package @tursodatabase/database-wasm package)

Installation

npm install @tursodatabase/database

Getting Started

In-Memory Database

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

// Create an in-memory database
const db = await connect(':memory:');

// Create a table
await db.exec('CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)');

// Insert data
const insert = db.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
await insert.run('Alice', '[e-mail]');
await insert.run('Bob', '[e-mail]');

// Query data
const users = await db.prepare('SELECT * FROM users').all();
console.log(users);
// Output: [
//   { id: 1, name: 'Alice', email: '[e-mail]' },
//   { id: 2, name: 'Bob', email: '[e-mail]' }
// ]

File-Based Database

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

// Create or open a database file
const db = await connect('my-database.db');

// Create a table
await db.exec(`
  CREATE TABLE IF NOT EXISTS posts (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    title TEXT NOT NULL,
    content TEXT,
    created_at DATETIME DEFAULT CURRENT_TIMESTAMP
  )
`);

// Insert a post
const insertPost = db.prepare('INSERT INTO posts (title, content) VALUES (?, ?)');
const result = await insertPost.run('Hello World', 'This is my first blog post!');

console.log(`Inserted post with ID: ${result.lastInsertRowid}`);

Transactions

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

const db = await connect('transactions.db');

// Using transactions for atomic operations
const transaction = db.transactionAsync(async (txn, users) => {
  const insert = await txn.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
  for (const user of users) {
    await insert.run(user.name, user.email);
  }
});

// Execute transaction
await transaction([
  { name: 'Alice', email: '[e-mail]' },
  { name: 'Bob', email: '[e-mail]' }
]);

API Reference

For complete API documentation, see JavaScript API Reference.

Related Packages

• The @tursodatabase/serverless package provides a serverless driver with the same API.
• The @tursodatabase/sync package provides bidirectional sync between a local Turso database and Turso Cloud.

License

This project is licensed under the MIT license

Support

• GitHub Issues
• Documentation
• Discord Community