mongoose-tree
Implements the materialized path strategy for storing a hierarchy of documents with mongoose
Usage
Install via NPM
$ npm install mongoose-tree
Then you can use the plugin on your schemas
var tree = ; var UserSchema = name : String;UserSchema;var User = mongoose; var adam = name : 'Adam' ;var bob = name : 'Bob' ;var carol = name : 'Carol' ; // Set the parent relationshipsbobparent = adam;carolparent = bob; adam;
At this point in mongoDB you will have documents similar to
{
"_id" : ObjectId("50136e40c78c4b9403000001"),
"name" : "Adam",
"path" : "50136e40c78c4b9403000001"
}
{
"_id" : ObjectId("50136e40c78c4b9403000002"),
"name" : "Bob",
"parent" : ObjectId("50136e40c78c4b9403000001"),
"path" : "50136e40c78c4b9403000001#50136e40c78c4b9403000002"
}
{
"_id" : ObjectId("50136e40c78c4b9403000003"),
"name" : "Carol",
"parent" : ObjectId("50136e40c78c4b9403000002"),
"path" : "50136e40c78c4b9403000001#50136e40c78c4b9403000002#50136e40c78c4b9403000003"
}
The path is used for recursive methods and is kept up to date by the plugin if the parent is changed
Options
Model
API
getChildren
Signature:
getChildren([recursive], cb);
if recursive is supplied and true subchildren are returned
Based on the above hierarchy:
adam; adam;
getAncestors
Signature:
getAncestors(cb);
Based on the above hierarchy:
carol
level
Equal to the level of the hierarchy
carollevel; // equals 3
Tests
To run the tests install mocha
npm install mocha -g
and then run
mocha