Struct aws_sdk_rdsdata::operation::execute_statement::ExecuteStatementOutput

#[non_exhaustive]
pub struct ExecuteStatementOutput {
    pub records: Option<Vec<Vec<Field>>>,
    pub column_metadata: Option<Vec<ColumnMetadata>>,
    pub number_of_records_updated: i64,
    pub generated_fields: Option<Vec<Field>>,
    pub formatted_records: Option<String>,
    /* private fields */
}

The response elements represent the output 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.

records: Option<Vec<Vec<Field>>>

The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

column_metadata: Option<Vec<ColumnMetadata>>

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

number_of_records_updated: i64

The number of records updated by the request.

generated_fields: Option<Vec<Field>>

Values for fields generated during a DML request.

The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

formatted_records: Option<String>

A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

Implementations

impl ExecuteStatementOutput

pub fn records(&self) -> &[Vec<Field>]

The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .records.is_none().

pub fn column_metadata(&self) -> &[ColumnMetadata]

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .column_metadata.is_none().

pub fn number_of_records_updated(&self) -> i64

The number of records updated by the request.

pub fn generated_fields(&self) -> &[Field]

Values for fields generated during a DML request.

The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .generated_fields.is_none().

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

A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

impl ExecuteStatementOutput

pub fn builder() -> ExecuteStatementOutputBuilder

Creates a new builder-style object to manufacture ExecuteStatementOutput.

Trait Implementations

impl Clone for ExecuteStatementOutput

fn clone(&self) -> ExecuteStatementOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteStatementOutput

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

Formats the value using the given formatter.

impl PartialEq for ExecuteStatementOutput

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

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

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

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

impl RequestId for ExecuteStatementOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for ExecuteStatementOutput