@effect/sql-sqlite-do 4.0.0-beta.70 → 4.0.0-beta.71
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 +29 -15
- package/dist/SqliteClient.d.ts.map +1 -1
- package/dist/SqliteClient.js.map +1 -1
- package/dist/index.d.ts +0 -39
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -39
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/SqliteClient.ts +29 -15
- package/src/index.ts +0 -39
package/dist/SqliteClient.d.ts
CHANGED
|
@@ -1,21 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Effect SQL client for Cloudflare Durable Object SQLite storage.
|
|
3
3
|
*
|
|
4
4
|
* This module adapts a Durable Object `SqlStorage` handle into both the
|
|
5
|
-
* Durable Object-specific
|
|
6
|
-
* `SqlClient` service. Use it
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
5
|
+
* Durable Object-specific {@link SqliteClient} service and the generic Effect
|
|
6
|
+
* SQL `SqlClient` service. Use it inside a Durable Object for per-object
|
|
7
|
+
* queries, repositories, migrations, transactional read/write workflows, and
|
|
8
|
+
* tests that exercise Cloudflare's SQLite-backed storage API.
|
|
9
|
+
*
|
|
10
|
+
* **Mental model**
|
|
11
|
+
*
|
|
12
|
+
* Durable Object storage is scoped to one object id. Each object instance has
|
|
13
|
+
* its own database, and {@link make} wraps the same `SqlStorage` handle that
|
|
14
|
+
* the object uses for normal reads and writes. Effect SQL access is serialized
|
|
15
|
+
* through one connection; a transaction keeps that permit for the lifetime of
|
|
16
|
+
* its scope.
|
|
17
|
+
*
|
|
18
|
+
* **Common tasks**
|
|
19
|
+
*
|
|
20
|
+
* Use {@link layer} when the Durable Object constructor already has a concrete
|
|
21
|
+
* `SqlStorage` handle. Use {@link layerConfig} when the handle and transform
|
|
22
|
+
* options should be supplied through Effect `Config`. Keep using generic
|
|
23
|
+
* `SqlClient` APIs for ordinary SQL, and depend on {@link SqliteClient} when
|
|
24
|
+
* code needs the Durable Object-specific service identity.
|
|
25
|
+
*
|
|
26
|
+
* **Gotchas**
|
|
27
|
+
*
|
|
28
|
+
* Keep transactions short and avoid suspending them across unrelated work,
|
|
29
|
+
* because all access through one client waits on the same serialized
|
|
30
|
+
* connection. `SqlStorage.exec` returns SQLite blob values as `ArrayBuffer`,
|
|
31
|
+
* which this client normalizes to `Uint8Array`. SQLite does not support
|
|
32
|
+
* `updateValues`.
|
|
19
33
|
*
|
|
20
34
|
* @since 4.0.0
|
|
21
35
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SqliteClient.d.ts","sourceRoot":"","sources":["../src/SqliteClient.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"SqliteClient.d.ts","sourceRoot":"","sources":["../src/SqliteClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,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;AAUvD;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE,MAA8C,CAAA;AAEnE;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,qCAAqC,CAAA;AAE1D;;;;;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;IAEnC,8BAA8B;IAC9B,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAA;CAC7B;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,6CAAsE,CAAA;AAE/F;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAA;IACvB,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;AAED;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GACf,SAAS,kBAAkB,KAC1B,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,UAAU,CAmHrE,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,QAAQ,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,GAChB,QAAQ,kBAAkB,KACzB,KAAK,CAAC,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,CAML,CAAA"}
|
package/dist/SqliteClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SqliteClient.js","names":["Config","Context","Effect","Fiber","identity","Layer","Scope","Semaphore","Stream","Reactivity","Client","classifySqliteError","SqlError","Statement","ATTR_DB_SYSTEM_NAME","classifyError","cause","message","operation","TypeId","SqliteClient","Service","make","options","gen","compiler","makeCompilerSqlite","transformQueryNames","transformRows","transformResultNames","defaultTransforms","array","undefined","makeConnection","db","runIterator","sql","params","cursor","exec","columns","columnNames","result","raw","obj","i","length","value","ArrayBuffer","Uint8Array","runStatement","try","Array","from","catch","reason","runValues","row","execute","map","executeRaw","executeValues","executeUnprepared","executeStream","suspend","iterator","fromIteratorSucceed","pipe","mapArray","chunk","semaphore","connection","acquirer","withPermits","succeed","transactionAcquirer","uninterruptibleMask","restore","fiber","getCurrent","scope","getUnsafe","context","as","tap","take","addFinalizer","release","Object","assign","spanAttributes","entries","config","layerConfig","effectContext","unwrap","flatMap","client","add","SqlClient","provide","layer"],"sources":["../src/SqliteClient.ts"],"sourcesContent":[null],"mappings":"
|
|
1
|
+
{"version":3,"file":"SqliteClient.js","names":["Config","Context","Effect","Fiber","identity","Layer","Scope","Semaphore","Stream","Reactivity","Client","classifySqliteError","SqlError","Statement","ATTR_DB_SYSTEM_NAME","classifyError","cause","message","operation","TypeId","SqliteClient","Service","make","options","gen","compiler","makeCompilerSqlite","transformQueryNames","transformRows","transformResultNames","defaultTransforms","array","undefined","makeConnection","db","runIterator","sql","params","cursor","exec","columns","columnNames","result","raw","obj","i","length","value","ArrayBuffer","Uint8Array","runStatement","try","Array","from","catch","reason","runValues","row","execute","map","executeRaw","executeValues","executeUnprepared","executeStream","suspend","iterator","fromIteratorSucceed","pipe","mapArray","chunk","semaphore","connection","acquirer","withPermits","succeed","transactionAcquirer","uninterruptibleMask","restore","fiber","getCurrent","scope","getUnsafe","context","as","tap","take","addFinalizer","release","Object","assign","spanAttributes","entries","config","layerConfig","effectContext","unwrap","flatMap","client","add","SqlClient","provide","layer"],"sources":["../src/SqliteClient.ts"],"sourcesContent":[null],"mappings":"AAoCA,OAAO,KAAKA,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,SAASC,QAAQ,QAAQ,iBAAiB;AAC1C,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAC7C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,UAAU,MAAM,uCAAuC;AACnE,OAAO,KAAKC,MAAM,MAAM,+BAA+B;AAEvD,SAASC,mBAAmB,EAAEC,QAAQ,QAAQ,8BAA8B;AAC5E,OAAO,KAAKC,SAAS,MAAM,+BAA+B;AAE1D,MAAMC,mBAAmB,GAAG,gBAAgB;AAE5C,MAAMC,aAAa,GAAGA,CAACC,KAAc,EAAEC,OAAe,EAAEC,SAAiB,KACvEP,mBAAmB,CAACK,KAAK,EAAE;EAAEC,OAAO;EAAEC;AAAS,CAAE,CAAC;AAEpD;;;;;;AAMA,OAAO,MAAMC,MAAM,GAAW,qCAAqC;AAwBnE;;;;;;AAMA,OAAO,MAAMC,YAAY,gBAAGnB,OAAO,CAACoB,OAAO,CAAe,oCAAoC,CAAC;AAgB/F;;;;;;AAMA,OAAO,MAAMC,IAAI,GACfC,OAA2B,IAE3BrB,MAAM,CAACsB,GAAG,CAAC,aAAS;EAClB,MAAMC,QAAQ,GAAGZ,SAAS,CAACa,kBAAkB,CAACH,OAAO,CAACI,mBAAmB,CAAC;EAC1E,MAAMC,aAAa,GAAGL,OAAO,CAACM,oBAAoB,GAC9ChB,SAAS,CAACiB,iBAAiB,CAACP,OAAO,CAACM,oBAAoB,CAAC,CAACE,KAAK,GAC/DC,SAAS;EAEb,MAAMC,cAAc,GAAG/B,MAAM,CAACsB,GAAG,CAAC,aAAS;IACzC,MAAMU,EAAE,GAAGX,OAAO,CAACW,EAAE;IAErB,UAAUC,WAAWA,CACnBC,GAAW,EACXC,MAAA,GAAiC,EAAE;MAEnC,MAAMC,MAAM,GAAGJ,EAAE,CAACK,IAAI,CAACH,GAAG,EAAE,GAAGC,MAAM,CAAC;MACtC,MAAMG,OAAO,GAAGF,MAAM,CAACG,WAAW;MAClC,KAAK,MAAMC,MAAM,IAAIJ,MAAM,CAACK,GAAG,EAAE,EAAE;QACjC,MAAMC,GAAG,GAAQ,EAAE;QACnB,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGL,OAAO,CAACM,MAAM,EAAED,CAAC,EAAE,EAAE;UACvC,MAAME,KAAK,GAAGL,MAAM,CAACG,CAAC,CAAC;UACvBD,GAAG,CAACJ,OAAO,CAACK,CAAC,CAAC,CAAC,GAAGE,KAAK,YAAYC,WAAW,GAAG,IAAIC,UAAU,CAACF,KAAK,CAAC,GAAGA,KAAK;QAChF;QACA,MAAMH,GAAG;MACX;IACF;IAEA,MAAMM,YAAY,GAAGA,CACnBd,GAAW,EACXC,MAAA,GAAiC,EAAE,KAEnCnC,MAAM,CAACiD,GAAG,CAAC;MACTA,GAAG,EAAEA,CAAA,KAAMC,KAAK,CAACC,IAAI,CAAClB,WAAW,CAACC,GAAG,EAAEC,MAAM,CAAC,CAAC;MAC/CiB,KAAK,EAAGtC,KAAK,IAAK,IAAIJ,QAAQ,CAAC;QAAE2C,MAAM,EAAExC,aAAa,CAACC,KAAK,EAAE,6BAA6B,EAAE,SAAS;MAAC,CAAE;KAC1G,CAAC;IAEJ,MAAMwC,SAAS,GAAGA,CAChBpB,GAAW,EACXC,MAAA,GAAiC,EAAE,KAEnCnC,MAAM,CAACiD,GAAG,CAAC;MACTA,GAAG,EAAEA,CAAA,KACHC,KAAK,CAACC,IAAI,CAACnB,EAAE,CAACK,IAAI,CAACH,GAAG,EAAE,GAAGC,MAAM,CAAC,CAACM,GAAG,EAAE,EAAGc,GAAG,IAAI;QAChD,KAAK,IAAIZ,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGY,GAAG,CAACX,MAAM,EAAED,CAAC,EAAE,EAAE;UACnC,MAAME,KAAK,GAAGU,GAAG,CAACZ,CAAC,CAAC;UACpB,IAAIE,KAAK,YAAYC,WAAW,EAAE;YAChCS,GAAG,CAACZ,CAAC,CAAC,GAAG,IAAII,UAAU,CAACF,KAAK,CAAQ;UACvC;QACF;QACA,OAAOU,GAAG;MACZ,CAAC,CAAC;MACJH,KAAK,EAAGtC,KAAK,IAAK,IAAIJ,QAAQ,CAAC;QAAE2C,MAAM,EAAExC,aAAa,CAACC,KAAK,EAAE,6BAA6B,EAAE,SAAS;MAAC,CAAE;KAC1G,CAAC;IAEJ,OAAOZ,QAAQ,CAAa;MAC1BsD,OAAOA,CAACtB,GAAG,EAAEC,MAAM,EAAET,aAAa;QAChC,OAAOA,aAAa,GAChB1B,MAAM,CAACyD,GAAG,CAACT,YAAY,CAACd,GAAG,EAAEC,MAAM,CAAC,EAAET,aAAa,CAAC,GACpDsB,YAAY,CAACd,GAAG,EAAEC,MAAM,CAAC;MAC/B,CAAC;MACDuB,UAAUA,CAACxB,GAAG,EAAEC,MAAM;QACpB,OAAOa,YAAY,CAACd,GAAG,EAAEC,MAAM,CAAC;MAClC,CAAC;MACDwB,aAAaA,CAACzB,GAAG,EAAEC,MAAM;QACvB,OAAOmB,SAAS,CAACpB,GAAG,EAAEC,MAAM,CAAC;MAC/B,CAAC;MACDyB,iBAAiBA,CAAC1B,GAAG,EAAEC,MAAM,EAAET,aAAa;QAC1C,OAAOA,aAAa,GAChB1B,MAAM,CAACyD,GAAG,CAACT,YAAY,CAACd,GAAG,EAAEC,MAAM,CAAC,EAAET,aAAa,CAAC,GACpDsB,YAAY,CAACd,GAAG,EAAEC,MAAM,CAAC;MAC/B,CAAC;MACD0B,aAAaA,CAAC3B,GAAG,EAAEC,MAAM,EAAET,aAAa;QACtC,OAAOpB,MAAM,CAACwD,OAAO,CAAC,MAAK;UACzB,MAAMC,QAAQ,GAAG9B,WAAW,CAACC,GAAG,EAAEC,MAAM,CAAC;UACzC,OAAO7B,MAAM,CAAC0D,mBAAmB,CAACD,QAAQ,EAAE,GAAG,CAAC;QAClD,CAAC,CAAC,CAACE,IAAI,CACLvC,aAAa,GACTpB,MAAM,CAAC4D,QAAQ,CAAEC,KAAK,IAAKzC,aAAa,CAACyC,KAAK,CAAQ,CAAC,GACvDjE,QAAQ,CACb;MACH;KACD,CAAC;EACJ,CAAC,CAAC;EAEF,MAAMkE,SAAS,GAAG,OAAO/D,SAAS,CAACe,IAAI,CAAC,CAAC,CAAC;EAC1C,MAAMiD,UAAU,GAAG,OAAOtC,cAAc;EAExC,MAAMuC,QAAQ,GAAGF,SAAS,CAACG,WAAW,CAAC,CAAC,CAAC,CAACvE,MAAM,CAACwE,OAAO,CAACH,UAAU,CAAC,CAAC;EACrE,MAAMI,mBAAmB,GAAGzE,MAAM,CAAC0E,mBAAmB,CAAEC,OAAO,IAAI;IACjE,MAAMC,KAAK,GAAG3E,KAAK,CAAC4E,UAAU,EAAG;IACjC,MAAMC,KAAK,GAAG/E,OAAO,CAACgF,SAAS,CAACH,KAAK,CAACI,OAAO,EAAE5E,KAAK,CAACA,KAAK,CAAC;IAC3D,OAAOJ,MAAM,CAACiF,EAAE,CACdjF,MAAM,CAACkF,GAAG,CACRP,OAAO,CAACP,SAAS,CAACe,IAAI,CAAC,CAAC,CAAC,CAAC,EAC1B,MAAM/E,KAAK,CAACgF,YAAY,CAACN,KAAK,EAAEV,SAAS,CAACiB,OAAO,CAAC,CAAC,CAAC,CAAC,CACtD,EACDhB,UAAU,CACX;EACH,CAAC,CAAC;EAEF,OAAOiB,MAAM,CAACC,MAAM,CACjB,OAAO/E,MAAM,CAACY,IAAI,CAAC;IAClBkD,QAAQ;IACR/C,QAAQ;IACRkD,mBAAmB;IACnBe,cAAc,EAAE,CACd,IAAInE,OAAO,CAACmE,cAAc,GAAGF,MAAM,CAACG,OAAO,CAACpE,OAAO,CAACmE,cAAc,CAAC,GAAG,EAAE,CAAC,EACzE,CAAC5E,mBAAmB,EAAE,QAAQ,CAAC,CAChC;IACDc;GACD,CAAC,EACF;IACE,CAACT,MAAM,GAAGA,MAAgB;IAC1ByE,MAAM,EAAErE;GACT,CACF;AACH,CAAC,CAAC;AAEJ;;;;;;AAMA,OAAO,MAAMsE,WAAW,GACtBD,MAAuC,IAEvCvF,KAAK,CAACyF,aAAa,CACjB9F,MAAM,CAAC+F,MAAM,CAACH,MAAM,CAAC,CAACzB,IAAI,CACxBjE,MAAM,CAAC8F,OAAO,CAAC1E,IAAI,CAAC,EACpBpB,MAAM,CAACyD,GAAG,CAAEsC,MAAM,IAChBhG,OAAO,CAACqB,IAAI,CAACF,YAAY,EAAE6E,MAAM,CAAC,CAAC9B,IAAI,CACrClE,OAAO,CAACiG,GAAG,CAACxF,MAAM,CAACyF,SAAS,EAAEF,MAAM,CAAC,CACtC,CACF,CACF,CACF,CAAC9B,IAAI,CAAC9D,KAAK,CAAC+F,OAAO,CAAC3F,UAAU,CAAC4F,KAAK,CAAC,CAAC;AAEzC;;;;;;AAMA,OAAO,MAAMA,KAAK,GAChBT,MAA0B,IAE1BvF,KAAK,CAACyF,aAAa,CACjB5F,MAAM,CAACyD,GAAG,CAACrC,IAAI,CAACsE,MAAM,CAAC,EAAGK,MAAM,IAC9BhG,OAAO,CAACqB,IAAI,CAACF,YAAY,EAAE6E,MAAM,CAAC,CAAC9B,IAAI,CACrClE,OAAO,CAACiG,GAAG,CAACxF,MAAM,CAACyF,SAAS,EAAEF,MAAM,CAAC,CACtC,CAAC,CACL,CAAC9B,IAAI,CAAC9D,KAAK,CAAC+F,OAAO,CAAC3F,UAAU,CAAC4F,KAAK,CAAC,CAAC","ignoreList":[]}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,49 +2,10 @@
|
|
|
2
2
|
* @since 4.0.0
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* Provides an Effect SQL client for Cloudflare Durable Object SQLite storage.
|
|
6
|
-
*
|
|
7
|
-
* This module adapts a Durable Object `SqlStorage` handle into both the
|
|
8
|
-
* Durable Object-specific `SqliteClient` service and the generic Effect
|
|
9
|
-
* `SqlClient` service. Use it from inside a Durable Object to run local
|
|
10
|
-
* per-object queries, repositories, migrations, transactional read/write
|
|
11
|
-
* workflows, and tests that exercise Cloudflare's SQLite-backed storage API.
|
|
12
|
-
*
|
|
13
|
-
* Durable Object SQLite storage is scoped to one object id, so each object
|
|
14
|
-
* instance has its own database and callers should pass the same `SqlStorage`
|
|
15
|
-
* handle that the object uses for normal reads and writes. This adapter
|
|
16
|
-
* serializes Effect SQL access through one connection; a transaction holds that
|
|
17
|
-
* permit for the lifetime of its scope, so keep transactions short, avoid
|
|
18
|
-
* suspending them across unrelated work, and use them when multi-statement
|
|
19
|
-
* writes must commit atomically. `SqlStorage.exec` returns `ArrayBuffer` values
|
|
20
|
-
* for SQLite blobs, which this client normalizes to `Uint8Array`, and SQLite
|
|
21
|
-
* does not support `updateValues`.
|
|
22
|
-
*
|
|
23
5
|
* @since 4.0.0
|
|
24
6
|
*/
|
|
25
7
|
export * as SqliteClient from "./SqliteClient.ts";
|
|
26
8
|
/**
|
|
27
|
-
* Utilities for applying Effect SQL migrations to Cloudflare Durable Object SQLite storage.
|
|
28
|
-
*
|
|
29
|
-
* This module re-exports the shared `Migrator` loaders and error types, then
|
|
30
|
-
* provides `run` and `layer` helpers that execute ordered migrations through the
|
|
31
|
-
* current Durable Object `SqlStorage`-backed `SqlClient`. Use it when a Durable
|
|
32
|
-
* Object needs to create or upgrade its local schema during construction, before
|
|
33
|
-
* repositories or request handlers use the object storage, or in tests that
|
|
34
|
-
* exercise Durable Object persistence.
|
|
35
|
-
*
|
|
36
|
-
* Migrations are recorded in `effect_sql_migrations` by default and are loaded
|
|
37
|
-
* using the shared `<id>_<name>` file or record-key convention. The underlying
|
|
38
|
-
* storage is scoped to a Durable Object id, so running migrations for one object
|
|
39
|
-
* does not update any other object instance; run the migrator against the same
|
|
40
|
-
* `SqlStorage` handle that the object uses for normal queries. These SQL
|
|
41
|
-
* migrations are separate from Cloudflare's Durable Object class migrations, and
|
|
42
|
-
* the Durable Object must already be configured with SQLite storage before this
|
|
43
|
-
* module can apply schema changes. Repeated startup runs are expected and are
|
|
44
|
-
* guarded by the migrations table, but request handling should wait until the
|
|
45
|
-
* migration layer has finished. This adapter does not currently write SQLite
|
|
46
|
-
* schema dumps for `schemaDirectory`.
|
|
47
|
-
*
|
|
48
9
|
* @since 4.0.0
|
|
49
10
|
*/
|
|
50
11
|
export * as SqliteMigrator from "./SqliteMigrator.ts";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -3,49 +3,10 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// @barrel: Auto-generated exports. Do not edit manually.
|
|
5
5
|
/**
|
|
6
|
-
* Provides an Effect SQL client for Cloudflare Durable Object SQLite storage.
|
|
7
|
-
*
|
|
8
|
-
* This module adapts a Durable Object `SqlStorage` handle into both the
|
|
9
|
-
* Durable Object-specific `SqliteClient` service and the generic Effect
|
|
10
|
-
* `SqlClient` service. Use it from inside a Durable Object to run local
|
|
11
|
-
* per-object queries, repositories, migrations, transactional read/write
|
|
12
|
-
* workflows, and tests that exercise Cloudflare's SQLite-backed storage API.
|
|
13
|
-
*
|
|
14
|
-
* Durable Object SQLite storage is scoped to one object id, so each object
|
|
15
|
-
* instance has its own database and callers should pass the same `SqlStorage`
|
|
16
|
-
* handle that the object uses for normal reads and writes. This adapter
|
|
17
|
-
* serializes Effect SQL access through one connection; a transaction holds that
|
|
18
|
-
* permit for the lifetime of its scope, so keep transactions short, avoid
|
|
19
|
-
* suspending them across unrelated work, and use them when multi-statement
|
|
20
|
-
* writes must commit atomically. `SqlStorage.exec` returns `ArrayBuffer` values
|
|
21
|
-
* for SQLite blobs, which this client normalizes to `Uint8Array`, and SQLite
|
|
22
|
-
* does not support `updateValues`.
|
|
23
|
-
*
|
|
24
6
|
* @since 4.0.0
|
|
25
7
|
*/
|
|
26
8
|
export * as SqliteClient from "./SqliteClient.js";
|
|
27
9
|
/**
|
|
28
|
-
* Utilities for applying Effect SQL migrations to Cloudflare Durable Object SQLite storage.
|
|
29
|
-
*
|
|
30
|
-
* This module re-exports the shared `Migrator` loaders and error types, then
|
|
31
|
-
* provides `run` and `layer` helpers that execute ordered migrations through the
|
|
32
|
-
* current Durable Object `SqlStorage`-backed `SqlClient`. Use it when a Durable
|
|
33
|
-
* Object needs to create or upgrade its local schema during construction, before
|
|
34
|
-
* repositories or request handlers use the object storage, or in tests that
|
|
35
|
-
* exercise Durable Object persistence.
|
|
36
|
-
*
|
|
37
|
-
* Migrations are recorded in `effect_sql_migrations` by default and are loaded
|
|
38
|
-
* using the shared `<id>_<name>` file or record-key convention. The underlying
|
|
39
|
-
* storage is scoped to a Durable Object id, so running migrations for one object
|
|
40
|
-
* does not update any other object instance; run the migrator against the same
|
|
41
|
-
* `SqlStorage` handle that the object uses for normal queries. These SQL
|
|
42
|
-
* migrations are separate from Cloudflare's Durable Object class migrations, and
|
|
43
|
-
* the Durable Object must already be configured with SQLite storage before this
|
|
44
|
-
* module can apply schema changes. Repeated startup runs are expected and are
|
|
45
|
-
* guarded by the migrations table, but request handling should wait until the
|
|
46
|
-
* migration layer has finished. This adapter does not currently write SQLite
|
|
47
|
-
* schema dumps for `schemaDirectory`.
|
|
48
|
-
*
|
|
49
10
|
* @since 4.0.0
|
|
50
11
|
*/
|
|
51
12
|
export * as SqliteMigrator from "./SqliteMigrator.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["SqliteClient","SqliteMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA
|
|
1
|
+
{"version":3,"file":"index.js","names":["SqliteClient","SqliteMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effect/sql-sqlite-do",
|
|
3
|
-
"version": "4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-beta.71",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "A SQLite toolkit for Effect",
|
|
@@ -44,10 +44,10 @@
|
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@cloudflare/workers-types": "^4.20260511.1",
|
|
47
|
-
"effect": "^4.0.0-beta.
|
|
47
|
+
"effect": "^4.0.0-beta.71"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|
|
50
|
-
"effect": "^4.0.0-beta.
|
|
50
|
+
"effect": "^4.0.0-beta.71"
|
|
51
51
|
},
|
|
52
52
|
"scripts": {
|
|
53
53
|
"codegen": "effect-utils codegen",
|
package/src/SqliteClient.ts
CHANGED
|
@@ -1,21 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Effect SQL client for Cloudflare Durable Object SQLite storage.
|
|
3
3
|
*
|
|
4
4
|
* This module adapts a Durable Object `SqlStorage` handle into both the
|
|
5
|
-
* Durable Object-specific
|
|
6
|
-
* `SqlClient` service. Use it
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
5
|
+
* Durable Object-specific {@link SqliteClient} service and the generic Effect
|
|
6
|
+
* SQL `SqlClient` service. Use it inside a Durable Object for per-object
|
|
7
|
+
* queries, repositories, migrations, transactional read/write workflows, and
|
|
8
|
+
* tests that exercise Cloudflare's SQLite-backed storage API.
|
|
9
|
+
*
|
|
10
|
+
* **Mental model**
|
|
11
|
+
*
|
|
12
|
+
* Durable Object storage is scoped to one object id. Each object instance has
|
|
13
|
+
* its own database, and {@link make} wraps the same `SqlStorage` handle that
|
|
14
|
+
* the object uses for normal reads and writes. Effect SQL access is serialized
|
|
15
|
+
* through one connection; a transaction keeps that permit for the lifetime of
|
|
16
|
+
* its scope.
|
|
17
|
+
*
|
|
18
|
+
* **Common tasks**
|
|
19
|
+
*
|
|
20
|
+
* Use {@link layer} when the Durable Object constructor already has a concrete
|
|
21
|
+
* `SqlStorage` handle. Use {@link layerConfig} when the handle and transform
|
|
22
|
+
* options should be supplied through Effect `Config`. Keep using generic
|
|
23
|
+
* `SqlClient` APIs for ordinary SQL, and depend on {@link SqliteClient} when
|
|
24
|
+
* code needs the Durable Object-specific service identity.
|
|
25
|
+
*
|
|
26
|
+
* **Gotchas**
|
|
27
|
+
*
|
|
28
|
+
* Keep transactions short and avoid suspending them across unrelated work,
|
|
29
|
+
* because all access through one client waits on the same serialized
|
|
30
|
+
* connection. `SqlStorage.exec` returns SQLite blob values as `ArrayBuffer`,
|
|
31
|
+
* which this client normalizes to `Uint8Array`. SQLite does not support
|
|
32
|
+
* `updateValues`.
|
|
19
33
|
*
|
|
20
34
|
* @since 4.0.0
|
|
21
35
|
*/
|
package/src/index.ts
CHANGED
|
@@ -5,50 +5,11 @@
|
|
|
5
5
|
// @barrel: Auto-generated exports. Do not edit manually.
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
|
-
* Provides an Effect SQL client for Cloudflare Durable Object SQLite storage.
|
|
9
|
-
*
|
|
10
|
-
* This module adapts a Durable Object `SqlStorage` handle into both the
|
|
11
|
-
* Durable Object-specific `SqliteClient` service and the generic Effect
|
|
12
|
-
* `SqlClient` service. Use it from inside a Durable Object to run local
|
|
13
|
-
* per-object queries, repositories, migrations, transactional read/write
|
|
14
|
-
* workflows, and tests that exercise Cloudflare's SQLite-backed storage API.
|
|
15
|
-
*
|
|
16
|
-
* Durable Object SQLite storage is scoped to one object id, so each object
|
|
17
|
-
* instance has its own database and callers should pass the same `SqlStorage`
|
|
18
|
-
* handle that the object uses for normal reads and writes. This adapter
|
|
19
|
-
* serializes Effect SQL access through one connection; a transaction holds that
|
|
20
|
-
* permit for the lifetime of its scope, so keep transactions short, avoid
|
|
21
|
-
* suspending them across unrelated work, and use them when multi-statement
|
|
22
|
-
* writes must commit atomically. `SqlStorage.exec` returns `ArrayBuffer` values
|
|
23
|
-
* for SQLite blobs, which this client normalizes to `Uint8Array`, and SQLite
|
|
24
|
-
* does not support `updateValues`.
|
|
25
|
-
*
|
|
26
8
|
* @since 4.0.0
|
|
27
9
|
*/
|
|
28
10
|
export * as SqliteClient from "./SqliteClient.ts"
|
|
29
11
|
|
|
30
12
|
/**
|
|
31
|
-
* Utilities for applying Effect SQL migrations to Cloudflare Durable Object SQLite storage.
|
|
32
|
-
*
|
|
33
|
-
* This module re-exports the shared `Migrator` loaders and error types, then
|
|
34
|
-
* provides `run` and `layer` helpers that execute ordered migrations through the
|
|
35
|
-
* current Durable Object `SqlStorage`-backed `SqlClient`. Use it when a Durable
|
|
36
|
-
* Object needs to create or upgrade its local schema during construction, before
|
|
37
|
-
* repositories or request handlers use the object storage, or in tests that
|
|
38
|
-
* exercise Durable Object persistence.
|
|
39
|
-
*
|
|
40
|
-
* Migrations are recorded in `effect_sql_migrations` by default and are loaded
|
|
41
|
-
* using the shared `<id>_<name>` file or record-key convention. The underlying
|
|
42
|
-
* storage is scoped to a Durable Object id, so running migrations for one object
|
|
43
|
-
* does not update any other object instance; run the migrator against the same
|
|
44
|
-
* `SqlStorage` handle that the object uses for normal queries. These SQL
|
|
45
|
-
* migrations are separate from Cloudflare's Durable Object class migrations, and
|
|
46
|
-
* the Durable Object must already be configured with SQLite storage before this
|
|
47
|
-
* module can apply schema changes. Repeated startup runs are expected and are
|
|
48
|
-
* guarded by the migrations table, but request handling should wait until the
|
|
49
|
-
* migration layer has finished. This adapter does not currently write SQLite
|
|
50
|
-
* schema dumps for `schemaDirectory`.
|
|
51
|
-
*
|
|
52
13
|
* @since 4.0.0
|
|
53
14
|
*/
|
|
54
15
|
export * as SqliteMigrator from "./SqliteMigrator.ts"
|