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

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

Overview

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) 


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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

#resource_arn ⇒ String

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

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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

#schema ⇒ String

The name of the database schema.

<note markdown=“1”> Currently, the ‘schema` parameter isn’t supported.

</note>

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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

#sql ⇒ String

The SQL statement to run. Don’t include a semicolon (;) at the end of the SQL statement.

Returns:

  • (String) 


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 153

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