Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.49 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.49 KB
Raw

Catbox-DynamoDB

A Catbox external caching strategy

Usage

var Catbox = require('catbox');
var DynamoDB = require('catbox-dynamodb');
var options = {tableName: 'sampleTable'};
var policy = {expiresIn: 10000};
var client = new Catbox.Client(DynamoDB, options);
var cache = new Catbox.Policy(policy, client, 'segment');

Options

  • region - the DynamoDB region within AWS. Defaults to 'us-east-1'.
  • tableName - the table in DynamoDB you wish to use. Needs to be within the specified region.
  • hashAttribute - the attribute specified as the Hash key in the table. Defaults to 'segment'
  • rangeAttribute - the attribute specified as the Range key in the table. Defaults to 'id'
  • consistentRead - ask for strongly consistent reads during get calls. Defaults to false

Notes

At this point in time it is assumed that a table has been created prior to using this caching strategy.

When the table is created it will need to have the Primary Key set to Hash and Range.

If you do not set Hash to 'segment' and Range to 'id', you will need to specify these in the options for the strategy to work correctly.

You will also need to make sure that you have credentials in some place that the application can see them. For guidance, please see this article.

Testing

Note that running the test suite will actually run the tests against DynamoDB.

node test