turso/bindings/javascript/sync

Turso Sync for JavaScript

---

About

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

⚠️ Warning: This software is in BETA. It may still contain bugs and unexpected behavior. Use caution with production data and ensure you have backups.

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

Related Packages

• 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.

Support

• GitHub Issues
• Documentation
• Discord Community