0.0.8 • Published 1 year ago
@aws-lite/rds-data v0.0.8
@aws-lite/rds-data
Official
aws-liteplugin for RDS Data ServiceMaintained by: @andybee
Install
npm i @aws-lite/rds-dataOptionally install types:
npm i -D @aws-lite/rds-data-typesReference
Reference documentation with examples at aws-lite.org
Methods
BatchExecuteStatement
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
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
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
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
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