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

Class: Aws::RDSDataService::Types::BatchExecuteStatementRequest

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

Overview

Note:

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

{
  database: "DbName",
  parameter_sets: [
    [
      {
        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
  schema: "DbName",
  secret_arn: "Arn", # required
  sql: "SqlStatement", # required
  transaction_id: "Id",
}

The request parameters represent the input of a SQL statement over an array of data.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ String

The name of the database.

Returns:

  • (String) —

    The name of the database.

#parameter_sets ⇒ Array<Array<Types::SqlParameter>>

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

  • Specify one or more empty parameter sets.

  • Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

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.

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