SQLite Sync

The @databases/sqlite-sync library provides a synchronous, safe and convenient API for querying SQLite databases in node.js. Built on top of better-sqlite3.

N.B. you should only have one process connected to a given SQLite database at a time.

Usage

import connect, {sql} from '@databases/sqlite-sync';
// or in CommonJS:
// const connect = require('@databases/sqlite-sync');
// const {sql} = require('@databases/sqlite-sync');

const db = connect();

console.log(db.query(sql`SELECT * FROM users;`));

For details on how to build queries, see Building SQL Queries

API

connect(fileName)

Create a database connection for a given database. You should only create one connection per database for your entire applicaiton. Normally this means having one module that creates and exports the connection pool.

In memory:

import connect from '@databases/sqlite-sync';

const db = connect();

File system:

import connect from '@databases/sqlite-sync';

const db = connect(FILE_NAME);

The Database inherits from DatabaseTransaction, so you call Database.query directly instead of having to create a transaction for every query.

DatabaseConnection.query(SQLQuery): any[]

Run an SQL Query and get a promise for an array of results.

DatabaseConnection.queryStream(SQLQuery): Iterable<any>

Run an SQL Query and get an iterable of the results. e.g.

for (const record of db.queryStream(sql`SELECT * FROM massive_table`)) {
  console.log(result);
}

DatabaseConnection.tx(fn): T

Executes a callback function as a transaction.

A transaction wraps the queries executed by the callback with additional queries:

1. it executes BEGIN just before invoking the callback function

2. it executes COMMIT, if the callback didn't throw any error

3. it executes ROLLBACK, if the callback did throw an error

const result = db.tx((transaction) => {
  const resultA = transaction.query(sql`SELECT 1 + 1 AS a`);
  const resultB = transaction.query(sql`SELECT 1 + 1 AS b`);
  return resultA[0].a + resultB[0].b;
});
// => 4

DatabaseConnection.dispose(): void

Dispose the connection pool. Once this is called, any subsequent queries will fail.