@lunora/cli 1.0.0-alpha.44 → 1.0.0-alpha.441
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 +33 -0
- package/README.md +3 -1
- package/dist/bin.mjs +3 -10
- package/dist/cli.d.mts +31 -0
- package/dist/cli.d.ts +31 -0
- package/dist/cli.mjs +1 -0
- package/dist/index.d.mts +1087 -386
- package/dist/index.d.ts +1087 -386
- package/dist/index.mjs +1 -19
- package/dist/packem_chunks/cli.mjs +2 -0
- package/dist/packem_chunks/dispatch.mjs +1 -0
- package/dist/packem_chunks/handler.mjs +17 -158
- package/dist/packem_chunks/handler10.mjs +1 -16
- package/dist/packem_chunks/handler11.mjs +1 -22
- package/dist/packem_chunks/handler12.mjs +1 -192
- package/dist/packem_chunks/handler13.mjs +1 -131
- package/dist/packem_chunks/handler14.mjs +3 -65
- package/dist/packem_chunks/handler15.mjs +1 -58
- package/dist/packem_chunks/handler16.mjs +1 -80
- package/dist/packem_chunks/handler17.mjs +1 -43
- package/dist/packem_chunks/handler18.mjs +7 -105
- package/dist/packem_chunks/handler19.mjs +2 -170
- package/dist/packem_chunks/handler2.mjs +1 -114
- package/dist/packem_chunks/handler20.mjs +1 -94
- package/dist/packem_chunks/handler21.mjs +3 -94
- package/dist/packem_chunks/handler22.mjs +3 -0
- package/dist/packem_chunks/handler23.mjs +1 -0
- package/dist/packem_chunks/handler24.mjs +2 -0
- package/dist/packem_chunks/handler25.mjs +1 -0
- package/dist/packem_chunks/handler26.mjs +99 -0
- package/dist/packem_chunks/handler27.mjs +15 -0
- package/dist/packem_chunks/handler28.mjs +1 -0
- package/dist/packem_chunks/handler3.mjs +1 -204
- package/dist/packem_chunks/handler4.mjs +1 -33
- package/dist/packem_chunks/handler5.mjs +3 -49
- package/dist/packem_chunks/handler6.mjs +1 -91
- package/dist/packem_chunks/handler7.mjs +1 -42
- package/dist/packem_chunks/handler8.mjs +1 -174
- package/dist/packem_chunks/handler9.mjs +2 -315
- package/dist/packem_chunks/runCodegenCommand.mjs +4 -52
- package/dist/packem_chunks/runDevCommand.mjs +6 -0
- package/dist/packem_chunks/runInitCommand.mjs +189 -1432
- package/dist/packem_chunks/runResetCommand.mjs +1 -41
- package/dist/packem_chunks/runRpcCommand.mjs +1 -68
- package/dist/packem_shared/DEFAULT_IMPORT_BATCH_SIZE-BwTREKH3.mjs +1 -0
- package/dist/packem_shared/EXIT_CODE-D_XCixv8.mjs +1 -0
- package/dist/packem_shared/admin-token-VdUnvnKW.mjs +1 -0
- package/dist/packem_shared/admin-url-DJB8P6Jh.mjs +1 -0
- package/dist/packem_shared/api-spec-lYyq4vL6.mjs +1 -0
- package/dist/packem_shared/binding-manifest-file-CQ1eQYy1.mjs +2 -0
- package/dist/packem_shared/buildRegistryIndex-Dc8D8AR6.mjs +1 -0
- package/dist/packem_shared/cap-error-body-YBKO32BF.mjs +1 -0
- package/dist/packem_shared/catalog-CahzmDLV.mjs +1 -0
- package/dist/packem_shared/cli-manifest-DoQ_3bzs.mjs +1 -0
- package/dist/packem_shared/cloudflare-credentials-BVmZnDZk.mjs +1 -0
- package/dist/packem_shared/codegen-error-AmH54ofi.mjs +3 -0
- package/dist/packem_shared/command-CB4JM-Jl.mjs +1 -0
- package/dist/packem_shared/commands-DvSfLvyt.mjs +13 -0
- package/dist/packem_shared/createLogger-4TujevyB.mjs +2 -0
- package/dist/packem_shared/createRecordingSpawner-01ZngIwK.mjs +1 -0
- package/dist/packem_shared/deploy-target-resolve-BTCW1Iv4.mjs +1 -0
- package/dist/packem_shared/diffSnapshots-htqNZT8Q.mjs +7 -0
- package/dist/packem_shared/docker-DpVxvYpL.mjs +1 -0
- package/dist/packem_shared/free-port-DjbFhaaT.mjs +1 -0
- package/dist/packem_shared/health-probe-Bw9JFfIy.mjs +1 -0
- package/dist/packem_shared/import-ZdIj7W66.mjs +13 -0
- package/dist/packem_shared/index-oHZBGBwB.mjs +1 -0
- package/dist/packem_shared/insertSchemaExtension-DuiV6cba.mjs +8 -0
- package/dist/packem_shared/lint-ignore-report-DKZagpqk.mjs +2 -0
- package/dist/packem_shared/mcp-config-file-GR1Y_CVw.mjs +2 -0
- package/dist/packem_shared/open-url-EnKy--w-.mjs +1 -0
- package/dist/packem_shared/output-format-DWe_tkTR.mjs +2 -0
- package/dist/packem_shared/parseManifest-CwPTKdtS.mjs +1 -0
- package/dist/packem_shared/path-containment-CgxYZggb.mjs +1 -0
- package/dist/packem_shared/plan-lzllz0Cn.mjs +5 -0
- package/dist/packem_shared/planDevCommand-HmQ01PRq.mjs +1 -0
- package/dist/packem_shared/platform-diagnostics-Cn2g6Jh-.mjs +4 -0
- package/dist/packem_shared/prompt-cancelled-BvsNxg_Q.mjs +1 -0
- package/dist/packem_shared/render-lunora-error-B6893vbU.mjs +2 -0
- package/dist/packem_shared/resolve-Bdc9KEUv.mjs +5 -0
- package/dist/packem_shared/resolve-target-C_ZloTvd.mjs +1 -0
- package/dist/packem_shared/runAddCommand-BChdJQ5L.mjs +1 -0
- package/dist/packem_shared/runDeployCommand-CwgnRrbK.mjs +1 -0
- package/dist/packem_shared/runExportCommand-slAq5BCF.mjs +5 -0
- package/dist/packem_shared/runMigrateGenerateCommand-rZdsVcFj.mjs +11 -0
- package/dist/packem_shared/schemaIrToSnapshot-BHuNOfgs.mjs +1 -0
- package/dist/packem_shared/shared-D-zCOmgY.mjs +1 -0
- package/dist/packem_shared/storage-CAiRP6Gr.mjs +1 -0
- package/dist/packem_shared/tui-prompts-B3YwUhGw.mjs +4 -0
- package/dist/packem_shared/variables-CPYyJtsL.mjs +1 -0
- package/dist/packem_shared/vectorize-metadata-DOB1akh6.mjs +2 -0
- package/dist/packem_shared/wrangler-name-Dsk5K1f-.mjs +1 -0
- package/dist/packem_shared/wrangler-secrets-DlSlWvRH.mjs +1 -0
- package/package.json +43 -19
- package/skills/README.md +36 -17
- package/skills/lunora/SKILL.md +158 -65
- package/skills/lunora-cloudflare-audit/SKILL.md +163 -0
- package/skills/lunora-create-package/SKILL.md +97 -84
- package/skills/lunora-deploy/SKILL.md +175 -105
- package/skills/lunora-functions/SKILL.md +367 -60
- package/skills/lunora-migration-helper/SKILL.md +162 -137
- package/skills/lunora-performance-audit/SKILL.md +137 -95
- package/skills/lunora-quickstart/SKILL.md +136 -136
- package/skills/lunora-realtime/SKILL.md +217 -97
- package/skills/lunora-setup-auth/SKILL.md +203 -101
- package/skills/lunora-setup-hyperdrive/SKILL.md +130 -109
- package/skills/lunora-setup-hyperdrive-global/SKILL.md +93 -90
- package/skills/lunora-setup-mail/SKILL.md +85 -113
- package/skills/lunora-setup-scheduler/SKILL.md +132 -96
- package/skills/lunora-setup-storage/SKILL.md +189 -95
- package/dist/packem_chunks/planDevCommand.mjs +0 -541
- package/dist/packem_chunks/runDeployCommand.mjs +0 -594
- package/dist/packem_chunks/runMigrateGenerateCommand.mjs +0 -397
- package/dist/packem_shared/COMMANDS-B0ftFD_3.mjs +0 -948
- package/dist/packem_shared/DEFAULT_IMPORT_BATCH_SIZE-Ck-2bU08.mjs +0 -244
- package/dist/packem_shared/admin-url-4UzT-CI4.mjs +0 -19
- package/dist/packem_shared/api-spec-CtA6ilu4.mjs +0 -13
- package/dist/packem_shared/buildRegistryIndex-BcYe607_.mjs +0 -38
- package/dist/packem_shared/codegen-error-DJG-ghs_.mjs +0 -31
- package/dist/packem_shared/command-D3lB_4Az.mjs +0 -19
- package/dist/packem_shared/commands-B-gR09Z_.mjs +0 -845
- package/dist/packem_shared/createLogger-B40gPzQo.mjs +0 -78
- package/dist/packem_shared/createRecordingSpawner-DxI3mebw.mjs +0 -43
- package/dist/packem_shared/detect-package-manager-DYp7n3mJ.mjs +0 -61
- package/dist/packem_shared/diffSnapshots-BeDvvNiF.mjs +0 -161
- package/dist/packem_shared/docker-hMQ97KSQ.mjs +0 -21
- package/dist/packem_shared/insertSchemaExtension-DAqbfr9Z.mjs +0 -64
- package/dist/packem_shared/open-url-Dfq6fAyT.mjs +0 -41
- package/dist/packem_shared/output-format-wUvAN6AL.mjs +0 -17
- package/dist/packem_shared/parseArgs-YXFuKdEk.mjs +0 -56
- package/dist/packem_shared/parseManifest--vZf2FY1.mjs +0 -94
- package/dist/packem_shared/prompt-cancelled-APzX1Im-.mjs +0 -9
- package/dist/packem_shared/resolve-target-qbsJ_5sF.mjs +0 -16
- package/dist/packem_shared/runAddCommand-bnY6-HKb.mjs +0 -4
- package/dist/packem_shared/schema-drift-gate-BtBt0as0.mjs +0 -79
- package/dist/packem_shared/schemaIrToSnapshot-DdsljJT-.mjs +0 -43
- package/dist/packem_shared/storage-BIsph-Vk.mjs +0 -84
- package/dist/packem_shared/tui-prompts-BjEN8XgP.mjs +0 -658
- package/dist/packem_shared/wrangler-name-cy4yhm9j.mjs +0 -12
- package/dist/packem_shared/wrangler-secrets-P2_ZUR-k.mjs +0 -47
|
@@ -1,90 +1,61 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: lunora-setup-hyperdrive
|
|
3
|
-
description: Connects an existing Postgres/MySQL database to a Lunora app
|
|
3
|
+
description: Connects an existing, externally owned Postgres/MySQL database to a Lunora app through Cloudflare Hyperdrive. Lunora does not own its schema. Covers `@lunora/hyperdrive`, the action-only, non-reactive `ctx.sql` client (`createHyperdrive` + `fromPostgresJs`/`fromNodePg`/`fromMysql2`, wired with the app builder's `.hyperdrive()`), the `HYPERDRIVE` binding and `wrangler hyperdrive create`, and making external rows live through a projection or a `.source()` ingest table. Use when the user wants to "query our existing Postgres", "read the legacy DB from an action", "connect Neon/RDS/Supabase", or sync external rows into Lunora, or sees `ctx.sql` / `hyperdrive_outside_action` errors. For storing Lunora's own `.global()` tables in Postgres/MySQL with reactive live queries, use `lunora-setup-hyperdrive-global` instead.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Lunora Setup Hyperdrive
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
>
|
|
15
|
-
>
|
|
16
|
-
>
|
|
17
|
-
>
|
|
18
|
-
>
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
## When to Use
|
|
23
|
-
|
|
24
|
-
- Reading/writing an existing Postgres or MySQL database from a Lunora action.
|
|
25
|
-
- Incrementally migrating off a legacy DB while standing up Lunora alongside it.
|
|
26
|
-
- Backfilling/syncing external rows into reactive Lunora tables (projection).
|
|
27
|
-
|
|
28
|
-
## When Not to Use
|
|
29
|
-
|
|
30
|
-
- You want the external data to be **reactive** out of the box — it can't be;
|
|
31
|
-
Hyperdrive writes don't hit the change-feed. Project into a `defineSchema`
|
|
32
|
-
table instead.
|
|
33
|
-
- You're reaching for `ctx.sql` inside a `query` or `mutation` — forbidden by
|
|
34
|
-
design (the advisor lint flags it). Move the access into an `action`.
|
|
35
|
-
- The app has no Lunora backend yet — use `lunora-quickstart` first.
|
|
36
|
-
- You'd be replacing `defineSchema` entirely — then you lose realtime, OCC,
|
|
37
|
-
optimistic updates, the offline queue, and the advisors. Use Lunora's own data
|
|
38
|
-
layer for app state.
|
|
39
|
-
|
|
40
|
-
## Workflow
|
|
41
|
-
|
|
42
|
-
1. Install `@lunora/hyperdrive` and one SQL driver.
|
|
43
|
-
2. Create the Hyperdrive config (`wrangler hyperdrive create`) and add the
|
|
44
|
-
`HYPERDRIVE` binding to `wrangler.jsonc`.
|
|
45
|
-
3. Regenerate types with `lunora codegen` so `ctx.sql` appears on `ActionCtx`.
|
|
46
|
-
4. Read/write the external DB from an action via `ctx.sql`.
|
|
47
|
-
5. (Optional) Project external rows into a `defineSchema` table to make them
|
|
48
|
-
reactive.
|
|
49
|
-
|
|
50
|
-
## Step 1: Install the package + a driver
|
|
8
|
+
`@lunora/hyperdrive` exposes a Cloudflare Hyperdrive binding as a
|
|
9
|
+
driver-agnostic `ctx.sql` client that is available only inside an `action`. It integrates
|
|
10
|
+
a database Lunora doesn't own. Don't use it to replace `defineSchema`, because you'd lose
|
|
11
|
+
realtime, OCC, optimistic updates, the offline queue and the advisors.
|
|
12
|
+
|
|
13
|
+
> **`ctx.sql` is not reactive.** Lunora cannot see this database, so subscriptions
|
|
14
|
+
> do not re-run when its rows change, including rows you write through `ctx.sql`.
|
|
15
|
+
> Queries are non-deterministic, so `ctx.sql` exists only on `ActionCtx`.
|
|
16
|
+
> The `hyperdrive_outside_action` advisor lint flags any use in a
|
|
17
|
+
> `query`/`mutation`. To make the data live, see Step 5. If you instead want Lunora-owned tables
|
|
18
|
+
> stored in Postgres/MySQL and fully reactive, use `lunora-setup-hyperdrive-global`.
|
|
19
|
+
|
|
20
|
+
## Step 1: Install the package + one driver
|
|
51
21
|
|
|
52
22
|
```bash
|
|
53
23
|
pnpm add @lunora/hyperdrive
|
|
54
|
-
|
|
55
|
-
pnpm add
|
|
56
|
-
# or
|
|
57
|
-
pnpm add pg # node-postgres → fromNodePg ($1, $2 placeholders)
|
|
58
|
-
# or
|
|
59
|
-
pnpm add mysql2 # mysql2 → fromMysql2 (? placeholders)
|
|
24
|
+
pnpm add postgres # → fromPostgresJs ($1, $2 placeholders)
|
|
25
|
+
# or: pnpm add pg → fromNodePg ($1, $2)
|
|
26
|
+
# or: pnpm add mysql2 → fromMysql2 (?)
|
|
60
27
|
```
|
|
61
28
|
|
|
29
|
+
The drivers are optional peer dependencies, so none ships with the package.
|
|
30
|
+
The package never rewrites SQL, so use your driver's native placeholders.
|
|
31
|
+
|
|
62
32
|
## Step 2: Create the binding
|
|
63
33
|
|
|
34
|
+
Nothing to write by hand: `lunora dev` and `lunora deploy` add a `HYPERDRIVE` binding
|
|
35
|
+
to `wrangler.jsonc` with a placeholder `id`.
|
|
36
|
+
|
|
37
|
+
- **Dev.** `ctx.sql` runs on an embedded Postgres (PGlite), data in
|
|
38
|
+
`.wrangler/state/lunora-pglite`. Install its two optional packages:
|
|
39
|
+
|
|
64
40
|
```bash
|
|
65
|
-
|
|
41
|
+
pnpm add -D @electric-sql/pglite @electric-sql/pglite-socket
|
|
66
42
|
```
|
|
67
43
|
|
|
68
|
-
|
|
69
|
-
`
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
{
|
|
76
|
-
"binding": "HYPERDRIVE",
|
|
77
|
-
"id": "<the id from the command above>",
|
|
78
|
-
"localConnectionString": "postgres://user:pass@localhost:5432/db", // gitleaks:allow -- placeholder, not a real secret
|
|
79
|
-
},
|
|
80
|
-
],
|
|
81
|
-
}
|
|
44
|
+
To use your own database, set `localConnectionString` on the binding or
|
|
45
|
+
`CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_<BINDING>`; neither is overridden.
|
|
46
|
+
|
|
47
|
+
- **Deploy.** Give `lunora deploy` the origin and a token that may edit Hyperdrive:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
LUNORA_HYPERDRIVE_URL="postgres://user:pass@host:5432/db" lunora deploy # gitleaks:allow -- placeholder, not a real secret
|
|
82
51
|
```
|
|
83
52
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
53
|
+
(`CLOUDFLARE_API_TOKEN` with Hyperdrive: Edit, and `CLOUDFLARE_ACCOUNT_ID`; the variable is
|
|
54
|
+
`LUNORA_<BINDING>_URL`.) Lunora creates the config, or reuses one of the same name, and writes
|
|
55
|
+
its `id` into `wrangler.jsonc`. The connection string is never written or logged.
|
|
56
|
+
|
|
57
|
+
To manage the config yourself, run `wrangler hyperdrive create my-db --connection-string=...`
|
|
58
|
+
and put the `id` in the binding. Validation fails without a `binding`.
|
|
88
59
|
|
|
89
60
|
## Step 3: Regenerate types
|
|
90
61
|
|
|
@@ -92,63 +63,113 @@ that's a remote resource only `wrangler hyperdrive create` can mint. Importing
|
|
|
92
63
|
lunora codegen
|
|
93
64
|
```
|
|
94
65
|
|
|
95
|
-
When
|
|
96
|
-
|
|
97
|
-
determinism/realtime caveat.
|
|
66
|
+
When `ctx.sql` is used, codegen adds `readonly sql: SqlClient` to `ActionCtx` only. It also
|
|
67
|
+
emits a `.hyperdrive()` method on the generated app builder.
|
|
98
68
|
|
|
99
|
-
## Step 4:
|
|
69
|
+
## Step 4: Wire the client on the app builder
|
|
100
70
|
|
|
101
|
-
|
|
71
|
+
`ctx.sql` is `readonly`, so assigning it in a handler is a `TS2540` error.
|
|
72
|
+
Codegen can't build the client because it depends on your driver, so supply a
|
|
73
|
+
thunk instead. It runs once per shard construction, not per request:
|
|
74
|
+
|
|
75
|
+
```ts title="src/server.ts"
|
|
76
|
+
import type { HyperdriveLike } from "@lunora/hyperdrive";
|
|
102
77
|
import { createHyperdrive, fromPostgresJs } from "@lunora/hyperdrive";
|
|
103
78
|
import postgres from "postgres";
|
|
104
79
|
|
|
105
|
-
import {
|
|
80
|
+
import { defineApp } from "../lunora/_generated/app.js";
|
|
106
81
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
82
|
+
const app = defineApp<Env>()
|
|
83
|
+
.shard((env) => env.SHARD)
|
|
84
|
+
.hyperdrive((env) => fromPostgresJs(postgres(createHyperdrive(env.HYPERDRIVE as HyperdriveLike).connectionString)))
|
|
85
|
+
.build();
|
|
86
|
+
|
|
87
|
+
export const ShardDO = app.ShardDO;
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Then query from any action:
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
import { LunoraError } from "lunorash/server";
|
|
94
|
+
|
|
95
|
+
import { action, v } from "#lunora/_generated/server.js";
|
|
110
96
|
|
|
111
|
-
|
|
97
|
+
export const listLegacyOrders = action.input({ orgId: v.string() }).action(async ({ ctx, args: { orgId } }) => {
|
|
98
|
+
if (!ctx.auth.userId) {
|
|
99
|
+
throw new LunoraError("UNAUTHORIZED", "not signed in");
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
// `orgId` comes from the client: the join scopes it to orgs the caller belongs to.
|
|
103
|
+
return ctx.sql.query<{ id: string; total: number }>(
|
|
104
|
+
"select o.id, o.total from orders o join org_members m on m.org_id = o.org where o.org = $1 and m.user_id = $2",
|
|
105
|
+
[orgId, ctx.auth.userId],
|
|
106
|
+
);
|
|
112
107
|
});
|
|
113
108
|
```
|
|
114
109
|
|
|
115
|
-
|
|
116
|
-
Postgres, `?` for MySQL).
|
|
110
|
+
**Verify:** call the action from the studio's function runner and check that it returns rows.
|
|
117
111
|
|
|
118
|
-
## Step 5 (optional): Make
|
|
112
|
+
## Step 5 (optional): Make external data reactive
|
|
119
113
|
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
114
|
+
Pick one approach:
|
|
115
|
+
|
|
116
|
+
**A. Projection from an action.** This works when your app is the writer. Write the row into a
|
|
117
|
+
`defineSchema` table through a mutation. That write is tracked:
|
|
123
118
|
|
|
124
119
|
```ts
|
|
120
|
+
import { LunoraError } from "lunorash/server";
|
|
121
|
+
|
|
122
|
+
import { internal } from "#lunora/_generated/internal.js";
|
|
123
|
+
|
|
125
124
|
const [row] = await ctx.sql.query<{ id: string; total: number }>("select id, total from orders where id = $1", [id]);
|
|
126
125
|
|
|
127
|
-
|
|
128
|
-
|
|
126
|
+
if (!row) {
|
|
127
|
+
throw new LunoraError("NOT_FOUND", `order ${id} not found`);
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// Re-runs live queries over `orders`. ctx.run* takes a generated reference, not a "file:fn" string.
|
|
131
|
+
await ctx.runMutation(internal.orders.upsert, { id: row.id, total: row.total });
|
|
129
132
|
```
|
|
130
133
|
|
|
134
|
+
**B. A `.source()` table.** This works when other systems also write the database. Lunora polls
|
|
135
|
+
the external query on the shard's alarm, diffs the result, materializes it into the
|
|
136
|
+
DO's SQLite and notifies subscribers, so you don't write an action or a cron:
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
// lunora/schema.ts
|
|
140
|
+
messages: defineTable({ body: v.string(), channelId: v.string() })
|
|
141
|
+
.shardBy("channelId")
|
|
142
|
+
.source({
|
|
143
|
+
binding: "HYPERDRIVE",
|
|
144
|
+
query: 'select id, body, channel_id as "channelId" from messages where channel_id = $1',
|
|
145
|
+
tenantBy: (shardKey) => [shardKey], // required under .shardBy(): the tenant boundary
|
|
146
|
+
}),
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
// worker entry: one client per binding name
|
|
151
|
+
.sourceClient((env, binding) => fromPostgresJs(postgres((env[binding] as { connectionString: string }).connectionString)))
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
How `.source()` behaves:
|
|
155
|
+
|
|
156
|
+
- Freshness depends on the poll interval: every alarm tick by default,
|
|
157
|
+
`refresh: { everyMs }` to throttle it, or `"manual"`.
|
|
158
|
+
- The table is read-only from Lunora: rows come only from the ingest loop.
|
|
159
|
+
- The default `mode: "full-pull"` re-reads the whole slice on every tick, which
|
|
160
|
+
works up to about 10k rows. For larger slices, use `mode: "incremental"` with a
|
|
161
|
+
`cursor`, plus either `reconcileEveryMs` or `softDeleteColumn` so deletes are
|
|
162
|
+
still detected.
|
|
163
|
+
- A source table can't also be `.global()`.
|
|
164
|
+
|
|
131
165
|
## Common Pitfalls
|
|
132
166
|
|
|
133
|
-
1. **`ctx.sql` in a query/mutation.** It's action-only
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
5. **Wrong placeholder syntax.** `$1, $2` for Postgres drivers, `?` for mysql2.
|
|
143
|
-
The package does not rewrite SQL.
|
|
144
|
-
|
|
145
|
-
## Checklist
|
|
146
|
-
|
|
147
|
-
- [ ] `@lunora/hyperdrive` + one driver (`postgres`/`pg`/`mysql2`) installed.
|
|
148
|
-
- [ ] `wrangler hyperdrive create` run; `HYPERDRIVE` binding added to
|
|
149
|
-
`wrangler.jsonc` with a real `id` and a `localConnectionString` for dev.
|
|
150
|
-
- [ ] `lunora codegen` run so `ctx.sql` is typed on `ActionCtx`.
|
|
151
|
-
- [ ] All `ctx.sql` access lives in actions (advisor clean — no
|
|
152
|
-
`hyperdrive_outside_action`).
|
|
153
|
-
- [ ] If reactivity is needed, external rows are projected into a `defineSchema`
|
|
154
|
-
table.
|
|
167
|
+
1. **`ctx.sql` in a query/mutation.** It's action-only. Move the SQL into an action.
|
|
168
|
+
2. **Expecting `ctx.sql` writes to update subscriptions.** They don't. Use Step 5.
|
|
169
|
+
3. **Placeholder `id` at deploy.** The deploy stops until `LUNORA_<BINDING>_URL` is set
|
|
170
|
+
(Lunora then creates the config) or the real `id` is pasted in. An empty `id` is not
|
|
171
|
+
provisioned: wrangler rejects it, so remove the entry and let Lunora add it again.
|
|
172
|
+
4. **Wrong placeholders.** Use `$1` for `postgres`/`pg` and `?` for `mysql2`.
|
|
173
|
+
5. **Unscoped `.source()` under `.shardBy()`.** Without `tenantBy`, every tenant's
|
|
174
|
+
rows are copied into each shard. `defineSchema` throws, and the
|
|
175
|
+
`external_source_unscoped` lint fails the build.
|
|
@@ -1,67 +1,55 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: lunora-setup-hyperdrive-global
|
|
3
|
-
description:
|
|
3
|
+
description: Stores a Lunora app's own `.global()` tables in Postgres or MySQL (PlanetScale, Neon, RDS, or any Hyperdrive-reachable database) through Cloudflare Hyperdrive instead of D1. Lunora owns the schema, and live queries stay fully reactive. Also migrates an existing D1 `.global()` dataset with `lunora migrate d1-to-hyperdrive`. Covers `.global({ backend: "hyperdrive" })`, `@lunora/hyperdrive/global` (`buildPgExec` / `buildMysqlExec`, `createHyperdriveGlobalCtxDb`), the app builder's `.hyperdriveGlobal({ engine, exec })`, and the `HYPERDRIVE` binding. Use when the user wants to "move global tables to PlanetScale/Postgres", "use Postgres instead of D1", or "migrate off D1", or edits `.global({ backend: "hyperdrive" })`. For querying an existing, externally owned database from an action (non-reactive `ctx.sql`), use `lunora-setup-hyperdrive` instead.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Lunora Setup: Hyperdrive Global Backend (Postgres/MySQL)
|
|
7
7
|
|
|
8
|
-
Store
|
|
9
|
-
through
|
|
10
|
-
|
|
11
|
-
D1, as a **drop-in, fully reactive** backend. (PlanetScale on Cloudflare is the
|
|
12
|
-
headline use case; nothing here is PlanetScale-specific.)
|
|
8
|
+
Store `.global()` (cross-tenant) tables in a Postgres or MySQL database reached
|
|
9
|
+
through Cloudflare Hyperdrive instead of D1. PlanetScale on Cloudflare is the
|
|
10
|
+
typical case, but nothing here is PlanetScale-specific.
|
|
13
11
|
|
|
14
|
-
>
|
|
15
|
-
> `
|
|
16
|
-
>
|
|
17
|
-
>
|
|
18
|
-
>
|
|
19
|
-
>
|
|
20
|
-
>
|
|
21
|
-
|
|
22
|
-
## When to Use
|
|
23
|
-
|
|
24
|
-
- You want `.global()` (cross-tenant) tables to live in PlanetScale rather than
|
|
25
|
-
D1 — e.g. for larger datasets, existing SQL tooling, or unified Cloudflare
|
|
26
|
-
billing.
|
|
27
|
-
- You're migrating an existing D1 `.global()` dataset to PlanetScale.
|
|
12
|
+
> **This is not `ctx.sql`.** `@lunora/hyperdrive`'s `ctx.sql`
|
|
13
|
+
> (`lunora-setup-hyperdrive`) is an action-only, non-reactive client for a
|
|
14
|
+
> database Lunora doesn't own. `.global({ backend: "hyperdrive" })` is the opposite:
|
|
15
|
+
> Lunora owns the tables (one column per field, like D1), and every write goes
|
|
16
|
+
> through Lunora's store core. Subscriptions re-run exactly as they do with D1.
|
|
17
|
+
> The live-query guarantee covers only writes made through Lunora (`ctx.db`).
|
|
18
|
+
> Rows written to the database directly are invisible to live queries.
|
|
28
19
|
|
|
29
20
|
## When Not to Use
|
|
30
21
|
|
|
31
|
-
- You only need to read
|
|
32
|
-
|
|
33
|
-
- Your global data is small and D1 is fine
|
|
34
|
-
|
|
22
|
+
- You only need to read or write a legacy database from an action: use
|
|
23
|
+
`lunora-setup-hyperdrive`.
|
|
24
|
+
- Your global data is small and D1 is fine: bare `.global()` needs no extra
|
|
25
|
+
binding or driver.
|
|
35
26
|
|
|
36
27
|
## How it works
|
|
37
28
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
decimal), so the value codec is shared with D1.
|
|
29
|
+
The same dialect-parameterized store core that backs D1 runs here with a
|
|
30
|
+
Postgres or MySQL `SqlDialect`. A Hyperdrive-backed `SqlExec` executes it from
|
|
31
|
+
inside the Durable Object that hosts the global writer. Values are stored in the
|
|
32
|
+
same shapes D1 uses (boolean → 1/0, JSON → text/json, bigint → decimal).
|
|
43
33
|
|
|
44
|
-
## Step 1: Install
|
|
34
|
+
## Step 1: Install
|
|
45
35
|
|
|
46
36
|
```bash
|
|
47
|
-
pnpm add @lunora/hyperdrive/
|
|
48
|
-
|
|
49
|
-
pnpm add
|
|
50
|
-
# or
|
|
51
|
-
pnpm add mysql2 # PlanetScale MySQL → mysql2/promise
|
|
37
|
+
pnpm add @lunora/hyperdrive @lunora/sql-store
|
|
38
|
+
pnpm add postgres # Postgres engine → buildPgExec(fromPostgresJs(...))
|
|
39
|
+
# or: pnpm add mysql2 → buildMysqlExec(mysql2/promise pool), MySQL 8.0+
|
|
52
40
|
```
|
|
53
41
|
|
|
54
|
-
|
|
42
|
+
`@lunora/hyperdrive/global` is a subpath export of `@lunora/hyperdrive`, not a
|
|
43
|
+
separate package. Codegen requires `@lunora/sql-store` too, because the generated
|
|
44
|
+
`_generated/app.ts` imports its `SqlExec` types. Install the driver that matches
|
|
45
|
+
your engine. Drivers are optional peer dependencies.
|
|
55
46
|
|
|
56
|
-
|
|
57
|
-
then a Hyperdrive config over its connection string:
|
|
47
|
+
## Step 2: Create the Hyperdrive binding
|
|
58
48
|
|
|
59
49
|
```bash
|
|
60
50
|
wrangler hyperdrive create my-db --connection-string="postgres://user:pass@host/db" # gitleaks:allow -- placeholder
|
|
61
51
|
```
|
|
62
52
|
|
|
63
|
-
Add the binding to `wrangler.jsonc` (use `localConnectionString` for `lunora dev`):
|
|
64
|
-
|
|
65
53
|
```jsonc
|
|
66
54
|
{
|
|
67
55
|
"hyperdrive": [
|
|
@@ -70,10 +58,14 @@ Add the binding to `wrangler.jsonc` (use `localConnectionString` for `lunora dev
|
|
|
70
58
|
}
|
|
71
59
|
```
|
|
72
60
|
|
|
73
|
-
|
|
74
|
-
|
|
61
|
+
A binding is required. Without any `hyperdrive` entry, config validation errors
|
|
62
|
+
and `lunora dev` / `lunora deploy` won't start. You choose the name: the
|
|
63
|
+
validator only checks that at least one binding exists, and your `exec` selector picks it.
|
|
64
|
+
|
|
65
|
+
Point Hyperdrive at the primary (or pin writes to it) so you can read your own
|
|
66
|
+
writes. A replica can serve a stale read right after a write.
|
|
75
67
|
|
|
76
|
-
## Step 3: Mark tables
|
|
68
|
+
## Step 3: Mark tables
|
|
77
69
|
|
|
78
70
|
```ts
|
|
79
71
|
// lunora/schema.ts
|
|
@@ -84,88 +76,99 @@ export default defineSchema({
|
|
|
84
76
|
});
|
|
85
77
|
```
|
|
86
78
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
errors clearly).
|
|
79
|
+
Bare `.global()` stays on D1. An app can use only one global backend: codegen fails
|
|
80
|
+
if the schema mixes D1 and Hyperdrive global tables.
|
|
90
81
|
|
|
91
|
-
## Step 4: Wire `.hyperdriveGlobal()`
|
|
82
|
+
## Step 4: Wire `.hyperdriveGlobal()`
|
|
92
83
|
|
|
93
|
-
Codegen emits a `.hyperdriveGlobal()` builder method.
|
|
94
|
-
|
|
95
|
-
lazily after hibernation):
|
|
84
|
+
Codegen emits a `.hyperdriveGlobal({ engine, exec, origin? })` builder method.
|
|
85
|
+
`exec` builds a `SqlExec` from `env`:
|
|
96
86
|
|
|
97
87
|
```ts
|
|
98
|
-
import { buildPgExec } from "@lunora/hyperdrive/global";
|
|
99
88
|
import { fromPostgresJs } from "@lunora/hyperdrive";
|
|
89
|
+
import { buildPgExec } from "@lunora/hyperdrive/global";
|
|
100
90
|
import postgres from "postgres";
|
|
101
91
|
|
|
102
|
-
|
|
92
|
+
import { defineApp } from "../lunora/_generated/app.js";
|
|
93
|
+
|
|
94
|
+
const app = defineApp<Env>()
|
|
103
95
|
.shard((env) => env.SHARD)
|
|
104
96
|
.hyperdriveGlobal({
|
|
105
97
|
engine: "postgres",
|
|
106
98
|
exec: (env) => buildPgExec(fromPostgresJs(postgres(env.HYPERDRIVE.connectionString))),
|
|
107
|
-
})
|
|
99
|
+
})
|
|
100
|
+
.build();
|
|
101
|
+
|
|
102
|
+
export const ShardDO = app.ShardDO;
|
|
108
103
|
```
|
|
109
104
|
|
|
110
|
-
For MySQL, create the pool with the
|
|
111
|
-
guard needs matched-row counts,
|
|
105
|
+
For MySQL, create the pool with the `FOUND_ROWS` flag. The optimistic-concurrency
|
|
106
|
+
guard needs matched-row counts. Without the flag, an idempotent write reports
|
|
107
|
+
zero affected rows and raises a spurious conflict. `buildMysqlExec` throws at
|
|
108
|
+
construction when the flag is missing. If it can't read the flag, it warns once instead.
|
|
112
109
|
|
|
113
110
|
```ts
|
|
114
111
|
import { buildMysqlExec } from "@lunora/hyperdrive/global";
|
|
115
112
|
import mysql from "mysql2/promise";
|
|
116
113
|
|
|
114
|
+
// inside the builder chain:
|
|
117
115
|
.hyperdriveGlobal({
|
|
118
116
|
engine: "mysql",
|
|
119
117
|
exec: (env) => buildMysqlExec(mysql.createPool({ uri: env.HYPERDRIVE.connectionString, flags: ["FOUND_ROWS"] })),
|
|
120
|
-
})
|
|
118
|
+
})
|
|
121
119
|
```
|
|
122
120
|
|
|
123
|
-
|
|
121
|
+
Outside the app builder, for example in tests or a custom host,
|
|
122
|
+
`createHyperdriveGlobalCtxDb({ engine, exec, ... })` builds the same reactive writer
|
|
123
|
+
directly.
|
|
124
|
+
|
|
125
|
+
## Step 5: Regenerate and run
|
|
124
126
|
|
|
125
127
|
```bash
|
|
126
|
-
lunora codegen
|
|
128
|
+
lunora codegen
|
|
127
129
|
lunora dev
|
|
128
130
|
```
|
|
129
131
|
|
|
130
|
-
Tables
|
|
131
|
-
the dialect
|
|
132
|
+
Tables provision automatically on first use, because the runtime runs the DDL
|
|
133
|
+
through the dialect. You don't write or commit SQL migrations. `CREATE TABLE IF NOT EXISTS` never
|
|
134
|
+
reshapes an existing table, though. When a column's validator starts accepting
|
|
135
|
+
null, the store reports the `ALTER` statement to run. MySQL tables created before
|
|
136
|
+
the `utf8mb4_0900_bin` column collation need a one-off
|
|
137
|
+
`ALTER TABLE … CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_bin`.
|
|
138
|
+
See `lunora-migration-helper` for schema changes.
|
|
132
139
|
|
|
133
|
-
|
|
140
|
+
**Verify:** subscribe to a query over a hyperdrive-backed table, write through a
|
|
141
|
+
mutation, and confirm that the subscription updates.
|
|
134
142
|
|
|
135
|
-
|
|
136
|
-
|
|
143
|
+
Postgres deployments can also serve `ctx.vectors` from pgvector instead of a Vectorize
|
|
144
|
+
binding with `createPgVectorIndex` (from `@lunora/hyperdrive/global`). It supports
|
|
145
|
+
equality-only metadata filters.
|
|
146
|
+
|
|
147
|
+
## Migrating an existing D1 dataset
|
|
148
|
+
|
|
149
|
+
The flow is blue-green: deploy the Hyperdrive-backed worker next to the D1 one,
|
|
150
|
+
then copy the data:
|
|
137
151
|
|
|
138
152
|
```bash
|
|
139
153
|
lunora migrate d1-to-hyperdrive \
|
|
140
|
-
--from-url https://old-d1.example.com
|
|
141
|
-
--to-url https://new-
|
|
142
|
-
--tables settings,orders
|
|
143
|
-
# --out dump.ndjson # keep the intermediate dump to inspect
|
|
154
|
+
--from-url https://old-d1.example.com --from-token "$D1_ADMIN_TOKEN" \
|
|
155
|
+
--to-url https://new-hd.example.com --to-token "$HD_ADMIN_TOKEN" \
|
|
156
|
+
--tables settings,orders # omit to move every global table; --out dump.ndjson keeps the dump
|
|
144
157
|
```
|
|
145
158
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
are reported as conflicts
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
> live queries — same as D1. Let Lunora own the writes.
|
|
159
|
+
The command exports the source's global rows to NDJSON, imports them into the
|
|
160
|
+
target, and compares row counts. It refuses to run when the source and target
|
|
161
|
+
resolve to the same URL, and non-localhost URLs must use https. Rows whose `_id`
|
|
162
|
+
already exists in the target are reported as conflicts and not duplicated.
|
|
163
|
+
A count mismatch is a warning: inspect it with `--out`, resolve it, and re-run.
|
|
164
|
+
Tokens default to `--token` / `LUNORA_ADMIN_TOKEN`.
|
|
153
165
|
|
|
154
166
|
## Common Pitfalls
|
|
155
167
|
|
|
156
|
-
1. **
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
3. **
|
|
160
|
-
4. **
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
## Checklist
|
|
164
|
-
|
|
165
|
-
- [ ] `@lunora/hyperdrive/global` + the engine's driver installed.
|
|
166
|
-
- [ ] Hyperdrive binding (`HYPERDRIVE`) created over the PlanetScale connection
|
|
167
|
-
string, with a `localConnectionString` for dev.
|
|
168
|
-
- [ ] Target tables marked `.global({ backend: "hyperdrive" })` (one backend per app).
|
|
169
|
-
- [ ] `.hyperdriveGlobal({ engine, exec })` wired in the app composition.
|
|
170
|
-
- [ ] `lunora codegen` run; `lunora dev` serves the tables reactively.
|
|
171
|
-
- [ ] (Migrating) `lunora migrate d1-to-hyperdrive` run; row counts verified.
|
|
168
|
+
1. **Installing `@lunora/hyperdrive/global` as a package name.** It's a subpath.
|
|
169
|
+
Install `@lunora/hyperdrive` and `@lunora/sql-store`.
|
|
170
|
+
2. **Mixing D1 and Hyperdrive global tables.** Codegen rejects this.
|
|
171
|
+
3. **Missing `FOUND_ROWS` on MySQL.** It causes spurious OCC conflicts on idempotent writes.
|
|
172
|
+
4. **Stale-replica reads.** Point Hyperdrive at the primary.
|
|
173
|
+
5. **Writing to the database directly.** Live queries won't see those writes. Route writes
|
|
174
|
+
through `ctx.db`.
|