@effect/sql-sqlite-node 4.0.0-beta.105 → 4.0.0-beta.107
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/SqliteClient.d.ts +8 -2
- package/dist/SqliteClient.d.ts.map +1 -1
- package/dist/SqliteClient.js +13 -4
- package/dist/SqliteClient.js.map +1 -1
- package/package.json +4 -4
- package/src/SqliteClient.ts +23 -5
package/dist/SqliteClient.d.ts
CHANGED
|
@@ -53,7 +53,7 @@ export interface BackupMetadata {
|
|
|
53
53
|
*/
|
|
54
54
|
export declare const SqliteClient: Context.Service<SqliteClient, SqliteClient>;
|
|
55
55
|
/**
|
|
56
|
-
* Configuration for a node SQLite client backed by `node:sqlite`, including the database filename, read-only mode, statement cache settings, WAL behavior, span attributes, and query/result name transforms.
|
|
56
|
+
* Configuration for a node SQLite client backed by `node:sqlite`, including the database filename, read-only mode, statement cache settings, WAL and busy timeout behavior, span attributes, and query/result name transforms.
|
|
57
57
|
*
|
|
58
58
|
* @category models
|
|
59
59
|
* @since 4.0.0
|
|
@@ -64,12 +64,18 @@ export interface SqliteClientConfig {
|
|
|
64
64
|
readonly prepareCacheSize?: number | undefined;
|
|
65
65
|
readonly prepareCacheTTL?: Duration.Input | undefined;
|
|
66
66
|
readonly disableWAL?: boolean | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* How long SQLite waits when the database is busy. Defaults to 5 seconds.
|
|
69
|
+
* `Duration.infinity` is clamped to SQLite's maximum timeout.
|
|
70
|
+
* Waiting blocks the Node.js event loop because `node:sqlite` is synchronous.
|
|
71
|
+
*/
|
|
72
|
+
readonly busyTimeout?: Duration.Input | undefined;
|
|
67
73
|
readonly spanAttributes?: Record<string, unknown> | undefined;
|
|
68
74
|
readonly transformResultNames?: ((str: string) => string) | undefined;
|
|
69
75
|
readonly transformQueryNames?: ((str: string) => string) | undefined;
|
|
70
76
|
}
|
|
71
77
|
/**
|
|
72
|
-
* Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL enabled by default
|
|
78
|
+
* Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL and a 5-second busy timeout enabled by default. Explicit transactions on writable connections take the write lock for their duration, even when they only read; clients opened with `readonly: true` are unaffected.
|
|
73
79
|
*
|
|
74
80
|
* @category constructors
|
|
75
81
|
* @since 4.0.0
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SqliteClient.d.ts","sourceRoot":"","sources":["../src/SqliteClient.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"SqliteClient.d.ts","sourceRoot":"","sources":["../src/SqliteClient.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAGrC,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAA;AACnE,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAA;AAEvD,OAAO,EAAuB,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AAQ5E;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAAgD,CAAA;AAErE;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,uCAAuC,CAAA;AAE5D;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,SAAS;IACpD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAA;IACnC,QAAQ,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IACjF,QAAQ,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IAEvE,8BAA8B;IAC9B,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,6CAAwE,CAAA;AAEjG;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACvC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACzC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAE7D,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;IACrE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;CACrE;AAOD;;;;;GAKG;AACH,eAAO,MAAM,IAAI,YACN,kBAAkB,KAC1B,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,UAAU,CAkNrE,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,WAAW,WACd,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,KACtC,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAUzB,CAAA;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,KAAK,WACR,kBAAkB,KACzB,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,CAML,CAAA"}
|
package/dist/SqliteClient.js
CHANGED
|
@@ -3,9 +3,14 @@
|
|
|
3
3
|
*
|
|
4
4
|
* This module opens a SQLite database and exposes it as both `SqliteClient` and
|
|
5
5
|
* the generic Effect SQL client. It serializes access through one connection,
|
|
6
|
-
* caches prepared statements, enables WAL mode unless disabled, and
|
|
7
|
-
*
|
|
8
|
-
* `
|
|
6
|
+
* caches prepared statements, enables WAL mode unless disabled, and waits up
|
|
7
|
+
* to five seconds for busy databases by default. Explicit transactions on
|
|
8
|
+
* writable connections use `BEGIN IMMEDIATE` to avoid read-to-write lock
|
|
9
|
+
* upgrades, which serializes them behind other writers even when they only
|
|
10
|
+
* read. Clients opened with `readonly: true` are unaffected. Busy waits block
|
|
11
|
+
* the Node.js event loop because `node:sqlite` is synchronous. Database backup
|
|
12
|
+
* and extension loading are supported; streaming queries and `updateValues`
|
|
13
|
+
* are not.
|
|
9
14
|
*
|
|
10
15
|
* @since 4.0.0
|
|
11
16
|
*/
|
|
@@ -26,6 +31,7 @@ import { classifySqliteError, SqlError } from "effect/unstable/sql/SqlError";
|
|
|
26
31
|
import * as Statement from "effect/unstable/sql/Statement";
|
|
27
32
|
import { backup as backupDatabase, DatabaseSync } from "node:sqlite";
|
|
28
33
|
const ATTR_DB_SYSTEM_NAME = "db.system.name";
|
|
34
|
+
const MAX_BUSY_TIMEOUT = 2_147_483_647;
|
|
29
35
|
/**
|
|
30
36
|
* Runtime type identifier used to mark Node `SqliteClient` values.
|
|
31
37
|
*
|
|
@@ -41,7 +47,7 @@ export const TypeId = "~@effect/sql-sqlite-node/SqliteClient";
|
|
|
41
47
|
*/
|
|
42
48
|
export const SqliteClient = /*#__PURE__*/Context.Service("@effect/sql-sqlite-node/SqliteClient");
|
|
43
49
|
/**
|
|
44
|
-
* Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL enabled by default
|
|
50
|
+
* Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL and a 5-second busy timeout enabled by default. Explicit transactions on writable connections take the write lock for their duration, even when they only read; clients opened with `readonly: true` are unaffected.
|
|
45
51
|
*
|
|
46
52
|
* @category constructors
|
|
47
53
|
* @since 4.0.0
|
|
@@ -57,6 +63,8 @@ export const make = options => Effect.gen(function* () {
|
|
|
57
63
|
});
|
|
58
64
|
yield* Scope.addFinalizer(scope, Effect.sync(() => db.close()));
|
|
59
65
|
db.enableLoadExtension(false);
|
|
66
|
+
const busyTimeout = Math.min(MAX_BUSY_TIMEOUT, Math.max(0, Math.round(Duration.toMillis(options.busyTimeout ?? Duration.seconds(5)))));
|
|
67
|
+
db.exec(`PRAGMA busy_timeout = ${busyTimeout}`);
|
|
60
68
|
if (options.disableWAL !== true) {
|
|
61
69
|
db.exec("PRAGMA journal_mode = WAL");
|
|
62
70
|
}
|
|
@@ -188,6 +196,7 @@ export const make = options => Effect.gen(function* () {
|
|
|
188
196
|
acquirer,
|
|
189
197
|
compiler,
|
|
190
198
|
transactionAcquirer,
|
|
199
|
+
beginTransaction: "BEGIN IMMEDIATE",
|
|
191
200
|
spanAttributes: [...(options.spanAttributes ? Object.entries(options.spanAttributes) : []), [ATTR_DB_SYSTEM_NAME, "sqlite"]],
|
|
192
201
|
transformRows
|
|
193
202
|
}), {
|
package/dist/SqliteClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SqliteClient.js","names":[],"sources":["../src/SqliteClient.ts"],"sourcesContent":[null],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"SqliteClient.js","names":[],"sources":["../src/SqliteClient.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;AAgBA,OAAO,KAAK,KAAK,MAAM,cAAc;AACrC,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAK,QAAQ,MAAM,iBAAiB;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc;AACrC,SAAS,QAAQ,QAAQ,iBAAiB;AAC1C,OAAO,KAAK,KAAK,MAAM,cAAc;AACrC,OAAO,KAAK,KAAK,MAAM,cAAc;AACrC,OAAO,KAAK,SAAS,MAAM,kBAAkB;AAC7C,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,UAAU,MAAM,uCAAuC;AACnE,OAAO,KAAK,MAAM,MAAM,+BAA+B;AAEvD,SAAS,mBAAmB,EAAE,QAAQ,QAAQ,8BAA8B;AAC5E,OAAO,KAAK,SAAS,MAAM,+BAA+B;AAC1D,SAAS,MAAM,IAAI,cAAc,EAAE,YAAY,QAAQ,aAAa;AAGpE,MAAM,mBAAmB,GAAG,gBAAgB;AAC5C,MAAM,gBAAgB,GAAG,aAAa;AAEtC;;;;;;AAMA,OAAO,MAAM,MAAM,GAAW,uCAAuC;AAqCrE;;;;;;AAMA,OAAO,MAAM,YAAY,gBAAG,OAAO,CAAC,OAAO,CAAe,sCAAsC,CAAC;AA+BjG;;;;;;AAMA,OAAO,MAAM,IAAI,GACf,OAA2B,IAE3B,MAAM,CAAC,GAAG,CAAC,aAAS;EAClB,MAAM,QAAQ,GAAG,SAAS,CAAC,kBAAkB,CAAC,OAAO,CAAC,mBAAmB,CAAC;EAC1E,MAAM,aAAa,GAAG,OAAO,CAAC,oBAAoB,GAChD,SAAS,CAAC,iBAAiB,CACzB,OAAO,CAAC,oBAAoB,CAC7B,CAAC,KAAK,GACP,SAAS;EAEX,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,aAAS;IACzC,MAAM,KAAK,GAAG,OAAO,MAAM,CAAC,KAAK;IACjC,MAAM,EAAE,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE;MAC5C,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;MACnC,cAAc,EAAE;KACjB,CAAC;IACF,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/D,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC;IAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAC1B,gBAAgB,EAChB,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACvF;IACD,EAAE,CAAC,IAAI,CAAC,yBAAyB,WAAW,EAAE,CAAC;IAE/C,IAAI,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE;MAC/B,EAAE,CAAC,IAAI,CAAC,2BAA2B,CAAC;IACtC;IAEA,MAAM,YAAY,GAAG,OAAO,KAAK,CAAC,IAAI,CAAC;MACrC,QAAQ,EAAE,OAAO,CAAC,gBAAgB,IAAI,GAAG;MACzC,UAAU,EAAE,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;MAC3D,MAAM,EAAG,GAAW,IAClB,MAAM,CAAC,GAAG,CAAC;QACT,GAAG,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;QAC1B,KAAK,EAAG,KAAK,IAAK,IAAI,QAAQ,CAAC;UAAE,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,SAAS;QAAC,CAAE;OAC1G;KACJ,CAAC;IAEF,MAAM,YAAY,GAAG,CACnB,SAAwB,EACxB,MAA8B,EAC9B,GAAY,KAEZ,MAAM,CAAC,SAAS,CAAgC,KAAK,IAAI;MACvD,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC;MACvE,OAAO,MAAM,CAAC,GAAG,CAAC;QAChB,GAAG,EAAE,MAAK;UACR,SAAS,CAAC,cAAc,CAAC,eAAe,CAAC;UACzC,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;YAClC,OAAO,SAAS,CAAC,GAAG,CAAC,GAAI,MAAqB,CAAuB;UACvE;UACA,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,GAAI,MAAqB,CAAC;UACvD,OAAO,GAAG,GAAG;YAAE,OAAO,EAAE,MAAM,CAAC,OAAO;YAAE,eAAe,EAAE,MAAM,CAAC;UAAe,CAAS,GAAG,EAAE;QAC/F,CAAC;QACD,KAAK,EAAG,KAAK,IAAK,IAAI,QAAQ,CAAC;UAAE,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,SAAS;QAAC,CAAE;OAC1G,CAAC;IACJ,CAAC,CAAC;IAEJ,MAAM,kBAAkB,GAAG,CACzB,SAAwB,EACxB,MAA8B,KAE9B,MAAM,CAAC,SAAS,CAAmD,KAAK,IAAI;MAC1E,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC;MACvE,OAAO,MAAM,CAAC,GAAG,CAAC;QAChB,GAAG,EAAE,MAAK;UACR,SAAS,CAAC,cAAc,CAAC,eAAe,CAAC;UACzC,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;YAClC,OAAO,SAAS,CAAC,GAAG,CAAC,GAAI,MAAqB,CAAqD;UACrG;UACA,SAAS,CAAC,GAAG,CAAC,GAAI,MAAqB,CAAC;UACxC,OAAO,EAAE;QACX,CAAC;QACD,KAAK,EAAG,KAAK,IAAK,IAAI,QAAQ,CAAC;UAAE,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,SAAS;QAAC,CAAE;OAC1G,CAAC;IACJ,CAAC,CAAC;IAEJ,MAAM,4BAA4B,GAAG,CACnC,SAAwB,EACxB,MAA8B,KAE9B,MAAM,CAAC,SAAS,CAAmD,KAAK,IAAI;MAC1E,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,YAAY,CAAC;MACvE,OAAO,MAAM,CAAC,GAAG,CAAC;QAChB,GAAG,EAAE,MAAK;UACR,SAAS,CAAC,cAAc,CAAC,eAAe,CAAC;UACzC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC;UAC/B,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;YAClC,OAAO,SAAS,CAAC,GAAG,CAAC,GAAI,MAAqB,CAAqD;UACrG;UACA,SAAS,CAAC,GAAG,CAAC,GAAI,MAAqB,CAAC;UACxC,OAAO,EAAE;QACX,CAAC;QACD,KAAK,EAAG,KAAK,IAAK,IAAI,QAAQ,CAAC;UAAE,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,SAAS;QAAC,CAAE;OAC1G,CAAC;IACJ,CAAC,CAAC;IAEJ,MAAM,GAAG,GAAG,CACV,GAAW,EACX,MAA8B,EAC9B,GAAG,GAAG,KAAK,KAEX,MAAM,CAAC,OAAO,CACZ,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,EAC3B,CAAC,IAAK,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CACpC;IAEH,MAAM,SAAS,GAAG,CAChB,GAAW,EACX,MAA8B,KAE9B,MAAM,CAAC,iBAAiB,CACtB,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,EAC3B,SAAS,IAAI;MACZ,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC;MAC/B,OAAO,kBAAkB,CAAC,SAAS,EAAE,MAAM,CAAC;IAC9C,CAAC,EACA,SAAS,IAAK,MAAM,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CACnE;IAEH,MAAM,mBAAmB,GAAG,CAC1B,GAAW,EACX,MAA8B,KAC3B,4BAA4B,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAE1D,OAAO,QAAQ,CAAmB;MAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa;QAChC,OAAO,aAAa,GAChB,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,aAAa,CAAC,GAC3C,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC;MACtB,CAAC;MACD,UAAU,CAAC,GAAG,EAAE,MAAM;QACpB,OAAO,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC;MAC/B,CAAC;MACD,aAAa,CAAC,GAAG,EAAE,MAAM;QACvB,OAAO,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC;MAC/B,CAAC;MACD,uBAAuB,CAAC,GAAG,EAAE,MAAM;QACjC,OAAO,mBAAmB,CAAC,GAAG,EAAE,MAAM,CAAC;MACzC,CAAC;MACD,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa;QAC1C,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,EAAE,EAAE,KAAK,CAAC;QACjE,OAAO,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,MAAM;MACnE,CAAC;MACD,aAAa,CAAC,IAAI,EAAE,OAAO;QACzB,OAAO,MAAM,CAAC,GAAG,CAAC,+BAA+B,CAAC;MACpD,CAAC;MACD,MAAM,CAAC,WAAW;QAChB,OAAO,MAAM,CAAC,OAAO,CAAC,MAAK;UACzB,IAAI,UAAU,GAAG,CAAC;UAClB,OAAO,MAAM,CAAC,UAAU,CAAC;YACvB,GAAG,EAAE,MACH,cAAc,CAAC,EAAE,EAAE,WAAW,EAAE;cAC9B,QAAQ,EAAG,QAAQ,IAAI;gBACrB,UAAU,GAAG,QAAQ,CAAC,UAAU;cAClC;aACD,CAAC,CAAC,IAAI,CAAE,KAAK,KAAsB;cAAE,UAAU,EAAE,UAAU,IAAI,KAAK;cAAE,cAAc,EAAE;YAAC,CAAE,CAAC,CAAC;YAC9F,KAAK,EAAG,KAAK,IAAK,IAAI,QAAQ,CAAC;cAAE,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,2BAA2B,EAAE,QAAQ;YAAC,CAAE;WACvG,CAAC;QACJ,CAAC,CAAC;MACJ,CAAC;MACD,aAAa,CAAC,IAAI;QAChB,OAAO,MAAM,CAAC,iBAAiB,CAC7B,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAC/C,MACE,MAAM,CAAC,GAAG,CAAC;UACT,GAAG,EAAE,MAAM,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC;UACjC,KAAK,EAAG,KAAK,IACX,IAAI,QAAQ,CAAC;YAAE,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,0BAA0B,EAAE,eAAe;UAAC,CAAE;SAC7F,CAAC,EACJ,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CACvD;MACH;KACD,CAAC;EACJ,CAAC,CAAC;EAEF,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;EAC1C,MAAM,UAAU,GAAG,OAAO,cAAc;EAExC,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;EACrE,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAE,OAAO,IAAI;IACjE,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,EAAG;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC;IAC3D,OAAO,MAAM,CAAC,EAAE,CACd,MAAM,CAAC,GAAG,CACR,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAC1B,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CACtD,EACD,UAAU,CACX;EACH,CAAC,CAAC;EAEF,OAAO,MAAM,CAAC,MAAM,CACjB,OAAO,MAAM,CAAC,IAAI,CAAC;IAClB,QAAQ;IACR,QAAQ;IACR,mBAAmB;IACnB,gBAAgB,EAAE,iBAAiB;IACnC,cAAc,EAAE,CACd,IAAI,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,EACzE,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAChC;IACD;GACD,CAAC,EACF;IACE,CAAC,MAAM,GAAG,MAAgB;IAC1B,MAAM,EAAE,OAAO;IACf,MAAM,EAAG,WAAmB,IAAK,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAG,CAAC,IAAK,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACvF,aAAa,EAAG,IAAY,IAAK,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAG,CAAC,IAAK,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;GACvF,CACF;AACH,CAAC,CAAC;AAEJ;;;;;;AAMA,OAAO,MAAM,WAAW,GACtB,MAAuC,IAEvC,KAAK,CAAC,aAAa,CACjB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACxB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EACpB,MAAM,CAAC,GAAG,CAAE,MAAM,IAChB,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,IAAI,CACrC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CACtC,CACF,CACF,CACF,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAEzC;;;;;;AAMA,OAAO,MAAM,KAAK,GAChB,MAA0B,IAE1B,KAAK,CAAC,aAAa,CACjB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAG,MAAM,IAC9B,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,IAAI,CACrC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CACtC,CAAC,CACL,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAEzC;AAEA,MAAM,aAAa,GAAG,CAAC,KAAc,EAAE,OAAe,EAAE,SAAiB,KACvE,mBAAmB,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE;EAAE,OAAO;EAAE;AAAS,CAAE,CAAC;AAE1E,MAAM,oBAAoB,GAAI,KAAc,IAAa;EACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,EAAE,SAAS,IAAI,KAAK,CAAC,IAAI,OAAO,IAAI,KAAK,EAAE;IAC5F,OAAO,KAAK;EACd;EACA,MAAM,OAAO,GAAI,KAAuC,CAAC,OAAO;EAChE,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;IAC/B,OAAO,KAAK;EACd;EACA,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;IAAE,KAAK,EAAE;EAAO,CAAE,CAAC;AACjD,CAAC","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effect/sql-sqlite-node",
|
|
3
|
-
"version": "4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-beta.107",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "A SQLite toolkit for Effect",
|
|
@@ -48,11 +48,11 @@
|
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@types/node": "^26.1.2",
|
|
51
|
-
"@effect/platform-node": "^4.0.0-beta.
|
|
52
|
-
"effect": "^4.0.0-beta.
|
|
51
|
+
"@effect/platform-node": "^4.0.0-beta.107",
|
|
52
|
+
"effect": "^4.0.0-beta.107"
|
|
53
53
|
},
|
|
54
54
|
"peerDependencies": {
|
|
55
|
-
"effect": "^4.0.0-beta.
|
|
55
|
+
"effect": "^4.0.0-beta.107"
|
|
56
56
|
},
|
|
57
57
|
"scripts": {
|
|
58
58
|
"codegen": "effect-utils codegen",
|
package/src/SqliteClient.ts
CHANGED
|
@@ -3,9 +3,14 @@
|
|
|
3
3
|
*
|
|
4
4
|
* This module opens a SQLite database and exposes it as both `SqliteClient` and
|
|
5
5
|
* the generic Effect SQL client. It serializes access through one connection,
|
|
6
|
-
* caches prepared statements, enables WAL mode unless disabled, and
|
|
7
|
-
*
|
|
8
|
-
* `
|
|
6
|
+
* caches prepared statements, enables WAL mode unless disabled, and waits up
|
|
7
|
+
* to five seconds for busy databases by default. Explicit transactions on
|
|
8
|
+
* writable connections use `BEGIN IMMEDIATE` to avoid read-to-write lock
|
|
9
|
+
* upgrades, which serializes them behind other writers even when they only
|
|
10
|
+
* read. Clients opened with `readonly: true` are unaffected. Busy waits block
|
|
11
|
+
* the Node.js event loop because `node:sqlite` is synchronous. Database backup
|
|
12
|
+
* and extension loading are supported; streaming queries and `updateValues`
|
|
13
|
+
* are not.
|
|
9
14
|
*
|
|
10
15
|
* @since 4.0.0
|
|
11
16
|
*/
|
|
@@ -29,6 +34,7 @@ import { backup as backupDatabase, DatabaseSync } from "node:sqlite"
|
|
|
29
34
|
import type { StatementSync } from "node:sqlite"
|
|
30
35
|
|
|
31
36
|
const ATTR_DB_SYSTEM_NAME = "db.system.name"
|
|
37
|
+
const MAX_BUSY_TIMEOUT = 2_147_483_647
|
|
32
38
|
|
|
33
39
|
/**
|
|
34
40
|
* Runtime type identifier used to mark Node `SqliteClient` values.
|
|
@@ -82,7 +88,7 @@ export interface BackupMetadata {
|
|
|
82
88
|
export const SqliteClient = Context.Service<SqliteClient>("@effect/sql-sqlite-node/SqliteClient")
|
|
83
89
|
|
|
84
90
|
/**
|
|
85
|
-
* Configuration for a node SQLite client backed by `node:sqlite`, including the database filename, read-only mode, statement cache settings, WAL behavior, span attributes, and query/result name transforms.
|
|
91
|
+
* Configuration for a node SQLite client backed by `node:sqlite`, including the database filename, read-only mode, statement cache settings, WAL and busy timeout behavior, span attributes, and query/result name transforms.
|
|
86
92
|
*
|
|
87
93
|
* @category models
|
|
88
94
|
* @since 4.0.0
|
|
@@ -93,6 +99,12 @@ export interface SqliteClientConfig {
|
|
|
93
99
|
readonly prepareCacheSize?: number | undefined
|
|
94
100
|
readonly prepareCacheTTL?: Duration.Input | undefined
|
|
95
101
|
readonly disableWAL?: boolean | undefined
|
|
102
|
+
/**
|
|
103
|
+
* How long SQLite waits when the database is busy. Defaults to 5 seconds.
|
|
104
|
+
* `Duration.infinity` is clamped to SQLite's maximum timeout.
|
|
105
|
+
* Waiting blocks the Node.js event loop because `node:sqlite` is synchronous.
|
|
106
|
+
*/
|
|
107
|
+
readonly busyTimeout?: Duration.Input | undefined
|
|
96
108
|
readonly spanAttributes?: Record<string, unknown> | undefined
|
|
97
109
|
|
|
98
110
|
readonly transformResultNames?: ((str: string) => string) | undefined
|
|
@@ -105,7 +117,7 @@ interface SqliteConnection extends Connection {
|
|
|
105
117
|
}
|
|
106
118
|
|
|
107
119
|
/**
|
|
108
|
-
* Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL enabled by default
|
|
120
|
+
* Creates a scoped node SQLite client from the supplied configuration, using a single serialized connection with WAL and a 5-second busy timeout enabled by default. Explicit transactions on writable connections take the write lock for their duration, even when they only read; clients opened with `readonly: true` are unaffected.
|
|
109
121
|
*
|
|
110
122
|
* @category constructors
|
|
111
123
|
* @since 4.0.0
|
|
@@ -129,6 +141,11 @@ export const make = (
|
|
|
129
141
|
})
|
|
130
142
|
yield* Scope.addFinalizer(scope, Effect.sync(() => db.close()))
|
|
131
143
|
db.enableLoadExtension(false)
|
|
144
|
+
const busyTimeout = Math.min(
|
|
145
|
+
MAX_BUSY_TIMEOUT,
|
|
146
|
+
Math.max(0, Math.round(Duration.toMillis(options.busyTimeout ?? Duration.seconds(5))))
|
|
147
|
+
)
|
|
148
|
+
db.exec(`PRAGMA busy_timeout = ${busyTimeout}`)
|
|
132
149
|
|
|
133
150
|
if (options.disableWAL !== true) {
|
|
134
151
|
db.exec("PRAGMA journal_mode = WAL")
|
|
@@ -303,6 +320,7 @@ export const make = (
|
|
|
303
320
|
acquirer,
|
|
304
321
|
compiler,
|
|
305
322
|
transactionAcquirer,
|
|
323
|
+
beginTransaction: "BEGIN IMMEDIATE",
|
|
306
324
|
spanAttributes: [
|
|
307
325
|
...(options.spanAttributes ? Object.entries(options.spanAttributes) : []),
|
|
308
326
|
[ATTR_DB_SYSTEM_NAME, "sqlite"]
|