@effectstream/db 0.100.16 → 0.100.18
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/README.md +5 -5
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -49,7 +49,7 @@ try {
|
|
|
49
49
|
|
|
50
50
|
For PgLite (in-memory) the package ships `./start-pglite`,
|
|
51
51
|
`./apply-migrations`, `./db-wait`, `./pgtyped-update`, `./version` as
|
|
52
|
-
small executable subpaths
|
|
52
|
+
small executable subpaths - used directly by the orchestrator.
|
|
53
53
|
|
|
54
54
|
> **PgLite caveat:** PgLite is single-writer. Wrap PgLite-bound code in
|
|
55
55
|
> `acquireDBMutex(name)` / `releaseDBMutex(name)` so concurrent generators
|
|
@@ -69,7 +69,7 @@ Connection management (heavily used):
|
|
|
69
69
|
|
|
70
70
|
- `getConnection(creds?)`: pooled `Pool` singleton. Dominant entry point (~31 call sites across the repo).
|
|
71
71
|
- `acquireDBMutex(name, priority?)` and `releaseDBMutex(name)` coordinate PgLite access; ~7 call sites each.
|
|
72
|
-
- `waitUntilFree()`
|
|
72
|
+
- `waitUntilFree()` - companion to the mutex.
|
|
73
73
|
- `getPersistentConnection(creds)` returns a non-pooled `Client` for long-lived listeners.
|
|
74
74
|
|
|
75
75
|
Queries (pgtyped-generated, shipped under one umbrella):
|
|
@@ -80,7 +80,7 @@ Queries (pgtyped-generated, shipped under one umbrella):
|
|
|
80
80
|
|
|
81
81
|
Snapshots:
|
|
82
82
|
|
|
83
|
-
- `runSnapshotLoop`
|
|
83
|
+
- `runSnapshotLoop` - periodic `pg_dump` of synced state.
|
|
84
84
|
- `createSnapshot`: single-shot snapshot helper.
|
|
85
85
|
- `SnapshotConfig`, `SnapshotRetentionConfig`: config types.
|
|
86
86
|
|
|
@@ -92,10 +92,10 @@ Dynamic table / event helpers:
|
|
|
92
92
|
Subpath entry points (executable scripts):
|
|
93
93
|
|
|
94
94
|
- `@effectstream/db/start-pglite`: boot a PgLite instance.
|
|
95
|
-
- `@effectstream/db/apply-migrations`
|
|
95
|
+
- `@effectstream/db/apply-migrations` - apply SQL migrations against the active DB.
|
|
96
96
|
- `@effectstream/db/db-wait`: block until the DB accepts a connection.
|
|
97
97
|
- `@effectstream/db/pgtyped-update`: regenerate pgtyped types.
|
|
98
|
-
- `@effectstream/db/version`
|
|
98
|
+
- `@effectstream/db/version` - print schema version.
|
|
99
99
|
|
|
100
100
|
## Examples
|
|
101
101
|
|
package/package.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effectstream/db",
|
|
3
|
-
"version": "0.100.
|
|
3
|
+
"version": "0.100.18",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"homepage": "https://effectstream.github.io/docs/",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "https://github.com/
|
|
8
|
+
"url": "https://github.com/effectstream/effectstream",
|
|
9
9
|
"directory": "packages/node-sdk/db"
|
|
10
10
|
},
|
|
11
11
|
"bugs": {
|
|
12
|
-
"url": "https://github.com/
|
|
12
|
+
"url": "https://github.com/effectstream/effectstream/issues"
|
|
13
13
|
},
|
|
14
14
|
"exports": {
|
|
15
15
|
".": "./src/mod.ts",
|
|
@@ -21,11 +21,11 @@
|
|
|
21
21
|
"./version": "./migrations/system-version.ts"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@effectstream/coroutine": "0.100.
|
|
25
|
-
"@effectstream/log": "0.100.
|
|
26
|
-
"@effectstream/runtime": "0.100.
|
|
27
|
-
"@effectstream/sync": "0.100.
|
|
28
|
-
"@effectstream/utils": "0.100.
|
|
24
|
+
"@effectstream/coroutine": "0.100.18",
|
|
25
|
+
"@effectstream/log": "0.100.18",
|
|
26
|
+
"@effectstream/runtime": "0.100.18",
|
|
27
|
+
"@effectstream/sync": "0.100.18",
|
|
28
|
+
"@effectstream/utils": "0.100.18",
|
|
29
29
|
"@electric-sql/pglite": "^0.3.14",
|
|
30
30
|
"@pgtyped/runtime": "2.4.2",
|
|
31
31
|
"@pgtyped/parser": "2.4.2",
|