AWSの Mobile SDK for Xamarin が、AWS SDK for .NETに含まれるようになりました。このガイドでは、Mobile SDK for Xamarin のアーカイブバージョンについて説明します。
Amazon DynamoDB
Amazon DynamoDB とは
Amazon DynamoDB
主なコンセプト
DynamoDB データモデルのコンセプトには、テーブル、項目、属性が含まれます。
テーブル
Amazon DynamoDB では、データベースはテーブルの集合体です。テーブルは項目の集合であり、各項目は属性の集合です。
リレーショナルデータベースのテーブルには、テーブル名、プライマリキー、列名とデータ型のリストなど、事前定義されたスキーマがあります。テーブルに保存されているすべてのレコードは、同じ一連の列で構成されている必要があります。それに対し、DynamoDB では、テーブルに 1 つのプライマリキーが設定されていることのみが必要であり、すべての属性名とデータ型を事前に定義する必要はありません。
テーブルの操作方法の詳細については、「DynamoDB のテーブルの操作」を参照してください。
項目と属性
DynamoDB テーブル内の個々の項目には多数の属性があります。ただし、項目サイズに対する 400KB の制限があります。項目のサイズは、属性名と値の長さの合計です(バイナリおよび UTF-8 の長さ)。
項目の各属性は、名前と値のペアです。属性には単一値または多値のセットを指定できます。たとえば書籍項目には、題名と著者の属性を指定できます。それぞれの書籍の題名は 1 つですが、多数の著者を指定できます。多値属性は 1 つのセットであり、値の重複は許可されていません。
たとえば、製品カタログを DynamoDB に保存するとします。ID 属性をプライマリキーとして ProductCatalog テーブルを作成します。プライマリキーは各項目を一意に識別するため、テーブル内の 2 つの製品が同じ ID を持つことはできません。
項目の操作に関する詳細については、「DynamoDB の項目の操作」を参照してください。
データ型
Amazon DynamoDB では、次のデータ型をサポートしています。
-
スカラー型 – 数値、文字列、バイナリ、ブール、Null。
-
多値型 – 文字列セット、数値セット、バイナリセット。
-
ドキュメント型 – リスト、マップ。
データ型 (スカラー型、多値型、ドキュメント型) の詳細については、「DynamoDB データ型」を参照してください。
プライマリキー
テーブルを作成する場合には、テーブル名に加えて、テーブルのプライマリキーを指定する必要があります。プライマリキーはテーブルの各項目を一意に識別するため、テーブル内の 2 つの項目が同じキーを持つことはありません。DynamoDB では、次の 2 つのタイプのプライマリキーがサポートされています。
-
ハッシュキー: プライマリキーは、ハッシュ属性という 1 つの属性で構成されています。DynamoDB では、このプライマリキー属性について、順序を指定しないハッシュインデックスを構築します。テーブルの各項目は、ハッシュキー値によって一意に識別されます。
-
ハッシュキーおよびレンジキー: プライマリキーは、2 つの属性で構成されています。最初の属性はハッシュ属性で、2 番目の属性が範囲属性です。DynamoDB では、ハッシュプライマリキー属性に基づいて、順序を指定しないハッシュインデックスを構築し、レンジプライマリキー属性に基づいて、ソートされたレンジインデックスを構築します。テーブルの各項目は、ハッシュキーと範囲キーの値の組み合わせによって識別されます。2 つの項目でハッシュキー値を同じにすることは可能ですが、これらの 2 つの項目の範囲キー値は異なっている必要があります。
セカンダリインデックス
ハッシュキーおよびレンジキーを使用してテーブルを作成するときに、必要に応じてそのテーブルで 1 つ以上のセカンダリインデックスを定義できます。セカンダリインデックスでは、プライマリキーに対するクエリに加えて、代替キーを使用して、テーブル内のデータのクエリを行うことができます。
DynamoDB では、2 種類のセカンダリインデックス (ローカルセカンダリインデックスおよびグローバルセカンダリインデックス) をサポートしています。
-
ローカルセカンダリインデックス: テーブルと同じハッシュキーと、異なるレンジキーを持つインデックス。
-
グローバルセカンダリインデックス: テーブルと異なるハッシュキーとレンジキーを持つインデックス。
テーブルあたり最大 5 個のグローバルセカンダリインデックスと 5 個のローカルセカンダリインデックスを定義できます。詳細については、DynamoDB 開発者ガイドの「DynamoDB でのセカンダリインデックスを使用したデータアクセス性の向上」を参照してください。
クエリおよびスキャン
Amazon DynamoDB では、プライマリキーを使用した項目へのアクセスに加えて、データの検索用に Query と Scan という 2 つの API も用意されています。いくつかのベストプラクティスを理解するために、DynamoDB 開発者ガイドの「クエリおよびスキャンのガイドライン」をお読みになることをお勧めします。
Query
Query オペレーションでは、プライマリキーの属性値を使用してテーブルまたはセカンダリインデックスの項目を検索します。ハッシュキーの属性名と検索対象の個別の値を指定する必要があります。必要に応じて、レンジキーの属性名と値を指定し、比較演算子を使用して、検索結果をさらに絞り込むことができます。
サンプルクエリについては、以下を参照してください。
Query の詳細については、DynamoDB 開発者ガイドの「Query」を参照してください。
Scan
Scan オペレーションでは、テーブルまたはセカンダリインデックスのすべての項目を読み込みます。デフォルトでは、Scan オペレーションはテーブルまたはインデックスのすべての項目のデータ属性を返します。ProjectionExpression パラメータを使用し、Scan がすべての属性ではなく一部のみを返すようにできます。
サンプルの Scan については、以下を参照してください。
Scan の詳細については、DynamoDB 開発者ガイドの「Scan」を参照してください。
プロジェクトのセットアップ
前提条件
アプリケーションで DynamoDB を使用するには、プロジェクトに SDK を追加する必要があります。「AWS Mobile SDK for .NET and Xamarin をセットアップする」の手順に従って、追加します。
DynamoDB テーブルの作成
テーブルを作成するには、DynamoDB コンソール
-
[テーブルの作成] をクリックします。
-
テーブルの名前を入力します。
-
プライマリキーのタイプとして、[ハッシュ] を選択します。
-
タイプを選択し、ハッシュ属性名の値を入力します。[次へ] をクリックします。
-
[Add Indexes (インデックスの追加)] ページで、グローバルセカンダリインデックスを使用する予定の場合は、[Index Type (インデックスタイプ)] に「グローバルセカンダリインデックス」を設定し、[Index Hash Key (インデックスハッシュキー)] で、セカンダリインデックスの値を入力します。これにより、プライマリインデックスとセカンダリインデックスの両方を使用して、クエリとスキャンを行うことができます。[Add Index To Table (テーブルにインデックスを追加)] をクリックし、続いて [続行] をクリックします。グローバルセカンダリインデックスを使用してスキップするには、[続行] をクリックします。
-
読み込みおよび書き込みキャパシティーを目的のレベルに設定します。キャパシティー設定の詳細については、「Provisioned Throughput in Amazon DynamoDB」を参照してください。[次へ] をクリックします。
-
次の画面で、通知 E メールを入力し、必要に応じてスループットアラームを作成します。[次へ] をクリックします。
-
[概要] ページで、[作成] をクリックします。DynamoDB にデータベースが作成されます。
DynamoDB のアクセス許可を設定する
DynamoDB をアプリケーションで使用するには、適切なアクセス許可を設定する必要があります。次の IAM ポリシーでは、ユーザーは特定の DynamoDB テーブルの項目を削除、取得、挿入、クエリ、スキャン、更新することができます。このポリシーは、ARN によって識別されます。
{ "Statement": [ { "Effect": "Allow", "Action": [ "dynamodb:DeleteItem", "dynamodb:GetItem", "dynamodb:PutItem", "dynamodb:Query", "dynamodb:Scan", "dynamodb:UpdateItem" ], "Resource": "arn:aws:dynamodb:us-west-2:123456789012:table/MyTable" } ] }
ポリシーは、IAM コンソール
IAM ポリシーの詳細については、「IAM の使用」を参照してください。
DynamoDB 固有のポリシーの詳細については、DynamoDB 開発者ガイドの「IAM を使用して DynamoDB リソースへのアクセスをコントロールする」を参照してください。
DynamoDB とアプリケーションの統合
AWS Mobile SDK for .NET and Xamarin には、DynamoDB を操作するための高レベルのライブラリが用意されています。低レベルの DynamoDB API に対してリクエストすることもできますが、ほとんどのユースケースにおいて、ハイレベルのライブラリが推奨されています。特に、AmazonDynamoDBClient は高レベルライブラリの便利な部分です。このクラスを使用することで、さまざまな (CRUD) 操作の作成、読み取り、更新、削除、およびクエリの実行を行うことができます。
AWS Mobile SDK for .NET and Xamarin では、DynamoDB を操作するために、AWS SDK for .NET から API を使用して呼び出すことができます。API はすべて、AWSSDK.dll で利用できます。AWS SDK for .NET のダウンロードの詳細については、「AWS SDK for .NET
Xamarin アプリケーションで DynamoDB を操作する方法は、3 種類あります。
-
ドキュメントモデル: この API には、お客様のプログラミングタスクを簡素化する低レベル DyanmoDB API のラッパークラスが用意されています。テーブルとドキュメントが主要なラッパークラスです。ドキュメントモデルは、項目の作成、取得、更新、削除などのデータオペレーションに使用できます。この API は、Amazon.DynamoDB.DocumentModel 名前空間で利用できます。
-
オブジェクト永続性モデル: オブジェクト永続性 API では、クライアント側のクラスを DynamoDB テーブルにマッピングすることができます。各オブジェクトインスタンスが、対応するテーブルの項目にマッピングされます。この API 内にある DynamoDBContext クラスによって、クライアント側オブジェクトをテーブルに保存し、項目をオブジェクトとして取得し、クエリおよびスキャンを実行するメソッドが提供されます。オブジェクト永続性モデルは、項目の作成、取得、更新、削除などのデータオペレーションに使用できます。まず、サービスクライアント API を使用してテーブルを作成する必要があります。次に、オブジェクト永続性モデルを使用して、クラスをテーブルにマッピングします。この API は、Amazon.DynamoDB.DataModel 名前空間で利用できます。
-
サービスクライアント API: これは、プロトコルレベルの API であり、DynamoDB API に緊密にマッピングされます。この低レベル API は、テーブルおよび項目のすべてのオペレーション (テーブルおよび項目の作成、更新、削除など) に使用できます。テーブルに対するクエリおよびスキャンも可能です。この API は、Amazon.DynamoDB 名前空間で利用できます。
これらの 3 つのモデルは、次のトピックで詳しく説明します。