Icon

AWS RDS Data (version v1.*.*)

batch_execute_statement

Runs a batch SQL statement over an array of data.
You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.
If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

Parameters

$body

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

Type: object

{
"schema" : "The name of the database schema.",
"database" : "The name of the database.",
"secretArn" : "The name or ARN of the secret that enables access to the DB cluster.",
"resourceArn" : "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.",
"parameterSets" : [ [ {
"name" : "The name of the parameter.",
"value" : {
"stringValue" : "A value of string data type.",
"isNull" : "A NULL value.",
"booleanValue" : "A value of Boolean data type.",
"arrayValue" : {
"stringValues" : [ "string" ],
"doubleValues" : [ "number" ],
"booleanValues" : [ "boolean" ],
"longValues" : [ "number" ],
"arrayValues" : [ {
"stringValues" : [ "string" ],
"doubleValues" : [ "number" ],
"booleanValues" : [ "boolean" ],
"longValues" : [ "number" ],
"arrayValues" : "ArrayOfArray"
} ]
},
"doubleValue" : "A value of double data type.",
"blobValue" : "A value of BLOB data type.",
"longValue" : "A value of long data type."
}
} ] ],
"transactionId" : "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. \nIf the SQL statement is not part of a transaction, don't set this parameter.",
"sql" : "The SQL statement to run."
}

begin_transaction

Starts a SQL transaction. <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>

Parameters

$body

The request parameters represent the input of a request to start a SQL transaction.

Type: object

{
"schema" : "The name of the database schema.",
"database" : "The name of the database.",
"secretArn" : "The name or ARN of the secret that enables access to the DB cluster.",
"resourceArn" : "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster."
}

commit_transaction

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

Parameters

$body

The request parameters represent the input of a commit transaction request.

Type: object

{
"secretArn" : "The name or ARN of the secret that enables access to the DB cluster.",
"resourceArn" : "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.",
"transactionId" : "The identifier of the transaction to end and commit."
}

execute_sql

Runs one or more SQL statements.
This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

Parameters

$body

The request parameters represent the input of a request to run one or more SQL statements.

Type: object

{
"dbClusterOrInstanceArn" : "The ARN of the Aurora Serverless DB cluster.",
"schema" : "The name of the database schema.",
"database" : "The name of the database.",
"sqlStatements" : "One or more SQL statements to run on the DB cluster. \nYou can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements. ",
"awsSecretStoreArn" : "The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster."
}

execute_statement

Runs a SQL statement against a database.
If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.
The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.

Parameters

$body

The request parameters represent the input of a request to run a SQL statement against a database.

Type: object

{
"schema" : "The name of the database schema.",
"database" : "The name of the database.",
"secretArn" : "The name or ARN of the secret that enables access to the DB cluster.",
"resourceArn" : "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.",
"continueAfterTimeout" : "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. \nFor 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.",
"resultSetOptions" : {
"decimalReturnType" : "A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise. \nConversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values."
},
"includeResultMetadata" : "A value that indicates whether to include metadata in the results.",
"parameters" : [ {
"name" : "The name of the parameter.",
"value" : {
"stringValue" : "A value of string data type.",
"isNull" : "A NULL value.",
"booleanValue" : "A value of Boolean data type.",
"arrayValue" : {
"stringValues" : [ "string" ],
"doubleValues" : [ "number" ],
"booleanValues" : [ "boolean" ],
"longValues" : [ "number" ],
"arrayValues" : [ {
"stringValues" : [ "string" ],
"doubleValues" : [ "number" ],
"booleanValues" : [ "boolean" ],
"longValues" : [ "number" ],
"arrayValues" : "ArrayOfArray"
} ]
},
"doubleValue" : "A value of double data type.",
"blobValue" : "A value of BLOB data type.",
"longValue" : "A value of long data type."
}
} ],
"transactionId" : "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. \nIf the SQL statement is not part of a transaction, don't set this parameter.",
"sql" : "The SQL statement to run."
}

rollback_transaction

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Parameters

$body

The request parameters represent the input of a request to perform a rollback of a transaction.

Type: object

{
"secretArn" : "The name or ARN of the secret that enables access to the DB cluster.",
"resourceArn" : "The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.",
"transactionId" : "The identifier of the transaction to roll back."
}