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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



605
606
607
608
609
610
611
612
613
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 605

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) 


605
606
607
608
609
610
611
612
613
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 605

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 markdown=“1”> 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.

</note>

[1]: www.postgresql.org/docs/10/dml-returning.html

Returns:



605
606
607
608
609
610
611
612
613
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 605

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) 


605
606
607
608
609
610
611
612
613
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 605

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:



605
606
607
608
609
610
611
612
613
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 605

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