Arbeiten mit Elementen: Java

Sie können das AWS SDK for Java Dokument verwenden, API um typische Erstellungs-, Lese-, Aktualisierungs- und Löschvorgänge (CRUD) für Amazon DynamoDB DynamoDB-Elemente in einer Tabelle durchzuführen.

Dieser Abschnitt enthält Java-Beispiele für die Ausführung verschiedener Aktionen für Java-Dokumentelemente sowie mehrere API vollständige Arbeitsbeispiele.

Einfügen eines Elements

Die putItem-Methode speichert ein Element in einer Tabelle. Wenn das Element bereits vorhanden ist, wird das ganze Element ersetzt. Anstatt das gesamte Element zu ersetzen und nur spezifische Attribute zu aktualisieren, können Sie die Methode updateItem verwenden. Weitere Informationen finden Sie unter Aktualisieren eines Elements.

Angeben eines optionalen Parameters

Neben den erforderlichen Parametern können Sie auch optionale Parameter für die putItem-Methode angeben. Zum Beispiel verwendet das folgende Java-Codebeispiel einen optionalen Parameter, um eine Bedingung für das Hochladen des Elements anzugeben. Wenn die von Ihnen angegebene Bedingung nicht erfüllt ist, wird AWS SDK for Java ein ConditionalCheckFailedException ausgelöst. Das Codebeispiel gibt die folgenden optionalen Parameter in der putItem-Methode an:

Im folgenden Beispiel wird ein neues Buchelement mit diesen optionalen Parameter hinzugefügt.

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 und Dokumente JSON

Sie können ein JSON Dokument als Attribut in einer DynamoDB-Tabelle speichern. Verwenden Sie dazu die withJSON-Methode Item. Diese Methode analysiert das JSON Dokument und ordnet jedes Element einem systemeigenen DynamoDB-Datentyp zu.

Angenommen, Sie möchten das folgende JSON Dokument speichern, das Lieferanten enthält, die Bestellungen für ein bestimmtes Produkt ausführen können.

{
    "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"
        ]
    }
}

Sie können die withJSON-Methode verwenden, um es in der ProductCatalog-Tabelle in einem Map´-Attribut mit dem Namen VendorInfo zu speichern. Das folgende Java-Codebeispiel veranschaulicht dies.

// 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); 

Abrufen eines Elements

Um ein einzelnes Element abzurufen, verwenden Sie die getItem-Methode eines Table-Objekts. Dazu gehen Sie wie folgt vor:

Im folgenden Java-Codebeispiel werden die vorherigen Schritte veranschaulicht. Im Codebeispiel wird das Element abgerufen, das den angegebenen Partitionsschlüssel aufweist.

AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);

Table table = dynamoDB.getTable("ProductCatalog");

Item item = table.getItem("Id", 210);

Angeben eines optionalen Parameters

Neben den erforderlichen Parametern können Sie auch optionale Parameter für die getItem-Methode angeben. Zum Beispiel verwendet das folgende Java-Codebeispiel eine optionale Methode zum Abrufen nur einer bestimmten Liste von Attributen und zum Angeben von Strongly Consistent-Lesevorgängen. (Weitere Informationen zur Lesekonsistenz finden Sie unter DynamoDB-Lesekonsistenz.)

Sie können einen ProjectionExpression verwenden, um nur spezifische Attribute oder Elemente anstelle eines ganzen Elements abzurufen. Ein ProjectionExpression kann Attribute auf oberster Ebene oder verschachtelte Attribute mithilfe von Dokumentpfaden angeben. Weitere Informationen finden Sie unter Verwenden von Projektionsausdrücken in DynamoDB.

Mit den Parametern der getItem-Methode kann keine Read Consistency angegeben werden. Sie können jedoch eine GetItemSpec erstellen, die vollständigen Zugriff auf die Eingaben für die GetItem-Low-Level-Operation bietet. Durch das Codebeispiel unten wird eine GetItemSpec erstellt. Es verwendet diese Spezifikation als Eingabe für die getItem-Methode.

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());

Um ein Item in einem vom Menschen lesbaren Format zu drucken, verwenden Sie die Methode toJSONPretty. Die Ausgabe aus dem vorherigen Beispiel sieht wie folgt aus.

{
  "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 und JSON Dokumente

In dem PutItem und Dokumente JSON Abschnitt speichern Sie ein JSON Dokument in einem Map Attribut mit dem NamenVendorInfo. Sie können die getItem Methode verwenden, um das gesamte Dokument im JSON Format abzurufen. Sie können auch die Dokumentpfadnotation verwenden, um nur einige der Elemente des Dokuments abzurufen. Das folgende Java-Codebeispiel veranschaulicht diese Vorgehensweisen.

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());
 

Die Ausgabe aus dem vorherigen Beispiel sieht wie folgt aus.

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"]}}}

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"}

Batch Write: Einfügen und Löschen mehrerer Elemente

Batch Write bezieht sich auf das Einfügen und Löschen mehrerer Elemente in einem Batch. Die batchWriteItem-Methode ermöglicht Ihnen das Einfügen und Löschen von mehreren Elementen aus einer oder mehreren Tabellen anhand eines einzigen Aufrufs. Im Folgenden finden Sie die Schritte zum Einfügen oder Löschen mehrerer Elemente mithilfe des Dokuments. AWS SDK for Java API

Im folgenden Java-Codebeispiel werden die vorherigen Schritte veranschaulicht. Das folgende Beispiel führt eine batchWriteItem-Operation für zwei Tabellen durch: Forum und Thread. Die entsprechenden TableWriteItems-Objekte definieren die folgenden Aktionen:

Der Code ruft dann batchWriteItem auf, um die Operation durchzuführen.

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

Ein funktionierendes Beispiel finden Sie unter Beispiel: Batch-Schreibvorgang unter Verwendung des AWS SDK for Java Dokuments API.

Batch Get: Abrufen mehrerer Elemente

Die batchGetItem-Methode ermöglicht Ihnen das Abrufen mehrerer Elemente aus einer oder mehreren Tabellen. Um ein einzelnes Element abzurufen, können Sie die getItem-Methode verwenden.

Dazu gehen Sie wie folgt vor:

Im folgenden Java-Codebeispiel werden die vorherigen Schritte veranschaulicht. In dem Beispiel werden zwei Elemente aus der Forum-Tabelle und drei Elemente aus der Thread-Tabelle abgerufen.

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);
    }
} 

Angeben eines optionalen Parameters

Neben den erforderlichen Parametern können Sie bei Verwendung von batchGetItem auch optionale Parameter angeben. Beispielsweise können Sie einen ProjectionExpression mit jedem TableKeysAndAttributes, das Sie definieren, bereitstellen. So können Sie die Attribute angeben, die aus der Tabelle abgerufen werden sollen.

Im folgenden C#-Codebeispiel werden zwei Elemente aus der Forum-Tabelle abgerufen. Der Parameter withProjectionExpression gibt an, dass nur das Attribut Threads abgerufen werden soll.

TableKeysAndAttributes forumTableKeysAndAttributes = new TableKeysAndAttributes("Forum")
    .withProjectionExpression("Threads");

forumTableKeysAndAttributes.addHashOnlyPrimaryKeys("Name",
    "Amazon S3",
    "Amazon DynamoDB");

BatchGetItemOutcome outcome = dynamoDB.batchGetItem(forumTableKeysAndAttributes);

Aktualisieren eines Elements

Die updateItem-Methode eines Table-Objekts kann vorhandene Attributwerte aktualisieren, neue Attribute hinzuzufügen oder Attribute aus einem vorhandenen Element löschen.

Die updateItem-Methode verhält sich wie folgt:

Dazu gehen Sie wie folgt vor:

Im folgenden Java-Codebeispiel werden die vorherigen Aufgaben veranschaulicht. Das Beispiel aktualisiert ein Buchelement in der ProductCatalog-Tabelle. Es wird ein neuer Autor zum Satz der Authors hinzugefügt und das vorhandene ISBN-Attribut wird gelöscht. Darüber hinaus wird auch der Preis um eins gesenkt.

Im ExpressionAttributeValues wird eine UpdateExpression-Zuordnung verwendet. Die Platzhalter :val1 und :val2 werden zur Laufzeit durch die tatsächlichen Werte für Authors und Price ersetzt.

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);

Angeben eines optionalen Parameters

Neben den erforderlichen Parametern können Sie auch optionale Parameter für die updateItem-Methode angeben, z. B. eine Bedingung, die erfüllt werden muss, damit die Aktualisierung erfolgt. Wenn die von Ihnen angegebene Bedingung nicht erfüllt ist, wird AWS SDK for Java eine ConditionalCheckFailedException ausgelöst. Beim folgenden Java-Codebeispiel wird der Preis eines Buchelements bedingungsabhängig auf 25 erhöht. Das Beispiel zeigt einen ConditionExpression, der besagt, dass der Preis nur aktualisiert werden soll, wenn der vorhandene Preis 20 lautet.

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);

Unteilbarer Zähler

Sie können updateItem verwenden, um einen unteilbaren Zähler zu implementieren, mit dem der Wert eines bestehenden Attributs erhöht oder verringert wird, ohne andere Schreibanforderungen zu beeinflussen. Zum Erhöhen eines unteilbaren Zählers verwenden Sie einen UpdateExpression mit einer set-Aktion, um einem vorhandenen Attribut vom Typ Number einen numerischen Wert hinzuzufügen.

Das folgende Codebeispiel zeigt diesen Vorgang und erhöht das Attribut Quantity um eins. Es zeigt auch die Verwendung des Parameters ExpressionAttributeNames in einem 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);

Löschen eines Elements

Die deleteItem-Methode löscht ein Element aus einer Tabelle. Sie müssen den Primärschlüssel des Elements bereitstellen, das Sie löschen möchten.

Dazu gehen Sie wie folgt vor:

Das folgende Java-Codebeispiel veranschaulicht diese Vorgehensweisen.

AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard().build();
DynamoDB dynamoDB = new DynamoDB(client);

Table table = dynamoDB.getTable("ProductCatalog");

DeleteItemOutcome outcome = table.deleteItem("Id", 101);

Angeben eines optionalen Parameters

Sie können für deleteItem optionale Parameter angeben. Das folgende Java-Codebeispiel enthält einen ConditionExpression, der besagt, dass ein Buchelement im InPublication nur dann gelöscht werden darf, wenn das Buch nicht mehr veröffentlicht wird (das Attribut ProductCatalog ist False).

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);