Class: Aws::RDSDataService::Types::ExecuteStatementRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDSDataService::Types::ExecuteStatementRequest
- Defined in:
- gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb
Overview
When making an API call, you may pass ExecuteStatementRequest data as a hash:
{
continue_after_timeout: false,
database: "DbName",
format_records_as: "NONE", # accepts NONE, JSON
include_result_metadata: false,
parameters: [
{
name: "ParameterName",
type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
value: {
array_value: {
array_values: [
{
# recursive ArrayValue
},
],
boolean_values: [false],
double_values: [1.0],
long_values: [1],
string_values: ["String"],
},
blob_value: "data",
boolean_value: false,
double_value: 1.0,
is_null: false,
long_value: 1,
string_value: "String",
},
},
],
resource_arn: "Arn", # required
result_set_options: {
decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
long_return_type: "STRING", # accepts STRING, LONG
},
schema: "DbName",
secret_arn: "Arn", # required
sql: "SqlStatement", # required
transaction_id: "Id",
}
The request parameters represent the input of a request to run a SQL statement against a database.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#continue_after_timeout ⇒ Boolean
A value that indicates whether to continue running the statement after the call times out.
-
#database ⇒ String
The name of the database.
-
#format_records_as ⇒ String
A value that indicates whether to format the result set as a single JSON string.
-
#include_result_metadata ⇒ Boolean
A value that indicates whether to include metadata in the results.
-
#parameters ⇒ Array<Types::SqlParameter>
The parameters for the SQL statement.
-
#resource_arn ⇒ String
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
-
#result_set_options ⇒ Types::ResultSetOptions
Options that control how the result set is returned.
-
#schema ⇒ String
The name of the database schema.
-
#secret_arn ⇒ String
The ARN of the secret that enables access to the DB cluster.
-
#sql ⇒ String
The SQL statement to run.
-
#transaction_id ⇒ String
The identifier of a transaction that was started by using the
BeginTransaction
operation.
Instance Attribute Details
#continue_after_timeout ⇒ Boolean
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.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#database ⇒ String
The name of the database.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#format_records_as ⇒ String
A value that indicates whether to format the result set as a single
JSON string. This parameter only applies to SELECT
statements and
is ignored for other types of statements. Allowed values are NONE
and JSON
. The default value is NONE
. The result is returned in
the formattedRecords
field.
For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#include_result_metadata ⇒ Boolean
A value that indicates whether to include metadata in the results.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#parameters ⇒ Array<Types::SqlParameter>
The parameters for the SQL statement.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#resource_arn ⇒ String
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#result_set_options ⇒ Types::ResultSetOptions
Options that control how the result set is returned.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#schema ⇒ String
The name of the database schema.
schema
parameter isn't supported.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#secret_arn ⇒ String
The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.
For information about creating the secret, see Create a database secret.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#sql ⇒ String
The SQL statement to run.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |
#transaction_id ⇒ 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.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 604 class ExecuteStatementRequest < Struct.new( :continue_after_timeout, :database, :format_records_as, :include_result_metadata, :parameters, :resource_arn, :result_set_options, :schema, :secret_arn, :sql, :transaction_id) SENSITIVE = [] include Aws::Structure end |