概要

この記事では、AWSのData APIを通じてDrizzle ORMでMySQLデータベースに接続し、サーバレス環境でデータ操作を行う方法を解説します。Drizzle ORMは型安全なORMで、AWSのData APIを活用することでサーバレス環境からMySQLデータベースへの接続が可能となり、効率的で安全なデータ管理が実現します。Data APIはクライアントライブラリなしでデータベース操作が行えるため、サーバレス環境でのデータベース利用に最適です。

AWSのData APIとDrizzle ORMの概要

AWS Data APIとは

AWS Data APIは、Amazon RDS上のMySQLやAurora ServerlessにアクセスできるAPIで、SQLクエリをHTTPリクエスト経由で実行する機能を提供します。以下の利点があります：

  • サーバレス対応：クライアントライブラリ不要で、AWS Lambdaなどのサーバレス環境から直接データベースにアクセスできる。
  • IAM認証でのセキュアなアクセス：安全な認証を提供し、アクセス制御が簡単。
  • 高いスケーラビリティ：オンデマンドでスケールするため、大規模なデータ操作にも対応。

Drizzle ORMとは

Drizzle ORMは、JavaScriptとTypeScriptで使用できる軽量なORMで、型安全なデータベース操作が可能です。Drizzle ORMはSQLに近い記述でクエリを操作でき、型定義が明確なためエラーの少ないコードが書けます。Data APIと組み合わせることで、AWSのサーバレス環境でも簡単かつ効率的にデータ操作が可能です。

AWS Data APIとDrizzle ORMでMySQLに接続する手順

AWS RDSでのMySQLインスタンス作成とData APIの有効化

まず、AWS RDSでMySQLデータベースインスタンスを作成し、Data APIを有効にします。

  1. AWS Management Consoleにログインし、RDSサービスで「データベースを作成」します。
  2. データベースエンジンとしてMySQLを選択。
  3. 「サーバレス」設定でインスタンスを作成し、設定完了後にData APIを有効化します。
  4. AWSによって生成されたData APIのエンドポイントURLやARN（Amazon Resource Name）を控えておきます。 これにより、AWSのData API経由で、HTTPリクエストを使ってサーバレス環境からMySQLに接続できるようになります。

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

Drizzle ORMとAWSのData APIに接続するために必要なパッケージをインストールします。@aws-sdk/client-rds-dataはData APIへのアクセスに使います。

npm install drizzle-orm @aws-sdk/client-rds-data
  • drizzle-orm：ORM本体で、型安全なクエリを提供します。
  • @aws-sdk/client-rds-data：AWS Data APIに接続するためのSDKです。

Drizzle ORMとAWS Data APIの接続設定

Drizzle ORMを利用してAWS Data API経由でMySQLに接続するため、クライアント設定を行います。以下の設定例を参考にdatabase.jsファイルを作成します。

// 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",  // データベースのリージョン
  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", // データベース名
  resourceArn: "your-db-cluster-arn", // RDSのリソースARN
  secretArn: "your-db-credentials-arn", // Secrets Managerで管理される認証情報のARN
});
export default db;

接続情報の詳細：

  • region：MySQLデータベースのAWSリージョン。
  • database：MySQLのデータベース名。
  • resourceArn：RDSインスタンスのリソースARN。
  • secretArn：データベース認証情報が保存されているSecrets ManagerのARN。 これにより、Drizzle ORMを介してAWS Data APIでMySQLにアクセスできるようになります。

テーブルのスキーマ定義

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(),
  role: sqlColumn("role").string().notNull(),
  salary: sqlColumn("salary").int()
});

このスキーマ定義では、employeesテーブルにid、name、role、salaryの各カラムが含まれ、Drizzle ORMによる型安全な操作が可能です。

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

Drizzle ORMを利用して、AWS Data API経由でMySQLに対するデータ操作を行います。以下に基本的なCRUD操作のサンプルコードを示します。

データの挿入

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

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

データの取得

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

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

データの更新

async function updateEmployeeRole(id, newRole) {
  await db.update(employees)
    .set({ role: newRole })
    .where(employees.id.equals(id));
}

updateEmployeeRole関数は、指定した従業員の役職（role）を更新します。

データの削除

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

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

AWS LambdaやAPI Gatewayとの統合

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

// 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, role, salary } = JSON.parse(event.body);
    await db.insert(employees).values({ name, role, salary });
    return {
      statusCode: 201,
      body: JSON.stringify({ message: "Employee added" }),
    };
  }
};

このコードをAWS Lambdaにデプロイし、API Gatewayを設定することで、HTTPリクエストを受けてMySQLデータベースにアクセスできるAPIエンドポイントが完成します。

エラー対処と注意点

  1. Data API接続エラー
    リージョンやARNが正しく設定されているかを確認してください。特に環境変数で情報を管理する場合、正確な情報が設定されているかをチェックしましょう。
  2. アクセス権限
    Lambda関数がData APIやSecrets Managerにアクセスできるよう、適切なIAMロールを設定します。
  3. 型エラー
    Drizzle ORMはTypeScriptと互換性が高く、型安全なデータ操作が可能です。スキーマと一致しないデータを挿入しようとするとエラーが発生するため、TypeScriptの型チェックを利用してエラーを事前に防ぎましょう。

まとめ

Drizzle ORMとAWSのData APIを組み合わせることで、型安全かつ効率的なサーバレス環境でのMySQLデータベース操作が可能になります。AWSのData APIはHTTPリクエストでデータベース操作が行えるため、LambdaやAPI Gatewayとの連携が容易で、スケーラブルでセキュアなデータ管理が実現します。Drizzle ORMを利用することで、シンプルで型安全なデータ操作を提供し、モダンなサーバレスアーキテクチャに最適な構成が可能です。

参照:

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