@lunora/d1 1.0.0-alpha.9 → 1.0.0-alpha.91

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/index.d.mts CHANGED
@@ -1,6 +1,9 @@
1
- import { SchemaLike, DatabaseWriterLike } from '@lunora/do';
2
- import { SqlCtxDbOptions, createSqlCtxDb, SqlCtxExec, readSqlCdcChanges, SqlDialect } from '@lunora/sql-store';
1
+ import { SchemaLike, DatabaseWriterLike } from '@lunora/shard-engine';
2
+ export { applyCdcChanges } from '@lunora/shard-engine';
3
+ import { SqlCtxDbOptions, SqlCtxExec, createSqlCtxDb, readSqlCdcChanges, SqlDialect } from '@lunora/sql-store';
3
4
  export { type SqlCtxExec as D1Exec, type SqlCtxDbOptions, type SqlCtxExec, createSqlCtxDb } from '@lunora/sql-store';
5
+ import { D1DatabaseLike, D1SessionLike, D1PreparedStatementLike } from '@lunora/platform';
6
+ export type { D1DatabaseLike, D1PreparedStatementLike, D1SessionLike } from '@lunora/platform';
4
7
  import { BatchItem, BatchResponse } from 'drizzle-orm/batch';
5
8
  import { DrizzleD1Database } from 'drizzle-orm/d1';
6
9
  /** The D1 store options — the shared store options minus `dialect` (the SQLite dialect is injected for you). */
@@ -9,12 +12,14 @@ type D1ContextDatabaseOptions = Omit<SqlCtxDbOptions, "dialect">;
9
12
  declare const createD1ContextDatabase: (options: D1ContextDatabaseOptions) => ReturnType<typeof createSqlCtxDb>;
10
13
  /** Auto-provision the schema's `.global()` tables in D1 (idempotent `CREATE TABLE IF NOT EXISTS`). */
11
14
  declare const runD1GlobalTableMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
12
- /** Materialize the `__agg_&lt;index>` companion tables for the schema's aggregate indexes. */
15
+ /** Materialize the `__agg_<index>` companion tables for the schema's aggregate indexes. */
13
16
  declare const runD1AggregateMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
14
- /** Materialize the `__rank_&lt;index>` companion tables for the schema's rank indexes. */
17
+ /** Materialize the `__rank_<index>` companion tables for the schema's rank indexes. */
15
18
  declare const runD1RankMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
16
- /** Materialize the `__fts_&lt;index>` fts5 shadow tables for the schema's search indexes (no-op without fts5). */
19
+ /** Materialize (and backfill) the `__fts_<index>` fts5 shadow tables for the schema's search indexes. */
17
20
  declare const runD1SearchMigrations: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
21
+ /** Index existing rows into every search companion, including the `staged: true` ones migrations leave empty. */
22
+ declare const backfillD1SearchIndexes: (exec: SqlCtxExec, schema: SchemaLike) => Promise<void>;
18
23
  /** Create the `__cdc_log` table in D1 (idempotent; only run when CDC is enabled). */
19
24
  declare const runD1CdcMigration: (exec: SqlCtxExec) => Promise<void>;
20
25
  /** Read changelog entries newer than `sinceSeq` in commit order. */
@@ -22,11 +27,30 @@ declare const readD1CdcChanges: (exec: SqlCtxExec, options?: {
22
27
  limit?: number;
23
28
  sinceSeq?: number;
24
29
  }) => ReturnType<typeof readSqlCdcChanges>;
25
- /** Drop changelog entries at or below a checkpointed `throughSeq`. */
26
- declare const trimD1CdcChanges: (exec: SqlCtxExec, throughSeq: number) => Promise<void>;
30
+ /**
31
+ * Delete `.global()` changelog entries older than `retentionMs`, if this writer
32
+ * wins the fleet's sweep lease. See `sweepSqlCdcRetention`.
33
+ *
34
+ * Replaces the seq-based `trimD1CdcChanges`, which took a checkpoint no caller
35
+ * could compute: the log is shared across every shard and region, so no single
36
+ * caller knows a `seq` that is safe for all of them. A time window is a bound
37
+ * they can all reason about, and the lease is what stops them racing.
38
+ */
39
+ declare const sweepD1CdcRetention: (exec: SqlCtxExec, retentionMs: number, now: number) => Promise<void>;
27
40
  /** One exported row: `doc` is reconstructed from the column tuple. */
28
41
  interface ExportRow {
29
42
  doc: Record<string, unknown>;
43
+ /**
44
+ * True physical source line, when the caller has it (e.g. a global row
45
+ * pulled out of an interspersed NDJSON import stream by
46
+ * `@lunora/runtime`'s `import-stream.ts`). When present this overrides the
47
+ * position-derived line below — the caller-side positions of a
48
+ * global-only subset don't line up with the original file once
49
+ * non-global rows have been filtered out. Absent for callers with no
50
+ * physical source to attribute (e.g. a fresh `exportGlobalRows` roundtrip
51
+ * in tests), which keeps the positional fallback.
52
+ */
53
+ line?: number;
30
54
  table: string;
31
55
  }
32
56
  interface ImportError {
@@ -42,32 +66,42 @@ interface ImportResult {
42
66
  inserted: Record<string, number>;
43
67
  }
44
68
  /**
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
- */
69
+ * Return every `.global()` table in the schema, optionally narrowed by an
70
+ * allowlist. Shard-local tables are skipped here — they're handled by the DO
71
+ * helpers — so callers get a clean separation between the two storage planes.
72
+ */
49
73
  declare const selectGlobalTables: (schema: SchemaLike, requested?: ReadonlyArray<string>) => string[];
50
74
  interface ExportGlobalArgs {
51
75
  batchSize?: number;
52
76
  tables?: ReadonlyArray<string>;
53
77
  }
54
78
  /**
55
- * Yield rows from every requested `.global()` table in batches. Uses
56
- * `LIMIT ?/OFFSET ?` because D1 globals don't have a stable keyset abstraction
57
- * here (the writer's `findMany` does, but at the cost of routing through the
58
- * full validator pipeline; for a snapshot stream a plain offset scan is
59
- * sufficient and predictable).
60
- */
79
+ * Yield rows from every requested `.global()` table in batches.
80
+ *
81
+ * Keyset-paginates on the physical primary key (`id` — every `.global()` table
82
+ * carries it, see `frameworkColumnDdl`): `WHERE "id" > ? ORDER BY "id" LIMIT ?`,
83
+ * carrying the last id forward. A plain `LIMIT/OFFSET` scan would be wrong here —
84
+ * SQLite gives no ordering guarantee for an unordered SELECT and each page is a
85
+ * separate query, so pages could overlap or skip rows (and any concurrent
86
+ * insert/delete would shift offsets and silently drop/duplicate rows in the
87
+ * snapshot). Keyset paging is deterministic under concurrent writes and avoids
88
+ * O(n^2) OFFSET scans on large tables.
89
+ *
90
+ * Tables are provisioned first (idempotent `CREATE … IF NOT EXISTS`): `.global()`
91
+ * tables are created lazily on first write, so a fresh deployment — or any table
92
+ * never written — would otherwise abort the stream with a raw `no such table`
93
+ * instead of exporting it as empty.
94
+ */
61
95
  declare const exportGlobalRows: (exec: SqlCtxExec, schema: SchemaLike, args: ExportGlobalArgs) => AsyncGenerator<ExportRow, void, undefined>;
62
96
  interface ImportGlobalArgs {
63
97
  /**
64
- * Optional direct exec handle to the same D1 database the writer targets.
65
- * When supplied, the conflict pre-probe issues a single
66
- * `SELECT 1 FROM &lt;table> WHERE id = ? LIMIT 1` against the row's declared
67
- * table instead of falling back to `writer.get(id)`, which scans every
68
- * global table looking for the id. Strongly recommended for large schemas
69
- * — the writer-fallback is O(N tables) per row.
70
- */
98
+ * Optional direct exec handle to the same D1 database the writer targets.
99
+ * When supplied, the conflict pre-probe issues a single
100
+ * `SELECT 1 FROM <table> WHERE id = ? LIMIT 1` against the row's declared
101
+ * table instead of falling back to `writer.get(id)`, which scans every
102
+ * global table looking for the id. Strongly recommended for large schemas
103
+ * — the writer-fallback is O(N tables) per row.
104
+ */
71
105
  exec?: D1ExecLike;
72
106
  rows: ReadonlyArray<ExportRow>;
73
107
  startLine?: number;
@@ -77,121 +111,128 @@ interface D1ExecLike {
77
111
  all: (sql: string, parameters: ReadonlyArray<unknown>) => Promise<Record<string, unknown>[]>;
78
112
  }
79
113
  /**
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
- */
114
+ * Import rows into `.global()` tables via the schema-aware D1 writer. The
115
+ * writer rejects unknown ids on `insert` (the writer assigns one when `_id` is
116
+ * absent); we pre-probe each row's `_id` so a collision is reported as a
117
+ * conflict instead of bubbled as a UNIQUE error. Schema-failed rows surface in
118
+ * `errors`; the rest land.
119
+ */
86
120
  declare const importGlobalRows: (writer: DatabaseWriterLike, schema: SchemaLike, args: ImportGlobalArgs) => Promise<ImportResult>;
87
121
  /**
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
- /** Thin wrapper over a `D1DatabaseSession` exposing bookmark plumbing. */
122
+ * Thin wrapper over a `D1DatabaseSession` exposing bookmark plumbing.
123
+ *
124
+ * `all` and `first` retry D1's expected transient failures — but only for a
125
+ * statement that is provably read-only. D1 produces a documented
126
+ * baseline of infrastructural errors even when healthy (Cloudflare's team calls
127
+ * a handful every few hours "not unexpected") and their guidance is to retry;
128
+ * a client that does not has adopted that error rate as the application's own.
129
+ *
130
+ * Nothing else on this class or on {@link D1Client} retries. `run` is the write
131
+ * path, and every transient D1 error is ambiguous about whether the statement
132
+ * applied — re-running a non-idempotent write after a lost response
133
+ * double-applies it. `all` is not a read path either: D1 runs
134
+ * `UPDATE … RETURNING` through it, so the retry is gated on the statement's
135
+ * leading keyword rather than on the method name. Wrap a genuinely idempotent
136
+ * write in {@link withD1Retry} yourself, per call.
137
+ */
117
138
  declare class D1Session {
118
139
  private readonly session;
119
140
  /** See {@link D1Client.stmtCache}. Scoped per session. */
120
141
  private readonly stmtCache;
121
142
  constructor(session: D1SessionLike);
122
143
  prepare(sql: string): D1PreparedStatementLike;
144
+ /**
145
+ * Execute a statement. **Not retried** — `run` is the write path, and a
146
+ * transient D1 error does not say whether the write applied.
147
+ */
123
148
  run<T = unknown>(sql: string, ...binds: unknown[]): Promise<{
124
149
  meta?: Record<string, unknown>;
125
150
  results?: T[];
126
151
  success: boolean;
127
152
  }>;
153
+ /**
154
+ * Read all rows, retrying D1's transient failures when `sql` is a
155
+ * read-only statement. An `UPDATE … RETURNING` runs through here too and is
156
+ * left unretried.
157
+ */
128
158
  all<T = unknown>(sql: string, ...binds: unknown[]): Promise<{
129
159
  results: T[];
130
160
  success: boolean;
131
161
  }>;
162
+ /** Read the first row, retrying under the same read-only rule as {@link all}. */
132
163
  first<T = unknown>(sql: string, ...binds: unknown[]): Promise<T | null>;
133
164
  /**
134
- * Returns the most recent bookmark known to the session, or `undefined`
135
- * when D1 has not issued one yet.
136
- */
165
+ * Returns the most recent bookmark known to the session, or `undefined`
166
+ * when D1 has not issued one yet.
167
+ */
137
168
  getBookmark(): string | undefined;
138
169
  }
170
+ /**
171
+ * A D1 handle: prepared-statement caching, Sessions-API sessions, and the
172
+ * drizzle-typed accessors.
173
+ *
174
+ * **Nothing on this class retries.** `prepare`, `drizzle`, `drizzleSession`,
175
+ * `batch` and `raw` all hand back the underlying D1 surface untouched. The
176
+ * automatic retry lives on {@link D1Session.all} / {@link D1Session.first} and
177
+ * on `retryingExec` (the seam `.global()` tables read through); wrap anything
178
+ * else in {@link withD1Retry} yourself, and only when it is safe to run twice.
179
+ */
139
180
  declare class D1Client {
140
181
  private readonly db;
141
182
  /**
142
- * SQL string -> prepared statement. Prepared statements are reusable in
143
- * D1; preparing the same SQL twice forces the worker to round-trip the
144
- * statement plan. Caching is per-instance so unit-test isolation holds.
145
- * Bounded to {@link STMT_CACHE_CAPACITY} via LRU eviction.
146
- */
183
+ * SQL string -> prepared statement. Prepared statements are reusable in
184
+ * D1; preparing the same SQL twice forces the worker to round-trip the
185
+ * statement plan. Caching is per-instance so unit-test isolation holds.
186
+ * Bounded to {@link STMT_CACHE_CAPACITY} via LRU eviction.
187
+ */
147
188
  private readonly stmtCache;
148
189
  /**
149
- * Lazily-built drizzle handle over the bare binding. Memoised so a single
150
- * `D1Client` reuses the same dialect/session machinery across calls.
151
- */
190
+ * Lazily-built drizzle handle over the bare binding. Memoised so a single
191
+ * `D1Client` reuses the same dialect/session machinery across calls.
192
+ */
152
193
  private drizzleHandle;
153
194
  constructor(database: D1DatabaseLike);
154
195
  /**
155
- * Open a Sessions-API scoped session. Pass the bookmark forwarded by
156
- * the client to opt into read-your-writes consistency.
157
- *
158
- * With no bookmark this is the first request of a session — there is no
159
- * prior write to read, so we open with the explicit `"first-unconstrained"`
160
- * constraint (Cloudflare's lowest-latency default: the first read may serve
161
- * from any replica). Read-your-writes for sequenced requests still flows
162
- * through the forwarded bookmark; a caller needing a strongly-consistent
163
- * very-first read should pass `"first-primary"` as the bookmark instead.
164
- */
196
+ * Open a Sessions-API scoped session. Pass the bookmark forwarded by
197
+ * the client to opt into read-your-writes consistency.
198
+ *
199
+ * With no bookmark this is the first request of a session — there is no
200
+ * prior write to read, so we open with the explicit `"first-unconstrained"`
201
+ * constraint (Cloudflare's lowest-latency default: the first read may serve
202
+ * from any replica). Read-your-writes for sequenced requests still flows
203
+ * through the forwarded bookmark; a caller needing a strongly-consistent
204
+ * very-first read should pass `"first-primary"` as the bookmark instead.
205
+ */
165
206
  withSession(bookmark?: string): D1Session;
166
207
  /**
167
- * Prepare a statement, reusing a cached one when the SQL text matches.
168
- * `bind()` on a prepared statement returns a new bound statement and
169
- * leaves the underlying prepared plan reusable, so cache hits are safe
170
- * even when the previous caller already called `.bind(...).run()`.
171
- */
208
+ * Prepare a statement, reusing a cached one when the SQL text matches.
209
+ * `bind()` on a prepared statement returns a new bound statement and
210
+ * leaves the underlying prepared plan reusable, so cache hits are safe
211
+ * even when the previous caller already called `.bind(...).run()`.
212
+ */
172
213
  prepare(sql: string): D1PreparedStatementLike;
173
214
  /**
174
- * Drizzle handle over the bare `env.DB` binding. Used for typed queries
175
- * against generated `sqliteTable` schemas; does **not** participate in the
176
- * D1 Sessions API (no bookmark pinning). For bookmark-scoped reads, use
177
- * {@link drizzleSession} instead.
178
- */
215
+ * Drizzle handle over the bare `env.DB` binding. Used for typed queries
216
+ * against generated `sqliteTable` schemas; does **not** participate in the
217
+ * D1 Sessions API (no bookmark pinning). For bookmark-scoped reads, use
218
+ * {@link drizzleSession} instead.
219
+ */
179
220
  get drizzle(): DrizzleD1Database<Record<string, unknown>>;
180
221
  /**
181
- * Drizzle handle scoped to a D1 Sessions-API session. The bookmark, when
182
- * supplied, opts into read-your-writes consistency for follow-up reads on
183
- * the same session.
184
- *
185
- * A `D1DatabaseSession` exposes the same `prepare` / `batch` surface
186
- * drizzle calls into, so a single `unknown` cast lets us treat the session
187
- * as a `D1Database` for driver-construction purposes.
188
- */
222
+ * Drizzle handle scoped to a D1 Sessions-API session. The bookmark, when
223
+ * supplied, opts into read-your-writes consistency for follow-up reads on
224
+ * the same session.
225
+ *
226
+ * A `D1DatabaseSession` exposes the same `prepare` / `batch` surface
227
+ * drizzle calls into, so a single `unknown` cast lets us hand the session to
228
+ * the driver.
229
+ */
189
230
  drizzleSession(bookmark?: string): DrizzleD1Database<Record<string, unknown>>;
190
231
  /**
191
- * Atomic batch over the drizzle d1 driver. Mirrors `db.batch([...])`
192
- * exactly; exposed on the client so callers don't need to hold a drizzle
193
- * handle just to run a typed batch.
194
- */
232
+ * Atomic batch over the drizzle d1 driver. Mirrors `db.batch([...])`
233
+ * exactly; exposed on the client so callers don't need to hold a drizzle
234
+ * handle just to run a typed batch.
235
+ */
195
236
  batch<U extends BatchItem<"sqlite">, T extends Readonly<[U, ...U[]]>>(items: T): Promise<BatchResponse<T>>;
196
237
  /** Direct access to the underlying binding (advanced use only). */
197
238
  get raw(): D1DatabaseLike;
@@ -205,24 +246,24 @@ interface GlobalTableInfo {
205
246
  interface GlobalTablePage {
206
247
  columns: string[];
207
248
  /**
208
- * Foreign-key columns (local column → referenced table) for tables that carry
209
- * real SQL `REFERENCES` constraints — recovered from `PRAGMA foreign_key_list`.
210
- * Schema `.global()` tables omit this (their refs come from `describeTables`);
211
- * external tables (e.g. better-auth's `session`/`twoFactor`) expose it so the
212
- * schema diagram can draw their global→global FK edges.
213
- */
249
+ * Foreign-key columns (local column → referenced table) for tables that carry
250
+ * real SQL `REFERENCES` constraints — recovered from `PRAGMA foreign_key_list`.
251
+ * Schema `.global()` tables omit this (their refs come from `describeTables`);
252
+ * external tables (e.g. better-auth's `session`/`twoFactor`) expose it so the
253
+ * schema diagram can draw their global→global FK edges.
254
+ */
214
255
  refs?: Record<string, string>;
215
256
  rows: Record<string, unknown>[];
216
257
  total: number;
217
258
  }
218
259
  /**
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
- */
260
+ * One equality constraint a facet-value click adds to the global browser's view:
261
+ * `column = value` (or `column IS NULL` when `value` is nullish). `column` is a
262
+ * displayed column name, validated against the table's columns and mapped to its
263
+ * physical column (`_id` → `id`) before it is quoted; `value` is the **raw stored
264
+ * value** the facet returned (a SQLite scalar), bound as a parameter and never
265
+ * interpolated. AND-combined with the other clauses.
266
+ */
226
267
  interface GlobalFilterClause {
227
268
  column: string;
228
269
  value: unknown;
@@ -234,13 +275,13 @@ interface ReadGlobalTablePageOptions {
234
275
  table: string;
235
276
  }
236
277
  /**
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
- */
278
+ * Options for {@link facetGlobalColumn} — the read-only "what values does this
279
+ * column hold?" summary for the global (D1) browser. `column` is the displayed
280
+ * column to group by (validated and mapped to its physical column, never
281
+ * interpolated); `filters` mirrors {@link ReadGlobalTablePageOptions}'s eq
282
+ * constraints so the facet reflects the **active view** (the same rows the
283
+ * browser is previewing); `limit` caps the distinct values returned (clamped).
284
+ */
244
285
  interface FacetGlobalColumnOptions {
245
286
  column: string;
246
287
  filters?: GlobalFilterClause[];
@@ -253,43 +294,43 @@ interface GlobalFacetValue {
253
294
  value: unknown;
254
295
  }
255
296
  /**
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
- */
297
+ * Payload of a {@link facetGlobalColumn} call: the top-N distinct `values` (each
298
+ * with a `count`) ordered by frequency, plus `truncated` — `true` when more
299
+ * distinct values existed beyond the cap, so the UI can say so rather than imply
300
+ * the list is exhaustive. Mirrors the shard browser's `FacetColumnResult`.
301
+ */
261
302
  interface GlobalFacetResult {
262
303
  truncated: boolean;
263
304
  values: GlobalFacetValue[];
264
305
  }
265
306
  /**
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
- */
307
+ * List every browsable D1 table with its row count, ordered by name. Surfaces
308
+ * both the schema's `.global()` tables (provisioned first) and external tables
309
+ * (auth, etc.); internal/companion tables are excluded.
310
+ */
270
311
  declare const listGlobalTables: (exec: SqlCtxExec, schema: SchemaLike) => Promise<GlobalTableInfo[]>;
271
312
  /**
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
- */
313
+ * Read a page of rows from one D1 table. The table is validated against the live
314
+ * browsable-table list before its name is interpolated, so this can't be coerced
315
+ * into reading an internal table or injecting SQL. `limit` is clamped to
316
+ * `[1, 500]`; `offset` floors at `0`. `filters` AND-narrows the page to rows
317
+ * matching each `column = value` eq constraint (a facet-value drill-down), bound
318
+ * through {@link buildEqPredicate} so they never inject SQL.
319
+ */
279
320
  declare const readGlobalTablePage: (exec: SqlCtxExec, schema: SchemaLike, options: ReadGlobalTablePageOptions) => Promise<GlobalTablePage>;
280
321
  /**
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
- */
322
+ * Summarise the distinct values of one displayed column over the **active view**
323
+ * (the same eq `filters` the global browser is previewing) — the D1 twin of the
324
+ * shard browser's `facetColumn`. Read-only: a `SELECT col AS value, COUNT(*) AS
325
+ * count … GROUP BY col ORDER BY count DESC LIMIT N+1`, with the column validated
326
+ * against the table's displayed columns (typed 404 if unknown), mapped to its
327
+ * physical column, and quoted — never interpolated from caller input. The extra
328
+ * over-fetched row is dropped and surfaced as `truncated`. A sensitive column on
329
+ * an external (non-schema) table is never grouped — it collapses to a single
330
+ * redacted `•••` bucket — mirroring the page browser's value redaction so the
331
+ * facet can't leak credentials. The returned `value` is the raw stored scalar, so
332
+ * a click feeds it straight back as an eq filter.
333
+ */
293
334
  declare const facetGlobalColumn: (exec: SqlCtxExec, schema: SchemaLike, options: FacetGlobalColumnOptions) => Promise<GlobalFacetResult>;
294
335
  interface Migration {
295
336
  /** Human-readable name, e.g. `001_init` (used in logs). */
@@ -310,30 +351,109 @@ interface MigrationRunnerResult {
310
351
  }[];
311
352
  }
312
353
  /**
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
- */
354
+ * Sequentially applies pending migrations against a D1 database via the
355
+ * drizzle-orm/d1 driver. Each migration is hashed (SHA-256 over its SQL
356
+ * text); the hash is stored in `__drizzle_migrations`, so re-applying the
357
+ * same SQL under a different `version` is rejected and identical migrations
358
+ * are skipped idempotently.
359
+ */
319
360
  declare class MigrationRunner {
320
361
  private readonly client;
321
362
  private readonly migrations;
322
363
  /**
323
- * Accepts either a {@link D1Client} (preferred — gets typed batches +
324
- * drizzle handle for free) or a raw `D1DatabaseLike` binding (wrapped on
325
- * the caller's behalf so existing `@lunora/cli` callers keep working).
326
- */
364
+ * Accepts either a {@link D1Client} (preferred — gets typed batches +
365
+ * drizzle handle for free) or a raw `D1DatabaseLike` binding (wrapped on
366
+ * the caller's behalf so existing `@lunora/cli` callers keep working).
367
+ */
327
368
  constructor(database: D1Client | D1DatabaseLike, migrations: Migration[]);
328
369
  run(): Promise<MigrationRunnerResult>;
329
370
  private applyOne;
330
371
  private assertUniqueVersions;
331
372
  private assertUniqueSql;
332
373
  }
374
+ /** Tuning for {@link withD1Retry}. */
375
+ interface D1RetryOptions {
376
+ /** Total attempts including the first. Default 3. Must be >= 1. */
377
+ attempts?: number;
378
+ /**
379
+ * Total budget across every attempt and backoff, in ms. An attempt still
380
+ * running when the budget expires is abandoned, and a backoff never sleeps
381
+ * past it.
382
+ *
383
+ * `timeoutMs` bounds one attempt; this bounds the operation.
384
+ */
385
+ deadlineMs?: number;
386
+ /** Sleep implementation. Injected so tests need no timers. */
387
+ sleep?: (ms: number) => Promise<void>;
388
+ /**
389
+ * Abandon a single attempt that has not settled within this many ms, and
390
+ * treat it as a transient failure.
391
+ *
392
+ * There is no default — a legitimate analytical query and a stalled one
393
+ * look identical from outside, so the value has to come from what your
394
+ * workload actually needs. Unset, {@link SLOW_FAILURE_MS} stops a slow
395
+ * failure from being retried rather than guessing a bound for you.
396
+ *
397
+ * Only ever applied to operations that are safe to abandon. It does not
398
+ * cancel the underlying D1 call.
399
+ */
400
+ timeoutMs?: number;
401
+ }
402
+ /**
403
+ * True when `error` looks like one of D1's expected transient failures.
404
+ *
405
+ * Deliberately conservative: an unrecognised error is treated as **permanent**
406
+ * and surfaces immediately. Retrying a genuine bug — a syntax error, a
407
+ * constraint violation — turns one fast failure into three slow ones and
408
+ * hides the cause.
409
+ * @experimental
410
+ */
411
+ declare const isTransientD1Error: (error: unknown) => boolean;
412
+ /**
413
+ * Thrown when an attempt is abandoned for exceeding
414
+ * {@link D1RetryOptions.timeoutMs}.
415
+ *
416
+ * Its own class so a caller can tell "D1 hung" apart from "D1 returned an
417
+ * error" — they have different remedies, and collapsing them hides which one
418
+ * is happening.
419
+ * @experimental
420
+ */
421
+ declare class D1TimeoutError extends Error {
422
+ /** Milliseconds waited before the attempt was abandoned. */
423
+ readonly timeoutMs: number;
424
+ constructor(timeoutMs: number);
425
+ }
426
+ /**
427
+ * Run `operation`, retrying D1's transient failures with exponential backoff
428
+ * and jitter.
429
+ *
430
+ * **Only wrap operations that are safe to run more than once.** Reads always
431
+ * are. A write is only if it is idempotent — an upsert keyed on a primary key,
432
+ * a delete by id, an `INSERT OR IGNORE`. A bare `INSERT` or a relative
433
+ * `UPDATE` is not, and re-running one after a lost response double-applies it.
434
+ * @experimental
435
+ */
436
+ declare const withD1Retry: <T>(operation: () => Promise<T>, options?: D1RetryOptions) => Promise<T>;
437
+ /**
438
+ * Wrap a `.global()` exec so its **read-only** statements retry D1's transient
439
+ * failures.
440
+ *
441
+ * This is where the retry has to live to reach an application: `.global()`
442
+ * tables run every read through the exec codegen builds over the raw D1
443
+ * binding, not through a `D1Client`. `run` and `batch` are passed straight
444
+ * through — they are the write path, and a transient D1 error does not say
445
+ * whether the write applied.
446
+ *
447
+ * `all` is not the read path either. It only retries when
448
+ * {@link isReadOnlyD1Sql} proves the statement is one, because `UPDATE …
449
+ * RETURNING` runs through `all` too.
450
+ * @experimental
451
+ */
452
+ declare const retryingExec: (exec: SqlCtxExec, options?: D1RetryOptions) => SqlCtxExec;
333
453
  /**
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
- */
454
+ * The canonical SQLite dialect: column affinities, the shared SQLite value
455
+ * codec, `RETURNING` support (both D1 and `node:sqlite`), and `sqlite_master`
456
+ * table probing. The rest of the per-statement shaping is drizzle's.
457
+ */
338
458
  declare const sqliteDialect: SqlDialect;
339
- export { D1Client, type D1ContextDatabaseOptions as D1CtxDbOptions, type D1DatabaseLike, type D1PreparedStatementLike, D1Session, type D1SessionLike, 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, createD1ContextDatabase as createD1CtxDb, exportGlobalRows, facetGlobalColumn, importGlobalRows, listGlobalTables, readD1CdcChanges, readGlobalTablePage, runD1AggregateMigrations, runD1CdcMigration, runD1GlobalTableMigrations, runD1RankMigrations, runD1SearchMigrations, selectGlobalTables, sqliteDialect, trimD1CdcChanges };
459
+ export { D1Client, type D1ContextDatabaseOptions as D1CtxDbOptions, type D1RetryOptions, D1Session, D1TimeoutError, 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, isTransientD1Error, listGlobalTables, readD1CdcChanges, readGlobalTablePage, retryingExec, runD1AggregateMigrations, runD1CdcMigration, runD1GlobalTableMigrations, runD1RankMigrations, runD1SearchMigrations, selectGlobalTables, sqliteDialect, sweepD1CdcRetention, withD1Retry };