이 튜토리얼에서는 PlanetScale 데이터베이스에 HTTP 호출을 하기 위해 database-js 드라이버를 사용합니다. TCP를 통해 PlanetScale에 연결해야 한다면, MySQL 시작하기 페이지를 참고하세요.
Drizzle와 PlanetScale 시작하기
This guide assumes familiarity with:
중요
기본 파일 구조
이 프로젝트의 기본 파일 구조입니다. src/db 디렉토리 안에는 schema.ts 파일에 테이블 정의가 있습니다. drizzle 폴더에는 SQL 마이그레이션 파일과 스냅샷이 있습니다.
📦 <project root>
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json1단계 - @planetscale/database 패키지 설치
npm
yarn
pnpm
bun
npm i drizzle-orm @planetscale/database dotenv
npm i -D drizzle-kit tsx2단계 - 연결 변수 설정하기
프로젝트 루트에 .env 파일을 생성하고 데이터베이스 연결 변수를 추가합니다:
DATABASE_HOST=
DATABASE_USERNAME=
DATABASE_PASSWORD=팁
database-js 드라이버를 통해 연결하는 데 필요한 모든 환경 변수를 얻으려면 PlanetScale 문서를 참고하세요.
3단계 - Drizzle ORM을 데이터베이스에 연결하기
src/db 디렉토리에 index.ts 파일을 생성하고 데이터베이스 연결을 초기화해 보겠습니다.
import { drizzle } from "drizzle-orm/planetscale-serverless";
const db = drizzle({
connection: {
host: process.env.DATABASE_HOST!,
username: process.env.DATABASE_USERNAME!,
password: process.env.DATABASE_PASSWORD!,
},
});기존 드라이버를 사용해야 한다면 다음과 같이 작성할 수 있습니다.
import { drizzle } from "drizzle-orm/planetscale-serverless";
import { Client } from "@planetscale/database";
const client = new Client({
host: process.env.DATABASE_HOST!,
username: process.env.DATABASE_USERNAME!,
password: process.env.DATABASE_PASSWORD!,
});
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 pushpush 커맨드에 대해 더 알아보려면 문서를 참고하세요.
팁
또는 drizzle-kit generate 커맨드로 마이그레이션을 생성한 후, drizzle-kit migrate 커맨드로 적용할 수도 있습니다:
마이그레이션 생성:
npx drizzle-kit generate마이그레이션 적용:
npx drizzle-kit migrate마이그레이션 프로세스에 대해 더 알아보려면 문서를 참고하세요.
7단계 - 데이터베이스 시드 및 쿼리
src/index.ts 파일을 사용자 생성, 조회, 수정, 삭제 쿼리로 업데이트해 보겠습니다.
import 'dotenv/config';
import { eq } from 'drizzle-orm';
import { drizzle } from 'drizzle-orm/planetscale-serverless';
import { usersTable } from './db/schema';
const db = drizzle({
connection: {
host: process.env.DATABASE_HOST!,
username: process.env.DATABASE_USERNAME!,
password: process.env.DATABASE_PASSWORD!,
}
});
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>팁
TypeScript 파일을 실행할 때 bun을 사용하는 것을 추천합니다. bun을 사용하면 프로젝트가 CommonJS(CJS), ECMAScript Modules(ESM) 또는 다른 모듈 형식으로 구성되어 있더라도 추가 설정 없이 스크립트를 실행할 수 있습니다. bun으로 스크립트를 실행하려면 다음 명령어를 사용하세요:
bun src/index.ts만약 bun이 설치되어 있지 않다면, Bun 설치 문서를 참고하세요.