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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#column_metadataArray<Types::ColumnMetadata>

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

Returns:



655
656
657
658
659
660
661
662
663
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 655

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

#formatted_recordsString

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)


655
656
657
658
659
660
661
662
663
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 655

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

#generated_fieldsArray<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:



655
656
657
658
659
660
661
662
663
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 655

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

#number_of_records_updatedInteger

The number of records updated by the request.

Returns:

  • (Integer)


655
656
657
658
659
660
661
662
663
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 655

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

#recordsArray<Array<Types::Field>>

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

Returns:



655
656
657
658
659
660
661
662
663
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 655

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