NeptuneData / Client / execute_open_cypher_query

execute_open_cypher_query#

NeptuneData.Client.execute_open_cypher_query(**kwargs)#

Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more information.

Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher’s declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs.

The openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the openCypher project under an Apache 2 open-source license.

See also: AWS API Documentation

Request Syntax

response = client.execute_open_cypher_query(
    openCypherQuery='string',
    parameters='string'
)
Parameters:

  • openCypherQuery (string) –

    [REQUIRED]

    The openCypher query string to be executed.

  • parameters (string) – The openCypher query parameters for query execution. See Examples of openCypher parameterized queries for more information.

Return type:

dict

Returns:

Response Syntax

{
    'results': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

  • (dict) –

    • results (document) –

      The openCypherquery results.

Exceptions

  • NeptuneData.Client.exceptions.QueryTooLargeException

  • NeptuneData.Client.exceptions.InvalidNumericDataException

  • NeptuneData.Client.exceptions.BadRequestException

  • NeptuneData.Client.exceptions.QueryLimitExceededException

  • NeptuneData.Client.exceptions.InvalidParameterException

  • NeptuneData.Client.exceptions.QueryLimitException

  • NeptuneData.Client.exceptions.ClientTimeoutException

  • NeptuneData.Client.exceptions.CancelledByUserException

  • NeptuneData.Client.exceptions.IllegalArgumentException

  • NeptuneData.Client.exceptions.TooManyRequestsException

  • NeptuneData.Client.exceptions.UnsupportedOperationException

  • NeptuneData.Client.exceptions.FailureByQueryException

  • NeptuneData.Client.exceptions.MemoryLimitExceededException

  • NeptuneData.Client.exceptions.PreconditionsFailedException

  • NeptuneData.Client.exceptions.MalformedQueryException

  • NeptuneData.Client.exceptions.ParsingException

  • NeptuneData.Client.exceptions.ConstraintViolationException

  • NeptuneData.Client.exceptions.TimeLimitExceededException

  • NeptuneData.Client.exceptions.InvalidArgumentException

  • NeptuneData.Client.exceptions.ConcurrentModificationException

  • NeptuneData.Client.exceptions.MissingParameterException