@chronicle.app/etl-sqlite 0.1.0 → 0.3.0

package/README.md

@@ -4,6 +4,28 @@ SQLite extraction with built-in `node:sqlite` on Node >=22.13.0.
 
 Extend `SqliteExtractor`, declare `source` and `strategy`, and implement `extract()` using the protected `db` connection. Pass an existing database path as `input`. Always call `teardown()` in a `finally` block, including after setup or extraction fails.
 
+`setup()` opens `input` with the protected `openDatabase(path)`. Call it from a subclass to read a different file, such as a temporary copy of a database the source app keeps exclusively locked, or a database extracted from a backup. Close and clear `this.db` before reopening; `teardown()` closes whichever connection is open.
+
+```ts
+override async setup(): Promise<void> {
+  await super.setup();
+  try {
+    this.db!.prepare('SELECT 1 FROM sqlite_schema').get();
+  } catch (err) {
+    if (!isSqliteBusy(err)) throw err;
+    this.db!.close();
+    this.db = null;
+    const copy = join(await mkdtemp(join(tmpdir(), 'source-')), 'copy.sqlite');
+    await copyFile(this.config.input, copy);
+    this.db = this.openDatabase(copy);
+  }
+}
+```
+
+`isSqliteBusy(err)` reports whether an error is SQLITE_BUSY (including extended busy codes). Opening a locked database succeeds; the first read fails.
+
+`allRows<T>(stmt, ...params)`, `getRow<T>(stmt, ...params)` and `iterateRows<T>(stmt, ...params)` wrap `all()`, `get()` and `iterate()` with a row type, so call sites need no `as unknown as T[]`. The type is not checked at runtime. `iterateRows` also keeps its statement referenced until iteration ends, so iterating `db.prepare(sql)` inline is safe. On Node 22.13, `iterate()` alone does not, and garbage collection mid-iteration throws "statement has been finalized".
+
 The connection is read-only: missing databases are not created, and journal mode is not changed. Live WAL databases require access to the database and its sidecar files; a copied database must include uncheckpointed WAL contents or be a consistent SQLite backup.
 
 `timeRangeConditions(column, range, options)` returns parameterized SQL conditions and values. The column is a trusted developer-supplied SQL identifier, not user input. Bounds are exclusive by default; conversion functions and inclusive operators are supported. Numeric dates are Unix milliseconds; the default SQL values are Unix seconds.
@@ -11,3 +33,15 @@ The connection is read-only: missing databases are not created, and journal mode
 Apple epoch helpers retain the existing API: iOS inputs/outputs use nanoseconds since 2001, Safari inputs/outputs use seconds since 2001. `iosToUnixTimestamp` returns Unix milliseconds; other Unix arguments/results use seconds.
 
 Node SQLite returns large INTEGER values only when `statement.setReadBigInts(true)` is enabled. Use that for source nanosecond timestamps and convert deliberately at the application boundary.
+
+## Porting from better-sqlite3
+
+`node:sqlite` differs from better-sqlite3 in ways that fail at runtime rather than at compile time. All of these hold on Node 22.13.0:
+
+- Parameters are spread, not passed as an array: `stmt.all(...values)`. `stmt.all(values)` throws `Unknown named parameter '0'`.
+- Booleans can't be bound (`ERR_INVALID_ARG_TYPE`). Bind `1` or `0`.
+- Reading an integer beyond `Number.MAX_SAFE_INTEGER` throws `ERR_OUT_OF_RANGE`. Call `stmt.setReadBigInts(true)`, or select the column with `CAST(column AS TEXT)`.
+- BLOBs come back as `Uint8Array`, not `Buffer`; `Buffer.isBuffer()` is false. Wrap with `Buffer.from(value.buffer, value.byteOffset, value.byteLength)` where a `Buffer` is needed.
+- Databases open read-only and their journal mode is never changed. Don't set `journal_mode` or other writing pragmas on source databases.
+
+There is no query builder. Write SQL with `?` placeholders, and build `IN (...)` lists and optional `WHERE` clauses from arrays of conditions and values, as `timeRangeConditions` does.

package/dist/SqliteExtractor.d.ts

@@ -23,6 +23,12 @@ export declare abstract class SqliteExtractor<SelfClass extends typeof SqliteExt
     }>;
     protected db: DatabaseSync | null;
     setup(): Promise<void>;
+    /**
+     * Open a database read-only without changing its journal mode. `setup()`
+     * opens `input` with this; subclasses can call it to read another file, such
+     * as a copy of a locked database, after closing and clearing `this.db`.
+     */
+    protected openDatabase(path: string): DatabaseSync;
     teardown(): Promise<void>;
 }
 //# sourceMappingURL=SqliteExtractor.d.ts.map

package/dist/SqliteExtractor.js

@@ -13,7 +13,15 @@ export class SqliteExtractor extends Extractor {
             throw new Error('Database already initialized');
         await super.setup();
         const { input } = this.config;
-        this.db = new DatabaseSync(input, { readOnly: true });
+        this.db = this.openDatabase(input);
+    }
+    /**
+     * Open a database read-only without changing its journal mode. `setup()`
+     * opens `input` with this; subclasses can call it to read another file, such
+     * as a copy of a locked database, after closing and clearing `this.db`.
+     */
+    openDatabase(path) {
+        return new DatabaseSync(path, { readOnly: true });
     }
     async teardown() {
         if (this.db) {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './SqliteExtractor.js';
+export * from './statements.js';
 export * from './timeRange.js';
 export * from './appleEpoch.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
 export * from './SqliteExtractor.js';
+export * from './statements.js';
 export * from './timeRange.js';
 export * from './appleEpoch.js';

package/dist/statements.d.ts

@@ -0,0 +1,29 @@
+import type { SQLInputValue, StatementSync } from 'node:sqlite';
+type Parameters = SQLInputValue[] | [namedParameters: Record<string, SQLInputValue>, ...anonymousParameters: SQLInputValue[]];
+/**
+ * Run a statement and type its rows. `node:sqlite` returns
+ * `Record<string, SQLOutputValue>`; `T` is the caller's description of the
+ * selected columns and is not checked at runtime.
+ */
+export declare function allRows<T>(statement: StatementSync, ...params: Parameters): T[];
+/** Run a statement and type its first row, or `undefined` when there is none. */
+export declare function getRow<T>(statement: StatementSync, ...params: Parameters): T | undefined;
+/**
+ * Run a statement and iterate its rows one at a time, typed as `T`.
+ *
+ * The generator keeps `statement` referenced until iteration ends. On Node
+ * 22.13, the iterator from `iterate()` does not, so a statement prepared inline
+ * (`iterateRows(db.prepare(sql))`) can be garbage collected mid-iteration, and
+ * the next row throws "statement has been finalized".
+ */
+export declare function iterateRows<T>(statement: StatementSync, ...params: Parameters): Generator<T>;
+/**
+ * Whether an error is SQLITE_BUSY, which `node:sqlite` reports as
+ * `{ code: 'ERR_SQLITE_ERROR', errcode: 5 }` when another connection holds a
+ * lock (for example an app that keeps its database exclusively locked).
+ * Extended result codes (primary code in the low byte), such as
+ * SQLITE_BUSY_SNAPSHOT, also match.
+ */
+export declare function isSqliteBusy(err: unknown): boolean;
+export {};
+//# sourceMappingURL=statements.d.ts.map

package/dist/statements.js

@@ -0,0 +1,37 @@
+/**
+ * Run a statement and type its rows. `node:sqlite` returns
+ * `Record<string, SQLOutputValue>`; `T` is the caller's description of the
+ * selected columns and is not checked at runtime.
+ */
+export function allRows(statement, ...params) {
+    return statement.all(...params);
+}
+/** Run a statement and type its first row, or `undefined` when there is none. */
+export function getRow(statement, ...params) {
+    return statement.get(...params);
+}
+/**
+ * Run a statement and iterate its rows one at a time, typed as `T`.
+ *
+ * The generator keeps `statement` referenced until iteration ends. On Node
+ * 22.13, the iterator from `iterate()` does not, so a statement prepared inline
+ * (`iterateRows(db.prepare(sql))`) can be garbage collected mid-iteration, and
+ * the next row throws "statement has been finalized".
+ */
+export function* iterateRows(statement, ...params) {
+    yield* statement.iterate(...params);
+}
+const SQLITE_BUSY = 5;
+/**
+ * Whether an error is SQLITE_BUSY, which `node:sqlite` reports as
+ * `{ code: 'ERR_SQLITE_ERROR', errcode: 5 }` when another connection holds a
+ * lock (for example an app that keeps its database exclusively locked).
+ * Extended result codes (primary code in the low byte), such as
+ * SQLITE_BUSY_SNAPSHOT, also match.
+ */
+export function isSqliteBusy(err) {
+    if (typeof err !== 'object' || err === null)
+        return false;
+    const { code, errcode } = err;
+    return (code === 'ERR_SQLITE_ERROR' && typeof errcode === 'number' && errcode % 256 === SQLITE_BUSY);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chronicle.app/etl-sqlite",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -19,7 +19,8 @@
   "type": "module",
   "description": "Read-only SQLite extraction using built-in node:sqlite",
   "devDependencies": {
-    "@chronicle.app/tsconfig": "0.1.0",
+    "@chronicle.app/etl": "0.3.0",
+    "@chronicle.app/tsconfig": "0.3.0",
     "@types/node": "^22.10.1",
     "typescript": "^5.7.2"
   },
@@ -34,9 +35,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@chronicle.app/etl": "0.1.0",
     "zod": "^3.24.1"
   },
+  "peerDependencies": {
+    "@chronicle.app/etl": ">=0.1.0 <1.0.0"
+  },
   "engines": {
     "node": ">=22.13.0"
   },