Dynamoose is a modeling tool for Amazon's DynamoDB
Clone or download
Latest commit 6654a5c Jan 20, 2019



Join the chat at https://gitter.im/dynamoosejs/Lobby Build Status Coverage Status

Dynamoose is a modeling tool for Amazon's DynamoDB (inspired by Mongoose)

Getting Started


$ npm install dynamoose


Set AWS configurations in enviroment varable:

export AWS_ACCESS_KEY_ID="Your AWS Access Key ID"
export AWS_SECRET_ACCESS_KEY="Your AWS Secret Access Key"
export AWS_REGION="us-east-1"

Here's a simple example:

var dynamoose = require('dynamoose');

// Create cat model with default options
var Cat = dynamoose.model('Cat', { id: Number, name: String });

// Create a new cat object
var garfield = new Cat({id: 666, name: 'Garfield'});

// Save to DynamoDB

// Lookup in DynamoDB
.then(function (badCat) {
  console.log('Never trust a smiling cat. - ' + badCat.name);

API Docs

The documentation can be found at https://dynamoosejs.com/api. You can also find additional examples at https://dynamoosejs.com/examples.

Help Wanted!

Help improve Dynamoose. I need all the help I can get to improve test coverage and the documentation. If you would like to help please look at the /test folder to add tests to the project along with /docs/_docs and /docs/_examples folders to help write better documentation and examples for Dynamoose. You can create a PR (pull request) to get your changes merged in. Thank you very much!!


The Dynamoose ChangeLog can be found in the CHANGELOG.md file.


The Dynamoose Roadmap can be found in the ROADMAP.md file. Help is always appreciated on these items. If you are able to help submit a PR so we can review and improve Dynamoose!