API de requêtes Neptune - Amazon Neptune
ExecuteGremlinQueryExecuteGremlinExplainQueryExecuteGremlinProfileQueryListGremlinQueriesGetGremlinQueryStatusCancelGremlinQuery________________________ExecuteOpenCypherQueryExecuteOpenCypherExplainQueryListOpenCypherQueriesGetOpenCypherQueryStatusCancelOpenCypherQuery________________________QueryEvalStatsGremlinQueryStatusGremlinQueryStatusAttributes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API de requêtes Neptune

Actions de requête Gremlin :

Actions de requête openCypher :

Structures des requêtes :

ExecuteGremlinQuery (action)

        Le nom AWS CLI de cette API est : execute-gremlin-query.

Cette commande exécute une requête Gremlin. Amazon Neptune est compatible avec Apache TinkerPop3 et Gremlin. Vous pouvez donc utiliser le langage de traversée Gremlin pour interroger le graphe, comme décrit dans la section The Graph de la documentation d'Apache TinkerPOP3. Plus d'informations sont également disponibles dans Accès à un graphe Neptune avec Gremlin.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant les actions IAM suivantes dans ce cluster, en fonction de la requête :

Notez que la clé de condition IAM neptune-db:QueryLanguage:Gremlin peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes Gremlin (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • gremlinQuery (dans la CLI : --gremlin-query) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    À l'aide de cette API, vous pouvez exécuter des requêtes Gremlin au format chaîne comme vous pouvez le faire avec le point de terminaison HTTP. L'interface est compatible n'importe quelle version Gremlin utilisée par le cluster de bases de données (consultez la section du client Tinkerpop pour déterminer les versions de Gremlin prises en charge par votre version de moteur).

  • serializer (dans la CLI : --serializer) : chaîne de type : string (chaîne encodée en UTF-8).

    Si la valeur du paramètre est autre que null, les résultats de requête sont renvoyés dans un message de réponse sérialisé au format spécifié par ce paramètre. Consultez la section GraphSON de la documentation TinkerPop pour obtenir la liste des formats actuellement pris en charge.

Réponse

  • meta : document de type : document (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON).

    Métadonnées relatives à la requête Gremlin.

  • requestId : chaîne de type : string (chaîne encodée en UTF-8).

    Identifiant unique de la requête Gremlin.

  • result : document de type : document (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON).

    Requête Gremlin générée par le serveur.

  • status : objet GremlinQueryStatusAttributes.

    Statut de la requête Gremlin.

Erreurs

ExecuteGremlinExplainQuery (action)

        Le nom AWS CLI de cette API est : execute-gremlin-explain-query.

Exécute une requête Gremlin Explain.

Amazon Neptune a ajouté une fonctionnalité Gremlin nommée explain qui fournit un outil en libre-service permettant de comprendre l'approche d'exécution adoptée par le moteur Neptune pour la requête. Vous l'appelez en ajoutant un paramètre explain à un appel HTTP qui soumet une requête Gremlin.

La fonctionnalité explain fournit des informations sur la structure logique des plans d'exécution de requête. Vous pouvez utiliser ces informations pour identifier les goulots d'étranglement potentiels liés à l'évaluation et à l'exécution et pour régler votre requête, comme expliqué dans la section Réglage des requêtes Gremlin. Vous pouvez aussi utiliser des indicateurs de requête pour améliorer les plans d'exécution de requêtes.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique qui autorise les actions IAM suivantes dans ce cluster, en fonction de la requête :

Notez que la clé de condition IAM neptune-db:QueryLanguage:Gremlin peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes Gremlin (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • gremlinQuery (dans la CLI : --gremlin-query) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de requête Gremlin explain.

Réponse

  • output : objet ReportAsText de type : blob (bloc de données binaires non interprétées).

    Blob de texte contenant le résultat de la fonctionnalité explain de Gremlin, comme décrit dans la section Réglage des requêtes Gremlin.

Erreurs

ExecuteGremlinProfileQuery (action)

        Le nom AWS CLI de cette API est : execute-gremlin-profile-query.

Effectue une requête Gremlin Profile, qui effectue une traversée Gremlin spécifique, collecte différentes métriques sur l'exécution et génère en sortie un rapport de profil. Consultez API de profil Gremlin dans Neptune pour plus d'informations.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:ReadDataViaQuery dans ce cluster.

Notez que la clé de condition IAM neptune-db:QueryLanguage:Gremlin peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes Gremlin (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • chop (dans la CLI : --chop) : entier de type : integer (entier signé de 32 bits).

    Si la valeur du paramètre est différente de zéro, la chaîne de résultats est tronquée à ce nombre de caractères. Si la valeur est zéro, la chaîne contient tous les résultats.

  • gremlinQuery (dans la CLI : --gremlin-query) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de requête Gremlin à profiler.

  • indexOps (dans la CLI : --index-ops) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Si cet indicateur est défini sur TRUE, les résultats comprennent un rapport détaillé de toutes les opérations d'index qui ont eu lieu au cours de l'exécution et de la sérialisation des requêtes.

  • results (dans la CLI : --results) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Si cet indicateur est défini sur TRUE, les résultats de la requête sont collectés et affichés dans le rapport de profil. En cas de valeur FALSE, seul le nombre de résultats s'affiche.

  • serializer (dans la CLI : --serializer) : chaîne de type : string (chaîne encodée en UTF-8).

    Si la valeur du paramètre est différente de null, les résultats collectés sont renvoyés dans un message de réponse sérialisé au format spécifié par ce paramètre. Consultez l'API de profil Gremlin dans Neptune pour plus d'informations.

Réponse

  • output : objet ReportAsText de type : blob (bloc de données binaires non interprétées).

    Blob de texte contenant le résultat de Gremlin Profile. Consultez API de profil Gremlin dans Neptune pour plus d'informations.

Erreurs

ListGremlinQueries (action)

        Le nom AWS CLI de cette API est : list-gremlin-queries.

Répertorie les requêtes Gremlin actives. Consultez la section API de statut des requêtes Gremlin pour plus d'informations sur le résultat.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:GetQueryStatus dans ce cluster.

Notez que la clé de condition IAM neptune-db:QueryLanguage:Gremlin peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes Gremlin (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • includeWaiting (dans la CLI : --include-waiting) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Si ce paramètre est défini sur TRUE, la liste renvoyée inclut les requêtes en attente. La valeur par défaut est FALSE.

Réponse

  • acceptedQueryCount : entier de type : integer (entier signé de 32 bits).

    Nombre de requêtes qui ont été acceptées mais qui n'ont pas encore été terminées, y compris les requêtes dans la file d'attente.

  • queries : tableau d'objets GremlinQueryStatus.

    Liste des requêtes actuelles.

  • runningQueryCount : entier de type : integer (entier signé de 32 bits).

    Nombre de requêtes Gremlin actuellement en cours d'exécution.

Erreurs

GetGremlinQueryStatus (action)

        Le nom AWS CLI de cette API est : get-gremlin-query-status.

Génère le statut d'une requête Gremlin spécifiée.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:GetQueryStatus dans ce cluster.

Notez que la clé de condition IAM neptune-db:QueryLanguage:Gremlin peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes Gremlin (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • queryId (dans la CLI : --query-id) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Identifiant unique de la requête Gremlin.

Réponse

  • queryEvalStats : objet QueryEvalStats.

    Statut d'évaluation de la requête Gremlin.

  • queryId : chaîne de type : string (chaîne encodée en UTF-8).

    ID de la requête dont le statut est renvoyé.

  • queryString : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de requête Gremlin.

Erreurs

CancelGremlinQuery (action)

        Le nom AWS CLI de cette API est : cancel-gremlin-query.

Annule une requête Gremlin. Pour plus d'informations, consultez la section Annulation de requêtes Gremlin.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:CancelQuery dans ce cluster.

Demande

  • queryId (dans la CLI : --query-id) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Identifiant unique de la requête à annuler.

Réponse

  • status : chaîne de type : string (chaîne encodée en UTF-8).

    Statut de l'annulation.

Erreurs

Actions de requête openCypher :

ExecuteOpenCypherQuery (action)

        Le nom AWS CLI de cette API est : execute-open-cypher-query.

Exécute une requête openCypher. Consultez Accès au graphe de Neptune avec openCypher pour plus d'informations.

Neptune prend en charge la création d'applications de graphe à l'aide d'openCypher, qui est actuellement l'un des langages de requête les plus populaires parmi les développeurs travaillant avec des bases de données orientées graphe. Les développeurs, les analystes et les scientifiques des données apprécient la syntaxe déclarative openCypher inspirée de SQL, car sa structure familière facilite l'interrogation des graphes de propriétés.

Le langage openCypher a été initialement développé par Neo4j, puis est devenu open source en 2015 et a contribué au projet openCypher sous une licence open source Apache 2.

Notez que lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique qui autorise les actions IAM suivantes dans ce cluster, en fonction de la requête :

Notez aussi que la clé de condition IAM neptune-db:QueryLanguage:OpenCypher peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes openCypher (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • openCypherQuery (dans la CLI : --open-cypher-query) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de requête openCypher à exécuter.

  • parameters (dans la CLI : --parameters) : chaîne de type : string (chaîne encodée en UTF-8).

    Paramètres de requête openCypher pour l'exécution des requêtes. Pour plus d'informations, consultez Exemples de requêtes paramétrées openCypher.

Réponse

  • results : obligatoire : document de type : document (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON).

    Résultats de la requête openCypher.

Erreurs

ExecuteOpenCypherExplainQuery (action)

        Le nom AWS CLI de cette API est : execute-open-cypher-explain-query.

Exécute une demande explain openCypher. Pour plus d'informations, consultez Fonctionnalité explain d'openCypher.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:ReadDataViaQuery dans ce cluster.

Notez que la clé de condition IAM neptune-db:QueryLanguage:OpenCypher peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes openCypher (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • explainMode (dans la CLI : --explain-mode) : obligatoire : élément OpenCypherExplainMode de type : string (chaîne encodée en UTF-8).

    Mode explain openCypher. Peut avoir l'une des valeurs suivantes : static, dynamic ou details.

  • openCypherQuery (dans la CLI : --open-cypher-query) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de requête openCypher.

  • parameters (dans la CLI : --parameters) : chaîne de type : string (chaîne encodée en UTF-8).

    Paramètres de requête openCypher.

Réponse

  • results : obligatoire : blob de type : blob (bloc de données binaires non interprétées).

    Blob de texte contenant les résultats explain openCypher.

Erreurs

ListOpenCypherQueries (action)

        Le nom AWS CLI de cette API est : list-open-cypher-queries.

Répertorie les requêtes openCypher actives. Consultez la section Point de terminaison d'état Neptune openCypher pour plus d'informations.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:GetQueryStatus dans ce cluster.

Notez que la clé de condition IAM neptune-db:QueryLanguage:OpenCypher peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes openCypher (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • includeWaiting (dans la CLI : --include-waiting) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Lorsque ce paramètre est défini sur TRUE et qu'aucun autre paramètre n'est présent, des informations d'état sont renvoyées pour les requêtes en attente ainsi que pour les requêtes en cours d'exécution.

Réponse

  • acceptedQueryCount : entier de type : integer (entier signé de 32 bits).

    Nombre de requêtes qui ont été acceptées mais qui n'ont pas encore été terminées, y compris les requêtes dans la file d'attente.

  • queries : tableau d'objets GremlinQueryStatus.

    Liste des requêtes openCypher en cours.

  • runningQueryCount : entier de type : integer (entier signé de 32 bits).

    Nombre de requêtes openCypher en cours d'exécution.

Erreurs

GetOpenCypherQueryStatus (action)

        Le nom AWS CLI de cette API est : get-open-cypher-query-status.

Récupère le statut d'une requête openCypher spécifiée.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:GetQueryStatus dans ce cluster.

Notez que la clé de condition IAM neptune-db:QueryLanguage:OpenCypher peut être utilisée dans le document de stratégie pour restreindre l'utilisation des requêtes openCypher (voir Clés de condition disponibles dans les déclarations de stratégie d'accès aux données de Neptune IAM).

Demande

  • queryId (dans la CLI : --query-id) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    ID unique de la requête openCypher pour laquelle le statut de la requête doit être récupéré.

Réponse

  • queryEvalStats : objet QueryEvalStats.

    Statut de l'évaluation de la requête openCypher.

  • queryId : chaîne de type : string (chaîne encodée en UTF-8).

    ID unique de la requête dont le statut est renvoyé.

  • queryString : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de requête openCypher.

Erreurs

CancelOpenCypherQuery (action)

        Le nom AWS CLI de cette API est : cancel-open-cypher-query.

Annule une requête openCypher spécifiée. Consultez la section Point de terminaison d'état Neptune openCypher pour plus d'informations.

Lorsque vous invoquez cette opération dans un cluster Neptune pour lequel l'authentification IAM est activée, l'utilisateur ou le rôle IAM à l'origine de la demande doit être associé à une politique autorisant l'action IAM neptune-db:CancelQuery dans ce cluster.

Demande

  • queryId (dans la CLI : --query-id) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    ID unique de la requête openCypher à annuler.

  • silent (dans la CLI : --silent) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Si ce paramètre est défini sur TRUE, l'annulation de la requête openCypher se produit silencieusement.

Réponse

  • payload : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Charge utile d'annulation pour la requête openCypher.

  • status : chaîne de type : string (chaîne encodée en UTF-8).

    Statut d'annulation de la requête openCypher.

Erreurs

Structures des requêtes :

QueryEvalStats (structure)

Structure permettant de saisir les statistiques relatives aux requêtes, telles que le nombre de requêtes en cours, acceptées ou en attente, ainsi que leurs détails.

Champs

  • cancelled : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Valeur définie sur TRUE si la requête a été annulée, ou sur FALSE dans le cas contraire.

  • elapsed : entier de type : integer (entier signé de 32 bits).

    Nombre de microsecondes d'exécution de la requête jusqu'ici.

  • subqueries : document de type : document (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON).

    Nombre de sous-requêtes de cette requête.

  • waited : entier de type : integer (entier signé de 32 bits).

    Indique le temps d'attente de la requête, en millisecondes.

GremlinQueryStatus (structure)

Capture le statut d'une requête Gremlin (voir la page API de statut des requêtes Gremlin).

Champs

  • queryEvalStats : objet QueryEvalStats.

    Statistiques de la requête Gkremlin.

  • queryId : chaîne de type : string (chaîne encodée en UTF-8).

    ID de la requête Gremlin.

  • queryString : chaîne de type : string (chaîne encodée en UTF-8).

    Chaîne de la requête Gremlin.

GremlinQueryStatusAttributes (structure)

Contient les composants de statut d'une requête Gremlin.

Champs

  • attributes : document de type : document (contenu ouvert indépendant du protocole représenté par un modèle de données de type JSON).

    Attributs du statut de la requête Gremlin.

  • code : entier de type : integer (entier signé de 32 bits).

    Code de réponse HTTP renvoyé par la demande de requête Gremlin.

  • message : chaîne de type : string (chaîne encodée en UTF-8).

    Message d'état.