Struct aws_sdk_rdsdata::input::ExecuteStatementInput

#[non_exhaustive]
pub struct ExecuteStatementInput {
    pub resource_arn: Option<String>,
    pub secret_arn: Option<String>,
    pub sql: Option<String>,
    pub database: Option<String>,
    pub schema: Option<String>,
    pub parameters: Option<Vec<SqlParameter>>,
    pub transaction_id: Option<String>,
    pub include_result_metadata: bool,
    pub continue_after_timeout: bool,
    pub result_set_options: Option<ResultSetOptions>,
}

The request parameters represent the input of a request to run a SQL statement against a database.

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.

resource_arn: Option<String>

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

secret_arn: Option<String>

The name or ARN of the secret that enables access to the DB cluster.

sql: Option<String>

The SQL statement to run.

database: Option<String>

The name of the database.

schema: Option<String>

The name of the database schema.

Currently, the schema parameter isn't supported.

parameters: Option<Vec<SqlParameter>>

The parameters for the SQL statement.

Array parameters are not supported.

transaction_id: Option<String>

The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

include_result_metadata: bool

A value that indicates whether to include metadata in the results.

continue_after_timeout: bool

A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

result_set_options: Option<ResultSetOptions>

Options that control how the result set is returned.

Implementations

impl ExecuteStatementInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ExecuteStatement, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ExecuteStatement>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ExecuteStatementInput

impl ExecuteStatementInput

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

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

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

The name or ARN of the secret that enables access to the DB cluster.

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

The SQL statement to run.

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

The name of the database.

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

The name of the database schema.

Currently, the schema parameter isn't supported.

pub fn parameters(&self) -> Option<&[SqlParameter]>

The parameters for the SQL statement.

Array parameters are not supported.

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

The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

pub fn include_result_metadata(&self) -> bool

A value that indicates whether to include metadata in the results.

pub fn continue_after_timeout(&self) -> bool

A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

pub fn result_set_options(&self) -> Option<&ResultSetOptions>

Options that control how the result set is returned.

Trait Implementations

impl Clone for ExecuteStatementInput

fn clone(&self) -> ExecuteStatementInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteStatementInput

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

Formats the value using the given formatter.

impl PartialEq<ExecuteStatementInput> for ExecuteStatementInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ExecuteStatementInput