@datafire/amazonaws_rds_data NPM

@datafire/amazonaws_rds_data

Client library for AWS RDS DataService

Installation and Usage

npm install --save @datafire/amazonaws_rds_data

let amazonaws_rds_data = require('@datafire/amazonaws_rds_data').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

BatchExecuteStatement

amazonaws_rds_data.BatchExecuteStatement({
  "resourceArn": "",
  "secretArn": "",
  "sql": ""
}, context)

Input

input object
- database string: The name of the database.
- parameterSets array: The parameter set for the batch operation. The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options: Specify one or more empty parameter sets. Use the ExecuteStatement operation instead of the BatchExecuteStatement operation. Array parameters are not supported.
  - items SqlParametersList
- resourceArn required string: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- schema string: The name of the database schema.
- secretArn required string: The name or ARN of the secret that enables access to the DB cluster.
- sql required string: The SQL statement to run.
- transactionId string: The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in. If the SQL statement is not part of a transaction, don't set this parameter.

Output

output BatchExecuteStatementResponse

BeginTransaction

amazonaws_rds_data.BeginTransaction({
  "resourceArn": "",
  "secretArn": ""
}, context)

Input

input object
- database string: The name of the database.
- resourceArn required string: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- schema string: The name of the database schema.
- secretArn required string: The name or ARN of the secret that enables access to the DB cluster.

Output

output BeginTransactionResponse

CommitTransaction

amazonaws_rds_data.CommitTransaction({
  "resourceArn": "",
  "secretArn": "",
  "transactionId": ""
}, context)

Input

input object
- resourceArn required string: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- secretArn required string: The name or ARN of the secret that enables access to the DB cluster.
- transactionId required string: The identifier of the transaction to end and commit.

Output

output CommitTransactionResponse

ExecuteStatement

amazonaws_rds_data.ExecuteStatement({
  "resourceArn": "",
  "secretArn": "",
  "sql": ""
}, context)

Input

input object
- parameters array: The parameters for the SQL statement. Array parameters are not supported.
  - items SqlParameter
- continueAfterTimeout boolean: A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out. For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.
- database string: The name of the database.
- includeResultMetadata boolean: A value that indicates whether to include metadata in the results.
- resourceArn required string: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- resultSetOptions object: Options that control how the result set is returned.
  - decimalReturnType
- schema string: The name of the database schema.
- secretArn required string: The name or ARN of the secret that enables access to the DB cluster.
- sql required string: The SQL statement to run.
- transactionId string: The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in. If the SQL statement is not part of a transaction, don't set this parameter.

Output

output ExecuteStatementResponse

ExecuteSql

amazonaws_rds_data.ExecuteSql({
  "awsSecretStoreArn": "",
  "dbClusterOrInstanceArn": "",
  "sqlStatements": ""
}, context)

Input

input object
- awsSecretStoreArn required string: The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.
- database string: The name of the database.
- dbClusterOrInstanceArn required string: The ARN of the Aurora Serverless DB cluster.
- schema string: The name of the database schema.
- sqlStatements required string: One or more SQL statements to run on the DB cluster. You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

Output

output ExecuteSqlResponse

RollbackTransaction

amazonaws_rds_data.RollbackTransaction({
  "resourceArn": "",
  "secretArn": "",
  "transactionId": ""
}, context)

Input

input object
- resourceArn required string: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- secretArn required string: The name or ARN of the secret that enables access to the DB cluster.
- transactionId required string: The identifier of the transaction to roll back.

Output

output RollbackTransactionResponse

Definitions

Arn

Arn string

ArrayOfArray

ArrayOfArray array: An array of arrays. Some array entries can be null.
- items ArrayValue

ArrayValue

ArrayValue object: Contains an array.
- arrayValues
  - items ArrayValue
- booleanValues
  - items BoxedBoolean
- doubleValues
  - items BoxedDouble
- longValues
  - items BoxedLong
- stringValues
  - items String

ArrayValueList

ArrayValueList array
- items Value

BadRequestException

BatchExecuteStatementRequest

BatchExecuteStatementRequest object: The request parameters represent the input of a SQL statement over an array of data.
- database
- parameterSets
  - items SqlParametersList
- resourceArn required
- schema
- secretArn required
- sql required
- transactionId

BatchExecuteStatementResponse

BatchExecuteStatementResponse object: The response elements represent the output of a SQL statement over an array of data.
- updateResults
  - items UpdateResult

BeginTransactionRequest

BeginTransactionRequest object: The request parameters represent the input of a request to start a SQL transaction.
- database
- resourceArn required
- schema
- secretArn required

BeginTransactionResponse

BeginTransactionResponse object: The response elements represent the output of a request to start a SQL transaction.
- transactionId

Blob

Blob string

Boolean

Boolean boolean

BooleanArray

BooleanArray array: An array of Boolean values. Some array entries can be null.
- items BoxedBoolean

BoxedBoolean

BoxedBoolean boolean

BoxedDouble

BoxedDouble number

BoxedFloat

BoxedFloat number

BoxedInteger

BoxedInteger integer

BoxedLong

BoxedLong integer

ColumnMetadata

ColumnMetadata object: Contains the metadata for a column.
- arrayBaseColumnType
- isAutoIncrement
- isCaseSensitive
- isCurrency
- isSigned
- label
- name
- nullable
- precision
- scale
- schemaName
- tableName
- type
- typeName

CommitTransactionRequest

CommitTransactionRequest object: The request parameters represent the input of a commit transaction request.
- resourceArn required
- secretArn required
- transactionId required

CommitTransactionResponse

CommitTransactionResponse object: The response elements represent the output of a commit transaction request.
- transactionStatus

DbName

DbName string

DecimalReturnType

DecimalReturnType string (values: DOUBLE_OR_LONG, STRING)

DoubleArray

DoubleArray array: An array of floating point numbers. Some array entries can be null.
- items BoxedDouble

ExecuteSqlRequest

ExecuteSqlRequest object: The request parameters represent the input of a request to run one or more SQL statements.
- awsSecretStoreArn required
- database
- dbClusterOrInstanceArn required
- schema
- sqlStatements required

ExecuteSqlResponse

ExecuteSqlResponse object: The response elements represent the output of a request to run one or more SQL statements.
- sqlStatementResults
  - items SqlStatementResult

ExecuteStatementRequest

ExecuteStatementRequest object: The request parameters represent the input of a request to run a SQL statement against a database.
- parameters
  - items SqlParameter
- continueAfterTimeout
- database
- includeResultMetadata
- resourceArn required
- resultSetOptions
  - decimalReturnType
- schema
- secretArn required
- sql required
- transactionId

ExecuteStatementResponse

ExecuteStatementResponse object: The response elements represent the output of a request to run a SQL statement against a database.
- columnMetadata
  - items ColumnMetadata
- generatedFields
  - items Field
- numberOfRecordsUpdated
- records
  - items FieldList

Field

Field object: Contains a value.
- arrayValue
  - arrayValues
    - items ArrayValue
  - booleanValues
    - items BoxedBoolean
  - doubleValues
    - items BoxedDouble
  - longValues
    - items BoxedLong
  - stringValues
    - items String
- blobValue
- booleanValue
- doubleValue
- isNull
- longValue
- stringValue

FieldList

FieldList array
- items Field

ForbiddenException

Id

Id string

Integer

Integer integer

InternalServerErrorException

Long

Long integer

LongArray

LongArray array: An array of integers. Some array entries can be null.
- items BoxedLong

Metadata

Metadata array
- items ColumnMetadata

NotFoundException

ParameterName

ParameterName string

Record

Record object: A record returned by a call.
- values
  - items Value

Records

Records array
- items Record

RecordsUpdated

RecordsUpdated integer

ResultFrame

ResultFrame object: The result set returned by a SQL statement.
- records
  - items Record
- resultSetMetadata
  - columnCount
  - columnMetadata
    - items ColumnMetadata

ResultSetMetadata

ResultSetMetadata object: The metadata of the result set returned by a SQL statement.
- columnCount
- columnMetadata
  - items ColumnMetadata

ResultSetOptions

ResultSetOptions object: Options that control how the result set is returned.
- decimalReturnType

RollbackTransactionRequest

RollbackTransactionRequest object: The request parameters represent the input of a request to perform a rollback of a transaction.
- resourceArn required
- secretArn required
- transactionId required

RollbackTransactionResponse

RollbackTransactionResponse object: The response elements represent the output of a request to perform a rollback of a transaction.
- transactionStatus

Row

Row array
- items Value

ServiceUnavailableError

SqlParameter

SqlParameter object: A parameter used in a SQL statement.
- name
- typeHint
- value
  - arrayValue
    - arrayValues
      - items ArrayValue
    - booleanValues
      - items BoxedBoolean
    - doubleValues
      - items BoxedDouble
    - longValues
      - items BoxedLong
    - stringValues
      - items String
  - blobValue
  - booleanValue
  - doubleValue
  - isNull
  - longValue
  - stringValue

SqlParameterSets

SqlParameterSets array
- items SqlParametersList

SqlParametersList

SqlParametersList array
- items SqlParameter

SqlRecords

SqlRecords array
- items FieldList

SqlStatement

SqlStatement string

SqlStatementResult

SqlStatementResult object: The result of a SQL statement. <important> <p>This data type is deprecated.</p> </important>
- numberOfRecordsUpdated
- resultFrame
  - records
    - items Record
  - resultSetMetadata
    - columnCount
    - columnMetadata
      - items ColumnMetadata

SqlStatementResults

SqlStatementResults array
- items SqlStatementResult

StatementTimeoutException

String

String string

StringArray

StringArray array: An array of strings. Some array entries can be null.
- items String

StructValue

StructValue object: A structure value returned by a call.
- attributes
  - items Value

TransactionStatus

TransactionStatus string

TypeHint

TypeHint string (values: DATE, DECIMAL, TIME, TIMESTAMP)

UpdateResult

UpdateResult object: The response elements represent the results of an update.
- generatedFields
  - items Field

UpdateResults

UpdateResults array
- items UpdateResult

Value

Value object: Contains the value of a column. <important> <p>This data type is deprecated.</p> </important>
- arrayValues
  - items Value
- bigIntValue
- bitValue
- blobValue
- doubleValue
- intValue
- isNull
- realValue
- stringValue
- structValue
  - attributes
    - items Value

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

5 years ago