Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pradel/mongodb-bluebird
A simple package mongodb promise
https://github.com/pradel/mongodb-bluebird
bluebird mongodb nodejs
Last synced: 7 days ago
JSON representation
A simple package mongodb promise
- Host: GitHub
- URL: https://github.com/pradel/mongodb-bluebird
- Owner: pradel
- License: mit
- Created: 2014-10-29T14:52:06.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-16T09:04:15.000Z (over 6 years ago)
- Last Synced: 2024-11-01T09:33:43.637Z (14 days ago)
- Topics: bluebird, mongodb, nodejs
- Language: JavaScript
- Size: 21.5 KB
- Stars: 16
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mongodb-bluebird
[](https://travis-ci.org/pradel/mongodb-bluebird)
Add promise to the [node-mongodb-native](https://github.com/mongodb/node-mongodb-native).
## Installation
```
npm install mongodb-bluebird
```
## Quick examples
```
var mongo = require('mongodb-bluebird');
//open connection to the database
mongo.connect("mongodb://localhost:27017/mongodb-bluebird").then(function(db) {
//close connection to the database
return db.close().then(function() {
console.log('success');
});
}).catch(function(err) {
console.error("something went wrong");
});
//find users
mongo.connect("mongodb://localhost:27017/mongodb-bluebird").then(function(db) {
//get the user collection
var users = db.collection('users');
return users.find().then(function(users) {
console.log(users);
}).catch(function(err) {
console.error("something went wrong");
});
});
//find one user
users.findOne().then(function(user) {
console.log(user);
});
//find by id
users.findById('507f191e810c19729de860ea').then(function(user) {
console.log(user);
});
```
### Get a collection
```
var users = db.collection('users');
```
The `_id` field will be automatically converted into ObjectId.
If you want to convert automatically some other fields into ObjectId just pass an array as second parameter :
```
var users = db.collection('users', {
ObjectIds: [`your', 'fields']
});
```
If you want to disable ObjectId conversion for `_id:
```
var users = db.collection('users', {
ObjectId: false
});
```
## API
###Top Level
* `mongodb` - raw mongodb driver
###Collection
[MongoDB Collection](http://mongodb.github.io/node-mongodb-native/api-generated/collection.html)
[MongoDB Queries](http://mongodb.github.io/node-mongodb-native/markdown-docs/queries.html)
* `find([query][, fields][, options])`
* `findOne([query][, fields][, options])`
* `findById(oid[, fields][, options])`
* `insert(docs[, options])`
* `update(query, document[, options])`
* `updateById(oid, document[, options])`
* `remove([query][, options])`
* `removeById(oid[, options])`
* `count([query][, options])`
* `save([doc][, options])`
* `findAndModify(query, sort, doc[, options])`
* `findAndRemove(query, sort[, options])`
* `group(keys, condition, initial, reduce, finalize, command[, options])`
* `aggregate(array[, options])`
* `drop()`
* `rename(newName[, options])`
* `createIndex(fieldOrSpec[, options])`
* `ensureIndex(fieldOrSpec[, options])`
* `dropIndex(name)`
###Db
[MongoDB Db](http://mongodb.github.io/node-mongodb-native/api-generated/db.html)
* `close()`
* `admin()`
* `collectionNames([collectionName][, options])`
* `collections()`
* `eval(code[, parameters][, options])`
* `logout()`
* `authenticate(username, password[, options])`
* `addUser(username, password[, options])`
* `removeUser(username[, options])`
* `createCollection(collectionName[, options])`
* `dropCollection(collectionName)`
* `renameCollection(fromCollection, toCollection[, options])`
* `dropDatabase()`
* `stats([, options])`
##TODO
* Write some tests