@aws-lite/rds-data

0.0.8 • Public • Published

Official aws-lite plugin for RDS Data Service

Maintained by: @andybee

Install

npm i @aws-lite/rds-data

Optionally install types:

npm i -D @aws-lite/rds-data-types

Reference

Reference documentation with examples at aws-lite.org

Methods

BatchExecuteStatement

Canonical AWS API doc

Properties:

  • database (string)
    • Name of the database
  • parameterSets (array)
    • Parameter set for the batch operation
  • resourceArn (string) [required]
    • Amazon Resource Name (ARN) of the Aurora Serverless DB cluster
  • schema (string)
    • Name of the database schema
  • secretArn (string) [required]
    • ARN of the secret that enables access to the DB cluster
  • sql (string) [required]
    • SQL statement to run
  • transactionId (string)
    • Transaction ID of the transaction that you want to include the SQL statement in

BeginTransaction

Canonical AWS API doc

Properties:

  • database (string)
    • Name of the database
  • resourceArn (string) [required]
    • Amazon Resource Name (ARN) of the Aurora Serverless DB cluster
  • schema (string)
    • Name of the database schema
  • secretArn (string) [required]
    • ARN of the secret that enables access to the DB cluster

CommitTransaction

Canonical AWS API doc

Properties:

  • resourceArn (string) [required]
    • Amazon Resource Name (ARN) of the Aurora Serverless DB cluster
  • secretArn (string) [required]
    • ARN of the secret that enables access to the DB cluster
  • transactionId (string) [required]
    • Identifier of the transaction to end and commit

ExecuteStatement

Canonical AWS API doc

Properties:

  • continueAfterTimeout (boolean)
    • Value that indicates whether to continue running the statement after the call times out
  • database (string)
    • Name of the database
  • formatRecordsAs (string)
    • Indicates whether to format the result set as a single JSON string: 'NONE', or 'JSON'
  • includeResultMetadata (boolean)
    • Value that indicates whether to include metadata in the results
  • parameters (array)
    • Parameters for the SQL statement
  • resourceArn (string) [required]
    • Amazon Resource Name (ARN) of the Aurora Serverless DB cluster
  • resultSetOptions (object)
    • Options that control how the result set is returned
  • schema (string)
    • Name of the database schema
  • secretArn (string) [required]
    • ARN of the secret that enables access to the DB cluster
  • sql (string) [required]
    • SQL statement to run
  • transactionId (string)
    • Transaction ID of the transaction that you want to include the SQL statement in

RollbackTransaction

Canonical AWS API doc

Properties:

  • resourceArn (string) [required]
    • Amazon Resource Name (ARN) of the Aurora Serverless DB cluster
  • secretArn (string) [required]
    • ARN of the secret that enables access to the DB cluster
  • transactionId (string) [required]
    • Identifier of the transaction to roll back

Deprecated methods

Learn more

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-lite/rds-data

Weekly Downloads

27

Version

0.0.8

License

Apache-2.0

Unpacked Size

8.28 kB

Total Files

4

Last publish

Collaborators

  • brianleroux
  • architectci
  • ryanblock