Struct ExecuteQueryInput

#[non_exhaustive]
pub struct ExecuteQueryInput {
    pub graph_identifier: Option<String>,
    pub query_string: Option<String>,
    pub language: Option<QueryLanguage>,
    pub parameters: Option<HashMap<String, Document>>,
    pub plan_cache: Option<PlanCacheType>,
    pub explain_mode: Option<ExplainMode>,
    pub query_timeout_milliseconds: Option<i32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

graph_identifier: Option<String>

The unique identifier of the Neptune Analytics graph.

query_string: Option<String>

The query string to be executed.

language: Option<QueryLanguage>

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

parameters: Option<HashMap<String, Document>>

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

plan_cache: Option<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.

explain_mode: Option<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.

query_timeout_milliseconds: Option<i32>

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

Implementations

impl ExecuteQueryInput

pub fn graph_identifier(&self) -> Option<&str>

The unique identifier of the Neptune Analytics graph.

pub fn query_string(&self) -> Option<&str>

The query string to be executed.

pub fn language(&self) -> Option<&QueryLanguage>

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

pub fn parameters(&self) -> Option<&HashMap<String, Document>>

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

pub fn plan_cache(&self) -> Option<&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.

pub fn explain_mode(&self) -> Option<&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.

pub fn query_timeout_milliseconds(&self) -> Option<i32>

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

impl ExecuteQueryInput

pub fn builder() -> ExecuteQueryInputBuilder

Creates a new builder-style object to manufacture ExecuteQueryInput.

Trait Implementations

impl Clone for ExecuteQueryInput

fn clone(&self) -> ExecuteQueryInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecuteQueryInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ExecuteQueryInput

fn eq(&self, other: &ExecuteQueryInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExecuteQueryInput