re:re:actable
Урок 032 минуты чтения

Как описывать таблицы PostgreSQL в Drizzle?

На этой странице
Кратко

Схема Drizzle — TypeScript-описание таблиц, столбцов и ограничений. По ней выводятся типы запросов и создаются миграции.

Вопрос

Как описывать таблицы PostgreSQL в Drizzle? Как получить типы строк для чтения и вставки?

Таблица пользователей

// src/db/schema.ts
import {
  boolean,
  integer,
  pgTable,
  timestamp,
  varchar,
} from "drizzle-orm/pg-core";
 
export const users = pgTable("users", {
  id: integer("id").primaryKey().generatedAlwaysAsIdentity(),
  name: varchar("name", { length: 100 }).notNull(),
  email: varchar("email", { length: 255 }).notNull().unique(),
  isBlocked: boolean("is_blocked").notNull().default(false),
  createdAt: timestamp("created_at", { withTimezone: true })
    .notNull()
    .defaultNow(),
  updatedAt: timestamp("updated_at", { withTimezone: true })
    .notNull()
    .defaultNow(),
});

Имена TypeScript и PostgreSQL

createdAt: timestamp("created_at")
  • в TypeScript поле называется createdAt;
  • в PostgreSQL столбец называется created_at.

Drizzle преобразует имена при чтении и записи.

Тип для чтения

export type User = typeof users.$inferSelect;

Получится примерно:

type User = {
  id: number;
  name: string;
  email: string;
  isBlocked: boolean;
  createdAt: Date;
  updatedAt: Date;
};

Тип для вставки

export type NewUser = typeof users.$inferInsert;

id, isBlocked, createdAt и updatedAt будут необязательными, потому что база умеет заполнить их сама.

Схема должна быть экспортирована

Drizzle Kit загружает экспортированные таблицы из файла, указанного в drizzle.config.ts.

export const users = pgTable(...);

Неэкспортированную таблицу средство миграций не увидит.

Схема — не проверка тела запроса

type NewUser = typeof users.$inferInsert;

Этот тип существует только во время разработки. Для request.body всё равно нужна проверка Zod.

Что важно помнить

  • Ключ объекта в pgTable() — имя поля в TypeScript, строка — имя столбца в базе (createdAt ↔ created_at).
  • $inferSelect описывает строку при чтении, $inferInsert — при вставке (поля с default необязательны).
  • Drizzle Kit видит только экспортированные таблицы — неэкспортированная не попадёт в миграцию.
  • Схема Drizzle описывает базу, а не входные данные API: тело запроса проверяет Zod.

Мини-шпаргалка

  • pgTable() описывает таблицу PostgreSQL.
  • Ключ объекта — имя в TypeScript, строка — имя столбца.
  • $inferSelect создаёт тип чтения.
  • $inferInsert создаёт тип вставки.
  • Экспортируй все таблицы, которые должны попасть в миграции.

Документация

Drizzle: Schema declaration.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам