Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
API de consulta de Neptune
Acciones de consulta de Gremlin:
Acciones de consulta de openCypher:
Estructuras de consulta:
ExecuteGremlinQuery (acción)
El nombre de la AWS CLI para esta API es: execute-gremlin-query.
Este comando ejecuta una consulta de Gremlin. Amazon Neptune es compatible con Apache TinkerPop3 y Gremlin, por lo que puede usar el lenguaje transversal de Gremlin para consultar el gráfico, tal y como se describe en The Graph
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita una de las siguientes acciones de IAM en dicho clúster, en función de la consulta:
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:Gremlin se puede utilizar en el documento de política para restringir el uso de consultas de Gremlin (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
gremlinQuery (en la CLI:
--gremlin-query): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).Con esta API, puede ejecutar consultas de Gremlin en formato de cadena de la misma manera que con el punto de conexión HTTP. La interfaz es compatible con cualquier versión de Gremlin que utilice el clúster de base de datos (consulte la sección cliente TinkerPop para determinar las versiones de Gremlin que admite la versión del motor).
-
serializer (en la CLI:
--serializer): una cadena, del tipo:string(una cadena codificada con UTF-8).Si no es nulo, los resultados de la consulta se devuelven en un mensaje de respuesta serializado en el formato especificado por este parámetro. Consulte la sección GraphSON
en la documentación de TinkerPop para ver una lista de los formatos compatibles actualmente.
Respuesta
-
meta: un documento, del tipo:
document(un contenido abierto independiente del protocolo representado por un modelo de datos similar a JSON).Metadatos sobre la consulta de Gremlin.
-
requestId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador único de la consulta de Gremlin.
-
result: un documento, del tipo:
document(un contenido abierto independiente del protocolo representado por un modelo de datos similar a JSON).El resultado de la consulta de Gremlin del servidor.
-
status: objeto GremlinQueryStatusAttributes.
El estado de la consulta de Gremlin.
ExecuteGremlinExplainQuery (acción)
El nombre de la AWS CLI para esta API es: execute-gremlin-explain-query.
Ejecuta una consulta Explain de Gremlin.
Amazon Neptune ha añadido una característica de Gremlin denominada explain que proporciona una herramienta de autoservicio para comprender el enfoque de ejecución que adopta el motor de Neptune para la consulta. Puede invocarla añadiendo un parámetro explain a una llamada HTTP que envíe una consulta de Gremlin.
La característica explain proporciona información sobre la estructura lógica de los planes de ejecución de consultas. Puede utilizar esta información para identificar posibles obstáculos en la evaluación y la ejecución y ajustar la consulta, tal y como se explica en Ajuste de consultas de Gremlin. También puede usar sugerencias de consulta para mejorar los planes de ejecución de consultas.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita una de las siguientes acciones de IAM en dicho clúster, en función de la consulta:
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:Gremlin se puede utilizar en el documento de política para restringir el uso de consultas de Gremlin (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
gremlinQuery (en la CLI:
--gremlin-query): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La cadena de consulta Explain de Gremlin.
Respuesta
-
output: un ReportAsText, del tipo:
blob(un bloque de datos binarios sin interpretar).Un blob de texto que incluye el resultado Explain de Gremlin, tal y como se describe en Ajuste de consultas de Gremlin.
ExecuteGremlinProfileQuery (action)
El nombre de la AWS CLI para esta API es: execute-gremlin-profile-query.
Ejecuta un consulta Profile de Gremlin, que ejecuta un recorrido especificado, recopila varias métricas sobre la ejecución y genera un informe de perfil como resultado. Consulte API de perfil de Gremlin en Neptune para obtener más información.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:ReadDataViaQuery en dicho clúster.
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:Gremlin se puede utilizar en el documento de política para restringir el uso de consultas de Gremlin (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
chop (en la CLI:
--chop): un valor entero, del tipo:integer(un valor entero firmado de 32 bits).Si es distinto de cero, hace que la cadena de resultados se trunque con ese número de caracteres. Si se establece en cero, la cadena contiene todos los resultados.
-
gremlinQuery (en la CLI:
--gremlin-query): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La cadena de consulta de Gremlin para la que generar el perfil.
-
indexOps (en la CLI:
--index-ops): un booleano, del tipo:boolean(un valor booleano [true o false]).Si este indicador está establecido en
TRUE, muestra un informe detallado de todas las operaciones de índice que se realizaron durante la ejecución y serialización de consultas. -
results (en la CLI:
--results): un booleano, del tipo:boolean(un valor booleano [true o false]).Si este indicador está establecido en
TRUE, los resultados de la consulta se recopilan y se muestran como parte del informe de perfil. Si está establecido enFALSE, solo se muestra el recuento de resultados. -
serializer (en la CLI:
--serializer): una cadena, del tipo:string(una cadena codificada con UTF-8).Si no es nulo, los resultados recopilados se devuelven en un mensaje de respuesta serializado en el formato especificado por este parámetro. Consulte API de perfil de Gremlin en Neptune para obtener más información.
Respuesta
-
output: un ReportAsText, del tipo:
blob(un bloque de datos binarios sin interpretar).Un blob de texto que incluye el resultado Profile de Gremlin. Consulte API de perfil de Gremlin en Neptune para obtener más información.
ListGremlinQueries (acción)
El nombre de la AWS CLI para esta API es: list-gremlin-queries.
Muestra las consultas activas de Gremlin. Consulte API del estado de la consulta de Gremlin para obtener más información sobre el resultado.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:GetQueryStatus en dicho clúster.
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:Gremlin se puede utilizar en el documento de política para restringir el uso de consultas de Gremlin (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
includeWaiting (en la CLI:
--include-waiting): un booleano, del tipo:boolean(un valor booleano [true o false]).Si se establece en
TRUE, la lista devuelta incluye las consultas en espera. El valor predeterminado esFALSE;
Respuesta
-
acceptedQueryCount: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).El número de consultas que se han aceptado pero que aún no se han completado, incluidas las consultas en la cola.
-
queries: matriz de objetos GremlinQueryStatus.
Una lista de las consultas actuales.
-
runningQueryCount: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).El número de consultas de Gremlin que se están ejecutando actualmente.
GetGremlinQueryStatus (acción)
El nombre de la AWS CLI para esta API es: get-gremlin-query-status.
Obtiene el estado de una consulta específica de Gremlin.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:GetQueryStatus en dicho clúster.
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:Gremlin se puede utilizar en el documento de política para restringir el uso de consultas de Gremlin (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
queryId (en la CLI:
--query-id): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador único que identifica la consulta de Gremlin.
Respuesta
-
queryEvalStats: objeto QueryEvalStats.
El estado de evaluación de la consulta de Gremlin.
-
queryId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ID de la consulta cuyo estado se devuelve.
-
queryString: una cadena, del tipo:
string(una cadena codificada con UTF-8).La cadena de consulta de Gremlin.
CancelGremlinQuery (acción)
El nombre de la AWS CLI para esta API es: cancel-gremlin-query.
Cancela una consulta de Gremlin. Consulte Cancelación de consultas de Gremlin para obtener más información.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:CancelQuery en dicho clúster.
Solicitud
-
queryId (en la CLI:
--query-id): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador único que identifica la consulta que se va a cancelar.
Respuesta
-
status: una cadena, del tipo:
string(una cadena codificada con UTF-8).El estado de la cancelación
Acciones de consulta de openCypher:
ExecuteOpenCypherQuery (acción)
El nombre de la AWS CLI para esta API es: execute-open-cypher-query.
Ejecuta una consulta de openCypher. Consulte Acceso al gráfico de Neptune con openCypher para obtener más información.
Neptune permite crear aplicaciones de gráficos mediante openCypher, que actualmente es uno de los lenguajes de consulta más populares entre los desarrolladores que trabajan con bases de datos de gráficos. A los desarrolladores, analistas empresariales y científicos de datos les gusta la sintaxis declarativa de openCypher, inspirada en SQL, ya que proporciona una estructura conocida para consultar gráficos de propiedades.
Neo4j desarrolló originalmente el lenguaje de openCyperh y que pasó a ser de código abierto en 2015. Además, contribuyó al proyecto openCypher
Tenga en cuenta que al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita una de las acciones de IAM en dicho clúster, en función de la consulta:
Además, tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:OpenCypher se puede utilizar en el documento de política para restringir el uso de consultas de openCypher (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
openCypherQuery (en la CLI:
--open-cypher-query): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La cadena de consulta de openCypher que se va a ejecutar.
-
parameters (en la CLI:
--parameters): una cadena, del tipo:string(una cadena codificada con UTF-8).Los parámetros de consulta de openCypher para la ejecución de consultas. Consulte Ejemplos de consultas parametrizadas de openCypher para obtener más información.
Respuesta
-
results: obligatorio: un documento, del tipo:
document(un contenido abierto independiente del protocolo representado por un modelo de datos similar a JSON).Los resultados de la consulta de openCypherquery.
ExecuteOpenCypherExplainQuery (acción)
El nombre de la AWS CLI para esta API es: execute-open-cypher-explain-query.
Ejecuta una solicitud explain de openCypher. Consulte La característica Explain de openCypher para obtener más información.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:ReadDataViaQuery en dicho clúster.
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:OpenCypher se puede utilizar en el documento de política para restringir el uso de consultas de openCypher (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
explainMode (en la CLI:
--explain-mode): obligatorio: un valor OpenCypherExplainMode, del tipo:string(una cadena codificada con UTF-8).El modo
explainde openCypher. Puede ser:static,dynamicodetails. -
openCypherQuery (en la CLI:
--open-cypher-query): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La cadena de consulta de openCypher.
-
parameters (en la CLI:
--parameters): una cadena, del tipo:string(una cadena codificada con UTF-8).Los parámetros de consulta de openCypher.
Respuesta
-
results: obligatorio: un blob, del tipo:
blob(un bloque de datos binarios sin interpretar).Un blob de texto que incluye los resultados
explainde openCypher.
ListOpenCypherQueries (acción)
El nombre de la AWS CLI para esta API es: list-open-cypher-queries.
Muestra las consultas activas de openCypher. Consulte Punto de conexión de estado de openCypher en Neptune para obtener más información.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:GetQueryStatus en dicho clúster.
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:OpenCypher se puede utilizar en el documento de política para restringir el uso de consultas de openCypher (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
includeWaiting (en la CLI:
--include-waiting): un booleano, del tipo:boolean(un valor booleano [true o false]).Cuando se establece en
TRUEy otros parámetros no están presentes, se devuelve la información de estado tanto para las consultas en espera como para las consultas en ejecución.
Respuesta
-
acceptedQueryCount: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).El número de consultas que se han aceptado pero que aún no se han completado, incluidas las consultas en la cola.
-
queries: matriz de objetos GremlinQueryStatus.
Una lista de las consultas actuales de openCypher.
-
runningQueryCount: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).El número de consultas de openCypher que se están ejecutando actualmente.
GetOpenCypherQueryStatus (acción)
El nombre de la AWS CLI para esta API es: get-open-cypher-query-status.
Recupera el estado de una consulta específica de openCypher.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:GetQueryStatus en dicho clúster.
Tenga en cuenta que la clave de condición de IAM neptune-db:QueryLanguage:OpenCypher se puede utilizar en el documento de política para restringir el uso de consultas de openCypher (consulte Claves de condición disponibles en las declaraciones de políticas de acceso a datos de IAM de Neptune).
Solicitud
-
queryId (en la CLI:
--query-id): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El ID único de la consulta de openCypher del que se va a recuperar el estado de la consulta.
Respuesta
-
queryEvalStats: objeto QueryEvalStats.
El estado de evaluación de la consulta de openCypher.
-
queryId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ID único de la consulta cuyo estado se devuelve.
-
queryString: una cadena, del tipo:
string(una cadena codificada con UTF-8).La cadena de consulta de openCypher.
CancelOpenCypherQuery (acción)
El nombre de la AWS CLI para esta API es: cancel-open-cypher-query.
Cancela una consulta específica de openCypher. Consulte Punto de conexión de estado de openCypher en Neptune para obtener más información.
Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:CancelQuery en dicho clúster.
Solicitud
-
queryId (en la CLI:
--query-id): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El ID único de la consulta de openCypher que se va a cancelar.
-
silent (en la CLI:
--silent): un booleano, del tipo:boolean(un valor booleano [true o false]).Si se establece en
TRUE, se lleva a cabo de forma silenciosa la cancelación de la consulta de openCypher.
Respuesta
-
payload: un booleano, del tipo:
boolean(un valor booleano [true o false]).La carga de cancelación de la consulta de openCypher.
-
status: una cadena, del tipo:
string(una cadena codificada con UTF-8).El estado de cancelación de la consulta de openCypher.
Estructuras de consulta:
QueryEvalStats (estructura)
Estructura para capturar estadísticas de consultas, como el número de consultas en ejecución, aceptadas o en espera y sus detalles.
Campos
-
cancelled: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Se establece en
TRUEsi la consulta se ha cancelado o en FALSE en caso contrario. -
elapsed: se trata de un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).El número de milisegundos que la consulta lleva en ejecución.
-
subqueries: se trata de un documento, del tipo:
document(un contenido abierto independiente del protocolo representado por un modelo de datos similar a JSON).El número de subconsultas de esta consulta.
-
waited: se trata de un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Indica cuánto tiempo esperó la consulta, en milisegundos.
GremlinQueryStatus (estructura)
Captura el estado de una consulta de Gremlin (consulta la página API del estado de la consulta de Gremlin).
Campos
-
queryEvalStats: se trata de un objeto QueryEvalStats.
Las estadísticas de la consulta de Gremlin.
-
queryId: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El ID de la consulta de Gremlin.
-
queryString: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La cadena de la consulta de Gremlin.
GremlinQueryStatusAttributes (estructura)
Incluye los componentes de estado de una consulta de Gremlin.
Campos
-
attributes: se trata de un documento, del tipo:
document(un contenido abierto independiente del protocolo representado por un modelo de datos similar a JSON).Atributos del estado de la consulta de Gremlin.
-
code: se trata de un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).El código de respuesta HTTP devuelto por la solicitud de consulta de Gremlin.
-
message: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Mensaje del estado.
