@brightcove/dynamodb-connector

DynamoDB Connector

Provides a standardized way to connect to an AWS DynamoDB database using the v3 AWS javascript SDK.

Node Version: ~> 18.12 NPM Version: ~> 9.1

Install

npm install @brightcove/dynamodb-connector --save

Usage

const DynamoDBConnector = require('@brightcove/dynamodb-connector');
const db = new DynamoDBConnector(options);
...
const result = await db.query({
    TableName: 'my-table',
    ...
});

Options

Param	Type	Description	Required
dynamodb	DynamoDBClientConfig	https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/interfaces/dynamodbclientconfig.html	yes
logger	Logger	What will be used for logging errors (ie. logger.error()). console is used by default if not specified	no
sanitizedFields	array	The default list of fields to filter out of items when calling sanitize	no