Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RDSData

Amazon RDS Data Service

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these statements, you work with the Data Service API.

The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.

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

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of RDSDataClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

batchExecuteStatement

  • 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

    Returns Promise<BatchExecuteStatementCommandOutput>

  • 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

    Returns void

  • 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

    Returns void

  • 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

    • args: BatchExecuteStatementCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<BatchExecuteStatementCommandOutput>

  • 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

    Returns void

  • 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

    Returns void

beginTransaction

  • 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 with continueAfterTimeout enabled.

    Parameters

    Returns Promise<BeginTransactionCommandOutput>

  • 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 with continueAfterTimeout enabled.

    Parameters

    Returns void

  • 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 with continueAfterTimeout enabled.

    Parameters

    Returns void

  • 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 with continueAfterTimeout enabled.

    Parameters

    • args: BeginTransactionCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<BeginTransactionCommandOutput>

  • 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 with continueAfterTimeout enabled.

    Parameters

    Returns void

  • 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 with continueAfterTimeout enabled.

    Parameters

    Returns void

commitTransaction

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

executeSql

executeStatement

  • 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

    Returns Promise<ExecuteStatementCommandOutput>

  • 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

    Returns void

  • 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

    Returns void

  • 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

    • args: ExecuteStatementCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ExecuteStatementCommandOutput>

  • 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

    Returns void

  • 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

    Returns void

rollbackTransaction

send