API オペレーションの構築

NoSQL Workbench を使用して DynamoDB CRUD API を構築するには、NoSQL Workbench の右上にある [Interface-based operations] (インターフェイスベースのオペレーション) を選択します。

次に [Operations] (オペレーション) ドロップダウンに移動し、構築するオペレーションを選択します。

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

Table operations

• Delete Table

• Create Table

• Update Table

Item operations

• Get Item

• Put Item

• Update Item

• Delete Item

• Query

• Scan

• Transact Get Items

• Transact Write Items

テーブルの操作

テーブルを削除する

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

1. [Operations] (オペレーション) ドロップダウンリストから [Delete Table] (テーブルの削除) を選択します。

2. [Table name] (テーブル名) ドロップダウンリストからテーブルを選択します。

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

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

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

   表示される確認ウィンドウで、テーブル名を入力して [Delete] (削除) を選択し、確定します。

   

   操作の結果は、画面の下部にある [Results] (結果) タブに表示されます。

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

Create table

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

1. [Operations] (オペレーション) ドロップダウンリストから [Create Table] (テーブルの作成) を選択します。

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

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

4. 必要に応じて、テーブルを設定します。グローバルセカンダリインデックスの作成、自動スケーリングの有効化などのオプションを使用できます。

5. キャパシティ設定をカスタマイズするには、[Capacity Settings] (キャパシティ設定) に移動し、[Default settings] (デフォルト設定) チェックボックスをオフにします。

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

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

   • テーブルが現在オンデマンドに設定されている場合は、プロビジョニングされたスループットを指定できません。

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

6. 作成した新しい設定をすべてクリアして最初からやり直す場合は、[Clear Form] (フォームのクリア) を選択します。

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

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

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

   オペレーションの結果は、画面の下部にある [Results] (結果) タブに表示されます。

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

   

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

テーブルを更新する

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

1. [Operations] (オペレーション) ドロップダウンリストから [Update Table] (テーブルの更新) を選択します。

2. [Update operations] (更新オペレーション) ドロップダウンリストから、目的のオペレーションを選択します。

3. [Table name] (テーブル名) ドロップダウンリストからテーブルを選択します。

4. 選択したテーブルを必要に応じて更新します。GSI の作成、プロビジョニングされたスループットの更新などのオプションを使用できます。

5. GSI の作成、プロビジョニングされたスループットの更新、または GSI のプロビジョニングされたスループットの更新を選択すると、キャパシティ設定オプションが表示されます。

6. キャパシティ設定をカスタマイズするには、[Capacity Settings] (キャパシティ設定) に移動します。次に、[Inherit capacity settings from base table] (基本テーブルからキャパシティ設定を継承する) または [On-demand] (オンデマンド) のいずれかのチェックボックスをオフにします。

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

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

   • テーブルが現在オンデマンドに設定されている場合は、プロビジョニングされたスループットを指定できません。

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

7. 先ほど入力した設定をクリアしてやり直す場合は、[Clear Form] (フォームのクリア) を選択します。

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

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

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

   オペレーションの結果は、画面の下部にある [Results] (結果) タブに表示されます。

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

    

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

項目の操作

項目を取得する

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

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

2. 射影式を追加する場合は、次を行います。

   1. [Projection expression] (プロジェクション式) を選択します。

   2. [Projection expression] (プロジェクション式) の横にある + (プラス記号) を選択します。

   3. [Attribute name] (属性名) を指定します。

   

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

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

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

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

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

項目を配置する

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

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

2. ソートキーの値を指定します (存在する場合)。

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

   1. [Other attributes] (その他の属性) の横にある + (プラス記号) を選択します。

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

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

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

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

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

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

   

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

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

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

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

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

項目を更新する

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

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

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

3. [Update expression (式の更新)] で、リストにある式を選択します。

4. 式の [+] (プラス記号) を選択します。

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

6. さらに式を追加する場合は、[Update Expression (式の更新)] ドロップダウンリストで別の式を選んで、[+] を選択します。

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

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

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

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

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

   

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

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

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

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

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

項目を削除する

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

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

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

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

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

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

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

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

   

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

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

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

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

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

Query

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

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

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

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

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

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

4. [+] (プラス記号) を選択します。

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

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

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

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

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

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

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

   

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

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

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

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

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

Scan

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

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

2. [+] (プラス記号) を選択します。

3. クエリ結果とともに返される属性を指定します。

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

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

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

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

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

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

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

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

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

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

TransactGetItems

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

1. [+] (プラス記号) を選択します。

2. 項目を取得する オペレーションの手順に従います。

   オペレーションの詳細の指定後に、さらにオペレーションを追加する場合は + (プラス記号) を選択します。

   

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

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

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

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

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

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

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

TransactWriteItems

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

1. [アクション] ドロップダウンリストで、必要なオペレーションを選択します。

   • DeleteItem の場合、項目を削除する オペレーションの手順に従います。

   • PutItem の場合、項目を配置する オペレーションの手順に従います。

   • UpdateItem の場合、項目を更新する オペレーションの手順に従います。

   オペレーションの詳細を指定したら、[+] ボタンを選択します。

   

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

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

   

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

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

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

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

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