Drizzle HTTP 프록시

This guide assumes familiarity with:

Drizzle의 데이터베이스 연결 기초

HTTP 프록시의 작동 방식과 필요한 이유

Drizzle 프록시는 데이터베이스와의 드라이버 통신을 직접 구현해야 할 때 사용됩니다. 기존 드라이버에 쿼리 단계에서 커스텀 로직을 추가하는 등 여러 경우에 사용할 수 있습니다. 가장 일반적인 사용 사례는 HTTP 드라이버로, 데이터베이스가 있는 서버로 쿼리를 전송하고, 데이터베이스에서 쿼리를 실행한 후, Drizzle ORM이 결과로 매핑할 수 있는 원시 데이터를 응답으로 반환합니다

내부적으로 어떻게 작동하나요?

┌───────────────────────────┐                 ┌─────────────────────────────┐              
│       Drizzle ORM         │                 │  HTTP Server with Database  │             
└─┬─────────────────────────┘                 └─────────────────────────┬───┘             
  │                                                ^                    │
  │-- 1. Build query         2. Send built query --│                    │
  │                                                │                    │
  │              ┌───────────────────────────┐     │                    │
  └─────────────>│                           │─────┘                    │ 
                 │      HTTP Proxy Driver    │                          │
  ┌──────────────│                           │<─────────────┬───────────┘
  │              └───────────────────────────┘              │
  │                                                  3. Execute a query + send raw results back
  │-- 4. Map data and return        
  │                   
  v

Drizzle ORM은 SQL 실행을 위한 비동기 콜백 함수를 간단히 사용하는 것도 지원합니다.

sql은 플레이스홀더가 포함된 쿼리 문자열입니다.
params는 매개변수 배열입니다.
method는 SQL 문에 따라 run, all, values 또는 get 중 하나로 설정됩니다.

Drizzle은 항상 반환 값으로 {rows: string[][]} 또는 {rows: string[]}를 기대합니다.

method가 get일 때는 {rows: string[]} 형태로 값을 반환해야 합니다.
그 외의 경우에는 {rows: string[][]} 형태로 반환해야 합니다.

PostgreSQL

MySQL

SQLite

// Example of driver implementation
import { drizzle } from 'drizzle-orm/pg-proxy';

const db = drizzle(async (sql, params, method) => {
  try {
    const rows = await axios.post('http://localhost:3000/query', { sql, params, method });

    return { rows: rows.data };
  } catch (e: any) {
    console.error('Error from pg proxy server: ', e.response.data)
    return { rows: [] };
  }
});

// Example of server implementation
import { Client } from 'pg';
import express from 'express';

const app = express();

app.use(express.json());
const port = 3000;

const client = new Client('postgres://postgres:postgres@localhost:5432/postgres');

app.post('/query', async (req, res) => {
  const { sql, params, method } = req.body;

  // prevent multiple queries
  const sqlBody = sql.replace(/;/g, '');

  try {
    const result = await client.query({
      text: sqlBody,
      values: params,
      rowMode: method === 'all' ? 'array': undefined,
    });
    res.send(result.rows);
  } catch (e: any) {
    res.status(500).json({ error: e });
  }

  res.status(500).json({ error: 'Unknown method value' });
});

app.listen(port, () => {
  console.log(`Example app listening on port ${port}`);
});

// Example of driver implementation
import { drizzle } from 'drizzle-orm/mysql-proxy';

const db = drizzle(async (sql, params, method) => {
  try {
    const rows = await axios.post('http://localhost:3000/query', { sql, params, method });

    return { rows: rows.data };
  } catch (e: any) {
    console.error('Error from mysql proxy server: ', e.response.data)
    return { rows: [] };
  }
});

// Example of server implementation
import * as mysql from 'mysql2/promise';
import express from 'express';

const app = express();

app.use(express.json());
const port = 3000;

const main = async () => {
    const connection = await mysql.createConnection('mysql://root:mysql@127.0.0.1:5432/drizzle');

    app.post('/query', async (req, res) => {
      const { sql, params, method } = req.body;

      // prevent multiple queries
      const sqlBody = sql.replace(/;/g, '');

      try {
            const result = await connection.query({
                sql: sqlBody,
                values: params,
                rowsAsArray: method === 'all',
                typeCast: function(field: any, next: any) {
                    if (field.type === 'TIMESTAMP' || field.type === 'DATETIME' || field.type === 'DATE') {
                        return field.string();
                    }
                    return next();
                },
            });
      } catch (e: any) {
        res.status(500).json({ error: e });
      }

      if (method === 'all') {
        res.send(result[0]);
      } else if (method === 'execute') {
        res.send(result);
      }
      res.status(500).json({ error: 'Unknown method value' });
    });

    app.listen(port, () => {
      console.log(`Example app listening on port ${port}`);
    });
}

main();

import { drizzle } from 'drizzle-orm/sqlite-proxy';

const db = drizzle(async (sql, params, method) => {
  try {
    const rows = await axios.post('http://localhost:3000/query', { sql, params, method });

    return { rows: rows.data };
  } catch (e: any) {
    console.error('Error from sqlite proxy server: ', e.response.data)
    return { rows: [] };
  }
});

배치 지원

SQLite 프록시는 다른 모든 드라이버와 동일하게 배치 요청을 지원합니다. 전체 문서를 확인하세요.

배치 쿼리를 위한 특정 콜백을 지정하고 프록시 서버로의 요청을 처리해야 합니다:

import { drizzle } from 'drizzle-orm/sqlite-proxy';

type ResponseType = { rows: any[][] | any[] }[];

const db = drizzle(async (sql, params, method) => {
  // single queries logic. Same as in code above
}, async (queries: { sql: string, params: any[], method: 'all' | 'run' | 'get' | 'values'}[]) => {
    try {
      const result: ResponseType = await axios.post('http://localhost:3000/batch', { queries });

      return result;
    } catch (e: any) {
      console.error('Error from sqlite proxy server:', e);
      throw e;
    }
  });

그런 다음 db.batch([]) 메서드를 사용하여 모든 쿼리를 프록시할 수 있습니다

배치의 응답은 프록시 서버로 전송된 순서와 동일한 순서로 원시 값의 배열(배열 내 배열)이어야 합니다

모든 SQL 쿼리를 직접 작성할 계획이 아니라면 테이블 선언이 유용합니다:

import { sql } from "drizzle-orm";
import { text, integer, sqliteTable } from "drizzle-orm/sqlite-core";

const users = sqliteTable('users', {
  id: text('id'),
  textModifiers: text('text_modifiers').notNull().default(sql`CURRENT_TIMESTAMP`),
  intModifiers: integer('int_modifiers', { mode: 'boolean' }).notNull().default(false),
});

컬럼 타입에 대한 자세한 내용은 **Drizzle의 SQLite 컬럼 타입**을 참조하세요.