Cellar
Brainless short-term single-document storage for MongoDB
Cellar
is a small module built on top of Mongoose to allow easy short-term storage of simple schemas.
It's primary purpose is for storage of OAuth tokens and other data that you need cached for a short period.
Installation
Through NPM
$ npm install cellar
or using Git
$ git clone git://github.com/treygriffith/cellar.git node_modules/cellar/
API/How to Use
Instantiate Cellar with a collection name, mongoDB details or a Mongoose instance, and a schema
// with Mongoose and Mongoose Schemavar mongoose = ;var mongoUrl = 'mongodb://' + dbuser + ':' + dbpass + '@' + dbhost + ':' + dbport + '/' + dbname;mongoose;var myschema = mongoose;var cellar = 'mystore' mongoose myschema maxAge:3;// with mongoDB details and object literal of Schema (maxAge of -1 stores docs forever)var cellar = 'mystore' user:dbuser pass:dbpass host:dbhost port:dbport name:dbname hello: String stored_by: String maxAge:-1;
Cellar exposes 3 methods:
-
store
- Create and update documents in the collection// Create Doc/Insertcellar;// Update existing// As of 0.0.2, this syntax will upsert, resulting in a document of {hello: "planet", stored_by: "cellar"}cellar -
retrieve
- Find and return single documents in the collection// Find whole doccellar;// Find doc with only 1 field returnedcellar; -
retrieve_field
- Find and return the contents of a single field on a single document in the collection// Find contents of one fieldcellar