MongoStorage

This library is work-in-progress for a client-side MongoDB implementation.

Bower

Install using bower

bower install mongostorage

Table of contents

• Database
  • use()
  • createCollection()
  • dropDatabase()
  • collections()
• Collection
  • insert()
  • update()
  • find()
  • findOne()
  • remove()
  • count()
  • drop()
• Query Operators
  • Comparison Query Operators
    • $gt
    • $gte
    • $lt
    • $lte
    • $ne
    • $ni
    • $nin
  • Logical Query Operators
    • $and
    • $or
    • $nor
    • $not

Database

#use()

Before we can actually start creating or retrieving documents, we should select the database we wish to use. You should call the use() method to change the selected database.

var db = new MongoStorage();
db.use('foo_dev');

This will load all the collections from the foo_dev database.

#createCollection()

To create a new collection, you should call the createCollection() method of the database.

var db = new MongoStorage();
db.use('foo_dev');
db.createCollection('users');

This will expose a new user property in the database that can be used to access or modify the data in that collection.

#dropDatabase()

This will drop the current database.

db.dropDatabase();

#collections()

Retrieves the list of collections.

db.collections();

Collection

#insert()

It's possible to insert document per document or insert multiple documents at once.

db.collection.insert(documents, [function]);

Example

db.users.insert({firstName: 'Foo', name: 'Bar'});

db.users.insert([{firstName: 'Foo 1', name: 'Bar'}, {firstName: 'Foo 2', name: 'Bar'}]);

#update()

#find()

Retrieves an array of documents that matches the query criteria.

db.collection.find([query, [options]], function);

Example

db.users.find({age: {$gte: 25}}, function(users) {
    // All the users with an age greater then or equal to 25
});

db.users.find({age: {$gte: 25}}, {limit: 5}, function(users) {
    // The first 5 users with an age greater then or equal to 25
});

db.users.find({age: {$gte: 25}}, {limit: 5, skip: 5}, function(users) {
    // The next 5 users with an age greater then or equal to 25
});

#findOne()

Retrieves the first document that matches the query criteria.

db.collection.findOne([query, [options]], function);

Example

db.users.findOne({name: 'Bar', age: {$lt: 24}}, function(user) {
    // The first user with an age less then 24
});

db.users.findOne({name: 'Bar', age: {$lt: 24}}, {sort: {age: -1}}, function(user) {
    // The oldest user with an age less then 24
});

#remove()

To remove data out of a collection, you can use the remove() method. It has an optional query parameter and an optional callback function that will tell you how many records where removed.

db.collection.remove([query], [function]);

Example

db.users.remove();

db.users.remove(function(nr) {
    // nr holds the number of documents removed out of the collection
});

db.users.remove({age: {$gt: 25}}, function(nr) {
    // nr holds the number of documents removed out of the collection
});

#count()

Counts the number of documents in the collection that matches the query criteria.

db.collection.count([query], function);

Example

db.users.count(function(count) {
    // count holds the total number of users in the database
});

db.users.count({age: {$gt: 25}}, function(count) {
    // count holds the total number of users with an age greater then 25
});

#drop()

Drops the collection from the database

db.collection.drop([function]);

Example

db.users.drop();

db.users.drop(function() {
    // The users collection has been removed
});

Query Operators

Comparison query operators

For comparison of different type values.

$gt

Matches values that are greater than the value specified in the query.

$gte

Matches values that are greater than or equal to the value specified in the query.

$lt

Matches values that are less than the value specified in the query.

$lte

Matches values that are less than or equal to the value specified in the query.

$ne

Matches all values that are not equal to the value specified in the query.

$in

Matches any of the values that exist in an array specified in the query.

$nin

Matches values that do not exist in an array specified to the query.

Logical query operators

$and

Joins query clauses with a logical AND returns all documents that match the conditions of both clauses.

$or

Joins query clauses with a logical OR returns all documents that match the conditions of either clause.

$nor

Joins query clauses with a logical NOR returns all documents that fail to match both clauses.

$not

Inverts the effect of a query expression and returns documents that do not match the query expression.

Author

• Sam Verschueren [[email protected]]

License

MIT © Sam Verschueren