Skip to content

ExecuteQueryInput

Source code in docs_src/capo_neptune_graph/types/execute_query_input.py
class ExecuteQueryInput(TypedDict, closed=True):
    graph_identifier: "capo_neptune_graph.types.graph_identifier.GraphIdentifier"
    """<p>The unique identifier of the Neptune Analytics graph.</p>"""
    query_string: "str"
    """<p>The query string to be executed.</p>"""
    language: "capo_neptune_graph.types.query_language.QueryLanguage"
    """<p>The query language the query is written in. Currently only openCypher is supported.</p>"""
    parameters: NotRequired[
        "capo_neptune_graph.types.document_valued_map.DocumentValuedMap"
    ]
    """<p>The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional) </p>"""
    plan_cache: NotRequired["capo_neptune_graph.types.plan_cache_type.PlanCacheType"]
    """<p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.</p>"""
    explain_mode: NotRequired["capo_neptune_graph.types.explain_mode.ExplainMode"]
    """<p>The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.</p>"""
    query_timeout_milliseconds: NotRequired["int"]
    """<p>Specifies the query timeout duration, in milliseconds. (optional)</p>"""

explain_mode instance-attribute

explain_mode: NotRequired[ExplainMode]

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

graph_identifier instance-attribute

graph_identifier: GraphIdentifier

The unique identifier of the Neptune Analytics graph.

language instance-attribute

language: QueryLanguage

The query language the query is written in. Currently only openCypher is supported.

parameters instance-attribute

parameters: NotRequired[DocumentValuedMap]

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

plan_cache instance-attribute

plan_cache: NotRequired[PlanCacheType]

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

query_string instance-attribute

query_string: str

The query string to be executed.

query_timeout_milliseconds instance-attribute

query_timeout_milliseconds: NotRequired[int]

Specifies the query timeout duration, in milliseconds. (optional)