Struct aws_sdk_neptunedata::operation::execute_open_cypher_query::builders::ExecuteOpenCypherQueryFluentBuilder

pub struct ExecuteOpenCypherQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ExecuteOpenCypherQuery.

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.

Note that when invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:

• neptune-db:ReadDataViaQuery

• neptune-db:WriteDataViaQuery

• neptune-db:DeleteDataViaQuery

Note also that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

Implementations

impl ExecuteOpenCypherQueryFluentBuilder

pub fn as_input(&self) -> &ExecuteOpenCypherQueryInputBuilder

Access the ExecuteOpenCypherQuery as a reference.

pub async fn send( self ) -> Result<ExecuteOpenCypherQueryOutput, SdkError<ExecuteOpenCypherQueryError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<ExecuteOpenCypherQueryOutput, ExecuteOpenCypherQueryError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn open_cypher_query(self, input: impl Into<String>) -> Self

The openCypher query string to be executed.

pub fn set_open_cypher_query(self, input: Option<String>) -> Self

The openCypher query string to be executed.

pub fn get_open_cypher_query(&self) -> &Option<String>

The openCypher query string to be executed.

pub fn parameters(self, input: impl Into<String>) -> Self

The openCypher query parameters for query execution. See Examples of openCypher parameterized queries for more information.

pub fn set_parameters(self, input: Option<String>) -> Self

The openCypher query parameters for query execution. See Examples of openCypher parameterized queries for more information.

pub fn get_parameters(&self) -> &Option<String>

The openCypher query parameters for query execution. See Examples of openCypher parameterized queries for more information.

Trait Implementations

impl Clone for ExecuteOpenCypherQueryFluentBuilder

fn clone(&self) -> ExecuteOpenCypherQueryFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteOpenCypherQueryFluentBuilder

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

Formats the value using the given formatter.