rdsdata/aws.sdk.kotlin.services.rdsdata/RdsDataClient

RdsDataClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<RdsDataClient.Config, RdsDataClient.Config.Builder, RdsDataClient>

Companion

object Companion : AbstractAwsSdkClientFactory<RdsDataClient.Config, RdsDataClient.Config.Builder, RdsDataClient, RdsDataClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: RdsDataClient.Config

RdsDataClient's configuration

Functions

batchExecuteStatement

abstract suspend fun batchExecuteStatement(input: BatchExecuteStatementRequest): BatchExecuteStatementResponse

Runs a batch SQL statement over an array of data.

beginTransaction

abstract suspend fun beginTransaction(input: BeginTransactionRequest): BeginTransactionResponse

Starts a SQL transaction.

commitTransaction

abstract suspend fun commitTransaction(input: CommitTransactionRequest): CommitTransactionResponse

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

executeStatement

abstract suspend fun executeStatement(input: ExecuteStatementRequest): ExecuteStatementResponse

Runs a SQL statement against a database.

rollbackTransaction

abstract suspend fun rollbackTransaction(input: RollbackTransactionRequest): RollbackTransactionResponse

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Inherited functions

batchExecuteStatement

inline suspend fun RdsDataClient.batchExecuteStatement(crossinline block: BatchExecuteStatementRequest.Builder.() -> Unit): BatchExecuteStatementResponse

Runs a batch SQL statement over an array of data.

beginTransaction

inline suspend fun RdsDataClient.beginTransaction(crossinline block: BeginTransactionRequest.Builder.() -> Unit): BeginTransactionResponse

Starts a SQL transaction.

expect abstract fun close()

commitTransaction

inline suspend fun RdsDataClient.commitTransaction(crossinline block: CommitTransactionRequest.Builder.() -> Unit): CommitTransactionResponse

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

executeStatement

inline suspend fun RdsDataClient.executeStatement(crossinline block: ExecuteStatementRequest.Builder.() -> Unit): ExecuteStatementResponse

Runs a SQL statement against a database.

rollbackTransaction

inline suspend fun RdsDataClient.rollbackTransaction(crossinline block: RollbackTransactionRequest.Builder.() -> Unit): RollbackTransactionResponse

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

withConfig

fun RdsDataClient.withConfig(block: RdsDataClient.Config.Builder.() -> Unit): RdsDataClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.