Drizzle와 TiDB 시작하기

기본 파일 구조

이 프로젝트의 기본 파일 구조입니다. src/db 디렉토리 안에는 schema.ts 파일에 테이블 정의가 있습니다. drizzle 폴더에는 SQL 마이그레이션 파일과 스냅샷이 있습니다.

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

1단계 - @tidbcloud/serverless 패키지 설치

npm i drizzle-orm @tidbcloud/serverless dotenv
npm i -D drizzle-kit tsx

yarn add drizzle-orm @tidbcloud/serverless dotenv
yarn add -D drizzle-kit tsx

pnpm add drizzle-orm @tidbcloud/serverless dotenv
pnpm add -D drizzle-kit tsx

bun add drizzle-orm @tidbcloud/serverless dotenv
bun add -D drizzle-kit tsx

2단계 - 연결 변수 설정하기

프로젝트 루트 디렉토리에 .env 파일을 생성하고 데이터베이스 연결 변수를 추가하세요:

DATABASE_URL=

3단계 - Drizzle ORM을 데이터베이스에 연결하기

src/db 디렉토리에 index.ts 파일을 생성하고 데이터베이스 연결을 초기화해 보겠습니다.

import { drizzle } from 'drizzle-orm/tidb-serverless';

const db = drizzle(process.env.DATABASE_URL!);

기존 드라이버를 제공해야 한다면 다음과 같이 작성할 수 있습니다.

import { connect } from '@tidbcloud/serverless';
import { drizzle } from 'drizzle-orm/tidb-serverless';

const client = connect({ url: process.env.DATABASE_URL! });
const db = drizzle({ client: client });

4단계 - 테이블 생성

src/db 디렉토리에 schema.ts 파일을 생성하고 테이블을 선언해 보겠습니다.

import { int, mysqlTable, serial, varchar } from 'drizzle-orm/mysql-core';

export const usersTable = mysqlTable('users_table', {
  id: serial().primaryKey(), // 고유 식별자, 자동 증가
  name: varchar({ length: 255 }).notNull(), // 이름, 최대 255자, 필수
  age: int().notNull(), // 나이, 필수
  email: varchar({ length: 255 }).notNull().unique(), // 이메일, 최대 255자, 필수, 고유
});

5단계 - Drizzle 설정 파일 구성

Drizzle 설정 파일 - Drizzle Kit에서 사용하는 설정 파일로, 데이터베이스 연결 정보, 마이그레이션 폴더, 스키마 파일 등 모든 정보를 포함합니다.

프로젝트 루트에 drizzle.config.ts 파일을 생성하고 다음 내용을 추가하세요:

import 'dotenv/config';
import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  out: './drizzle',
  schema: './src/db/schema.ts',
  dialect: 'mysql',
  dbCredentials: {
    url: process.env.DATABASE_URL!,
  },
});

6단계 - 데이터베이스에 변경 사항 적용하기

drizzle-kit push 커맨드를 사용하면 데이터베이스에 직접 변경 사항을 적용할 수 있습니다. 이 방법은 로컬 개발 환경에서 새로운 스키마 디자인이나 수정 사항을 빠르게 테스트할 때 유용합니다. 마이그레이션 파일을 관리할 필요 없이 빠르게 반복 작업을 진행할 수 있습니다:

npx drizzle-kit push

push 커맨드에 대해 더 알아보려면 문서를 참고하세요.

npx drizzle-kit generate

npx drizzle-kit migrate

7단계 - 데이터베이스 시드 및 쿼리

src/index.ts 파일을 사용자 생성, 조회, 수정, 삭제 쿼리로 업데이트해 보겠습니다.

import 'dotenv/config';
import { drizzle } from 'drizzle-orm/tidb-serverless';
import { eq } from 'drizzle-orm';
import { usersTable } from './db/schema';

const db = drizzle(process.env.DATABASE_URL!);

async function main() {
  // 새로운 사용자 데이터 생성
  const user: typeof usersTable.$inferInsert = {
    name: 'John',
    age: 30,
    email: 'john@example.com',
  };

  // 사용자 생성
  await db.insert(usersTable).values(user);
  console.log('새로운 사용자가 생성되었습니다!');

  // 모든 사용자 조회
  const users = await db.select().from(usersTable);
  console.log('데이터베이스에서 모든 사용자를 가져옵니다: ', users);
  /*
  const users: {
    id: number;
    name: string;
    age: number;
    email: string;
  }[]
  */

  // 사용자 정보 업데이트
  await db
    .update(usersTable)
    .set({
      age: 31,
    })
    .where(eq(usersTable.email, user.email));
  console.log('사용자 정보가 업데이트되었습니다!');

  // 사용자 삭제
  await db.delete(usersTable).where(eq(usersTable.email, user.email));
  console.log('사용자가 삭제되었습니다!');
}

main();

8단계 - index.ts 파일 실행하기

TypeScript 파일을 실행하는 방법은 여러 가지가 있지만, 여기서는 tsx를 사용하는 방법을 살펴보겠습니다.

이미 tsx를 설치했으므로, 이제 쿼리를 실행할 수 있습니다.

index.ts 스크립트 실행하기

<Npx>
  tsx src/index.ts
</Npx>

bun src/index.ts