Docooment
A Mongoose like Azure DocuomentDB ORM based on Microsoft Azure DocumentDB Node.js SDK.
Plugins
Docooment is compatibile with most of mongoose plugins. Check out the plugins search site to see hundreds of related modules from the community.
Overview
Connecting to DocumentDB
To use Docooment, you need to first create an Azure account.
You can follow this tutorial to help you get started.
First, we need to define a connection.
connect
take a URI
, port
, database
and options
that contains the auth masterKey
.
var docooment = require('docooment');
docooment.connect('https://your-db-account.documents.azure.com', 443, 'yourDatabase' , {masterKey: 'yourMasterKey'});
Note: This documentantion is from Mongoose docs
Defining a Model
Models are defined through the Schema
interface.
var Schema = mongoose.Schema
, ObjectId = Schema.ObjectId;
var BlogPost = new Schema({
author : ObjectId
, title : String
, body : String
, date : Date
});
Aside from defining the structure of your documents and the types of data you're storing, a Schema handles the definition of:
The following example shows some of these features:
var Comment = new Schema({
name : { type: String, default: 'hahaha' }
, age : { type: Number, min: 18, index: true }
, bio : { type: String, match: /[a-z]/ }
, date : { type: Date, default: Date.now }
, buff : Buffer
});
Comment.path('name').set(function (v) {
return capitalize(v);
});
Comment.pre('save', function (next) {
notify(this.get('email'));
next();
});
Take a look at the example in examples/schema.js
for an end-to-end example of a typical setup.
Accessing a Model
Once we define a model through mongoose.model('ModelName', mySchema)
, we can access it through the same function
var myModel = mongoose.model('ModelName');
Or just do it all at once
var MyModel = mongoose.model('ModelName', mySchema);
We can then instantiate it, and save it:
var instance = new MyModel();
instance.my.key = 'hello';
instance.save(function (err) {
});
Or we can find documents from the same collection
MyModel.find({}, function (err, docs) {
});
You can also findOne
, findById
, update
, etc. For more details check out the docs.
Important! If you opened a separate connection using mongoose.createConnection()
but attempt to access the model through mongoose.model('ModelName')
it will not work as expected since it is not hooked up to an active db connection. In this case access your model through the connection you created:
var conn = mongoose.createConnection('your connection string')
, MyModel = conn.model('ModelName', schema)
, m = new MyModel;
m.save();
vs
var conn = mongoose.createConnection('your connection string')
, MyModel = mongoose.model('ModelName', schema)
, m = new MyModel;
m.save();
Embedded Documents
In the first example snippet, we defined a key in the Schema that looks like:
comments: [Comments]
Where Comments
is a Schema
we created. This means that creating embedded documents is as simple as:
var BlogPost = mongoose.model('BlogPost');
var post = new BlogPost();
post.comments.push({ title: 'My comment' });
post.save(function (err) {
if (!err) console.log('Success!');
});
The same goes for removing them:
BlogPost.findById(myId, function (err, post) {
if (!err) {
post.comments[0].remove();
post.save(function (err) {
});
}
});
Embedded documents enjoy all the same features as your models. Defaults, validators, middleware. Whenever an error occurs, it's bubbled to the save()
error callback, so error handling is a snap!
Mongoose interacts with your embedded documents in arrays atomically, out of the box.
Middleware
See the docs page.
Intercepting and mutating method arguments
You can intercept method arguments via middleware.
For example, this would allow you to broadcast changes about your Documents every time someone set
s a path in your Document to a new value:
schema.pre('set', function (next, path, val, typel) {
this.emit('set', path, val);
next();
});
Moreover, you can mutate the incoming method
arguments so that subsequent middleware see different values for those arguments. To do so, just pass the new values to next
:
.pre(method, function firstPre (next, methodArg1, methodArg2) {
next("altered-" + methodArg1.toString(), methodArg2);
});
.pre(method, function secondPre (next, methodArg1, methodArg2) {
console.log(methodArg1);
console.log(methodArg2);
next();
});
Schema gotcha
type
, when used in a schema has special meaning within Mongoose. If your schema requires using type
as a nested property you must use object notation:
new Schema({
broken: { type: Boolean }
, asset : {
name: String
, type: String
}
});
new Schema({
works: { type: Boolean }
, asset : {
name: String
, type: { type: String }
}
});
License
Copyright (c) 2015 DigitalRockers srl <dev@digitalrockers.it>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.