drizzle-kit pull

drizzle-kit pull 명령어를 사용하면 기존 데이터베이스 스키마를 가져와서(introspect) schema.ts 파일로 Drizzle 스키마를 생성할 수 있습니다. 이 기능은 Drizzle 마이그레이션의 데이터베이스 우선 접근 방식을 지원하기 위해 설계되었습니다.

                                  ┌────────────────────────┐      ┌─────────────────────────┐ 
                                  │                        │ <---  CREATE TABLE "users" (
┌──────────────────────────┐      │                        │        "id" SERIAL PRIMARY KEY,
│ ~ drizzle-kit pull       │      │                        │        "name" TEXT,
└─┬────────────────────────┘      │        DATABASE        │        "email" TEXT UNIQUE
  │                               │                        │       );
  └ 데이터베이스 스키마 가져오기 -----> │                        │
  ┌ Drizzle 스키마 생성       <----- │                        │
  │ TypeScript 파일 생성            └────────────────────────┘
  │
  v

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(), 
};

이 기능은 TypeScript 프로젝트 외부에서 데이터베이스 스키마를 관리하거나, 다른 사람이 관리하는 데이터베이스를 사용할 때 유용합니다.

drizzle-kit pull을 사용하려면 dialect와 데이터베이스 연결 url 또는 user:password@host:port/db 파라미터를 지정해야 합니다. 이 값들은 drizzle.config.ts 설정 파일을 통해 제공하거나 CLI 옵션으로 직접 전달할 수 있습니다.

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

export default defineConfig({
  dialect: "postgresql",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname",
  },
});

npx drizzle-kit pull

npx drizzle-kit pull --dialect=postgresql --url=postgresql://user:password@host:port/dbname

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

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

npx drizzle-kit pull --config=drizzle-dev.config.ts
npx drizzle-kit pull --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은 사전에 번들링된 데이터베이스 드라이버를 포함하지 않습니다. 현재 프로젝트에서 사용 가능한 데이터베이스 드라이버를 dialect에 따라 자동으로 선택합니다. 토론 참고

대부분 동일한 dialect의 드라이버들은 동일한 연결 파라미터 집합을 공유합니다. 하지만 aws-data-api, pglight, d1-http와 같은 예외적인 경우에는 driver 파라미터를 명시적으로 지정해야 합니다.

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  driver: "aws-data-api",
  dbCredentials: {
    database: "database",
    resourceArn: "resourceArn",
    secretArn: "secretArn",
  },
});

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  driver: "pglite",
  dbCredentials: {
    // 메모리 내
    url: ":memory:"
    
    // 또는 데이터베이스 폴더
    url: "./database/"
  },
});

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "sqlite",
  driver: "d1-http",
  dbCredentials: {
    accountId: "accountId",
    databaseId: "databaseId",
    token: "token",
  },
});

테이블, 스키마, 확장 기능 포함하기

drizzle-kit push는 기본적으로 public 스키마의 모든 테이블을 관리합니다.
tablesFilters, schemaFilter, extensionFilters 옵션을 통해 테이블 목록, 스키마, 확장 기능을 설정할 수 있습니다.

public 스키마의 모든 테이블만 작업하고,
drizzle-kit에게 postgis 확장 기능이 설치되어 있음을 알려줍니다.
이 확장 기능은 public 스키마에 자체 테이블을 생성하므로, drizzle이 이를 무시할 수 있도록 설정합니다.

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname",
  },
  extensionsFilters: ["postgis"],
  schemaFilter: ["public"],
  tablesFilter: ["*"],
});

npx drizzle-kit push

확장된 설정 목록

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

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

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

drivers: ['aws-data-api', 'd1-http', 'pglight']

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

npx drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --url=postgresql://user:password@host:port/dbname
npx drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --driver=pglite url=database/
npx drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

yarn drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --url=postgresql://user:password@host:port/dbname
yarn drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --driver=pglite url=database/
yarn drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

pnpm drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --url=postgresql://user:password@host:port/dbname
pnpm drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --driver=pglite url=database/
pnpm drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname

bun drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --url=postgresql://user:password@host:port/dbname
bun drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --driver=pglite url=database/
bun drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname