Drizzle로 데이터베이스 연결하기

Drizzle ORM은 데이터베이스 드라이버를 통해 데이터베이스에 SQL 쿼리를 실행합니다.

index.ts

schema.ts

import { drizzle } from "drizzle-orm/node-postgres"
import { users } from "./schema"

const db = drizzle(process.env.DATABASE_URL);
const usersCount = await db.$count(users);

                        ┌──────────────────────┐
                        │   db.$count(users)   │ <--- Drizzle 쿼리
                        └──────────────────────┘     
                            │               ʌ
select count(*) from users -│               │
                            │               │- [{ count: 0 }]
                            v               │
                         ┌─────────────────────┐
                         │    node-postgres    │ <--- 데이터베이스 드라이버
                         └─────────────────────┘
                            │               ʌ
01101000 01100101 01111001 -│               │
                            │               │- 01110011 01110101 01110000
                            v               │
                         ┌────────────────────┐
                         │      Database      │ 
                         └────────────────────┘

import { pgTable, integer, text } from "drizzle-orm";

export const users = pgTable("users", {
  id: integer("id").generateAlwaysAsIdentity(),
  name: text("name"),
})

Drizzle는 내부적으로 node-postgres 드라이버 인스턴스를 생성합니다. 필요할 경우 db.$client를 통해 이 드라이버에 접근할 수 있습니다.

import { drizzle } from "drizzle-orm/node-postgres"

const db = drizzle(process.env.DATABASE_URL);
const pool = db.$client;

// 위 코드는 아래와 동일합니다.
import { drizzle } from "drizzle-orm/node-postgres";
import { Pool } from "pg";

const pool = new Pool({
  connectionString: process.env.DATABASE_URL,
});
const db = drizzle({ client: pool });

Drizzle는 설계상 모든 엣지 또는 서버리스 런타임과 기본적으로 호환됩니다. 서버리스 데이터베이스에 접근해야 할 때도 Drizzle가 도와줍니다.

Neon HTTP

Neon with websockets

Vercel Postgres

PlanetScale HTTP

Cloudflare d1

import { drizzle } from "drizzle-orm/neon-http";

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

import { drizzle } from "drizzle-orm/neon-serverless";

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

import { drizzle } from "drizzle-orm/vercel-postgres";

const db = drizzle();

import { drizzle  } from "drizzle-orm/planetscale";

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

import { drizzle  } from "drizzle-orm/d1";

const db = drizzle({ connection: env.DB });

또한, Bun SQLite나 Expo SQLite와 같은 런타임 특화 드라이버도 지원합니다.

import { drizzle } from "drizzle-orm/bun-sqlite"

const db = drizzle(); // <--- 메모리 내 데이터베이스 생성
const db = drizzle("./sqlite.db");

import { drizzle } from "drizzle-orm/expo-sqlite";
import { openDatabaseSync } from "expo-sqlite/next";

const expo = openDatabaseSync("db.db");
const db = drizzle(expo);

데이터베이스 연결 URL

데이터베이스 연결 URL 개념에 익숙하지 않은 분들을 위해 설명드립니다.

postgresql://alex:AbC123dEf@ep-cool-darkness-123456.us-east-2.aws.neon.tech/dbname
             └──┘ └───────┘ └─────────────────────────────────────────────┘ └────┘
              ʌ    ʌ          ʌ                                              ʌ
        역할 -│    │          │- 호스트명                                    │- 데이터베이스
                   │
                   │- 비밀번호

위 예제는 PostgreSQL 데이터베이스 연결 URL을 보여줍니다. 각 부분은 다음과 같은 의미를 가집니다:

postgresql://: 데이터베이스 프로토콜
alex: 데이터베이스 접속 역할(role)
AbC123dEf: 데이터베이스 접속 비밀번호
ep-cool-darkness-123456.us-east-2.aws.neon.tech: 데이터베이스 호스트명
dbname: 연결할 데이터베이스 이름

이 형식은 다양한 데이터베이스 시스템에서 유사하게 사용됩니다. 여러분이 사용하는 데이터베이스에 맞게 URL을 구성하면 됩니다.

다음 단계

각 드라이버별 문서를 확인해 보세요.

PostgreSQL 드라이버

PostgreSQL Neon Vercel Postgres Supabase Xata PGLite

MySQL 드라이버

MySQL PlanetsScale TiDB

SQLite 드라이버

SQLite Turso Cloudflare D1 Bun SQLite

네이티브 SQLite

Expo SQLite OP SQLite React Native SQLite

기타

Drizzle Proxy