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. read previous migration folders
    2. find diff between current and previous scheama
    3. prompt developer for renames if necessary
  ┌ 4. generate SQL migration and persist to file
  │    ┌─┴───────────────────────────────────────┐  
  │      📂 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은 schema 구성 옵션을 통해 glob 형식으로 경로를 지정해야 합니다.

📦 <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",
  //or
  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's favourite
});

사용자 지정 마이그레이션 파일 이름

--name CLI 옵션을 제공하여 사용자 지정 마이그레이션 파일 이름을 설정할 수 있습니다

npx drizzle-kit generate --name=init

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

하나의 프로젝트에서 여러 구성 파일 사용

프로젝트에 여러 구성 파일을 가질 수 있으며, 이는 여러 데이터베이스 단계나 동일한 프로젝트에서 여러 데이터베이스 또는 다른 데이터베이스를 사용할 때 매우 유용합니다:

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

bunx drizzle-kit generate --config=drizzle-dev.config.ts
bunx 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 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 generate --name=init
npx drizzle-kit generate --name=seed_users --custom

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

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

bunx drizzle-kit generate --name=init
bunx drizzle-kit generate --name=seed_users --custom

drizzle.config.ts 파일을 통해 drizzle-kit을 구성하는 것을 권장하지만, 필요한 경우(예: CI/CD 파이프라인 등) CLI를 통해 모든 구성 옵션을 제공할 수 있습니다.

확장 예제

./src/schema.ts에 위치한 Drizzle 스키마와 기본 ./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');