2019/05/30 - AWS RDS DataService - 5 new api methods
Changes The RDS Data API is generally available for the MySQL-compatible edition of Amazon Aurora Serverless in the US East (N. Virginia and Ohio), US West (Oregon), EU (Ireland), and Asia Pacific (Tokyo) regions. This service enables you to easily access Aurora Serverless clusters with web services-based applications including AWS Lambda and AWS AppSync. The new APIs included in this SDK release are ExecuteStatement, BatchExecuteStatement, BeginTransaction, CommitTransaction, and RollbackTransaction. The ExecuteSql API is deprecated; instead use ExecuteStatement which provides additional functionality including transaction support.
Starts a SQL transaction.
Warning
A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.
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.
DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.
See also: AWS API Documentation
Request Syntax
client.begin_transaction(
database='string',
resourceArn='string',
schema='string',
secretArn='string'
)
string
The name of the database.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
string
The name of the database schema.
string
[REQUIRED]
The name or ARN of the secret that enables access to the DB cluster.
dict
Response Syntax
{
'transactionId': 'string'
}
Response Structure
(dict) --
The response elements represent the output of a request to start a SQL transaction.
transactionId (string) --
The transaction ID of the transaction started by the call.
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
See also: AWS API Documentation
Request Syntax
client.rollback_transaction(
resourceArn='string',
secretArn='string',
transactionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
string
[REQUIRED]
The name or ARN of the secret that enables access to the DB cluster.
string
[REQUIRED]
The identifier of the transaction to roll back.
dict
Response Syntax
{
'transactionStatus': 'string'
}
Response Structure
(dict) --
The response elements represent the output of a request to perform a rollback of a transaction.
transactionStatus (string) --
The status of the rollback operation.
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.
Warning
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.
See also: AWS API Documentation
Request Syntax
client.batch_execute_statement(
database='string',
parameterSets=[
[
{
'name': 'string',
'value': {
'blobValue': b'bytes',
'booleanValue': True|False,
'doubleValue': 123.0,
'isNull': True|False,
'longValue': 123,
'stringValue': 'string'
}
},
],
],
resourceArn='string',
schema='string',
secretArn='string',
sql='string',
transactionId='string'
)
string
The name of the database.
list
The parameter set for the batch operation.
(list) --
(dict) --
A parameter used in a SQL statement.
name (string) --
The name of the parameter.
value (dict) --
The value of the parameter.
blobValue (bytes) --
A value of BLOB data type.
booleanValue (boolean) --
A value of Boolean data type.
doubleValue (float) --
A value of double data type.
isNull (boolean) --
A NULL value.
longValue (integer) --
A value of long data type.
stringValue (string) --
A value of string data type.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
string
The name of the database schema.
string
[REQUIRED]
The name or ARN of the secret that enables access to the DB cluster.
string
[REQUIRED]
The SQL statement to run.
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.
dict
Response Syntax
{
'updateResults': [
{
'generatedFields': [
{
'blobValue': b'bytes',
'booleanValue': True|False,
'doubleValue': 123.0,
'isNull': True|False,
'longValue': 123,
'stringValue': 'string'
},
]
},
]
}
Response Structure
(dict) --
The response elements represent the output of a SQL statement over an array of data.
updateResults (list) --
The execution results of each batch entry.
(dict) --
The response elements represent the results of an update.
generatedFields (list) --
Values for fields generated during the request.
(dict) --
Contains a value.
blobValue (bytes) --
A value of BLOB data type.
booleanValue (boolean) --
A value of Boolean data type.
doubleValue (float) --
A value of double data type.
isNull (boolean) --
A NULL value.
longValue (integer) --
A value of long data type.
stringValue (string) --
A value of string data type.
Runs a SQL statement against a database.
Warning
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.
See also: AWS API Documentation
Request Syntax
client.execute_statement(
continueAfterTimeout=True|False,
database='string',
includeResultMetadata=True|False,
parameters=[
{
'name': 'string',
'value': {
'blobValue': b'bytes',
'booleanValue': True|False,
'doubleValue': 123.0,
'isNull': True|False,
'longValue': 123,
'stringValue': 'string'
}
},
],
resourceArn='string',
schema='string',
secretArn='string',
sql='string',
transactionId='string'
)
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.
Warning
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.
string
The name of the database.
boolean
A value that indicates whether to include metadata in the results.
list
The parameters for the SQL statement.
(dict) --
A parameter used in a SQL statement.
name (string) --
The name of the parameter.
value (dict) --
The value of the parameter.
blobValue (bytes) --
A value of BLOB data type.
booleanValue (boolean) --
A value of Boolean data type.
doubleValue (float) --
A value of double data type.
isNull (boolean) --
A NULL value.
longValue (integer) --
A value of long data type.
stringValue (string) --
A value of string data type.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
string
The name of the database schema.
string
[REQUIRED]
The name or ARN of the secret that enables access to the DB cluster.
string
[REQUIRED]
The SQL statement to run.
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.
dict
Response Syntax
{
'columnMetadata': [
{
'arrayBaseColumnType': 123,
'isAutoIncrement': True|False,
'isCaseSensitive': True|False,
'isCurrency': True|False,
'isSigned': True|False,
'label': 'string',
'name': 'string',
'nullable': 123,
'precision': 123,
'scale': 123,
'schemaName': 'string',
'tableName': 'string',
'type': 123,
'typeName': 'string'
},
],
'generatedFields': [
{
'blobValue': b'bytes',
'booleanValue': True|False,
'doubleValue': 123.0,
'isNull': True|False,
'longValue': 123,
'stringValue': 'string'
},
],
'numberOfRecordsUpdated': 123,
'records': [
[
{
'blobValue': b'bytes',
'booleanValue': True|False,
'doubleValue': 123.0,
'isNull': True|False,
'longValue': 123,
'stringValue': 'string'
},
],
]
}
Response Structure
(dict) --
The response elements represent the output of a request to run a SQL statement against a database.
columnMetadata (list) --
Metadata for the columns included in the results.
(dict) --
Contains the metadata for a column.
arrayBaseColumnType (integer) --
The type of the column.
isAutoIncrement (boolean) --
A value that indicates whether the column increments automatically.
isCaseSensitive (boolean) --
A value that indicates whether the column is case-sensitive.
isCurrency (boolean) --
A value that indicates whether the column contains currency values.
isSigned (boolean) --
A value that indicates whether an integer column is signed.
label (string) --
The label for the column.
name (string) --
The name of the column.
nullable (integer) --
A value that indicates whether the column is nullable.
precision (integer) --
The precision value of a decimal number column.
scale (integer) --
The scale value of a decimal number column.
schemaName (string) --
The name of the schema that owns the table that includes the column.
tableName (string) --
The name of the table that includes the column.
type (integer) --
The type of the column.
typeName (string) --
The database-specific data type of the column.
generatedFields (list) --
Values for fields generated during the request.
(dict) --
Contains a value.
blobValue (bytes) --
A value of BLOB data type.
booleanValue (boolean) --
A value of Boolean data type.
doubleValue (float) --
A value of double data type.
isNull (boolean) --
A NULL value.
longValue (integer) --
A value of long data type.
stringValue (string) --
A value of string data type.
numberOfRecordsUpdated (integer) --
The number of records updated by the request.
records (list) --
The records returned by the SQL statement.
(list) --
(dict) --
Contains a value.
blobValue (bytes) --
A value of BLOB data type.
booleanValue (boolean) --
A value of Boolean data type.
doubleValue (float) --
A value of double data type.
isNull (boolean) --
A NULL value.
longValue (integer) --
A value of long data type.
stringValue (string) --
A value of string data type.
Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
See also: AWS API Documentation
Request Syntax
client.commit_transaction(
resourceArn='string',
secretArn='string',
transactionId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
string
[REQUIRED]
The name or ARN of the secret that enables access to the DB cluster.
string
[REQUIRED]
The identifier of the transaction to end and commit.
dict
Response Syntax
{
'transactionStatus': 'string'
}
Response Structure
(dict) --
The response elements represent the output of a commit transaction request.
transactionStatus (string) --
The status of the commit operation.