Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Neptune-Abfrage-APIs
Gremlin-Abfrageaktionen:
openCypher-Abfrageaktionen:
Abfragestrukturen:
ExecuteGremlinQuery (Aktion)
Der AWS CLI-Name für diese API lautet: execute-gremlin-query.
Mit diesem Befehl wird eine Gremlin-Abfrage ausgeführt. Amazon Neptune ist mit Apache TinkerPOP3 und Gremlin kompatibel, sodass Sie die Gremlin Traversal Language verwenden können, um das Diagramm abzufragen; siehe hierzu The Graph
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die je nach Abfrage eine der folgenden IAM-Aktionen in diesem Cluster zulässt:
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:Gremlin im Richtliniendokument verwendet werden kann, um die Verwendung von Gremlin-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
gremlinQuery (in der CLI:
--gremlin-query) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Mit dieser API können Sie Gremlin-Abfragen im Zeichenfolgenformat ausführen, ebenso können Sie den HTTP-Endpunkt verwenden. Die Schnittstelle ist mit jeder Gremlin-Version kompatibel, die Ihr DB-Cluster verwendet (im Abschnitt Tinkerpop-Client finden Sie Informationen zur unterstützten Gremlin-Version Ihrer Engine).
-
serializer (in der CLI:
--serializer) – eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Wenn der Wert nicht null ist, werden die Abfrageergebnisse in einer serialisierten Antwortnachricht in dem von diesem Parameter angegebenen Format zurückgegeben. Im Abschnitt GraphSON
in der TinkerPop-Dokumentation finden Sie eine Liste der derzeit unterstützten Formate.
Antwort
-
meta – Dokument vom Typ
document(protokollunabhängiger offener Inhalt, der durch ein JSON-ähnliches Datenmodell repräsentiert wird).Metadaten zur Gremlin-Abfrage.
-
requestId – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die eindeutige Kennung der Gremlin-Abfrage.
-
result – Dokument vom Typ
document(protokollunabhängiger offener Inhalt, der durch ein JSON-ähnliches Datenmodell repräsentiert wird).Die Ausgabe der Gremlin-Abfrage des Servers.
-
status – Ein GremlinQueryStatusAttributes-Objekt.
Der Status der Gremlin-Abfrage.
Fehler
ExecuteGremlinExplainQuery (Aktion)
Der AWS CLI-Name für diese API lautet: execute-gremlin-explain-query.
Führt eine Gremlin-Explain-Abfrage aus.
Amazon Neptune hat eine Gremlin-Funktion mit dem Namen explain hinzugefügt, die ein Self-Service-Tool bereitstellt, mit dem Sie den Ausführungsansatz verstehen können, den die Neptune-Engine für die Abfrage verwendet. Sie rufen diese Funktion auf, indem Sie einem HTTP-Aufruf, der eine Gremlin-Abfrage sendet, einen explain-Parameter hinzufügen.
Die Explain-Funktion bietet Informationen zur logischen Struktur von Abfrageausführungsplänen. So können Sie potenzielle Engpässe bei Bewertung und Ausführung identifizieren und Ihre Abfrage optimieren, wie in Optimieren von Gremline-Abfragen beschrieben. Anschließend können Sie mit Abfragehinweisen die Abfrageausführungspläne verbessern.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die je nach Abfrage eine der folgenden IAM-Aktionen in diesem Cluster zulässt:
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:Gremlin im Richtliniendokument verwendet werden kann, um die Verwendung von Gremlin-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
gremlinQuery (in der CLI:
--gremlin-query) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die Zeichenfolge für die Gremlin-Explain-Abfrage.
Antwort
-
output – ReportAsText vom Typ
blob(ein Block mit nichtinterpretierten Binärdaten).Ein Textblob, der das Ergebnis der Gremlin-Explain-Abfrage enthält, wie unter Optimieren von Gremlin-Abfragen beschrieben.
Fehler
ExecuteGremlinProfileQuery (Aktion)
Der AWS CLI-Name für diese API lautet: execute-gremlin-profile-query.
Führt eine Gremlin-Profile-Abfrage aus, die eine bestimmte Transversale ausführt, erfasst verschiedene Metriken über den Durchlauf und erstellt einen Profilbericht als Ausgabe. Einzelheiten finden Sie unter Gremlin-Profil-API in Neptune.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:ReadDataViaQuery in diesem Cluster zulässt.
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:Gremlin im Richtliniendokument verwendet werden kann, um die Verwendung von Gremlin-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
chop (in der CLI:
--chop) – Ganzzahl vom Typinteger(32-Bit-Ganzzahl mit Vorzeichen).Wenn der Wert nicht Null ist, wird die Ergebniszeichenfolge mit dieser Anzahl von Zeichen abgeschnitten. Wenn auf Null gesetzt, enthält die Zeichenfolge alle Ergebnisse.
-
gremlinQuery (in der CLI:
--gremlin-query) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die Gremlin-Abfragezeichenfolge für das Profil.
-
indexOps (in der CLI:
--index-ops) – boolescher Wert vom Typboolean(boolescher Wert (wahr oder falsch)).Wenn dieses Flag auf
TRUEeingestellt ist, enthalten die Ergebnisse einen detaillierten Bericht aller Indexoperationen, die während der Abfrageausführung und -serialisierung durchgeführt wurden. -
results (in der CLI:
--results) – boolescher Wert vom Typboolean(boolescher Wert (wahr oder falsch)).Wenn dieses Flag auf
TRUEeingestellt ist, werden die Abfrageergebnisse gesammelt und als Teil des Profilberichts angezeigt. BeiFALSEwird nur die Ergebnisanzahl angezeigt. -
serializer (in der CLI:
--serializer) – eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Wenn der Wert nicht null ist, werden die gesammelten Ergebnisse in einer serialisierten Antwortnachricht in dem von diesem Parameter angegebenen Format zurückgegeben. Weitere Informationen finden Sie unter Gremlin-Profil-API in Neptune.
Antwort
-
output – ReportAsText vom Typ
blob(ein Block mit nichtinterpretierten Binärdaten).Ein Textblob, der das Ergebnis des Gremlin-Profils enthält. Einzelheiten finden Sie unter Gremlin-Profil-API in Neptune.
Fehler
ListGremlinQueries (Aktion)
Der AWS CLI-Name für diese API lautet: list-gremlin-queries.
Listet aktive Gremlin-Abfragen auf. Einzelheiten zur Ausgabe finden Sie unter Gremlin-Abfragestatus-API.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:GetQueryStatus in diesem Cluster zulässt.
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:Gremlin im Richtliniendokument verwendet werden kann, um die Verwendung von Gremlin-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
includeWaiting (in der CLI:
--include-waiting) – boolescher Wert vom Typboolean(boolescher Wert (wahr oder falsch)).Bei
TRUEenthält die zurückgegebene Liste wartende Abfragen. Der Standardwert istFALSE;
Antwort
-
acceptedQueryCount – eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Die Anzahl der Abfragen, die akzeptiert, aber noch nicht abgeschlossen wurden, einschließlich der Abfragen in der Warteschlange.
-
queries – Ein Array mit GremlinQueryStatus-Objekten.
Eine Liste der aktuellen Abfragen.
-
runningQueryCount – eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Die Anzahl der derzeit laufenden Gremlin-Abfragen.
Fehler
GetGremlinQueryStatus (Aktion)
Der AWS CLI-Name für diese API lautet: get-gremlin-query-status.
Ruft den Status einer angegebenen Gremlin-Abfrage ab.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:GetQueryStatus in diesem Cluster zulässt.
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:Gremlin im Richtliniendokument verwendet werden kann, um die Verwendung von Gremlin-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
queryId (in der CLI:
--query-id) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die eindeutige Kennung der Gremlin-Abfrage.
Antwort
-
queryEvalStats – Ein QueryEvalStats-Objekt.
Der Auswertungsstatus der Gremlin-Abfrage.
-
queryId – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die ID der Abfrage, für die der Status zurückgegeben wird.
-
queryString – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die Gremlin-Abfragezeichenfolge.
Fehler
CancelGremlinQuery (Aktion)
Der AWS CLI-Name für diese API lautet: cancel-gremlin-query.
Bricht eine Gremlin-Abfrage ab. Weitere Informationen finden Sie unter Gremlin-Abfrageabbruch.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:CancelQuery in diesem Cluster zulässt.
Anforderung
-
queryId (in der CLI:
--query-id) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die eindeutige Kennung der abzubrechenden Abfrage.
Antwort
-
status – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Der Status des Abbruchs.
Fehler
openCypher-Abfrageaktionen:
ExecuteOpenCypherQuery (Aktion)
Der AWS CLI-Name für diese API lautet: execute-open-cypher-query.
Führt eine openCypher-Abfrage aus. Weitere Informationen finden Sie unter Zugriff auf das Neptun-Diagramm mit openCypher.
Neptune unterstützt die Erstellung von Diagrammanwendungen mit openCypher, die zu den zurzeit beliebtesten Abfragesprachen für Entwickler gehört, die mit Graphdatenbanken arbeiten. Entwickler, Geschäftsanalysten und Datenwissenschaftler schätzen die SQL-inspirierte Syntax von openCypher, weil sie eine vertraute Struktur für das Verfassen von Abfragen für Eigenschaftsdiagramme bietet.
Die Abfragesprache openCypher wurde ursprünglich von Neo4j entwickelt, 2015 als Open-Source-Software veröffentlicht und ist unter einer Apache 2-Open-Source-Lizenz für das openCypher-Projekt
Hinweis: Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die je nach Abfrage eine der folgenden IAM-Aktionen in diesem Cluster zulässt:
Beachten Sie außerdem, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:OpenCypher im Richtliniendokument verwendet werden kann, um die Verwendung von openCypher-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
openCypherQuery (in der CLI:
--open-cypher-query) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die openCypher-Abfragezeichenfolge, die ausgeführt werden soll.
-
parameters (in der CLI:
--parameters) – eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die openCypher-Abfrageparameter für die Ausführung der Abfrage. Weitere Informationen finden Sie unter Beispiele für parametrisierte openCypher-Abfragen.
Antwort
-
results – Erforderlich Dokument vom Typ
document(protokollunabhängiger offener Inhalt, der durch ein JSON-ähnliches Datenmodell repräsentiert wird).Die openCypherquery-Ergebnisse.
Fehler
ExecuteOpenCypherExplainQuery (Aktion)
Der AWS CLI-Name für diese API lautet: execute-open-cypher-explain-query.
Führt eine openCypher-explain-Abfrage aus. Weitere Informationen finden Sie unter Die openCypher-Explain-Funktion.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:ReadDataViaQuery in diesem Cluster zulässt.
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:OpenCypher im Richtliniendokument verwendet werden kann, um die Verwendung von OpenCypher-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
explainMode (in der CLI:
--explain-mode) – Erforderlich: Ein OpenCypherExplainMode vom Typstring(UTF-8-kodierte Zeichenfolge).Der openCypher-
explain-Modus. Dabei kann es sich umstatic,dynamicoderdetailshandeln. -
openCypherQuery (in der CLI:
--open-cypher-query) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die openCypher-Abfragezeichenfolge.
-
parameters (in der CLI:
--parameters) – eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die openCypher-Abfrageparameter.
Antwort
-
results – Erforderlich: ein Blob vom Typ
blob(ein Block mit nichtinterpretierten Binärdaten).Ein Textblob, der die openCypher-
explain-Ergebnisse enthält.
Fehler
ListOpenCypherQueries (Aktion)
Der AWS CLI-Name für diese API lautet: list-open-cypher-queries.
Listet aktive openCypher-Abfragen auf. Weitere Informationen finden Sie unter Neptune-openCypher-Statusendpunkt.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:GetQueryStatus in diesem Cluster zulässt.
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:OpenCypher im Richtliniendokument verwendet werden kann, um die Verwendung von openCypher-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
includeWaiting (in der CLI:
--include-waiting) – boolescher Wert vom Typboolean(boolescher Wert (wahr oder falsch)).Wenn auf
TRUEfestgelegt und keine anderen Parameter vorhanden sind, werden Statusinformationen für wartende und ausgeführte Abfragen zurückgegeben.
Antwort
-
acceptedQueryCount – eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Die Anzahl der Abfragen, die akzeptiert, aber noch nicht abgeschlossen wurden, einschließlich der Abfragen in der Warteschlange.
-
queries – Ein Array mit GremlinQueryStatus-Objekten.
Eine Liste der aktuellen openCypher-Abfragen.
-
runningQueryCount – eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Die Anzahl der aktuell ausgeführten openCypher-Abfragen.
Fehler
GetOpenCypherQueryStatus (Aktion)
Der AWS CLI-Name für diese API lautet: get-open-cypher-query-status.
Ruft den Status einer angegebenen openCypher-Abfrage ab.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:GetQueryStatus in diesem Cluster zulässt.
Beachten Sie, dass der IAM-Bedingungsschlüssel neptune-db:QueryLanguage:OpenCypher im Richtliniendokument verwendet werden kann, um die Verwendung von openCypher-Abfragen einzuschränken (siehe In Neptune-IAM-Datenzugriffs-Richtlinienanweisungen verfügbare Bedingungsschlüssel).
Anforderung
-
queryId (in der CLI:
--query-id) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die eindeutige ID der openCypher-Abfrage, für die der Abfragestatus abgerufen werden soll.
Antwort
-
queryEvalStats – Ein QueryEvalStats-Objekt.
Der Evaluierungsstatus der openCypher-Abfrage.
-
queryId – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die eindeutige ID der Abfrage, für die der Status zurückgegeben wird.
-
queryString – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die openCypher-Abfragezeichenfolge.
Fehler
CancelOpenCypherQuery (Aktion)
Der AWS CLI-Name für diese API lautet: cancel-open-cypher-query.
Bricht eine angegebene openCypher-Abfrage ab. Weitere Informationen finden Sie unter Neptune-openCypher-Statusendpunkt.
Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:CancelQuery in diesem Cluster zulässt.
Anforderung
-
queryId (in der CLI:
--query-id) – Erforderlich: eine Zeichenfolge vom Typstring(UTF-8-kodierte Zeichenfolge).Die eindeutige ID der openCypher-Abfrage, die abgebrochen werden soll.
-
silent (in der CLI:
--silent) – boolescher Wert vom Typboolean(boolescher Wert (wahr oder falsch)).Wenn auf
TRUEfestgelegt, erfolgt der Abbruch der openCypher-Abfrage im Hintergrund.
Antwort
-
payload – boolescher Wert vom Typ
boolean(boolescher Wert (wahr oder falsch)).Die Abbruchnutzlast für die openCypher-Abfrage.
-
status – eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Der Abbruchstatus der openCypher-Abfrage.
Fehler
Abfragestrukturen:
QueryEvalStats (Struktur)
Struktur zur Erfassung von Abfragestatistiken, z. B. die Anzahl der ausgeführten, akzeptierten oder wartenden Abfragen sowie und deren Details.
Felder
-
cancelled – Dies ist ein boolescher Wert vom Typ
boolean(boolescher Wert (wahr oder falsch)).Wird auf
TRUEgesetzt, wenn die Abfrage abgebrochen wurde, andernfalls auf FALSE. -
elapsed – Dies ist eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Die Dauer in Mikrosekunden, die die Abfrage bis jetzt ausgeführt wurde
-
subqueries – Dies ist ein Dokument vom Typ
document(protokollunabhängiger offener Inhalt, der durch ein JSON-ähnliches Datenmodell repräsentiert wird).Die Anzahl der Unterabfragen in dieser Abfrage.
-
waited – Dies ist eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Gibt in Millisekunden an, wie lange die Abfrage gewartet hat.
GremlinQueryStatus (Struktur)
Erfasst den Status einer Gremlin-Abfrage (siehe Seite Gremlin-Abfragestatus-API).
Felder
-
queryEvalStats – Dies ist ein QueryEvalStats-Objekt.
Die Statistik der Gremlin-Abfrage.
-
queryId – Dies ist eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Der ID der Gremlin-Abfrage.
-
queryString – Dies ist eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die Zeichenfolge der Gremlin-Abfrage.
GremlinQueryStatusAttributes (Struktur)
Enthält Statuskomponenten einer Gremlin-Abfrage.
Felder
-
attributes – Dies ist ein Dokument vom Typ
document(protokollunabhängiger offener Inhalt, der durch ein JSON-ähnliches Datenmodell repräsentiert wird).Attribute des Gremlin-Abfragestatus.
-
code – Dies ist eine Ganzzahl vom Typ
integer(32-Bit-Ganzzahl mit Vorzeichen).Der von der Gremlin-Abfrageanforderung zurückgegebene HTTP-Antwortcode.
-
message – Dies ist eine Zeichenfolge vom Typ
string(UTF-8-kodierte Zeichenfolge).Die Statusmeldung.
