概要

この記事では、Drizzle ORMを用いてAWSのData API経由でPostgreSQLデータベースに接続し、サーバレス環境でデータ操作を行う方法を詳しく解説します。Drizzle ORMは、JavaScriptやTypeScriptで型安全なデータベース操作を提供し、AWSのData APIを利用することで、サーバレスアーキテクチャでも簡単にPostgreSQLにアクセスできます。Data APIは、AWSのRDSにおいてクライアントライブラリを使用せずにHTTPリクエストを介してデータベース操作ができる仕組みです。

AWSのData APIとDrizzle ORMの概要

AWS Data APIとは

AWS Data APIは、RDS（Relational Database Service）上のPostgreSQLおよびAmazon Auroraサーバレスインスタンスに対して、HTTPリクエストを介してデータ操作を行うAPIです。これにより、以下のような利点が得られます：

  • サーバレス対応：クライアントライブラリなしでデータベースにアクセスでき、AWS Lambdaなどのサーバレス環境で利用しやすい。
  • セキュアなアクセス：IAM認証で安全にデータベースにアクセス。
  • スケーラビリティ：オンデマンドでデータベースにアクセスするため、高いスケーラビリティを実現。

Drizzle ORMとは

Drizzle ORMは、JavaScriptやTypeScriptで利用できる軽量で型安全なORMです。Drizzle ORMはSQLに似た直感的なクエリ構文を提供し、TypeScriptの型を活用して安全にデータベース操作を行うことができます。AWSのData APIと組み合わせることで、サーバレス環境でも効率的にデータ管理が可能です。

AWS Data APIとDrizzle ORMの接続手順

AWS環境の設定 - RDSインスタンスの作成とData APIの有効化

まず、AWS RDSでPostgreSQLインスタンスを作成し、Data APIを有効にする必要があります。

  1. AWS Management Consoleにログイン。
  2. RDSサービスから新規データベースを作成し、データベースエンジンとしてPostgreSQLを選択。
  3. 作成画面で「サーバレス」モードを選び、インスタンス設定を完了します。
  4. データベース作成後、Data APIを有効にします。 この設定により、AWSのData APIを使ってHTTPリクエストでデータベースにアクセスできるようになります。Data APIのエンドポイントURLやARN（Amazon Resource Name）を控えておきましょう。

必要なパッケージのインストール

Drizzle ORMとAWS SDKを利用してData APIに接続するため、drizzle-ormと@aws-sdk/client-rds-dataをインストールします。

npm install drizzle-orm @aws-sdk/client-rds-data
  • drizzle-ormは型安全なORMで、クエリの記述を簡単に行えます。
  • @aws-sdk/client-rds-dataはAWS Data APIにアクセスするためのAWS SDKクライアントです。

Drizzle ORMとData APIの接続設定

Drizzle ORMを使用してAWS Data API経由でPostgreSQLに接続するために、必要な設定を行います。以下に、接続設定の例を示します。

// database.js
import { RDSDataClient, ExecuteStatementCommand } from "@aws-sdk/client-rds-data";
import { drizzle } from "drizzle-orm";
// Data APIクライアントの設定
const client = new RDSDataClient({
  region: "us-east-1",  // 自身のAWSリージョンに置き換え
  credentials: {
    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
  }
});
// `Drizzle` ORMのインスタンスを作成
const db = drizzle(client, {
  database: "your-database-name", // PostgreSQLデータベース名
  resourceArn: "your-db-cluster-arn", // RDSのリソースARN
  secretArn: "your-db-credentials-arn", // 秘密情報のARN
});
export default db;

database.jsで指定する情報には以下が含まれます：

  • region：データベースが配置されているリージョン。
  • database：使用するPostgreSQLのデータベース名。
  • resourceArn：RDSインスタンスのリソースARN。
  • secretArn：AWS Secrets Managerで管理されているデータベースの認証情報のARN。 これにより、Drizzle ORM経由でData APIを使用してPostgreSQLに接続できます。

テーブルのスキーマ定義

Drizzle ORMを使用して、テーブルのスキーマを定義します。以下は、employeesというテーブルのスキーマ例です。

// schema.js
import { sqlTable, sqlColumn } from "drizzle-orm";
// employeesテーブルの定義
export const employees = sqlTable("employees", {
  id: sqlColumn("id").int().primaryKey().autoIncrement(),
  name: sqlColumn("name").string().notNull(),
  position: sqlColumn("position").string().notNull(),
  salary: sqlColumn("salary").int()
});

employeesテーブルには、id、name、position、salaryの4つのフィールドがあり、それぞれのデータ型と制約を定義しています。Drizzle ORMが型安全に操作できるように、テーブル構造を明示的に定義します。

データ操作 - 挿入、取得、更新、削除

Drizzle ORMを使ってData API経由でPostgreSQLにデータ操作を行います。以下に、基本的なCRUD操作の例を示します。

データの挿入

import db from "./database";
import { employees } from "./schema";
async function insertEmployee(name, position, salary) {
  await db.insert(employees).values({ name, position, salary });
}

この関数は、employeesテーブルに新しい従業員データを挿入します。

データの取得

async function getEmployees() {
  const result = await db.select().from(employees);
  return result;
}

getEmployees関数は、employeesテーブルからすべてのデータを取得します。

データの更新

async function updateEmployeeSalary(id, newSalary) {
  await db.update(employees)
    .set({ salary: newSalary })
    .where(employees.id.equals(id));
}

updateEmployeeSalary関数は、指定された従業員の給与情報を更新します。

データの削除

async function deleteEmployee(id) {
  await db.delete(employees)
    .where(employees.id.equals(id));
}

deleteEmployee関数は、指定されたIDを持つ従業員のデータを削除します。

AWS LambdaやAPI Gatewayと統合する

AWSのData APIは、サーバレス環境に適しているため、Lambda関数でこれらのデータ操作を実行することが推奨されます。以下は、Lambda関数を利用したエンドポイントの作成例です。

// lambda-handler.js
import db from "./database";
import { employees } from "./schema";
export const handler = async (event) => {
  if (event.httpMethod === "GET") {
    const employeesList = await db.select().from(employees);
    return {
      statusCode: 200,
      body: JSON.stringify(employeesList),
    };
  } else if (event.httpMethod === "POST") {
    const { name, position, salary } = JSON.parse(event.body);
    await db.insert(employees).values({ name, position, salary });
    return {
      statusCode: 201,
      body: JSON.stringify({ message: "Employee added" }),
    };
  }
};

このコードをデプロイすれば、Lambda経由でAPI GatewayからHTTPリクエストに応じてPostgreSQLにアクセスできるエンドポイントが構築されます。

エラー対処と注意点

  1. 接続エラー
    AWSのリージョン設定やARNが間違っていると、Data API接続エラーが発生します。環境変数でこれらの情報を管理し、AWS設定が正しいかを再確認してください。
  2. アクセス権限
    Lambda関数でData APIを利用する場合、IAMロールに適切な権限（RDSおよびSecrets Managerへのアクセス許可）を付与してください。
  3. 型エラー
    Drizzle ORMはTypeScriptの型に基づく型安全な操作をサポートしていますが、スキーマの型と一致しないデータ操作をしようとするとエラーが発生します。TypeScriptの型チェックを活用しましょう。

まとめ

Drizzle ORMとAWSのData APIを使うことで、サーバレス環境からPostgreSQLへの安全でスケーラブルなデータアクセスが可能です。Data APIはHTTPリクエストでデータベース操作ができるため、AWS LambdaやAPI Gatewayとの統合も簡単で、サーバレスアーキテクチャを最大限に活用したデータベース管理が実現します。Drizzle ORMの型安全な操作とAWSの高度なインフラを組み合わせることで、高パフォーマンスかつセキュアなデータ管理が可能です。

参照:

Connecting to AWS Data API for PostgreSQL | `Drizzle` ORM Documentation