@lunora/d1 1.0.0-alpha.6 → 1.0.0-alpha.60
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/LICENSE.md +6 -0
- package/dist/dialect.d.mts +29 -27
- package/dist/dialect.d.ts +29 -27
- package/dist/dialect.mjs +1 -35
- package/dist/index.d.mts +157 -161
- package/dist/index.d.ts +157 -161
- package/dist/index.mjs +1 -7
- package/dist/packem_shared/D1Client-DeccGO7F.mjs +1 -0
- package/dist/packem_shared/MigrationRunner-CNH8wlIl.mjs +2 -0
- package/dist/packem_shared/backfillD1SearchIndexes-ERQf6szv.mjs +1 -0
- package/dist/packem_shared/exportGlobalRows-1Zw30YqW.mjs +1 -0
- package/dist/packem_shared/facetGlobalColumn-R-BETSuA.mjs +1 -0
- package/dist/packem_shared/quoteIdentifier-CObIFRhb.mjs +1 -0
- package/dist/packem_shared/sqliteDialect-B43yA0ek.mjs +1 -0
- package/package.json +5 -3
- package/dist/packem_shared/D1Client-DA3flo1o.mjs +0 -143
- package/dist/packem_shared/MigrationRunner-BkEwQ-Ya.mjs +0 -149
- package/dist/packem_shared/createD1CtxDb-BMR8J0dT.mjs +0 -14
- package/dist/packem_shared/exportGlobalRows-BGCPm_nA.mjs +0 -122
- package/dist/packem_shared/facetGlobalColumn-C6u_WMIY.mjs +0 -142
- package/dist/packem_shared/sqliteDialect-DqYnHPuu.mjs +0 -27
package/LICENSE.md
CHANGED
|
@@ -103,3 +103,9 @@ Unless required by applicable law or agreed to in writing, software distributed
|
|
|
103
103
|
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
|
104
104
|
CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
|
105
105
|
specific language governing permissions and limitations under the License.
|
|
106
|
+
|
|
107
|
+
<!-- DEPENDENCIES -->
|
|
108
|
+
<!-- /DEPENDENCIES -->
|
|
109
|
+
|
|
110
|
+
<!-- TYPE_DEPENDENCIES -->
|
|
111
|
+
<!-- /TYPE_DEPENDENCIES -->
|
package/dist/dialect.d.mts
CHANGED
|
@@ -1,38 +1,40 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
|
|
2
|
+
* Canonical SQL identifier quoter shared by `@lunora/d1` and `@lunora/do`.
|
|
3
|
+
*
|
|
4
|
+
* Double-quotes a SQL identifier and escapes any embedded double quotes by
|
|
5
|
+
* doubling them (`"` → `""`) — the ANSI/SQLite/Postgres rule. This is a
|
|
6
|
+
* security-relevant primitive (it is the sole defense against identifier
|
|
7
|
+
* injection wherever a table/column name is spliced into raw SQL), so it must
|
|
8
|
+
* have exactly ONE definition rather than byte-identical copies that can drift.
|
|
9
|
+
*
|
|
10
|
+
* Like `shared/stable-key.ts`, it is deliberately **not** a package: `@lunora/d1`
|
|
11
|
+
* and `@lunora/do` sit on the same tier with no lower-level package to host it,
|
|
12
|
+
* so each imports this file by relative path and the bundler (packem/rollup)
|
|
13
|
+
* inlines it — no runtime dependency edge, duplicated only in emitted output.
|
|
14
|
+
* Keep it genuinely zero-dependency (relative/built-in imports only) or inlining
|
|
15
|
+
* breaks. Consumers must drop `outDir`/`rootDir` from their `tsconfig.json` (a
|
|
16
|
+
* set `rootDir` raises TS6059 for this out-of-package file under `tsc --noEmit`).
|
|
17
|
+
*/
|
|
18
|
+
declare const quoteIdentifier: (name: string) => string;
|
|
15
19
|
/** SQLite column type affinities Lunora emits. */
|
|
16
20
|
type SqlAffinity = "BLOB" | "INTEGER" | "REAL" | "TEXT";
|
|
17
|
-
/** Double-quote (and escape) a SQL identifier. */
|
|
18
|
-
declare const quoteIdentifier: (name: string) => string;
|
|
19
21
|
/**
|
|
20
|
-
* SQLite affinity for a column by its validator `kind`, chosen so the value the
|
|
21
|
-
* D1 layer serializes round-trips intact:
|
|
22
|
-
* - `boolean` → INTEGER (stored as 1/0)
|
|
23
|
-
* - `number`/`timestamp`/`date` → REAL (numeric, never coerced to text)
|
|
24
|
-
* - `bytes` → BLOB
|
|
25
|
-
* - everything else → TEXT — string/id/literal, `bigint` (serialized as a
|
|
26
|
-
* decimal string), and object/array/record/union/any (JSON). A numeric affinity
|
|
27
|
-
* would coerce a numeric-looking string and corrupt the decode.
|
|
28
|
-
*/
|
|
22
|
+
* SQLite affinity for a column by its validator `kind`, chosen so the value the
|
|
23
|
+
* D1 layer serializes round-trips intact:
|
|
24
|
+
* - `boolean` → INTEGER (stored as 1/0)
|
|
25
|
+
* - `number`/`timestamp`/`date` → REAL (numeric, never coerced to text)
|
|
26
|
+
* - `bytes` → BLOB
|
|
27
|
+
* - everything else → TEXT — string/id/literal, `bigint` (serialized as a
|
|
28
|
+
* decimal string), and object/array/record/union/any (JSON). A numeric affinity
|
|
29
|
+
* would coerce a numeric-looking string and corrupt the decode.
|
|
30
|
+
*/
|
|
29
31
|
declare const sqlAffinityForKind: (kind: string | undefined) => SqlAffinity;
|
|
30
32
|
/** Framework columns every global table carries: the physical `id` (exposed as `_id`) and `_creationTime`. */
|
|
31
33
|
declare const frameworkColumnDdl: () => ReadonlyArray<string>;
|
|
32
34
|
/**
|
|
33
|
-
* Resolve a schema field to its physical D1 column: `_id`/`id` both map to the
|
|
34
|
-
* physical `id` column, `_creationTime` to its own, every other field to itself.
|
|
35
|
-
*/
|
|
35
|
+
* Resolve a schema field to its physical D1 column: `_id`/`id` both map to the
|
|
36
|
+
* physical `id` column, `_creationTime` to its own, every other field to itself.
|
|
37
|
+
*/
|
|
36
38
|
declare const columnRef: (field: string) => string;
|
|
37
39
|
/** Physical index identifier — `<table>_<name>`, so two tables' like-named indexes don't collide in SQLite's flat index namespace. */
|
|
38
40
|
declare const physicalIndexName: (tableName: string, indexName: string) => string;
|
package/dist/dialect.d.ts
CHANGED
|
@@ -1,38 +1,40 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
|
|
2
|
+
* Canonical SQL identifier quoter shared by `@lunora/d1` and `@lunora/do`.
|
|
3
|
+
*
|
|
4
|
+
* Double-quotes a SQL identifier and escapes any embedded double quotes by
|
|
5
|
+
* doubling them (`"` → `""`) — the ANSI/SQLite/Postgres rule. This is a
|
|
6
|
+
* security-relevant primitive (it is the sole defense against identifier
|
|
7
|
+
* injection wherever a table/column name is spliced into raw SQL), so it must
|
|
8
|
+
* have exactly ONE definition rather than byte-identical copies that can drift.
|
|
9
|
+
*
|
|
10
|
+
* Like `shared/stable-key.ts`, it is deliberately **not** a package: `@lunora/d1`
|
|
11
|
+
* and `@lunora/do` sit on the same tier with no lower-level package to host it,
|
|
12
|
+
* so each imports this file by relative path and the bundler (packem/rollup)
|
|
13
|
+
* inlines it — no runtime dependency edge, duplicated only in emitted output.
|
|
14
|
+
* Keep it genuinely zero-dependency (relative/built-in imports only) or inlining
|
|
15
|
+
* breaks. Consumers must drop `outDir`/`rootDir` from their `tsconfig.json` (a
|
|
16
|
+
* set `rootDir` raises TS6059 for this out-of-package file under `tsc --noEmit`).
|
|
17
|
+
*/
|
|
18
|
+
declare const quoteIdentifier: (name: string) => string;
|
|
15
19
|
/** SQLite column type affinities Lunora emits. */
|
|
16
20
|
type SqlAffinity = "BLOB" | "INTEGER" | "REAL" | "TEXT";
|
|
17
|
-
/** Double-quote (and escape) a SQL identifier. */
|
|
18
|
-
declare const quoteIdentifier: (name: string) => string;
|
|
19
21
|
/**
|
|
20
|
-
* SQLite affinity for a column by its validator `kind`, chosen so the value the
|
|
21
|
-
* D1 layer serializes round-trips intact:
|
|
22
|
-
* - `boolean` → INTEGER (stored as 1/0)
|
|
23
|
-
* - `number`/`timestamp`/`date` → REAL (numeric, never coerced to text)
|
|
24
|
-
* - `bytes` → BLOB
|
|
25
|
-
* - everything else → TEXT — string/id/literal, `bigint` (serialized as a
|
|
26
|
-
* decimal string), and object/array/record/union/any (JSON). A numeric affinity
|
|
27
|
-
* would coerce a numeric-looking string and corrupt the decode.
|
|
28
|
-
*/
|
|
22
|
+
* SQLite affinity for a column by its validator `kind`, chosen so the value the
|
|
23
|
+
* D1 layer serializes round-trips intact:
|
|
24
|
+
* - `boolean` → INTEGER (stored as 1/0)
|
|
25
|
+
* - `number`/`timestamp`/`date` → REAL (numeric, never coerced to text)
|
|
26
|
+
* - `bytes` → BLOB
|
|
27
|
+
* - everything else → TEXT — string/id/literal, `bigint` (serialized as a
|
|
28
|
+
* decimal string), and object/array/record/union/any (JSON). A numeric affinity
|
|
29
|
+
* would coerce a numeric-looking string and corrupt the decode.
|
|
30
|
+
*/
|
|
29
31
|
declare const sqlAffinityForKind: (kind: string | undefined) => SqlAffinity;
|
|
30
32
|
/** Framework columns every global table carries: the physical `id` (exposed as `_id`) and `_creationTime`. */
|
|
31
33
|
declare const frameworkColumnDdl: () => ReadonlyArray<string>;
|
|
32
34
|
/**
|
|
33
|
-
* Resolve a schema field to its physical D1 column: `_id`/`id` both map to the
|
|
34
|
-
* physical `id` column, `_creationTime` to its own, every other field to itself.
|
|
35
|
-
*/
|
|
35
|
+
* Resolve a schema field to its physical D1 column: `_id`/`id` both map to the
|
|
36
|
+
* physical `id` column, `_creationTime` to its own, every other field to itself.
|
|
37
|
+
*/
|
|
36
38
|
declare const columnRef: (field: string) => string;
|
|
37
39
|
/** Physical index identifier — `<table>_<name>`, so two tables' like-named indexes don't collide in SQLite's flat index namespace. */
|
|
38
40
|
declare const physicalIndexName: (tableName: string, indexName: string) => string;
|
package/dist/dialect.mjs
CHANGED
|
@@ -1,35 +1 @@
|
|
|
1
|
-
|
|
2
|
-
const sqlAffinityForKind = (kind) => {
|
|
3
|
-
switch (kind) {
|
|
4
|
-
case "boolean": {
|
|
5
|
-
return "INTEGER";
|
|
6
|
-
}
|
|
7
|
-
case "bytes": {
|
|
8
|
-
return "BLOB";
|
|
9
|
-
}
|
|
10
|
-
case "date":
|
|
11
|
-
case "number":
|
|
12
|
-
case "timestamp": {
|
|
13
|
-
return "REAL";
|
|
14
|
-
}
|
|
15
|
-
default: {
|
|
16
|
-
return "TEXT";
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
};
|
|
20
|
-
const frameworkColumnDdl = () => [
|
|
21
|
-
`${quoteIdentifier("id")} TEXT PRIMARY KEY`,
|
|
22
|
-
`${quoteIdentifier("_creationTime")} REAL NOT NULL`
|
|
23
|
-
];
|
|
24
|
-
const columnRef = (field) => {
|
|
25
|
-
if (field === "_id" || field === "id") {
|
|
26
|
-
return quoteIdentifier("id");
|
|
27
|
-
}
|
|
28
|
-
if (field === "_creationTime") {
|
|
29
|
-
return quoteIdentifier("_creationTime");
|
|
30
|
-
}
|
|
31
|
-
return quoteIdentifier(field);
|
|
32
|
-
};
|
|
33
|
-
const physicalIndexName = (tableName, indexName) => quoteIdentifier(`${tableName}_${indexName}`);
|
|
34
|
-
|
|
35
|
-
export { columnRef, frameworkColumnDdl, physicalIndexName, quoteIdentifier, sqlAffinityForKind };
|
|
1
|
+
import{quoteIdentifier as i}from"./packem_shared/quoteIdentifier-CObIFRhb.mjs";const t=e=>{switch(e){case"boolean":return"INTEGER";case"bytes":return"BLOB";case"date":case"number":case"timestamp":return"REAL";default:return"TEXT"}},a=()=>[`${i("id")} TEXT PRIMARY KEY`,`${i("_creationTime")} REAL NOT NULL`],o=e=>e==="_id"||e==="id"?i("id"):e==="_creationTime"?i("_creationTime"):i(e),c=(e,r)=>i(`${e}_${r}`);export{o as columnRef,a as frameworkColumnDdl,c as physicalIndexName,i as quoteIdentifier,t as sqlAffinityForKind};
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
import { SchemaLike, DatabaseWriterLike } from '@lunora/
|
|
2
|
-
import { SqlCtxDbOptions,
|
|
1
|
+
import { SchemaLike, DatabaseWriterLike } from '@lunora/shard-engine';
|
|
2
|
+
import { SqlCtxDbOptions, SqlCtxExec, createSqlCtxDb, readSqlCdcChanges, SqlDialect } from '@lunora/sql-store';
|
|
3
3
|
export { type SqlCtxExec as D1Exec, type SqlCtxDbOptions, type SqlCtxExec, createSqlCtxDb } from '@lunora/sql-store';
|
|
4
|
+
import { D1DatabaseLike, D1SessionLike, D1PreparedStatementLike } from '@lunora/platform';
|
|
5
|
+
export type { D1DatabaseLike, D1PreparedStatementLike, D1SessionLike } from '@lunora/platform';
|
|
4
6
|
import { BatchItem, BatchResponse } from 'drizzle-orm/batch';
|
|
5
7
|
import { DrizzleD1Database } from 'drizzle-orm/d1';
|
|
6
8
|
/** The D1 store options — the shared store options minus `dialect` (the SQLite dialect is injected for you). */
|
|
@@ -13,8 +15,10 @@ declare const runD1GlobalTableMigrations: (exec: SqlCtxExec, schema: SchemaLike)
|
|
|
13
15
|
declare const runD1AggregateMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
|
|
14
16
|
/** Materialize the `__rank_<index>` companion tables for the schema's rank indexes. */
|
|
15
17
|
declare const runD1RankMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
|
|
16
|
-
/** Materialize the `__fts_<index>` fts5 shadow tables for the schema's search indexes
|
|
18
|
+
/** Materialize (and backfill) the `__fts_<index>` fts5 shadow tables for the schema's search indexes. */
|
|
17
19
|
declare const runD1SearchMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
|
|
20
|
+
/** Index existing rows into every search companion, including the `staged: true` ones migrations leave empty. */
|
|
21
|
+
declare const backfillD1SearchIndexes: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
|
|
18
22
|
/** Create the `__cdc_log` table in D1 (idempotent; only run when CDC is enabled). */
|
|
19
23
|
declare const runD1CdcMigration: (exec: SqlCtxExec) => Promise<void>;
|
|
20
24
|
/** Read changelog entries newer than `sinceSeq` in commit order. */
|
|
@@ -27,6 +31,17 @@ declare const trimD1CdcChanges: (exec: SqlCtxExec, throughSeq: number) => Promis
|
|
|
27
31
|
/** One exported row: `doc` is reconstructed from the column tuple. */
|
|
28
32
|
interface ExportRow {
|
|
29
33
|
doc: Record<string, unknown>;
|
|
34
|
+
/**
|
|
35
|
+
* True physical source line, when the caller has it (e.g. a global row
|
|
36
|
+
* pulled out of an interspersed NDJSON import stream by
|
|
37
|
+
* `@lunora/runtime`'s `import-stream.ts`). When present this overrides the
|
|
38
|
+
* position-derived line below — the caller-side positions of a
|
|
39
|
+
* global-only subset don't line up with the original file once
|
|
40
|
+
* non-global rows have been filtered out. Absent for callers with no
|
|
41
|
+
* physical source to attribute (e.g. a fresh `exportGlobalRows` roundtrip
|
|
42
|
+
* in tests), which keeps the positional fallback.
|
|
43
|
+
*/
|
|
44
|
+
line?: number;
|
|
30
45
|
table: string;
|
|
31
46
|
}
|
|
32
47
|
interface ImportError {
|
|
@@ -42,32 +57,42 @@ interface ImportResult {
|
|
|
42
57
|
inserted: Record<string, number>;
|
|
43
58
|
}
|
|
44
59
|
/**
|
|
45
|
-
* Return every `.global()` table in the schema, optionally narrowed by an
|
|
46
|
-
* allowlist. Shard-local tables are skipped here — they're handled by the DO
|
|
47
|
-
* helpers — so callers get a clean separation between the two storage planes.
|
|
48
|
-
*/
|
|
60
|
+
* Return every `.global()` table in the schema, optionally narrowed by an
|
|
61
|
+
* allowlist. Shard-local tables are skipped here — they're handled by the DO
|
|
62
|
+
* helpers — so callers get a clean separation between the two storage planes.
|
|
63
|
+
*/
|
|
49
64
|
declare const selectGlobalTables: (schema: SchemaLike, requested?: ReadonlyArray<string>) => string[];
|
|
50
65
|
interface ExportGlobalArgs {
|
|
51
66
|
batchSize?: number;
|
|
52
67
|
tables?: ReadonlyArray<string>;
|
|
53
68
|
}
|
|
54
69
|
/**
|
|
55
|
-
* Yield rows from every requested `.global()` table in batches.
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
|
|
70
|
+
* Yield rows from every requested `.global()` table in batches.
|
|
71
|
+
*
|
|
72
|
+
* Keyset-paginates on the physical primary key (`id` — every `.global()` table
|
|
73
|
+
* carries it, see `frameworkColumnDdl`): `WHERE "id" > ? ORDER BY "id" LIMIT ?`,
|
|
74
|
+
* carrying the last id forward. A plain `LIMIT/OFFSET` scan would be wrong here —
|
|
75
|
+
* SQLite gives no ordering guarantee for an unordered SELECT and each page is a
|
|
76
|
+
* separate query, so pages could overlap or skip rows (and any concurrent
|
|
77
|
+
* insert/delete would shift offsets and silently drop/duplicate rows in the
|
|
78
|
+
* snapshot). Keyset paging is deterministic under concurrent writes and avoids
|
|
79
|
+
* O(n^2) OFFSET scans on large tables.
|
|
80
|
+
*
|
|
81
|
+
* Tables are provisioned first (idempotent `CREATE … IF NOT EXISTS`): `.global()`
|
|
82
|
+
* tables are created lazily on first write, so a fresh deployment — or any table
|
|
83
|
+
* never written — would otherwise abort the stream with a raw `no such table`
|
|
84
|
+
* instead of exporting it as empty.
|
|
85
|
+
*/
|
|
61
86
|
declare const exportGlobalRows: (exec: SqlCtxExec, schema: SchemaLike, args: ExportGlobalArgs) => AsyncGenerator<ExportRow, void, undefined>;
|
|
62
87
|
interface ImportGlobalArgs {
|
|
63
88
|
/**
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
89
|
+
* Optional direct exec handle to the same D1 database the writer targets.
|
|
90
|
+
* When supplied, the conflict pre-probe issues a single
|
|
91
|
+
* `SELECT 1 FROM <table> WHERE id = ? LIMIT 1` against the row's declared
|
|
92
|
+
* table instead of falling back to `writer.get(id)`, which scans every
|
|
93
|
+
* global table looking for the id. Strongly recommended for large schemas
|
|
94
|
+
* — the writer-fallback is O(N tables) per row.
|
|
95
|
+
*/
|
|
71
96
|
exec?: D1ExecLike;
|
|
72
97
|
rows: ReadonlyArray<ExportRow>;
|
|
73
98
|
startLine?: number;
|
|
@@ -77,42 +102,13 @@ interface D1ExecLike {
|
|
|
77
102
|
all: (sql: string, parameters: ReadonlyArray<unknown>) => Promise<Record<string, unknown>[]>;
|
|
78
103
|
}
|
|
79
104
|
/**
|
|
80
|
-
* Import rows into `.global()` tables via the schema-aware D1 writer. The
|
|
81
|
-
* writer rejects unknown ids on `insert` (the writer assigns one when `_id` is
|
|
82
|
-
* absent); we pre-probe each row's `_id` so a collision is reported as a
|
|
83
|
-
* conflict instead of bubbled as a UNIQUE error. Schema-failed rows surface in
|
|
84
|
-
* `errors`; the rest land.
|
|
85
|
-
*/
|
|
105
|
+
* Import rows into `.global()` tables via the schema-aware D1 writer. The
|
|
106
|
+
* writer rejects unknown ids on `insert` (the writer assigns one when `_id` is
|
|
107
|
+
* absent); we pre-probe each row's `_id` so a collision is reported as a
|
|
108
|
+
* conflict instead of bubbled as a UNIQUE error. Schema-failed rows surface in
|
|
109
|
+
* `errors`; the rest land.
|
|
110
|
+
*/
|
|
86
111
|
declare const importGlobalRows: (writer: DatabaseWriterLike, schema: SchemaLike, args: ImportGlobalArgs) => Promise<ImportResult>;
|
|
87
|
-
/**
|
|
88
|
-
* Minimal structural projection of `D1Database` to keep the adapter
|
|
89
|
-
* compatible with the real workers-types value as well as unit-test doubles.
|
|
90
|
-
*/
|
|
91
|
-
interface D1DatabaseLike {
|
|
92
|
-
batch?: (statements: D1PreparedStatementLike[]) => Promise<unknown[]>;
|
|
93
|
-
exec?: (sql: string) => Promise<unknown>;
|
|
94
|
-
prepare: (sql: string) => D1PreparedStatementLike;
|
|
95
|
-
withSession: (bookmark?: string) => D1SessionLike;
|
|
96
|
-
}
|
|
97
|
-
interface D1SessionLike {
|
|
98
|
-
batch?: (statements: D1PreparedStatementLike[]) => Promise<unknown[]>;
|
|
99
|
-
getBookmark: () => string | null;
|
|
100
|
-
prepare: (sql: string) => D1PreparedStatementLike;
|
|
101
|
-
}
|
|
102
|
-
interface D1PreparedStatementLike {
|
|
103
|
-
all: <T = unknown>() => Promise<{
|
|
104
|
-
results: T[];
|
|
105
|
-
success: boolean;
|
|
106
|
-
}>;
|
|
107
|
-
bind: (...values: unknown[]) => D1PreparedStatementLike;
|
|
108
|
-
first: <T = unknown>(column?: string) => Promise<T | null>;
|
|
109
|
-
raw: <T = unknown>() => Promise<T[][]>;
|
|
110
|
-
run: <T = unknown>() => Promise<{
|
|
111
|
-
meta?: Record<string, unknown>;
|
|
112
|
-
results?: T[];
|
|
113
|
-
success: boolean;
|
|
114
|
-
}>;
|
|
115
|
-
}
|
|
116
112
|
/** Thin wrapper over a `D1DatabaseSession` exposing bookmark plumbing. */
|
|
117
113
|
declare class D1Session {
|
|
118
114
|
private readonly session;
|
|
@@ -131,67 +127,67 @@ declare class D1Session {
|
|
|
131
127
|
}>;
|
|
132
128
|
first<T = unknown>(sql: string, ...binds: unknown[]): Promise<T | null>;
|
|
133
129
|
/**
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
130
|
+
* Returns the most recent bookmark known to the session, or `undefined`
|
|
131
|
+
* when D1 has not issued one yet.
|
|
132
|
+
*/
|
|
137
133
|
getBookmark(): string | undefined;
|
|
138
134
|
}
|
|
139
135
|
declare class D1Client {
|
|
140
136
|
private readonly db;
|
|
141
137
|
/**
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
138
|
+
* SQL string -> prepared statement. Prepared statements are reusable in
|
|
139
|
+
* D1; preparing the same SQL twice forces the worker to round-trip the
|
|
140
|
+
* statement plan. Caching is per-instance so unit-test isolation holds.
|
|
141
|
+
* Bounded to {@link STMT_CACHE_CAPACITY} via LRU eviction.
|
|
142
|
+
*/
|
|
147
143
|
private readonly stmtCache;
|
|
148
144
|
/**
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
145
|
+
* Lazily-built drizzle handle over the bare binding. Memoised so a single
|
|
146
|
+
* `D1Client` reuses the same dialect/session machinery across calls.
|
|
147
|
+
*/
|
|
152
148
|
private drizzleHandle;
|
|
153
149
|
constructor(database: D1DatabaseLike);
|
|
154
150
|
/**
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
151
|
+
* Open a Sessions-API scoped session. Pass the bookmark forwarded by
|
|
152
|
+
* the client to opt into read-your-writes consistency.
|
|
153
|
+
*
|
|
154
|
+
* With no bookmark this is the first request of a session — there is no
|
|
155
|
+
* prior write to read, so we open with the explicit `"first-unconstrained"`
|
|
156
|
+
* constraint (Cloudflare's lowest-latency default: the first read may serve
|
|
157
|
+
* from any replica). Read-your-writes for sequenced requests still flows
|
|
158
|
+
* through the forwarded bookmark; a caller needing a strongly-consistent
|
|
159
|
+
* very-first read should pass `"first-primary"` as the bookmark instead.
|
|
160
|
+
*/
|
|
165
161
|
withSession(bookmark?: string): D1Session;
|
|
166
162
|
/**
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
163
|
+
* Prepare a statement, reusing a cached one when the SQL text matches.
|
|
164
|
+
* `bind()` on a prepared statement returns a new bound statement and
|
|
165
|
+
* leaves the underlying prepared plan reusable, so cache hits are safe
|
|
166
|
+
* even when the previous caller already called `.bind(...).run()`.
|
|
167
|
+
*/
|
|
172
168
|
prepare(sql: string): D1PreparedStatementLike;
|
|
173
169
|
/**
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
170
|
+
* Drizzle handle over the bare `env.DB` binding. Used for typed queries
|
|
171
|
+
* against generated `sqliteTable` schemas; does **not** participate in the
|
|
172
|
+
* D1 Sessions API (no bookmark pinning). For bookmark-scoped reads, use
|
|
173
|
+
* {@link drizzleSession} instead.
|
|
174
|
+
*/
|
|
179
175
|
get drizzle(): DrizzleD1Database<Record<string, unknown>>;
|
|
180
176
|
/**
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
177
|
+
* Drizzle handle scoped to a D1 Sessions-API session. The bookmark, when
|
|
178
|
+
* supplied, opts into read-your-writes consistency for follow-up reads on
|
|
179
|
+
* the same session.
|
|
180
|
+
*
|
|
181
|
+
* A `D1DatabaseSession` exposes the same `prepare` / `batch` surface
|
|
182
|
+
* drizzle calls into, so a single `unknown` cast lets us hand the session to
|
|
183
|
+
* the driver.
|
|
184
|
+
*/
|
|
189
185
|
drizzleSession(bookmark?: string): DrizzleD1Database<Record<string, unknown>>;
|
|
190
186
|
/**
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
187
|
+
* Atomic batch over the drizzle d1 driver. Mirrors `db.batch([...])`
|
|
188
|
+
* exactly; exposed on the client so callers don't need to hold a drizzle
|
|
189
|
+
* handle just to run a typed batch.
|
|
190
|
+
*/
|
|
195
191
|
batch<U extends BatchItem<"sqlite">, T extends Readonly<[U, ...U[]]>>(items: T): Promise<BatchResponse<T>>;
|
|
196
192
|
/** Direct access to the underlying binding (advanced use only). */
|
|
197
193
|
get raw(): D1DatabaseLike;
|
|
@@ -205,24 +201,24 @@ interface GlobalTableInfo {
|
|
|
205
201
|
interface GlobalTablePage {
|
|
206
202
|
columns: string[];
|
|
207
203
|
/**
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
204
|
+
* Foreign-key columns (local column → referenced table) for tables that carry
|
|
205
|
+
* real SQL `REFERENCES` constraints — recovered from `PRAGMA foreign_key_list`.
|
|
206
|
+
* Schema `.global()` tables omit this (their refs come from `describeTables`);
|
|
207
|
+
* external tables (e.g. better-auth's `session`/`twoFactor`) expose it so the
|
|
208
|
+
* schema diagram can draw their global→global FK edges.
|
|
209
|
+
*/
|
|
214
210
|
refs?: Record<string, string>;
|
|
215
211
|
rows: Record<string, unknown>[];
|
|
216
212
|
total: number;
|
|
217
213
|
}
|
|
218
214
|
/**
|
|
219
|
-
* One equality constraint a facet-value click adds to the global browser's view:
|
|
220
|
-
* `column = value` (or `column IS NULL` when `value` is nullish). `column` is a
|
|
221
|
-
* displayed column name, validated against the table's columns and mapped to its
|
|
222
|
-
* physical column (`_id` → `id`) before it is quoted; `value` is the **raw stored
|
|
223
|
-
* value** the facet returned (a SQLite scalar), bound as a parameter and never
|
|
224
|
-
* interpolated. AND-combined with the other clauses.
|
|
225
|
-
*/
|
|
215
|
+
* One equality constraint a facet-value click adds to the global browser's view:
|
|
216
|
+
* `column = value` (or `column IS NULL` when `value` is nullish). `column` is a
|
|
217
|
+
* displayed column name, validated against the table's columns and mapped to its
|
|
218
|
+
* physical column (`_id` → `id`) before it is quoted; `value` is the **raw stored
|
|
219
|
+
* value** the facet returned (a SQLite scalar), bound as a parameter and never
|
|
220
|
+
* interpolated. AND-combined with the other clauses.
|
|
221
|
+
*/
|
|
226
222
|
interface GlobalFilterClause {
|
|
227
223
|
column: string;
|
|
228
224
|
value: unknown;
|
|
@@ -234,13 +230,13 @@ interface ReadGlobalTablePageOptions {
|
|
|
234
230
|
table: string;
|
|
235
231
|
}
|
|
236
232
|
/**
|
|
237
|
-
* Options for {@link facetGlobalColumn} — the read-only "what values does this
|
|
238
|
-
* column hold?" summary for the global (D1) browser. `column` is the displayed
|
|
239
|
-
* column to group by (validated and mapped to its physical column, never
|
|
240
|
-
* interpolated); `filters` mirrors {@link ReadGlobalTablePageOptions}'s eq
|
|
241
|
-
* constraints so the facet reflects the **active view** (the same rows the
|
|
242
|
-
* browser is previewing); `limit` caps the distinct values returned (clamped).
|
|
243
|
-
*/
|
|
233
|
+
* Options for {@link facetGlobalColumn} — the read-only "what values does this
|
|
234
|
+
* column hold?" summary for the global (D1) browser. `column` is the displayed
|
|
235
|
+
* column to group by (validated and mapped to its physical column, never
|
|
236
|
+
* interpolated); `filters` mirrors {@link ReadGlobalTablePageOptions}'s eq
|
|
237
|
+
* constraints so the facet reflects the **active view** (the same rows the
|
|
238
|
+
* browser is previewing); `limit` caps the distinct values returned (clamped).
|
|
239
|
+
*/
|
|
244
240
|
interface FacetGlobalColumnOptions {
|
|
245
241
|
column: string;
|
|
246
242
|
filters?: GlobalFilterClause[];
|
|
@@ -253,43 +249,43 @@ interface GlobalFacetValue {
|
|
|
253
249
|
value: unknown;
|
|
254
250
|
}
|
|
255
251
|
/**
|
|
256
|
-
* Payload of a {@link facetGlobalColumn} call: the top-N distinct `values` (each
|
|
257
|
-
* with a `count`) ordered by frequency, plus `truncated` — `true` when more
|
|
258
|
-
* distinct values existed beyond the cap, so the UI can say so rather than imply
|
|
259
|
-
* the list is exhaustive. Mirrors the shard browser's `FacetColumnResult`.
|
|
260
|
-
*/
|
|
252
|
+
* Payload of a {@link facetGlobalColumn} call: the top-N distinct `values` (each
|
|
253
|
+
* with a `count`) ordered by frequency, plus `truncated` — `true` when more
|
|
254
|
+
* distinct values existed beyond the cap, so the UI can say so rather than imply
|
|
255
|
+
* the list is exhaustive. Mirrors the shard browser's `FacetColumnResult`.
|
|
256
|
+
*/
|
|
261
257
|
interface GlobalFacetResult {
|
|
262
258
|
truncated: boolean;
|
|
263
259
|
values: GlobalFacetValue[];
|
|
264
260
|
}
|
|
265
261
|
/**
|
|
266
|
-
* List every browsable D1 table with its row count, ordered by name. Surfaces
|
|
267
|
-
* both the schema's `.global()` tables (provisioned first) and external tables
|
|
268
|
-
* (auth, etc.); internal/companion tables are excluded.
|
|
269
|
-
*/
|
|
262
|
+
* List every browsable D1 table with its row count, ordered by name. Surfaces
|
|
263
|
+
* both the schema's `.global()` tables (provisioned first) and external tables
|
|
264
|
+
* (auth, etc.); internal/companion tables are excluded.
|
|
265
|
+
*/
|
|
270
266
|
declare const listGlobalTables: (exec: SqlCtxExec, schema: SchemaLike) => Promise<GlobalTableInfo[]>;
|
|
271
267
|
/**
|
|
272
|
-
* Read a page of rows from one D1 table. The table is validated against the live
|
|
273
|
-
* browsable-table list before its name is interpolated, so this can't be coerced
|
|
274
|
-
* into reading an internal table or injecting SQL. `limit` is clamped to
|
|
275
|
-
* `[1, 500]`; `offset` floors at `0`. `filters` AND-narrows the page to rows
|
|
276
|
-
* matching each `column = value` eq constraint (a facet-value drill-down), bound
|
|
277
|
-
* through {@link buildEqPredicate} so they never inject SQL.
|
|
278
|
-
*/
|
|
268
|
+
* Read a page of rows from one D1 table. The table is validated against the live
|
|
269
|
+
* browsable-table list before its name is interpolated, so this can't be coerced
|
|
270
|
+
* into reading an internal table or injecting SQL. `limit` is clamped to
|
|
271
|
+
* `[1, 500]`; `offset` floors at `0`. `filters` AND-narrows the page to rows
|
|
272
|
+
* matching each `column = value` eq constraint (a facet-value drill-down), bound
|
|
273
|
+
* through {@link buildEqPredicate} so they never inject SQL.
|
|
274
|
+
*/
|
|
279
275
|
declare const readGlobalTablePage: (exec: SqlCtxExec, schema: SchemaLike, options: ReadGlobalTablePageOptions) => Promise<GlobalTablePage>;
|
|
280
276
|
/**
|
|
281
|
-
* Summarise the distinct values of one displayed column over the **active view**
|
|
282
|
-
* (the same eq `filters` the global browser is previewing) — the D1 twin of the
|
|
283
|
-
* shard browser's `facetColumn`. Read-only: a `SELECT col AS value, COUNT(*) AS
|
|
284
|
-
* count … GROUP BY col ORDER BY count DESC LIMIT N+1`, with the column validated
|
|
285
|
-
* against the table's displayed columns (typed 404 if unknown), mapped to its
|
|
286
|
-
* physical column, and quoted — never interpolated from caller input. The extra
|
|
287
|
-
* over-fetched row is dropped and surfaced as `truncated`. A sensitive column on
|
|
288
|
-
* an external (non-schema) table is never grouped — it collapses to a single
|
|
289
|
-
* redacted `•••` bucket — mirroring the page browser's value redaction so the
|
|
290
|
-
* facet can't leak credentials. The returned `value` is the raw stored scalar, so
|
|
291
|
-
* a click feeds it straight back as an eq filter.
|
|
292
|
-
*/
|
|
277
|
+
* Summarise the distinct values of one displayed column over the **active view**
|
|
278
|
+
* (the same eq `filters` the global browser is previewing) — the D1 twin of the
|
|
279
|
+
* shard browser's `facetColumn`. Read-only: a `SELECT col AS value, COUNT(*) AS
|
|
280
|
+
* count … GROUP BY col ORDER BY count DESC LIMIT N+1`, with the column validated
|
|
281
|
+
* against the table's displayed columns (typed 404 if unknown), mapped to its
|
|
282
|
+
* physical column, and quoted — never interpolated from caller input. The extra
|
|
283
|
+
* over-fetched row is dropped and surfaced as `truncated`. A sensitive column on
|
|
284
|
+
* an external (non-schema) table is never grouped — it collapses to a single
|
|
285
|
+
* redacted `•••` bucket — mirroring the page browser's value redaction so the
|
|
286
|
+
* facet can't leak credentials. The returned `value` is the raw stored scalar, so
|
|
287
|
+
* a click feeds it straight back as an eq filter.
|
|
288
|
+
*/
|
|
293
289
|
declare const facetGlobalColumn: (exec: SqlCtxExec, schema: SchemaLike, options: FacetGlobalColumnOptions) => Promise<GlobalFacetResult>;
|
|
294
290
|
interface Migration {
|
|
295
291
|
/** Human-readable name, e.g. `001_init` (used in logs). */
|
|
@@ -310,20 +306,20 @@ interface MigrationRunnerResult {
|
|
|
310
306
|
}[];
|
|
311
307
|
}
|
|
312
308
|
/**
|
|
313
|
-
* Sequentially applies pending migrations against a D1 database via the
|
|
314
|
-
* drizzle-orm/d1 driver. Each migration is hashed (SHA-256 over its SQL
|
|
315
|
-
* text); the hash is stored in `__drizzle_migrations`, so re-applying the
|
|
316
|
-
* same SQL under a different `version` is rejected and identical migrations
|
|
317
|
-
* are skipped idempotently.
|
|
318
|
-
*/
|
|
309
|
+
* Sequentially applies pending migrations against a D1 database via the
|
|
310
|
+
* drizzle-orm/d1 driver. Each migration is hashed (SHA-256 over its SQL
|
|
311
|
+
* text); the hash is stored in `__drizzle_migrations`, so re-applying the
|
|
312
|
+
* same SQL under a different `version` is rejected and identical migrations
|
|
313
|
+
* are skipped idempotently.
|
|
314
|
+
*/
|
|
319
315
|
declare class MigrationRunner {
|
|
320
316
|
private readonly client;
|
|
321
317
|
private readonly migrations;
|
|
322
318
|
/**
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
319
|
+
* Accepts either a {@link D1Client} (preferred — gets typed batches +
|
|
320
|
+
* drizzle handle for free) or a raw `D1DatabaseLike` binding (wrapped on
|
|
321
|
+
* the caller's behalf so existing `@lunora/cli` callers keep working).
|
|
322
|
+
*/
|
|
327
323
|
constructor(database: D1Client | D1DatabaseLike, migrations: Migration[]);
|
|
328
324
|
run(): Promise<MigrationRunnerResult>;
|
|
329
325
|
private applyOne;
|
|
@@ -331,9 +327,9 @@ declare class MigrationRunner {
|
|
|
331
327
|
private assertUniqueSql;
|
|
332
328
|
}
|
|
333
329
|
/**
|
|
334
|
-
* The canonical SQLite dialect: column affinities, the shared SQLite value
|
|
335
|
-
* codec, `RETURNING` support (both D1 and `node:sqlite`), and `sqlite_master`
|
|
336
|
-
* table probing. The rest of the per-statement shaping is drizzle's.
|
|
337
|
-
*/
|
|
330
|
+
* The canonical SQLite dialect: column affinities, the shared SQLite value
|
|
331
|
+
* codec, `RETURNING` support (both D1 and `node:sqlite`), and `sqlite_master`
|
|
332
|
+
* table probing. The rest of the per-statement shaping is drizzle's.
|
|
333
|
+
*/
|
|
338
334
|
declare const sqliteDialect: SqlDialect;
|
|
339
|
-
export { D1Client, type D1ContextDatabaseOptions as D1CtxDbOptions,
|
|
335
|
+
export { D1Client, type D1ContextDatabaseOptions as D1CtxDbOptions, D1Session, type ExportGlobalArgs, type FacetGlobalColumnOptions, type ExportRow as GlobalExportRow, type GlobalFacetResult, type GlobalFacetValue, type GlobalFilterClause, type ImportError as GlobalImportError, type ImportResult as GlobalImportResult, type GlobalTableInfo, type GlobalTablePage, type ImportGlobalArgs, type Migration, MigrationRunner, type MigrationRunnerResult, type ReadGlobalTablePageOptions, backfillD1SearchIndexes, createD1ContextDatabase as createD1CtxDb, exportGlobalRows, facetGlobalColumn, importGlobalRows, listGlobalTables, readD1CdcChanges, readGlobalTablePage, runD1AggregateMigrations, runD1CdcMigration, runD1GlobalTableMigrations, runD1RankMigrations, runD1SearchMigrations, selectGlobalTables, sqliteDialect, trimD1CdcChanges };
|