@devries-cameron20 / t3code Mirror · read-only
Fork 0

The best way to control Claude Code, Codex and more from any computer or phone

Mirrored from https://github.com/Camo67/t3code.git

Synced Nov 21, 06:00 UTC

main
mdx 148 lines 4.4 KB
Raw
1 ---
2 title: Drizzle MySQL on Railway
3 description: Connect an Effect-native Railway Service to MySQL and deploy committed Drizzle migrations.
4 ---
5
6 Run Drizzle in a Railway container beside [Railway MySQL](/railway/data/mysql). Start with [Railway setup](/railway/setup), the [Service tutorial](/railway/tutorial/part-2), and a `src/schema.ts` exporting a MySQL `Users` table from the [MySQL client guide](/sql/drizzle/mysql).
7
8 ## Install the database dependencies
9
10 ```sh
11 pnpm add @alchemy.run/drizzle drizzle-orm@1.0.0-rc.5 @effect/sql-mysql2
12 pnpm add -D drizzle-kit@1.0.0-rc.5
13 ```
14
15 The Drizzle versions match the repository's Effect integration.
16
17 ## Configure migrations
18
19 ```typescript
20 // drizzle.config.ts
21 import { defineConfig } from "drizzle-kit";
22
23 export default defineConfig({
24 dialect: "mysql",
25 schema: "./src/schema.ts",
26 out: "./drizzle",
27 dbCredentials: { url: process.env.DATABASE_URL! },
28 });
29 ```
30
31 `DATABASE_URL` here is a MySQL URL for the migration runner, separate from the Service's bound `MYSQL_URL`.
32
33 ## Generate after changing the schema
34
35 ```sh
36 pnpm exec drizzle-kit generate
37 ```
38
39 Review the generated SQL and snapshots, including any rename decisions, before applying them.
40
41 ## Commit the migration
42
43 ```sh
44 git add src/schema.ts drizzle.config.ts drizzle
45 git diff --cached
46 ```
47
48 ```sh
49 git commit -m "Add users migration"
50 ```
51
52 Commit the schema, SQL, and snapshots together; deployment must consume the reviewed history.
53
54 ## Declare MySQL
55
56 ```typescript
57 // src/db.ts
58 import * as Railway from "@alchemy.run/railway";
59 import { Site } from "./project.ts";
60
61 export const Db = Railway.MySQL("Db", { project: Site });
62 ```
63
64 This creates the MySQL service, persistent volume, and a public TCP proxy by default; keep the database and application in the same Railway environment.
65
66 ## Install the driver in the Service image
67
68 ```diff lang="typescript"
69 // src/api.ts
70 {
71 project: Site,
72 main: import.meta.url,
73 + build: { install: ["mysql2"] },
74 }
75 ```
76
77 Use the container-backed `Railway.Service` packaging path, not the single-file Canvas `Railway.Function` path.
78
79 ## Bind MySQL
80
81 ```diff lang="typescript"
82 +import { Db } from "./db.ts";
83
84 Effect.gen(function* () {
85 + const conn = yield* Railway.ConnectMySQL(Db);
86 return {
87 fetch: Effect.succeed(HttpServerResponse.text("Hello from Railway!")),
88 };
89 -}),
90 +}).pipe(Effect.provide(Railway.ConnectMySQLHttp)),
91 ```
92
93 The binding supplies an Effect-valued, redacted private connection string rather than a SQL query method. These excerpts use the tutorial's minimal text handler until the database is migrated.
94
95 ## Provision before the first migration
96
97 ```sh
98 pnpm alchemy deploy
99 ```
100
101 Keep `yield* Api` in the tutorial's Stack with `Railway.providers()`. The initial handler does not query tables, so the database can be provisioned before its first migration.
102
103 ## Apply the committed SQL
104
105 ```sh
106 pnpm exec drizzle-kit migrate
107 ```
108
109 Supply `publicConnectionUri` as secret `DATABASE_URL` for an external runner, or run inside the same Railway environment with `connectionUri` when `public: false`. Configure and verify TLS for any public database traffic; do not disable certificate verification to make a migration connect.
110
111 ## Open the runtime client
112
113 ```diff lang="typescript"
114 +import * as Drizzle from "@alchemy.run/drizzle/MySQL";
115
116 const conn = yield* Railway.ConnectMySQL(Db);
117 +const db = yield* Drizzle.MySQL(conn.connectionString);
118 ```
119
120 The application uses Railway's private MySQL endpoint, not the public TCP proxy.
121
122 ## Query from the Service
123
124 ```diff lang="typescript"
125 +import { Users } from "./schema.ts";
126
127 return {
128 - fetch: Effect.succeed(HttpServerResponse.text("Hello from Railway!")),
129 + fetch: Effect.gen(function* () {
130 + const users = yield* db.select().from(Users).pipe(Effect.orDie);
131 + return yield* HttpServerResponse.json({ users });
132 + }),
133 };
134 ```
135
136 Use MySQL query semantics; PostgreSQL's `.returning()` is not part of this example.
137
138 ## Deploy the application
139
140 ```sh
141 pnpm alchemy deploy
142 ```
143
144 For later changes, generate, review, and commit the schema, SQL, and snapshots before applying migrations and deploying compatible code. `Railway.MySQL` has no `migrations` prop, so `alchemy deploy` does not replace `drizzle-kit migrate`.
145
146 ## Continue
147
148 See the [SQL database comparison](/sql/databases), [portable MySQL queries](/sql/drizzle/mysql), and [migration workflow](/sql/drizzle/migrations). The [MySQL database guide](/railway/data/mysql) covers the resource's image, volume, private hostname, and public proxy.