API オペレーションの構築 - Amazon DynamoDB
テーブルを削除するGSI を削除テーブルの作成GSI の作成テーブルを更新するGSI の更新項目を配置する項目を更新する項目を削除する項目の複製QueryScanTransactGetItemsTransactWriteItems

API オペレーションの構築

NoSQL Workbench を使用して DynamoDB CRUD API を構築するには、NoSQL Workbench ユーザーインターフェイスの左側で [オペレーションビルダー] を選択します。

次に [開く] を選択して、接続を選択します。

オペレーションビルダーでは、以下の操作を実行できます。

テーブルを削除する

Delete Table オペレーションを実行するには、次の操作を行います。

  1. [テーブル] セクションで、削除するテーブルを見つけます。

  2. 横方向の省略記号メニューで、[テーブルを削除] を選択します。

  3. [テーブル名] を入力して、テーブルを削除することを確認します。

  4. [削除] を選択します。

このオペレーションの詳細については、「Amazon DynamoDB API リファレンス」の「Delete table」(テーブルを削除する) を参照してください。

GSI を削除

Delete GSI オペレーションを実行するには、次の操作を行います。

  1. [テーブル] セクションで、削除するテーブルの GSI を見つけます。

  2. 横方向の省略記号メニューで、[GSI を削除] を選択します。

  3. [GSI 名] を入力して、GSI を削除することを確認します。

  4. [削除] を選択します。

このオペレーションの詳細については、「Amazon DynamoDB API リファレンス」の「Delete table」(テーブルを削除する) を参照してください。

テーブルの作成

Create Table オペレーションを実行するには、次の操作を行います。

  1. [テーブル] セクションの横にある [+] アイコンを選択します。

  2. 目的のテーブル名を入力します。

  3. パーティションキーを作成します。

  4. オプション: ソートキーを作成します。

  5. キャパシティー設定をカスタマイズするには、[デフォルトのキャパシティー設定を使用] チェックボックスをオフにします。

    • これで、プロビジョンドキャパシティまたはオンデマンドキャパシティを選択できます。

      [プロビジョンド] を選択すると、最小と最大の読み込みおよび書き込みキャパシティーユニットを設定できます。自動スケーリングを有効または無効にすることもできます。

    • テーブルの現在の設定が [オンデマンド] になっている場合は、プロビジョンドスループットを指定できません。

    • [オンデマンド] から [プロビジョンドスループット] に切り替えると、すべての GSI に自動スケーリング (最小: 1、最大: 10、ターゲット: 70%) が自動的に適用されます。

  6. このテーブルを GSI なしで作成するには、[GSI をスキップして作成] を選択します。オプションで、[次へ] を選択して、この新しいテーブルで GSI を作成できます。

このオペレーションの詳細については、「Amazon DynamoDB API リファレンス」の「Create table」(テーブルを作成する) を参照してください。

GSI の作成

Create GSI オペレーションを実行するには、次の操作を行います。

  1. GSI を追加する先のテーブルを見つけます。

  2. 横方向の省略記号メニューで、[GSI の作成] を選択します。

  3. [インデックス名] で、GSI に名前を付けます。

  4. パーティションキーを作成します。

  5. オプション: ソートキーを作成します。

  6. ドロップダウンから [射影タイプ] オプションを選択します。

  7. [GSI の作成] を選択します。

このオペレーションの詳細については、「Amazon DynamoDB API リファレンス」の「Create table」(テーブルを作成する) を参照してください。

テーブルを更新する

Update Table オペレーションでテーブルのキャパシティー設定を更新するには、次の操作を行います。

  1. キャパシティー設定を更新するテーブルを見つけます。

  2. 横方向の省略記号メニューで、[キャパシティー設定を更新] を選択します。

  3. [プロビジョンド] または [オンデマンドキャパシティー] を選択します。

    [プロビジョンド] を選択すると、最小と最大の読み込みおよび書き込みキャパシティーユニットを設定できます。自動スケーリングを有効または無効にすることもできます。

  4. [Update] (更新) を選択します。

このオペレーションの詳細については、「Amazon DynamoDB API リファレンス」の「Update table」(テーブルの更新) を参照してください。

GSI の更新

Update Table オペレーションで GSI のキャパシティー設定を更新するには、次の操作を行います。

注記

デフォルトでは、グローバルセカンダリインデックスは基本テーブルのキャパシティー設定を継承します。基本テーブルがプロビジョンドキャパシティーモードである場合にのみ、グローバルセカンダリインデックスを別のキャパシティーモードに設定できます。プロビジョニングモードのテーブルでグローバルセカンダリインデックスを作成するときには、そのインデックスに対して予想されるワークロードに応じた読み込み/書き込みキャパシティーユニットを指定する必要があります。詳細については、「グローバルセカンダリインデックスに対するプロビジョニングされたスループットに関する考慮事項」を参照してください。

  1. キャパシティー設定を更新する GSI を見つけます。

  2. 横方向の省略記号メニューで、[キャパシティー設定を更新] を選択します。

  3. これで、プロビジョンドキャパシティまたはオンデマンドキャパシティを選択できます。

    [プロビジョンド] を選択すると、最小と最大の読み込みおよび書き込みキャパシティーユニットを設定できます。自動スケーリングを有効または無効にすることもできます。

  4. [Update] (更新) を選択します。

このオペレーションの詳細については、「Amazon DynamoDB API リファレンス」の「Update table」(テーブルの更新) を参照してください。

項目を配置する

Put Item オペレーションを使用して項目を作成します。Put Item オペレーションのコードを実行または生成するには、次の操作を行います。

  1. 項目を作成するテーブルを見つけます。

  2. [アクション] ドロップダウンで、[項目の作成] を選択します。

  3. パーティションキー値を入力します。

  4. ソートキーの値を入力します (存在する場合)。

  5. キーではない属性を指定する場合は、次の操作を行います。

    1. [+ その他の属性を追加] を選択します。

    2. [属性の名前]、[タイプ]、[値] を指定します。

  6. Put Item オペレーションを成功させるために条件式を満たす必要がある場合は、次の手順を実行します。

    1. [Condition (条件)] を選択します。

    2. 属性名、比較演算子、属性タイプ、および属性値を指定します。

    3. 他の条件が必要な場合は、[Condition (条件)] を再度選択します。

    詳細については、「条件式」を参照してください。

  7. コードを生成する場合は、[コードの生成] を選択します。

    表示されたタブから目的の言語を選択します。これで、このコードをコピーしてアプリケーションで使用できるようになります。

  8. オペレーションをすぐに実行する場合は、[実行] をクリックします。

  9. このオペレーションを後で使用するために保存する場合は、[Save operation] (オペレーションの保存) を選択し、オペレーションの名前を入力して、[Save] (保存) を選択します。

このオペレーションの詳細については、Amazon DynamoDB API リファレンスの 「PutItem」を参照してください。

項目を更新する

Update Item オペレーションのコードを実行または生成するには、次の操作を行います。

  1. 項目を更新するテーブルを見つけます。

  2. 項目を選択します。

  3. 選択した式の属性名と属性値を入力します。

  4. さらに式を追加する場合は、[式を更新] ドロップダウンリストで別の式を選択し、[+] アイコンを選択します。

  5. Update Item オペレーションを成功させるために条件式を満たす必要がある場合は、次の手順を実行します。

    1. [Condition (条件)] を選択します。

    2. 属性名、比較演算子、属性タイプ、および属性値を指定します。

    3. 他の条件が必要な場合は、[Condition (条件)] を再度選択します。

    詳細については、「条件式」を参照してください。

  6. コードを生成する場合は、[Generate code (コードの生成)] を選択します。

    使用する言語のタブを選択します。これで、このコードをコピーしてアプリケーションで使用できるようになります。

  7. オペレーションをすぐに実行する場合は、[実行] をクリックします。

  8. このオペレーションを後で使用するために保存する場合は、[Save operation] (オペレーションの保存) を選択し、オペレーションの名前を入力して、[Save] (保存) を選択します。

このオペレーションの詳細については、Amazon DynamoDB API リファレンスの 「UpdateItem」を参照してください。

項目を削除する

Delete Item オペレーションを実行するには、次の操作を行います。

  1. 項目を削除するテーブルを見つけます。

  2. 項目を選択します。

  3. [アクション] ドロップダウンで、[項目の削除] を選択します。

  4. [削除] を選択して、項目を削除することを確認します。

このオペレーションの詳細については、Amazon DynamoDB API リファレンスの 「DeleteItem」を参照してください。

項目の複製

同じ属性を持つ新しい項目を作成することで、項目を複製できます。項目を複製するには、次の操作を行います。

  1. 項目を複製するテーブルを見つけます。

  2. 項目を選択します。

  3. [アクション] ドロップダウンで、[項目の複製] を選択します。

  4. 新しいパーティションキーを指定します。

  5. 新しいソートキーを指定します (必要な場合)。

  6. [実行] を選択します。

このオペレーションの詳細については、Amazon DynamoDB API リファレンスの 「DeleteItem」を参照してください。

Query

Query オペレーションのコードを実行または生成するには、次の操作を行います。

  1. NoSQL Workbench UI の上部で、[クエリ] を選択します。

  2. パーティションキーの値を指定します。

  3. Query オペレーションにソートキーが必要な場合は、以下の操作を実行します。

    1. [ソートキー] を選択します。

    2. 比較演算子と属性値を指定します。

  4. [クエリ] を選択して、このクエリオペレーションを実行します。さらにオプションが必要な場合は、[その他のオプション] チェックボックスをオンにして、次の手順に進みます。

  5. オペレーション結果とともにすべての属性を返す必要がない場合は、[Projection expression (プロジェクション式)] を選択します。

  6. [+] アイコンを選択します。

  7. クエリ結果とともに返される属性を入力します。

  8. さらに属性が必要な場合は、[+] を選択します。

  9. Query オペレーションを成功させるために条件式を満たす必要がある場合は、次の手順を実行します。

    1. [Condition (条件)] を選択します。

    2. 属性名、比較演算子、属性タイプ、および属性値を指定します。

    3. 他の条件が必要な場合は、[Condition (条件)] を再度選択します。

    詳細については、「条件式」を参照してください。

  10. コードを生成する場合は、[Generate code (コードの生成)] を選択します。

    使用する言語のタブを選択します。これで、このコードをコピーしてアプリケーションで使用できるようになります。

  11. オペレーションをすぐに実行する場合は、[実行] をクリックします。

  12. このオペレーションを後で使用するために保存する場合は、[Save operation] (オペレーションの保存) を選択し、オペレーションの名前を入力して、[Save] (保存) を選択します。

このオペレーションの詳細については、Amazon DynamoDB API リファレンスの「Query」を参照してください。

Scan

Scan オペレーションのコードを実行または生成するには、次の操作を行います。

  1. NoSQL Workbench UI の上部で、[スキャン] を選択します。

  2. [スキャン] ボタンを選択して、この基本的なスキャンオペレーションを実行します。さらにオプションが必要な場合は、[その他のオプション] チェックボックスをオンにして、次の手順に進みます。

  3. 属性名を指定して、スキャン結果をフィルタリングします。

  4. オペレーション結果とともにすべての属性を返す必要がない場合は、[Projection expression (プロジェクション式)] を選択します。

  5. スキャンオペレーションを成功させるために条件式を満たす必要がある場合は、次の手順を実行します。

    1. [Condition (条件)] を選択します。

    2. 属性名、比較演算子、属性タイプ、および属性値を指定します。

    3. 他の条件が必要な場合は、[Condition (条件)] を再度選択します。

    詳細については、「条件式」を参照してください。

  6. コードを生成する場合は、[Generate code (コードの生成)] を選択します。

    使用する言語のタブを選択します。これで、このコードをコピーしてアプリケーションで使用できるようになります。

  7. オペレーションをすぐに実行する場合は、[実行] をクリックします。

  8. このオペレーションを後で使用するために保存する場合は、[Save operation] (オペレーションの保存) を選択し、オペレーションの名前を入力して、[Save] (保存) を選択します。

TransactGetItems

TransactGetItems オペレーションのコードを実行または生成するには、次の操作を行います。

  1. NoSQL Workbench UI の上部にある [その他のオペレーション] ドロップダウンで、[TransactGetItems] を選択します。

  2. [TransactGetItem] の近くにある [+] アイコンを選択します。

  3. パーティションキーを指定します。

  4. ソートキーを指定します (必要な場合)。

  5. [実行] を選択してオペレーションを実行するか、[オペレーションを保存] を選択して保存するか、[コードを生成] を選択してオペレーションのコードを生成します。

トランザクションの詳細については、「Amazon DynamoDB Transactions」を参照してください。

TransactWriteItems

TransactWriteItems オペレーションのコードを実行または生成するには、次の操作を行います。

  1. NoSQL Workbench UI の上部にある [その他のオペレーション] ドロップダウンで、[TransactWriteItems] を選択します。

  2. [アクション] ドロップダウンで、オペレーションを選択します。

  3. [TransactWriteItem] の近くにある [+] アイコンを選択します。

  4. [アクション] ドロップダウンで、実行するオペレーションを選択します。

    アクションの順序を変更するには、左側のリストでアクションを選択し、上矢印または下矢印を選択してリスト内で上下に移動します。

    アクションを削除するには、リストでアクションを選択してから、[削除] (ごみ箱) アイコンを選択します。

  5. [実行] を選択してオペレーションを実行するか、[オペレーションを保存] を選択して保存するか、[コードを生成] を選択してオペレーションのコードを生成します。

トランザクションの詳細については、「Amazon DynamoDB Transactions」を参照してください。