Drizzle ORM
Règles
- Définition du schéma :
pgTable() / mysqlTable() / sqliteTable() dans src/db/schema.ts
- Développement :
drizzle-kit push pour itération rapide — aucun fichier de migration nécessaire
- Production :
drizzle-kit generate + drizzle-kit migrate pour un historique de migrations traçable
- Requêtes type-safe :
db.select().from(users).where(eq(users.email, email)) — inférence TypeScript complète
- Relations : définir avec le helper
relations() — one() et many() pour les requêtes relationnelles avec db.query
- Instructions préparées :
db.select().from(users).where(eq(users.id, sql.placeholder("id"))).prepare() — réutilisables pour les chemins chauds (hot paths)
- Transactions :
db.transaction(async (tx) => { ... }) — utiliser tx et non db dans la fonction de callback
- Index : définir en ligne avec
.index() ou dans la configuration de la table — ajouter sur les colonnes utilisées dans where et orderBy
- Drizzle Studio :
npx drizzle-kit studio pour un navigateur de base de données visuel pendant le développement
Exemples de code
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 },
});
À éviter
drizzle-kit push en production — utiliser generate + migrate pour des migrations tracées
- SQL brut quand l'API Drizzle le couvre — utiliser le tag template
sql uniquement pour les expressions complexes
- Oublier les définitions
relations() — sans elles, les requêtes relationnelles db.query ne fonctionneront pas
- Requêtes N+1 — utiliser
with dans db.query pour joindre les relations en une seule requête
- Index manquants sur les clés étrangères et les colonnes filtrées — Drizzle ne les crée pas automatiquement