API de résumé de graphe et de statistiques du plan de données Neptune - Amazon Neptune
GetPropertygraphStatisticsManagePropertygraphStatisticsDeletePropertygraphStatisticsGetPropertygraphSummary________________________StatistiquesStatisticsSummaryDeleteStatisticsValueMapRefreshStatisticsIdMapNodeStructureEdgeStructureSubjectStructurePropertygraphSummaryValueMapPropertygraphSummary

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 résumé de graphe et de statistiques du plan de données Neptune

Actions liées aux statistiques des graphes de propriétés :

Structures des statistiques :

GetPropertygraphStatistics (action)

        Le nom AWS CLI de cette API est : get-propertygraph-statistics.

Obtient les statistiques du graphe de propriétés (Gremlin et 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:GetStatisticsStatus dans ce cluster.

Demande

  • Aucun paramètre de demande.

Réponse

  • payload : obligatoire : objet Statistiques.

    Statistiques pour les données du graphe de propriétés.

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

    Code de retour HTTP de la demande. Si la demande aboutit, le code est 200. Consultez la section Codes d'erreur courants pour les demandes de statistiques DFE pour obtenir une liste des erreurs courantes.

Erreurs

ManagePropertygraphStatistics (action)

        Le nom AWS CLI de cette API est : manage-propertygraph-statistics.

Gère la génération et l'utilisation des statistiques des graphes de propriétés.

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:ManageStatistics dans ce cluster.

Demande

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

    Mode de génération des statistiques. Correspond à DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE ou REFRESH (le dernier mode déclenche manuellement la génération de statistiques DFE).

Réponse

  • payload : objet RefreshStatisticsIdMap.

    N'est renvoyé que pour le mode d'actualisation.

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

    Code de retour HTTP de la demande. Si la demande aboutit, le code est 200.

Erreurs

DeletePropertygraphStatistics (action)

        Le nom AWS CLI de cette API est : delete-propertygraph-statistics.

Supprime les statistiques pour les données Gremlin et openCypher (graphe de propriétés).

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:DeleteStatistics dans ce cluster.

Demande

  • Aucun paramètre de demande.

Réponse

  • payload : objet DeleteStatisticsValueMap.

    Charge utile de la suppression.

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

    Statut d'annulation.

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

    Code de réponse HTTP 200 si la suppression a réussi, ou 204 s'il n'y avait aucune statistique à supprimer.

Erreurs

GetPropertygraphSummary (action)

        Le nom AWS CLI de cette API est : get-propertygraph-summary.

Génère un résumé de graphe de propriétés.

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:GetGraphSummary dans ce cluster.

Demande

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

    Le mode peut prendre l'une des deux valeurs suivantes : BASIC (valeur par défaut) et DETAILED.

Réponse

  • payload : objet PropertygraphSummaryValueMap.

    Charge utile contenant la réponse de résumé de graphe de propriétés.

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

    Code de retour HTTP de la demande. Si la demande aboutit, le code est 200.

Erreurs

Structures des statistiques :

Statistics (structure)

Contient des informations statistiques. Le moteur DFE utilise les informations relatives aux données d'un graphe Neptune pour effectuer des compromis efficaces lors de la planification de l'exécution des requêtes. Ces informations prennent la forme de statistiques qui incluent ce que l'on appelle des ensembles de caractéristiques et des statistiques de prédicats qui contribuent à guider la planification des requêtes. Consultez Gestion des statistiques à utiliser par le DFE Neptune.

Champs

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

    Indique si la génération des statistiques est activée.

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

    Indique si la génération automatique des statistiques est activée ou non.

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

    Heure UTC à laquelle les statistiques DFE ont été générées pour la dernière fois.

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

    Remarque concernant les problèmes liés à la non-validité des statistiques.

  • signatureInfo : objet StatisticsSummary.

    Structure StatisticsSummary qui contient :

    • signatureCount : nombre total de signatures pour tous les ensembles de caractéristiques.

    • instanceCount : nombre total d'instances d'ensembles de caractéristiques.

    • predicateCount : nombre total de prédicats uniques.

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

    Indique l'ID de la génération de statistiques en cours d'exécution. La valeur -1 indique qu'aucune statistique n'a été générée.

StatisticsSummary (structure)

Informations sur les ensembles de caractéristiques générés dans les statistiques.

Champs

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

    Nombre total d'instances d'ensembles de caractéristiques.

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

    Nombre total de prédicats uniques.

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

    Nombre total de signatures pour tous les ensembles de caractéristiques.

DeleteStatisticsValueMap (structure)

Charge utile pour DeleteStatistics.

Champs

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

    Statut actuel des statistiques.

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

    ID d'exécution de la génération de statistiques en cours.

RefreshStatisticsIdMap (structure)

Statistiques pour le mode REFRESH.

Champs

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

    ID d'exécution de la génération de statistiques en cours.

NodeStructure (structure)

Structure d'un nœud.

Champs

  • count : long de type : long (entier signé de 64 bits).

    Nombre de nœuds dotés de cette structure spécifique.

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

    Liste des différentes étiquettes d'arête sortantes présentes dans cette structure spécifique.

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

    Liste des propriétés de nœud présentes dans cette structure spécifique.

EdgeStructure (structure)

Structure d'une arête.

Champs

  • count : long de type : long (entier signé de 64 bits).

    Nombre d'arêtes dotées de cette structure spécifique.

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

    Liste des propriétés d'arête présentes dans cette structure spécifique.

SubjectStructure (structure)

Structure de sujet.

Champs

  • count : long de type : long (entier signé de 64 bits).

    Nombre d'occurrences de cette structure spécifique.

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

    Liste des prédicats présents dans cette structure spécifique.

PropertygraphSummaryValueMap (structure)

Charge utile de la réponse de résumé de graphe de propriétés.

Champs

  • graphSummary : objet PropertygraphSummary.

    Résumé du graphe.

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

    Horodatage, au format ISO 8601, indiquant l'heure à laquelle Neptune a calculé ses statistiques pour la dernière fois.

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

    Version de la réponse de résumé de graphe.

PropertygraphSummary (structure)

L'API de résumé de graphe renvoie une liste en lecture seule des étiquettes et des clés de propriété des nœuds et des arêtes, ainsi que le nombre de nœuds, d'arêtes et de propriétés. Consultez Réponse de résumé pour un graphe de propriétés (PG).

Champs

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

    Liste des étiquettes d'arête distinctes dans le graphe.

  • edgeProperties : objets LongValuedMap. Il s'agit d'un tableau de mappage de paires clé-valeur où :

        Chaque clé est une chaîne de type : string (chaîne encodée en UTF-8).

        Chaque valeur est un long de type : long (entier signé de 64 bits).

    Liste des propriétés d'arêtes distinctes dans le graphe et nombre d'arêtes où chaque propriété est utilisée.

  • edgeStructures : tableau d'objets EdgeStructure.

    Ce champ n'est présent que lorsque le mode demandé est DETAILED. Contient une liste des structures d'arête.

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

    Liste des étiquettes de nœud distinctes dans le graphe.

  • nodeProperties : objets LongValuedMap. Il s'agit d'un tableau de mappage de paires clé-valeur où :

        Chaque clé est une chaîne de type : string (chaîne encodée en UTF-8).

        Chaque valeur est un long de type : long (entier signé de 64 bits).

    Nombre de propriétés de nœuds distinctes dans le graphe.

  • nodeStructures : tableau d'objets NodeStructure.

    Ce champ n'est présent que lorsque le mode demandé est DETAILED. Contient une liste des structures de nœud.

  • numEdgeLabels : long de type : long (entier signé de 64 bits).

    Nombre d'étiquettes d'arête distinctes dans le graphe.

  • numEdgeProperties : long de type : long (entier signé de 64 bits).

    Nombre de propriétés d'arêtes distinctes dans le graphe.

  • numEdges : long de type : long (entier signé de 64 bits).

    Nombre d'arêtes dans le graphe.

  • numNodeLabels : long de type : long (entier signé de 64 bits).

    Nombre d'étiquettes de nœuds distinctes dans le graphe.

  • numNodeProperties : long de type : long (entier signé de 64 bits).

    Liste des propriétés de nœud distinctes dans le graphe et nombre de nœuds où chaque propriété est utilisée.

  • numNodes : long de type : long (entier signé de 64 bits).

    Nombre de nœuds dans le graphe.

  • totalEdgePropertyValues : long de type : long (entier signé de 64 bits).

    Nombre total d'utilisations de toutes les propriétés d'arête.

  • totalNodePropertyValues : long de type : long (entier signé de 64 bits).

    Nombre total d'utilisations de toutes les propriétés de nœud.