awswrangler.data_api.rds.RdsDataApi

class awswrangler.data_api.rds.RdsDataApi(resource_arn: str, database: str, secret_arn: str = '', sleep: float = 0.5, backoff: float = 1.0, retries: int = 30, boto3_session: Session | None = None) → None

Provides access to the RDS Data API.

Parameters:

  • resource_arn (str) – ARN for the RDS resource.

  • database (str) – Target database name.

  • secret_arn (str) – The ARN for the secret to be used for authentication.

  • sleep (float) – Number of seconds to sleep between connection attempts to paused clusters - defaults to 0.5.

  • backoff (float) – Factor by which to increase the sleep between connection attempts to paused clusters - defaults to 1.0.

  • retries (int) – Maximum number of connection attempts to paused clusters - defaults to 10.

  • boto3_session (Session | None) – The default boto3 session will be used if boto3_session is None.

__init__(resource_arn: str, database: str, secret_arn: str = '', sleep: float = 0.5, backoff: float = 1.0, retries: int = 30, boto3_session: Session | None = None) → None

Methods

__init__(resource_arn, database[, ...])

batch_execute(sql[, database, ...])

Batch execute SQL statements against a Data API Service.

begin_transaction([database, schema])

Start an SQL transaction.

close()

Close underlying endpoint connections.

commit_transaction(transaction_id)

Commit an SQL transaction.

execute(sql[, database, transaction_id, ...])

Execute SQL statement against a Data API Service.

rollback_transaction(transaction_id)

Roll back an SQL transaction.