Überblick über den JSON-Datentyp

ElastiCache unterstützt eine Reihe von Valkey- und Redis OSS-Befehlen für die Arbeit mit dem JSON-Datentyp. Im Folgenden finden Sie eine Übersicht über den JSON-Datentyp und eine detaillierte Liste der unterstützten Befehle.

Terminologie

Begriff	Beschreibung
JSON-Dokument	Bezieht sich auf den Wert eines JSON-Schlüssels.
JSON-Wert	Bezieht sich auf eine Teilmenge eines JSON-Dokuments, einschließlich des Stammverzeichnisses, das das gesamte Dokument darstellt. Ein Wert könnte ein Container oder ein Eintrag innerhalb eines Containers sein.
JSON-Element	Äquivalent zu JSON-Wert.

Unterstützter JSON-Standard

Das JSON-Format ist mit RFC 7159 und dem ECMA-404-JSON-Datenaustauschstandard konform. UTF-8 Unicode wird im JSON-Text unterstützt.

Stammelement

Das Stammelement kann von jedem JSON-Datentyp stammen. Beachten Sie, dass in früheren RFC 4627 nur Objekte oder Arrays als Stammwerte zugelassen waren. Seit dem Update auf RFC 7159 kann das Stammverzeichnis eines JSON-Dokuments einen beliebigen JSON-Datentyp haben.

Begrenzung der Dokumentgröße

JSON-Dokumente werden intern in einem Format gespeichert, das für schnellen Zugriff und Änderung optimiert ist. Dieses Format führt in der Regel dazu, dass etwas mehr Speicher verbraucht wird als bei der äquivalenten serialisierten Darstellung desselben Dokuments.

Der Speicherverbrauch eines einzelnen JSON-Dokuments ist auf 64 MB begrenzt, was der Größe der In-Memory-Datenstruktur entspricht, nicht der JSON-Zeichenfolge. Sie können mit dem JSON.DEBUG MEMORY-Befehl den Speicherplatz überprüfen, der von einem JSON-Dokument verbraucht wird.

JSON ACLs

• Ähnlich wie bei den vorhandenen Pro-Datentyp-Kategorien (@string, @hash usw.) wird eine neue Kategorie @json hinzugefügt, um die Verwaltung des Zugriffs auf JSON-Befehle und -Daten zu vereinfachen. Keine anderen vorhandenen Valkey- oder Redis OSS-Befehle gehören zur Kategorie @json. Alle JSON-Befehle erzwingen alle Keyspace- oder Befehlseinschränkungen und -berechtigungen.

• Es gibt fünf bestehende Valkey- und Redis OSS-ACL-Kategorien, die aktualisiert wurden und nun die neuen JSON-Befehle enthalten: @read, @write, @fast, @slow und @admin. Die folgende Tabelle zeigt die Zuordnung von JSON-Befehlen zu den entsprechenden Kategorien an.

ACL

JSON-Befehl	@read	@write	@fast	@slow	@admin
JSON.ARRAPPEND		y	y
JSON.ARRINDEX	y		y
JSON.ARRINSERT		y	y
JSON.ARRLEN	y		y
JSON.ARRPOP		y	y
JSON.ARRTRIM		y	y
JSON.CLEAR		y	y
JSON.DEBUG	y			y	y
JSON.DEL		y	y
JSON.FORGET		y	y
JSON.GET	y		y
JSON.MGET	y		y
JSON.NUMINCRBY		y	y
JSON.NUMMULTBY		y	y
JSON.OBJKEYS	y		y
JSON.OBJLEN	y		y
JSON.RESP	y		y
JSON.SET		y		y
JSON.STRAPPEND		y	y
JSON.STRLEN	y		y
JSON.STRLEN	y		y
JSON.TOGGLE		y	y
JSON.TYPE	y		y
JSON.NUMINCRBY		y	y

Begrenzung der Verschachtelungstiefe

Wenn ein JSON-Objekt oder Array ein Element hat, das selbst ein anderes JSON-Objekt oder Array ist, wird gesagt, dass dieses innere Objekt oder Array innerhalb des äußeren Objekts oder Arrays „verschachtelt“ wird. Die maximale Verschachtelungstiefe ist 128. Jeder Versuch, ein Dokument zu erstellen, das eine Verschachtelungstiefe von mehr als 128 enthält, wird mit einem Fehler abgelehnt.

Befehlssyntax

Die meisten Befehle erfordern einen Schlüsselnamen als erstes Argument. Einige Befehle haben auch ein Pfadargument. Das Pfadargument ist standardmäßig das Stammverzeichnis, wenn es optional und nicht im Lieferumfang enthalten ist.

Notation:

• Erforderliche Argumente sind in spitzen Klammern eingeschlossen. Zum Beispiel: <key>

• Optionale Argumente werden in eckige Klammern gesetzt. Zum Beispiel: [path]

• Zusätzliche optionale Argumente sind durch eine Ellipse („...“) gekennzeichnet. Zum Beispiel: [json ...]

Pfadsyntax

Redis JSON unterstützt zwei Arten von Pfadsyntaxen:

• Verbesserte Syntax — Folgt der von Goessner beschriebenen JSONPath Syntax, wie in der folgenden Tabelle dargestellt. Wir haben die Beschreibungen in der Tabelle zur besseren Übersicht neu angeordnet und geändert.

• Beschränkte Syntax – Hat begrenzte Abfragemöglichkeiten.

Anmerkung

Die Ergebnisse einiger Befehle sind davon abhängig, welche Art von Pfadsyntax verwendet wird.

Wenn ein Abfragepfad mit „$“ beginnt, verwendet er die erweiterte Syntax. Andernfalls wird eine eingeschränkte Syntax verwendet.

Verbesserte Syntax

Symbol/Ausdruck	Beschreibung
$	Das Stammelement.
. oder []	Untergeordneter Operator
..	Rekursiver Abstieg
*	Platzhalter Alle Elemente in einem Objekt oder Array.
[]	Array-Index-Operator Der Index basiert auf 0.
[,]	Union-Operator
[start:end:step]	Array-Slice-Operator
?()	Wendet einen Filterausdruck (Skript) auf das aktuelle Array oder Objekt an.
()	Filterausdruck
@	Wird in Filterausdrücken verwendet, die zum aktuellen Knoten verweisen, der verarbeitet wird.
==	Ist gleich; wird in Filterausdrücken verwendet.
!=	Ist nicht gleich; wird in Filterausdrücken verwendet.
>	Größer als; wird in Filterausdrücken verwendet.
>=	Größer als oder gleich; wird in Filterausdrücken verwendet.
<	Kleiner als; wird in Filterausdrücken verwendet.
<=	Kleiner als oder gleich; wird in Filterausdrücken verwendet.
&&	Logisches UND; wird verwendet, um mehrere Filterausdrücke zu kombinieren.
||	Logisches ODER; wird verwendet, um mehrere Filterausdrücke zu kombinieren.

Beispiele

Die folgenden Beispiele bauen auf den Beispiel-XML-Daten von Goessner auf, die wir durch Hinzufügen zusätzlicher Felder geändert haben.

{ "store": {
    "book": [ 
      { "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95,
        "in-stock": true,
        "sold": true
      },
      { "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99,
        "in-stock": false,
        "sold": true
      },
      { "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99,
        "in-stock": true,
        "sold": false
      },
      { "category": "fiction",
        "author": "J. R. R. Tolkien",
        "title": "The Lord of the Rings",
        "isbn": "0-395-19395-8",
        "price": 22.99,
        "in-stock": false,
        "sold": false
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95,
      "in-stock": true,
      "sold": false
    }
  }
}

Pfad	Beschreibung
$.store.book[*].author	Die Autoren aller Bücher im Laden.
$..author	Alle Autoren
$.store.*	Alle Mitglieder des Ladens.
$["store"].*	Alle Mitglieder des Ladens.
$.store..price	Der Preis von allem im Laden.
$..*	Alle rekursiven Mitglieder der JSON-Struktu.
$..book[*]	Alle Bücher.
$..book[0]	Das erste Buch.
$..book[-1]	Das letzte Buch.
$..book[0:2]	Die ersten beiden Bücher.
$..book[0,1]	Die ersten beiden Bücher.
$..book[0:4]	Bücher von Index 0 bis 3 (Endindex ist nicht inklusive).
$..book[0:4:2]	Bücher bei Index 0, 2.
$..book[?(@.isbn)]	Alle Bücher mit einer ISBN-Nummer.
$..book[?(@.price<10)]	Alle Bücher günstiger als 10 USD.
'$..book[?(@.price < 10)]'	Alle Bücher günstiger als 10 USD. (Der Pfad muss in Anführungszeichen gesetzt werden, wenn er Leerzeichen enthält.)
'$..book[?(@["price"] < 10)]'	Alle Bücher günstiger als 10 USD.
'$..book[?(@.["price"] < 10)]'	Alle Bücher günstiger als 10 USD.
$..book[?(@.price>=10&&@.price<=100)]	Alle Bücher im Preisbereich von 10 bis 100 USD inklusive.
'$..book[?(@.price>=10 && @.price<=100)]'	Alle Bücher im Preisbereich von 10 bis 100 USD inklusive. (Der Pfad muss in Anführungszeichen gesetzt werden, wenn er Leerzeichen enthält.)
$..book[?(@.sold==true||@.in-stock==false)]	Alle Bücher verkauft oder ausverkauft.
'$..book[?(@.sold == true || @.in-stock == false)]'	Alle Bücher verkauft oder ausverkauft. (Der Pfad muss in Anführungszeichen gesetzt werden, wenn er Leerzeichen enthält.)
'$.store.book[?(@.["category"] == "fiction")]'	Alle Bücher der Kategorie Belletristik.
'$.store.book[?(@.["category"] != "fiction")]'	Alle Bücher in der Kategorie Sachbücher.

Zusätzliche Beispiele für Filterausdrücke:

127.0.0.1:6379> JSON.SET k1 . '{"books": [{"price":5,"sold":true,"in-stock":true,"title":"foo"}, {"price":15,"sold":false,"title":"abc"}]}'
OK
127.0.0.1:6379> JSON.GET k1 $.books[?(@.price>1&&@.price<20&&@.in-stock)]
"[{\"price\":5,\"sold\":true,\"in-stock\":true,\"title\":\"foo\"}]"
127.0.0.1:6379> JSON.GET k1 '$.books[?(@.price>1 && @.price<20 && @.in-stock)]'
"[{\"price\":5,\"sold\":true,\"in-stock\":true,\"title\":\"foo\"}]"
127.0.0.1:6379> JSON.GET k1 '$.books[?((@.price>1 && @.price<20) && (@.sold==false))]'
"[{\"price\":15,\"sold\":false,\"title\":\"abc\"}]"
127.0.0.1:6379> JSON.GET k1 '$.books[?(@.title == "abc")]'
[{"price":15,"sold":false,"title":"abc"}]

127.0.0.1:6379> JSON.SET k2 . '[1,2,3,4,5]'
127.0.0.1:6379> JSON.GET k2 $.*.[?(@>2)]
"[3,4,5]"
127.0.0.1:6379> JSON.GET k2 '$.*.[?(@ > 2)]'
"[3,4,5]"

127.0.0.1:6379> JSON.SET k3 . '[true,false,true,false,null,1,2,3,4]'
OK
127.0.0.1:6379> JSON.GET k3 $.*.[?(@==true)]
"[true,true]"
127.0.0.1:6379> JSON.GET k3 '$.*.[?(@ == true)]'
"[true,true]"
127.0.0.1:6379> JSON.GET k3 $.*.[?(@>1)]
"[2,3,4]"
127.0.0.1:6379> JSON.GET k3 '$.*.[?(@ > 1)]'
"[2,3,4]"

Beschränkte Syntax

Symbol/Ausdruck	Beschreibung
. oder []	Untergeordneter Operator
[]	Array-Index-Operator Der Index basiert auf 0.

Beispiele

Pfad	Beschreibung
.store.book[0].author	Der Autor des ersten Buches.
.store.book[-1].author	Der Autor des letzten Buches.
.address.city	Name der Stadt.
["store"]["book"][0]["title"]	Der Titel des ersten Buches.
["store"]["book"][-1]["title"]	Der Titel des letzten Buches.

Anmerkung

Alle Goessner-Inhalte, die in dieser Dokumentation erwähnt werden, unterliegen der Creative-Commons-Lizenz.

Häufige Fehlerpräfixe

Jede Fehlermeldung hat ein Präfix. Im Folgenden finden Sie eine Liste mit allgemeinen Fehlerpräfixen.

Präfix	Beschreibung
ERR	Ein allgemeiner Fehler.
LIMIT	Ein Fehler, der auftritt, wenn die Größenbeschränkung überschritten wird. Zum Beispiel wurde die Größenbeschränkung oder Verschachtelungstiefe überschritten.
NONEXISTENT	Ein Schlüssel oder Pfad ist nicht vorhanden.
OUTOFBOUNDARIES	Array-Index außerhalb des gültigen Bereichs.
SYNTAXERR	Syntaxfehler
WRONGTYPE	Falscher Werttyp.

JSON-verwandte Metriken

Die folgenden JSON-Infometriken werden bereitgestellt:

Informationen	Beschreibung
json_total_memory_bytes	JSON-Objekten zugewiesener Gesamtspeicher
json_num_documents	Gesamtzahl der Dokumente in Valkey oder Redis OSS.

Führen Sie den folgenden Befehl aus, um Kernmetriken abzufragen:

info json_core_metrics

Wie interagiert OSS ElastiCache bei Valkey und Redis mit JSON

Im folgenden Abschnitt wird beschrieben, wie OSS ElastiCache für Valkey und Redis mit dem JSON-Datentyp interagiert.

Rangfolge der Operatoren

Bei der Bewertung bedingter Ausdrücke zum Filtern, haben &&s zuerst Vorrang, und dann werden ||s ausgewertet, wie es in den meisten Sprachen üblich ist. Operationen innerhalb von Klammern werden zuerst ausgeführt.

Verhalten der maximalen Verschachtelungsbeschränkung

Das maximale Limit für Pfadverschachtelung ElastiCache für Redis OSS ist 128. Ein Wert wie $.a.b.c.d... kann also nur 128 Level erreichen.

Umgang mit numerischen Werten

JSON hat keine separaten Datentypen für ganze Zahlen und Gleitkommazahlen. Sie werden alle Zahlen genannt.

Numerische Repräsentationen:

Wenn eine JSON-Nummer bei der Eingabe empfangen wird, wird sie in eine der beiden internen Binärdarstellungen umgewandelt: eine 64-Bit-Ganzzahl oder eine doppelt genaue 64-Bit-Gleitkommazahl. Die Ursprüngliche Zeichenfolge und alle ihre Formatierungen werden nicht beibehalten. Wenn also eine Zahl als Teil einer JSON-Antwort ausgegeben wird, wird sie von der internen Binärdarstellung in eine druckbare Zeichenfolge konvertiert, die generische Formatierungsregeln verwendet. Diese Regeln könnten dazu führen, dass eine andere Zeichenfolge generiert wird als empfangen wurde.

Arithmetische Befehle NUMINCRBY und NUMMULTBY:

• Wenn beide Zahlen ganze Zahlen sind und das Ergebnis außerhalb des Bereichs von int64 liegt, ergibt sich daraus automatisch eine doppelt genaue 64-Bit-Gleitkommazahl.

• Wenn mindestens eine der Zahlen eine Gleitkommazahl ist, ergibt sich daraus eine doppelt genaue 64-Bit-Gleitkommazahl.

• Wenn das Ergebnis den Bereich einer doppelt genauen 64-Bit-Gleitkommazahl überschreitet, gibt der Befehl einen OVERFLOW-Fehler aus.

Eine detaillierte Liste der verfügbaren Befehle finden Sie unter Unterstützte Valkey- und Redis OSS-Befehle.

Direktes Array-Filtern

ElastiCache für Valkey oder Redis filtert OSS Array-Objekte direkt.

Bei Daten wie [0,1,2,3,4,5,6] und einer Pfadabfrage wie $[?(@<4)] oder Daten wie {"my_key":[0,1,2,3,4,5,6]} und einer Pfadabfrage wie ElastiCache würde $.my_key[?(@<4)] unter beiden Umständen [1,2,3] zurückgegeben werden.

Array-Indizierung

ElastiCache für Valkey oder Redis erlaubt OSS sowohl positive als auch negative Indizes für Arrays. Bei einem Array mit der Länge fünf würde 0 das erste Element abfragen, 1 das zweite usw. Negative Zahlen beginnen am Ende des Arrays, also würde -1 das fünfte Element abfragen, -2 das vierte Element usw.

Um ein vorhersehbares Verhalten für Kunden zu gewährleisten, werden Array-Indizes ElastiCache weder nach unten noch nach oben gerundet. Wenn Sie also ein Array mit einer Länge von 5 haben, würde der Aufruf von Index 5 oder höher oder -6 oder niedriger zu keinem Ergebnis führen.

Strikte Syntaxbewertung

MemoryDB erlaubt keine JSON-Pfade mit ungültiger Syntax, selbst wenn eine Teilmenge des Pfads einen gültigen Pfad enthält. Dies soll für unsere Kunden ein korrektes Verhalten sicherstellen.