Class: Aws::RDSDataService::Types::ExecuteStatementResponse

Inherits:

Struct

• Object
• Struct
• Aws::RDSDataService::Types::ExecuteStatementResponse

Includes:

Structure

Defined in:

lib/aws-sdk-rdsdataservice/types.rb

Overview

The response elements represent the output of a request to run a SQL statement against a database.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #column_metadata ⇒ Array<Types::ColumnMetadata>

  Metadata for the columns included in the results.

• #formatted_records ⇒ String

  A string value that represents the result set of a ‘SELECT` statement in JSON format.

• #generated_fields ⇒ Array<Types::Field>

  Values for fields generated during a DML request.

• #number_of_records_updated ⇒ Integer

  The number of records updated by the request.

• #records ⇒ Array<Array<Types::Field>>

  The records returned by the SQL statement.

Instance Attribute Details

#column_metadata ⇒ Array<Types::ColumnMetadata>

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

Returns:

• (Array<Types::ColumnMetadata>)

# File 'lib/aws-sdk-rdsdataservice/types.rb', line 548

class ExecuteStatementResponse < Struct.new(
  :records,
  :column_metadata,
  :number_of_records_updated,
  :generated_fields,
  :formatted_records)
  SENSITIVE = []
  include Aws::Structure
end

#formatted_records ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-rdsdataservice/types.rb', line 548

class ExecuteStatementResponse < Struct.new(
  :records,
  :column_metadata,
  :number_of_records_updated,
  :generated_fields,
  :formatted_records)
  SENSITIVE = []
  include Aws::Structure
end

#generated_fields ⇒ Array<Types::Field>

Values for fields generated during a DML request.

<note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>

Returns:

• (Array<Types::Field>)

# File 'lib/aws-sdk-rdsdataservice/types.rb', line 548

class ExecuteStatementResponse < Struct.new(
  :records,
  :column_metadata,
  :number_of_records_updated,
  :generated_fields,
  :formatted_records)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_records_updated ⇒ Integer

The number of records updated by the request.

Returns:

• (Integer)

# File 'lib/aws-sdk-rdsdataservice/types.rb', line 548

class ExecuteStatementResponse < Struct.new(
  :records,
  :column_metadata,
  :number_of_records_updated,
  :generated_fields,
  :formatted_records)
  SENSITIVE = []
  include Aws::Structure
end

#records ⇒ Array<Array<Types::Field>>

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

Returns:

• (Array<Array<Types::Field>>)

# File 'lib/aws-sdk-rdsdataservice/types.rb', line 548

class ExecuteStatementResponse < Struct.new(
  :records,
  :column_metadata,
  :number_of_records_updated,
  :generated_fields,
  :formatted_records)
  SENSITIVE = []
  include Aws::Structure
end