drizzle-kit check

This guide assumes familiarity with:

drizzle-kit check 커맨드는 생성된 SQL 마이그레이션 기록의 일관성을 확인할 수 있게 해줍니다.

이 기능은 여러 개발자가 프로젝트에서 작업하고 다른 브랜치에서 데이터베이스 스키마를 변경할 때 매우 유용합니다. 팀을 위한 마이그레이션에 대해 더 알아보세요.




drizzle-kit check 커맨드를 사용하려면 dialect와 데이터베이스 연결 정보를 지정해야 합니다. 이 정보는 drizzle.config.ts 설정 파일을 통해 제공하거나 CLI 옵션으로 제공할 수 있습니다.

설정 파일 사용
CLI 옵션 사용
// drizzle.config.ts
import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
});
npx drizzle-kit check

하나의 프로젝트에 여러 설정 파일 사용하기

하나의 프로젝트에서 여러 설정 파일을 사용할 수 있습니다. 이는 여러 데이터베이스 단계나 동일한 프로젝트 내에서 여러 데이터베이스를 사용할 때 매우 유용합니다.

npm
yarn
pnpm
bun
npx drizzle-kit migrate --config=drizzle-dev.config.ts
npx drizzle-kit migrate --config=drizzle-prod.config.ts
📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json

이 구조를 통해 개발 환경과 프로덕션 환경에 각각 다른 설정 파일을 적용할 수 있습니다. 예를 들어, drizzle-dev.config.ts는 개발용 데이터베이스 설정을, drizzle-prod.config.ts는 프로덕션용 데이터베이스 설정을 담고 있습니다. 이렇게 하면 환경에 따라 적절한 설정을 쉽게 적용할 수 있습니다.

확장된 설정 목록

drizzle-kitdrizzle.config.ts 파일을 통해 설정하는 것을 권장합니다. 하지만 CI/CD 파이프라인 등에서 필요할 경우, 모든 설정 옵션을 CLI를 통해 제공할 수도 있습니다.

dialect필수사용 중인 데이터베이스 방언. postgresql, mysql, sqlite 중 선택 가능
out마이그레이션 폴더, 기본값=./drizzle
config설정 파일 경로, 기본값=drizzle.config.ts

npm
yarn
pnpm
bun
npx drizzle-kit check --dialect=postgresql
npx drizzle-kit check --dialect=postgresql --our=./migrations-folder