@Generated(value="software.amazon.awssdk:codegen") public interface RdsDataAsyncClient extends SdkClient
builder()
method.
Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.
For more information about the Data Service API, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static RdsDataAsyncClient create()
RdsDataAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static RdsDataAsyncClientBuilder builder()
RdsDataAsyncClient
.default CompletableFuture<BatchExecuteStatementResponse> batchExecuteStatement(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.
batchExecuteStatementRequest
- The request parameters represent the input of a SQL statement over an array of data.resourceArn
parameter is
not available.default CompletableFuture<BatchExecuteStatementResponse> batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> 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.
This is a convenience which creates an instance of the BatchExecuteStatementRequest.Builder
avoiding the
need to create one manually via BatchExecuteStatementRequest.builder()
batchExecuteStatementRequest
- A Consumer
that will call methods on BatchExecuteStatementRequest.Builder
to create a
request. The request parameters represent the input of a SQL statement over an array of data.resourceArn
parameter is
not available.default CompletableFuture<BeginTransactionResponse> beginTransaction(BeginTransactionRequest beginTransactionRequest)
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>
beginTransactionRequest
- The request parameters represent the input of a request to start a SQL transaction.resourceArn
parameter is
not available.default CompletableFuture<BeginTransactionResponse> beginTransaction(Consumer<BeginTransactionRequest.Builder> beginTransactionRequest)
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>
This is a convenience which creates an instance of the BeginTransactionRequest.Builder
avoiding the need
to create one manually via BeginTransactionRequest.builder()
beginTransactionRequest
- A Consumer
that will call methods on BeginTransactionRequest.Builder
to create a request.
The request parameters represent the input of a request to start a SQL transaction.resourceArn
parameter is
not available.default CompletableFuture<CommitTransactionResponse> commitTransaction(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.resourceArn
parameter is
not available.resourceArn
, secretArn
, or transactionId
value can't be found.default CompletableFuture<CommitTransactionResponse> commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest)
Ends a SQL transaction started with the BeginTransaction
operation and commits the changes.
This is a convenience which creates an instance of the CommitTransactionRequest.Builder
avoiding the need
to create one manually via CommitTransactionRequest.builder()
commitTransactionRequest
- A Consumer
that will call methods on CommitTransactionRequest.Builder
to create a request.
The request parameters represent the input of a commit transaction request.resourceArn
parameter is
not available.resourceArn
, secretArn
, or transactionId
value can't be found.default CompletableFuture<ExecuteSqlResponse> executeSql(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.resourceArn
parameter is
not available.default CompletableFuture<ExecuteSqlResponse> executeSql(Consumer<ExecuteSqlRequest.Builder> executeSqlRequest)
Runs one or more SQL statements.
This operation is deprecated. Use the BatchExecuteStatement
or ExecuteStatement
operation.
This is a convenience which creates an instance of the ExecuteSqlRequest.Builder
avoiding the need to
create one manually via ExecuteSqlRequest.builder()
executeSqlRequest
- A Consumer
that will call methods on ExecuteSqlRequest.Builder
to create a request. The
request parameters represent the input of a request to run one or more SQL statements.resourceArn
parameter is
not available.default CompletableFuture<ExecuteStatementResponse> executeStatement(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.
The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.
executeStatementRequest
- The request parameters represent the input of a request to run a SQL statement against a database.resourceArn
parameter is
not available.default CompletableFuture<ExecuteStatementResponse> executeStatement(Consumer<ExecuteStatementRequest.Builder> 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.
The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.
This is a convenience which creates an instance of the ExecuteStatementRequest.Builder
avoiding the need
to create one manually via ExecuteStatementRequest.builder()
executeStatementRequest
- A Consumer
that will call methods on ExecuteStatementRequest.Builder
to create a request.
The request parameters represent the input of a request to run a SQL statement against a database.resourceArn
parameter is
not available.default CompletableFuture<RollbackTransactionResponse> rollbackTransaction(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.resourceArn
parameter is
not available.resourceArn
, secretArn
, or transactionId
value can't be found.default CompletableFuture<RollbackTransactionResponse> rollbackTransaction(Consumer<RollbackTransactionRequest.Builder> rollbackTransactionRequest)
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
This is a convenience which creates an instance of the RollbackTransactionRequest.Builder
avoiding the
need to create one manually via RollbackTransactionRequest.builder()
rollbackTransactionRequest
- A Consumer
that will call methods on RollbackTransactionRequest.Builder
to create a
request. The request parameters represent the input of a request to perform a rollback of a transaction.resourceArn
parameter is
not available.resourceArn
, secretArn
, or transactionId
value can't be found.