mirror of
https://github.com/tursodatabase/limbo.git
synced 2025-12-23 08:21:09 +00:00
73289c6325
This PR brings back go driver to the turso monorepo and adds sync support for the golang. It depends on the pre-compiled binaries at https://github.com/tursodatabase/turso-go-platform-libs repository There is a CI which trigger build on the turso-go-platform-libs repo in case when release tag is published Reviewed-by: Preston Thorpe <preston@turso.tech> Closes #4085 |
||
|---|---|---|
| .. | ||
| packages | ||
| src | ||
| build.rs | ||
| Cargo.toml | ||
| 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 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.