drizzle-kit generate

drizzle-kit generate는 여러분의 Drizzle 스키마 선언이나 스키마 변경에 따라 SQL 마이그레이션을 생성할 수 있게 해줍니다.

import * as p from "./drizzle-orm/pg-core";

export const users = p.pgTable("users", {
  id: p.serial().primaryKey(),
  name: p.text(),
  email: p.text().unique(), 
};

┌────────────────────────┐                  
│ $ drizzle-kit generate │                  
└─┬──────────────────────┘                  
  │                                           
  └ 1. 이전 마이그레이션 폴더 읽기
    2. 현재와 이전 스키마 간 차이점 찾기
    3. 필요한 경우 개발자에게 이름 변경 요청
  ┌ 4. SQL 마이그레이션 생성 및 파일로 저장
  │    ┌─┴───────────────────────────────────────┐  
  │      📂 drizzle       
  │      ├ 📂 _meta
  │      └ 📜 0000_premium_mister_fear.sql
  v

-- drizzle/0000_premium_mister_fear.sql

CREATE TABLE "users" (
 "id" SERIAL PRIMARY KEY,
 "name" TEXT,
 "email" TEXT UNIQUE
);

이 기능은 Drizzle 마이그레이션을 관리하는 코드 우선 접근 방식을 다루기 위해 설계되었습니다. 생성된 마이그레이션은 drizzle-kit migrate를 사용하거나, drizzle-orm의 migrate()를 사용하거나, bytebase와 같은 외부 마이그레이션 도구를 사용하거나, 직접 데이터베이스에서 실행할 수 있습니다.

drizzle-kit generate 커맨드는 dialect와 schema 경로 옵션을 제공해야 합니다. 이 옵션들은 drizzle.config.ts 설정 파일을 통해 설정하거나 CLI 옵션으로 설정할 수 있습니다.

// drizzle.config.ts
import { defineConfig } from "drizzle-kit";

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

npx drizzle-kit generate

npx drizzle-kit generate --dialect=postgresql --schema=./src/schema.ts

스키마 파일 경로

여러분은 하나의 schema.ts 파일을 사용하거나, 프로젝트 전체에 걸쳐 원하는 만큼 많은 스키마 파일을 분산시킬 수 있습니다. Drizzle Kit은 이러한 스키마 파일의 경로를 glob 형식으로 schema 설정 옵션을 통해 지정하도록 요구합니다.

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ ...
 │ ├ 📜 index.ts
 │ └ 📜 schema.ts 
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

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

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ 📂 user
 │ │ ├ 📜 handler.ts 
 │ │ └ 📜 schema.ts 
 │ ├ 📂 posts
 │ │ ├ 📜 handler.ts 
 │ │ └ 📜 schema.ts 
 │ └ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/**/schema.ts",
  // 또는
  schema: ["./src/user/schema.ts", "./src/posts/schema.ts"]
});

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ 📂 schema
 │ │ ├ 📜 user.ts 
 │ │ ├ 📜 post.ts 
 │ │ └ 📜 comment.ts 
 │ └ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/schema/*",
});

📦 <project root>
 ├ ...
 ├ 📂 drizzle
 ├ 📂 src
 │ ├ 📜 userById.ts 
 │ ├ 📜 userByEmail.ts 
 │ ├ 📜 listUsers.ts 
 │ ├ 📜 user.sql.ts 
 │ ├ 📜 postById.ts 
 │ ├ 📜 listPosts.ts 
 │ └ 📜 post.sql.ts 
 │ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ 📜 package.json

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./src/**/*.sql.ts", // Dax가 가장 좋아하는 방식
});

커스텀 마이그레이션 파일 이름 설정하기

--name CLI 옵션을 사용하여 마이그레이션 파일 이름을 커스텀하게 설정할 수 있습니다.

npx drizzle-kit generate --name=init

위 명령어를 실행하면 다음과 같은 파일 구조가 생성됩니다.

📦 <project root>
 ├ 📂 drizzle
 │ ├ 📂 _meta
 │ └ 📜 0000_init.sql 
 ├ 📂 src
 └ …

이렇게 하면 마이그레이션 파일 이름이 0000_init.sql로 지정됩니다.

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

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

npx drizzle-kit generate --config=drizzle-dev.config.ts
npx drizzle-kit generate --config=drizzle-prod.config.ts

yarn drizzle-kit generate --config=drizzle-dev.config.ts
yarn drizzle-kit generate --config=drizzle-prod.config.ts

pnpm drizzle-kit generate --config=drizzle-dev.config.ts
pnpm drizzle-kit generate --config=drizzle-prod.config.ts

bun drizzle-kit generate --config=drizzle-dev.config.ts
bun drizzle-kit generate --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 Kit에서 아직 지원하지 않는 DDL 변경이나 데이터 시딩을 위해, 여러분은 빈 마이그레이션 파일을 생성하여 직접 SQL 마이그레이션을 작성할 수 있습니다. 커스텀 마이그레이션에 대한 자세한 문서는 여기에서 확인할 수 있습니다.

drizzle-kit generate --custom --name=seed-users

📦 <project root>
 ├ 📂 drizzle
 │ ├ 📂 _meta
 │ ├ 📜 0000_init.sql 
 │ └ 📜 0001_seed-users.sql 
 ├ 📂 src
 └ …

-- ./drizzle/0001_seed-users.sql

INSERT INTO "users" ("name") VALUES('Dan');
INSERT INTO "users" ("name") VALUES('Andrew');
INSERT INTO "users" ("name") VALUES('Dandrew');

확장 가능한 설정 목록

drizzle-kit generate 명령어는 CLI 전용 옵션을 제공합니다.

npx drizzle-kit push --name=init
npx drizzle-kit push --name=seed_users --custom

yarn drizzle-kit push --name=init
yarn drizzle-kit push --name=seed_users --custom

pnpm drizzle-kit push --name=init
pnpm drizzle-kit push --name=seed_users --custom

bun drizzle-kit push --name=init
bun drizzle-kit push --name=seed_users --custom

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

---
dialects: ['postgresql', 'mysql', 'sqlite', 'turso', 'singlestore']
---

{frontmatter.dialects.map(dialect => <><code>{dialect}</code>&#32;</>)}

확장 예제

Drizzle 스키마가 ./src/schema.ts에 위치하고, 기본값인 ./drizzle 대신 ./migrations라는 이름의 마이그레이션 폴더를 사용하여 0001_seed-users.sql이라는 커스텀 PostgreSQL 마이그레이션 파일을 만드는 방법을 살펴보겠습니다.

또한, Drizzle 설정 파일을 configs 폴더에 위치시킬 것입니다.

먼저 설정 파일을 만들어 보겠습니다:

📦 <project root>
 ├ 📂 migrations
 ├ 📂 configs
 │ └ 📜 drizzle.config.ts
 ├ 📂 src
 └ …

import { defineConfig } from "drizzle-kit";

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

이제 다음 명령어를 실행합니다:

npx drizzle-kit generate --config=./configs/drizzle.config.ts --name=seed-users --custom

이 명령어를 실행하면 다음과 같이 파일이 생성됩니다:

📦 <project root>
 ├ …
 ├ 📂 migrations
 │ ├ 📂 _meta
 │ ├ 📜 0000_init.sql 
 │ └ 📜 0001_seed-users.sql 
 └ …

-- ./drizzle/0001_seed-users.sql

INSERT INTO "users" ("name") VALUES('Dan');
INSERT INTO "users" ("name") VALUES('Andrew');
INSERT INTO "users" ("name") VALUES('Dandrew');