libSQL is an open source, open contribution fork of SQLite. This source repository contains libSQL API bindings for Node, which aims to be compatible with better-sqlite3, but with opt-in promise API.
Please note you are currently encouraged to use the libSQL SDK as it is more mature at this point and also supports serverless applications that only can use fetch().
- In-memory and local libSQL/SQLite databases
- Remote libSQL databases
- Embedded, in-app replica that syncs with a remote libSQL database
You can install the package with:
Node:
npm i libsqlBun:
bun add libsqlDeno:
Use the npm: prefix for package import:
import Database from 'npm:libsql';To try out your first libsql program, type the following in hello.js:
import Database from 'libsql';
const db = new Database(':memory:');
db.exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)");
db.exec("INSERT INTO users (id, name, email) VALUES (1, 'Alice', '[email protected]')");
const row = db.prepare("SELECT * FROM users WHERE id = ?").get(1);
console.log(`Name: ${row.name}, email: ${row.email}`);and then run:
$ node hello.jsTo use the promise API, import libsql/promise:
import Database from 'libsql/promise';
const db = new Database(':memory:');
await db.exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)");
await db.exec("INSERT INTO users (id, name, email) VALUES (1, 'Alice', '[email protected]')");
const stmt = await db.prepare("SELECT * FROM users WHERE id = ?");
const row = stmt.get(1);
console.log(`Name: ${row.name}, email: ${row.email}`);import Database from 'libsql';
const db = new Database('hello.db');import Database from 'libsql';
const url = process.env.LIBSQL_URL;
const authToken = process.env.LIBSQL_AUTH_TOKEN;
const opts = {
authToken: authToken,
};
const db = new Database(url, opts);import libsql
const opts = { syncUrl: "<url>", authToken: "<optional auth token>" };
const db = new Database('hello.db', opts);
db.sync();db.exec("CREATE TABLE users (id INTEGER, email TEXT);")db.exec("INSERT INTO users VALUES (1, '[email protected]')")const row = db.prepare("SELECT * FROM users WHERE id = ?").get(1);To build the libsql package, run:
npm run buildYou can then run the integration tests with:
npm link
cd integration-tests
npm link libsql
npm testThis project is licensed under the MIT license.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in libSQL by you, shall be licensed as MIT, without any additional terms or conditions.