node:sqlite

Opens (or creates) a database: a file path, a file: URL, or ':memory:'. Every Node option is honoured — open, readOnly, enableForeignKeyConstraints, enableDoubleQuotedStringLiterals, allowExtension, timeout, readBigInts, returnArrays, allowBareNamedParameters, allowUnknownNamedParameters, defensive.

const db = new DatabaseSync(':memory:');

Opening, closing and state. Closing finalizes the database's statements; using one afterwards is ERR_INVALID_STATE, as in Node.

db.close();

exec runs one or more statements; prepare compiles a reusable statement.

const insert = db.prepare('INSERT INTO tasks (title) VALUES (?)');

The backing file of an attached database, or null for an in-memory or temporary one.

db.location();

Registers a SQL function written in TypeScript (deterministic, directOnly, useBigIntArguments, varargs). An exception it throws is rethrown from the statement that called it.

db.function('shout', (s: string) => s.toUpperCase() + '!');

Registers an aggregate (start, step, result) or, with inverse, a window function.

db.aggregate('total', { start: 0, step: (acc: number, v: number) => acc + v });

Approves, denies or ignores each action SQLite compiles (sqlite.constants.SQLITE_OK/DENY/IGNORE).

db.setAuthorizer(() => constants.SQLITE_OK);

Records changes as a changeset or patchset and applies one elsewhere, with filter and conflict handlers.

const session = db.createSession();

Loads a SQLite extension, when the database was opened with allowExtension.

db.enableLoadExtension(true);

Snapshots a database to bytes and restores one from them.

const image = db.serialize();

Prepared statements cached by tagged-template SQL.

const sql = db.createTagStore();

Rows are null-prototype objects (arrays with returnArrays); get() is undefined without a row; iterate() steps lazily.

const rows = db.prepare('SELECT * FROM tasks').all();

Each result column's name, declared type and origin database/table/column; the statement's SQL, and its SQL with the bound values.

stmt.columns();

Per-statement versions of the database's reading and binding options.

stmt.setReadBigInts(true);

Positional ? parameters, or a leading object binding :x/@x/$x (and the bare key). Numbers bind as REAL and bigints as INTEGER, as in Node.

db.prepare('SELECT title FROM tasks WHERE id = :id').get({ id: 2 });

An INTEGER past 2^53 is ERR_OUT_OF_RANGE unless readBigInts is set.

stmt.setReadBigInts(true);

SQLite failures throw an Error with code ERR_SQLITE_ERROR, errcode and errstr, as Node's.

try { db.exec('bogus'); } catch (e) { e.errcode; }

Copies a database into a file a few pages per turn of the event loop, reporting progress; resolves the total page count.

await backup(db, 'copy.db');