mongodb 2.1.0-alpha → 2.1.2

package/Makefile

@@ -2,13 +2,10 @@ NODE = node
 NPM = npm
 JSDOC = jsdoc
 name = all
-
+ 
 generate_docs:
 	# cp -R ./HISTORY.md ./docs/content/meta/release-notes.md
-	cp -R ./docs/history-header.md ./docs/content/meta/release-notes.md
-	more ./HISTORY.md >> ./docs/content/meta/release-notes.md
-	pandoc docs/layouts/partials/welcome.md -o docs/layouts/partials/welcome.html
-	hugo -s docs/ -d ../public
+	hugo -s docs/reference -d ../../public
 	$(JSDOC) -c conf.json -t docs/jsdoc-template/ -d ./public/api
 	cp -R ./public/api/scripts ./public/.
 	cp -R ./public/api/styles ./public/.

package/README.md

@@ -6,14 +6,14 @@
 
 # Description
 
-The MongoDB driver is the high level part of the 2.0 or higher MongoDB driver and is meant for end users.
+The MongoDB driver is the high level part of the 2.1 or higher MongoDB driver and is meant for end users.
 
 ## MongoDB Node.JS Driver
- 
+
 | what          | where                                          |
 |---------------|------------------------------------------------|
 | documentation | http://mongodb.github.io/node-mongodb-native/  |
-| api-doc        | http://mongodb.github.io/node-mongodb-native/  |
+| api-doc        | http://mongodb.github.io/node-mongodb-native/2.1/api/  |
 | source        | https://github.com/mongodb/node-mongodb-native |
 | mongodb       | http://www.mongodb.org/                        |
 
@@ -41,9 +41,100 @@ Core Server (i.e. SERVER) project are **public**.
 
 http://jira.mongodb.org/browse/NODE
 
+# Installation
+
+The recommended way to get started using the Node.js 2.0 driver is by using the `NPM` (Node Package Manager) to install the dependency in your project.
+
+## MongoDB Driver
+
+Given that you have created your own project using `npm init` we install the mongodb driver and it's dependencies by executing the following `NPM` command.
+
+```
+npm install mongodb --save
+```
+
+This will download the MongoDB driver and add a dependency entry in your `package.json` file.
+
+## Troubleshooting
+
+The MongoDB driver depends on several other packages. These are.
+
+* mongodb-core
+* bson
+* kerberos
+* node-gyp
+
+The `kerberos` package is a C++ extension that requires a build environment to be installed on your system. You must be able to build node.js itself to be able to compile and install the `kerberos` module. Furthermore the `kerberos` module requires the MIT Kerberos package to correctly compile on UNIX operating systems. Consult your UNIX operation system package manager what libraries to install.
+
+{{% note class="important" %}}
+Windows already contains the SSPI API used for Kerberos authentication. However you will need to install a full compiler tool chain using visual studio C++ to correctly install the kerberos extension.
+{{% /note %}}
+
+### Diagnosing on UNIX
+
+If you don’t have the build essentials it won’t build. In the case of linux you will need gcc and g++, node.js with all the headers and python. The easiest way to figure out what’s missing is by trying to build the kerberos project. You can do this by performing the following steps.
+
+```
+git clone https://github.com/christkv/kerberos.git
+cd kerberos
+npm install
+```
+
+If all the steps complete you have the right toolchain installed. If you get node-gyp not found you need to install it globally by doing.
+
+```
+npm install -g node-gyp
+```
+
+If correctly compiles and runs the tests you are golden. We can now try to install the mongod driver by performing the following command.
+
+```
+cd yourproject
+npm install mongodb --save
+```
+
+If it still fails the next step is to examine the npm log. Rerun the command but in this case in verbose mode.
+
+```
+npm --loglevel verbose install mongodb
+```
+
+This will print out all the steps npm is performing while trying to install the module.
+
+### Diagnosing on Windows
+
+A known compiler tool chain known to work for compiling `kerberos` on windows is the following.
+
+* Visual Studio c++ 2010 (do not use higher versions)
+* Windows 7 64bit SDK
+* Python 2.7 or higher
+
+Open visual studio command prompt. Ensure node.exe is in your path and install node-gyp.
+
+```
+npm install -g node-gyp
+```
+
+Next you will have to build the project manually to test it. Use any tool you use with git and grab the repo.
+
+```
+git clone https://github.com/christkv/kerberos.git
+cd kerberos
+npm install
+node-gyp rebuild
+```
+
+This should rebuild the driver successfully if you have everything set up correctly.
+
+### Other possible issues
+
+Your python installation might be hosed making gyp break. I always recommend that you test your deployment environment first by trying to build node itself on the server in question as this should unearth any issues with broken packages (and there are a lot of broken packages out there).
+
+Another thing is to ensure your user has write permission to wherever the node modules are being installed.
+
 QuickStart
 ==========
-The quick start guide will show you how to setup a simple application using node.js and MongoDB. It scope is only how to set up the driver and perform the simple crud operations. For more in depth coverage we encourage reading the tutorials.
+The quick start guide will show you how to setup a simple application using node.js and MongoDB. Its scope is only how to set up the driver and perform the simple crud operations. For more in depth coverage we encourage reading the tutorials.
 
 Create the package.json file
 ----------------------------
@@ -136,7 +227,7 @@ var insertDocuments = function(db, callback) {
   // Get the documents collection
   var collection = db.collection('documents');
   // Insert some documents
-  collection.insert([
+  collection.insertMany([
     {a : 1}, {a : 2}, {a : 3}
   ], function(err, result) {
     assert.equal(err, null);
@@ -195,7 +286,7 @@ var updateDocument = function(db, callback) {
   // Get the documents collection
   var collection = db.collection('documents');
   // Update document where a is 2, set b equal to 1
-  collection.update({ a : 2 }
+  collection.updateOne({ a : 2 }
     , { $set: { b : 1 } }, function(err, result) {
     assert.equal(err, null);
     assert.equal(1, result.result.n);
@@ -226,25 +317,26 @@ MongoClient.connect(url, function(err, db) {
 });
 ```
 
-Remove a document
+Delete a document
 -----------------
-Next lets remove the document where the field **a** equals to **3**.
+Next lets delete the document where the field **a** equals to **3**.
 
 ```js
-var removeDocument = function(db, callback) {
+var deleteDocument = function(db, callback) {
   // Get the documents collection
   var collection = db.collection('documents');
   // Insert some documents
-  collection.remove({ a : 3 }, function(err, result) {
+  collection.deleteOne({ a : 3 }, function(err, result) {
     assert.equal(err, null);
     assert.equal(1, result.result.n);
     console.log("Removed the document with the field a equal to 3");
     callback(result);
-  });    
+  });
 }
 ```
 
-This will remove the first document where the field **a** equals to **3**. Let's add the method to the **MongoClient.connect** callback function.
+This will delete the first document where the field **a** equals to **3**. Let's add the method to the **MongoClient
+.connect** callback function.
 
 ```js
 var MongoClient = require('mongodb').MongoClient
@@ -259,7 +351,7 @@ MongoClient.connect(url, function(err, db) {
 
   insertDocuments(db, function() {
     updateDocument(db, function() {
-      removeDocument(db, function() {
+      deleteDocument(db, function() {
         db.close();
       });
     });
@@ -288,7 +380,8 @@ var findDocuments = function(db, callback) {
 }
 ```
 
-This query will return all the documents in the **documents** collection. Since we removed a document the total documents returned is **2**. Finally let's add the findDocument method to the **MongoClient.connect** callback.
+This query will return all the documents in the **documents** collection. Since we deleted a document the total
+documents returned is **2**. Finally let's add the findDocument method to the **MongoClient.connect** callback.
 
 ```js
 var MongoClient = require('mongodb').MongoClient
@@ -303,7 +396,7 @@ MongoClient.connect(url, function(err, db) {
 
   insertDocuments(db, function() {
     updateDocument(db, function() {
-      removeDocument(db, function() {
+      deleteDocument(db, function() {
         findDocuments(db, function() {
           db.close();
         });

package/conf.json

@@ -5,21 +5,25 @@
       "test/functional/operation_example_tests.js",
       "test/functional/operation_promises_example_tests.js",
       "test/functional/operation_generators_example_tests.js",
-      "lib/admin.js", 
+      "test/functional/authentication_tests.js",
+      "test/functional/gridfs_stream_tests.js",
+      "lib/admin.js",
       "lib/collection.js",
       "lib/cursor.js",
-      "lib/aggregation_cursor.js", 
+      "lib/aggregation_cursor.js",
       "lib/command_cursor.js",
       "lib/db.js",
-      "lib/mongo_client.js", 
-      "lib/mongos.js", 
-      "lib/read_preference.js", 
-      "lib/replset.js", 
-      "lib/server.js", 
-      "lib/bulk/common.js", 
-      "lib/bulk/ordered.js", 
-      "lib/bulk/unordered.js", 
+      "lib/mongo_client.js",
+      "lib/mongos.js",
+      "lib/read_preference.js",
+      "lib/replset.js",
+      "lib/server.js",
+      "lib/bulk/common.js",
+      "lib/bulk/ordered.js",
+      "lib/bulk/unordered.js",
       "lib/gridfs/grid_store.js",
+      "node_modules/mongodb-core/lib/error.js",
+      "lib/gridfs-stream/index.js",
       "node_modules/mongodb-core/lib/connection/logger.js",
       "node_modules/bson/lib/bson/binary.js",
       "node_modules/bson/lib/bson/code.js",
@@ -31,7 +35,7 @@
       "node_modules/bson/lib/bson/timestamp.js",
       "node_modules/bson/lib/bson/max_key.js",
       "node_modules/bson/lib/bson/min_key.js"
-    ]     
+    ]
   },
   "templates": {
     "cleverLinks": true,
@@ -55,7 +59,7 @@
       "keyword": ""
     },
     "linenums": true
-  },  
+  },
   "markdown": {
     "parser": "gfm",
     "hardwrap": true,
@@ -64,4 +68,4 @@
   "examples": {
     "indent": 4
   }
-}
+}

package/index.js

@@ -1,5 +1,6 @@
 // Core module
-var core = require('mongodb-core');
+var core = require('mongodb-core'),
+  Instrumentation = require('./lib/apm');
 
 // Set up the connect function
 var connect = require('./lib/mongo_client').connect;
@@ -8,6 +9,7 @@ var connect = require('./lib/mongo_client').connect;
 connect.MongoError = core.MongoError;
 
 // Actual driver classes exported
+connect.Admin = require('./lib/admin');
 connect.MongoClient = require('./lib/mongo_client');
 connect.Db = require('./lib/db');
 connect.Collection = require('./lib/collection');
@@ -19,10 +21,12 @@ connect.GridStore = require('./lib/gridfs/grid_store');
 connect.Chunk = require('./lib/gridfs/chunk');
 connect.Logger = core.Logger;
 connect.Cursor = require('./lib/cursor');
+connect.GridFSBucket = require('./lib/gridfs-stream');
 
 // BSON types exported
 connect.Binary = core.BSON.Binary;
 connect.Code = core.BSON.Code;
+connect.Map = core.BSON.Map;
 connect.DBRef = core.BSON.DBRef;
 connect.Double = core.BSON.Double;
 connect.Long = core.BSON.Long;
@@ -35,5 +39,12 @@ connect.Timestamp = core.BSON.Timestamp;
 
 // Add connect method
 connect.connect = connect;
+
+// Set up the instrumentation method
+connect.instrument = function(options, callback) {
+  if(typeof options == 'function') callback = options, options = {};
+  return new Instrumentation(core, options, callback);
+}
+
 // Set our exports to be the connect function
-module.exports = connect;
+module.exports = connect;