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

Как настроить drizzle.config.ts?

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

drizzle.config.ts сообщает Drizzle Kit, где находится схема, куда складывать миграции, какой диалект SQL использовать и к какой базе подключаться.

Вопрос

Как настроить drizzle.config.ts? Какие поля обязательны и как не применить миграции к рабочей базе по ошибке?

Основная идея

Создай файл в корне проекта:

// drizzle.config.ts
import "dotenv/config";
import { defineConfig } from "drizzle-kit";
 
if (!process.env.DATABASE_URL) {
  throw new Error("Не задана переменная DATABASE_URL");
}
 
export default defineConfig({
  dialect: "postgresql",
  schema: "./src/db/schema.ts",
  out: "./drizzle",
  dbCredentials: {
    url: process.env.DATABASE_URL,
  },
  strict: true,
  verbose: true,
});

Значение полей

ПолеНазначение
dialectВыбранная СУБД
schemaФайл или маска файлов схемы
outПапка SQL-миграций и снимков
dbCredentialsСоединение для команд, работающих с базой
strictДополнительное подтверждение опасных изменений
verboseБолее подробный вывод команд

Схема в нескольких файлах

schema: "./src/db/schema/*.ts",

Пример структуры:

src/db/schema/
├── users.ts
├── tasks.ts
└── index.ts

Все таблицы должны быть экспортированы из подходящих файлов.

Команды

{
  "scripts": {
    "db:generate": "drizzle-kit generate",
    "db:migrate": "drizzle-kit migrate",
    "db:push": "drizzle-kit push",
    "db:pull": "drizzle-kit pull",
    "db:studio": "drizzle-kit studio"
  }
}

Отдельная тестовая база

Можно создать второй файл:

drizzle.test.config.ts

И запустить:

drizzle-kit migrate --config=drizzle.test.config.ts

Главное — не перепутать тестовую строку соединения с рабочей.

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

  • schema — путь к файлу или папке со схемой, out — папка с SQL-миграциями и снимками.
  • dialect: "postgresql" выбирает диалект SQL, dbCredentials.url берётся из окружения.
  • Конфигурация выполняется Drizzle Kit отдельно от приложения — переменные окружения нужно загрузить в ней самой.
  • Для тестов используется отдельная база и отдельная строка соединения.

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

  • schema указывает на TypeScript-схему.
  • out хранит миграции и снимки.
  • dialect: "postgresql" выбирает PostgreSQL.
  • Конфигурация получает адрес базы из окружения.
  • Опасные команды никогда не запускаются с непроверенной рабочей строкой.

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

Drizzle: Configuration file.

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

Поиск

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