Drizzle Kit으로 마이그레이션하기

This guide assumes familiarity with:

Drizzle와 drizzle-kit 시작하기 - 여기서 읽기
Drizzle 스키마 기본 개념 - 여기서 읽기
데이터베이스 연결 기본 - 여기서 읽기
Drizzle 마이그레이션 기본 개념 - 여기서 읽기

Drizzle Kit은 Drizzle를 사용해 SQL 데이터베이스 마이그레이션을 관리하는 CLI 도구입니다.

npm

yarn

pnpm

bun

npm i drizzle-kit

yarn add drizzle-kit

pnpm add drizzle-kit

bun add 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

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


`drizzle-kit generate`	Drizzle 스키마를 기반으로 SQL 마이그레이션 파일을 생성합니다. 선언 시 또는 변경 사항이 있을 때 생성할 수 있습니다. 자세히 보기.
`drizzle-kit migrate`	생성된 SQL 마이그레이션 파일을 데이터베이스에 적용합니다. 자세히 보기.
`drizzle-kit pull`	데이터베이스 스키마를 가져와 Drizzle 스키마로 변환한 후 코드베이스에 저장합니다. 자세히 보기
`drizzle-kit push`	Drizzle 스키마를 데이터베이스에 푸시합니다. 선언 시 또는 스키마 변경 사항이 있을 때 푸시할 수 있습니다. 자세히 보기
`drizzle-kit studio`	데이터베이스에 연결하고 Drizzle Studio를 위한 프록시 서버를 실행합니다. 이를 통해 편리하게 데이터베이스를 탐색할 수 있습니다. 자세히 보기
`drizzle-kit check`	생성된 모든 마이그레이션을 검토하고, 생성된 마이그레이션 간의 경쟁 조건(충돌)을 확인합니다. 자세히 보기
`drizzle-kit up`	이전에 생성된 마이그레이션의 스냅샷을 업그레이드하는 데 사용됩니다. 자세히 보기

Drizzle Kit은 drizzle.config.ts 설정 파일이나 CLI 파라미터를 통해 구성됩니다.
최소한 SQL dialect와 schema 경로를 제공해야 Drizzle Kit이 마이그레이션을 생성할 수 있습니다.

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

간단한 설정

확장 설정

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

bun drizzle-kit push --config=drizzle-dev.drizzle.config
bun 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