Aktualisierungsausdrücke in DynamoDB verwenden

Die UpdateItem-Operation aktualisiert ein vorhandenes Elements oder fügt ein neues Element in die Tabelle ein, wenn es noch nicht existiert. Sie müssen den Schlüssel des Elements angeben, das Sie aktualisieren möchten. Außerdem müssen Sie einen Aktualisierungsausdruck angeben, der die zu ändernden Attribute sowie die Werte enthält, die Sie ihnen zuweisen möchten.

Ein Aktualisierungsausdruck gibt an, wie UpdateItem die Attribute eines Elements ändert, z. B. durch Festlegen eines Skalarwerts oder durch Entfernen von Elementen aus einer Liste oder Zuordnung.

Im Folgenden finden Sie eine Syntaxzusammenfassung für Aktualisierungsausdrücke.

update-expression ::=
    [ SET action [, action] ... ]
    [ REMOVE action [, action] ...]
    [ ADD action [, action] ... ]
    [ DELETE action [, action] ...]

Ein Aktualisierungsausdruck besteht aus einer oder mehreren Klauseln. Jede Klausel beginnt mit einem SET-, REMOVE-, ADD- oder DELETE-Schlüsselwort. Sie können jede dieser Klauseln in beliebiger Reihenfolge in einen Aktualisierungsausdruck einfügen. Jedes Aktionsschlüsselwort kann jedoch nur einmal angezeigt werden.

Jede Klausel umfasst eine oder mehrere Aktionen, die durch Komma getrennt sind. Jede Aktion stellt eine Datenänderung dar.

Die Beispiele in diesem Abschnitt basieren auf dem Element ProductCatalog, wie in Verwenden von Projektionsausdrücken in DynamoDB dargestellt.

Die folgenden Themen behandeln verschiedene Anwendungsfälle für die SET-Aktion.

SET— Artikelattribute ändern oder hinzufügen

Verwenden Sie die SET-Aktion in einem Aktualisierungsausdruck, um ein oder mehrere Attribute zu einem Element hinzuzufügen. Wenn diese Attribute bereits vorhanden sind, werden sie durch die neuen Werte überschrieben. Wenn Sie vermeiden möchten, dass ein vorhandenes Attribut überschrieben wird, können Sie es zusammen mit dem verwendenSET. if_not_exists function Die Funktion if_not_exists gilt spezifisch für die SET-Aktion und kann nur in einem Aktualisierungsausdruck verwendet werden.

Wenn Sie SET verwenden, um ein Listenelement zu aktualisieren, wird der Inhalt dieses Elements durch die neuen Daten ersetzt, die Sie angeben. Wenn das Element noch nicht vorhanden ist, fügt SET das neue Element am Ende der Liste an.

Wenn Sie mehrere Elemente in einer einzigen SET-Operation hinzufügen, werden die Elemente nach Elementnummer sortiert.

Sie können SET auch verwenden, um einen Wert zu einem Attribut des Typs Number zu addieren oder von diesem zu subtrahieren. Wenn Sie mehrere SET-Aktionen durchführen möchten, trennen Sie sie durch Komma.

Schauen Sie sich die folgende Syntaxzusammenfassung an:

set-action ::=
    path = value

value ::=
    operand
    | operand '+' operand
    | operand '-' operand

operand ::=
    path | function

function ::=
    if_not_exists (path)

Wenn das Element kein Attribut im angegebenen Pfad enthält, wird als if_not_exists ausgewertet. value Andernfalls wird es zu ausgewertet. path

Die folgende PutItem-Operation erstellt ein Beispielelement, auf das wir uns in den Beispielen beziehen werden.

aws dynamodb put-item \
    --table-name ProductCatalog \
    --item file://item.json

Die Argumente für --item werden in der Datei item.json gespeichert: (Der Einfachheit halber werden nur wenige Elementattribute verwendet.)

{
    "Id": {"N": "789"},
    "ProductCategory": {"S": "Home Improvement"},
    "Price": {"N": "52"},
    "InStock": {"BOOL": true},
    "Brand": {"S": "Acme"}
}

Ändern von Attributen

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET ProductCategory = :c, Price = :p" \
    --expression-attribute-values file://values.json \
    --return-values ALL_NEW

{
    ":c": { "S": "Hardware" },
    ":p": { "N": "60" }
}

Hinzufügen von Listen und Zuordnungen

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET RelatedItems = :ri, ProductReviews = :pr" \
    --expression-attribute-values file://values.json \
    --return-values ALL_NEW

{
    ":ri": {
        "L": [
            { "S": "Hammer" }
        ]
    },
    ":pr": {
        "M": {
            "FiveStar": {
                "L": [
                    { "S": "Best product ever!" }
                ]
            }
        }
    }
}

Hinzufügen von Elementen zu einer Liste

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET RelatedItems[1] = :ri" \
    --expression-attribute-values file://values.json \
    --return-values ALL_NEW

{
    ":ri": { "S": "Nails" }
}

Hinzufügen verschachtelter Zuordnungsattribute

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET #pr.#5star[1] = :r5, #pr.#3star = :r3" \
    --expression-attribute-names file://names.json \
    --expression-attribute-values file://values.json \
    --return-values ALL_NEW

{
    "#pr": "ProductReviews",
    "#5star": "FiveStar",
    "#3star": "ThreeStar"
}

{
    ":r5": { "S": "Very happy with my purchase" },
    ":r3": {
        "L": [
            { "S": "Just OK - not that great" }
        ]
    }
}

Vergrößern und Verkleinern numerischer Attribute

Sie können ein vorhandenes numerisches Attribut vergrößern oder verkleinern. Dazu verwenden Sie die Operatoren + (plus) und - (minus).

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET Price = Price - :p" \
    --expression-attribute-values '{":p": {"N":"15"}}' \
    --return-values ALL_NEW

Anfügen von Elementen zu einer Liste

Sie können Elemente an das Ende einer Liste anfügen. Dazu verwenden Sie SET mit der Funktion list_append. (Beim Funktionsnamen muss die Groß- und Kleinschreibung beachtet werden.) Die Funktion list_append gilt spezifisch für die SET-Aktion und kann nur in einem Aktualisierungsausdruck verwendet werden. Die Syntax ist wie folgt.

Die Funktion nimmt zwei Listen als Eingabe und fügt alle Elemente von list2 bis list1 an.

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET #ri = list_append(#ri, :vals)" \
    --expression-attribute-names '{"#ri": "RelatedItems"}' \
    --expression-attribute-values file://values.json  \
    --return-values ALL_NEW

{
    ":vals": {
        "L": [
            { "S": "Screwdriver" },
            {"S": "Hacksaw" }
        ]
    }
}

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET #ri = list_append(:vals, #ri)" \
    --expression-attribute-names '{"#ri": "RelatedItems"}' \
    --expression-attribute-values '{":vals": {"L": [ { "S": "Chisel" }]}}' \
    --return-values ALL_NEW

Verhindern der Überschreibung eines vorhandenen Attributs

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET Price = if_not_exists(Price, :p)" \
    --expression-attribute-values '{":p": {"N": "100"}}' \
    --return-values ALL_NEW

REMOVE— Löschen von Attributen aus einem Element

Verwenden Sie die REMOVE-Aktion in einem Aktualisierungsausdruck, um ein oder mehrere Attribute aus einem Element in Amazon DynamoDB zu entfernen. Wenn Sie mehrere REMOVE-Aktionen durchführen möchten, trennen Sie sie durch Komma.

Im Folgenden finden Sie eine Syntaxzusammenfassung für REMOVE in einem Aktualisierungsausdruck. Der einzige Operand ist der Dokumentpfad für das Attribut, das Sie entfernen möchten.

remove-action ::=
    path

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "REMOVE Brand, InStock, QuantityOnHand" \
    --return-values ALL_NEW

Entfernen von Elementen aus einer Liste

Sie können REMOVE verwenden, um einzelne Element aus einer Liste zu löschen.

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "REMOVE RelatedItems[1], RelatedItems[2]" \
    --return-values ALL_NEW

ADD— Zahlen und Sätze aktualisieren

Verwenden Sie die ADD-Aktion in einem Aktualisierungsausdruck, um ein neues Attribut mit seinen zugehörigen Werten einem Element hinzuzufügen.

Wenn das Attribut bereits vorhanden ist, hängt das Verhalten von ADD vom Datentyp des Attributs ab.

Wenn Sie mehrere ADD-Aktionen durchführen möchten, trennen Sie sie durch Komma.

Schauen Sie sich die folgende Syntaxzusammenfassung an:

add-action ::=
    path value

Die folgenden Themen behandeln verschiedene Anwendungsfälle für die ADD-Aktion.

Hinzufügen einer Zahl

Angenommen, das Attribut QuantityOnHand ist nicht vorhanden. Im folgenden AWS CLI Beispiel wird der Wert QuantityOnHand auf 5 gesetzt.

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "ADD QuantityOnHand :q" \
    --expression-attribute-values '{":q": {"N": "5"}}' \
    --return-values ALL_NEW

Da QuantityOnHand nun vorhanden ist, können Sie das Beispiel erneut ausführen, um QuantityOnHand jedes Mal um 5 zu erhöhen.

Hinzufügen von Elementen zu einem Satz

Angenommen, das Attribut Color ist nicht vorhanden. Im folgenden AWS CLI -Beispiel wird Color auf einen Zeichenfolgensatz mit zwei Elementen festgelegt.

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "ADD Color :c" \
    --expression-attribute-values '{":c": {"SS":["Orange", "Purple"]}}' \
    --return-values ALL_NEW

Da Color nun vorhanden ist, können wir weitere Elemente hinzufügen.

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "ADD Color :c" \
    --expression-attribute-values '{":c": {"SS":["Yellow", "Green", "Blue"]}}' \
    --return-values ALL_NEW

DELETE— Elemente aus einem Satz entfernen

Verwenden Sie die DELETE-Aktion in einem Aktualisierungsausdruck, um ein oder mehrere Elemente aus einem Satz zu entfernen. Wenn Sie mehrere DELETE-Aktionen durchführen möchten, trennen Sie sie durch Komma.

Schauen Sie sich die folgende Syntaxzusammenfassung an:

delete-action ::=
    path subset

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "DELETE Color :p" \
    --expression-attribute-values '{":p": {"SS": ["Yellow", "Purple"]}}' \
    --return-values ALL_NEW

Verwenden mehrerer Aktualisierungsausdrücke

Sie können in einer einzelnen Anweisung mehrere Aktualisierungsausdrücke verwenden.

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET Price = Price - :p REMOVE InStock" \
    --expression-attribute-values '{":p": {"N":"15"}}' \
    --return-values ALL_NEW

aws dynamodb update-item \
    --table-name ProductCatalog \
    --key '{"Id":{"N":"789"}}' \
    --update-expression "SET RelatedItems[1] = :newValue, Price = :newPrice" \
    --expression-attribute-values '{":newValue": {"S":"Nails"}, ":newPrice": {"N":"21"}}'  \
    --return-values ALL_NEW