tRPC API からリレーショナルデータベースへの接続

connection ジェネレーターは、tRPC API を リレーショナルデータベース プロジェクトに接続し、プロシージャコンテキストで Prisma クライアントを利用可能にする型安全な tRPC ミドルウェアプラグインを生成します。

前提条件

このジェネレーターを使用する前に、以下を確認してください：

1. tRPC API プロジェクト（ts#api で生成）
2. ts#rdb プロジェクト

使用方法

ジェネレーターの実行

CLI

pnpm

pnpm nx g @aws/nx-plugin:connection

yarn

yarn nx g @aws/nx-plugin:connection

npm

npx nx g @aws/nx-plugin:connection

bun

bunx nx g @aws/nx-plugin:connection

変更されるファイルを確認するためにドライランを実行することもできます

pnpm

pnpm nx g @aws/nx-plugin:connection --dry-run

yarn

yarn nx g @aws/nx-plugin:connection --dry-run

npm

npx nx g @aws/nx-plugin:connection --dry-run

bun

bunx nx g @aws/nx-plugin:connection --dry-run

VSCode

1. インストール Nx Console VSCode Plugin まだインストールしていない場合
2. VSCodeでNxコンソールを開く
3. クリック Generate (UI) "Common Nx Commands"セクションで
4. 検索 @aws/nx-plugin - connection
5. 必須パラメータを入力
6. クリック Generate

ソースとして tRPC API プロジェクトを選択し、ターゲットとしてリレーショナルデータベースプロジェクトを選択します。

オプション

パラメータ	型	デフォルト	説明
sourceProject 必須	string	-	ソース プロジェクト
targetProject 必須	string	-	接続先のターゲット プロジェクト
sourceComponent	string	-	接続元のソース コンポーネント (コンポーネント名、ソース プロジェクト ルートからの相対パス、またはジェネレーター ID)。プロジェクトをソースとして明示的に選択するには '.' を使用します。
targetComponent	string	-	接続先のターゲット コンポーネント (コンポーネント名、ターゲット プロジェクト ルートからの相対パス、またはジェネレーター ID)。プロジェクトをターゲットとして明示的に選択するには '.' を使用します。
preferInstallDependencies	boolean	true	ジェネレーター実行後に依存関係のインストールを優先するかどうか。複数のジェネレーターをバッチ処理する際にインストールを延期する場合はfalseに設定します（後続のジェネレーターがNxプロジェクトグラフを計算できるよう、必要に応じてインストールは実行されます）。最後に一度だけインストールします。

ジェネレーターの出力

ジェネレーターは、tRPC API プロジェクト内にミドルウェアファイルを作成します：

• Directorypackages/api/src

  • Directorymiddleware

    • <db-name>.ts tRPC plugin exposing the Prisma client in procedure context

さらに、tRPC API の dev ターゲットを更新して、ローカル実行時にデータベースが自動的に起動するようにします。

ミドルウェアの使用

プラグインの登録

生成されたプラグインを tRPC ルーターに追加して、それを使用するすべてのプロシージャがデータベースにアクセスできるようにします：

packages/api/src/router.ts

import { t } from './init.js';
import { createMyDbPlugin } from './middleware/my-db.js';

export const authenticatedProcedure = t.procedure
  .concat(createMyDbPlugin());

プロシージャ内でのデータベースへのアクセス

プラグインは IMyDbContext をプロシージャコンテキストにマージし、myDb をオプショナルプロパティとして利用可能にします：

packages/api/src/procedures/users.ts

import { z } from 'zod';
import { authenticatedProcedure } from '../router.js';

export const listUsers = authenticatedProcedure
  .output(z.array(z.object({ id: z.string(), name: z.string() })))
  .query(async ({ ctx }) => {
    // ctx.myDb is the Prisma client — typed as Awaited<ReturnType<typeof getPrisma>>
    return await ctx.myDb!.user.findMany();
  });

MySQL: リクエストごとに切断

ターゲットデータベースが MySQL エンジンを使用している場合、生成されたミドルウェアは opts.next() を try/finally ブロックでラップし、$disconnect() を呼び出します：

packages/api/src/middleware/my-db.ts

return t.procedure.use(async (opts) => {
  const myDb = await getPrisma();
  try {
    return await opts.next({ ctx: { ...opts.ctx, myDb } });
  } finally {
    await myDb.$disconnect();
  }
});

これは、MySQL アダプターがクエリ後に Node.js イベントループを保持し続けることに対処するもので、そうしないと Lambda がストリーミングレスポンスをフラッシュできなくなります。finally で切断することでイベントループが解放され、レスポンスが完了できるようになります。詳細は MySQL: API Gateway ストリーミングモード を参照してください。

PostgreSQL ではこれは不要です — そのアダプターは allowExitOnIdle: true で設定された接続プールを使用します。

MySQL: IAM トークンの有効期限

RDS IAM トークンは 15 分 で期限切れになります。MySQL アダプターは接続時にトークンをキャプチャします。Lambda がトークンの有効期限が切れるまで十分長くウォーム状態を保つと、新しい接続試行が失敗する可能性があります。接続エラーをチェックし、getPrisma() を再度呼び出して新しいトークンを持つ新しいクライアントを取得してください。詳細と回避策については MySQL: IAM トークンの有効期限 を参照してください。

複数のデータベース

異なるターゲットでジェネレーターを再度実行することで、追加のデータベースを接続できます。各データベースは独自のプラグインとコンテキストインターフェースを取得します：

packages/api/src/router.ts

export const dbProcedure = t.procedure
  .concat(createMyDbPlugin())
  .concat(createOtherDbPlugin());

インフラストラクチャ

実行時にAPIがデータベースに接続できるようにするには、API Lambda関数をデータベースと同じVPCにデプロイし、ネットワークおよびIAMアクセスを付与する必要があります。

CDK

アプリケーションスタックで、APIをデータベースと同じVPCにデプロイし、allowDefaultPortFromとgrantConnectを呼び出して、ネットワークパスを開き、各Lambdaハンドラーに IAM rds-db:connect権限を付与します：

packages/infra/src/stacks/application-stack.ts

import { MyDatabase } from '@my-scope/common-constructs';

const db = new MyDatabase(this, 'Db', { vpc, ... });

const api = new MyApi(this, 'Api', {
  integrations: MyApi.defaultIntegrations(this)
    .withDefaultOptions({
      vpc,
      vpcSubnets: { subnetType: SubnetType.PRIVATE_WITH_EGRESS },
    })
    .build(),
});

Object.entries(api.integrations).forEach(([operation, integration]) => {
  db.allowDefaultPortFrom(integration.handler, `Allow ${operation} to connect to the database`);
  db.grantConnect(integration.handler);
});

API Lambda関数は、プライベート分離サブネットではなく、エグレス付きプライベートサブネットにデプロイしてください。実行時に、getPrisma()はAWS AppConfigからデータベース接続の詳細を取得しますが、これはアウトバウンドインターネットアクセスを必要とするパブリックAWSサービスエンドポイントです。

Note

この例では、API内のすべてのハンドラーにアクセスを付与していますが、一部のハンドラーのみがアクセスを必要とする場合は、個別に設定する方が良いでしょう。

Terraform

APIをデータベースと同じVPCにデプロイし、additional_iam_policy_statementsを介してrds-db:connectを付与し、セキュリティグループルールのペアでネットワークパスを開きます。aws_vpc.mainとaws_subnetリソースは、データベースデプロイメントガイドで定義されています：

packages/infra/src/main.tf

module "my_database" {
  source              = "../../common/terraform/src/app/dbs/my-database"
  vpc_id              = aws_vpc.main.id
  database_subnet_ids = aws_subnet.database[*].id
  lambda_subnet_ids   = aws_subnet.private[*].id
}

module "api" {
  source     = "../../common/terraform/src/app/apis/my-api"
  enable_vpc = true
  vpc_id     = aws_vpc.main.id
  subnet_ids = aws_subnet.private[*].id

  appconfig_application_id  = module.runtime_config_appconfig.application_id
  appconfig_application_arn = module.runtime_config_appconfig.application_arn

  additional_iam_policy_statements = [
    {
      Effect = "Allow"
      Action = ["rds-db:connect"]
      Resource = [
        "arn:aws:rds-db:${data.aws_region.current.region}:${data.aws_caller_identity.current.account_id}:dbuser:${module.my_database.connect_resource_id}/${module.my_database.database_runtime_user}"
      ]
    }
  ]
}

resource "aws_vpc_security_group_ingress_rule" "api_to_database" {
  description                  = "Allow the API Lambda functions to connect to the database"
  security_group_id            = module.my_database.security_group_id
  referenced_security_group_id = module.api.security_group_id
  from_port                    = module.my_database.cluster_port
  to_port                      = module.my_database.cluster_port
  ip_protocol                  = "tcp"
}

resource "aws_vpc_security_group_egress_rule" "api_to_database" {
  description                  = "Allow outbound traffic from the API Lambda functions to the database"
  security_group_id            = module.api.security_group_id
  referenced_security_group_id = module.my_database.security_group_id
  from_port                    = module.my_database.cluster_port
  to_port                      = module.my_database.cluster_port
  ip_protocol                  = "tcp"
}

API Lambda関数は、プライベート分離サブネットではなく、エグレス付きプライベートサブネットにデプロイしてください。appconfig_application_id/appconfig_application_arnは、データベースモジュールからではなく、ルートモジュールで一度宣言された共有ランタイム設定 AppConfigアプリケーションから取得されます。これらを渡すことで、Lambda関数にRUNTIME_CONFIG_APP_IDが設定され、アプリケーションへの読み取りアクセスが付与されます。データベースモジュールのランタイム設定エントリがデプロイされるように、インスタンス化時にdatabase名前空間を含めてください：

packages/infra/src/main.tf

module "runtime_config_appconfig" {
  source = "../../common/terraform/src/core/runtime-config/appconfig"

  application_name = "my-app-runtime-config"
  namespaces       = ["connection", "agentcore", "database"]
}

RDS Proxy を使用せずに接続する場合の SSL 要件

Node.js 20以降のLambdaランタイムからAuroraクラスターに直接接続する場合は、NODE_EXTRA_CA_CERTSを設定してAmazon RDS CAバンドルを読み込んでください：

CDK

packages/infra/src/stacks/application-stack.ts

const api = new Api(this, 'Api', {
  integrations: Api.defaultIntegrations(this)
    .withDefaultOptions({
      environment: {
        NODE_EXTRA_CA_CERTS: '/var/runtime/ca-cert.pem',
      },
    })
    .build(),
});

Terraform

packages/infra/src/main.tf

module "api" {
  source = "..."
  ...

  environment_variables = {
    NODE_EXTRA_CA_CERTS = "/var/runtime/ca-cert.pem"
  }
}

詳細については、AWS LambdaのAmazon RDS接続のSSL/TLS要件およびAmazon RDS ProxyのTLSドキュメントを参照してください。RDS Proxyを使用する場合、Lambda関数でRDS CAバンドルを設定する必要はありません。

ローカル開発

ジェネレーターは、tRPC API の dev ターゲットがデータベースの dev ターゲットに依存するように設定するため、以下を実行すると：

pnpm

pnpm nx dev <api-project-name>

yarn

yarn nx dev <api-project-name>

npm

npx nx dev <api-project-name>

bun

bunx nx dev <api-project-name>

API と一緒にローカルデータベースが自動的に起動します。