Drizzle ORM
ルール
- スキーマ定義:
pgTable() / mysqlTable() / sqliteTable() を src/db/schema.ts で使用
- 開発時:
drizzle-kit push で高速イテレーション — マイグレーションファイルは不要
- 本番環境:
drizzle-kit generate + drizzle-kit migrate で追跡可能なマイグレーション履歴
- 型安全なクエリ:
db.select().from(users).where(eq(users.email, email)) — 完全な TypeScript 型推論
- リレーション:
relations() ヘルパーで定義 — one() と many() を使用して db.query でリレーショナルクエリを実行
- プリペアドステートメント:
db.select().from(users).where(eq(users.id, sql.placeholder("id"))).prepare() — ホットパスで再利用
- トランザクション:
db.transaction(async (tx) => { ... }) — コールバック内では tx を使用(db は使用しない)
- インデックス:
.index() でインライン定義、またはテーブル設定で定義 — where や orderBy で使用するカラムに追加
- Drizzle Studio:
npx drizzle-kit studio で開発中のビジュアルデータベースブラウザを起動
パターン
import { pgTable, text, timestamp, uuid, integer } from "drizzle-orm/pg-core";
import { relations } from "drizzle-orm";
export const users = pgTable("users", {
id: uuid("id").primaryKey().defaultRandom(),
name: text("name").notNull(),
email: text("email").notNull().unique(),
createdAt: timestamp("created_at").defaultNow().notNull(),
});
export const posts = pgTable("posts", {
id: uuid("id").primaryKey().defaultRandom(),
title: text("title").notNull(),
authorId: uuid("author_id").references(() => users.id).notNull(),
});
export const usersRelations = relations(users, ({ many }) => ({
posts: many(posts),
}));
export const postsRelations = relations(posts, ({ one }) => ({
author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));
const result = await db.query.users.findFirst({
where: eq(users.id, userId),
with: { posts: true },
});
避けるべきこと
- 本番環境での
drizzle-kit push — 追跡可能なマイグレーションのために generate + migrate を使用すること
- Drizzle API でカバーできる場合の生 SQL — 複雑な式にのみ
sql テンプレートタグを使用すること
relations() 定義の忘れ — これがないと db.query のリレーショナルクエリが動作しません
- N+1 クエリ —
db.query で with を使用してリレーションを1つのクエリで結合すること
- 外部キーやフィルタリングカラムへのインデックス不足 — Drizzle は自動的に作成しません