DynamoDB 用の PartiQL の開始方法

このセクションでは、Amazon DynamoDB コンソール、AWS Command Line Interface (AWS CLI)、および DynamoDB API から DynamoDB 用の PartiQL を使用する方法について説明します。

次の例では、「DynamoDB の開始方法」チュートリアルで、DynamoDB テーブルを定義していることが前提です。

DynamoDB コンソール、AWS Command Line Interface、または DynamoDB API を使用して DynamoDB にアクセスする方法については、「DynamoDB へのアクセス」を参照してください。

NoSQL Workbench をダウンロードして、DynamoDB 用の PartiQL ステートメントを構築するには、DynamoDB Operation Builder 用の NoSQL Workbench の右上にある [PartiQL operations] (PartiQL オペレーション) を選択します。

Console

注記

DynamoDB 用 PartiQL は、新しい DynamoDB コンソールでのみ使用できます。新しい DynamoDB コンソールを使用するには、コンソール左側のナビゲーションペインで、[新しいコンソールのプレビューを試す] を選択します。

AWS Management Console にサインインして DynamoDB コンソール (https://console.aws.amazon.com/dynamodb/) を開きます。
コンソール左側のナビゲーションペインで、[PartiQL エディター] を選択します。
[Music] テーブルを選択します。
[Query table] (クエリテーブル) を選択します。このアクションで生成したクエリは、完全なテーブルスキャンを実行しません。
partitionKeyValue を文字列型の値である Acme Band に置換します。sortKeyValue を文字列型の値である Happy Day に置換します。
[Run (実行)] ボタンを選択します。
[Table view] (テーブルビュー) または [JSON view] (JSON ビュー) ボタンを選択すると、クエリの結果を確認できます。

NoSQL workbench

[PartiQL statement] (PartiQL ステートメント) を選択します。

次の PartiQL [SELECT statement] (SELECT ステートメント) を入力します。


SELECT *                                         
FROM Music  
WHERE Artist=? and SongTitle=?

Artist および SongTitle パラメータの値を指定するには
1. [Optional request parameters] (オプションのリクエストパラメータ) を選択します。
2. [Add new parameters] (パラメータの追加) を選択します。
3. 属性タイプとして [string] (文字列型) を選択し、値に Acme Band を選択します。
4. ステップ b とステップ c を繰り返し、[string] (文字列型) のタイプと PartiQL Rocks の値を選択します。
コードを生成する場合は、[Generate code (コードの生成)] を選択します。

表示されたタブから目的の言語を選択します。これで、このコードをコピーしてアプリケーションで使用できるようになります。
オペレーションをすぐに実行する場合は、[Run] (実行) をクリックします。

AWS CLI

INSERT PartiQL ステートメントを使用して、Music テーブルに項目を作成します。


aws dynamodb execute-statement --statement "INSERT INTO Music  \
					    VALUE  \
					    {'Artist':'Acme Band','SongTitle':'PartiQL Rocks'}"

SELECT PartiQL ステートメントを使用して、Music テーブルから項目を取得します。


aws dynamodb execute-statement --statement "SELECT * FROM Music   \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

UPDATE PartiQL ステートメントを使用して、Music テーブルの項目を更新します。


aws dynamodb execute-statement --statement "UPDATE Music  \
                                            SET AwardsWon=1  \
                                            SET AwardDetail={'Grammys':[2020, 2018]}  \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

Music テーブルに、項目のリスト値を追加します。


aws dynamodb execute-statement --statement "UPDATE Music  \
                                            SET AwardDetail.Grammys =list_append(AwardDetail.Grammys,[2016])  \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

Music テーブルから項目のリスト値を削除します。


aws dynamodb execute-statement --statement "UPDATE Music  \
                                            REMOVE AwardDetail.Grammys[2]  \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

Music テーブルに、項目の新しいマップメンバーを追加します。


aws dynamodb execute-statement --statement "UPDATE Music  \
                                            SET AwardDetail.BillBoard=[2020]  \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

Music テーブルに、項目の新しい文字列セットの属性を追加します。


aws dynamodb execute-statement --statement "UPDATE Music  \
                                            SET BandMembers =<<'member1', 'member2'>>  \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

Music テーブルで、項目の文字列セットの属性を更新します。


aws dynamodb execute-statement --statement "UPDATE Music  \
                                            SET BandMembers =set_add(BandMembers, <<'newmember'>>)  \
                                            WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

DELETE PartiQL ステートメントを使用して、Music テーブルから項目を削除します。


aws dynamodb execute-statement --statement "DELETE  FROM Music  \
    WHERE Artist='Acme Band' AND SongTitle='PartiQL Rocks'"

Java


import java.util.ArrayList;
import java.util.List;

import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClientBuilder;
import com.amazonaws.services.dynamodbv2.model.AttributeValue;
import com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException;
import com.amazonaws.services.dynamodbv2.model.ExecuteStatementRequest;
import com.amazonaws.services.dynamodbv2.model.ExecuteStatementResult;
import com.amazonaws.services.dynamodbv2.model.InternalServerErrorException;
import com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException;
import com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException;
import com.amazonaws.services.dynamodbv2.model.RequestLimitExceededException;
import com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException;
import com.amazonaws.services.dynamodbv2.model.TransactionConflictException;

public class DynamoDBPartiQGettingStarted {

    public static void main(String[] args) {
        // Create the DynamoDB Client with the region you want
        AmazonDynamoDB dynamoDB = createDynamoDbClient("us-west-1");

        try {
            // Create ExecuteStatementRequest
            ExecuteStatementRequest executeStatementRequest = new ExecuteStatementRequest();
            List<AttributeValue> parameters= getPartiQLParameters();

            //Create an item in the Music table using the INSERT PartiQL statement
            processResults(executeStatementRequest(dynamoDB, "INSERT INTO Music value {'Artist':?,'SongTitle':?}", parameters));

            //Retrieve an item from the Music table using the SELECT PartiQL statement.
            processResults(executeStatementRequest(dynamoDB, "SELECT * FROM Music  where Artist=? and SongTitle=?", parameters));

            //Update an item in the Music table using the UPDATE PartiQL statement.
            processResults(executeStatementRequest(dynamoDB, "UPDATE Music SET AwardsWon=1 SET AwardDetail={'Grammys':[2020, 2018]}  where Artist=? and SongTitle=?", parameters));

            //Add a list value for an item in the Music table.
            processResults(executeStatementRequest(dynamoDB, "UPDATE Music SET AwardDetail.Grammys =list_append(AwardDetail.Grammys,[2016])  where Artist=? and SongTitle=?", parameters));

            //Remove a list value for an item in the Music table.
            processResults(executeStatementRequest(dynamoDB, "UPDATE Music REMOVE AwardDetail.Grammys[2]   where Artist=? and SongTitle=?", parameters));

            //Add a new map member for an item in the Music table.
            processResults(executeStatementRequest(dynamoDB, "UPDATE Music set AwardDetail.BillBoard=[2020] where Artist=? and SongTitle=?", parameters));

            //Add a new string set attribute for an item in the Music table.
            processResults(executeStatementRequest(dynamoDB, "UPDATE Music SET BandMembers =<<'member1', 'member2'>> where Artist=? and SongTitle=?", parameters));

            //update a string set attribute for an item in the Music table.
            processResults(executeStatementRequest(dynamoDB, "UPDATE Music SET BandMembers =set_add(BandMembers, <<'newmember'>>) where Artist=? and SongTitle=?", parameters));

            //Retrieve an item from the Music table using the SELECT PartiQL statement.
            processResults(executeStatementRequest(dynamoDB, "SELECT * FROM Music  where Artist=? and SongTitle=?", parameters));

            //delete an item from the Music Table
            processResults(executeStatementRequest(dynamoDB, "DELETE  FROM Music  where Artist=? and SongTitle=?", parameters));
        } catch (Exception e) {
            handleExecuteStatementErrors(e);
        }
    }

    private static AmazonDynamoDB createDynamoDbClient(String region) {
        return AmazonDynamoDBClientBuilder.standard().withRegion(region).build();
    }

    private static List<AttributeValue> getPartiQLParameters() {
        List<AttributeValue> parameters = new ArrayList<AttributeValue>();
        parameters.add(new AttributeValue("Acme Band"));
        parameters.add(new AttributeValue("PartiQL Rocks"));
        return parameters;
    }

    private static ExecuteStatementResult executeStatementRequest(AmazonDynamoDB client, String statement, List<AttributeValue> parameters ) {
        ExecuteStatementRequest request = new ExecuteStatementRequest();
        request.setStatement(statement);
        request.setParameters(parameters);
        return client.executeStatement(request);
    }

    private static void processResults(ExecuteStatementResult executeStatementResult) {
        System.out.println("ExecuteStatement successful: "+ executeStatementResult.toString());

    }

    // Handles errors during ExecuteStatement execution. Use recommendations in error messages below to add error handling specific to
    // your application use-case.
    private static void handleExecuteStatementErrors(Exception exception) {
        try {
            throw exception;
        } catch (ConditionalCheckFailedException ccfe) {
            System.out.println("Condition check specified in the operation failed, review and update the condition " +
                                       "check before retrying. Error: " + ccfe.getErrorMessage());
        } catch (TransactionConflictException tce) {
            System.out.println("Operation was rejected because there is an ongoing transaction for the item, generally " +
                                       "safe to retry with exponential back-off. Error: " + tce.getErrorMessage());
        } catch (ItemCollectionSizeLimitExceededException icslee) {
            System.out.println("An item collection is too large, you\'re using Local Secondary Index and exceeded " +
                                       "size limit of items per partition key. Consider using Global Secondary Index instead. Error: " + icslee.getErrorMessage());
        } catch (Exception e) {
            handleCommonErrors(e);
        }
    }

    private static void handleCommonErrors(Exception exception) {
        try {
            throw exception;
        } catch (InternalServerErrorException isee) {
            System.out.println("Internal Server Error, generally safe to retry with exponential back-off. Error: " + isee.getErrorMessage());
        } catch (RequestLimitExceededException rlee) {
            System.out.println("Throughput exceeds the current throughput limit for your account, increase account level throughput before " +
                                       "retrying. Error: " + rlee.getErrorMessage());
        } catch (ProvisionedThroughputExceededException ptee) {
            System.out.println("Request rate is too high. If you're using a custom retry strategy make sure to retry with exponential back-off. " +
                                       "Otherwise consider reducing frequency of requests or increasing provisioned capacity for your table or secondary index. Error: " +
                                       ptee.getErrorMessage());
        } catch (ResourceNotFoundException rnfe) {
            System.out.println("One of the tables was not found, verify table exists before retrying. Error: " + rnfe.getErrorMessage());
        } catch (AmazonServiceException ase) {
            System.out.println("An AmazonServiceException occurred, indicates that the request was correctly transmitted to the DynamoDB " +
                                       "service, but for some reason, the service was not able to process it, and returned an error response instead. Investigate and " +
                                       "configure retry strategy. Error type: " + ase.getErrorType() + ". Error message: " + ase.getErrorMessage());
        } catch (AmazonClientException ace) {
            System.out.println("An AmazonClientException occurred, indicates that the client was unable to get a response from DynamoDB " +
                                       "service, or the client was unable to parse the response from the service. Investigate and configure retry strategy. "+
                                       "Error: " + ace.getMessage());
        } catch (Exception e) {
            System.out.println("An exception occurred, investigate and configure retry strategy. Error: " + e.getMessage());
        }
    }

}

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

PartiQL クエリ言語

データ型