AWS SDK for Java ドキュメント API を使用して、テーブル内の Amazon DynamoDB 項目に対して、一般的な作成、読み込み、更新、削除 (CRUD) のオペレーションを実行できます。
注記
SDK for Java には、オブジェクト永続性モデルも用意されています。このモデルにより、クライアント側のクラスを DynamoDB テーブルにマッピングすることができます。この方法により、記述する必要のあるコードの量を減らすことができます。詳細については、「」を参照してくださいJava 1.x: DynamoDBMapper
このセクションには、いくつかの Java ドキュメント API 項目のアクションを実行する Java サンプルといくつかの完全な操作例が含まれています。
トピック
項目の置換
putItem
メソッドによって、項目をテーブルに格納します。項目が存在する場合、その項目全体が置き換えられます。項目全体を置き換える代わりに固有の属性のみを更新する場合は、updateItem
メソッドを使用できます。詳細については、「」を参照してください項目の更新
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
import software.amazon.awssdk.services.dynamodb.model.DynamoDbException;
import software.amazon.awssdk.services.dynamodb.model.PutItemRequest;
import software.amazon.awssdk.services.dynamodb.model.PutItemResponse;
import software.amazon.awssdk.services.dynamodb.model.ResourceNotFoundException;
import java.util.HashMap;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*
* To place items into an Amazon DynamoDB table using the AWS SDK for Java V2,
* its better practice to use the
* Enhanced Client. See the EnhancedPutItem example.
*/
public class PutItem {
public static void main(String[] args) {
final String usage = """
Usage:
<tableName> <key> <keyVal> <albumtitle> <albumtitleval> <awards> <awardsval> <Songtitle> <songtitleval>
Where:
tableName - The Amazon DynamoDB table in which an item is placed (for example, Music3).
key - The key used in the Amazon DynamoDB table (for example, Artist).
keyval - The key value that represents the item to get (for example, Famous Band).
albumTitle - The Album title (for example, AlbumTitle).
AlbumTitleValue - The name of the album (for example, Songs About Life ).
Awards - The awards column (for example, Awards).
AwardVal - The value of the awards (for example, 10).
SongTitle - The song title (for example, SongTitle).
SongTitleVal - The value of the song title (for example, Happy Day).
**Warning** This program will place an item that you specify into a table!
""";
if (args.length != 9) {
System.out.println(usage);
System.exit(1);
}
String tableName = args[0];
String key = args[1];
String keyVal = args[2];
String albumTitle = args[3];
String albumTitleValue = args[4];
String awards = args[5];
String awardVal = args[6];
String songTitle = args[7];
String songTitleVal = args[8];
Region region = Region.US_EAST_1;
DynamoDbClient ddb = DynamoDbClient.builder()
.region(region)
.build();
putItemInTable(ddb, tableName, key, keyVal, albumTitle, albumTitleValue, awards, awardVal, songTitle,
songTitleVal);
System.out.println("Done!");
ddb.close();
}
public static void putItemInTable(DynamoDbClient ddb,
String tableName,
String key,
String keyVal,
String albumTitle,
String albumTitleValue,
String awards,
String awardVal,
String songTitle,
String songTitleVal) {
HashMap<String, AttributeValue> itemValues = new HashMap<>();
itemValues.put(key, AttributeValue.builder().s(keyVal).build());
itemValues.put(songTitle, AttributeValue.builder().s(songTitleVal).build());
itemValues.put(albumTitle, AttributeValue.builder().s(albumTitleValue).build());
itemValues.put(awards, AttributeValue.builder().s(awardVal).build());
PutItemRequest request = PutItemRequest.builder()
.tableName(tableName)
.item(itemValues)
.build();
try {
PutItemResponse response = ddb.putItem(request);
System.out.println(tableName + " was successfully updated. The request id is "
+ response.responseMetadata().requestId());
} catch (ResourceNotFoundException e) {
System.err.format("Error: The Amazon DynamoDB table \"%s\" can't be found.\n", tableName);
System.err.println("Be sure that it exists and that you've typed its name correctly!");
System.exit(1);
} catch (DynamoDbException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
オプションパラメータの指定
必須のパラメータに加え、putItem
メソッドにはオプションパラメータも指定できます。たとえば、以下の Java コード例では、オプションパラメータを使用して、項目のアップロード条件を指定します。指定した条件を満たさない場合は、AWS SDK for Java が ConditionalCheckFailedException
をスローします。このコード例では、putItem
メソッドに以下のオプションパラメータを指定します。
-
リクエストの条件を定義する
ConditionExpression
。このコードでは、特定の値に等しい ISBN 属性が既存の項目にある場合にのみ同じプライマリキーを持つ既存の項目を置き換えるという条件を定義します。 -
条件で使用される
ExpressionAttributeValues
のマップ。この場合、必要な置き換えは 1 つだけです。条件式のプレースホルダー:val
が、実行時に、チェックする実際の ISBN 値に置き換えられます。
以下の例では、これらのオプションパラメータを使用して新しい書籍項目を追加します。
例
Item item = new Item()
.withPrimaryKey("Id", 104)
.withString("Title", "Book 104 Title")
.withString("ISBN", "444-4444444444")
.withNumber("Price", 20)
.withStringSet("Authors",
new HashSet<String>(Arrays.asList("Author1", "Author2")));
Map<String, Object> expressionAttributeValues = new HashMap<String, Object>();
expressionAttributeValues.put(":val", "444-4444444444");
PutItemOutcome outcome = table.putItem(
item,
"ISBN = :val", // ConditionExpression parameter
null, // ExpressionAttributeNames parameter - we're not using it for this example
expressionAttributeValues);
PutItem および JSON ドキュメント
JSON ドキュメントは、DynamoDB テーブルに属性として格納できます。これを行うには、withJSON
項目の Item
メソッドを使用します。このメソッドは、JSON ドキュメントを解析し、各要素を DynamoDB のネイティブデータ型にマッピングします。
特定の製品の注文を処理できるベンダーを含む、次の JSON ドキュメントを格納するとします。
例
{
"V01": {
"Name": "Acme Books",
"Offices": [ "Seattle" ]
},
"V02": {
"Name": "New Publishers, Inc.",
"Offices": ["London", "New York"
]
},
"V03": {
"Name": "Better Buy Books",
"Offices": [ "Tokyo", "Los Angeles", "Sydney"
]
}
}
withJSON
メソッドを使用して、ProductCatalog
という名前の Map
属性でこれを VendorInfo
テーブルに格納することができます。次の Java コード例はそれを行う方法を示しています。
// Convert the document into a String. Must escape all double-quotes.
String vendorDocument = "{"
+ " \"V01\": {"
+ " \"Name\": \"Acme Books\","
+ " \"Offices\": [ \"Seattle\" ]"
+ " },"
+ " \"V02\": {"
+ " \"Name\": \"New Publishers, Inc.\","
+ " \"Offices\": [ \"London\", \"New York\"" + "]" + "},"
+ " \"V03\": {"
+ " \"Name\": \"Better Buy Books\","
+ "\"Offices\": [ \"Tokyo\", \"Los Angeles\", \"Sydney\""
+ " ]"
+ " }"
+ " }";
Item item = new Item()
.withPrimaryKey("Id", 210)
.withString("Title", "Book 210 Title")
.withString("ISBN", "210-2102102102")
.withNumber("Price", 30)
.withJSON("VendorInfo", vendorDocument);
PutItemOutcome outcome = table.putItem(item);
項目の取得
単一の項目を取り出すには、getItem
オブジェクトの Table
メソッドを使用します。以下のステップに従ってください。
-
DynamoDB
クラスのインスタンスを作成します。 -
操作対象のテーブルを表すために、
Table
クラスのインスタンスを作成します。 -
getItem
インスタンスのTable
メソッドを呼び出します。取り出す項目のプライマリキーを指定する必要があります。
以下の Java コード例は、前述のステップの例です。このコードでは、指定したパーティションキーを持つ項目を取得します。
AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);
Table table = dynamoDB.getTable("ProductCatalog");
Item item = table.getItem("Id", 210);
オプションパラメータの指定
必須のパラメータに加え、getItem
メソッドにはオプションパラメータも指定できます。たとえば、以下の Java コード例では、オプションメソッドを使用して、特定の属性リストのみを取り出します。また、強い整合性のある戻り値をリクエストします。読み込み整合性の詳細については、「DynamoDB の読み取り整合性」を参照してください。
ProjectionExpression
を使用すると、項目全体ではなく特定の属性または要素のみを取り出すことができます。ProjectionExpression
は、ドキュメントのパスを使用して最上位の属性または入れ子になった属性を指定できます。詳細については、「」を参照してくださいDynamoDB でのプロジェクション式の使用
getItem
メソッドのパラメータでは、読み取りの一貫性を指定できません。ただし、GetItemSpec
を作成して、低レベル GetItem
オペレーションへの入力のすべてに対するフルアクセスを提供できます。以下のコード例では、GetItemSpec
を作成し、その仕様を getItem
メソッドへの入力として使用します。
例
GetItemSpec spec = new GetItemSpec()
.withPrimaryKey("Id", 206)
.withProjectionExpression("Id, Title, RelatedItems[0], Reviews.FiveStar")
.withConsistentRead(true);
Item item = table.getItem(spec);
System.out.println(item.toJSONPretty());
Item
を人間が読める形式で出力するには、toJSONPretty
メソッドを使用します。前のサンプルからの出力は、次のようになります。
{
"RelatedItems" : [ 341 ],
"Reviews" : {
"FiveStar" : [ "Excellent! Can't recommend it highly enough! Buy it!", "Do yourself a favor and buy this" ]
},
"Id" : 123,
"Title" : "20-Bicycle 123"
}
GetItem および JSON ドキュメント
PutItem および JSON ドキュメント セクションでは、Map
という名前の VendorInfo
属性に JSON ドキュメントを格納します。getItem
メソッドを使用して、ドキュメント全体を JSON 形式で取得できます。または、ドキュメントパスの表記を使用して、ドキュメントの一部の要素のみを取得することもできます。次の Java コード例は、この手法を示しています。
GetItemSpec spec = new GetItemSpec()
.withPrimaryKey("Id", 210);
System.out.println("All vendor info:");
spec.withProjectionExpression("VendorInfo");
System.out.println(table.getItem(spec).toJSON());
System.out.println("A single vendor:");
spec.withProjectionExpression("VendorInfo.V03");
System.out.println(table.getItem(spec).toJSON());
System.out.println("First office location for this vendor:");
spec.withProjectionExpression("VendorInfo.V03.Offices[0]");
System.out.println(table.getItem(spec).toJSON());
前のサンプルからの出力は、次のようになります。
All vendor info: {"VendorInfo":{"V03":{"Name":"Better Buy Books","Offices":["Tokyo","Los Angeles","Sydney"]},"V02":{"Name":"New Publishers, Inc.","Offices":["London","New York"]},"V01":{"Name":"Acme Books","Offices":["Seattle"]}}} A single vendor: {"VendorInfo":{"V03":{"Name":"Better Buy Books","Offices":["Tokyo","Los Angeles","Sydney"]}}} First office location for a single vendor: {"VendorInfo":{"V03":{"Offices":["Tokyo"]}}}
注記
toJSON
メソッドを使用して、任意の項目(またはその属性)を JSON 形式文字列に変換できます。次のコード例は、最上位の属性と入れ子になった属性を複数取り出し、JSON として結果を出力します。
GetItemSpec spec = new GetItemSpec()
.withPrimaryKey("Id", 210)
.withProjectionExpression("VendorInfo.V01, Title, Price");
Item item = table.getItem(spec);
System.out.println(item.toJSON());
出力は次のようになります。
{"VendorInfo":{"V01":{"Name":"Acme Books","Offices":["Seattle"]}},"Price":30,"Title":"Book 210 Title"}
バッチ書き込み: 複数の項目の置換および削除
バッチ書き込みは、複数の項目の書き込みと削除をバッチで行うことを意味します。batchWriteItem
メソッドによって、単一の コール内にある 1 つまたは複数のテーブルから複数の項目を置換および削除できます。以下に、AWS SDK for Java ドキュメント API を使用して複数の項目を入力および削除する手順を示します。
-
DynamoDB
クラスのインスタンスを作成します。 -
テーブルのすべての入力および削除オペレーションを記述する
TableWriteItems
クラスのインスタンスを作成します。1 つのバッチ書き込みオペレーションで複数のテーブルに書き込む場合、テーブルごとにTableWriteItems
インスタンスを 1 つずつ作成する必要があります。 -
前の手順で作成した
batchWriteItem
オブジェクトを指定して、TableWriteItems
メソッドを呼び出します。 -
応答を処理します。返された未処理のリクエスト項目が応答内に存在していたかどうかをチェックする必要があります。これは、プロビジョニングされたスループットクォータまたは他の何らかの一時的エラーに達する場合に、発生する可能性があります。また、DynamoDB によって、リクエストのサイズ、およびリクエスト内で指定できるオペレーションの数が制限されます。これらの制限を超えると、DynamoDB によってリクエストが却下されます。詳細については、「Amazon DynamoDB のサービス、アカウント、およびテーブルのクォータ」を参照してください。
以下の Java コード例は、前述のステップの例です。この例では、2 つのテーブル (batchWriteItem
と Forum
) で Thread
オペレーションを実行します。対応する TableWriteItems
オブジェクトは、次のアクションを定義します。
-
Forum
テーブル内で項目を配置します。 -
Thread
テーブル内で項目を入力および削除します。
その後、コードは batchWriteItem
を呼び出してオペレーションを実行します。
AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);
TableWriteItems forumTableWriteItems = new TableWriteItems("Forum")
.withItemsToPut(
new Item()
.withPrimaryKey("Name", "Amazon RDS")
.withNumber("Threads", 0));
TableWriteItems threadTableWriteItems = new TableWriteItems("Thread")
.withItemsToPut(
new Item()
.withPrimaryKey("ForumName","Amazon RDS","Subject","Amazon RDS Thread 1")
.withHashAndRangeKeysToDelete("ForumName","Some partition key value", "Amazon S3", "Some sort key value");
BatchWriteItemOutcome outcome = dynamoDB.batchWriteItem(forumTableWriteItems, threadTableWriteItems);
// Code for checking unprocessed items is omitted in this example
実例については、「例: AWS SDK for Java ドキュメント API を使用したバッチ書き込みオペレーション」を参照してください。
バッチ取得: 複数の項目の取得
batchGetItem
メソッドによって、1 つまたは複数のテーブルから複数の項目を取得できます。単一の項目を取り出すために、getItem
メソッドを使用できます。
以下のステップに従ってください。
-
DynamoDB
クラスのインスタンスを作成します。 -
テーブルから取り出すプライマリキーのリストを記述する
TableKeysAndAttributes
クラスのインスタンスを作成します。1 つのバッチ取得オペレーションで複数のテーブルから読み込む場合、テーブルごとにTableKeysAndAttributes
インスタンスを 1 つずつ作成する必要があります。 -
前の手順で作成した
batchGetItem
オブジェクトを指定して、TableKeysAndAttributes
メソッドを呼び出します。
以下の Java コード例は、前述のステップの例です。この例では、Forum
テーブル内の 2 つの項目、および Thread
テーブル内の 3 つの項目を取り出します。
AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);
TableKeysAndAttributes forumTableKeysAndAttributes = new TableKeysAndAttributes(forumTableName);
forumTableKeysAndAttributes.addHashOnlyPrimaryKeys("Name",
"Amazon S3",
"Amazon DynamoDB");
TableKeysAndAttributes threadTableKeysAndAttributes = new TableKeysAndAttributes(threadTableName);
threadTableKeysAndAttributes.addHashAndRangePrimaryKeys("ForumName", "Subject",
"Amazon DynamoDB","DynamoDB Thread 1",
"Amazon DynamoDB","DynamoDB Thread 2",
"Amazon S3","S3 Thread 1");
BatchGetItemOutcome outcome = dynamoDB.batchGetItem(
forumTableKeysAndAttributes, threadTableKeysAndAttributes);
for (String tableName : outcome.getTableItems().keySet()) {
System.out.println("Items in table " + tableName);
List<Item> items = outcome.getTableItems().get(tableName);
for (Item item : items) {
System.out.println(item);
}
}
オプションパラメータの指定
必須のパラメータに加え、batchGetItem
を使用する場合はオプションパラメータも指定できます。たとえば、定義した ProjectionExpression
ごとに TableKeysAndAttributes
を指定できます。これにより、テーブルから取り出す属性を指定することができます。
次のサンプルコードでは、Forum
から 2 つの項目を取得します。withProjectionExpression
パラメータは、Threads
属性のみを取得することを指定します。
例
TableKeysAndAttributes forumTableKeysAndAttributes = new TableKeysAndAttributes("Forum")
.withProjectionExpression("Threads");
forumTableKeysAndAttributes.addHashOnlyPrimaryKeys("Name",
"Amazon S3",
"Amazon DynamoDB");
BatchGetItemOutcome outcome = dynamoDB.batchGetItem(forumTableKeysAndAttributes);
項目の更新
updateItem
オブジェクトの Table
メソッドは、既存の属性値の更新、新しい属性の追加、または既存の項目からの属性の削除を実行できます。
updateItem
メソッドは、以下のように動作します。
-
項目が存在しない (指定されたプライマリキーを持つ項目がテーブル内にない) 場合、
updateItem
はテーブルに新しい項目を追加します -
項目が存在する場合、
updateItem
はUpdateExpression
パラメータで指定されたとおりに更新を実行します。
注記
putItem
を使用して項目を「更新」することもできます。たとえば、putItem
を呼び出して項目をテーブルに追加したが、指定されたプライマリキーを持つ項目がすでに存在する場合、putItem
は項目全体を置き換えます。入力で指定されていない属性が既存の項目内にある場合、putItem
は項目からそれらの属性を削除します。
一般に、項目属性を変更するときは必ず updateItem
を使用することをお勧めします。updateItem
メソッドは、入力で指定した項目属性のみを変更し、項目内の他の属性は変更されません。
以下のステップに従ってください。
-
操作対象のテーブルを表すために、
Table
クラスのインスタンスを作成します。 -
updateTable
インスタンスのTable
メソッドを呼び出します。変更する属性とその変更方法を記述するUpdateExpression
と同時に、取り出す項目のプライマリーキーを指定する必要があります。
以下の Java コード例は、前述のタスクの例です。このコードでは、ProductCatalog
テーブルの書籍項目を更新します。この例では、Authors
のセットに著者を追加し、既存の ISBN
属性を削除します。また、価格を 1 引き下げます。
ExpressionAttributeValues
マップは UpdateExpression
で使用されます。プレースホルダー :val1
および :val2
は、実行時に、Authors
と Price
の実際の値に置き換えられます。
AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);
Table table = dynamoDB.getTable("ProductCatalog");
Map<String, String> expressionAttributeNames = new HashMap<String, String>();
expressionAttributeNames.put("#A", "Authors");
expressionAttributeNames.put("#P", "Price");
expressionAttributeNames.put("#I", "ISBN");
Map<String, Object> expressionAttributeValues = new HashMap<String, Object>();
expressionAttributeValues.put(":val1",
new HashSet<String>(Arrays.asList("Author YY","Author ZZ")));
expressionAttributeValues.put(":val2", 1); //Price
UpdateItemOutcome outcome = table.updateItem(
"Id", // key attribute name
101, // key attribute value
"add #A :val1 set #P = #P - :val2 remove #I", // UpdateExpression
expressionAttributeNames,
expressionAttributeValues);
オプションパラメータの指定
必須のパラメータに加えて、更新を実行するために満たす必要がある条件も含めて、updateItem
メソッドのオプションパラメータを指定することもできます。指定した条件を満たさない場合は、AWS SDK for Java が ConditionalCheckFailedException
をスローします。たとえば、以下の Java コード例では、書籍項目の価格を条件付きで 25 に更新します。現在の価格が 20 である場合にのみ価格を更新する必要があることを示す ConditionExpression
を指定します。
例
Table table = dynamoDB.getTable("ProductCatalog");
Map<String, String> expressionAttributeNames = new HashMap<String, String>();
expressionAttributeNames.put("#P", "Price");
Map<String, Object> expressionAttributeValues = new HashMap<String, Object>();
expressionAttributeValues.put(":val1", 25); // update Price to 25...
expressionAttributeValues.put(":val2", 20); //...but only if existing Price is 20
UpdateItemOutcome outcome = table.updateItem(
new PrimaryKey("Id",101),
"set #P = :val1", // UpdateExpression
"#P = :val2", // ConditionExpression
expressionAttributeNames,
expressionAttributeValues);
アトミックカウンタ
updateItem
を使用してアトミックカウンターを実装できます。アトミックカウンターでは、他の書き込みリクエストを妨げることなく、既存の属性の値をインクリメントまたはデクリメントします。アトミックカウンターをインクリメントするには、UpdateExpression
を使用して、set
アクションで既存の Number
型の属性に数値を加算します。
次のサンプルはこのアトミックカウンターを示しており、Quantity
属性を 1 ずつインクリメントさせています。さらに、ExpressionAttributeNames
での UpdateExpression
パラメータの使用方法も示します。
Table table = dynamoDB.getTable("ProductCatalog");
Map<String,String> expressionAttributeNames = new HashMap<String,String>();
expressionAttributeNames.put("#p", "PageCount");
Map<String,Object> expressionAttributeValues = new HashMap<String,Object>();
expressionAttributeValues.put(":val", 1);
UpdateItemOutcome outcome = table.updateItem(
"Id", 121,
"set #p = #p + :val",
expressionAttributeNames,
expressionAttributeValues);
項目の削除
deleteItem
メソッドによって、テーブルから項目を削除します。削除する項目のプライマリキーを入力する必要があります。
以下のステップに従ってください。
-
DynamoDB
クライアントのインスタンスを作成します。 -
削除する項目のキーを指定して、
deleteItem
メソッドを呼び出します。
次の Java サンプルは、このタスクを示しています。
例
AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);
Table table = dynamoDB.getTable("ProductCatalog");
DeleteItemOutcome outcome = table.deleteItem("Id", 101);
オプションパラメータの指定
deleteItem
のオプションパラメータを指定できます。たとえば、次の Java コード例は、ConditionExpression
内の書籍項目は書籍が絶版になった (ProductCatalog
属性が false) 場合のみ削除可能であることを示す InPublication
を指定します。
例
Map<String,Object> expressionAttributeValues = new HashMap<String,Object>();
expressionAttributeValues.put(":val", false);
DeleteItemOutcome outcome = table.deleteItem("Id",103,
"InPublication = :val",
null, // ExpressionAttributeNames - not used in this example
expressionAttributeValues);