sqlite

🚧 A Work in Progress. Do Not Use 🚧

An experimental SQLite library for Node using Neon

Goals

APIs
- Query binding
- Connection creation and closing
- Connection pooling
- Parallel queries
- Serialization
- Traces and profiling
- Interrupting queries
- Exporting a database
Modern infrastructure
Target latest node and electron versions
Promise based API
Blob support
ESNext BigInt support
SQLite extensions support
Typescript support
Query caching support
Extensive documentation and examples using docusarus, guides and examples
Bundle sqlite if system does not have it installed
Support for larger subset of SQLite API (compared to node-sqlite3)
Better performance (compared to node-sqlite3)

Ideal API

import Sqlite from '@sqlite/sqlite';
const connector = new Sqlite();
// Creating a regular async connection
const conn = await connection.open({
  database: '/path/to/database', // ':memory:'
  verbose: true                  // process.env.NODE_ENV !== 'production'
});
// Parallel queries
await Promise.all([
  conn.run('SELECT * FROM users'),
  conn.run('UPDATE tbl SET name = ? WHERE email = ?', 'bar', 2)
]);
// Statement currying
const updateTables = await db.statement('UPDATE tbl SET name = ? WHERE email = ?');
const result = await updateTables('john', 'john@gmail.com');
console.log(result);
// Batching queries
const updateTables = await db.batch(
  `
  ATTACH DATABASE ':memory:' AS my_attached;
  BEGIN;
  CREATE TABLE my_attached.foo(x INTEGER);
  INSERT INTO my_attached.foo VALUES(42);
  END
  `;
);
const updateTables = await db.batch([
  'ATTACH DATABASE ':memory:' AS my_attached;',
  'BEGIN;',
  'CREATE TABLE my_attached.foo(x INTEGER);',
  'INSERT INTO my_attached.foo VALUES(42);',
  'END'
]);

Local Development

git clone https://github.com/sqlite-js/sqlite
cd sqlite
yarn
yarn test

Prior art

Yarn wouldn’t exist if it wasn’t for excellent prior art. Sqlite has been inspired by the following projects: