Drizzle Kit을 사용한 마이그레이션

This guide assumes familiarity with:

Drizzle 및 drizzle-kit 시작하기 - 여기에서 읽기
Drizzle 스키마 기초 - 여기에서 읽기
데이터베이스 연결 기초 - 여기에서 읽기
Drizzle 마이그레이션 기초 - 여기에서 읽기

Drizzle Kit은 Drizzle로 SQL 데이터베이스 마이그레이션을 관리하기 위한 CLI 도구입니다.

npm

yarn

pnpm

bun

npm i -D drizzle-kit

yarn add -D drizzle-kit

pnpm add -D drizzle-kit

bun add -D drizzle-kit

IMPORTANT

먼저 Drizzle 시작하기 및 마이그레이션 기초를 살펴보고 비즈니스 요구사항에 가장 적합한 SQL 마이그레이션 흐름을 선택하시기 바랍니다.

Drizzle Kit은 스키마를 기반으로 SQL 마이그레이션 파일을 생성하고 실행하며, 데이터베이스에 직접 스키마를 푸시하고, 데이터베이스에서 스키마를 가져오며, drizzle studio를 실행하고, 몇 가지 유틸리티 명령어를 제공합니다.

npm

yarn

pnpm

bun

npx drizzle-kit generate
npx drizzle-kit migrate
npx drizzle-kit push
npx drizzle-kit pull
npx drizzle-kit check
npx drizzle-kit up
npx drizzle-kit studio

yarn drizzle-kit generate
yarn drizzle-kit migrate
yarn drizzle-kit push
yarn drizzle-kit pull
yarn drizzle-kit check
yarn drizzle-kit up
yarn drizzle-kit studio

pnpm drizzle-kit generate
pnpm drizzle-kit migrate
pnpm drizzle-kit push
pnpm drizzle-kit pull
pnpm drizzle-kit check
pnpm drizzle-kit up
pnpm drizzle-kit studio

bunx drizzle-kit generate
bunx drizzle-kit migrate
bunx drizzle-kit push
bunx drizzle-kit pull
bunx drizzle-kit check
bunx drizzle-kit up
bunx drizzle-kit studio


`drizzle-kit generate`	스키마 선언 시점이나 후속 변경 시 Drizzle 스키마를 기반으로 SQL 마이그레이션 파일을 생성합니다. 여기에서 보기.
`drizzle-kit migrate`	생성된 SQL 마이그레이션 파일을 데이터베이스에 적용합니다. 여기에서 보기.
`drizzle-kit pull`	데이터베이스 스키마를 가져오고(introspect), Drizzle 스키마로 변환하여 코드베이스에 저장합니다. 여기에서 보기
`drizzle-kit push`	스키마 선언 시점이나 후속 스키마 변경 시 Drizzle 스키마를 데이터베이스로 푸시합니다. 여기에서 보기
`drizzle-kit studio`	데이터베이스에 연결하고 Drizzle Studio용 프록시 서버를 실행하여 편리한 데이터베이스 브라우징을 제공합니다. 여기에서 보기
`drizzle-kit check`	생성된 모든 마이그레이션을 살펴보고 경쟁 조건(충돌)을 확인합니다. 여기에서 보기
`drizzle-kit up`	이전에 생성된 마이그레이션의 스냅샷을 업그레이드하는 데 사용됩니다. 여기에서 보기

Drizzle Kit은 drizzle.config.ts 설정 파일 또는 CLI 매개변수를 통해 구성됩니다.
Drizzle Kit이 마이그레이션을 생성하는 방법을 알 수 있도록 최소한 SQL dialect 및 schema 경로를 제공해야 합니다.

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle.config.ts  <--- Drizzle config file
 ├ 📜 package.json
 └ 📜 tsconfig.json

simple config

extended config

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
});

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  out: "./drizzle",
  dialect: "postgresql",
  schema: "./src/schema.ts",

  driver: "pglite",
  dbCredentials: {
    url: "./database/",
  },

  extensionsFilters: ["postgis"],
  schemaFilter: "public",
  tablesFilter: "*",

  introspect: {
    casing: "camel",
  },

  migrations: {
    prefix: "timestamp",
    table: "__drizzle_migrations__",
    schema: "public",
  },

  breakpoints: true,
  strict: true,
  verbose: true,
});

CLI 매개변수를 통해 Drizzle Kit 설정 경로를 제공할 수 있습니다. 이는 여러 데이터베이스 스테이지 또는 여러 데이터베이스, 또는 동일한 프로젝트에서 다른 데이터베이스를 사용할 때 매우 유용합니다:

npm

yarn

pnpm

bun

npx drizzle-kit push --config=drizzle-dev.drizzle.config
npx drizzle-kit push --config=drizzle-prod.drizzle.config

yarn drizzle-kit push --config=drizzle-dev.drizzle.config
yarn drizzle-kit push --config=drizzle-prod.drizzle.config

pnpm drizzle-kit push --config=drizzle-dev.drizzle.config
pnpm drizzle-kit push --config=drizzle-prod.drizzle.config

bunx drizzle-kit push --config=drizzle-dev.drizzle.config
bunx drizzle-kit push --config=drizzle-prod.drizzle.config

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json