mirror of
https://github.com/aljazceru/turso.git
synced 2025-12-25 03:54:21 +01:00
adca9e4c70
This PR introduces separate `package.browser.json` file for `*-browser` npm packages (`@tursodatabase/sync-browser` and `@tursodatabase/database-browser`). The packages are nearly identical and the only change is `package.json` content (browser package mentions only WASM optional dependency which shouldn't confuse NPM and force it to download WASM dep package instead of native one). Due to that, innocent "hack" is implemented which swap `package.json` with `package.browser.json` before publish of `browser` package. Closes #2906
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
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.