メニュー
Amazon DynamoDB
開発者ガイド (API バージョン 2012-08-10)

DynamoDB API

Amazon DynamoDB を使用するには、アプリケーションでいくつかの簡単な API オペレーションを使用する必要があります。以下に、カテゴリー別にこれらのオペレーションの概要を示します。

コントロールプレーン

コントロールプレーンの操作では、DynamoDB テーブルを作成、管理できます。また、インデックス、ストリーム、およびテーブルに依存する他のオブジェクトを操作できます。

  • CreateTable – 新しいテーブルを作成します。オプションで、1 つ以上のセカンダリインデックスを作成し、テーブルに対して DynamoDB ストリーム を有効にできます。

  • DescribeTable – プライマリキーのスキーマ、スループット設定、インデックス情報など、テーブルに関する情報を返します。

  • ListTables – リストのすべてのテーブルの名前を返します。

  • UpdateTable – テーブルまたはそのインデックスの設定を変更、テーブルの新しいインデックスを作成または削除、またはテーブルの DynamoDB ストリーム 設定を変更します。

  • DeleteTable – テーブルとそのすべての依存オブジェクトを DynamoDB から削除します。

データプレーン

データプレーンオペレーションでは、テーブルのデータで、作成、読み込み、更新、および削除 (CRUD とも呼ばれます) アクションを実行できます。一部のデータプレーンオペレーションでも、セカンダリインデックス からデータを読み込むことができます。

データの作成

  • PutItem – テーブルに単一の項目を書き込みます。プライマリキー属性を指定する必要がありますが、その他の属性を指定する必要はありません。

  • BatchWriteItem – 25 個の項目をテーブルに書き込みます。これは、PutItem を複数回呼び出すよりも効率的です。アプリケーションで項目を書き込むために、1 回のネットワークラウンドトリップのみで済むためです。また、BatchWriteItem を使用して、1 つ以上のテーブルから複数の項目を削除することもできます。

データの読み取り

  • GetItem – テーブルから単一の項目を取り出します。目的の項目のプライマリキーを指定する必要があります。項目全体またはその属性のサブセットのみを取り出すことができます。

  • BatchGetItem – 1 つ以上のテーブルから 100 個の項目を取り出します。これは、GetItem を複数回呼び出すよりも効率的です。アプリケーションで項目を読み込むために、1 回のネットワークラウンドトリップのみで済むためです。

  • Query – 特定のパーティションキーがあるすべての項目を取り出します。パーティションキーの値を指定する必要があります。項目全体またはその属性のサブセットのみを取り出すことができます。オプションで、ソートキーの値に条件を適用し、同じパーティションキーがあるデータのサブセットだけを取り出すことができます。テーブルにパーティションキーとソートキーの両方を持つテーブルがある場合、テーブルでこのオペレーションを使用できます。また、インデックスにパーティションキーとソートキーの両方がある場合、インデックスでこのオペレーションを使用できます。

  • Scan – 指定されたテーブルまたはインデックスのすべての項目を取り出します。項目全体またはその属性のサブセットのみを取り出すことができます。オプションでフィルタリング条件を適用すると、関心のある値のみを返し、残りは破棄できます。

データの更新

  • UpdateItem – 項目の 1 つ以上の属性を変更します。変更する項目のプライマリキーを指定する必要があります。新しい属性を追加したり、既存の属性を変更または削除したりできます。ユーザー定義の条件を満たす場合にのみ更新が成功するように、条件付きの更新を実行できます。オプションで、アトミックカウンタを実装できます。このカウンタは、他の書き込みリクエストを妨害することなく、数値属性をインクリメントまたはデクリメントします。

データの削除

  • DeleteItem – テーブルから単一の項目を削除します。削除する項目のプライマリキーを指定する必要があります。

  • BatchWriteItem – 1 つ以上のテーブルから最大 25 個の項目を削除します。これは、DeleteItem を複数回呼び出すよりも効率的です。アプリケーションで項目を削除するために、1 回のネットワークラウンドトリップのみで済むためです。また、BatchWriteItem を使用して、1 つ以上のテーブルに複数の項目を追加することもできます。

DynamoDB ストリーム

DynamoDB ストリーム オペレーションでは、テーブルのストリームを有効または無効にし、ストリームに含まれるデータ変更レコードにアクセスすることができます。

  • ListStreams – すべてのストリームのリスト、または特定のテーブルのストリームのみを返します。

  • DescribeStream – Amazon リソースネーム (ARN)、アプリケーションが最初のいくつかのストリームレコードの読み込みを開始できる場所など、ストリームに関する情報を返します。

  • GetShardIteratorシャードイテレーターを返します。これは、ストリームからレコードを取得するためにアプリケーションが使用するデータ構造です。

  • GetRecords – 特定のシャードイテレーターを使用して 1 つ以上のストリームレコードを取得します。