Interface RdsDataClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface RdsDataClient
extends AwsClient

Service client for accessing AWS RDS DataService. This can be created using the static builder() method.

RDS Data API

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, provisioned, and Serverless v1

• Aurora MySQL - Serverless v2, provisioned, and Serverless v1

For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default 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 a RdsDataClient.
default CommitTransactionResponse	commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest)	Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
default CommitTransactionResponse	commitTransaction(CommitTransactionRequest commitTransactionRequest)	Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
static RdsDataClient	create()	Create a RdsDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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.
default RdsDataServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchExecuteStatement

default BatchExecuteStatementResponse batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)
                                                     throws SecretsErrorException,
HttpEndpointNotEnabledException,
DatabaseErrorException,
DatabaseResumingException,
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:

• AWS API Documentation

batchExecuteStatement

default BatchExecuteStatementResponse batchExecuteStatement(Consumer<BatchExecuteStatementRequest.Builder> batchExecuteStatementRequest)
                                                     throws SecretsErrorException,
HttpEndpointNotEnabledException,
DatabaseErrorException,
DatabaseResumingException,
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 via BatchExecuteStatementRequest.builder()

Parameters:

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.

Returns:

Result of the BatchExecuteStatement operation returned by the service.

See Also:

• AWS API Documentation

beginTransaction

default BeginTransactionResponse beginTransaction(BeginTransactionRequest beginTransactionRequest)
                                           throws SecretsErrorException,
HttpEndpointNotEnabledException,
DatabaseErrorException,
DatabaseResumingException,
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.

For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate ExecuteStatement call with continueAfterTimeout 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:

• AWS API Documentation

beginTransaction

default BeginTransactionResponse beginTransaction(Consumer<BeginTransactionRequest.Builder> beginTransactionRequest)
                                           throws SecretsErrorException,
HttpEndpointNotEnabledException,
DatabaseErrorException,
DatabaseResumingException,
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.

For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.

This is a convenience which creates an instance of the BeginTransactionRequest.Builder avoiding the need to create one manually via BeginTransactionRequest.builder()

Parameters:

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.

Returns:

Result of the BeginTransaction operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via CommitTransactionRequest.builder()

Parameters:

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.

Returns:

Result of the CommitTransaction operation returned by the service.

See Also:

• AWS API Documentation

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 Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement 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:

• AWS API Documentation

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 Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the 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()

Parameters:

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.

Returns:

Result of the ExecuteSql operation returned by the service.

See Also:

• AWS API Documentation

executeStatement

default ExecuteStatementResponse executeStatement(ExecuteStatementRequest executeStatementRequest)
                                           throws SecretsErrorException,
HttpEndpointNotEnabledException,
DatabaseErrorException,
DatabaseResumingException,
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:

• AWS API Documentation

executeStatement

default ExecuteStatementResponse executeStatement(Consumer<ExecuteStatementRequest.Builder> executeStatementRequest)
                                           throws SecretsErrorException,
HttpEndpointNotEnabledException,
DatabaseErrorException,
DatabaseResumingException,
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 via ExecuteStatementRequest.builder()

Parameters:

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.

Returns:

Result of the ExecuteStatement operation returned by the service.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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 via RollbackTransactionRequest.builder()

Parameters:

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.

Returns:

Result of the RollbackTransaction operation returned by the service.

See Also:

• AWS API Documentation

create

static RdsDataClient create()

Create a RdsDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static RdsDataClientBuilder builder()

Create a builder that can be used to configure and create a RdsDataClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default RdsDataServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration