# mongoskin [](http://travis-ci.org/kissjs/node-mongoskin)
This project is a wrapper of [node-mongodb-native](https://github.com/mongodb/node-mongodb-native).
The api is same to node-mongodb-native, please see the [document](http://mongodb.github.com/node-mongodb-native/) first.
## Test
* test results: [test_results.md](https://github.com/kissjs/node-mongoskin/blob/master/test_results.md)
* jscoverage: [**89%**](http://fengmk2.github.com/coverage/mongoskin.html)
## Test pass [mongodb] versions
* >= 0.9.8 < 1.0.0: mongodb have bug, it will throw a `TypeError: object is not a function`
when connection open error.
* 1.0.x
* 1.1.x
* 1.2.x
```bash
$ make test
```
# Mongoskin document
* [Nodejs mongodb drivers comparation](#comparation)
* [Install](#install)
* [Quick Start](#quickstart)
* [Connect easier](#quickstart-1)
* [Server options and BSON options](#quickstart-2)
* [Similar API with node-mongodb-native](#quickstart-3)
* [Cursor easier](#quickstart-4)
* [MVC helper](#quickstart-5)
* [Documentation](#documentation)
* [Module](#module)
* [SkinServer](#skinserver)
* [SkinDb](#skindb)
* [SkinCollection](#skincollection)
* [Additional methods](#additional-collection-op)
* [Collection operation](#inherit-collection-op)
* [Indexes](#inherit-indexes)
* [Querying](#inherit-query)
* [Aggregation](#inherit-aggregation)
* [Inserting](#inherit-inserting)
* [Updating](#inherit-updating)
* [Removing](#inherit-removing)
* [SkinCursor](#skincursor)
Nodejs Mongodb Driver Comparison
========
node-mongodb-native
--------
One of the most powerful Mongo drivers is node-mongodb-native. Most other drivers build
on top of it, including mongoskin. Unfortunately, it has an awkward interface with too many
callbacks. Also, mongoskin needs a way to hold a Collection instance as an MVC model.
See [mongodb-native](https://github.com/christkv/node-mongodb-native/tree/master/docs)
mongoose
--------
Mongoose provides an ORM way to hold Collection instance as Model,
you should define schema first. But why mongodb need schema?
Some guys like me, want to write code from application layer but not database layer,
and we can use any fields without define it before.
Mongoose provide a DAL that you can do validation, and write your middlewares.
But some guys like me would like to validate manually, I think it is the tao of mongodb.
If you don't thinks so, [Mongoose-ORM](https://github.com/LearnBoost/mongoose) is probably your choice.
mongoskin
--------
Mongoskin is an easy to use driver of mongodb for nodejs,
it is similar with mongo shell, powerful like node-mongodb-native,
and support additional javascript method binding, which make it can act as a Model(in document way).
It will provide full features of [node-mongodb-native](https://github.com/christkv/node-mongodb-native),
and make it [future](http://en.wikipedia.org/wiki/Future_%28programming%29).
If you need validation, you can use [node-iform](https://github.com/guileen/node-iform).
[Back to index](#index)
Install
========
```bash
$ npm install mongoskin
```
[Back to index](#index)
Quick Start
========
**Is mongoskin synchronized?**
Nope! It is asynchronized, it use the [future pattern](http://en.wikipedia.org/wiki/Future_%28programming%29).
**Mongoskin** is the future layer above [node-mongodb-native](https://github.com/christkv/node-mongodb-native)
Connect easier
--------
You can connect to mongodb easier now.
```js
var mongo = require('mongoskin');
mongo.db('localhost:27017/testdb').collection('blog').find().toArray(function (err, items) {
console.dir(items);
})
```
Server options and BSON options
--------
You can also set `auto_reconnect` options querystring.
And native_parser options will automatically set if native_parser is available.
```js
var mongo = require('mongoskin');
var db = mongo.db('localhost:27017/test?auto_reconnect');
```
Similar API with node-mongodb-native
--------
You can do everything that node-mongodb-native can do.
```js
db.createCollection(...);
db.collection('user').ensureIndex([['username', 1]], true, function (err, replies) {});
db.collection('posts').hint = 'slug';
db.collection('posts').findOne({slug: 'whats-up'}, function (err, post) {
// do something
});
```
Cursor easier
--------
```js
db.collection('posts').find().toArray(function (err, posts) {
// do something
});
```
MVC helper
--------
You can bind **additional methods** for collection.
It is very useful if you want to use MVC patterns with nodejs and mongodb.
You can also invoke collection by properties after bind,
it could simplfy your `require`.
To keep your code in line with DRY principles, it's possible to create your own
data layer by for example, setting up your own validators and/or default values
inside the MVC methods as shown below in the config example
```js
db.bind('posts', {
findTop10 : function (fn) {
this.find({}, {limit:10, sort:[['views', -1]]}).toArray(fn);
},
removeTagWith : function (tag, fn) {
this.remove({tags:tag},fn);
}
}
});
db.bind('settings', {
getAll: function(user, fn) {
this.find({user: user}).toArray(function(err, settings) {
// We want to set a default currency from within our app instead of storing it
// for every user
settings.currency = (typeof settings.currency !== "undefined") ? settings.currency : 'USD';
fn(err, settings);
});
}
});
db.bind('comments');
db.collection('posts').removeTagWith('delete', function (err, replies) {
//do something
});
db.posts.findTop10(function (err, topPosts) {
//do something
});
db.comments.find().toArray(function (err, comments) {
//do something
});
```
[Back to index](#index)
Documentation
========
for more information, see the source.
[Back to index](#index)
Module
--------
### MongoSkin Url format
```
[*://][username:password@]host[:port][/database][?auto_reconnect[=true|false]]`
```
e.g.
```
localhost/blog
mongo://admin:pass@127.0.0.1:27017/blog?auto_reconnect
127.0.0.1?auto_reconnect=false
```
### db(serverURL[s], dbOptions, replicasetOptions)
Get or create instance of [SkinDb](#skindb).
```js
var db = mongoskin.db('localhost:27017/testdb?auto_reconnect=true&poolSize=5');
```
for ReplSet server
```js
var db = mongoskin.db([
'192.168.0.1:27017/?auto_reconnect=true',
'192.168.0.2:27017/?auto_reconnect=true',
'192.168.0.3:27017/?auto_reconnect=true'
], {
database: 'testdb',
safe: true
}, {
connectArbiter: false,
socketOptions: {
timeout: 2000
}
});
```
### router(select)
select is `function(collectionName)` returns a database instance, means router collectionName to that database.
```js
var db = mongo.router(function (coll_name) {
switch(coll_name) {
case 'user':
case 'message':
return mongo.db('192.168.1.3/auth_db');
default:
return mongo.db('192.168.1.2/app_db');
}
});
db.bind('user', require('./shared-user-methods'));
var users = db.user; //auth_db.user
var messages = db.collection('message'); // auth_db.message
var products = db.collection('product'); //app_db.product
```
### classes extends frome node-mongodb-native
* BSONPure
* BSONNative
* BinaryParser
* Binary
* Code
* DBRef
* Double
* MaxKey
* MinKey
* ObjectID
* Symbol
* Timestamp
* Long
* BaseCommand
* DbCommand
* DeleteCommand
* GetMoreCommand
* InsertCommand
* KillCursorCommand
* QueryCommand
* UpdateCommand
* MongoReply
* Admin
* Collection
* Connection
* Server
* ReplSetServers
* Cursor
* Db
* connect
* Grid
* Chunk
* GridStore
* native
* pure
[Back to index](#index)
SkinServer
--------
### SkinServer(server)
Construct SkinServer from native Server instance.
### db(dbname, username=null, password=null)
Construct [SkinDb](#skindb) from SkinServer.
[Back to index](#index)
SkinDb
--------
### SkinDb(db, username=null, password=null)
Construct SkinDb.
### open(callback)
Connect to database, retrieval native
[Db](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/db.js#L17)
instance, callback is function(err, db).
### collection(collectionName)
Retrieval [SkinCollection](#skincollection) instance of specified collection name.
### bind(collectionName)
### bind(collectionName, SkinCollection)
### bind(collectionName, extendObject1, extendObject2 ...)
Bind [SkinCollection](#skincollection) to db properties as a shortcut to db.collection(name).
You can also bind additional methods to the SkinCollection, it is useful when
you want to reuse a complex operation. This will also affect
db.collection(name) method.
e.g.
```js
db.bind('book', {
firstBook: function (fn) {
this.findOne(fn);
}
});
db.book.firstBook(function (err, book) {});
```
### all the methods from Db.prototype
See [Db](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/db.js#L17) of node-mongodb-native for more information.
[Back to index](#index)
SkinCollection
--------
See [Collection](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js#L45) of node-mongodb-native for more information.
### open(callback)
Retrieval native
[Collection](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js#L45)
instance, callback is function(err, collection).
### id(hex)
Equivalent to
```js
db.bson_serializer.ObjectID.createFromHexString(hex);
```
See [ObjectID.createFromHexString](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/bson/bson.js#L548)
### Collection operation
```js
checkCollectionName(collectionName)
options(callback)
rename(collectionName, callback)
drop(callback)
```
### Indexes
```js
createIndex(fieldOrSpec, unique, callback)
ensureIndex(fieldOrSpec, unique, callback)
indexInformation(callback)
dropIndex(indexName, callback)
dropIndexes(callback)
```
See [mongodb-native indexes](https://github.com/christkv/node-mongodb-native/blob/master/docs/indexes.md)
### Queries
See [mongodb-native queries](https://github.com/christkv/node-mongodb-native/blob/master/docs/queries.md)
#### findItems(..., callback)
Equivalent to
```js
collection.find(..., function (err, cursor) {
cursor.toArray(callback);
});
```
See [Collection.find](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js#L348)
#### findEach(..., callback)
Equivalent to
```js
collection.find(..., function (err, cursor) {
cursor.each(callback);
});
```
See [Collection.find](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js#L348)
#### findById(id, ..., callback)
Equivalent to
```js
collection.findOne({_id, ObjectID.createFromHexString(id)}, ..., callback);
```
See [Collection.findOne](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js#L417)
#### find(...)
If the last parameter is function, it is equivalent to native
[Collection.find](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js#L348)
method, else it will return a future [SkinCursor](#skincursor).
e.g.
```js
// callback
db.book.find({}, function (err, cursor) {/* do something */});
// future SkinCursor
db.book.find().toArray(function (err, books) {/* do something */});
```
#### normalizeHintField(hint)
#### find
```js
/**
* Various argument possibilities
* 1 callback
* 2 selector, callback,
* 2 callback, options // really?!
* 3 selector, fields, callback
* 3 selector, options, callback
* 4,selector, fields, options, callback
* 5 selector, fields, skip, limit, callback
* 6 selector, fields, skip, limit, timeout, callback
*
* Available options:
* limit, sort, fields, skip, hint, explain, snapshot, timeout, tailable, batchSize
*/
```
#### findAndModify(query, sort, update, options, callback)
```js
/**
Fetch and update a collection
query: a filter for the query
sort: if multiple docs match, choose the first one in the specified sort order as the object to manipulate
update: an object describing the modifications to the documents selected by the query
options:
remove: set to a true to remove the object before returning
new: set to true if you want to return the modified object rather than the original. Ignored for remove.
upsert: true/false (perform upsert operation)
**/
```
#### findOne(queryObject, options, callback)
### Aggregation
#### mapReduce(map, reduce, options, callback)
e.g.
```js
var map = function () {
emit(test(this.timestamp.getYear()), 1);
}
var reduce = function (k, v){
count = 0;
for (i = 0; i < v.length; i++) {
count += v[i];
}
return count;
}
var options = {scope: {test: new client.bson_serializer.Code(t.toString())}};
collection.mapReduce(map, reduce, options, function (err, collection) {
collection.find(function (err, cursor) {
cursor.toArray(function (err, results) {
test.equal(2, results[0].value)
finished_test({test_map_reduce_functions_scope:'ok'});
})
})
```
#### group(keys, condition, initial, reduce, command, callback)
e.g.
```js
collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", true, function(err, results) {});
```
#### count(query, callback)
#### distinct(key, query, callback)
### Inserting
#### insert(docs, options, callback)
### Updating
#### save(doc, options, callback)
```js
/**
Update a single document in this collection.
spec - a associcated array containing the fields that need to be present in
the document for the update to succeed
document - an associated array with the fields to be updated or in the case of
a upsert operation the fields to be inserted.
Options:
upsert - true/false (perform upsert operation)
multi - true/false (update all documents matching spec)
strict - true/false (perform check if the operation failed, required extra call to db)
Deprecated Options:
safe - true/false (perform check if the operation failed, required extra call to db)
**/
```
#### update(spec, document, options, callback)
#### updateById(_id, ..., callback)
Equivalent to
```js
collection.update({_id, ObjectID.createFromHexString(id)}, ..., callback);
```
See [Collection.update](https://github.com/christkv/node-mongodb-native/blob/master/docs/insert.md)
### Removing
#### remove(selector, options, callback)
#### removeById(_id, options, callback)
[Back to index](#index)
SkinCursor
---------
See [Cursor](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/cursor.js#L1)
of node-mongodb-native for more information.
All these methods will return the SkinCursor itself.
```js
sort(keyOrList, [direction], [callback])
limit(limit, [callback])
skip(skip, [callback])
batchSize(skip, [callback])
toArray(callback)
each(callback)
count(callback)
nextObject(callback)
getMore(callback)
explain(callback)
```
[Back to index](#index)
## How to validate input?
I wrote a middleware to validate post data, [node-iform](https://github.com/guileen/node-iform)
base on [node-validator](https://github.com/chriso/node-validator)
## Authors
Below is the output from `git-summary`.
```
project: node-mongoskin
commits: 112
active : 54 days
files : 39
authors:
49 Lin Gui 43.8%
34 guilin 桂林 30.4%
9 fengmk2 8.0%
5 guilin 4.5%
2 François de Metz 1.8%
2 Paul Gebheim 1.8%
2 Gui Lin 1.8%
1 humanchimp 0.9%
1 Aneil Mallavarapu 0.9%
1 wmertens 0.9%
1 Harvey McQueen 0.9%
1 Joe Faber 0.9%
1 Matt Perpick 0.9%
1 Quang Van 0.9%
1 Rakshit Menpara 0.9%
1 Wout Mertens 0.9%
```
## License
(The MIT License)
Copyright (c) 2011 - 2012 kissjs.org
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.