@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRDSDataAsync extends AWSRDSData
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSRDSDataAsync
instead.
Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these statements, you work with the Data Service API.
The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.
For more information about the Data Service API, see Using the Data API in the Amazon Aurora User Guide.
ENDPOINT_PREFIX
batchExecuteStatement, beginTransaction, commitTransaction, executeSql, executeStatement, getCachedResponseMetadata, rollbackTransaction, shutdown
Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest)
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.
There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set.
The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.
batchExecuteStatementRequest
- The request parameters represent the input of a SQL statement over an array of data.Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest, AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler)
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.
There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set.
The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.
batchExecuteStatementRequest
- The request parameters represent the input of a SQL statement over an array of data.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BeginTransactionResult> beginTransactionAsync(BeginTransactionRequest beginTransactionRequest)
Starts a SQL transaction.
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.
beginTransactionRequest
- The request parameters represent the input of a request to start a SQL transaction.Future<BeginTransactionResult> beginTransactionAsync(BeginTransactionRequest beginTransactionRequest, AsyncHandler<BeginTransactionRequest,BeginTransactionResult> asyncHandler)
Starts a SQL transaction.
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.
beginTransactionRequest
- The request parameters represent the input of a request to start a SQL transaction.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CommitTransactionResult> commitTransactionAsync(CommitTransactionRequest commitTransactionRequest)
Ends a SQL transaction started with the BeginTransaction
operation and commits the changes.
commitTransactionRequest
- The request parameters represent the input of a commit transaction request.Future<CommitTransactionResult> commitTransactionAsync(CommitTransactionRequest commitTransactionRequest, AsyncHandler<CommitTransactionRequest,CommitTransactionResult> asyncHandler)
Ends a SQL transaction started with the BeginTransaction
operation and commits the changes.
commitTransactionRequest
- The request parameters represent the input of a commit transaction request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated Future<ExecuteSqlResult> executeSqlAsync(ExecuteSqlRequest executeSqlRequest)
Runs one or more SQL statements.
This operation is deprecated. Use the BatchExecuteStatement
or ExecuteStatement
operation.
executeSqlRequest
- The request parameters represent the input of a request to run one or more SQL statements.@Deprecated Future<ExecuteSqlResult> executeSqlAsync(ExecuteSqlRequest executeSqlRequest, AsyncHandler<ExecuteSqlRequest,ExecuteSqlResult> asyncHandler)
Runs one or more SQL statements.
This operation is deprecated. Use the BatchExecuteStatement
or ExecuteStatement
operation.
executeSqlRequest
- The request parameters represent the input of a request to run one or more SQL statements.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest executeStatementRequest)
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.
If the binary response data from the database is more than 1 MB, the call is terminated.
executeStatementRequest
- The request parameters represent the input of a request to run a SQL statement against a database.Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest executeStatementRequest, AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler)
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.
If the binary response data from the database is more than 1 MB, the call is terminated.
executeStatementRequest
- The request parameters represent the input of a request to run a SQL statement against a database.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RollbackTransactionResult> rollbackTransactionAsync(RollbackTransactionRequest rollbackTransactionRequest)
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
rollbackTransactionRequest
- The request parameters represent the input of a request to perform a rollback of a transaction.Future<RollbackTransactionResult> rollbackTransactionAsync(RollbackTransactionRequest rollbackTransactionRequest, AsyncHandler<RollbackTransactionRequest,RollbackTransactionResult> asyncHandler)
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
rollbackTransactionRequest
- The request parameters represent the input of a request to perform a rollback of a transaction.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.