RDS イントロスペクションを使用した GraphQL API の構築

AWS AppSync のイントロスペクションユーティリティは、データベーステーブルからモデルを検出し、GraphQL の型を提案できます。AWS AppSync コンソールの API 作成ウィザードを使用すると、Aurora MySQL または PostgreSQL データベースから API を即座に生成できます。データを読み書きするための型と JavaScript リゾルバーを自動的に作成されます。

AWS AppSync は、Amazon RDS Data API を通じて Amazon Aurora データベースとの直接統合を実現します。Amazon RDS Data API は、永続的なデータベース接続を必要とせず、SQL ステートメントを実行するために AWS AppSync が接続する安全な HTTP エンドポイントを提供します。これを使用して、Aurora で MySQL および PostgreSQL ワークロードのリレーショナルデータベース API を作成できます。

AWS AppSync を使用してリレーショナルデータベースの API を構築すると、以下のような利点があります。

AWS AppSync は、既存のリレーショナルデータベースから API を簡単に構築できます。そのイントロスペクションユーティリティは、データベーステーブルからモデルを検出し、GraphQL の型を提案できます。AWS AppSync コンソールの API 作成ウィザードを使用すると、Aurora MySQL または PostgreSQL データベースから API を即座に生成できます。データを読み書きするための型と JavaScript リゾルバーを自動的に作成されます。

AWS AppSync には、リゾルバーでの SQL ステートメントの記述を簡単にするための統合された JavaScript ユーティリティが用意されています。動的な値を含む静的ステートメントには AWS AppSync の sql タグテンプレートを使用でき、プログラムでステートメントを構築するには rds モジュールユーティリティを使用できます。詳細については、「RDS のリゾルバー関数リファレンス」データソースと「組み込みモジュール」をご覧ください。

イントロスペクション機能を使用する (コンソール)

詳細なチュートリアルと入門ガイドについては、「チュートリアル: Aurora PostgreSQL Serverless で Data API を使用する」を参照してください。

AWS AppSync のコンソールでは、Data API で設定した既存の Aurora データベースから AWS AppSync GraphQL API をわずか数分で作成できます。これにより、データベース設定に基づいて運用スキーマが迅速に生成されます。API をそのまま使用することも、API を基にして機能を追加することもできます。

イントロスペクション機能の使用 (API)

StartDataSourceIntrospection イントロスペクション API を使用して、データベース内のモデルをプログラムで検出できます。コマンドの詳細については、「StartDataSourceIntrospection API の使用」を参照してください。

StartDataSourceIntrospection を使用するには、Aurora クラスターの Amazon リソースネーム (ARN)、データベース名、および AWS Secrets Manager シークレット ARN を指定します。このコマンドはイントロスペクションプロセスを開始します。GetDataSourceIntrospection コマンドを使用して結果を取得できます。検出されたモデルのストレージ定義言語 (SDL) 文字列をコマンドが返すかどうかを指定できます。これは、検出されたモデルから直接 SDL スキーマ定義を生成する場合に便利です。

例えば、単純な Todos テーブルに次のようなデータ定義言語 (DDL) ステートメントがあるとします。

create table if not exists public.todos  
(  
id serial constraint todos_pk primary key,  
description text,  
due timestamp,  
"createdAt" timestamp default now()  
);

イントロスペクションは、以下のように開始します。

aws appsync start-data-source-introspection \ 
  --rds-data-api-config resourceArn=<cluster-arn>,secretArn=<secret-arn>,databaseName=database

次に、GetDataSourceIntrospection コマンドを使用して結果を取得します。

aws appsync get-data-source-introspection \
  --introspection-id a1234567-8910-abcd-efgh-identifier \
  --include-models-sdl

これは次の結果を返します。

{
    "introspectionId": "a1234567-8910-abcd-efgh-identifier",
    "introspectionStatus": "SUCCESS",
    "introspectionStatusDetail": null,
    "introspectionResult": {
        "models": [
            {
                "name": "todos",
                "fields": [
                    {
                        "name": "description",
                        "type": {
                            "kind": "Scalar",
                            "name": "String",
                            "type": null,
                            "values": null
                        },
                        "length": 0
                    },
                    {
                        "name": "due",
                        "type": {
                            "kind": "Scalar",
                            "name": "AWSDateTime",
                            "type": null,
                            "values": null
                        },
                        "length": 0
                    },
                    {
                        "name": "id",
                        "type": {
                            "kind": "NonNull",
                            "name": null,
                            "type": {
                                "kind": "Scalar",
                                "name": "Int",
                                "type": null,
                                "values": null
                            },
                            "values": null
                        },
                        "length": 0
                    },
                    {
                        "name": "createdAt",
                        "type": {
                            "kind": "Scalar",
                            "name": "AWSDateTime",
                            "type": null,
                            "values": null
                        },
                        "length": 0
                    }
                ],
                "primaryKey": {
                    "name": "PRIMARY_KEY",
                    "fields": [
                        "id"
                    ]
                },
                "indexes": [],
                "sdl": "type todos\n{\ndescription: String\n\ndue: AWSDateTime\n\nid: Int!\n\ncreatedAt: AW
SDateTime\n}\n"
            }
        ],
        "nextToken": null
    }
}