Interface RdsDataClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).
Data API is available with the following types of Aurora databases:
-
Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned
-
Aurora MySQL - Serverless v1 only
For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault BatchExecuteStatementResponse
batchExecuteStatement
(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest) Runs a batch SQL statement over an array of data.default BatchExecuteStatementResponse
batchExecuteStatement
(BatchExecuteStatementRequest batchExecuteStatementRequest) Runs a batch SQL statement over an array of data.default BeginTransactionResponse
beginTransaction
(Consumer<BeginTransactionRequest.Builder> beginTransactionRequest) Starts a SQL transaction.default BeginTransactionResponse
beginTransaction
(BeginTransactionRequest beginTransactionRequest) Starts a SQL transaction.static RdsDataClientBuilder
builder()
Create a builder that can be used to configure and create aRdsDataClient
.default CommitTransactionResponse
commitTransaction
(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) Ends a SQL transaction started with theBeginTransaction
operation and commits the changes.default CommitTransactionResponse
commitTransaction
(CommitTransactionRequest commitTransactionRequest) Ends a SQL transaction started with theBeginTransaction
operation and commits the changes.static RdsDataClient
create()
Create aRdsDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default ExecuteSqlResponse
executeSql
(Consumer<ExecuteSqlRequest.Builder> executeSqlRequest) Deprecated.The ExecuteSql API is deprecated, please use the ExecuteStatement API.default ExecuteSqlResponse
executeSql
(ExecuteSqlRequest executeSqlRequest) Deprecated.The ExecuteSql API is deprecated, please use the ExecuteStatement API.default ExecuteStatementResponse
executeStatement
(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest) Runs a SQL statement against a database.default ExecuteStatementResponse
executeStatement
(ExecuteStatementRequest executeStatementRequest) Runs a SQL statement against a database.default RollbackTransactionResponse
rollbackTransaction
(Consumer<RollbackTransactionRequest.Builder> rollbackTransactionRequest) Performs a rollback of a transaction.default RollbackTransactionResponse
rollbackTransaction
(RollbackTransactionRequest rollbackTransactionRequest) Performs a rollback of a transaction.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchExecuteStatement
default BatchExecuteStatementResponse batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, AwsServiceException, SdkClientException, RdsDataException 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.
- Parameters:
batchExecuteStatementRequest
- The request parameters represent the input of a SQL statement over an array of data.- Returns:
- Result of the BatchExecuteStatement operation returned by the service.
- See Also:
-
batchExecuteStatement
default BatchExecuteStatementResponse batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, AwsServiceException, SdkClientException, RdsDataException 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.
This is a convenience which creates an instance of the
BatchExecuteStatementRequest.Builder
avoiding the need to create one manually viaBatchExecuteStatementRequest.builder()
- Parameters:
batchExecuteStatementRequest
- AConsumer
that will call methods onBatchExecuteStatementRequest.Builder
to create a request. The request parameters represent the input of a SQL statement over an array of data.- Returns:
- Result of the BatchExecuteStatement operation returned by the service.
- See Also:
-
beginTransaction
default BeginTransactionResponse beginTransaction(BeginTransactionRequest beginTransactionRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, AwsServiceException, SdkClientException, RdsDataException 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 withcontinueAfterTimeout
enabled.- Parameters:
beginTransactionRequest
- The request parameters represent the input of a request to start a SQL transaction.- Returns:
- Result of the BeginTransaction operation returned by the service.
- See Also:
-
beginTransaction
default BeginTransactionResponse beginTransaction(Consumer<BeginTransactionRequest.Builder> beginTransactionRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, AwsServiceException, SdkClientException, RdsDataException 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 withcontinueAfterTimeout
enabled.
This is a convenience which creates an instance of the
BeginTransactionRequest.Builder
avoiding the need to create one manually viaBeginTransactionRequest.builder()
- Parameters:
beginTransactionRequest
- AConsumer
that will call methods onBeginTransactionRequest.Builder
to create a request. The request parameters represent the input of a request to start a SQL transaction.- Returns:
- Result of the BeginTransaction operation returned by the service.
- See Also:
-
commitTransaction
default CommitTransactionResponse commitTransaction(CommitTransactionRequest commitTransactionRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, NotFoundException, AwsServiceException, SdkClientException, RdsDataException Ends a SQL transaction started with the
BeginTransaction
operation and commits the changes.- Parameters:
commitTransactionRequest
- The request parameters represent the input of a commit transaction request.- Returns:
- Result of the CommitTransaction operation returned by the service.
- See Also:
-
commitTransaction
default CommitTransactionResponse commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, NotFoundException, AwsServiceException, SdkClientException, RdsDataException 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 viaCommitTransactionRequest.builder()
- Parameters:
commitTransactionRequest
- AConsumer
that will call methods onCommitTransactionRequest.Builder
to create a request. The request parameters represent the input of a commit transaction request.- Returns:
- Result of the CommitTransaction operation returned by the service.
- See Also:
-
executeSql
@Deprecated default ExecuteSqlResponse executeSql(ExecuteSqlRequest executeSqlRequest) throws AccessDeniedException, BadRequestException, InternalServerErrorException, ForbiddenException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, RdsDataException Deprecated.The ExecuteSql API is deprecated, please use the ExecuteStatement API.Runs one or more SQL statements.
This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the operation is deprecated. Use the
BatchExecuteStatement
orExecuteStatement
operation.- Parameters:
executeSqlRequest
- The request parameters represent the input of a request to run one or more SQL statements.- Returns:
- Result of the ExecuteSql operation returned by the service.
- See Also:
-
executeSql
@Deprecated default ExecuteSqlResponse executeSql(Consumer<ExecuteSqlRequest.Builder> executeSqlRequest) throws AccessDeniedException, BadRequestException, InternalServerErrorException, ForbiddenException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, RdsDataException Deprecated.The ExecuteSql API is deprecated, please use the ExecuteStatement API.Runs one or more SQL statements.
This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the operation is deprecated. Use the
BatchExecuteStatement
orExecuteStatement
operation.
This is a convenience which creates an instance of the
ExecuteSqlRequest.Builder
avoiding the need to create one manually viaExecuteSqlRequest.builder()
- Parameters:
executeSqlRequest
- AConsumer
that will call methods onExecuteSqlRequest.Builder
to create a request. The request parameters represent the input of a request to run one or more SQL statements.- Returns:
- Result of the ExecuteSql operation returned by the service.
- See Also:
-
executeStatement
default ExecuteStatementResponse executeStatement(ExecuteStatementRequest executeStatementRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, UnsupportedResultException, AwsServiceException, SdkClientException, RdsDataException 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.
- Parameters:
executeStatementRequest
- The request parameters represent the input of a request to run a SQL statement against a database.- Returns:
- Result of the ExecuteStatement operation returned by the service.
- See Also:
-
executeStatement
default ExecuteStatementResponse executeStatement(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, UnsupportedResultException, AwsServiceException, SdkClientException, RdsDataException 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.
This is a convenience which creates an instance of the
ExecuteStatementRequest.Builder
avoiding the need to create one manually viaExecuteStatementRequest.builder()
- Parameters:
executeStatementRequest
- AConsumer
that will call methods onExecuteStatementRequest.Builder
to create a request. The request parameters represent the input of a request to run a SQL statement against a database.- Returns:
- Result of the ExecuteStatement operation returned by the service.
- See Also:
-
rollbackTransaction
default RollbackTransactionResponse rollbackTransaction(RollbackTransactionRequest rollbackTransactionRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, NotFoundException, AwsServiceException, SdkClientException, RdsDataException Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
- Parameters:
rollbackTransactionRequest
- The request parameters represent the input of a request to perform a rollback of a transaction.- Returns:
- Result of the RollbackTransaction operation returned by the service.
- See Also:
-
rollbackTransaction
default RollbackTransactionResponse rollbackTransaction(Consumer<RollbackTransactionRequest.Builder> rollbackTransactionRequest) throws SecretsErrorException, HttpEndpointNotEnabledException, DatabaseErrorException, DatabaseUnavailableException, TransactionNotFoundException, InvalidSecretException, ServiceUnavailableErrorException, ForbiddenException, DatabaseNotFoundException, AccessDeniedException, BadRequestException, StatementTimeoutException, InternalServerErrorException, NotFoundException, AwsServiceException, SdkClientException, RdsDataException 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 viaRollbackTransactionRequest.builder()
- Parameters:
rollbackTransactionRequest
- AConsumer
that will call methods onRollbackTransactionRequest.Builder
to create a request. The request parameters represent the input of a request to perform a rollback of a transaction.- Returns:
- Result of the RollbackTransaction operation returned by the service.
- See Also:
-
create
Create aRdsDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRdsDataClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-