@libsql/client NPM | npm.io

0.15.9 • Published 6 months ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

6 months ago

Features

🔌 Works offline with Embedded Replicas
🌎 Works with remote Turso databases
✨ Works with Turso AI & Vector Search
🔐 Supports encryption at rest

Install

npm install @libsql/client

Quickstart

The example below uses Embedded Replicas and syncs every minute from Turso.

import { createClient } from "@libsql/client";

export const turso = createClient({
    url: "file:local.db",
    syncUrl: process.env.TURSO_DATABASE_URL,
    authToken: process.env.TURSO_AUTH_TOKEN,
    syncInterval: 60000,
});

await turso.batch(
    [
        "CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT)",
        {
            sql: "INSERT INTO users(name) VALUES (?)",
            args: ["Iku"],
        },
    ],
    "write",
);

await turso.execute({
    sql: "SELECT * FROM users WHERE id = ?",
    args: [1],
});

Examples

Example	Description
local	Uses libsql with a local SQLite file. Creates database, inserts data, and queries.
remote	Connects to a remote database. Requires environment variables for URL and auth token.
sync	Demonstrates synchronization between local and remote databases.
batch	Executes multiple SQL statements in a single batch operation.
transactions	Shows transaction usage: starting, performing operations, and committing/rolling back.
memory	Uses an in-memory SQLite database for temporary storage or fast access.
vector	Works with vector embeddings, storing and querying for similarity search.
encryption	Creates and uses an encrypted SQLite database, demonstrating setup and data operations.
ollama	Similarity search with Ollama and Mistral.

Documentation

Visit our official documentation.

Support

Join us on Discord to get help using this SDK. Report security issues via email.

Contributors

See the contributing guide to learn how to get involved.

Contributors

libsql database sqlite serverless vercel netlify lambda

@libsql/core @libsql/hrana-client js-base64 libsql promise-limit

@everything-registry/sub-chunk-547 drizzle-plugin kysely-libsql horos hono-with-drizzle libsql-kv libsql-migrate libsql-ratelimiter libsql-studio-gui llm-web-ui luminest knex-libsql-dialect mcp-memory-libsql mcp-turso mcp-svelte-docs @vicary/kysely-libsql @yeonjoong/pulse @yourownmailer/cli @zalastax/nolb-_lib @powerhousedao/reactor-local fuzd-nodejs drizzle-schema-checker driftsql dswbx-bknd enochian-studio express-session-libsql fanful-react-sdk flyweight-turso @prisma/adapter-libsql @bobdivx/mf3d @bknd/data @cherrystudio/embedjs-libsql @barakcodes/kysely-libsql create-z3-app deadrop design.email-database botmate-cli bknd @antl3x/toolrag @affdash/database @adaneinstein/zap-assistent @aigne/platform-helpers @aigne/sqlite @andyrmitchell/drizzle-fast-bulk-test @andyrmitchell/drizzle-robust-transaction @allends/graphene-database @alexmchan/memocache @alexmchan/memocache-store-libsql @netzo/api pw-sql-reporter @oberoncms/adapter-turso starknext starknet-frontend sqlstudio ukv umzug-libsql tursobase @astrojs/db multi-agent-orchestrator music-metadata-search missiv-server-nodejs outerbase-studio nuxt-kysely nuxt-space-dev nuxt-space-layer scout-sqlite nestjs-drizzle next-js-eva-core prismoo realworld-hono-drizzle shamela gofer-app @effect/sql-libsql @destacks/sql @draftauth/core @drizzle-adapter/d1 @drizzle-adapter/libsql @equinox-js/libsql @eth-optimism/super-cli @featlly/drizzle-adapter @fiberplane/studio @hype/hype @iconicompany/multi-agent-orchestrator-local @heimdall-logs/db @hollowleaf/payload-db-sqlite @hexlet/job-analysis @invisal-testing/studio @iridiumcms/cms @gibme/sql @glyphyai/mastra-core @gemini-dock/server @gensx/storage @jliocsar/notiz-cli @mseep/mcp-turso @mseep/mcp-memory-libsql @raffaele-oplabs/super-cli @r1tsu/db-postgres @mainframe-api/node @mainframe-so/node @mastra/libsql

8 months ago

7 months ago

7 months ago

6 months ago

6 months ago

6 months ago

9 months ago

8 months ago

8 months ago

8 months ago

1 year ago

10 months ago

10 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago