Node.js Driver Examples¶

The Node.js driver for MongoDB is an officially supported driver as of Spring 2012. It’s written in JavaScript and was designed with simplicity in mind. It can be used on it’s own, but is commonly used in conjunction with an object mapping library like Mongoose.

The Node.js driver at the time of this writing, 07-10-15, supports the following versions of MongoDB:

Node.js Driver	MongoDB 2.4	MongoDB 2.6	MongoDB 3.0
>=2.0.14	✓	✓	✓
>=1.4.29	✓	✓	✓

Here are the current versions of Node.js the driver supports:

Node.js Driver	Node.js v0.8.X	Node.js v0.10.X	Node.js v0.11.X unstable
2.0.X	✓	✓	✓
>=1.4.18	✓	✓	✓

Installation¶

Installing the Node.js driver is simple, using the usual npm install procedure:

npm install mongodb

Example document¶

Here’s the example document we’ll be using:

{
    "start": "2015-09-02T22:46:30.782Z",
    "end": "2016-09-02T22:46:30.782Z",
    "location": "Texas",
    "official_game": false,
    "winner": "Javi",
    "players": [
        {
            "name": "Javi",
            "decks": [
                "Dinosaurs",
                "Plants"
            ],
            "points": 24,
            "place": 1
        },
        {
            "name": "Seth",
            "decks": [
                "Spies",
                "Zombies"
            ],
            "points": 20,
            "place": 2
        },
        {
            "name": "Dave",
            "decks": [
                "Steampunk",
                "Wizard"
            ],
            "points": 20,
            "place": 2
        },
        {
            "name": "Castro",
            "decks": [
                "Shapeshifters",
                "Ninjas"
            ],
            "points": 18,
            "place": 4
        }
    ]
}

Connecting¶

Warning

When connecting using the MongoDB URI, we highly recommend avoiding usernames or passwords with an @ symbol inside. This can break the URI parsing and cause failures when trying to connect.

Connecting to a replica set:¶

// Require mongodb
var MongoClient = require('mongodb').MongoClient;

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'fw-c9-1.objectrocket.com:12345,dfw-c9-0.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var options = '?replicaSet=c74b5276378ed3bd70cba37a3ac45fea';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database + options;

// Connect
MongoClient.connect(connectionString, function(err, db) {
  if (db) {
    db.close();
  }
  if (err) {
    console.log('Error: ', err);
  } else {
    console.log('Connected!');
    process.exit();
  }
});

Output from above:

$ node repl_connect_example.js
Connected!

Connecting to a sharded instance:¶

// Require mongodb
var MongoClient = require('mongodb').MongoClient;

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'dfw-c9-1.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database;

MongoClient.connect(connectionString, function(err, db) {
  if (err) {
    console.log('Error: ', err);
  } else {
    console.log('Connected!');
    process.exit();
  }
});

Output from above:

$ node sharded_connect_example.js
Connected!

Connecting to a sharded instance using SSL:¶

Make sure to change the port number when using an SSL connection.

// Require mongodb
var MongoClient = require('mongodb').MongoClient;

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'dfw-c9-1.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var options = '?ssl=true';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database + options;

MongoClient.connect(connectionString, function(err, db) {
  if (err) {
    console.log('Error: ', err);
  } else {
    console.log('Connected!'');
    process.exit();
  }
});

Output from above:

$ node ssl_sharded_connect_example.js
Connected!

Creating a document¶

Creating and inserting the document:

    // Require mongodb
    var MongoClient = require('mongodb').MongoClient;

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'dfw-c9-1.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var options = '?ssl=true';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database + options;

// Connect
    MongoClient.connect(connectionString, function(err, db) {
      if (err) {
        console.log('Error: ', err);
      }
      var example_doc = {
            "start" : new Date(),
            "end" : new Date(2015, 9, 28, 14, 17, 23, 0),
            "location" : "Texas",
            "official_game" : false,
            "winner" : "Javi",
            "players" : [
            {
                "name": "Javi",
                "decks": [
                    "Dinosaurs",
                    "Plants"
                ],
                "points": 24,
                "place": 1
            },
            {
                "name": "Seth",
                "decks": [
                    "Spies",
                    "Zombies"
                ],
                "points": 20,
                "place": 2
            },
            {
                "name": "Dave",
                "decks": [
                    "Steampunk",
                    "Wizard"
                ],
                "points": 20,
                "place": 2
            },
            {
                "name": "Castro",
                "decks": [
                    "Shapeshifters",
                    "Ninjas"
                ],
                "points": 18,
                "place": 4
            }
        ]
      };
      var collection = db.collection('example_collection');
      collection.insert(example_doc, {w:1}, function(err, result) {
        if (err) {
          console.log('Error: ', err);
        } else {
          console.log('Inserted a doc!');
          process.exit();
        }
      });
    });

Output from above:

$ node inserting_doc.js
Inserted a doc!

Reading documents¶

Finding a document with a specific field:

    // Require mongodb
    var MongoClient = require('mongodb').MongoClient;
    // Require prettyjson
    var prettyjson = require('prettyjson');

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'dfw-c9-1.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var options = '?ssl=true';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database + options;

// Connect
MongoClient.connect(connectionString, function(err, db) {
  if (err) {
    console.log('Error: ', err);
  }
      var collection = db.collection('example_collection');
      // Find a document where Javi won
      collection.findOne({"winner":"Javi"},function(err, doc) {
        if (err) {
          console.log('Error: ', err);
        } else {
          console.log(prettyjson.render(doc));
          process.exit();
        }
      });
    });

Output from above:

start:         Thu Sep 03 2015 12:22:26 GMT-0500 (CDT)
end:           Wed Oct 28 2015 14:17:23 GMT-0500 (CDT)
location:      Texas
official_game: false
winner:        Javi
players:
  -
  name:   Javi
  decks:
    - Dinosaurs
    - Plants
  points: 24
  place:  1
-
  name:   Seth
  decks:
    - Spies
    - Zombies
  points: 20
  place:  2
-
  name:   Dave
  decks:
    - Steampunk
    - Wizard
  points: 20
  place:  2
-
  name:   Castro
  decks:
    - Shapeshifters
    - Ninjas
  points: 18
  place:  4
_id:
_bsontype: ObjectID
id:        Uàé7ÿ¥8�L±

Note

In the above, prettyjson is trying to print the binary value of _id, so it renders unreadably.

Updating a document¶

Updating a document:

// Require mongodb
var MongoClient = require('mongodb').MongoClient;
// Require prettyjson
var prettyjson = require('prettyjson');

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'dfw-c9-1.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var options = '?ssl=true';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database + options;

// Connect
MongoClient.connect(connectionString, function(err, db) {
  if (err) {
    console.log('Error: ', err);
  }
  var collection = db.collection('example_collection');
  // Update the doc to make Seth the winner
  collection.update({"winner":"Javi"}, {$set:{"winner":"Seth"}}, {w:1}, function(err, result) {
    if(err) {
      console.log('Error: ', err);
    } else {
      console.log('Updated a doc! Heres the new one.');
    }
    // Find the new document
    collection.findOne({"winner":"Seth"}, function(err, doc) {
      if (err) {
        console.log('Error: ', err);
      } else {
        console.log(prettyjson.render(doc));
        process.exit();
      }
    });
  });
});

Output from above:

Updated a doc! Heres the new one.
start:         Thu Sep 03 2015 15:03:31 GMT-0500 (CDT)
end:           Wed Oct 28 2015 14:17:23 GMT-0500 (CDT)
location:      Texas
official_game: false
winner:        Seth
players:
  -
    name:   Javi
    decks:
      - Dinosaurs
      - Plants
    points: 24
    place:  1
  -
    name:   Seth
    decks:
      - Spies
      - Zombies
    points: 20
    place:  2
  -
    name:   Dave
    decks:
      - Steampunk
      - Wizard
    points: 20
    place:  2
  -
    name:   Castro
    decks:
      - Shapeshifters
      - Ninjas
    points: 18
    place:  4
_id:
  _bsontype: ObjectID
  id:        Uè§fßÌ®~ã

Deleting a document¶

Deleting a specific document:

// Require mongodb
var MongoClient = require('mongodb').MongoClient;

var username = 'YOUR_USERNAME';
var password = 'YOUR_PASSWORD';
var hosts = 'dfw-c9-1.objectrocket.com:12345';
var database = 'YOUR_DATABASE_NAME';
var options = '?ssl=true';
var connectionString = 'mongodb://' + username + ':' + password + '@' + hosts + '/' + database + options;

MongoClient.connect(connectionString, function(err, db) {
  if (err) {
      console.log('Error: ', err);
  }
  var collection = db.collection('example_collection');
  // Delete a single document where Javi won
  collection.remove({"winner": "Javi"}, {w: 1, single: true}, function(err, doc) {
    if (err) {
      console.log('Error: ', err);
    } else {
      console.log('Deleted a doc!');
      process.exit();
    }
  });
});

Output from above:

$ Deleted a doc!

Additional reading¶

If you need more help with Node.js, here are some links to more documentation:

As always, if you have any questions, please don’t hesitate to reach out to our support team!