You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDSDataService::Types::ExecuteStatementRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ExecuteStatementRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  continue_after_timeout: false,
  database: "DbName",
  include_result_metadata: false,
  parameters: [
    {
      name: "ParameterName",
      type_hint: "DATE", # accepts DATE, DECIMAL, TIME, TIMESTAMP
      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: "DOUBLE_OR_LONG", # accepts DOUBLE_OR_LONG, STRING
  },
  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.

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (Boolean) —

    A value that indicates whether to continue running the statement after the call times out.

#database ⇒ String

The name of the database.

Returns:

  • (String) —

    The name of the database.

#include_result_metadata ⇒ Boolean

A value that indicates whether to include metadata in the results.

Returns:

  • (Boolean) —

    A value that indicates whether to include metadata in the results.

#parameters ⇒ Array<Types::SqlParameter>

The parameters for the SQL statement.

Array parameters are not supported.

Returns:

#resource_arn ⇒ String

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

Returns:

  • (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.

Returns:

#schema ⇒ String

The name of the database schema.

Returns:

  • (String) —

    The name of the database schema.

#secret_arn ⇒ String

The name or ARN of the secret that enables access to the DB cluster.

Returns:

  • (String) —

    The name or ARN of the secret that enables access to the DB cluster.

#sql ⇒ String

The SQL statement to run.

Returns:

  • (String) —

    The SQL statement to run.

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

Returns:

  • (String) —

    The identifier of a transaction that was started by using the BeginTransaction operation.