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

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

Overview

Note:

When making an API call, you may pass BatchExecuteStatementRequest data as a 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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ String

The name of the database.

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

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

<note markdown=“1”> Array parameters are not supported.

</note>

Returns:



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :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.

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ String

The name of the database schema.

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

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

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#sql ⇒ String

The SQL statement to run.

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :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.

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 172

class BatchExecuteStatementRequest < Struct.new(
  :database,
  :parameter_sets,
  :resource_arn,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end