@statewalker/db-pglite 0.1.1 → 0.2.0
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 +6 -1
- package/package.json +11 -6
- package/src/pglite-db.test.ts +0 -20
package/README.md
CHANGED
|
@@ -19,6 +19,10 @@ pnpm add @statewalker/db-pglite @electric-sql/pglite
|
|
|
19
19
|
pnpm add @electric-sql/pglite-pgvector # only for the pgvector example below
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
+
`@electric-sql/pglite` (`^0.5.15`) is a peer dependency: install it yourself, so the driver and
|
|
23
|
+
the extensions you pass share one PGlite. Pick the PGlite version your extensions are built for
|
|
24
|
+
(`@electric-sql/pglite-pgvector@0.0.16` needs PGlite `0.5.15`, `0.0.17` needs `0.5.16`).
|
|
25
|
+
|
|
22
26
|
| Import | Gives | Environment |
|
|
23
27
|
| --- | --- | --- |
|
|
24
28
|
| `@statewalker/db-pglite` | `newPgliteDb`; types `PgliteDbOptions`, `Db`, `DbEntry` | Node.js, browser |
|
|
@@ -48,7 +52,8 @@ const rows = await db.query("SELECT $1::int + 1 AS n", [41]);
|
|
|
48
52
|
rejects this Db. Postgres runs `BEGIN ... COMMIT` as ordinary SQL inside one `exec`.
|
|
49
53
|
- **After `close()`** every call rejects with `db-pglite: the database is closed`; a second
|
|
50
54
|
`close()` does nothing.
|
|
51
|
-
- **Dependencies:** `@electric-sql/pglite` (the engine
|
|
55
|
+
- **Dependencies:** `@statewalker/db-api` (types); peer `@electric-sql/pglite` (the engine,
|
|
56
|
+
provided by the caller).
|
|
52
57
|
|
|
53
58
|
## License
|
|
54
59
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@statewalker/db-pglite",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "PGlite (Postgres in WASM) driver for @statewalker/db-api, for Node.js and the browser.",
|
|
@@ -22,19 +22,24 @@
|
|
|
22
22
|
".": {
|
|
23
23
|
"source": "./src/index.ts",
|
|
24
24
|
"types": "./dist/index.d.mts",
|
|
25
|
-
"import": "./dist/index.mjs"
|
|
25
|
+
"import": "./dist/index.mjs",
|
|
26
|
+
"default": "./dist/index.mjs"
|
|
26
27
|
}
|
|
27
28
|
},
|
|
28
29
|
"files": [
|
|
29
30
|
"dist",
|
|
30
|
-
"src"
|
|
31
|
+
"src",
|
|
32
|
+
"!src/**/*.test.ts"
|
|
31
33
|
],
|
|
32
34
|
"dependencies": {
|
|
33
|
-
"@
|
|
34
|
-
|
|
35
|
+
"@statewalker/db-api": "^0.1.6"
|
|
36
|
+
},
|
|
37
|
+
"peerDependencies": {
|
|
38
|
+
"@electric-sql/pglite": "^0.5.15"
|
|
35
39
|
},
|
|
36
40
|
"devDependencies": {
|
|
37
|
-
"@electric-sql/pglite
|
|
41
|
+
"@electric-sql/pglite": "^0.5.16",
|
|
42
|
+
"@electric-sql/pglite-pgvector": "^0.0.17",
|
|
38
43
|
"@types/node": "^26.6.4",
|
|
39
44
|
"rimraf": "^6.1.3",
|
|
40
45
|
"tsdown": "^0.23.0",
|
package/src/pglite-db.test.ts
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { vector } from "@electric-sql/pglite-pgvector";
|
|
2
|
-
import { runDbConformance } from "@statewalker/db-tests";
|
|
3
|
-
import { describe, expect, it } from "vitest";
|
|
4
|
-
import { newPgliteDb } from "./pglite-db.js";
|
|
5
|
-
|
|
6
|
-
runDbConformance((options) => newPgliteDb(options), { placeholder: "$1" });
|
|
7
|
-
|
|
8
|
-
describe("newPgliteDb", () => {
|
|
9
|
-
it("loads the extensions it is given (pgvector, as indexer-pglite needs)", async () => {
|
|
10
|
-
const db = await newPgliteDb({ extensions: { vector } });
|
|
11
|
-
try {
|
|
12
|
-
await db.exec("CREATE EXTENSION IF NOT EXISTS vector; CREATE TABLE v (e vector(3))");
|
|
13
|
-
await db.query("INSERT INTO v VALUES ($1::vector)", ["[1,2,3]"]);
|
|
14
|
-
const rows = await db.query<{ d: number }>("SELECT e <-> '[1,2,4]'::vector AS d FROM v");
|
|
15
|
-
expect(rows[0]?.d).toBeCloseTo(1);
|
|
16
|
-
} finally {
|
|
17
|
-
await db.close();
|
|
18
|
-
}
|
|
19
|
-
});
|
|
20
|
-
});
|