mirror of https://github.com/tursodatabase/limbo.git synced 2025-12-23 08:21:09 +00:00

History

Nikita Sivukhin 974feac27b move compute to the main thread for browser and node - now, most of the work is happening on the main thread - for database in browser, we still have dedicated WebWorker - but it is used only for OPFS access and only for that - for syn in browser we still offload sync operations to the WebWorker		2025-09-19 13:19:30 +04:00
..
packages	move compute to the main thread for browser and node	2025-09-19 13:19:30 +04:00
src	expose revision in the stats method	2025-09-15 10:56:13 +04:00
build.rs	opfs for sync in one commit!	2025-09-10 22:35:57 +04:00
Cargo.toml	move as many dependencies as possible to workspace to avoid multiple versions of the same dependency	2025-09-15 17:19:36 -03:00
README.md	opfs for sync in one commit!	2025-09-10 22:35:57 +04:00

README.md

Turso Sync for JavaScript

About

This package is for syncing local Turso databases to the Turso Cloud and back.

⚠️ Warning: This software is ALPHA, only use for development, testing, and experimentation. We are working to make it production ready, but do not use it for critical data right now.

Installation

npm install @tursodatabase/sync

Getting Started

To sync a database hosted at Turso Cloud:

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

const db = await connect({
    path: 'local.db',                // path used as a prefix for local files created by sync-engine
    url: 'https://<db>.turso.io',    // URL of the remote database: turso db show <db>
    authToken: '...',                // auth token issued from the Turso Cloud: turso db tokens create <db>
    clientName: 'turso-sync-example' // arbitrary client name
});

// db has same functions as Database class from @tursodatabase/database package but adds few more methods for sync:
await db.pull(); // pull changes from the remote
await db.push(); // push changes to the remote
await db.sync(); // pull & push changes

The @tursodatabase/database package provides the Turso in-memory database, compatible with SQLite.
The @tursodatabase/serverless package provides a serverless driver with the same API.

License

This project is licensed under the MIT license.