dynamodb-fast-access

dynamodb-fast-access

Default CRUD operations for managing AWS DynamoDB table items in an easy-to-extend structure.

Quick example

import * as DDFA from 'dynamodb-fast-access';

DDFA.DatabaseConfig.init({
    maxRetries: 9,
    tables: [{
        tableAlias: 'Products',
        tableName: 'Products_test',
        partitionKeyName: 'id',
        partitionKeyType: 'string'
    }]
});

class ProductsDB extends DDFA.DBMutable<any, any, any>('Products') {
    // You inherit a lot of basic functions
    // You can write further DB queries here
}

ProductsDB.create({ id: '123456abc', name: 'gloves', color: 'red' });
ProductsDB.getById('123456abc');
ProductsDB.deleteById('123456abc');
// And a lot more...

Usage

1. Configure the library by invoking the init function with the database configuration parameters. You can optionally provide your own configured AWS DynamoDB DocumentClient instance, otherwise it will be created.

2. (optional, recommended) Create the models for your database objects:

   • RawModel: that describes the object that is stored in the database.
   • Model: that describes the object that is stored in the database extended by additional derived attributes.
   • UpdateModel: that describes the attributes of the object that is stored in the database that are mutable.

3. (optional, recommended) Create the extender function that accepts RawModel type object array and returns Model type object array. This will extend your the raw database object upon request. (The default extender function does not modify the database objects.)

4. (optional) Create the deleter function to perform some task before the object is being deleted. This function is invoked before an item is deleted. (The default deleter function does not do anything.)

5. Create the database class by extending one of the provided base classes that provide a lot of basic functions to access the database. You can write your own database functions here as well.

Database configuration parameters

Example:

{
    maxRetries: 9,
    tables: [{
        tableAlias: 'Products',
        tableName: 'Products_test',
        partitionKeyName: 'id',
        partitionKeyType: 'string',
        sortKeyName: 'timestamp',
        sortKeyType: 'number',
        sortKeySeparator: '
Provided function descriptions



Function
Description



getTableAlias
Returns the configured alias of the DynamoDB table.


getTableName
Returns the configured name of the DynamoDB table.


getPartitionKeyName
Returns the configured name of the partition key of the DynamoDB table.


getPartitionKeyType
Returns the configured type of the partition key of the DynamoDB table.


getSortKeyName
Returns the configured name of the sort key of the DynamoDB table.


getSortKeyType
Returns the configured type of the sort key of the DynamoDB table.


getSortKeySeparator
Returns the string that separates the partition key and sort key.


create
Creates an entry in the DynamoDB table and returns the extended entry.


createRaw
Creates an entry in the DynamoDB table and returns the raw entry.


createBatch
Creates entries in the DynamoDB table and returns the extended entries.


createBatchRaw
Creates entries in the DynamoDB table and returns the raw entries.


getById
Returns the extended entry from the DynamoDB table by its id. Throws 'Resource does not exist.' error if entry with the provided id does not exist.


getByIdRaw
Returns the raw entry from the DynamoDB table by its id. Throws 'Resource does not exist.' error if entry with the provided id does not exist.


getByIds
Returns the extended entries from the DynamoDB table by their ids using AWS DynamoDB batchGet.


getByIdsRaw
Returns the raw entries from the DynamoDB table by their ids using AWS DynamoDB batchGet.


scanFiltered
Returns the extended entries from the DynamoDB table using AWS DynamoDB scan recursively.


scanFilteredRaw
Returns the raw entries from the DynamoDB table using AWS DynamoDB scan recursively.


deleteById
Deletes the entry from the DynamoDB table by its id. If the base class was initiated with a deleter function, then it is called before the item is deleted. Returns the id of the deleted entry if the delete is successful (also shadows DynamoDB 'ResourceNotFoundException' and considers the delete successful) and throws DynamoDB exceptions otherwise.


deleteByIds
Deletes entries from the DynamoDB table by their ids using AWS DynamoDB batchWrite. If the base class was initiated with a deleter function, then it is called before the item is deleted. Returns the ids of the deleted entries if deletes are successful and throws DynamoDB exceptions otherwise.


deleteScanFiltered
Deletes entries from the DynamoDB table by filter attributes (an attribute to match a specific value or an array to contain a specific item) using AWS DynamoDB scan and AWS DynamoDB batchWrite recursively. If the base class was initiated with a deleter function, then it is called before the item is deleted.


updateById
Updates the provided attributes of an entry of a DynamoDB table by id.


updateByIdWithDelete
Updates and deletes the provided attributes of an entry of a DynamoDB table by id.


query
Returns the extended entries from the DynamoDB table that has the provided partition key using AWS DynamoDB query.


queryRaw
Returns the raw entries from the DynamoDB table that has the provided partition key using AWS DynamoDB query.


queryRecurse
Performs a recursive query and returns the extended entries from the DynamoDB table that has the provided partition key using AWS DynamoDB query.


queryRecurseRaw
Performs a recursive query and returns the raw entries from the DynamoDB table that has the provided partition key using AWS DynamoDB query.


queryBeginsWith
Returns the extended entries from the DynamoDB table that has the provided partition key and whose sort key begins with the provided value using AWS DynamoDB query.


queryBeginsWithRaw
Returns the raw entries from the DynamoDB table that has the provided partition key and whose sort key begins with the provided value using AWS DynamoDB query.


queryBeginsWithRecurse
Performs a recursive query and returns the extended entries from the DynamoDB table that has the provided partition key and whose sort key begins with the provided value using AWS DynamoDB query.


queryBeginsWithRecurseRaw
Performs a recursive query and returns the raw entries from the DynamoDB table that has the provided partition key and whose sort key begins with the provided value using AWS DynamoDB query.


combineKeys
Combines the provided DynamoDB Key object attributes by concatenating the partition key and the optional sort key by the configured separator.


Base class functions



Function
DB
DBComposite
DBMutable
DBCompositeMutable



getTableAlias
✓
✓
✓
✓


getTableName
✓
✓
✓
✓


getPartitionKeyName
✓
✓
✓
✓


getPartitionKeyType
✓
✓
✓
✓


getSortKeyName
✓
✓
✓
✓


getSortKeyType
✓
✓
✓
✓


getSortKeySeparator
✓
✓
✓
✓


create
✓
✓
✓
✓


createRaw
✓
✓
✓
✓


createBatch
✓
✓
✓
✓


createBatchRaw
✓
✓
✓
✓


getById
✓
✓
✓
✓


getByIdRaw
✓
✓
✓
✓


getByIds
✓
✓
✓
✓


getByIdsRaw
✓
✓
✓
✓


scanFiltered
✓
✓
✓
✓


scanFilteredRaw
✓
✓
✓
✓


deleteById
✓
✓
✓
✓


deleteByIds
✓
✓
✓
✓


deleteScanFiltered
✓
✓
✓
✓


updateById


✓
✓


updateByIdWithDelete


✓
✓


query

✓

✓


queryRaw

✓

✓


queryRecurse

✓

✓


queryRecurseRaw

✓

✓


queryBeginsWith

✓

✓


queryBeginsWithRaw

✓

✓


queryBeginsWithRecurse

✓

✓


queryBeginsWithRecurseRaw

✓

✓


combineKeys

✓

✓



    }]
}

Provided function descriptions

Base class functions