diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000000..d43c10694e7 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: d4a1ef2e8fee8941792720296198c690 +tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/.gitignore b/.gitignore index ead9da69cc7..f82f9a21e97 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,10 @@ *.seed .project .settings +<<<<<<< HEAD +======= data node_modules/ output build +>>>>>>> efddd763a3fd570178896ad748101797f10ec5b8 diff --git a/docs/sphinx-docs/source/static/.mongodb b/.nojekyll similarity index 100% rename from docs/sphinx-docs/source/static/.mongodb rename to .nojekyll diff --git a/.npmignore b/.npmignore deleted file mode 100644 index ed901d90e73..00000000000 --- a/.npmignore +++ /dev/null @@ -1,12 +0,0 @@ -.git* -.buildinfo -.mongodb -docs/ -docs/sphinx-docs -data/ -dev/ -examples/ -test/ -.DS_Store - - diff --git a/Makefile b/Makefile deleted file mode 100644 index 26d9dd2142f..00000000000 --- a/Makefile +++ /dev/null @@ -1,67 +0,0 @@ -NODE = node -NPM = npm -NODEUNIT = deps/nodeunit/bin/nodeunit -DOX = node_modules/dox/bin/dox -name = all - -total: build_native - -build_native: - $(MAKE) -C ./external-libs/bson all - -build_native_debug: - $(MAKE) -C ./external-libs/bson all_debug - -build_native_clang: - $(MAKE) -C ./external-libs/bson clang - -build_native_clang_debug: - $(MAKE) -C ./external-libs/bson clang_debug - -clean_native: - $(MAKE) -C ./external-libs/bson clean - -test: build_native - @echo "\n == Run All tests minus replicaset tests==" - $(NODE) dev/tools/test_all.js --noreplicaset --boot - -test_junit: build_native - @echo "\n == Run All tests minus replicaset tests==" - $(NODE) dev/tools/test_all.js --junit --noreplicaset - -test_nodeunit_pure: - @echo "\n == Execute Test Suite using Pure JS BSON Parser == " - @$(NODEUNIT) test/ test/gridstore test/bson - -test_js: - @$(NODEUNIT) $(TESTS) - -test_nodeunit_replicaset_pure: - @echo "\n == Execute Test Suite using Pure JS BSON Parser == " - @$(NODEUNIT) test/replicaset - -test_nodeunit_native: - @echo "\n == Execute Test Suite using Native BSON Parser == " - @TEST_NATIVE=TRUE $(NODEUNIT) test/ test/gridstore test/bson - -test_nodeunit_replicaset_native: - @echo "\n == Execute Test Suite using Native BSON Parser == " - @TEST_NATIVE=TRUE $(NODEUNIT) test/replicaset - -test_all: build_native - @echo "\n == Run All tests ==" - $(NODE) dev/tools/test_all.js --boot - -test_all_junit: build_native - @echo "\n == Run All tests ==" - $(NODE) dev/tools/test_all.js --junit --boot - -clean: - rm ./external-libs/bson/bson.node - rm -r ./external-libs/bson/build - -generate_docs: - $(NODE) dev/tools/build-docs.js - make --directory=./docs/sphinx-docs --file=Makefile html - -.PHONY: total diff --git a/Readme.md b/Readme.md deleted file mode 100644 index 0008875e597..00000000000 --- a/Readme.md +++ /dev/null @@ -1,408 +0,0 @@ -Install -======== - -To install the most recent release from npm, run: - - npm install mongodb - -That may give you a warning telling you that bugs['web'] should be bugs['url'], it would be safe to ignore it (this has been fixed in the development version) - -To install from the latest from the repository, run:: - - npm install path/to/node-mongodb-native - -Community -======== -Check out the google group [node-mongodb-native](http://groups.google.com/group/node-mongodb-native) for questions/answers from users of the driver. - -Introduction -======== - -This is a node.js driver for MongoDB. It's a port (or close to a port) of the library for ruby at http://github.com/mongodb/mongo-ruby-driver/. - -A simple example of inserting a document. - - var client = new Db('test', new Server("127.0.0.1", 27017, {})), - test = function (err, collection) { - collection.insert({a:2}, function(err, docs) { - - collection.count(function(err, count) { - test.assertEquals(1, count); - }); - - // Locate all the entries using find - collection.find().toArray(function(err, results) { - test.assertEquals(1, results.length); - test.assertTrue(results.a === 2); - - // Let's close the db - client.close(); - }); - }); - }; - - client.open(function(err, p_client) { - client.collection('test_insert', test); - }); - -Data types -======== - -To store and retrieve the non-JSON MongoDb primitives ([ObjectID](http://www.mongodb.org/display/DOCS/Object+IDs), Long, Binary, [Timestamp](http://www.mongodb.org/display/DOCS/Timestamp+data+type), [DBRef](http://www.mongodb.org/display/DOCS/Database+References#DatabaseReferences-DBRef), Code). - -In particular, every document has a unique `_id` which can be almost any type, and by default a 12-byte ObjectID is created. ObjectIDs can be represented as 24-digit hexadecimal strings, but you must convert the string back into an ObjectID before you can use it in the database. For example: - - // Get the objectID type - var ObjectID = require('mongodb').ObjectID; - - var idString = '4e4e1638c85e808431000003'; - collection.findOne({_id: new ObjectID(idString)}, console.log) // ok - collection.findOne({_id: idString}, console.log) // wrong! callback gets undefined - -Here are the constructors the non-Javascript BSON primitive types: - - // Fetch the library - var mongo = require('mongodb'); - // Create new instances of BSON types - new mongo.Long(numberString) - new mongo.ObjectID(hexString) - new mongo.Timestamp() // the actual unique number is generated on insert. - new mongo.DBRef(collectionName, id, dbName) - new mongo.Binary(buffer) // takes a string or Buffer - new mongo.Code(code, [context]) - new mongo.Symbol(string) - new mongo.MinKey() - new mongo.MaxKey() - new mongo.Double(number) // Force double storage - -The C/C++ bson parser/serializer --------- - -From V0.8.0 to V0.9.6.9, the Javascript bson parser was slower than an optional C/C++ bson parser. As of V0.9.6.9+, due to performance improvements in the Javascript parser, the C/C++ parser is deprecated and is not installed by default anymore. - -If you are running a version of this library has the C/C++ parser compiled, to enable the driver to use the C/C++ bson parser pass it the option native_parser:true like below - - // using Deprecated native_parser: - var client = new Db('integration_tests_20', - new Server("127.0.0.1", 27017), - {native_parser:true}); - -The C++ parser uses the js objects both for serialization and deserialization. - -GitHub information -======== - -The source code is available at http://github.com/christkv/node-mongodb-native. -You can either clone the repository or download a tarball of the latest release. - -Once you have the source you can test the driver by running - - $ make test - -in the main directory. You will need to have a mongo instance running on localhost for the integration tests to pass. - -Examples -======== - -For examples look in the examples/ directory. You can execute the examples using node. - - $ cd examples - $ node queries.js - -GridStore -========= - -The GridStore class allows for storage of binary files in mongoDB using the mongoDB defined files and chunks collection definition. - -For more information have a look at [Gridstore](https://github.com/christkv/node-mongodb-native/blob/master/docs/gridfs.md) - -Replicasets -=========== -For more information about how to connect to a replicaset have a look at [Replicasets](https://github.com/christkv/node-mongodb-native/blob/master/docs/replicaset.md) - -Primary Key Factories --------- - -Defining your own primary key factory allows you to generate your own series of id's -(this could f.ex be to use something like ISBN numbers). The generated the id needs to be a 12 byte long "string". - -Simple example below - - // Custom factory (need to provide a 12 byte array); - CustomPKFactory = function() {} - CustomPKFactory.prototype = new Object(); - CustomPKFactory.createPk = function() { - return new ObjectID("aaaaaaaaaaaa"); - } - - var p_client = new Db('integration_tests_20', new Server("127.0.0.1", 27017, {}), {'pk':CustomPKFactory}); - p_client.open(function(err, p_client) { - p_client.dropDatabase(function(err, done) { - p_client.createCollection('test_custom_key', function(err, collection) { - collection.insert({'a':1}, function(err, docs) { - collection.find({'_id':new ObjectID("aaaaaaaaaaaa")}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.assertEquals(1, items.length); - - // Let's close the db - p_client.close(); - }); - }); - }); - }); - }); - }); - -Strict mode --------- - -Each database has an optional strict mode. If it is set then asking for a collection -that does not exist will return an Error object in the callback. Similarly if you -attempt to create a collection that already exists. Strict is provided for convenience. - - var error_client = new Db('integration_tests_', new Server("127.0.0.1", 27017, {auto_reconnect: false}), {strict:true}); - test.assertEquals(true, error_client.strict); - - error_client.open(function(err, error_client) { - error_client.collection('does-not-exist', function(err, collection) { - test.assertTrue(err instanceof Error); - test.assertEquals("Collection does-not-exist does not exist. Currently in strict mode.", err.message); - }); - - error_client.createCollection('test_strict_access_collection', function(err, collection) { - error_client.collection('test_strict_access_collection', function(err, collection) { - test.assertTrue(collection instanceof Collection); - // Let's close the db - error_client.close(); - }); - }); - }); - -Documentation -======== - -If this document doesn't answer your questions, see the source of -[Collection](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/collection.js) -or [Cursor](https://github.com/christkv/node-mongodb-native/blob/master/lib/mongodb/cursor.js), -or the documentation at MongoDB for query and update formats. - -Find --------- - -The find method is actually a factory method to create -Cursor objects. A Cursor lazily uses the connection the first time -you call `nextObject`, `each`, or `toArray`. - -The basic operation on a cursor is the `nextObject` method -that fetches the next matching document from the database. The convenience -methods `each` and `toArray` call `nextObject` until the cursor is exhausted. - -Signatures: - - var cursor = collection.find(query, [fields], options); - cursor.sort(fields).limit(n).skip(m). - - cursor.nextObject(function(err, doc) {}); - cursor.each(function(err, doc) {}); - cursor.toArray(function(err, docs) {}); - - cursor.rewind() // reset the cursor to its initial state. - -Useful chainable methods of cursor. These can optionally be options of `find` instead of method calls: - -* `.limit(n).skip(m)` to control paging. -* `.sort(fields)` Order by the given fields. There are several equivalent syntaxes: - * `.sort({field1: -1, field2: 1})` descending by field1, then ascending by field2. - * `.sort([['field1', 'desc'], ['field2', 'asc']])` same as above - * `.sort([['field1', 'desc'], 'field2'])` same as above - * `.sort('field1')` ascending by field1 - -Other options of `find`: - -* `fields` the fields to fetch (to avoid transferring the entire document) -* `tailable` if true, makes the cursor [tailable](http://www.mongodb.org/display/DOCS/Tailable+Cursors). -* `batchSize` The number of the subset of results to request the database -to return for every request. This should initially be greater than 1 otherwise -the database will automatically close the cursor. The batch size can be set to 1 -with `batchSize(n, function(err){})` after performing the initial query to the database. -* `hint` See [Optimization: hint](http://www.mongodb.org/display/DOCS/Optimization#Optimization-Hint). -* `explain` turns this into an explain query. You can also call -`explain()` on any cursor to fetch the explanation. -* `snapshot` prevents documents that are updated while the query is active -from being returned multiple times. See more -[details about query snapshots](http://www.mongodb.org/display/DOCS/How+to+do+Snapshotted+Queries+in+the+Mongo+Database). -* `timeout` if false, asks MongoDb not to time out this cursor after an -inactivity period. - - -For information on how to create queries, see the -[MongoDB section on querying](http://www.mongodb.org/display/DOCS/Querying). - - var mongodb = require('mongodb'); - var server = new mongodb.Server("127.0.0.1", 27017, {}); - new mongodb.Db('test', server, {}).open(function (error, client) { - if (error) throw error; - var collection = new mongodb.Collection(client, 'test_collection'); - collection.find({}, {limit:10}).toArray(function(err, docs) { - console.dir(docs); - }); - }); - -Insert --------- - -Signature: - - collection.insert(docs, options, [callback]); - -where `docs` can be a single document or an array of documents. - -Useful options: - -* `safe:true` Should always set if you have a callback. - -See also: [MongoDB docs for insert](http://www.mongodb.org/display/DOCS/Inserting). - - var mongodb = require('mongodb'); - var server = new mongodb.Server("127.0.0.1", 27017, {}); - new mongodb.Db('test', server, {}).open(function (error, client) { - if (error) throw error; - var collection = new mongodb.Collection(client, 'test_collection'); - collection.insert({hello: 'world'}, {safe:true}, - function(err, objects) { - if (err) console.warn(err.message); - if (err && err.message.indexOf('E11000 ') !== -1) { - // this _id was already inserted in the database - } - }); - }); - -Note that there's no reason to pass a callback to the insert or update commands -unless you use the `safe:true` option. If you don't specify `safe:true`, then -your callback will be called immediately. - -Update; update and insert (upsert) --------- - -The update operation will update the first document that matches your query -(or all documents that match if you use `multi:true`). -If `safe:true`, `upsert` is not set, and no documents match, your callback -will be given an error. - -See the [MongoDB docs](http://www.mongodb.org/display/DOCS/Updating) for -the modifier (`$inc`, `$set`, `$push`, etc.) formats. - -Signature: - - collection.update(criteria, objNew, options, [callback]); - -Useful options: - -* `safe:true` Should always set if you have a callback. -* `multi:true` If set, all matching documents are updated, not just the first. -* `upsert:true` Atomically inserts the document if no documents matched. - -Example for `update`: - - var mongodb = require('mongodb'); - var server = new mongodb.Server("127.0.0.1", 27017, {}); - new mongodb.Db('test', server, {}).open(function (error, client) { - if (error) throw error; - var collection = new mongodb.Collection(client, 'test_collection'); - collection.update({hi: 'here'}, {$set: {hi: 'there'}}, {safe:true}, - function(err) { - if (err) console.warn(err.message); - else console.log('successfully updated'); - }); - }); - -Find and modify --------- - -`findAndModify` is like `update`, but it also gives the updated document to -your callback. But there are a few key differences between findAndModify and -update: - - 1. The signatures differ. - 2. You can only findAndModify a single item, not multiple items. - -Signature: - - collection.findAndModify(query, sort, update, options, callback) - -The sort parameter is used to specify which object to operate on, if more than -one document matches. It takes the same format as the cursor sort (see -Connection.find above). - -See the -[MongoDB docs for findAndModify](http://www.mongodb.org/display/DOCS/findAndModify+Command) -for more details. - -Useful options: - -* `remove:true` set to a true to remove the object before returning -* `new:true` set to true if you want to return the modified object rather than the original. Ignored for remove. -* `upsert:true` Atomically inserts the document if no documents matched. - -Example for `findAndModify`: - - var mongodb = require('mongodb'); - var server = new mongodb.Server("127.0.0.1", 27017, {}); - new mongodb.Db('test', server, {}).open(function (error, client) { - if (error) throw error; - var collection = new mongodb.Collection(client, 'test_collection'); - collection.findAndModify({hello: 'world'}, [['_id','asc']], {$set: {hi: 'there'}}, {}, - function(err, object) { - if (err) console.warn(err.message); - else console.dir(object); // undefined if no matching object exists. - }); - }); - -Save --------- - -The `save` method is a shorthand for upsert if the document contains an -`_id`, or an insert if there is no `_id`. - -Sponsors -======== -Just as Felix Geisendörfer I'm also working on the driver for my own startup and this driver is a big project that also benefits other companies who are using MongoDB. - -If your company could benefit from a even better-engineered node.js mongodb driver I would appreciate any type of sponsorship you may be able to provide. All the sponsors will get a lifetime display in this readme, priority support and help on problems and votes on the roadmap decisions for the driver. If you are interested contact me on [christkv AT g m a i l.com](mailto:christkv@gmail.com) for details. - -And I'm very thankful for code contributions. If you are interested in working on features please contact me so we can discuss API design and testing. - -Release Notes -============= - -See HISTORY - -Credits -======== - -1. [10gen](http://github.com/mongodb/mongo-ruby-driver/) -2. [Google Closure Library](http://code.google.com/closure/library/) -3. [Jonas Raoni Soares Silva](http://jsfromhell.com/classes/binary-parser) - -Contributors -============= - -Aaron Heckmann, Christoph Pojer, Pau Ramon Revilla, Nathan White, Emmerman, Seth LaForge, Boris Filipov, Stefan Schärmeli, Tedde Lundgren, renctan, Sergey Ukustov, Ciaran Jessup, kuno, srimonti, Erik Abele, Pratik Daga, Slobodan Utvic, Kristina Chodorow, Yonathan Randolph, Brian Noguchi, Sam Epstein, James Harrison Fisher, Vladimir Dronnikov, Ben Hockey, Henrik Johansson, Simon Weare, Alex Gorbatchev, Shimon Doodkin, Kyle Mueller, Eran Hammer-Lahav, Marcin Ciszak, François de Metz, Vinay Pulim, nstielau, Adam Wiggins, entrinzikyl, Jeremy Selier, Ian Millington, Public Keating, andrewjstone, Christopher Stott, Corey Jewett, brettkiefer, Rob Holland, Senmiao Liu, heroic, gitfy - -License -======== - - Copyright 2009 - 2010 Christian Amor Kvalheim. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - diff --git a/TODO b/TODO deleted file mode 100644 index 1ed86e8de1f..00000000000 --- a/TODO +++ /dev/null @@ -1,25 +0,0 @@ -TODO for jan 4 - 2011 -- Chase down potential memory leak in findAndModify -- Check compatibility for gridFS between python and js -- Ensure Gridfs speed is comparable to other solutions -- Map out python replicaset driver functionality - -ACCOMPLISHED jan 4 - 2011 -+ Chase down potential memory leak in findAndModify -+ Check compatibility for gridFS between python and js -+ Ensure Gridfs speed is comparable to other solutions - -0.9.7.4-dev -- Amortize documents (only deserialize when accessed) -- Mongo tests to handle special Mongos situations -- If a secondary server disappears don't kill the driver connection -- Check for new servers coming online (a new secondary server etc) -- http://api.mongodb.org/python/current/api/pymongo/index.html#pymongo.ReadPreference - ---------------------------------------------------------------------------------------------* Allow secondary read with no master -* Add lowest response time selection of read server for replicaset using a selectable strategy. First one being using the ping command response time -* Allow execution of multiple commands against the same server connection when having a connection pool -* Implement tag support for replicasets -* Change bson c++ parser to use js objects instead of native c++ objects -* Whole stack benchmark with profiling to locate where the driver spends time -* Change bson c++ parser to be stackless to look at performance difference \ No newline at end of file diff --git a/docs/sphinx-docs/source/static/active.png b/_images/active.png similarity index 100% rename from docs/sphinx-docs/source/static/active.png rename to _images/active.png diff --git a/docs/sphinx-docs/source/static/nonactive.png b/_images/nonactive.png similarity index 100% rename from docs/sphinx-docs/source/static/nonactive.png rename to _images/nonactive.png diff --git a/_sources/api-articles/index.txt b/_sources/api-articles/index.txt new file mode 100644 index 00000000000..6509b1aaf72 --- /dev/null +++ b/_sources/api-articles/index.txt @@ -0,0 +1,9 @@ +================== +Articles +================== + +.. toctree:: + :maxdepth: 2 + + nodekoarticle1 + nodekoarticle2 diff --git a/_sources/api-articles/nodekoarticle1.txt b/_sources/api-articles/nodekoarticle1.txt new file mode 100644 index 00000000000..915b318e4ba --- /dev/null +++ b/_sources/api-articles/nodekoarticle1.txt @@ -0,0 +1,456 @@ +================================ +A Basic introduction to Mongo DB +================================ + + Mongo DB has rapidly grown to become a popular database for web applications and is a perfect fit for Node.JS applications, letting you write Javascript for the client, backend and database layer. Its schemaless nature is a better match to our constantly evolving data structures in web applications, and the integrated support for location queries is a bonus that's hard to ignore. Throw in Replica Sets for scaling, and we're looking at really nice platform to grow your storage needs now and in the future. + + + + Now to shamelessly plug my driver. It can be downloaded via npm, or fetched from the github repository. To install via npm, do the following: + + + + ``npm install mongodb`` + + + + or go fetch it from github at `https://github.com/christkv/node-mongodb-native `_ + + + + Once this business is taken care of, let's move through the types available for the driver and then how to connect to your Mongo DB instance before facing the usage of some CRUD operations. + + +------------------- +Mongo DB data types +------------------- + + So there is an important thing to keep in mind when working with Mongo DB, and that is the slight mapping difference between types Mongo DB supports and native Javascript data types. Let's have a look at the types supported out of the box and then how types are promoted by the driver to fit as close to native Javascript types as possible. + + + * **Float** is a 8 byte and is directly convertible to the Javascript type Number + * **Double class** a special class representing a float value, this is especially useful when using capped collections where you need to ensure your values are always floats. + * **Integers** is a bit trickier due to the fact that Javascript represents all Numbers as 64 bit floats meaning that the maximum integer value is at a 53 bit. Mongo has two types for integers, a 32 bit and a 64 bit. The driver will try to fit the value into 32 bits if it can and promote it to 64 bits if it has to. Similarly it will deserialize attempting to fit it into 53 bits if it can. If it cannot it will return an instance of **Long** to avoid loosing precession. + * **Long class** a special class that let's you store 64 bit integers and also let's you operate on the 64 bits integers. + * **Date** maps directly to a Javascript Date + * **RegExp** maps directly to a Javascript RegExp + * **String** maps directly to a Javascript String (encoded in utf8) + * **Binary class** a special class that let's you store data in Mongo DB + * **Code class** a special class that let's you store javascript functions in Mongo DB, can also provide a scope to run the method in + * **ObjectID class** a special class that holds a MongoDB document identifier (the equivalent to a Primary key) + * **DbRef class** a special class that let's you include a reference in a document pointing to another object + * **Symbol class** a special class that let's you specify a symbol, not really relevant for javascript but for languages that supports the concept of symbols. + + + + As we see the number type can be a little tricky due to the way integers are implemented in Javascript. The latest driver will do correct conversion up to 53 bit's of complexity. If you need to handle big integers the recommendation is to use the Long class to operate on the numbers. + + +--------------------------------------- +Getting that connection to the database +--------------------------------------- + + Let's get around to setting up a connection with the Mongo DB database. Jumping straight into the code let's do direct connection and then look at the code. + + + .. code-block:: javascript + + // Retrieve + var MongoClient = require('mongodb').MongoClient; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(!err) { + console.log("We are connected"); + } + }); + + + + Let's have a quick look at how the connection code works. The **Db.connect** +method let's use use a uri to connect to the Mongo database, where + **localhost:27017** is the server host and port and **exampleDb** the db +we wish to connect to. After the url notice the hash containing the + **auto_reconnect** key. Auto reconnect tells the driver to retry sending +a command to the server if there is a failure during it's execution. + + + + Another useful option you can pass in is + + + + **poolSize** , this allows you to control how many tcp connections are +opened in parallel. The default value for this is 5 but you can set it +as high as you want. The driver will use a round-robin strategy to +dispatch and read from the tcp connection. + + + + We are up and running with a connection to the database. Let's move on +and look at what collections are and how they work. + + +------------------------ +Mongo DB and Collections +------------------------ + + Collections are the equivalent of tables in traditional databases and contain all your documents. A database can have many collections. So how do we go about defining and using collections. Well there are a couple of methods that we can use. Let's jump straight into code and then look at the code. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + // Retrieve + var MongoClient = require('mongodb').MongoClient; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) { return console.dir(err); } + + db.collection('test', function(err, collection) {}); + + db.collection('test', {w:1}, function(err, collection) {}); + + db.createCollection('test', function(err, collection) {}); + + db.createCollection('test', {w:1}, function(err, collection) {}); + + }); + + + + Three different ways of creating a collection object but slightly different in behavior. Let's go through them and see what they do + + + .. code-block:: javascript + + db.collection('test', function(err, collection) {}); + + + + This function will not actually create a collection on the database until you actually insert the first document. + + + .. code-block:: javascript + + db.collection('test', {w:1}, function(err, collection) {}); + + + + Notice the **{w:1}** option. This option will make the driver check if the collection exists and issue an error if it does not. + + + .. code-block:: javascript + + db.createCollection('test', function(err, collection) {}); + + + + This command will create the collection on the Mongo DB database before returning the collection object. If the collection already exists it will ignore the creation of the collection. + + + .. code-block:: javascript + + db.createCollection('test', {w:1}, function(err, collection) {}); + + + + The **{w:1}** option will make the method return an error if the collection already exists. + + + + With an open db connection and a collection defined we are ready to do some CRUD operation on the data. + + +----------------------- +And then there was CRUD +----------------------- + + So let's get dirty with the basic operations for Mongo DB. The Mongo DB wire protocol is built around 4 main operations **insert/update/remove/query** . Most operations on the database are actually queries with special json objects defining the operation on the database. But I'm getting ahead of myself. Let's go back and look at insert first and do it with some code. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + // Retrieve + var MongoClient = require('mongodb').MongoClient; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) { return console.dir(err); } + + var collection = db.collection('test'); + var doc1 = {'hello':'doc1'}; + var doc2 = {'hello':'doc2'}; + var lotsOfDocs = [{'hello':'doc3'}, {'hello':'doc4'}]; + + collection.insert(doc1); + + collection.insert(doc2, {w:1}, function(err, result) {}); + + collection.insert(lotsOfDocs, {w:1}, function(err, result) {}); + + }); + + + + A couple of variations on the theme of inserting a document as we can see. To understand why it's important to understand how Mongo DB works during inserts of documents. + + + + Mongo DB has asynchronous **insert/update/remove** operations. This means that when you issue an **insert** operation its a fire and forget operation where the database does not reply with the status of the insert operation. To retrieve the status of the operation you have to issue a query to retrieve the last error status of the connection. To make it simpler to the developer the driver implements the **{w:1}** options so that this is done automatically when inserting the document. **{w:1}** becomes especially important when you do **update** or **remove** as otherwise it's not possible to determine the amount of documents modified or removed. + + + + Now let's go through the different types of inserts shown in the code above. + + + .. code-block:: javascript + + collection.insert(doc1); + + + + Taking advantage of the async behavior and not needing confirmation about the persisting of the data to Mongo DB we just fire off the insert (we are doing live analytics, loosing a couple of records does not matter). + + + .. code-block:: javascript + + collection.insert(doc2, {w:1}, function(err, result) {}); + + + + That document needs to stick. Using the **{w:1}** option ensure you get the error back if the document fails to insert correctly. + + + .. code-block:: javascript + + collection.insert(lotsOfDocs, {w:1}, function(err, result) {}); + + + + A batch insert of document with any errors being reported. This is much more efficient if you need to insert large batches of documents as you incur a lot less overhead. + + + + Right that's the basics of insert's ironed out. We got some documents in there but want to update them as we need to change the content of a field. Let's have a look at a simple example and then we will dive into how Mongo DB updates work and how to do them efficiently. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + // Retrieve + var MongoClient = require('mongodb').MongoClient; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) { return console.dir(err); } + + var collection = db.collection('test'); + var doc = {mykey:1, fieldtoupdate:1}; + + collection.insert(doc, {w:1}, function(err, result) { + collection.update({mykey:1}, {$set:{fieldtoupdate:2}}, {w:1}, function(err, result) {}); + }); + + var doc2 = {mykey:2, docs:[{doc1:1}]}; + + collection.insert(doc2, {w:1}, function(err, result) { + collection.update({mykey:2}, {$push:{docs:{doc2:1}}}, {w:1}, function(err, result) {}); + }); + }); + + + + Alright before we look at the code we want to understand how document updates work and how to do the efficiently. The most basic and less efficient way is to replace the whole document, this is not really the way to go if you want to change just a field in your document. Luckily Mongo DB provides a whole set of operations that let you modify just pieces of the document `Atomic operations documentation `_ . Basically outlined below. + + + * $inc - increment a particular value by a certain amount + * $set - set a particular value + * $unset - delete a particular field (v1.3+) + * $push - append a value to an array + * $pushAll - append several values to an array + * $addToSet - adds value to the array only if its not in the array already + * $pop - removes the last element in an array + * $pull - remove a value(s) from an existing array + * $pullAll - remove several value(s) from an existing array + * $rename - renames the field + * $bit - bitwise operations + + + + Now that the operations are outline let's dig into the specific cases show in the code example. + + + .. code-block:: javascript + + collection.update({mykey:1}, {$set:{fieldtoupdate:2}}, {w:1}, function(err, result) {}); + + + + Right so this update will look for the document that has a field **mykey** equal to **1** and apply an update to the field **fieldtoupdate** setting the value to **2** . Since we are using the **{w:1}** option the result parameter in the callback will return the value **1** indicating that 1 document was modified by the update statement. + + + .. code-block:: javascript + + collection.update({mykey:2}, {$push:{docs:{doc2:1}}}, {w:1}, function(err, result) {}); + + + + This updates adds another document to the field **docs** in the document identified by **{mykey:2}** using the atomic operation **$push** . This allows you to modify keep such structures as queues in Mongo DB. + + + + Let's have a look at the remove operation for the driver. As before let's start with a piece of code. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + // Retrieve + var MongoClient = require('mongodb').MongoClient; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) { return console.dir(err); } + + var collection = db.collection('test'); + var docs = [{mykey:1}, {mykey:2}, {mykey:3}]; + + collection.insert(docs, {w:1}, function(err, result) { + + collection.remove({mykey:1}); + + collection.remove({mykey:2}, {w:1}, function(err, result) {}); + + collection.remove(); + }); + }); + + + + Let's examine the 3 remove variants and what they do. + + + .. code-block:: javascript + + collection.remove({mykey:1}); + + + + This leverages the fact that Mongo DB is asynchronous and that it does not return a result for **insert/update/remove** to allow for **synchronous** style execution. This particular remove query will remove the document where **mykey** equals **1** . + + + .. code-block:: javascript + + collection.remove({mykey:2}, {w:1}, function(err, result) {}); + + + + This remove statement removes the document where **mykey** equals **2** but since we are using **{w:1}** it will back to Mongo DB to get the status of the remove operation and return the number of documents removed in the result variable. + + + .. code-block:: javascript + + collection.remove(); + + + + This last one will remove all documents in the collection. + + +------------- +Time to Query +------------- + + Queries is of course a fundamental part of interacting with a database and Mongo DB is no exception. Fortunately for us it has a rich query interface with cursors and close to SQL concepts for slicing and dicing your datasets. To build queries we have lots of operators to choose from `Mongo DB advanced queries `_ . There are literarily tons of ways to search and ways to limit the query. Let's look at some simple code for dealing with queries in different ways. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + // Retrieve + var MongoClient = require('mongodb').MongoClient; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) { return console.dir(err); } + + var collection = db.collection('test'); + var docs = [{mykey:1}, {mykey:2}, {mykey:3}]; + + collection.insert(docs, {w:1}, function(err, result) { + + collection.find().toArray(function(err, items) {}); + + var stream = collection.find({mykey:{$ne:2}}).stream(); + stream.on("data", function(item) {}); + stream.on("end", function() {}); + + collection.findOne({mykey:1}, function(err, item) {}); + + }); + }); + + + + Before we start picking apart the code there is one thing that needs to be understood, the **find** method does not execute the actual query. It builds an instance of **Cursor** that you then use to retrieve the data. This lets you manage how you retrieve the data from Mongo DB and keeps state about your current Cursor state on Mongo DB. Now let's pick apart the queries we have here and look at what they do. + + + .. code-block:: javascript + + collection.find().toArray(function(err, items) {}); + + + + This query will fetch all the document in the collection and return them as an array of items. Be careful with the function **toArray** as it might cause a lot of memory usage as it will instantiate all the document into memory before returning the final array of items. If you have a big resultset you could run into memory issues. + + + .. code-block:: javascript + + var stream = collection.find({mykey:{$ne:2}}).stream(); + stream.on("data", function(item) {}); + stream.on("end", function() {}); + + + + This is the preferred way if you have to retrieve a lot of data for streaming, as data is deserialized a **data** event is emitted. This keeps the resident memory usage low as the documents are streamed to you. Very useful if you are pushing documents out via websockets or some other streaming socket protocol. Once there is no more document the driver will emit the **end** event to notify the application that it's done. + + + .. code-block:: javascript + + collection.findOne({mykey:1}, function(err, item) {}); + + + + This is special supported function to retrieve just one specific document bypassing the need for a cursor object. + + + + That's pretty much it for the quick intro on how to use the database. I have also included a list of links to where to go to find more information and also a sample crude location application I wrote using express JS and mongo DB. + + +--------------- +Links and stuff +--------------- + * `The driver examples, good starting point for basic usage `_ + * `All the integration tests, they have tons of different usage cases `_ + * `The Mongo DB wiki pages such as the advanced query link `_ + * `A silly simple location based application using Express JS and Mongo DB `_ + diff --git a/_sources/api-articles/nodekoarticle2.txt b/_sources/api-articles/nodekoarticle2.txt new file mode 100644 index 00000000000..454cba1683c --- /dev/null +++ b/_sources/api-articles/nodekoarticle2.txt @@ -0,0 +1,326 @@ +============================================= +A primer for GridFS using the Mongo DB driver +============================================= + + In the first tutorial we targeted general usage of the database. But Mongo DB is much more than this. One of the additional very useful features is to act as a file storage system. This is accomplish in Mongo by having a file collection and a chunks collection where each document in the chunks collection makes up a **Block** of the file. In this tutorial we will look at how to use the GridFS functionality and what functions are available. + + +---------------- +A simple example +---------------- + + Let's dive straight into a simple example on how to write a file to the grid using the simplified Grid class. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient, + Grid = mongo.Grid; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) return console.dir(err); + + var grid = new Grid(db, 'fs'); + var buffer = new Buffer("Hello world"); + grid.put(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) { + if(!err) { + console.log("Finished writing file to Mongo"); + } + }); + }); + + + + All right let's dissect the example. The first thing you'll notice is the statement + + + .. code-block:: javascript + + var grid = new Grid(db, 'fs'); + + + + Since GridFS is actually a special structure stored as collections you'll notice that we are using the db connection that we used in the previous tutorial to operate on collections and documents. The second parameter **'fs'** allows you to change the collections you want to store the data in. In this example the collections would be **fs_files** and **fs_chunks** . + + + + Having a live grid instance we now go ahead and create some test data stored in a Buffer instance, although you can pass in a string instead. We then write our data to disk. + + + .. code-block:: javascript + + var buffer = new Buffer("Hello world"); + grid.put(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) { + if(!err) { + console.log("Finished writing file to Mongo"); + } + }); + + + + Let's deconstruct the call we just made. The **put** call will write the data you passed in as one or more chunks. The second parameter is a hash of options for the Grid class. In this case we wish to annotate the file we are writing to Mongo DB with some metadata and also specify a content type. Each file entry in GridFS has support for metadata documents which might be very useful if you are for example storing images in you Mongo DB and need to store all the data associated with the image. + + + + One important thing is to take not that the put method return a document containing a **_id** , this is an **ObjectID** identifier that you'll need to use if you wish to retrieve the file contents later. + + + + Right so we have written out first file, let's look at the other two simple functions supported by the Grid class. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient, + Grid = mongo.Grid; + + // Connect to the db + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + if(err) return console.dir(err); + + var grid = new Grid(db, 'fs'); + var buffer = new Buffer("Hello world"); + grid.put.(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) { + grid.get(fileInfo._id, function(err, data) { + console.log("Retrieved data: " + data.toString()); + grid.delete(fileInfo._id, function(err, result) { + }); + }); + }); + }); + + + + Let's have a look at the two operations **get** and **delete** + + + .. code-block:: javascript + + grid.get(fileInfo._id, function(err, data) {}); + + + + The **get** method takes an ObjectID as the first argument and as we can se in the code we are using the one provided in **fileInfo._id** . This will read all the chunks for the file and return it as a Buffer object. + + + + The **delete** method also takes an ObjectID as the first argument but will delete the file entry and the chunks associated with the file in Mongo. + + + + This **api** is the simplest one you can use to interact with GridFS but it's not suitable for all kinds of files. One of it's main drawbacks is you are trying to write large files to Mongo. This api will require you to read the entire file into memory when writing and reading from Mongo which most likely is not feasible if you have to store large files like Video or RAW Pictures. Luckily this is not the only way to work with GridFS. That's not to say this api is not useful. If you are storing tons of small files the memory usage vs the simplicity might be a worthwhile tradeoff. Let's dive into some of the more advanced ways of using GridFS. + + +----------------------------------------------- +Advanced GridFS or how not to run out of memory +----------------------------------------------- + + As we just said controlling memory consumption for you file writing and reading is key if you want to scale up the application. That means not reading in entire files before either writing or reading from Mongo DB. The good news is, it's supported. Let's throw some code out there straight away and look at how to do chunk sized streaming writes and reads. + + + + **the requires and and other initializing stuff omitted for brevity** + + + .. code-block:: javascript + + var fileId = new ObjectID(); + var gridStore = new GridStore(db, fileId, "w", {root:'fs'}); + gridStore.chunkSize = 1024 * 256; + + gridStore.open(function(err, gridStore) { + Step( + function writeData() { + var group = this.group(); + + for(var i = 0; i < 1000000; i += 5000) { + gridStore.write(new Buffer(5000), group()); + } + }, + + function doneWithWrite() { + gridStore.close(function(err, result) { + console.log("File has been written to GridFS"); + }); + } + ) + }); + + + + Before we jump into picking apart the code let's look at + + + .. code-block:: javascript + + var gridStore = new GridStore(db, fileId, "w", {root:'fs'}); + + + + Notice the parameter **"w"** this is important. It tells the driver that you are planning to write a new file. The parameters you can use here are. + + + * **"r"** - read only. This is the default mode + * **"w"** - write in truncate mode. Existing data will be overwritten + * **"w+"** - write in edit mode + + + + Right so there is a fair bit to digest here. We are simulating writing a file that's about 1MB big to Mongo DB using GridFS. To do this we are writing it in chunks of 5000 bytes. So to not live with a difficult callback setup we are using the Step library with its' group functionality to ensure that we are notified when all of the writes are done. After all the writes are done Step will invoke the next function (or step) called **doneWithWrite** where we finish up by closing the file that flushes out any remaining data to Mongo DB and updates the file document. + + + + As we are doing it in chunks of 5000 bytes we will notice that memory consumption is low. This is the trick to write large files to GridFS. In pieces. Also notice this line. + + + .. code-block:: javascript + + gridStore.chunkSize = 1024 * 256; + + + + This allows you to adjust how big the chunks are in bytes that Mongo DB will write. You can tune the Chunk Size to your needs. If you need to write large files to GridFS it might be worthwhile to trade of memory for CPU by setting a larger Chunk Size. + + + + Now let's see how the actual streaming read works. + + + .. code-block:: javascript + + new GridStore(db, fileId, "r").open(function(err, gridStore) { + var stream = gridStore.stream(true); + + stream.on("data", function(chunk) { + console.log("Chunk of file data"); + }); + + stream.on("end", function() { + console.log("EOF of file"); + }); + + stream.on("close", function() { + console.log("Finished reading the file"); + }); + }); + + + + Right let's have a quick lock at the streaming functionality supplied with the driver **(make sure you are using 0.9.6-12 or higher as there is a bug fix for custom chunksizes that you need)** + + + .. code-block:: javascript + + var stream = gridStore.stream(true); + + + + This opens a stream to our file, you can pass in a boolean parameter to tell the driver to close the file automatically when it reaches the end. This will fire the **close** event automatically. Otherwise you'll have to handle cleanup when you receive the **end** event. Let's have a look at the events supported. + + + .. code-block:: javascript + + stream.on("data", function(chunk) { + console.log("Chunk of file data"); + }); + + + + The **data** event is called for each chunk read. This means that it's by the chunk size of the written file. So if you file is 1MB big and the file has chunkSize 256K then you'll get 4 calls to the event handler for **data** . The chunk returned is a **Buffer** object. + + + .. code-block:: javascript + + stream.on("end", function() { + console.log("EOF of file"); + }); + + + + The **end** event is called when the driver reaches the end of data for the file. + + + .. code-block:: javascript + + stream.on("close", function() { + console.log("Finished reading the file"); + }); + + + + The **close** event is only called if you the **autoclose** parameter on the **gridStore.stream** method as shown above. If it's false or not set handle cleanup of the streaming in the **end** event handler. + + + + Right that's it for writing to GridFS in an efficient Manner. I'll outline some other useful function on the Gridstore object. + + +-------------------------------------------- +Other useful methods on the Gridstore object +-------------------------------------------- + + There are some other methods that are useful + + + .. code-block:: javascript + + gridStore.writeFile(filename/filedescriptor, function(err fileInfo) {}); + + + + **writeFile** takes either a file name or a file descriptor and writes it to GridFS. It does this in chunks to ensure the Eventloop is not tied up. + + + .. code-block:: javascript + + gridStore.read(length, function(err, data) {}); + + + + **read/readBuffer** lets you read a #length number of bytes from the current position in the file. + + + .. code-block:: javascript + + gridStore.seek(position, seekLocation, function(err, gridStore) {}); + + + + **seek** lets you navigate the file to read from different positions inside the chunks. The seekLocation allows you to specify how to seek. It can be one of three values. + + + * GridStore.IO *SEEK* SET Seek mode where the given length is absolute + * GridStore.IO *SEEK* CUR Seek mode where the given length is an offset to the current read/write head + * GridStore.IO *SEEK* END Seek mode where the given length is an offset to the end of the file + + GridStore.list(dbInstance, collectionName, {id:true}, function(err, files) {}) + + + + **list** lists all the files in the collection in GridFS. If you have a lot of files the current version will not work very well as it's getting all files into memory first. You can have it return either the filenames or the ids for the files using option. + + + .. code-block:: javascript + + gridStore.unlink(function(err, result) {}); + + + + **unlink** deletes the file from Mongo DB, that's to say all the file info and all the chunks. + + + + This should be plenty to get you on your way building your first GridFS based application. As in the previous article the following links might be useful for you. Good luck and have fun. + + +--------------- +Links and stuff +--------------- + * `The driver examples, good starting point for basic usage `_ + * `All the integration tests, they have tons of different usage cases `_ + diff --git a/_sources/api-bson-generated/binary.txt b/_sources/api-bson-generated/binary.txt new file mode 100644 index 00000000000..7509eb9ce7d --- /dev/null +++ b/_sources/api-bson-generated/binary.txt @@ -0,0 +1,104 @@ +======== +Binary() +======== + +------------------ +Constructor +------------------ + + +A class representation of the BSON Binary type. + + + .. js:class:: Binary() + + :param buffer buffer: a buffer object containing the binary data. + :param number [subType]: the option binary type. + :returns: grid + + +Sub types + - **BSON.BSON_BINARY_SUBTYPE_DEFAULT**, default BSON type. + - **BSON.BSON_BINARY_SUBTYPE_FUNCTION**, BSON function type. + - **BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY**, BSON byte array type. + - **BSON.BSON_BINARY_SUBTYPE_UUID**, BSON uuid type. + - **BSON.BSON_BINARY_SUBTYPE_MD5**, BSON md5 type. + - **BSON.BSON_BINARY_SUBTYPE_USER_DEFINED**, BSON user defined type. + + +------------------ +Constants +------------------ + +.. csv-table:: + :header: "Constant Name", "Value", "Description" + :widths: 15, 10, 30 + + "Binary.SUBTYPE_DEFAULT", "0", "Default BSON type" + "Binary.SUBTYPE_FUNCTION", "1", "Function BSON type" + "Binary.SUBTYPE_BYTE_ARRAY", "2", "Byte Array BSON type" + "Binary.SUBTYPE_UUID_OLD", "3", "OLD UUID BSON type" + "Binary.SUBTYPE_UUID", "4", "UUID BSON type" + "Binary.SUBTYPE_MD5", "5", "MD5 BSON type" + "Binary.SUBTYPE_USER_DEFINED", "128", "User BSON type" + +--- +put +--- + + +Updates this binary with byte_value. + +.. js:function:: put(byte_value) + + :param character byte_value: a single byte we wish to write. + +----- +write +----- + + +Writes a buffer or string to the binary. + +.. js:function:: write(string, offset) + + :param buffer string: a string or buffer to be written to the Binary BSON object. + :param number offset: specify the binary of where to write the content. + +---- +read +---- + + +Reads **length** bytes starting at **position**. + +.. js:function:: read(position, length) + + :param number position: read from the given position in the Binary. + :param number length: the number of bytes to read. + :returns: buffer + + +----- +value +----- + + +Returns the value of this binary as a string. + +.. js:function:: value() + + :returns: string + + +------ +length +------ + + +Length. + +.. js:function:: length() + + :returns: number the length of the binary. + diff --git a/_sources/api-bson-generated/bson.txt b/_sources/api-bson-generated/bson.txt new file mode 100644 index 00000000000..345102d4a3a --- /dev/null +++ b/_sources/api-bson-generated/bson.txt @@ -0,0 +1,238 @@ +====== +BSON() +====== + +------------------ +Constructor +------------------ + + +Create a new BSON instance + + + .. js:class:: BSON() + + :returns: bson instance of BSON Parser. + + + +------------------ +Constants +------------------ + +.. csv-table:: + :header: "Constant Name", "Value", "Description" + :widths: 15, 10, 30 + + "BSON.BSON_DATA_NUMBER", "1", "Number BSON Type" + "BSON.BSON_DATA_STRING", "2", "String BSON Type" + "BSON.BSON_DATA_OBJECT", "3", "Object BSON Type" + "BSON.BSON_DATA_ARRAY", "4", "Array BSON Type" + "BSON.BSON_DATA_BINARY", "5", "Binary BSON Type" + "BSON.BSON_DATA_OID", "7", "ObjectID BSON Type" + "BSON.BSON_DATA_BOOLEAN", "8", "Boolean BSON Type" + "BSON.BSON_DATA_DATE", "9", "Date BSON Type" + "BSON.BSON_DATA_NULL", "10", "null BSON Type" + "BSON.BSON_DATA_REGEXP", "11", "RegExp BSON Type" + "BSON.BSON_DATA_CODE", "13", "Code BSON Type" + "BSON.BSON_DATA_SYMBOL", "14", "Symbol BSON Type" + "BSON.BSON_DATA_CODE_W_SCOPE", "15", "Code with Scope BSON Type" + "BSON.BSON_DATA_INT", "16", "32 bit Integer BSON Type" + "BSON.BSON_DATA_TIMESTAMP", "17", "Timestamp BSON Type" + "BSON.BSON_DATA_LONG", "18", "Long BSON Type" + "BSON.BSON_DATA_MIN_KEY", "0xff", "MinKey BSON Type" + "BSON.BSON_DATA_MAX_KEY", "0x7f", "MaxKey BSON Type" + "BSON.BSON_BINARY_SUBTYPE_DEFAULT", "0", "Binary Default Type" + "BSON.BSON_BINARY_SUBTYPE_FUNCTION", "1", "Binary Function Type" + "BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY", "2", "Binary Byte Array Type" + "BSON.BSON_BINARY_SUBTYPE_UUID", "3", "Binary UUID Type" + "BSON.BSON_BINARY_SUBTYPE_MD5", "4", "Binary MD5 Type" + "BSON.BSON_BINARY_SUBTYPE_USER_DEFINED", "128", "Binary User Defined Type" + +------------------------ +BSON.calculateObjectSize +------------------------ + + +Calculate the bson size for a passed in Javascript object. + +.. js:function:: BSON.calculateObjectSize(object[, serializeFunctions]) + + :param object object: the Javascript object to calculate the BSON byte size for. + :param boolean [serializeFunctions]: serialize all functions in the object **(default:false)**. + :returns: number returns the number of bytes the BSON object will take up. + + +-------------------------------- +BSON.serializeWithBufferAndIndex +-------------------------------- + + +Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization. + +.. js:function:: BSON.serializeWithBufferAndIndex(object, checkKeys, buffer, index, serializeFunctions) + + :param object object: the Javascript object to serialize. + :param boolean checkKeys: the serializer will check if keys are valid. + :param buffer buffer: the Buffer you pre-allocated to store the serialized BSON object. + :param number index: the index in the buffer where we wish to start serializing into. + :param boolean serializeFunctions: serialize the javascript functions **(default:false)**. + :returns: number returns the new write index in the Buffer. + + +-------------- +BSON.serialize +-------------- + + +Serialize a Javascript object. + +.. js:function:: BSON.serialize(object, checkKeys, asBuffer, serializeFunctions) + + :param object object: the Javascript object to serialize. + :param boolean checkKeys: the serializer will check if keys are valid. + :param boolean asBuffer: return the serialized object as a Buffer object **(ignore)**. + :param boolean serializeFunctions: serialize the javascript functions **(default:false)**. + :returns: buffer returns the Buffer object containing the serialized object. + + +---------------------- +BSON.deserializeStream +---------------------- + + +Deserialize stream data as BSON documents. + + + +Options + - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. + - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. + - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. + +.. js:function:: BSON.deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex[, options]) + + :param buffer data: the buffer containing the serialized set of BSON documents. + :param number startIndex: the start index in the data Buffer where the deserialization is to start. + :param number numberOfDocuments: number of documents to deserialize. + :param array documents: an array where to store the deserialized documents. + :param number docStartIndex: the index in the documents array from where to start inserting documents. + :param object [options]: additional options used for the deserialization. + :returns: number returns the next index in the buffer after deserialization **x** numbers of documents. + + +---------------- +BSON.deserialize +---------------- + + +Deserialize data as BSON. + + + +Options + - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. + - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. + - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. + +.. js:function:: BSON.deserialize(buffer[, options], [isArray]) + + :param buffer buffer: the buffer containing the serialized set of BSON documents. + :param object [options]: additional options used for the deserialization. + :param boolean [isArray]: ignore used for recursive parsing. + :returns: object returns the deserialized Javascript Object. + + +----------- +deserialize +----------- + + +Deserialize data as BSON. + + + +Options + - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. + - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. + - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. + +.. js:function:: deserialize(buffer[, options], [isArray]) + + :param buffer buffer: the buffer containing the serialized set of BSON documents. + :param object [options]: additional options used for the deserialization. + :param boolean [isArray]: ignore used for recursive parsing. + :returns: object returns the deserialized Javascript Object. + + +----------------- +deserializeStream +----------------- + + +Deserialize stream data as BSON documents. + + + +Options + - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. + - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. + - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. + +.. js:function:: deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex[, options]) + + :param buffer data: the buffer containing the serialized set of BSON documents. + :param number startIndex: the start index in the data Buffer where the deserialization is to start. + :param number numberOfDocuments: number of documents to deserialize. + :param array documents: an array where to store the deserialized documents. + :param number docStartIndex: the index in the documents array from where to start inserting documents. + :param object [options]: additional options used for the deserialization. + :returns: number returns the next index in the buffer after deserialization **x** numbers of documents. + + +--------- +serialize +--------- + + +Serialize a Javascript object. + +.. js:function:: serialize(object, checkKeys, asBuffer, serializeFunctions) + + :param object object: the Javascript object to serialize. + :param boolean checkKeys: the serializer will check if keys are valid. + :param boolean asBuffer: return the serialized object as a Buffer object **(ignore)**. + :param boolean serializeFunctions: serialize the javascript functions **(default:false)**. + :returns: buffer returns the Buffer object containing the serialized object. + + +------------------- +calculateObjectSize +------------------- + + +Calculate the bson size for a passed in Javascript object. + +.. js:function:: calculateObjectSize(object[, serializeFunctions]) + + :param object object: the Javascript object to calculate the BSON byte size for. + :param boolean [serializeFunctions]: serialize all functions in the object **(default:false)**. + :returns: number returns the number of bytes the BSON object will take up. + + +--------------------------- +serializeWithBufferAndIndex +--------------------------- + + +Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization. + +.. js:function:: serializeWithBufferAndIndex(object, checkKeys, buffer, index, serializeFunctions) + + :param object object: the Javascript object to serialize. + :param boolean checkKeys: the serializer will check if keys are valid. + :param buffer buffer: the Buffer you pre-allocated to store the serialized BSON object. + :param number index: the index in the buffer where we wish to start serializing into. + :param boolean serializeFunctions: serialize the javascript functions **(default:false)**. + :returns: number returns the new write index in the Buffer. + diff --git a/_sources/api-bson-generated/code.txt b/_sources/api-bson-generated/code.txt new file mode 100644 index 00000000000..7302232a2a3 --- /dev/null +++ b/_sources/api-bson-generated/code.txt @@ -0,0 +1,19 @@ +====== +Code() +====== + +------------------ +Constructor +------------------ + + +A class representation of the BSON Code type. + + + .. js:class:: Code() + + :param string code: a string or function. + :param object [scope]: an optional scope for the function. + :returns: code + + diff --git a/_sources/api-bson-generated/db_ref.txt b/_sources/api-bson-generated/db_ref.txt new file mode 100644 index 00000000000..0fd9f15e124 --- /dev/null +++ b/_sources/api-bson-generated/db_ref.txt @@ -0,0 +1,20 @@ +======= +DBRef() +======= + +------------------ +Constructor +------------------ + + +A class representation of the BSON DBRef type. + + + .. js:class:: DBRef() + + :param string namespace: the collection name. + :param objectid oid: the reference ObjectID. + :param string [db]: optional db name, if omitted the reference is local to the current db. + :returns: dbref + + diff --git a/_sources/api-bson-generated/double.txt b/_sources/api-bson-generated/double.txt new file mode 100644 index 00000000000..d563b36f0f3 --- /dev/null +++ b/_sources/api-bson-generated/double.txt @@ -0,0 +1,30 @@ +======== +Double() +======== + +------------------ +Constructor +------------------ + + +A class representation of the BSON Double type. + + + .. js:class:: Double() + + :param number value: the number we want to represent as a double. + :returns: double + + + +------- +valueOf +------- + + +Access the number value. + +.. js:function:: valueOf() + + :returns: number returns the wrapped double number. + diff --git a/_sources/api-bson-generated/index.txt b/_sources/api-bson-generated/index.txt new file mode 100644 index 00000000000..3cedf0394a4 --- /dev/null +++ b/_sources/api-bson-generated/index.txt @@ -0,0 +1,18 @@ +================== +Binary JSON API +================== + +.. toctree:: + :maxdepth: 2 + + objectid + binary + code + db_ref + double + minkey + maxkey + symbol + timestamp + long + bson diff --git a/_sources/api-bson-generated/long.txt b/_sources/api-bson-generated/long.txt new file mode 100644 index 00000000000..8001c79a1b4 --- /dev/null +++ b/_sources/api-bson-generated/long.txt @@ -0,0 +1,487 @@ +====== +Long() +====== + +------------------ +Constructor +------------------ + + +Defines a Long class for representing a 64-bit two's-complement +integer value, which faithfully simulates the behavior of a Java "Long". This +implementation is derived from LongLib in GWT. + + + .. js:class:: Long() + + :param number low: the low (signed) 32 bits of the Long. + :param number high: the high (signed) 32 bits of the Long. + + +Constructs a 64-bit two's-complement integer, given its low and high 32-bit +values as *signed* integers. See the from* functions below for more +convenient ways of constructing Longs. + + + +The internal representation of a Long is the two given signed, 32-bit values. +We use 32-bit pieces because these are the size of integers on which +Javascript performs bit-operations. For operations like addition and +multiplication, we split each number into 16-bit pieces, which can easily be +multiplied within Javascript's floating-point representation without overflow +or change in sign. + + + +In the algorithms below, we frequently reduce the negative case to the +positive case by negating the input(s) and then post-processing the result. +Note that we must ALWAYS check specially whether those values are MIN_VALUE +(-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as +a positive number, it overflows back into a negative). Not handling this +case would often result in infinite recursion. + + +----- +toInt +----- + + +Return the int value. + +.. js:function:: toInt() + + :returns: number the value, assuming it is a 32-bit integer. + + +-------- +toNumber +-------- + + +Return the Number value. + +.. js:function:: toNumber() + + :returns: number the closest floating-point representation to this value. + + +------ +toJSON +------ + + +Return the JSON value. + +.. js:function:: toJSON() + + :returns: string the JSON representation. + + +-------- +toString +-------- + + +Return the String value. + +.. js:function:: toString([opt_radix]) + + :param number [opt_radix]: the radix in which the text should be written. + :returns: string the textual representation of this value. + + +----------- +getHighBits +----------- + + +Return the high 32-bits value. + +.. js:function:: getHighBits() + + :returns: number the high 32-bits as a signed value. + + +---------- +getLowBits +---------- + + +Return the low 32-bits value. + +.. js:function:: getLowBits() + + :returns: number the low 32-bits as a signed value. + + +------------------ +getLowBitsUnsigned +------------------ + + +Return the low unsigned 32-bits value. + +.. js:function:: getLowBitsUnsigned() + + :returns: number the low 32-bits as an unsigned value. + + +------------- +getNumBitsAbs +------------- + + +Returns the number of bits needed to represent the absolute value of this Long. + +.. js:function:: getNumBitsAbs() + + :returns: number Returns the number of bits needed to represent the absolute value of this Long. + + +------ +isZero +------ + + +Return whether this value is zero. + +.. js:function:: isZero() + + :returns: boolean whether this value is zero. + + +---------- +isNegative +---------- + + +Return whether this value is negative. + +.. js:function:: isNegative() + + :returns: boolean whether this value is negative. + + +----- +isOdd +----- + + +Return whether this value is odd. + +.. js:function:: isOdd() + + :returns: boolean whether this value is odd. + + +------ +equals +------ + + +Return whether this Long equals the other + +.. js:function:: equals(other) + + :param long other: Long to compare against. + :returns: boolean whether this Long equals the other + + +--------- +notEquals +--------- + + +Return whether this Long does not equal the other. + +.. js:function:: notEquals(other) + + :param long other: Long to compare against. + :returns: boolean whether this Long does not equal the other. + + +-------- +lessThan +-------- + + +Return whether this Long is less than the other. + +.. js:function:: lessThan(other) + + :param long other: Long to compare against. + :returns: boolean whether this Long is less than the other. + + +--------------- +lessThanOrEqual +--------------- + + +Return whether this Long is less than or equal to the other. + +.. js:function:: lessThanOrEqual(other) + + :param long other: Long to compare against. + :returns: boolean whether this Long is less than or equal to the other. + + +----------- +greaterThan +----------- + + +Return whether this Long is greater than the other. + +.. js:function:: greaterThan(other) + + :param long other: Long to compare against. + :returns: boolean whether this Long is greater than the other. + + +------------------ +greaterThanOrEqual +------------------ + + +Return whether this Long is greater than or equal to the other. + +.. js:function:: greaterThanOrEqual(other) + + :param long other: Long to compare against. + :returns: boolean whether this Long is greater than or equal to the other. + + +------- +compare +------- + + +Compares this Long with the given one. + +.. js:function:: compare(other) + + :param long other: Long to compare against. + :returns: boolean 0 if they are the same, 1 if the this is greater, and -1 if the given one is greater. + + +------ +negate +------ + + +The negation of this value. + +.. js:function:: negate() + + :returns: long the negation of this value. + + +--- +add +--- + + +Returns the sum of this and the given Long. + +.. js:function:: add(other) + + :param long other: Long to add to this one. + :returns: long the sum of this and the given Long. + + +-------- +subtract +-------- + + +Returns the difference of this and the given Long. + +.. js:function:: subtract(other) + + :param long other: Long to subtract from this. + :returns: long the difference of this and the given Long. + + +-------- +multiply +-------- + + +Returns the product of this and the given Long. + +.. js:function:: multiply(other) + + :param long other: Long to multiply with this. + :returns: long the product of this and the other. + + +--- +div +--- + + +Returns this Long divided by the given one. + +.. js:function:: div(other) + + :param long other: Long by which to divide. + :returns: long this Long divided by the given one. + + +------ +modulo +------ + + +Returns this Long modulo the given one. + +.. js:function:: modulo(other) + + :param long other: Long by which to mod. + :returns: long this Long modulo the given one. + + +--- +not +--- + + +The bitwise-NOT of this value. + +.. js:function:: not() + + :returns: long the bitwise-NOT of this value. + + +--- +and +--- + + +Returns the bitwise-AND of this Long and the given one. + +.. js:function:: and(other) + + :param long other: the Long with which to AND. + :returns: long the bitwise-AND of this and the other. + + +-- +or +-- + + +Returns the bitwise-OR of this Long and the given one. + +.. js:function:: or(other) + + :param long other: the Long with which to OR. + :returns: long the bitwise-OR of this and the other. + + +--- +xor +--- + + +Returns the bitwise-XOR of this Long and the given one. + +.. js:function:: xor(other) + + :param long other: the Long with which to XOR. + :returns: long the bitwise-XOR of this and the other. + + +--------- +shiftLeft +--------- + + +Returns this Long with bits shifted to the left by the given amount. + +.. js:function:: shiftLeft(numBits) + + :param number numBits: the number of bits by which to shift. + :returns: long this shifted to the left by the given amount. + + +---------- +shiftRight +---------- + + +Returns this Long with bits shifted to the right by the given amount. + +.. js:function:: shiftRight(numBits) + + :param number numBits: the number of bits by which to shift. + :returns: long this shifted to the right by the given amount. + + +------------------ +shiftRightUnsigned +------------------ + + +Returns this Long with bits shifted to the right by the given amount, with the new top bits matching the current sign bit. + +.. js:function:: shiftRightUnsigned(numBits) + + :param number numBits: the number of bits by which to shift. + :returns: long this shifted to the right by the given amount, with zeros placed into the new leading bits. + + +------------ +Long.fromInt +------------ + + +Returns a Long representing the given (32-bit) integer value. + +.. js:function:: Long.fromInt(value) + + :param number value: the 32-bit integer in question. + :returns: long the corresponding Long value. + + +--------------- +Long.fromNumber +--------------- + + +Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned. + +.. js:function:: Long.fromNumber(value) + + :param number value: the number in question. + :returns: long the corresponding Long value. + + +------------- +Long.fromBits +------------- + + +Returns a Long representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits. + +.. js:function:: Long.fromBits(lowBits, highBits) + + :param number lowBits: the low 32-bits. + :param number highBits: the high 32-bits. + :returns: long the corresponding Long value. + + +--------------- +Long.fromString +--------------- + + +Returns a Long representation of the given string, written using the given radix. + +.. js:function:: Long.fromString(str, opt_radix) + + :param string str: the textual representation of the Long. + :param number opt_radix: the radix in which the text is written. + :returns: long the corresponding Long value. + diff --git a/_sources/api-bson-generated/maxkey.txt b/_sources/api-bson-generated/maxkey.txt new file mode 100644 index 00000000000..5134b480104 --- /dev/null +++ b/_sources/api-bson-generated/maxkey.txt @@ -0,0 +1,17 @@ +======== +MaxKey() +======== + +------------------ +Constructor +------------------ + + +A class representation of the BSON MaxKey type. + + + .. js:class:: MaxKey() + + :returns: maxkey + + diff --git a/_sources/api-bson-generated/minkey.txt b/_sources/api-bson-generated/minkey.txt new file mode 100644 index 00000000000..68fd1efdba2 --- /dev/null +++ b/_sources/api-bson-generated/minkey.txt @@ -0,0 +1,17 @@ +======== +MinKey() +======== + +------------------ +Constructor +------------------ + + +A class representation of the BSON MinKey type. + + + .. js:class:: MinKey() + + :returns: minkey + + diff --git a/_sources/api-bson-generated/objectid.txt b/_sources/api-bson-generated/objectid.txt new file mode 100644 index 00000000000..568ee883990 --- /dev/null +++ b/_sources/api-bson-generated/objectid.txt @@ -0,0 +1,223 @@ +========== +ObjectID() +========== + +------------------ +Constructor +------------------ + + +Create a new ObjectID instance + + + .. js:class:: ObjectID() + + :param string id: Can be a 24 byte hex string, 12 byte binary string or a Number. + :returns: object instance of ObjectID. + + + +----------- +toHexString +----------- + + +Return the ObjectID id as a 24 byte hex string representation + +.. js:function:: toHexString() + + :returns: string return the 24 byte hex string representation. + + +**Examples** + + + + Generate a 24 character hex string representation of the ObjectID + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Create a new ObjectID + var objectId = new ObjectID(); + // Verify that the hex string is 24 characters long + assert.equal(24, objectId.toHexString().length); + + +------ +equals +------ + + +Compares the equality of this ObjectID with otherID. + +.. js:function:: equals(otherID) + + :param object otherID: ObjectID instance to compare against. + :returns: bool the result of comparing two ObjectID's + + +**Examples** + + + + Compare two different ObjectID's using the equals method + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Create a new ObjectID + var objectId = new ObjectID(); + // Create a new ObjectID Based on the first ObjectID + var objectId2 = new ObjectID(objectId.id); + // Create another ObjectID + var objectId3 = new ObjectID(); + // objectId and objectId2 should be the same + assert.ok(objectId.equals(objectId2)); + // objectId and objectId2 should be different + assert.ok(!objectId.equals(objectId3)); + + +------------ +getTimestamp +------------ + + +Returns the generation time in seconds that this ID was generated. + +.. js:function:: getTimestamp() + + :returns: number return number of seconds in the timestamp part of the 12 byte id. + + +**Examples** + + + + Generate 12 byte binary string representation using a second based timestamp or + default value + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Get a timestamp in seconds + var timestamp = Math.floor(new Date().getTime()/1000); + // Create a date with the timestamp + var timestampDate = new Date(timestamp*1000); + + // Create a new ObjectID with a specific timestamp + var objectId = new ObjectID(timestamp); + + // Get the timestamp and validate correctness + assert.equal(timestampDate.toString(), objectId.getTimestamp().toString()); + + +----------------------- +ObjectID.createFromTime +----------------------- + + +Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID. + +.. js:function:: ObjectID.createFromTime(time) + + :param number time: an integer number representing a number of seconds. + :returns: objectid return the created ObjectID + + +**Examples** + + + + Show the usage of the Objectid createFromTime function + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var objectId = ObjectID.createFromTime(1); + assert.equal("000000010000000000000000", objectId.toHexString()); + + +---------------------------- +ObjectID.createFromHexString +---------------------------- + + +Creates an ObjectID from a hex string representation of an ObjectID. + +.. js:function:: ObjectID.createFromHexString(hexString) + + :param string hexString: create a ObjectID from a passed in 24 byte hexstring. + :returns: objectid return the created ObjectID + + +**Examples** + + + + Convert a ObjectID into a hex string representation and then back to an ObjectID + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Create a new ObjectID + var objectId = new ObjectID(); + // Convert the object id to a hex string + var originalHex = objectId.toHexString(); + // Create a new ObjectID using the createFromHexString function + var newObjectId = new ObjectID.createFromHexString(originalHex) + // Convert the new ObjectID back into a hex string using the toHexString function + var newHex = newObjectId.toHexString(); + // Compare the two hex strings + assert.equal(originalHex, newHex); + diff --git a/_sources/api-bson-generated/symbol.txt b/_sources/api-bson-generated/symbol.txt new file mode 100644 index 00000000000..3cf5cfc13e2 --- /dev/null +++ b/_sources/api-bson-generated/symbol.txt @@ -0,0 +1,30 @@ +======== +Symbol() +======== + +------------------ +Constructor +------------------ + + +A class representation of the BSON Symbol type. + + + .. js:class:: Symbol() + + :param string value: the string representing the symbol. + :returns: symbol + + + +------- +valueOf +------- + + +Access the wrapped string value. + +.. js:function:: valueOf() + + :returns: string returns the wrapped string. + diff --git a/_sources/api-bson-generated/timestamp.txt b/_sources/api-bson-generated/timestamp.txt new file mode 100644 index 00000000000..e28ea56dc3e --- /dev/null +++ b/_sources/api-bson-generated/timestamp.txt @@ -0,0 +1,487 @@ +=========== +Timestamp() +=========== + +------------------ +Constructor +------------------ + + +Defines a Timestamp class for representing a 64-bit two's-complement +integer value, which faithfully simulates the behavior of a Java "Timestamp". This +implementation is derived from TimestampLib in GWT. + + + .. js:class:: Timestamp() + + :param number low: the low (signed) 32 bits of the Timestamp. + :param number high: the high (signed) 32 bits of the Timestamp. + + +Constructs a 64-bit two's-complement integer, given its low and high 32-bit +values as *signed* integers. See the from* functions below for more +convenient ways of constructing Timestamps. + + + +The internal representation of a Timestamp is the two given signed, 32-bit values. +We use 32-bit pieces because these are the size of integers on which +Javascript performs bit-operations. For operations like addition and +multiplication, we split each number into 16-bit pieces, which can easily be +multiplied within Javascript's floating-point representation without overflow +or change in sign. + + + +In the algorithms below, we frequently reduce the negative case to the +positive case by negating the input(s) and then post-processing the result. +Note that we must ALWAYS check specially whether those values are MIN_VALUE +(-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as +a positive number, it overflows back into a negative). Not handling this +case would often result in infinite recursion. + + +----- +toInt +----- + + +Return the int value. + +.. js:function:: toInt() + + :returns: number the value, assuming it is a 32-bit integer. + + +-------- +toNumber +-------- + + +Return the Number value. + +.. js:function:: toNumber() + + :returns: number the closest floating-point representation to this value. + + +------ +toJSON +------ + + +Return the JSON value. + +.. js:function:: toJSON() + + :returns: string the JSON representation. + + +-------- +toString +-------- + + +Return the String value. + +.. js:function:: toString([opt_radix]) + + :param number [opt_radix]: the radix in which the text should be written. + :returns: string the textual representation of this value. + + +----------- +getHighBits +----------- + + +Return the high 32-bits value. + +.. js:function:: getHighBits() + + :returns: number the high 32-bits as a signed value. + + +---------- +getLowBits +---------- + + +Return the low 32-bits value. + +.. js:function:: getLowBits() + + :returns: number the low 32-bits as a signed value. + + +------------------ +getLowBitsUnsigned +------------------ + + +Return the low unsigned 32-bits value. + +.. js:function:: getLowBitsUnsigned() + + :returns: number the low 32-bits as an unsigned value. + + +------------- +getNumBitsAbs +------------- + + +Returns the number of bits needed to represent the absolute value of this Timestamp. + +.. js:function:: getNumBitsAbs() + + :returns: number Returns the number of bits needed to represent the absolute value of this Timestamp. + + +------ +isZero +------ + + +Return whether this value is zero. + +.. js:function:: isZero() + + :returns: boolean whether this value is zero. + + +---------- +isNegative +---------- + + +Return whether this value is negative. + +.. js:function:: isNegative() + + :returns: boolean whether this value is negative. + + +----- +isOdd +----- + + +Return whether this value is odd. + +.. js:function:: isOdd() + + :returns: boolean whether this value is odd. + + +------ +equals +------ + + +Return whether this Timestamp equals the other + +.. js:function:: equals(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean whether this Timestamp equals the other + + +--------- +notEquals +--------- + + +Return whether this Timestamp does not equal the other. + +.. js:function:: notEquals(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean whether this Timestamp does not equal the other. + + +-------- +lessThan +-------- + + +Return whether this Timestamp is less than the other. + +.. js:function:: lessThan(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean whether this Timestamp is less than the other. + + +--------------- +lessThanOrEqual +--------------- + + +Return whether this Timestamp is less than or equal to the other. + +.. js:function:: lessThanOrEqual(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean whether this Timestamp is less than or equal to the other. + + +----------- +greaterThan +----------- + + +Return whether this Timestamp is greater than the other. + +.. js:function:: greaterThan(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean whether this Timestamp is greater than the other. + + +------------------ +greaterThanOrEqual +------------------ + + +Return whether this Timestamp is greater than or equal to the other. + +.. js:function:: greaterThanOrEqual(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean whether this Timestamp is greater than or equal to the other. + + +------- +compare +------- + + +Compares this Timestamp with the given one. + +.. js:function:: compare(other) + + :param timestamp other: Timestamp to compare against. + :returns: boolean 0 if they are the same, 1 if the this is greater, and -1 if the given one is greater. + + +------ +negate +------ + + +The negation of this value. + +.. js:function:: negate() + + :returns: timestamp the negation of this value. + + +--- +add +--- + + +Returns the sum of this and the given Timestamp. + +.. js:function:: add(other) + + :param timestamp other: Timestamp to add to this one. + :returns: timestamp the sum of this and the given Timestamp. + + +-------- +subtract +-------- + + +Returns the difference of this and the given Timestamp. + +.. js:function:: subtract(other) + + :param timestamp other: Timestamp to subtract from this. + :returns: timestamp the difference of this and the given Timestamp. + + +-------- +multiply +-------- + + +Returns the product of this and the given Timestamp. + +.. js:function:: multiply(other) + + :param timestamp other: Timestamp to multiply with this. + :returns: timestamp the product of this and the other. + + +--- +div +--- + + +Returns this Timestamp divided by the given one. + +.. js:function:: div(other) + + :param timestamp other: Timestamp by which to divide. + :returns: timestamp this Timestamp divided by the given one. + + +------ +modulo +------ + + +Returns this Timestamp modulo the given one. + +.. js:function:: modulo(other) + + :param timestamp other: Timestamp by which to mod. + :returns: timestamp this Timestamp modulo the given one. + + +--- +not +--- + + +The bitwise-NOT of this value. + +.. js:function:: not() + + :returns: timestamp the bitwise-NOT of this value. + + +--- +and +--- + + +Returns the bitwise-AND of this Timestamp and the given one. + +.. js:function:: and(other) + + :param timestamp other: the Timestamp with which to AND. + :returns: timestamp the bitwise-AND of this and the other. + + +-- +or +-- + + +Returns the bitwise-OR of this Timestamp and the given one. + +.. js:function:: or(other) + + :param timestamp other: the Timestamp with which to OR. + :returns: timestamp the bitwise-OR of this and the other. + + +--- +xor +--- + + +Returns the bitwise-XOR of this Timestamp and the given one. + +.. js:function:: xor(other) + + :param timestamp other: the Timestamp with which to XOR. + :returns: timestamp the bitwise-XOR of this and the other. + + +--------- +shiftLeft +--------- + + +Returns this Timestamp with bits shifted to the left by the given amount. + +.. js:function:: shiftLeft(numBits) + + :param number numBits: the number of bits by which to shift. + :returns: timestamp this shifted to the left by the given amount. + + +---------- +shiftRight +---------- + + +Returns this Timestamp with bits shifted to the right by the given amount. + +.. js:function:: shiftRight(numBits) + + :param number numBits: the number of bits by which to shift. + :returns: timestamp this shifted to the right by the given amount. + + +------------------ +shiftRightUnsigned +------------------ + + +Returns this Timestamp with bits shifted to the right by the given amount, with the new top bits matching the current sign bit. + +.. js:function:: shiftRightUnsigned(numBits) + + :param number numBits: the number of bits by which to shift. + :returns: timestamp this shifted to the right by the given amount, with zeros placed into the new leading bits. + + +----------------- +Timestamp.fromInt +----------------- + + +Returns a Timestamp representing the given (32-bit) integer value. + +.. js:function:: Timestamp.fromInt(value) + + :param number value: the 32-bit integer in question. + :returns: timestamp the corresponding Timestamp value. + + +-------------------- +Timestamp.fromNumber +-------------------- + + +Returns a Timestamp representing the given value, provided that it is a finite number. Otherwise, zero is returned. + +.. js:function:: Timestamp.fromNumber(value) + + :param number value: the number in question. + :returns: timestamp the corresponding Timestamp value. + + +------------------ +Timestamp.fromBits +------------------ + + +Returns a Timestamp representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits. + +.. js:function:: Timestamp.fromBits(lowBits, highBits) + + :param number lowBits: the low 32-bits. + :param number highBits: the high 32-bits. + :returns: timestamp the corresponding Timestamp value. + + +-------------------- +Timestamp.fromString +-------------------- + + +Returns a Timestamp representation of the given string, written using the given radix. + +.. js:function:: Timestamp.fromString(str, opt_radix) + + :param string str: the textual representation of the Timestamp. + :param number opt_radix: the radix in which the text is written. + :returns: timestamp the corresponding Timestamp value. + diff --git a/_sources/api-generated/admin.txt b/_sources/api-generated/admin.txt new file mode 100644 index 00000000000..28f4e7e65a7 --- /dev/null +++ b/_sources/api-generated/admin.txt @@ -0,0 +1,979 @@ +======= +Admin() +======= + +------------------ +Constructor +------------------ + + +Allows the user to access the admin functionality of MongoDB + + + .. js:class:: Admin() + + :param object db: Current db instance we wish to perform Admin operations on. + :returns: function Constructor for Admin type. + + + +--------- +buildInfo +--------- + + +Retrieve the server information for the current +instance of the db client + +.. js:function:: buildInfo(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from buildInfo or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + Retrieve the buildInfo for the current MongoDB instance + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin3', 'admin3', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin3', 'admin3', function(err, result) { + assert.ok(result); + + // Retrive the build information for the MongoDB instance + adminDb.buildInfo(function(err, info) { + assert.ok(err == null); + + adminDb.removeUser('admin3', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + + +------------ +serverStatus +------------ + + +Retrieve this db's server status. + +.. js:function:: serverStatus(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from serverStatus or null if an error occured. + :returns: null + + +**Examples** + + + + Retrieve the current server Info + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w: 1}, function(err, doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin13', 'admin13', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin13', 'admin13', function(err, result) { + + // Retrive the server Info + adminDb.serverStatus(function(err, info) { + assert.equal(null, err); + assert.ok(info != null); + + adminDb.removeUser('admin13', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + }); + + +-------------- +profilingLevel +-------------- + + +Retrieve the current profiling Level for MongoDB + +.. js:function:: profilingLevel(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from profilingLevel or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + Retrieve the current profiling level set for the MongoDB instance + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w: 1}, function(err, doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin5', 'admin5', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin5', 'admin5', function(err, replies) { + + // Retrive the profiling level + adminDb.profilingLevel(function(err, level) { + + adminDb.removeUser('admin5', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + }); + + +---- +ping +---- + + +Ping the MongoDB server and retrieve results + +.. js:function:: ping(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from ping or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how to add a user to the admin database + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin9', 'admin9', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin9', 'admin9', function(err, result) { + assert.ok(result); + + // Ping the server + adminDb.ping(function(err, pingResult) { + assert.equal(null, err); + + adminDb.removeUser('admin9', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + + +------------ +authenticate +------------ + + +Authenticate against MongoDB + +.. js:function:: authenticate(username, password, callback) + + :param string username: The user name for the authentication. + :param string password: The password for the authentication. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from authenticate or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + Authenticate against MongoDB Admin user + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + db.open(function(err, db) { + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w:1}, function(err, doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin2', 'admin2', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin2', 'admin2', function(err, result) { + assert.ok(result); + + adminDb.removeUser('admin2', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + + +------ +logout +------ + + +Logout current authenticated user + +.. js:function:: logout([options], callback) + + :param object [options]: Optional parameters to the command. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from logout or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how add a user, authenticate and logout + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin10', 'admin10', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin10', 'admin10', function(err, result) { + assert.ok(result); + + // Logout the user + adminDb.logout(function(err, result) { + assert.equal(true, result); + + adminDb.removeUser('admin10', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + + +------- +addUser +------- + + +Add a user to the MongoDB server, if the user exists it will +overwrite the current password + + + +Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: addUser(username, password[, options], callback) + + :param string username: The user name for the authentication. + :param string password: The password for the authentication. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from addUser or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how to add a user to the admin database + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin11', 'admin11', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin11', 'admin11', function(err, result) { + assert.ok(result); + + adminDb.removeUser('admin11', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + + +---------- +removeUser +---------- + + +Remove a user from the MongoDB server + + + +Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: removeUser(username[, options], callback) + + :param string username: The user name for the authentication. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from removeUser or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how to remove a user from the admin database + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin12', 'admin12', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin12', 'admin12', function(err, result) { + assert.ok(result); + + // Remove the user + adminDb.removeUser('admin12', function(err, result) { + assert.equal(null, err); + assert.equal(true, result); + + // Authenticate using the removed user should fail + adminDb.authenticate('admin12', 'admin12', function(err, result) { + assert.ok(err != null); + assert.ok(!result); + + db.close(); + }); + }) + }); + }); + }); + + +----------------- +setProfilingLevel +----------------- + + +Set the current profiling level of MongoDB + +.. js:function:: setProfilingLevel(level, callback) + + :param string level: The new profiling level (off, slow_only, all) + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from setProfilingLevel or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how to use the setProfilingInfo + Use this command to set the Profiling level on the MongoDB server + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w: 1}, function(err, doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin6', 'admin6', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin6', 'admin6', function(err, replies) { + + // Set the profiling level to only profile slow queries + adminDb.setProfilingLevel('slow_only', function(err, level) { + + // Retrive the profiling level and verify that it's set to slow_only + adminDb.profilingLevel(function(err, level) { + assert.equal('slow_only', level); + + // Turn profiling off + adminDb.setProfilingLevel('off', function(err, level) { + + // Retrive the profiling level and verify that it's set to off + adminDb.profilingLevel(function(err, level) { + assert.equal('off', level); + + // Set the profiling level to log all queries + adminDb.setProfilingLevel('all', function(err, level) { + + // Retrive the profiling level and verify that it's set to all + adminDb.profilingLevel(function(err, level) { + assert.equal('all', level); + + // Attempt to set an illegal profiling level + adminDb.setProfilingLevel('medium', function(err, level) { + assert.ok(err instanceof Error); + assert.equal("Error: illegal profiling level value medium", err.message); + + adminDb.removeUser('admin6', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }) + }); + }) + }); + }) + }); + }); + }); + }); + }); + + +------------- +profilingInfo +------------- + + +Retrive the current profiling information for MongoDB + +.. js:function:: profilingInfo(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from profilingInfo or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how to use the profilingInfo + Use this command to pull back the profiling information currently set for Mongodb + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w: 1}, function(doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin7', 'admin7', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin7', 'admin7', function(err, replies) { + + // Set the profiling level to all + adminDb.setProfilingLevel('all', function(err, level) { + + // Execute a query command + collection.find().toArray(function(err, items) { + + // Turn off profiling + adminDb.setProfilingLevel('off', function(err, level) { + + // Retrive the profiling information + adminDb.profilingInfo(function(err, infos) { + assert.ok(infos.constructor == Array); + assert.ok(infos.length >= 1); + assert.ok(infos[0].ts.constructor == Date); + assert.ok(infos[0].millis.constructor == Number); + + adminDb.removeUser('admin7', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + }); + }); + + +------- +command +------- + + +Execute a db command against the Admin database + +.. js:function:: command(command[, options], callback) + + :param object command: A command object `{ping:1}`. + :param object [options]: Optional parameters to the command. + :param function callback: this will be called after executing this method. The command always return the whole result of the command as the second parameter. + :returns: null Returns no result + + +**Examples** + + + + Retrieve the buildInfo using the command function + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin4', 'admin4', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin4', 'admin4', function(err, result) { + assert.ok(result); + + // Retrive the build information using the admin command + adminDb.command({buildInfo:1}, function(err, info) { + assert.ok(err == null); + + adminDb.removeUser('admin4', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + + +------------------ +validateCollection +------------------ + + +Validate an existing collection + +.. js:function:: validateCollection(collectionName[, options], callback) + + :param string collectionName: The name of the collection to validate. + :param object [options]: Optional parameters to the command. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from validateCollection or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of how to use the validateCollection command + Use this command to check that a collection is valid (not corrupt) and to get various statistics. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w: 1}, function(err, doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin8', 'admin8', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin8', 'admin8', function(err, replies) { + + // Validate the 'test' collection + adminDb.validateCollection('test', function(err, doc) { + + // Pre 1.9.1 servers + if(doc.result != null) { + assert.ok(doc.result != null); + assert.ok(doc.result.match(/firstExtent/) != null); + } else { + assert.ok(doc.firstExtent != null); + } + + adminDb.removeUser('admin8', function(err, result) { + assert.ok(result); + + db.close(); + }); + }); + }); + }); + }); + }); + + +------------- +listDatabases +------------- + + +List the available databases + +.. js:function:: listDatabases(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from listDatabases or null if an error occured. + :returns: null Returns no result + + +**Examples** + + + + An example of listing all available databases. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // List all the available databases + adminDb.listDatabases(function(err, dbs) { + assert.equal(null, err); + assert.ok(dbs.databases.length > 0); + + db.close(); + }); + }); + + +---------------- +replSetGetStatus +---------------- + + +Get ReplicaSet status + +.. js:function:: replSetGetStatus(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from replSetGetStatus or null if an error occured. + :returns: null + + +**Examples** + + + + Retrieve the current replicaset status if the server is running as part of a replicaset + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Grab a collection object + var collection = db.collection('test'); + + // Force the creation of the collection by inserting a document + // Collections are not created until the first document is inserted + collection.insert({'a':1}, {w: 1}, function(err, doc) { + + // Use the admin database for the operation + var adminDb = db.admin(); + + // Add the new user to the admin database + adminDb.addUser('admin14', 'admin14', function(err, result) { + + // Authenticate using the newly added user + adminDb.authenticate('admin14', 'admin14', function(err, result) { + + // Retrive the server Info, returns error if we are not + // running a replicaset + adminDb.replSetGetStatus(function(err, info) { + + adminDb.removeUser('admin14', function(err, result) { + assert.ok(result); + + db.close(); + }); + }) + }); + }); + }); + }); + diff --git a/_sources/api-generated/collection.txt b/_sources/api-generated/collection.txt new file mode 100644 index 00000000000..fe2914a345a --- /dev/null +++ b/_sources/api-generated/collection.txt @@ -0,0 +1,2888 @@ +============ +Collection() +============ + +------------------ +Constructor +------------------ + + +Create a new Collection instance (INTERNAL TYPE) + + + .. js:class:: Collection() + + :param object db: db instance. + :param string collectionName: collection name. + :param object [pkFactory]: alternative primary key factory. + :param object [options]: additional options for the collection. + :returns: object a collection instance. + + +Options + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + - **slaveOk** {Boolean, default:false}, Allow reads from secondaries. + - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. + - **raw** {Boolean, default:false}, perform all operations using raw bson objects. + - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. + + +------ +insert +------ + + +Inserts a single document or a an array of documents into MongoDB. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **continueOnError/keepGoing** {Boolean, default:false}, keep inserting documents even if one document has an error, *mongodb 1.9.1 >*. + - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: insert(docs[, options], [callback]) + + :param array docs: + :param object [options]: optional options for insert command + :param function [callback]: optional callback for the function, must be provided when using a writeconcern + :returns: null + + +**Examples** + + + + A simple document insert example, not using safe mode to ensure document persistance on MongoDB + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Fetch a collection to insert document into + var collection = db.collection("simple_document_insert_collection_no_safe"); + // Insert a single document + collection.insert({hello:'world_no_safe'}); + + // Wait for a second before finishing up, to ensure we have written the item to disk + setTimeout(function() { + + // Fetch the document + collection.findOne({hello:'world_no_safe'}, function(err, item) { + assert.equal(null, err); + assert.equal('world_no_safe', item.hello); + }) + }, 100); + + + + A batch document insert example, using safe mode to ensure document persistance on MongoDB + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Fetch a collection to insert document into + var collection = db.collection("batch_document_insert_collection_safe"); + // Insert a single document + collection.insert([{hello:'world_safe1'} + , {hello:'world_safe2'}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Fetch the document + collection.findOne({hello:'world_safe2'}, function(err, item) { + assert.equal(null, err); + assert.equal('world_safe2', item.hello); + }) + }); + + + + Example of inserting a document containing functions + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Fetch a collection to insert document into + var collection = db.collection("simple_document_insert_with_function_safe"); + // Insert a single document + collection.insert({hello:'world' + , func:function() {}}, {w:1, serializeFunctions:true}, function(err, result) { + assert.equal(null, err); + + // Fetch the document + collection.findOne({hello:'world'}, function(err, item) { + assert.equal(null, err); + assert.ok("function() {}", item.code); + }) + }); + + + + Example of using keepGoing to allow batch insert to complete even when there are illegal documents in the batch + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Only run the rest of the code if we have a mongodb server with version >= 1.9.1 + db.admin().serverInfo(function(err, result){ + + // Ensure we are running at least MongoDB v1.9.1 + if(parseInt((result.version.replace(/\./g, ''))) >= 191) { + + // Create a collection + var collection = db.collection('keepGoingExample'); + + // Add an unique index to title to force errors in the batch insert + collection.ensureIndex({title:1}, {unique:true}, function(err, indexName) { + + // Insert some intial data into the collection + collection.insert([{name:"Jim"} + , {name:"Sarah", title:"Princess"}], {w:1}, function(err, result) { + + // Force keep going flag, ignoring unique index issue + collection.insert([{name:"Jim"} + , {name:"Sarah", title:"Princess"} + , {name:'Gump', title:"Gump"}], {w:1, keepGoing:true}, function(err, result) { + + // Count the number of documents left (should not include the duplicates) + collection.count(function(err, count) { + assert.equal(3, count); + }) + }); + }); + }); + } else { + test.done(); + } + }); + + +------ +remove +------ + + +Removes documents specified by selector from the db. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **single** {Boolean, default:false}, removes the first document found. + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: remove([selector][, options], [callback]) + + :param object [selector]: optional select, no selector is equivalent to removing all documents. + :param object [options]: additional options during remove. + :param function [callback]: must be provided if you performing a remove with a writeconcern + :returns: null + + +**Examples** + + + + An example removing all documents in a collection not using safe mode + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Fetch a collection to insert document into + db.collection("remove_all_documents_no_safe", function(err, collection) { + + // Insert a bunch of documents + collection.insert([{a:1}, {b:2}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Remove all the document + collection.remove(); + + // Fetch all results + collection.find().toArray(function(err, items) { + assert.equal(null, err); + assert.equal(0, items.length); + db.close(); + }); + }); + }) + }); + + + + An example removing a subset of documents using safe mode to ensure removal of documents + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Fetch a collection to insert document into + db.collection("remove_subset_of_documents_safe", function(err, collection) { + + // Insert a bunch of documents + collection.insert([{a:1}, {b:2}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Remove all the document + collection.remove({a:1}, {w:1}, function(err, numberOfRemovedDocs) { + assert.equal(null, err); + assert.equal(1, numberOfRemovedDocs); + db.close(); + }); + }); + }) + }); + + +------ +rename +------ + + +Renames the collection. + + + +Options + - **dropTarget** {Boolean, default:false}, drop the target name collection if it previously exists. + +.. js:function:: rename(newName[, options], callback) + + :param string newName: the new name of the collection. + :param object [options]: returns option results. + :param function callback: the callback accepting the result + :returns: null + + +**Examples** + + + + An example of illegal and legal renaming of a collection + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Open a couple of collections + db.createCollection('test_rename_collection', function(err, collection1) { + db.createCollection('test_rename_collection2', function(err, collection2) { + + // Attemp to rename a collection to a number + try { + collection1.rename(5, function(err, collection) {}); + } catch(err) { + assert.ok(err instanceof Error); + assert.equal("collection name must be a String", err.message); + } + + // Attemp to rename a collection to an empty string + try { + collection1.rename("", function(err, collection) {}); + } catch(err) { + assert.ok(err instanceof Error); + assert.equal("collection names cannot be empty", err.message); + } + + // Attemp to rename a collection to an illegal name including the character $ + try { + collection1.rename("te$t", function(err, collection) {}); + } catch(err) { + assert.ok(err instanceof Error); + assert.equal("collection names must not contain '$'", err.message); + } + + // Attemp to rename a collection to an illegal name starting with the character . + try { + collection1.rename(".test", function(err, collection) {}); + } catch(err) { + assert.ok(err instanceof Error); + assert.equal("collection names must not start or end with '.'", err.message); + } + + // Attemp to rename a collection to an illegal name ending with the character . + try { + collection1.rename("test.", function(err, collection) {}); + } catch(err) { + assert.ok(err instanceof Error); + assert.equal("collection names must not start or end with '.'", err.message); + } + + // Attemp to rename a collection to an illegal name with an empty middle name + try { + collection1.rename("tes..t", function(err, collection) {}); + } catch(err) { + assert.equal("collection names cannot be empty", err.message); + } + + // Insert a couple of documents + collection1.insert([{'x':1}, {'x':2}], {w:1}, function(err, docs) { + + // Attemp to rename the first collection to the second one, this will fail + collection1.rename('test_rename_collection2', function(err, collection) { + assert.ok(err instanceof Error); + assert.ok(err.message.length > 0); + + // Attemp to rename the first collection to a name that does not exist + // this will be succesful + collection1.rename('test_rename_collection3', function(err, collection) { + assert.equal("test_rename_collection3", collection.collectionName); + + // Ensure that the collection is pointing to the new one + collection1.count(function(err, count) { + assert.equal(2, count); + db.close(); + }); + }); + }); + }) + }); + }); + }); + + +---- +save +---- + + +Save a document. Simple full document replacement function. Not recommended for efficiency, use atomic +operators and update instead for more efficient operations. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: save([doc][, options], [callback]) + + :param object [doc]: the document to save + :param object [options]: additional options during remove. + :param function [callback]: must be provided if you performing a safe save + :returns: null + + +**Examples** + + + + Example of a simple document save with safe set to false + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Fetch the collection + var collection = db.collection("save_a_simple_document"); + // Save a document with no safe option + collection.save({hello:'world'}); + + // Wait for a second + setTimeout(function() { + + // Find the saved document + collection.findOne({hello:'world'}, function(err, item) { + assert.equal(null, err); + assert.equal('world', item.hello); + db.close(); + }); + }, 1000); + }); + + + + Example of a simple document save and then resave with safe set to true + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Fetch the collection + var collection = db.collection("save_a_simple_document_modify_it_and_resave_it"); + + // Save a document with no safe option + collection.save({hello:'world'}, {w: 0}, function(err, result) { + + // Find the saved document + collection.findOne({hello:'world'}, function(err, item) { + assert.equal(null, err); + assert.equal('world', item.hello); + + // Update the document + item['hello2'] = 'world2'; + + // Save the item with the additional field + collection.save(item, {w: 1}, function(err, result) { + + // Find the changed document + collection.findOne({hello:'world'}, function(err, item) { + assert.equal(null, err); + assert.equal('world', item.hello); + assert.equal('world2', item.hello2); + + db.close(); + }); + }); + }); + }); + }); + + +------ +update +------ + + +Updates documents. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **upsert** {Boolean, default:false}, perform an upsert operation. + - **multi** {Boolean, default:false}, update all documents matching the selector. + - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: update(selector, document[, options], [callback]) + + :param object selector: the query to select the document/documents to be updated + :param object document: the fields/vals to be updated, or in the case of an upsert operation, inserted. + :param object [options]: additional options during update. + :param function [callback]: must be provided if you performing an update with a writeconcern + :returns: null + + +**Examples** + + + + Example of a simple document update with safe set to false on an existing document + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Get a collection + db.collection('update_a_simple_document', function(err, collection) { + + // Insert a document, then update it + collection.insert({a:1}, {w: 1}, function(err, doc) { + + // Update the document with an atomic operator + collection.update({a:1}, {$set:{b:2}}); + + // Wait for a second then fetch the document + setTimeout(function() { + + // Fetch the document that we modified + collection.findOne({a:1}, function(err, item) { + assert.equal(null, err); + assert.equal(1, item.a); + assert.equal(2, item.b); + db.close(); + }); + }, 1000); + }) + }); + }); + + + + Example of a simple document update using upsert (the document will be inserted if it does not exist) + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Get a collection + db.collection('update_a_simple_document_upsert', function(err, collection) { + + // Update the document using an upsert operation, ensuring creation if it does not exist + collection.update({a:1}, {b:2, a:1}, {upsert:true, w: 1}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result); + + // Fetch the document that we modified and check if it got inserted correctly + collection.findOne({a:1}, function(err, item) { + assert.equal(null, err); + assert.equal(1, item.a); + assert.equal(2, item.b); + db.close(); + }); + }); + }); + }); + + + + Example of an update across multiple documents using the multi option. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Get a collection + db.collection('update_a_simple_document_multi', function(err, collection) { + + // Insert a couple of documentations + collection.insert([{a:1, b:1}, {a:1, b:2}], {w: 1}, function(err, result) { + + // Update multiple documents using the multi option + collection.update({a:1}, {$set:{b:0}}, {w: 1, multi:true}, function(err, numberUpdated) { + assert.equal(null, err); + assert.equal(2, numberUpdated); + + // Fetch all the documents and verify that we have changed the b value + collection.find().toArray(function(err, items) { + assert.equal(null, err); + assert.equal(1, items[0].a); + assert.equal(0, items[0].b); + assert.equal(1, items[1].a); + assert.equal(0, items[1].b); + + db.close(); + }); + }) + }); + }); + }); + + +-------- +distinct +-------- + + +The distinct command returns returns a list of distinct values for the given key across a collection. + + + +Options + - **readPreference** {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: distinct(key[, query], [options], callback) + + :param string key: key to run distinct against. + :param object [query]: option query to narrow the returned objects. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from distinct or null if an error occured. + :returns: null + + +**Examples** + + + + Example of running the distinct command against a collection + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Crete the collection for the distinct example + db.createCollection('simple_key_based_distinct', function(err, collection) { + + // Insert documents to perform distinct against + collection.insert([{a:0, b:{c:'a'}}, {a:1, b:{c:'b'}}, {a:1, b:{c:'c'}}, + {a:2, b:{c:'a'}}, {a:3}, {a:3}], {w: 1}, function(err, ids) { + + // Peform a distinct query against the a field + collection.distinct('a', function(err, docs) { + assert.deepEqual([0, 1, 2, 3], docs.sort()); + + // Perform a distinct query against the sub-field b.c + collection.distinct('b.c', function(err, docs) { + assert.deepEqual(['a', 'b', 'c'], docs.sort()); + + db.close(); + }); + }); + }) + }); + }); + + + + Example of running the distinct command against a collection with a filter query + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Crete the collection for the distinct example + db.createCollection('simple_key_based_distinct_sub_query_filter', function(err, collection) { + + // Insert documents to perform distinct against + collection.insert([{a:0, b:{c:'a'}}, {a:1, b:{c:'b'}}, {a:1, b:{c:'c'}}, + {a:2, b:{c:'a'}}, {a:3}, {a:3}, {a:5, c:1}], {w: 1}, function(err, ids) { + + // Peform a distinct query with a filter against the documents + collection.distinct('a', {c:1}, function(err, docs) { + assert.deepEqual([5], docs.sort()); + + db.close(); + }); + }) + }); + }); + + +----- +count +----- + + +Count number of matching documents in the db to a query. + + + +Options + - **skip** {Number}, The number of documents to skip for the count. + - **limit** {Number}, The limit of documents to count. + - **readPreference** {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: count([query][, options], callback) + + :param object [query]: query to filter by before performing count. + :param object [options]: additional options during count. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the count method or null if an error occured. + :returns: null + + +**Examples** + + + + Example of running simple count commands against a collection. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Crete the collection for the distinct example + db.createCollection('simple_count_example', function(err, collection) { + + // Insert documents to perform distinct against + collection.insert([{a:1}, {a:2}, {a:3}, {a:4, b:1}], {w: 1}, function(err, ids) { + + // Perform a total count command + collection.count(function(err, count) { + assert.equal(null, err); + assert.equal(4, count); + + // Peform a partial account where b=1 + collection.count({b:1}, function(err, count) { + assert.equal(null, err); + assert.equal(1, count); + + db.close(); + }); + }); + }); + }); + }); + + +---- +drop +---- + + +Drop the collection + +.. js:function:: drop(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the drop method or null if an error occured. + :returns: null + + +**Examples** + + + + Example of a simple document save and then resave with safe set to true + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('test_other_drop', function(err, collection) { + assert.equal(null, err); + + // Drop the collection + collection.drop(function(err, reply) { + + // Ensure we don't have the collection in the set of names + db.collectionNames(function(err, replies) { + + var found = false; + // For each collection in the list of collection names in this db look for the + // dropped collection + replies.forEach(function(document) { + if(document.name == "test_other_drop") { + found = true; + return; + } + }); + + // Ensure the collection is not found + assert.equal(false, found); + + // Let's close the db + db.close(); + }); + }); + }); + }); + + +------------- +findAndModify +------------- + + +Find and update a document. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **remove** {Boolean, default:false}, set to true to remove the object before returning. + - **upsert** {Boolean, default:false}, perform an upsert operation. + - **new** {Boolean, default:false}, set to true if you want to return the modified object rather than the original. Ignored for remove. + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: findAndModify(query, sort, doc[, options], callback) + + :param object query: query object to locate the object to modify + :param array sort: - if multiple docs match, choose the first one in the specified sort order as the object to manipulate + :param object doc: - the fields/vals to be updated + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the findAndModify method or null if an error occured. + :returns: null + + +**Examples** + + + + A whole set of different ways to use the findAndModify command. + + + + The first findAndModify command modifies a document and returns the modified document back. + The second findAndModify command removes the document. + The second findAndModify command upserts a document and returns the new document. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_find_and_modify_operations_', function(err, collection) { + assert.equal(null, err); + + // Insert some test documentations + collection.insert([{a:1}, {b:1}, {c:1}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Simple findAndModify command returning the new document + collection.findAndModify({a:1}, [['a', 1]], {$set:{b1:1}}, {new:true}, function(err, doc) { + assert.equal(null, err); + assert.equal(1, doc.a); + assert.equal(1, doc.b1); + + // Simple findAndModify command returning the new document and + // removing it at the same time + collection.findAndModify({b:1}, [['b', 1]], + {$set:{b:2}}, {remove:true}, function(err, doc) { + + // Verify that the document is gone + collection.findOne({b:1}, function(err, item) { + assert.equal(null, err); + assert.equal(null, item); + + // Simple findAndModify command performing an upsert and returning the new document + // executing the command safely + collection.findAndModify({d:1}, [['b', 1]], + {d:1, f:1}, {new:true, upsert:true, w:1}, function(err, doc) { + assert.equal(null, err); + assert.equal(1, doc.d); + assert.equal(1, doc.f); + + db.close(); + }) + }); + }); + }); + }); + }); + }); + + +------------- +findAndRemove +------------- + + +Find and remove a document + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: findAndRemove(query, sort[, options], callback) + + :param object query: query object to locate the object to modify + :param array sort: - if multiple docs match, choose the first one in the specified sort order as the object to manipulate + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the findAndRemove method or null if an error occured. + :returns: null + + +**Examples** + + + + An example of using findAndRemove + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_find_and_modify_operations_', function(err, collection) { + assert.equal(null, err); + + // Insert some test documentations + collection.insert([{a:1}, {b:1}, {c:1}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Simple findAndModify command returning the new document and + // removing it at the same time + collection.findAndRemove({b:1}, [['b', 1]], function(err, doc) { + assert.equal(null, err); + assert.equal(1, doc.b); + + // Verify that the document is gone + collection.findOne({b:1}, function(err, item) { + assert.equal(null, err); + assert.equal(null, item); + + db.close(); + }); + }); + }); + }); + }); + + +---- +find +---- + + +Creates a cursor for a query that can be used to iterate over results from MongoDB + + + +Various argument possibilities + - callback? + - selector, callback?, + - selector, fields, callback? + - selector, options, callback? + - selector, fields, options, callback? + - selector, fields, skip, limit, callback? + - selector, fields, skip, limit, timeout, callback? + + + +Options + - **limit** {Number, default:0}, sets the limit of documents returned in the query. + - **sort** {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc. + - **fields** {Object}, the fields to return in the query. Object of fields to include or exclude (not both), {'a':1} + - **skip** {Number, default:0}, set to skip N documents ahead in your query (useful for pagination). + - **hint** {Object}, tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1} + - **explain** {Boolean, default:false}, explain the query instead of returning the data. + - **snapshot** {Boolean, default:false}, snapshot query. + - **timeout** {Boolean, default:false}, specify if the cursor can timeout. + - **tailable** {Boolean, default:false}, specify if the cursor is tailable. + - **tailableRetryInterval** {Number, default:100}, specify the miliseconds between getMores on tailable cursor. + - **numberOfRetries** {Number, default:5}, specify the number of times to retry the tailable cursor. + - **awaitdata** {Boolean, default:false} allow the cursor to wait for data, only applicable for tailable cursor. + - **exhaust** {Boolean, default:false} have the server send all the documents at once as getMore packets, not recommended. + - **batchSize** {Number, default:0}, set the batchSize for the getMoreCommand when iterating over the query results. + - **returnKey** {Boolean, default:false}, only return the index key. + - **maxScan** {Number}, Limit the number of items to scan. + - **min** {Number}, Set index bounds. + - **max** {Number}, Set index bounds. + - **showDiskLoc** {Boolean, default:false}, Show disk location of results. + - **comment** {String}, You can put a $comment field on a query to make looking in the profiler logs simpler. + - **raw** {Boolean, default:false}, Return all BSON documents as Raw Buffer documents. + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + - **numberOfRetries** {Number, default:5}, if using awaidata specifies the number of times to retry on timeout. + - **partial** {Boolean, default:false}, specify if the cursor should return partial results when querying against a sharded system + +.. js:function:: find(query[, options], callback) + + :param object query: query object to locate the object to modify + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the find method or null if an error occured. + :returns: cursor returns a cursor to the query + + +**Examples** + + + + A simple query using the find method on the collection. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_query', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the testing + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Peform a simple find and return all the documents + collection.find().toArray(function(err, docs) { + assert.equal(null, err); + assert.equal(3, docs.length); + + db.close(); + }); + }); + }); + }); + + + + A simple query showing the explain for a query + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_explain_query', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the testing + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Peform a simple find and return all the documents + collection.find({}, {explain:true}).toArray(function(err, docs) { + assert.equal(null, err); + assert.equal(1, docs.length); + + db.close(); + }); + }); + }); + }); + + + + A simple query showing skip and limit + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_limit_skip_query', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the testing + collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Peform a simple find and return all the documents + collection.find({}, {skip:1, limit:1, fields:{b:1}}).toArray(function(err, docs) { + assert.equal(null, err); + assert.equal(1, docs.length); + assert.equal(null, docs[0].a); + assert.equal(2, docs[0].b); + + db.close(); + }); + }); + }); + }); + + +------- +findOne +------- + + +Finds a single document based on the query + + + +Various argument possibilities + - callback? + - selector, callback?, + - selector, fields, callback? + - selector, options, callback? + - selector, fields, options, callback? + - selector, fields, skip, limit, callback? + - selector, fields, skip, limit, timeout, callback? + + + +Options + - **limit** {Number, default:0}, sets the limit of documents returned in the query. + - **sort** {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc. + - **fields** {Object}, the fields to return in the query. Object of fields to include or exclude (not both), {'a':1} + - **skip** {Number, default:0}, set to skip N documents ahead in your query (useful for pagination). + - **hint** {Object}, tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1} + - **explain** {Boolean, default:false}, explain the query instead of returning the data. + - **snapshot** {Boolean, default:false}, snapshot query. + - **timeout** {Boolean, default:false}, specify if the cursor can timeout. + - **tailable** {Boolean, default:false}, specify if the cursor is tailable. + - **batchSize** {Number, default:0}, set the batchSize for the getMoreCommand when iterating over the query results. + - **returnKey** {Boolean, default:false}, only return the index key. + - **maxScan** {Number}, Limit the number of items to scan. + - **min** {Number}, Set index bounds. + - **max** {Number}, Set index bounds. + - **showDiskLoc** {Boolean, default:false}, Show disk location of results. + - **comment** {String}, You can put a $comment field on a query to make looking in the profiler logs simpler. + - **raw** {Boolean, default:false}, Return all BSON documents as Raw Buffer documents. + - **readPreference** {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + - **partial** {Boolean, default:false}, specify if the cursor should return partial results when querying against a sharded system + +.. js:function:: findOne(query[, options], callback) + + :param object query: query object to locate the object to modify + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the findOne method or null if an error occured. + :returns: cursor returns a cursor to the query + + +**Examples** + + + + A simple query using findOne + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_limit_skip_find_one_query', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the testing + collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Peform a simple find and return all the documents + collection.findOne({a:2}, {fields:{b:1}}, function(err, doc) { + assert.equal(null, err); + assert.equal(null, doc.a); + assert.equal(2, doc.b); + + db.close(); + }); + }); + }); + }); + + +----------- +createIndex +----------- + + +Creates an index on the collection. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **unique** {Boolean, default:false}, creates an unique index. + - **sparse** {Boolean, default:false}, creates a sparse index. + - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. + - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value + - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. + - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. + - **v** {Number}, specify the format version of the indexes. + - **expireAfterSeconds** {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher) + - **name** {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes) + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: createIndex(fieldOrSpec[, options], callback) + + :param object fieldOrSpec: fieldOrSpec that defines the index. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the createIndex method or null if an error occured. + :returns: null + + +**Examples** + + + + A simple createIndex using a simple single field index + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('simple_index_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1}, {a:2}, {a:3}, {a:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.createIndex('a', {w:1}, function(err, indexName) { + assert.equal("a_1", indexName); + + // Peform a query, with explain to show we hit the query + collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { + assert.deepEqual([[2, 2]], explanation[0].indexBounds.a); + + db.close(); + }); + }); + }); + }); + }); + + + + A more complex createIndex using a compound unique index in the background and dropping duplicated documents + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('more_complex_index_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.createIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Show that duplicate records got dropped + collection.find({}).toArray(function(err, items) { + assert.equal(null, err); + assert.equal(4, items.length); + + // Peform a query, with explain to show we hit the query + collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { + assert.equal(null, err); + assert.ok(explanation[0].indexBounds.a != null); + assert.ok(explanation[0].indexBounds.b != null); + + db.close(); + }); + }) + }); + }); + }); + }); + + +----------- +ensureIndex +----------- + + +Ensures that an index exists, if it does not it creates it + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **unique** {Boolean, default:false}, creates an unique index. + - **sparse** {Boolean, default:false}, creates a sparse index. + - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. + - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value + - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. + - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. + - **v** {Number}, specify the format version of the indexes. + - **expireAfterSeconds** {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher) + - **name** {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes) + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: ensureIndex(fieldOrSpec[, options], callback) + + :param object fieldOrSpec: fieldOrSpec that defines the index. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the ensureIndex method or null if an error occured. + :returns: null + + +**Examples** + + + + A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('more_complex_ensure_index_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Show that duplicate records got dropped + collection.find({}).toArray(function(err, items) { + assert.equal(null, err); + assert.equal(4, items.length); + + // Peform a query, with explain to show we hit the query + collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { + assert.equal(null, err); + assert.ok(explanation[0].indexBounds.a != null); + assert.ok(explanation[0].indexBounds.b != null); + + db.close(); + }); + }) + }); + }); + }); + }); + + +---------------- +indexInformation +---------------- + + +Retrieves this collections index info. + + + +Options + - **full** {Boolean, default:false}, returns the full raw index information. + +.. js:function:: indexInformation([options], callback) + + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the indexInformation method or null if an error occured. + :returns: null + + +**Examples** + + + + An examples showing the information returned by indexInformation + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('more_index_information_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Fetch basic indexInformation for collection + collection.indexInformation(function(err, indexInformation) { + assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); + assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); + + // Fetch full index information + collection.indexInformation({full:true}, function(err, indexInformation) { + assert.deepEqual({ _id: 1 }, indexInformation[0].key); + assert.deepEqual({ a: 1, b: 1 }, indexInformation[1].key); + + db.close(); + }); + }); + }); + }); + }); + }); + + +--------- +dropIndex +--------- + + +Drops an index from this collection. + +.. js:function:: dropIndex(name, callback) + + :param string name: + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the dropIndex method or null if an error occured. + :returns: null + + +**Examples** + + + + An examples showing the creation and dropping of an index + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('create_and_drop_an_index', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Drop the index + collection.dropIndex("a_1_b_1", function(err, result) { + assert.equal(null, err); + + // Verify that the index is gone + collection.indexInformation(function(err, indexInformation) { + assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); + assert.equal(null, indexInformation.a_1_b_1); + + db.close(); + }); + }); + }); + }); + }); + }); + + +-------------- +dropAllIndexes +-------------- + + +Drops all indexes from this collection. + +.. js:function:: dropAllIndexes(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the dropAllIndexes method or null if an error occured. + :returns: null + + +------- +reIndex +------- + + +Reindex all indexes on the collection +Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections. + +.. js:function:: reIndex(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the reIndex method or null if an error occured. + :returns: null + + +**Examples** + + + + An example showing how to force a reindex of a collection. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('shouldCorrectlyForceReindexOnCollection', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Force a reindex of the collection + collection.reIndex(function(err, result) { + assert.equal(null, err); + assert.equal(true, result); + + // Verify that the index is gone + collection.indexInformation(function(err, indexInformation) { + assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); + assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); + + db.close(); + }); + }); + }); + }); + }); + }); + + +--------- +mapReduce +--------- + + +Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection. + + + +Options + - **out** {Object, default:*{inline:1}*}, sets the output target for the map reduce job. *{inline:1} | {replace:'collectionName'} | {merge:'collectionName'} | {reduce:'collectionName'}* + - **query** {Object}, query filter object. + - **sort** {Object}, sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces. + - **limit** {Number}, number of objects to return from collection. + - **keeptemp** {Boolean, default:false}, keep temporary data. + - **finalize** {Function | String}, finalize function. + - **scope** {Object}, can pass in variables that can be access from map/reduce/finalize. + - **jsMode** {Boolean, default:false}, it is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X. + - **verbose** {Boolean, default:false}, provide statistics on job execution time. + - **readPreference** {String, only for inline results}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: mapReduce(map, reduce[, options], callback) + + :param function map: the mapping function. + :param function reduce: the reduce function. + :param objects [options]: options for the map reduce job. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the mapReduce method or null if an error occured. + :returns: null + + +**Examples** + + + + A simple map reduce example + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a test collection + db.createCollection('test_map_reduce_functions', function(err, collection) { + + // Insert some documents to perform map reduce over + collection.insert([{'user_id':1}, {'user_id':2}], {w:1}, function(err, r) { + + // Map function + var map = function() { emit(this.user_id, 1); }; + // Reduce function + var reduce = function(k,vals) { return 1; }; + + // Peform the map reduce + collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}}, function(err, collection) { + // Mapreduce returns the temporary collection with the results + collection.findOne({'_id':1}, function(err, result) { + assert.equal(1, result.value); + + collection.findOne({'_id':2}, function(err, result) { + assert.equal(1, result.value); + + db.close(); + }); + }); + }); + }); + }); + }); + + + + A simple map reduce example using the inline output type on MongoDB > 1.7.6 returning the statistics + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Parse version of server if available + db.admin().serverInfo(function(err, result){ + + // Only run if the MongoDB version is higher than 1.7.6 + if(parseInt((result.version.replace(/\./g, ''))) >= 176) { + + // Create a test collection + db.createCollection('test_map_reduce_functions_inline', function(err, collection) { + + // Insert some test documents + collection.insert([{'user_id':1}, {'user_id':2}], {w:1}, function(err, r) { + + // Map function + var map = function() { emit(this.user_id, 1); }; + // Reduce function + var reduce = function(k,vals) { return 1; }; + + // Execute map reduce and return results inline + collection.mapReduce(map, reduce, {out : {inline: 1}, verbose:true}, function(err, results, stats) { + assert.equal(2, results.length); + assert.ok(stats != null); + + collection.mapReduce(map, reduce, {out : {replace: 'mapreduce_integration_test'}, verbose:true}, function(err, results, stats) { + assert.ok(stats != null); + db.close(); + }); + }); + }); + }); + } else { + test.done(); + } + }); + }); + + + + Mapreduce different test with a provided scope containing a javascript function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a test collection + db.createCollection('test_map_reduce_functions_scope', function(err, collection) { + + // Insert some test documents + collection.insert([{'user_id':1, 'timestamp':new Date()} + , {'user_id':2, 'timestamp':new Date()}], {w:1}, function(err, r) { + + // Map function + var map = function(){ + emit(fn(this.timestamp.getYear()), 1); + } + + // Reduce function + var reduce = function(k, v){ + count = 0; + for(i = 0; i < v.length; i++) { + count += v[i]; + } + return count; + } + + // Javascript function available in the map reduce scope + var t = function(val){ return val+1; } + + // Execute the map reduce with the custom scope + var o = {}; + o.scope = { fn: new Code(t.toString()) } + o.out = { replace: 'replacethiscollection' } + + collection.mapReduce(map, reduce, o, function(err, outCollection) { + assert.equal(null, err); + + // Find all entries in the map-reduce collection + outCollection.find().toArray(function(err, results) { + assert.equal(null, err); + assert.equal(2, results[0].value) + + // mapReduce with scope containing plain function + var o = {}; + o.scope = { fn: t } + o.out = { replace: 'replacethiscollection' } + + collection.mapReduce(map, reduce, o, function(err, outCollection) { + assert.equal(null, err); + + // Find all entries in the map-reduce collection + outCollection.find().toArray(function(err, results) { + assert.equal(2, results[0].value) + db.close(); + }); + }); + }); + }); + }); + }); + }); + + +----- +group +----- + + +Run a group command across a collection + + + +Options + - **readPreference** {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: group(keys, condition, initial, reduce, finalize, command[, options], callback) + + :param object keys: an object, array or function expressing the keys to group by. + :param object condition: an optional condition that must be true for a row to be considered. + :param object initial: initial value of the aggregation counter object. + :param function reduce: the reduce function aggregates (reduces) the objects iterated + :param function finalize: an optional function to be run on each item in the result set just before the item is returned. + :param boolean command: specify if you wish to run using the internal group command or using eval, default is true. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the group method or null if an error occured. + :returns: null + + +**Examples** + + + + A whole lot of different wayt to execute the group command + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a test collection + db.createCollection('test_group', function(err, collection) { + + // Peform a simple group by on an empty collection + collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) { + assert.deepEqual([], results); + + // Trigger some inserts on the collection + collection.insert([{'a':2}, {'b':5}, {'a':1}], {w:1}, function(err, ids) { + + // Perform a group count + collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) { + assert.equal(3, results[0].count); + + // Pefrom a group count using the eval method + collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", false, function(err, results) { + assert.equal(3, results[0].count); + + // Group with a conditional + collection.group([], {'a':{'$gt':1}}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) { + // Results + assert.equal(1, results[0].count); + + // Group with a conditional using the EVAL method + collection.group([], {'a':{'$gt':1}}, {"count":0}, "function (obj, prev) { prev.count++; }" , false, function(err, results) { + // Results + assert.equal(1, results[0].count); + + // Insert some more test data + collection.insert([{'a':2}, {'b':3}], {w:1}, function(err, ids) { + + // Do a Group by field a + collection.group(['a'], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) { + // Results + assert.equal(2, results[0].a); + assert.equal(2, results[0].count); + assert.equal(null, results[1].a); + assert.equal(2, results[1].count); + assert.equal(1, results[2].a); + assert.equal(1, results[2].count); + + // Do a Group by field a + collection.group({'a':true}, {}, {"count":0}, function (obj, prev) { prev.count++; }, true, function(err, results) { + // Results + assert.equal(2, results[0].a); + assert.equal(2, results[0].count); + assert.equal(null, results[1].a); + assert.equal(2, results[1].count); + assert.equal(1, results[2].a); + assert.equal(1, results[2].count); + + // Correctly handle illegal function + collection.group([], {}, {}, "5 ++ 5", function(err, results) { + assert.ok(err.message != null); + + // Use a function to select the keys used to group by + var keyf = function(doc) { return {a: doc.a}; }; + collection.group(keyf, {a: {$gt: 0}}, {"count": 0, "value": 0}, function(obj, prev) { prev.count++; prev.value += obj.a; }, true, function(err, results) { + // Results + results.sort(function(a, b) { return b.count - a.count; }); + assert.equal(2, results[0].count); + assert.equal(2, results[0].a); + assert.equal(4, results[0].value); + assert.equal(1, results[1].count); + assert.equal(1, results[1].a); + assert.equal(1, results[1].value); + + // Use a Code object to select the keys used to group by + var keyf = new Code(function(doc) { return {a: doc.a}; }); + collection.group(keyf, {a: {$gt: 0}}, {"count": 0, "value": 0}, function(obj, prev) { prev.count++; prev.value += obj.a; }, true, function(err, results) { + // Results + results.sort(function(a, b) { return b.count - a.count; }); + assert.equal(2, results[0].count); + assert.equal(2, results[0].a); + assert.equal(4, results[0].value); + assert.equal(1, results[1].count); + assert.equal(1, results[1].a); + assert.equal(1, results[1].value); + + // Correctly handle illegal function when using the EVAL method + collection.group([], {}, {}, "5 ++ 5", false, function(err, results) { + assert.ok(err.message != null); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + + +------- +options +------- + + +Returns the options of the collection. + +.. js:function:: options(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the options method or null if an error occured. + :returns: null + + +**Examples** + + + + An example returning the options for a collection. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a test collection that we are getting the options back from + db.createCollection('test_collection_options', {'capped':true, 'size':1024}, function(err, collection) { + assert.ok(collection instanceof Collection); + assert.equal('test_collection_options', collection.collectionName); + + // Let's fetch the collection options + collection.options(function(err, options) { + assert.equal(true, options.capped); + assert.equal(1024, options.size); + assert.equal("test_collection_options", options.create); + + db.close(); + }); + }); + }); + + +-------- +isCapped +-------- + + +Returns if the collection is a capped collection + +.. js:function:: isCapped(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the isCapped method or null if an error occured. + :returns: null + + +**Examples** + + + + An example showing how to establish if it's a capped collection + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a test collection that we are getting the options back from + db.createCollection('test_collection_is_capped', {'capped':true, 'size':1024}, function(err, collection) { + assert.ok(collection instanceof Collection); + assert.equal('test_collection_is_capped', collection.collectionName); + + // Let's fetch the collection options + collection.isCapped(function(err, capped) { + assert.equal(true, capped); + + db.close(); + }); + }); + }); + + +----------- +indexExists +----------- + + +Checks if one or more indexes exist on the collection + +.. js:function:: indexExists(indexNames, callback) + + :param string indexNames: check if one or more indexes exist on the collection. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the indexExists method or null if an error occured. + :returns: null + + +**Examples** + + + + An example showing the use of the indexExists function for a single index name and a list of index names. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a test collection that we are getting the options back from + db.createCollection('test_collection_index_exists', {w: 1}, function(err, collection) { + assert.equal(null, err); + + // Create an index on the collection + collection.createIndex('a', {w: 1}, function(err, indexName) { + + // Let's test to check if a single index exists + collection.indexExists("a_1", function(err, result) { + assert.equal(true, result); + + // Let's test to check if multiple indexes are available + collection.indexExists(["a_1", "_id_"], function(err, result) { + assert.equal(true, result); + + // Check if a non existing index exists + collection.indexExists("c_1", function(err, result) { + assert.equal(false, result); + + db.close(); + }); + }); + }); + }); + }); + }); + + +------- +geoNear +------- + + +Execute the geoNear command to search for items in the collection + + + +Options + - **num** {Number}, max number of results to return. + - **maxDistance** {Number}, include results up to maxDistance from the point. + - **distanceMultiplier** {Number}, include a value to multiply the distances with allowing for range conversions. + - **query** {Object}, filter the results by a query. + - **spherical** {Boolean, default:false}, perform query using a spherical model. + - **uniqueDocs** {Boolean, default:false}, the closest location in a document to the center of the search region will always be returned MongoDB > 2.X. + - **includeLocs** {Boolean, default:false}, include the location data fields in the top level of the results MongoDB > 2.X. + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: geoNear(x, y[, options], callback) + + :param number x: point to search on the x axis, ensure the indexes are ordered in the same order. + :param number y: point to search on the y axis, ensure the indexes are ordered in the same order. + :param objects [options]: options for the map reduce job. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the geoNear method or null if an error occured. + :returns: null + + +**Examples** + + + + Example of a simple geoNear query across some documents + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = configuration.newDbInstance({w:0}, {poolSize:1}); + + // Establish connection to db + db.open(function(err, db) { + + // Fetch the collection + var collection = db.collection("simple_geo_near_command"); + + // Add a location based index + collection.ensureIndex({loc:"2d"}, function(err, result) { + + // Save a new location tagged document + collection.insert([{a:1, loc:[50, 30]}, {a:1, loc:[30, 50]}], {w:1}, function(err, result) { + + // Use geoNear command to find document + collection.geoNear(50, 50, {query:{a:1}, num:1}, function(err, docs) { + assert.equal(1, docs.results.length); + + db.close(); + }); + }); + }); + }); + + +----------------- +geoHaystackSearch +----------------- + + +Execute a geo search using a geo haystack index on a collection. + + + +Options + - **maxDistance** {Number}, include results up to maxDistance from the point. + - **search** {Object}, filter the results by a query. + - **limit** {Number}, max number of results to return. + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: geoHaystackSearch(x, y[, options], callback) + + :param number x: point to search on the x axis, ensure the indexes are ordered in the same order. + :param number y: point to search on the y axis, ensure the indexes are ordered in the same order. + :param objects [options]: options for the map reduce job. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the geoHaystackSearch method or null if an error occured. + :returns: null + + +**Examples** + + + + Example of a simple geoHaystackSearch query across some documents + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Fetch the collection + var collection = db.collection("simple_geo_haystack_command"); + + // Add a location based index + collection.ensureIndex({loc: "geoHaystack", type: 1}, {bucketSize: 1}, function(err, result) { + + // Save a new location tagged document + collection.insert([{a:1, loc:[50, 30]}, {a:1, loc:[30, 50]}], {w:1}, function(err, result) { + + // Use geoNear command to find document + collection.geoHaystackSearch(50, 50, {search:{a:1}, limit:1, maxDistance:100}, function(err, docs) { + assert.equal(1, docs.results.length); + + db.close(); + }); + }); + }); + }); + + +------- +indexes +------- + + +Retrieve all the indexes on the collection. + +.. js:function:: indexes(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the indexes method or null if an error occured. + :returns: null + + +**Examples** + + + + Example of retrieving a collections indexes + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Crete the collection for the distinct example + db.createCollection('simple_key_based_distinct', function(err, collection) { + + // Create a geo 2d index + collection.ensureIndex({loc:"2d"}, {w: 1}, function(err, result) { + assert.equal(null, err); + + // Create a simple single field index + collection.ensureIndex({a:1}, {w: 1}, function(err, result) { + assert.equal(null, err); + + // List all of the indexes on the collection + collection.indexes(function(err, indexes) { + assert.equal(3, indexes.length); + + db.close(); + }); + }) + }) + }); + }); + + +--------- +aggregate +--------- + + +Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.1 + + + +Options + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: aggregate(array[, options], callback) + + :param array array: containing all the aggregation framework commands for the execution. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the aggregate method or null if an error occured. + :returns: null + + +**Examples** + + + + Correctly call the aggregation framework using a pipeline in an Array. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Some docs for insertion + var docs = [{ + title : "this is my title", author : "bob", posted : new Date() , + pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 }, + comments : [ + { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" } + ]}]; + + // Validate that we are running on at least version 2.1 of MongoDB + db.admin().serverInfo(function(err, result){ + + if(parseInt((result.version.replace(/\./g, ''))) >= 210) { + // Create a collection + var collection = db.collection('shouldCorrectlyExecuteSimpleAggregationPipelineUsingArray'); + // Insert the docs + collection.insert(docs, {w: 1}, function(err, result) { + + // Execute aggregate, notice the pipeline is expressed as an Array + collection.aggregate([ + { $project : { + author : 1, + tags : 1 + }}, + { $unwind : "$tags" }, + { $group : { + _id : {tags : "$tags"}, + authors : { $addToSet : "$author" } + }} + ], function(err, result) { + assert.equal(null, err); + assert.equal('good', result[0]._id.tags); + assert.deepEqual(['bob'], result[0].authors); + assert.equal('fun', result[1]._id.tags); + assert.deepEqual(['bob'], result[1].authors); + + db.close(); + }); + }); + } else { + db.close(); + test.done(); + } + }); + }); + + + + Correctly call the aggregation framework using a pipeline expressed as an argument list. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Some docs for insertion + var docs = [{ + title : "this is my title", author : "bob", posted : new Date() , + pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 }, + comments : [ + { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" } + ]}]; + + // Validate that we are running on at least version 2.1 of MongoDB + db.admin().serverInfo(function(err, result){ + + if(parseInt((result.version.replace(/\./g, ''))) >= 210) { + // Create a collection + var collection = db.collection('shouldCorrectlyExecuteSimpleAggregationPipelineUsingArguments'); + // Insert the docs + collection.insert(docs, {w: 1}, function(err, result) { + // Execute aggregate, notice the pipeline is expressed as function call parameters + // instead of an Array. + collection.aggregate( + { $project : { + author : 1, + tags : 1 + }}, + { $unwind : "$tags" }, + { $group : { + _id : {tags : "$tags"}, + authors : { $addToSet : "$author" } + }} + , function(err, result) { + assert.equal(null, err); + assert.equal('good', result[0]._id.tags); + assert.deepEqual(['bob'], result[0].authors); + assert.equal('fun', result[1]._id.tags); + assert.deepEqual(['bob'], result[1].authors); + + db.close(); + }); + }); + } else { + db.close(); + test.done(); + } + }); + }); + + + + Correctly call the aggregation framework using a pipeline expressed as an argument list. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Some docs for insertion + var docs = [{ + title : "this is my title", author : "bob", posted : new Date() , + pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 }, + comments : [ + { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" } + ]}]; + + // Validate that we are running on at least version 2.1 of MongoDB + db.admin().serverInfo(function(err, result){ + + if(parseInt((result.version.replace(/\./g, ''))) >= 210) { + // Create a collection + var collection = db.collection('shouldCorrectlyExecuteSimpleAggregationPipelineUsingArguments'); + // Insert the docs + collection.insert(docs, {w: 1}, function(err, result) { + // Execute aggregate, notice the pipeline is expressed as function call parameters + // instead of an Array. + collection.aggregate( + { $project : { + author : 1, + tags : 1 + }}, + { $unwind : "$tags" }, + { $group : { + _id : {tags : "$tags"}, + authors : { $addToSet : "$author" } + }} + , function(err, result) { + assert.equal(null, err); + assert.equal('good', result[0]._id.tags); + assert.deepEqual(['bob'], result[0].authors); + assert.equal('fun', result[1]._id.tags); + assert.deepEqual(['bob'], result[1].authors); + + db.close(); + }); + }); + } else { + db.close(); + test.done(); + } + }); + }); + + +----- +stats +----- + + +Get all the collection statistics. + + + +Options + - **scale** {Number}, divide the returned sizes by scale value. + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: stats([options], callback) + + :param objects [options]: options for the stats command. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the stats method or null if an error occured. + :returns: null + + +**Examples** + + + + Example of retrieving a collections stats + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Crete the collection for the distinct example + db.createCollection('collection_stats_test', function(err, collection) { + + // Insert some documents + collection.insert([{a:1}, {hello:'world'}], {w: 1}, function(err, result) { + + // Retrieve the statistics for the collection + collection.stats(function(err, stats) { + assert.equal(2, stats.count); + + db.close(); + }); + }); + }); + }); + diff --git a/_sources/api-generated/cursor.txt b/_sources/api-generated/cursor.txt new file mode 100644 index 00000000000..23aae3db37a --- /dev/null +++ b/_sources/api-generated/cursor.txt @@ -0,0 +1,885 @@ +======== +Cursor() +======== + +------------------ +Constructor +------------------ + + +Constructor for a cursor object that handles all the operations on query result +using find. This cursor object is unidirectional and cannot traverse backwards. Clients should not be creating a cursor directly, +but use find to acquire a cursor. (INTERNAL TYPE) + + + .. js:class:: Cursor() + + :param db db: the database object to work with. + :param collection collection: the collection to query. + :param object selector: the query selector. + :param object fields: an object containing what fields to include or exclude from objects returned. + :param object [options]: additional options for the collection. + + +Options + - **skip** {Number} skip number of documents to skip. + - **limit** {Number}, limit the number of results to return. -1 has a special meaning and is used by Db.eval. A value of 1 will also be treated as if it were -1. + - **sort** {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc. + - **hint** {Object}, hint force the query to use a specific index. + - **explain** {Boolean}, explain return the explaination of the query. + - **snapshot** {Boolean}, snapshot Snapshot mode assures no duplicates are returned. + - **timeout** {Boolean}, timeout allow the query to timeout. + - **tailable** {Boolean}, tailable allow the cursor to be tailable. + - **awaitdata** {Boolean}, awaitdata allow the cursor to wait for data, only applicable for tailable cursor. + - **batchSize** {Number}, batchSize the number of the subset of results to request the database to return for every request. This should initially be greater than 1 otherwise the database will automatically close the cursor. The batch size can be set to 1 with cursorInstance.batchSize after performing the initial query to the database. + - **raw** {Boolean}, raw return all query documents as raw buffers (default false). + - **read** {Boolean}, read specify override of read from source (primary/secondary). + - **slaveOk** {Boolean}, slaveOk, sets the slaveOk flag on the query wire protocol for secondaries. + - **returnKey** {Boolean}, returnKey only return the index key. + - **maxScan** {Number}, maxScan limit the number of items to scan. + - **min** {Number}, min set index bounds. + - **max** {Number}, max set index bounds. + - **showDiskLoc** {Boolean}, showDiskLoc show disk location of results. + - **comment** {String}, comment you can put a $comment field on a query to make looking in the profiler logs simpler. + - **numberOfRetries** {Number}, numberOfRetries if using awaidata specifies the number of times to retry on timeout. + - **dbName** {String}, dbName override the default dbName. + - **tailableRetryInterval** {Number}, tailableRetryInterval specify the miliseconds between getMores on tailable cursor. + - **exhaust** {Boolean}, exhaust have the server send all the documents at once as getMore packets. + - **partial** {Boolean}, partial have the sharded system return a partial result from mongos. + + +------------------ +Constants +------------------ + +.. csv-table:: + :header: "Constant Name", "Value", "Description" + :widths: 15, 10, 30 + + "Cursor.INIT", "0", "Init state" + "Cursor.OPEN", "1", "Cursor open" + "Cursor.CLOSED", "2", "Cursor closed" + "Cursor.GET_MORE", "3", "Cursor performing a get more" + +------ +rewind +------ + + +Resets this cursor to its initial state. All settings like the query string, +tailable, batchSizeValue, skipValue and limits are preserved. + +.. js:function:: rewind() + + :returns: cursor returns itself with rewind applied. + + +**Examples** + + + + An example showing the information returned by indexInformation + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + var docs = []; + + // Insert 100 documents with some data + for(var i = 0; i < 100; i++) { + var d = new Date().getTime() + i*1000; + docs[i] = {'a':i, createdAt:new Date(d)}; + } + + // Create collection + db.createCollection('Should_correctly_rewind_and_restart_cursor', function(err, collection) { + assert.equal(null, err); + + // insert all docs + collection.insert(docs, {w:1}, function(err, result) { + assert.equal(null, err); + + // Grab a cursor using the find + var cursor = collection.find({}); + // Fetch the first object off the cursor + cursor.nextObject(function(err, item) { + assert.equal(0, item.a) + // Rewind the cursor, resetting it to point to the start of the query + cursor.rewind(); + + // Grab the first object again + cursor.nextObject(function(err, item) { + assert.equal(0, item.a) + + db.close(); + }) + }) + }) + }); + }); + + +------- +toArray +------- + + +Returns an array of documents. The caller is responsible for making sure that there +is enough memory to store the results. Note that the array only contain partial +results when this cursor had been previouly accessed. In that case, +cursor.rewind() can be used to reset the cursor. + +.. js:function:: toArray(callback) + + :param function callback: This will be called after executing this method successfully. The first parameter will contain the Error object if an error occured, or null otherwise. The second parameter will contain an array of BSON deserialized objects as a result of the query. + :returns: null + + +**Examples** + + + + An example showing the information returned by indexInformation + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection to hold our documents + db.createCollection('test_array', function(err, collection) { + + // Insert a test document + collection.insert({'b':[1, 2, 3]}, {w:1}, function(err, ids) { + + // Retrieve all the documents in the collection + collection.find().toArray(function(err, documents) { + assert.equal(1, documents.length); + assert.deepEqual([1, 2, 3], documents[0].b); + + db.close(); + }); + }); + }); + }); + + +---- +each +---- + + +Iterates over all the documents for this cursor. As with **{cursor.toArray}**, +not all of the elements will be iterated if this cursor had been previouly accessed. +In that case, **{cursor.rewind}** can be used to reset the cursor. However, unlike +**{cursor.toArray}**, the cursor will only hold a maximum of batch size elements +at any given time if batch size is specified. Otherwise, the caller is responsible +for making sure that the entire result can fit the memory. + +.. js:function:: each(callback) + + :param function callback: this will be called for while iterating every document of the query result. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the document. + :returns: null + + +**Examples** + + + + A simple example iterating over a query using the each function of the cursor. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('test_to_a_after_each', function(err, collection) { + assert.equal(null, err); + + // Insert a document in the collection + collection.insert({'a':1}, {w:1}, function(err, ids) { + + // Grab a cursor + var cursor = collection.find(); + + // Execute the each command, triggers for each document + cursor.each(function(err, item) { + + // If the item is null then the cursor is exhausted/empty and closed + if(item == null) { + + // Show that the cursor is closed + cursor.toArray(function(err, items) { + assert.ok(err != null); + + // Let's close the db + db.close(); + }); + }; + }); + }); + }); + }); + + +----- +count +----- + + +Determines how many result the query for this cursor will return + +.. js:function:: count(applySkipLimit, callback) + + :param boolean applySkipLimit: if set to true will apply the skip and limits set on the cursor. Defaults to false. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the number of results or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example showing the count function of the cursor. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Creat collection + db.createCollection('cursor_count_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some docs + collection.insert([{a:1}, {a:2}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Do a find and get the cursor count + collection.find().count(function(err, count) { + assert.equal(null, err); + assert.equal(2, count); + + db.close(); + }) + }); + }); + }); + + +---- +sort +---- + + +Sets the sort parameter of this cursor to the given value. + +**This method has the following method signatures** + + + +(keyOrList, callback) +(keyOrList, direction, callback) + +.. js:function:: sort(keyOrList, direction, callback) + + :param string keyOrList: This can be a string or an array. If passed as a string, the string will be the field to sort. If passed an array, each element will represent a field to be sorted and should be an array that contains the format [string, direction]. + :param string direction: this determines how the results are sorted. "asc", "ascending" or 1 for asceding order while "desc", "desceding or -1 for descending order. Note that the strings are case insensitive. + :param function callback: this will be called after executing this method. The first parameter will contain an error object when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. + :returns: cursor an instance of this object. + + +**Examples** + + + + A simple example showing the use of sort on the cursor. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('simple_sort_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some documents we can sort on + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Do normal ascending sort + collection.find().sort([['a', 1]]).nextObject(function(err, item) { + assert.equal(null, err); + assert.equal(1, item.a); + + // Do normal descending sort + collection.find().sort([['a', -1]]).nextObject(function(err, item) { + assert.equal(null, err); + assert.equal(3, item.a); + + db.close(); + }); + }); + }); + }); + }); + + +----- +limit +----- + + +Sets the limit parameter of this cursor to the given value. + +.. js:function:: limit(limit[, callback]) + + :param number limit: the new limit. + :param function [callback]: this optional callback will be called after executing this method. The first parameter will contain an error object when the limit given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. + :returns: cursor an instance of this object. + + +**Examples** + + + + A simple example showing the use of limit on the cursor + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('simple_limit_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some documents we can sort on + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Limit to only one document returned + collection.find().limit(1).toArray(function(err, items) { + assert.equal(null, err); + assert.equal(1, items.length); + + db.close(); + }); + }); + }); + }); + + +----------------- +setReadPreference +----------------- + + +Sets the read preference for the cursor + +.. js:function:: setReadPreference(the[, callback]) + + :param string the: read preference for the cursor, one of Server.READ_PRIMARY, Server.READ_SECONDARY, Server.READ_SECONDARY_ONLY + :param function [callback]: this optional callback will be called after executing this method. The first parameter will contain an error object when the read preference given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. + :returns: cursor an instance of this object. + + +---- +skip +---- + + +Sets the skip parameter of this cursor to the given value. + +.. js:function:: skip(skip[, callback]) + + :param number skip: the new skip value. + :param function [callback]: this optional callback will be called after executing this method. The first parameter will contain an error object when the skip value given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. + :returns: cursor an instance of this object. + + +**Examples** + + + + A simple example showing the use of skip on the cursor + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('simple_skip_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some documents we can sort on + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Skip one document + collection.find().skip(1).nextObject(function(err, item) { + assert.equal(null, err); + assert.equal(2, item.a); + + db.close(); + }); + }); + }); + }); + + +--------- +batchSize +--------- + + +Sets the batch size parameter of this cursor to the given value. + +.. js:function:: batchSize(batchSize[, callback]) + + :param number batchSize: the new batch size. + :param function [callback]: this optional callback will be called after executing this method. The first parameter will contain an error object when the batchSize given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. + :returns: cursor an instance of this object. + + +**Examples** + + + + A simple example showing the use of batchSize on the cursor, batchSize only regulates how many + documents are returned for each batch using the getMoreCommand against the MongoDB server + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('simple_batch_size_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some documents we can sort on + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Do normal ascending sort + collection.find().batchSize(1).nextObject(function(err, item) { + assert.equal(null, err); + assert.equal(1, item.a); + + db.close(); + }); + }); + }); + }); + + +---------- +nextObject +---------- + + +Gets the next document from the cursor. + +.. js:function:: nextObject(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain an error object on error while the second parameter will contain a document from the returned result or null if there are no more results. + +**Examples** + + + + A simple example showing the use of nextObject. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('simple_next_object_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some documents we can sort on + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Do normal ascending sort + collection.find().nextObject(function(err, item) { + assert.equal(null, err); + assert.equal(1, item.a); + + db.close(); + }); + }); + }); + }); + + +------- +explain +------- + + +Gets a detailed information about how the query is performed on this cursor and how +long it took the database to process it. + +.. js:function:: explain(callback) + + :param function callback: this will be called after executing this method. The first parameter will always be null while the second parameter will be an object containing the details. + +**Examples** + + + + A simple example showing the use of the cursor explain function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('simple_explain_collection', function(err, collection) { + assert.equal(null, err); + + // Insert some documents we can sort on + collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) { + assert.equal(null, err); + + // Do normal ascending sort + collection.find().explain(function(err, explaination) { + assert.equal(null, err); + + db.close(); + }); + }); + }); + }); + + +------ +stream +------ + + +Returns a Node ReadStream interface for this cursor. + + + +Options + - **transform** {Function} function of type function(object) { return transformed }, allows for transformation of data before emitting. + +.. js:function:: stream() + + :returns: cursorstream returns a stream object. + + +**Examples** + + + + A simple example showing the use of the cursor stream function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a lot of documents to insert + var docs = [] + for(var i = 0; i < 100; i++) { + docs.push({'a':i}) + } + + // Create a collection + db.createCollection('test_stream_function', function(err, collection) { + assert.equal(null, err); + + // Insert documents into collection + collection.insert(docs, {w:1}, function(err, ids) { + // Peform a find to get a cursor + var stream = collection.find().stream(); + + // Execute find on all the documents + stream.on('close', function() { + db.close(); + }); + + stream.on('data', function(data) { + assert.ok(data != null); + }); + }); + }); + }); + + +----- +close +----- + + +Close the cursor. + +.. js:function:: close(callback) + + :param function callback: this will be called after executing this method. The first parameter will always contain null while the second parameter will contain a reference to this cursor. + :returns: null + + +**Examples** + + + + A simple example showing the use of the cursor close function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a lot of documents to insert + var docs = [] + for(var i = 0; i < 100; i++) { + docs.push({'a':i}) + } + + // Create a collection + db.createCollection('test_close_function_on_cursor', function(err, collection) { + assert.equal(null, err); + + // Insert documents into collection + collection.insert(docs, {w:1}, function(err, ids) { + // Peform a find to get a cursor + var cursor = collection.find(); + + // Fetch the first object + cursor.nextObject(function(err, object) { + assert.equal(null, err); + + // Close the cursor, this is the same as reseting the query + cursor.close(function(err, result) { + assert.equal(null, err); + + db.close(); + }); + }); + }); + }); + }); + + +-------- +isClosed +-------- + + +Check if the cursor is closed or open. + +.. js:function:: isClosed() + + :returns: boolean returns the state of the cursor. + + +**Examples** + + + + A simple example showing the use of the cursor close function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a lot of documents to insert + var docs = [] + for(var i = 0; i < 100; i++) { + docs.push({'a':i}) + } + + // Create a collection + db.createCollection('test_is_close_function_on_cursor', function(err, collection) { + assert.equal(null, err); + + // Insert documents into collection + collection.insert(docs, {w:1}, function(err, ids) { + // Peform a find to get a cursor + var cursor = collection.find(); + + // Fetch the first object + cursor.nextObject(function(err, object) { + assert.equal(null, err); + + // Close the cursor, this is the same as reseting the query + cursor.close(function(err, result) { + assert.equal(null, err); + assert.equal(true, cursor.isClosed()); + + db.close(); + }); + }); + }); + }); + }); + diff --git a/_sources/api-generated/cursorstream.txt b/_sources/api-generated/cursorstream.txt new file mode 100644 index 00000000000..11bd4fa42dd --- /dev/null +++ b/_sources/api-generated/cursorstream.txt @@ -0,0 +1,251 @@ +============== +CursorStream() +============== + +------------------ +Constructor +------------------ + + +CursorStream + + + .. js:class:: CursorStream() + + :param cursor cursor: a cursor object that the stream wraps. + :returns: stream + + +Returns a stream interface for the **cursor**. + + + +Options + - **transform** {Function} function of type function(object) { return transformed }, allows for transformation of data before emitting. + + + +Events + - **data** {function(item) {}} the data event triggers when a document is ready. + - **error** {function(err) {}} the error event triggers if an error happens. + - **close** {function() {}} the end event triggers when there is no more documents available. + + +----- +pause +----- + + +Pauses the stream. + +.. js:function:: pause() + + +**Examples** + + + + A simple example showing the use of the cursorstream pause function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a lot of documents to insert + var docs = [] + for(var i = 0; i < 1; i++) { + docs.push({'a':i}) + } + + // Create a collection + db.createCollection('test_cursorstream_pause', function(err, collection) { + assert.equal(null, err); + + // Insert documents into collection + collection.insert(docs, {w:1}, function(err, ids) { + // Peform a find to get a cursor + var stream = collection.find().stream(); + + // For each data item + stream.on("data", function(item) { + // Check if cursor is paused + assert.equal(false, stream.paused); + // Pause stream + stream.pause(); + // Check if cursor is paused + assert.equal(true, stream.paused); + + // Restart the stream after 1 miliscecond + setTimeout(function() { + stream.resume(); + // Check if cursor is paused + process.nextTick(function() { + assert.equal(false, stream.paused); + }) + }, 1); + }); + + // When the stream is done + stream.on("close", function() { + db.close(); + }); + }); + }); + }); + + +------ +resume +------ + + +Resumes the stream. + +.. js:function:: resume() + + +**Examples** + + + + A simple example showing the use of the cursorstream resume function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a lot of documents to insert + var docs = [] + for(var i = 0; i < 1; i++) { + docs.push({'a':i}) + } + + // Create a collection + db.createCollection('test_cursorstream_resume', function(err, collection) { + assert.equal(null, err); + + // Insert documents into collection + collection.insert(docs, {w:1}, function(err, ids) { + // Peform a find to get a cursor + var stream = collection.find().stream(); + + // For each data item + stream.on("data", function(item) { + // Check if cursor is paused + assert.equal(false, stream.paused); + // Pause stream + stream.pause(); + // Check if cursor is paused + assert.equal(true, stream.paused); + + // Restart the stream after 1 miliscecond + setTimeout(function() { + + // Resume the stream + stream.resume(); + + // Check if cursor is paused + process.nextTick(function() { + assert.equal(false, stream.paused); + }); + }, 1); + }); + + // When the stream is done + stream.on("close", function() { + db.close(); + }); + }); + }); + }); + + +------- +destroy +------- + + +Destroys the stream, closing the underlying +cursor. No more events will be emitted. + +.. js:function:: destroy() + + +**Examples** + + + + A simple example showing the use of the cursorstream resume function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a lot of documents to insert + var docs = [] + for(var i = 0; i < 1; i++) { + docs.push({'a':i}) + } + + // Create a collection + db.createCollection('test_cursorstream_destroy', function(err, collection) { + assert.equal(null, err); + + // Insert documents into collection + collection.insert(docs, {w:1}, function(err, ids) { + // Peform a find to get a cursor + var stream = collection.find().stream(); + + // For each data item + stream.on("data", function(item) { + // Destroy stream + stream.destroy(); + }); + + // When the stream is done + stream.on("close", function() { + db.close(); + }); + }); + }); + }); + diff --git a/_sources/api-generated/db.txt b/_sources/api-generated/db.txt new file mode 100644 index 00000000000..af3fd6e0292 --- /dev/null +++ b/_sources/api-generated/db.txt @@ -0,0 +1,2282 @@ +==== +Db() +==== + +------------------ +Constructor +------------------ + + +Create a new Db instance. + + + .. js:class:: Db() + + :param string databaseName: name of the database. + :param object serverConfig: server config object. + :param object [options]: additional options for the collection. + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + - **native_parser** {Boolean, default:false}, use c++ bson parser. + - **forceServerObjectId** {Boolean, default:false}, force server to create _id fields instead of client. + - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. + - **serializeFunctions** {Boolean, default:false}, serialize functions. + - **raw** {Boolean, default:false}, peform operations using raw bson buffers. + - **recordQueryStats** {Boolean, default:false}, record query statistics during execution. + - **retryMiliSeconds** {Number, default:5000}, number of miliseconds between retries. + - **numberOfRetries** {Number, default:5}, number of retries off connection. + - **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**. + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + + +------------------ +Constants +------------------ + +.. csv-table:: + :header: "Constant Name", "Value", "Description" + :widths: 15, 10, 30 + + "Db.DEFAULT_URL", "'mongodb://localhost:27017/default'", "Default URL" + +---- +open +---- + + +Initialize the database connection. + +.. js:function:: open(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the index information or null if an error occured. + :returns: null + + +**Examples** + + + + An example of a simple single server db connection + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + db.close(); + }); + + + + Simple replicaset connection setup, requires a running replicaset on the correct ports + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var replSet = new ReplSetServers([ + new Server('localhost', 30000), + new Server('localhost', 30001), + new Server('localhost', 30002) + ]); + var db = new Db('integration_test_', replSet, {w:0}); + db.open(function(err, p_db) { + assert.equal(null, err); + p_db.close(); + }); + + + + Example of Read Preference usage at the query level. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var replSet = new ReplSetServers([ + new Server('localhost', 30000), + new Server('localhost', 30001), + new Server('localhost', 30002) + ]); + // Create db instance + var db = new Db('integration_test_', replSet, {w:0, native_parser: (process.env['TEST_NATIVE'] != null)}); + // Trigger test once whole set is up + db.on("fullsetup", function() { + // Rip out secondaries forcing an attempt to read from the primary + db.serverConfig._state.secondaries = {}; + + // Grab the collection + db.collection("read_preference_replicaset_test_0", function(err, collection) { + // Attempt to read (should fail due to the server not being a primary); + collection.find().setReadPreference(ReadPreference.SECONDARY).toArray(function(err, items) { + assert.ok(err != null); + assert.equal("No replica set secondary available for query with ReadPreference SECONDARY", err.message); + // Does not get called or we don't care + db.close(); + }); + }); + }); + + // Connect to the db + db.open(function(err, p_db) { + db = p_db; + }); + + + + A Simple example off connecting to Mongos with a list of alternative proxies. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Set up mongos connection + var mongos = new Mongos([ + new Server("localhost", 50000, { auto_reconnect: true }), + new Server("localhost", 50001, { auto_reconnect: true }) + ]) + + // Connect using the mongos connections + var db = new Db('integration_test_', mongos, {w:0}); + db.open(function(err, db) { + assert.equal(null, err); + assert.ok(db != null); + + // Perform a simple insert into a collection + var collection = db.collection("shard_test"); + // Insert a simple doc + collection.insert({test:1}, {w:1}, function(err, result) { + assert.equal(null, err); + + collection.findOne({test:1}, {}, {readPreference:new ReadPreference(ReadPreference.SECONDARY)}, function(err, item) { + assert.equal(null, err); + assert.equal(1, item.test); + + db.close(); + }) + }); + }); + + +-- +db +-- + + +Create a new Db instance sharing the current socket connections. + +.. js:function:: db(dbName) + + :param string dbName: the name of the database we want to use. + :returns: db a db instance using the new database. + + +**Examples** + + + + Simple example connecting to two different databases sharing the socket connections below. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Reference a different database sharing the same connections + // for the data transfer + var secondDb = db.db("integration_tests_2"); + + // Fetch the collections + var multipleColl1 = db.collection("multiple_db_instances"); + var multipleColl2 = secondDb.collection("multiple_db_instances"); + + // Write a record into each and then count the records stored + multipleColl1.insert({a:1}, {w:1}, function(err, result) { + multipleColl2.insert({a:1}, {w:1}, function(err, result) { + + // Count over the results ensuring only on record in each collection + multipleColl1.count(function(err, count) { + assert.equal(1, count); + + multipleColl2.count(function(err, count) { + assert.equal(1, count); + + db.close(); + }); + }); + }); + }); + }); + + +----- +close +----- + + +Close the current db connection, including all the child db instances. Emits close event if no callback is provided. + +.. js:function:: close([forceClose], callback) + + :param boolean [forceClose]: connection can never be reused. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results or null if an error occured. + :returns: null + + +**Examples** + + + + An example that shows how to force close a db connection so it cannot be reused. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Fetch a collection + var collection = db.collection('shouldCorrectlyFailOnRetryDueToAppCloseOfDb'); + + // Insert a document + collection.insert({a:1}, {w:1}, function(err, result) { + assert.equal(null, err); + + // Force close the connection + db.close(true, function(err, result) { + + // Attemp to insert should fail now with correct message 'db closed by application' + collection.insert({a:2}, {w:1}, function(err, result) { + assert.equal('db closed by application', err.message); + }); + }); + }); + }); + + + + An example of a simple single server db connection and close function + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Close the connection with a callback that is optional + db.close(function(err, result) { + assert.equal(null, err); + + }); + }); + + +----- +admin +----- + + +Access the Admin database + +.. js:function:: admin([callback]) + + :param function [callback]: returns the results. + :returns: admin the admin db object. + + +**Examples** + + + + Example showing how to access the Admin database for admin level operations. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + db.open(function(err, db) { + + // Use the admin database for the operation + var adminDb = db.admin() + assert.ok(adminDb != null); + + db.close(); + }); + + +--------------- +collectionsInfo +--------------- + + +Returns a cursor to all the collection information. + +.. js:function:: collectionsInfo([collectionName], callback) + + :param string [collectionName]: the collection name we wish to retrieve the information from. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the options or null if an error occured. + :returns: null + + +**Examples** + + + + An example of retrieveing the information of all the collections. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a collection + db.createCollection('test_collections_info', function(err, r) { + assert.equal(null, err); + + // Return the information of a single collection name + db.collectionsInfo("test_collections_info").toArray(function(err, items) { + assert.equal(1, items.length); + + // Return the information of a all collections, using the callback format + db.collectionsInfo(function(err, cursor) { + + // Turn the cursor into an array of results + cursor.toArray(function(err, items) { + assert.ok(items.length > 0); + + db.close(); + }); + }) + }); + }); + }); + + +--------------- +collectionNames +--------------- + + +Get the list of all collection names for the specified db + + + +Options + - **namesOnly** {String, default:false}, Return only the full collection namespace. + +.. js:function:: collectionNames([collectionName][, options], callback) + + :param string [collectionName]: the collection name we wish to filter by. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the collection names or null if an error occured. + :returns: null + + +**Examples** + + + + An example of retrieveing the collection names for a database. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a collection + db.createCollection('test_collections_info', function(err, r) { + assert.equal(null, err); + + // Return the information of a single collection name + db.collectionNames("test_collections_info", function(err, items) { + assert.equal(1, items.length); + + // Return the information of a all collections, using the callback format + db.collectionNames(function(err, items) { + assert.ok(items.length > 0); + + db.close(); + }); + }); + }); + }); + + +---------- +collection +---------- + + +Fetch a specific collection (containing the actual collection information). If the application does not use strict mode you can +can use it without a callback in the following way. var collection = db.collection('mycollection'); + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. + - **raw** {Boolean, default:false}, perform all operations using raw bson objects. + - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + - **strict**, (Boolean, default:false) throws and error if the collection does not exist + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: collection(collectionName[, options], callback) + + :param string collectionName: the collection name we wish to access. + :param object [options]: returns option results. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the collection or null if an error occured. + :returns: null + + +**Examples** + + + + An example of retrieving a collection from a db using the collection function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Grab a collection without a callback no safe mode + var col1 = db.collection('test_correctly_access_collections'); + + // Grab a collection with a callback but no safe operation + db.collection('test_correctly_access_collections', function(err, col2) { + assert.equal(null, err); + + // Grab a collection with a callback in safe mode, ensuring it exists (should fail as it's not created) + db.collection('test_correctly_access_collections', {strict:true}, function(err, col3) { + assert.ok(err != null); + + // Create the collection + db.createCollection('test_correctly_access_collections', function(err, result) { + + // Retry to get the collection, should work as it's now created + db.collection('test_correctly_access_collections', {strict:true}, function(err, col3) { + assert.equal(null, err); + + db.close(); + }); + }); + }); + }); + }); + + +----------- +collections +----------- + + +Fetch all collections for the current db. + +.. js:function:: collections(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the collections or null if an error occured. + :returns: null + + +**Examples** + + + + An example of retrieving all collections for a db as Collection objects + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create the collection + db.createCollection('test_correctly_access_collections2', function(err, result) { + + // Retry to get the collection, should work as it's now created + db.collections(function(err, collections) { + assert.equal(null, err); + assert.ok(collections.length > 0); + + db.close(); + }); + }); + }); + + +---- +eval +---- + + +Evaluate javascript on the server + + + +Options + - **nolock** {Boolean, default:false}, Tell MongoDB not to block on the evaulation of the javascript. + +.. js:function:: eval(code[, parameters], [options], callback) + + :param code code: javascript to execute on server. + :param object [parameters]: the parameters for the call. + :param object [options]: the options + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from eval or null if an error occured. + :returns: null + + +**Examples** + + + + A whole bunch of examples on how to use eval on the server. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + var numberOfTests = + + // Evaluate a function on the server with the parameter 3 passed in + db.eval('function (x) {return x;}', [3], function(err, result) { + assert.equal(3, result); + }); + + // Evaluate a function on the server with the parameter 3 passed in no lock aquired for eval + // on server + db.eval('function (x) {return x;}', [3], {nolock:true}, function(err, result) { + assert.equal(3, result); + }); + + // Evaluate a function on the server that writes to a server collection + db.eval('function (x) {db.test_eval.save({y:x});}', [5], function(err, result) { + // Locate the entry + db.collection('test_eval', function(err, collection) { + collection.findOne(function(err, item) { + assert.equal(5, item.y); + }); + }); + }); + + // Evaluate a function with 2 parameters passed in + db.eval('function (x, y) {return x + y;}', [2, 3], function(err, result) { + assert.equal(5, result); + }); + + // Evaluate a function with no parameters passed in + db.eval('function () {return 5;}', function(err, result) { + assert.equal(5, result); + }); + + // Evaluate a statement + db.eval('2 + 3;', function(err, result) { + assert.equal(5, result); + }); + + // Evaluate a statement using the code object + db.eval(new Code("2 + 3;"), function(err, result) { + assert.equal(5, result); + }); + + // Evaluate a statement using the code object including a scope + db.eval(new Code("return i;", {'i':2}), function(err, result) { + assert.equal(2, result); + }); + + // Evaluate a statement using the code object including a scope + db.eval(new Code("i + 3;", {'i':2}), function(err, result) { + assert.equal(5, result); + }); + + // Evaluate an illegal statement + db.eval("5 ++ 5;", function(err, result) { + assert.ok(err instanceof Error); + assert.ok(err.message != null); + // Let's close the db + db.close(); + }); + }); + + + + Defining and calling a system level javascript function (NOT recommended, http://www.mongodb.org/display/DOCS/Server-side+Code+Execution) + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Clean out the collection + db.collection("system.js").remove({}, {w:1}, function(err, result) { + assert.equal(null, err); + + // Define a system level function + db.collection("system.js").insert({_id: "echo", value: new Code("function(x) { return x; }")}, {w:1}, function(err, result) { + assert.equal(null, err); + + db.eval("echo(5)", function(err, result) { + assert.equal(null, err); + assert.equal(5, result); + + db.close(); + }); + }); + }); + }); + + +----------- +dereference +----------- + + +Dereference a dbref, against a db + +.. js:function:: dereference(dbRef, callback) + + :param dbref dbRef: db reference object we wish to resolve. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dereference or null if an error occured. + :returns: null + + +**Examples** + + + + An example of dereferencing values. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Get a second db + var secondDb = db.db('integration_tests_2'); + + // Create a dereference example + secondDb.createCollection('test_deref_examples', function(err, collection) { + + // Insert a document in the collection + collection.insert({'a':1}, {w:1}, function(err, ids) { + + // Let's build a db reference and resolve it + var dbRef = new DBRef('test_deref_examples', ids[0]._id, 'integration_tests_2'); + + // Resolve it including a db resolve + db.dereference(dbRef, function(err, item) { + assert.equal(1, item.a); + + // Let's build a db reference and resolve it + var dbRef = new DBRef('test_deref_examples', ids[0]._id); + + // Simple local resolve + secondDb.dereference(dbRef, function(err, item) { + assert.equal(1, item.a); + + db.close(); + }); + }); + }); + }); + }); + + +------ +logout +------ + + +Logout user from server, fire off on all connections and remove all auth info + +.. js:function:: logout(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from logout or null if an error occured. + :returns: null + + +**Examples** + + + + An example of using the logout command for the database. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Add a user to the database + db.addUser('user', 'name', function(err, result) { + assert.equal(null, err); + + // Authenticate + db.authenticate('user', 'name', function(err, result) { + assert.equal(true, result); + + // Logout the db + db.logout(function(err, result) { + assert.equal(true, result); + + db.close(); + }); + }); + }); + }); + + +------------ +authenticate +------------ + + +Authenticate a user against the server. + + + +Options + - **authSource** {String}, The database that the credentials are for, + different from the name of the current DB, for example admin + +.. js:function:: authenticate(username, password[, options], callback) + + :param string username: username. + :param string password: password. + :param object [options]: the options + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from authentication or null if an error occured. + :returns: null + + +**Examples** + + + + An example of using the authenticate command. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Add a user to the database + db.addUser('user', 'name', function(err, result) { + assert.equal(null, err); + + // Authenticate + db.authenticate('user', 'name', function(err, result) { + assert.equal(true, result); + + db.close(); + }); + }); + }); + + +------- +addUser +------- + + +Add a user to the database. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: addUser(username, password[, options], callback) + + :param string username: username. + :param string password: password. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from addUser or null if an error occured. + :returns: null + + +**Examples** + + + + An example of adding a user to the database. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Add a user to the database + db.addUser('user', 'name', function(err, result) { + assert.equal(null, err); + + db.close(); + }); + }); + + +---------- +removeUser +---------- + + +Remove a user from a database + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: removeUser(username[, options], callback) + + :param string username: username. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from removeUser or null if an error occured. + :returns: null + + +**Examples** + + + + An example of dereferencing values. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Add a user to the database + db.addUser('user', 'name', function(err, result) { + assert.equal(null, err); + + // Authenticate + db.authenticate('user', 'name', function(err, result) { + assert.equal(true, result); + + // Logout the db + db.logout(function(err, result) { + assert.equal(true, result); + + // Remove the user from the db + db.removeUser('user', function(err, result) { + + // Authenticate + db.authenticate('user', 'name', function(err, result) { + assert.equal(false, result); + + db.close(); + }); + }); + }); + }); + }); + }); + + +---------------- +createCollection +---------------- + + +Creates a collection on a server pre-allocating space, need to create f.ex capped collections. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. + - **raw** {Boolean, default:false}, perform all operations using raw bson objects. + - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. + - **capped** {Boolean, default:false}, create a capped collection. + - **size** {Number}, the size of the capped collection in bytes. + - **max** {Number}, the maximum number of documents in the capped collection. + - **autoIndexId** {Boolean, default:true}, create an index on the _id field of the document, True by default on MongoDB 2.2 or higher off for version < 2.2. + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + - **strict**, (Boolean, default:false) throws and error if collection already exists + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: createCollection(collectionName[, options], callback) + + :param string collectionName: the collection name we wish to access. + :param object [options]: returns option results. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from createCollection or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example showing the creation of a collection. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a capped collection with a maximum of 1000 documents + db.createCollection("a_simple_collection", {capped:true, size:10000, max:1000, w:1}, function(err, collection) { + assert.equal(null, err); + + // Insert a document in the capped collection + collection.insert({a:1}, {w:1}, function(err, result) { + assert.equal(null, err); + + db.close(); + }); + }); + }); + + +------- +command +------- + + +Execute a command hash against MongoDB. This lets you acess any commands not available through the api on the server. + +.. js:function:: command(selector, callback) + + :param object selector: the command hash to send to the server, ex: {ping:1}. + :param function callback: this will be called after executing this method. The command always return the whole result of the command as the second parameter. + :returns: null + + +**Examples** + + + + A simple example creating, dropping a collection and then verifying that the collection is gone. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Execute ping against the server + db.command({ping:1}, function(err, result) { + assert.equal(null, err); + + db.close(); + }); + }); + + +-------------- +dropCollection +-------------- + + +Drop a collection from the database, removing it permanently. New accesses will create a new collection. + +.. js:function:: dropCollection(collectionName, callback) + + :param string collectionName: the name of the collection we wish to drop. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dropCollection or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example executing a command against the server. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Execute ping against the server + db.command({ping:1}, function(err, result) { + assert.equal(null, err); + + // Create a capped collection with a maximum of 1000 documents + db.createCollection("a_simple_create_drop_collection", {capped:true, size:10000, max:1000, w:1}, function(err, collection) { + assert.equal(null, err); + + // Insert a document in the capped collection + collection.insert({a:1}, {w:1}, function(err, result) { + assert.equal(null, err); + + // Drop the collection from this world + db.dropCollection("a_simple_create_drop_collection", function(err, result) { + assert.equal(null, err); + + // Verify that the collection is gone + db.collectionNames("a_simple_create_drop_collection", function(err, names) { + assert.equal(0, names.length); + + db.close(); + }); + }); + }); + }); + }); + }); + + +---------------- +renameCollection +---------------- + + +Rename a collection. + + + +Options + - **dropTarget** {Boolean, default:false}, drop the target name collection if it previously exists. + +.. js:function:: renameCollection(fromCollection, toCollection[, options], callback) + + :param string fromCollection: the name of the current collection we wish to rename. + :param string toCollection: the new name of the collection. + :param object [options]: returns option results. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from renameCollection or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example creating, dropping a collection and then verifying that the collection is gone. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a collection + db.createCollection("simple_rename_collection", {w:1}, function(err, collection) { + assert.equal(null, err); + + // Insert a document in the collection + collection.insert({a:1}, {w:1}, function(err, result) { + assert.equal(null, err); + + // Rename the collection + db.renameCollection("simple_rename_collection", "simple_rename_collection_2", function(err, collection2) { + assert.equal(null, err); + + // Retrieve the number of documents from the collection + collection2.count(function(err, count) { + assert.equal(1, count); + + // Verify that the collection is gone + db.collectionNames("simple_rename_collection", function(err, names) { + assert.equal(0, names.length); + + // Verify that the new collection exists + db.collectionNames("simple_rename_collection_2", function(err, names) { + assert.equal(1, names.length); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + + +--------- +lastError +--------- + + +Return last error message for the given connection, note options can be combined. + + + +Options + - **fsync** {Boolean, default:false}, option forces the database to fsync all files before returning. + - **j** {Boolean, default:false}, awaits the journal commit before returning, > MongoDB 2.0. + - **w** {Number}, until a write operation has been replicated to N servers. + - **wtimeout** {Number}, number of miliseconds to wait before timing out. + + + +Connection Options + - **connection** {Connection}, fire the getLastError down a specific connection. + +.. js:function:: lastError([options][, connectionOptions], callback) + + :param object [options]: returns option results. + :param object [connectionOptions]: returns option results. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from lastError or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example using lastError on a single connection with a pool of 1. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a collection + db.createCollection("simple_rename_collection3", {w:1}, function(err, collection) { + assert.equal(null, err); + + // Insert a document in the collection + collection.insert({a:1}, function(err, result) { + assert.equal(null, err); + + // Execute lastError + db.lastError(function(err, result) { + assert.equal(null, err); + assert.equal(null, result[0].err); + + // Pick a specific connection and execute lastError against it + var connection = db.serverConfig.checkoutWriter(); + // Execute lastError + db.lastError({}, {connection:connection}, function(err, result) { + assert.equal(null, err); + assert.equal(null, result[0].err); + + db.close(); + }); + }); + }); + }); + }); + + +-------------- +previousErrors +-------------- + + +Return all errors up to the last time db reset_error_history was called. + + + +Options + - **connection** {Connection}, fire the getLastError down a specific connection. + +.. js:function:: previousErrors([options], callback) + + :param object [options]: returns option results. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from previousErrors or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example using previousError to return the list of all errors, might be deprecated in the future. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a collection + db.createCollection("simple_previous_error_coll", {w:1}, function(err, collection) { + assert.equal(null, err); + + // Force a unique index + collection.ensureIndex({a:1}, {unique:true, w:1}, function(err, result) { + assert.equal(null, err); + + // Force some errors + collection.insert([{a:1}, {a:1}, {a:1}, {a:2}], function(err, result) { + + // Pick a specific connection and execute lastError against it + var connection = db.serverConfig.checkoutWriter(); + + // Execute previousErrors + db.previousErrors({connection:connection}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result.length); + assert.ok(result[0].err != null); + + db.close(); + }); + }); + }); + }); + }); + + +----------------- +resetErrorHistory +----------------- + + +Resets the error history of the mongo instance. + + + +Options + - **connection** {Connection}, fire the getLastError down a specific connection. + +.. js:function:: resetErrorHistory([options], callback) + + :param object [options]: returns option results. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from resetErrorHistory or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example using resetErrorHistory to clean up the history of errors. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + // Create a collection + db.createCollection("simple_reset_error_history_coll", {w:1}, function(err, collection) { + assert.equal(null, err); + + // Force a unique index + collection.ensureIndex({a:1}, {unique:true, w:1}, function(err, result) { + assert.equal(null, err); + + // Force some errors + collection.insert([{a:1}, {a:1}, {a:1}, {a:2}], function(err, result) { + // Pick a specific connection and execute lastError against it + var connection = db.serverConfig.checkoutWriter(); + + // Reset the error history + db.resetErrorHistory({connection:connection}, function(err, result) { + + // Execute previousErrors and validate that there are no errors left + db.previousErrors({connection:connection}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result.length); + assert.equal(null, result[0].err); + + db.close(); + }); + }); + }); + }); + }); + }); + + +----------- +createIndex +----------- + + +Creates an index on the collection. + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **unique** {Boolean, default:false}, creates an unique index. + - **sparse** {Boolean, default:false}, creates a sparse index. + - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. + - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value + - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. + - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. + - **v** {Number}, specify the format version of the indexes. + - **expireAfterSeconds** {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher) + - **name** {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes) + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: createIndex(collectionName, fieldOrSpec[, options], callback) + + :param string collectionName: name of the collection to create the index on. + :param object fieldOrSpec: fieldOrSpec that defines the index. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from createIndex or null if an error occured. + :returns: null + + +**Examples** + + + + A more complex createIndex using a compound unique index in the background and dropping duplicated documents + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('more_complex_index_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + db.createIndex('more_complex_index_test', {a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Show that duplicate records got dropped + collection.find({}).toArray(function(err, items) { + assert.equal(null, err); + assert.equal(4, items.length); + + // Peform a query, with explain to show we hit the query + collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { + assert.equal(null, err); + assert.ok(explanation[0].indexBounds.a != null); + assert.ok(explanation[0].indexBounds.b != null); + + db.close(); + }); + }) + }); + }); + }); + }); + + +----------- +ensureIndex +----------- + + +Ensures that an index exists, if it does not it creates it + + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **unique** {Boolean, default:false}, creates an unique index. + - **sparse** {Boolean, default:false}, creates a sparse index. + - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. + - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value + - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. + - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. + - **v** {Number}, specify the format version of the indexes. + - **expireAfterSeconds** {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher) + - **name** {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes) + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + +.. js:function:: ensureIndex(collectionName, fieldOrSpec[, options], callback) + + :param string collectionName: name of the collection to create the index on. + :param object fieldOrSpec: fieldOrSpec that defines the index. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from ensureIndex or null if an error occured. + :returns: null + + +**Examples** + + + + A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('more_complex_ensure_index_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + db.ensureIndex('more_complex_ensure_index_test', {a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Show that duplicate records got dropped + collection.find({}).toArray(function(err, items) { + assert.equal(null, err); + assert.equal(4, items.length); + + // Peform a query, with explain to show we hit the query + collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { + assert.equal(null, err); + assert.ok(explanation[0].indexBounds.a != null); + assert.ok(explanation[0].indexBounds.b != null); + + db.close(); + }); + }) + }); + }); + }); + }); + + +---------- +cursorInfo +---------- + + +Returns the information available on allocated cursors. + + + +Options + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + +.. js:function:: cursorInfo([options], callback) + + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from cursorInfo or null if an error occured. + :returns: null + + +**Examples** + + + + A Simple example of returning current cursor information in MongoDB + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('cursor_information_collection', function(err, collection) { + assert.equal(null, err); + + // Create a bunch of documents so we can force the creation of a cursor + var docs = []; + for(var i = 0; i < 1000; i++) { + docs.push({a:'hello world hello world hello world hello world hello world hello world hello world hello world'}); + } + + // Insert a bunch of documents for the index + collection.insert(docs, {w:1}, function(err, result) { + assert.equal(null, err); + + // Let's set a cursor + var cursor = collection.find({}, {batchSize:10}); + cursor.nextObject(function(err, item) { + assert.equal(null, err); + + // Let's grab the information about the cursors on the database + db.cursorInfo(function(err, cursorInformation) { + assert.ok(cursorInformation.totalOpen > 0); + + db.close(); + }); + }); + }); + }); + }); + + +--------- +dropIndex +--------- + + +Drop an index on a collection. + +.. js:function:: dropIndex(collectionName, indexName, callback) + + :param string collectionName: the name of the collection where the command will drop an index. + :param string indexName: name of the index to drop. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dropIndex or null if an error occured. + :returns: null + + +**Examples** + + + + An examples showing the creation and dropping of an index + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('create_and_drop_an_index', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Drop the index + db.dropIndex("create_and_drop_an_index", "a_1_b_1", function(err, result) { + assert.equal(null, err); + + // Verify that the index is gone + collection.indexInformation(function(err, indexInformation) { + assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); + assert.equal(null, indexInformation.a_1_b_1); + + db.close(); + }); + }); + }); + }); + }); + }); + + +------- +reIndex +------- + + +Reindex all indexes on the collection +Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections. + +.. js:function:: reIndex(collectionName, callback) + + :param string collectionName: the name of the collection. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from reIndex or null if an error occured. + +**Examples** + + + + An example showing how to force a reindex of a collection. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('create_and_drop_all_indexes', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Force a reindex of the collection + db.reIndex('create_and_drop_all_indexes', function(err, result) { + assert.equal(null, err); + assert.equal(true, result); + + // Verify that the index is gone + collection.indexInformation(function(err, indexInformation) { + assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); + assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); + + db.close(); + }); + }); + }); + }); + }); + }); + + +---------------- +indexInformation +---------------- + + +Retrieves this collections index info. + + + +Options + - **full** {Boolean, default:false}, returns the full raw index information. + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: indexInformation(collectionName[, options], callback) + + :param string collectionName: the name of the collection. + :param object [options]: additional options during update. + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from indexInformation or null if an error occured. + :returns: null + + +**Examples** + + + + An example showing the information returned by indexInformation + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection we want to drop later + db.createCollection('more_index_information_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Create an index on the a field + collection.ensureIndex({a:1, b:1} + , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { + + // Fetch basic indexInformation for collection + db.indexInformation('more_index_information_test', function(err, indexInformation) { + assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); + assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); + + // Fetch full index information + collection.indexInformation({full:true}, function(err, indexInformation) { + assert.deepEqual({ _id: 1 }, indexInformation[0].key); + assert.deepEqual({ a: 1, b: 1 }, indexInformation[1].key); + + db.close(); + }); + }); + }); + }); + }); + }); + + +------------ +dropDatabase +------------ + + +Drop a database. + +.. js:function:: dropDatabase(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dropDatabase or null if an error occured. + :returns: null + + +**Examples** + + + + An examples showing the dropping of a database + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Create a collection + db.createCollection('more_index_information_test', function(err, collection) { + assert.equal(null, err); + + // Insert a bunch of documents for the index + collection.insert([{a:1, b:1}, {a:1, b:1} + , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { + assert.equal(null, err); + + // Let's drop the database + db.dropDatabase(function(err, result) { + assert.equal(null, err); + + // Wait to seconds to let it replicate across + setTimeout(function() { + // Get the admin database + db.admin().listDatabases(function(err, dbs) { + // Grab the databases + dbs = dbs.databases; + // Did we find the db + var found = false; + + // Check if we have the db in the list + for(var i = 0; i < dbs.length; i++) { + if(dbs[i].name == 'integration_tests_to_drop') found = true; + } + + // We should not find the databases + if(process.env['JENKINS'] == null) assert.equal(false, found); + + db.close(); + }); + }, 2000); + }); + }); + }); + }); + + +----- +stats +----- + + +Get all the db statistics. + + + +Options + - **scale** {Number}, divide the returned sizes by scale value. + - **readPreference** {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST). + +.. js:function:: stats([options], callback) + + :param objects [options]: options for the stats command + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from stats or null if an error occured. + :returns: null + + +**Examples** + + + + An example showing how to retrieve the db statistics + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + assert.equal(null, err); + + db.stats(function(err, stats) { + assert.equal(null, err); + assert.ok(stats != null); + + db.close(); + }) + }); + + +---------- +Db.connect +---------- + + +Connect to MongoDB using a url as documented at + + + +docs.mongodb.org/manual/reference/connection-string/ + + + +Options + - **uri_decode_auth** {Boolean, default:false} uri decode the user name and password for authentication + - **db** {Object, default: null} a hash off options to set on the db object, see **Db constructor** + - **server** {Object, default: null} a hash off options to set on the server objects, see **Server** constructor** + - **replSet** {Object, default: null} a hash off options to set on the replSet object, see **ReplSet** constructor** + - **mongos** {Object, default: null} a hash off options to set on the mongos object, see **Mongos** constructor** + +.. js:function:: Db.connect(url[, options], callback) + + :param string url: connection url for MongoDB. + :param object [options]: optional options for insert command + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the db instance or null if an error occured. + :returns: null + + +**Examples** + + + + Example of a simple url connection string, with no acknowledgement of writes. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Connect to the server + Db.connect(configuration.url(), function(err, db) { + assert.equal(null, err); + + db.close(); + }); + diff --git a/_sources/api-generated/grid.txt b/_sources/api-generated/grid.txt new file mode 100644 index 00000000000..5ca5956af1d --- /dev/null +++ b/_sources/api-generated/grid.txt @@ -0,0 +1,272 @@ +====== +Grid() +====== + +------------------ +Constructor +------------------ + + +A class representation of a simple Grid interface. + + + .. js:class:: Grid() + + :param db db: A database instance to interact with. + :param string [fsName]: optional different root collection for GridFS. + :returns: grid + + + +--- +put +--- + + +Puts binary data to the grid + + + +Options + - **_id** {Any}, unique id for this file + - **root** {String}, root collection to use. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. + - **content_type** {String}, mime type of the file. Defaults to **{GridStore.DEFAULT_CONTENT_TYPE}**. + - **chunk_size** {Number}, size for the chunk. Defaults to **{Chunk.DEFAULT_CHUNK_SIZE}**. + - **metadata** {Object}, arbitrary data the user wants to store. + +.. js:function:: put(data[, options], callback) + + :param buffer data: buffer with Binary Data. + :param object [options]: the options for the files. + :param function callback: this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the put method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new grid instance + var grid = new Grid(db, 'fs'); + // Some data to write + var originalData = new Buffer('Hello world'); + // Write data to grid + grid.put(originalData, {}, function(err, result) { + // Fetch the content + grid.get(result._id, function(err, data) { + assert.deepEqual(originalData.toString('base64'), data.toString('base64')); + + db.close(); + }); + }); + }); + + + + A simple example showing the usage of the put method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new grid instance + var grid = new Grid(db, 'fs'); + // Some data to write + var originalData = new Buffer('Hello world'); + // Write data to grid + var id = 123; + grid.put(originalData, {_id: id}, function(err, result) { + // Fetch the content + grid.get(id, function(err, data) { + assert.deepEqual(originalData.toString('base64'), data.toString('base64')); + + db.close(); + }); + }); + }); + + + + A simple example showing the usage of the put method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new grid instance + var grid = new Grid(db, 'fs'); + // Some data to write + var originalData = new Buffer('Hello world'); + // Write data to grid + var id = 'test'; + grid.put(originalData, {_id: id}, function(err, result) { + assert.equal(result._id, id); + + // Fetch the content + grid.get(id, function(err, data) { + assert.deepEqual(originalData.toString('base64'), data.toString('base64')); + + db.close(); + }); + }); + }); + + +--- +get +--- + + +Get binary data to the grid + +.. js:function:: get(id, callback) + + :param any id: for file. + :param function callback: this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the get method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new grid instance + var grid = new Grid(db, 'fs'); + // Some data to write + var originalData = new Buffer('Hello world'); + // Write data to grid + grid.put(originalData, {}, function(err, result) { + // Fetch the content + grid.get(result._id, function(err, data) { + assert.deepEqual(originalData.toString('base64'), data.toString('base64')); + + // Should fail due to illegal objectID + grid.get('not an id', function(err, result) { + assert.ok(err != null); + + db.close(); + }); + }); + }); + }); + + +------ +delete +------ + + +Delete file from grid + +.. js:function:: delete(id, callback) + + :param any id: for file. + :param function callback: this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the delete method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new grid instance + var grid = new Grid(db, 'fs'); + // Some data to write + var originalData = new Buffer('Hello world'); + // Write data to grid + grid.put(originalData, {}, function(err, result) { + + // Delete file + grid.delete(result._id, function(err, result2) { + assert.equal(null, err); + assert.equal(true, result2); + + // Fetch the content, showing that the file is gone + grid.get(result._id, function(err, data) { + assert.ok(err != null); + assert.equal(null, data); + + db.close(); + }); + }); + }); + }); + diff --git a/_sources/api-generated/gridstore.txt b/_sources/api-generated/gridstore.txt new file mode 100644 index 00000000000..bd10620e5dc --- /dev/null +++ b/_sources/api-generated/gridstore.txt @@ -0,0 +1,1883 @@ +=========== +GridStore() +=========== + +------------------ +Constructor +------------------ + + +A class representation of a file stored in GridFS. + + + .. js:class:: GridStore() + + :param db db: A database instance to interact with. + :param any [id]: optional unique id for this file + :param string [filename]: optional filename for this file, no unique constrain on the field + :param string mode: set the mode for this file. + :param object options: optional properties to specify. + :returns: gridstore + + +Modes + - **"r"** - read only. This is the default mode. + - **"w"** - write in truncate mode. Existing data will be overwriten. + - **w+"** - write in edit mode. + + + +Options + - **root** {String}, root collection to use. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. + - **content_type** {String}, mime type of the file. Defaults to **{GridStore.DEFAULT_CONTENT_TYPE}**. + - **chunk_size** {Number}, size for the chunk. Defaults to **{Chunk.DEFAULT_CHUNK_SIZE}**. + - **metadata** {Object}, arbitrary data the user wants to store. + + +------------------ +Constants +------------------ + +.. csv-table:: + :header: "Constant Name", "Value", "Description" + :widths: 15, 10, 30 + + "GridStore.DEFAULT_ROOT_COLLECTION", "'fs'", "The collection to be used for holding the files and chunks collection." + "GridStore.DEFAULT_CONTENT_TYPE", "'binary/octet-stream'", "Default file mime type" + "GridStore.IO_SEEK_SET", "0", "Seek mode where the given length is absolute." + "GridStore.IO_SEEK_CUR", "1", "Seek mode where the given length is an offset to the current read/write head." + "GridStore.IO_SEEK_END", "2", "Seek mode where the given length is an offset to the end of the file." + +------------------ +Properties +------------------ + + +Returns the current chunksize of the file. + +.. js:attribute:: chunkSize number [Getter|Setter] + + + +The md5 checksum for this file. + +.. js:attribute:: md5 number [Getter|Setter] + + +---- +open +---- + + +Opens the file from the database and initialize this object. Also creates a +new one if file does not exist. + +.. js:function:: open(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain an **{Error}** object and the second parameter will be null if an error occured. Otherwise, the first parameter will be null and the second will contain the reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing how to save a file with a filename allowing for multiple files with the same name + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a file and open it + var gridStore = new GridStore(db, new ObjectID(), "test_gs_getc_file", "w"); + gridStore.open(function(err, gridStore) { + // Write some content to the file + gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) { + // Flush the file to GridFS + gridStore.close(function(err, fileData) { + assert.equal(null, err); + + // Create another file with same name and and save content to it + gridStore = new GridStore(db, new ObjectID(), "test_gs_getc_file", "w"); + gridStore.open(function(err, gridStore) { + // Write some content to the file + gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) { + // Flush the file to GridFS + gridStore.close(function(err, fileData) { + assert.equal(null, err); + + // Open the file in read mode using the filename + var gridStore2 = new GridStore(db, "test_gs_getc_file", "r"); + gridStore2.open(function(err, gridStore) { + + // Read first character and verify + gridStore.getc(function(err, chr) { + assert.equal('h', chr); + + // Open the file using an object id + gridStore2 = new GridStore(db, fileData._id, "r"); + gridStore2.open(function(err, gridStore) { + + // Read first character and verify + gridStore.getc(function(err, chr) { + assert.equal('h', chr); + + db.close(); + }) + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + + + + A simple example showing opening a file using a filename, writing to it and saving it. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new instance of the gridstore + var gridStore = new GridStore(db, 'ourexamplefiletowrite.txt', 'w'); + + // Open the file + gridStore.open(function(err, gridStore) { + + // Write some data to the file + gridStore.write('bar', function(err, gridStore) { + assert.equal(null, err); + + // Close (Flushes the data to MongoDB) + gridStore.close(function(err, result) { + assert.equal(null, err); + + // Verify that the file exists + GridStore.exist(db, 'ourexamplefiletowrite.txt', function(err, result) { + assert.equal(null, err); + assert.equal(true, result); + + db.close(); + }); + }); + }); + }); + }); + + + + A simple example showing opening a file using an ObjectID, writing to it and saving it. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Create a new instance of the gridstore + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the file + gridStore.open(function(err, gridStore) { + + // Write some data to the file + gridStore.write('bar', function(err, gridStore) { + assert.equal(null, err); + + // Close (Flushes the data to MongoDB) + gridStore.close(function(err, result) { + assert.equal(null, err); + + // Verify that the file exists + GridStore.exist(db, fileId, function(err, result) { + assert.equal(null, err); + assert.equal(true, result); + + db.close(); + }); + }); + }); + }); + }); + + +--------- +writeFile +--------- + + +Stores a file from the file system to the GridFS database. + +.. js:function:: writeFile(file, callback) + + :param string file: the file to store. + :param function callback: this will be called after this method is executed. The first parameter will be null and the the second will contain the reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing how to write a file to Gridstore using file location path. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Read the filesize of file on disk (provide your own) + var fileSize = fs.statSync('./test/tests/functional/gridstore/test_gs_weird_bug.png').size; + // Read the buffered data for comparision reasons + var data = fs.readFileSync('./test/tests/functional/gridstore/test_gs_weird_bug.png'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write the file to gridFS + gridStore.writeFile('./test/tests/functional/gridstore/test_gs_weird_bug.png', function(err, doc) { + + // Read back all the written content and verify the correctness + GridStore.read(db, fileId, function(err, fileData) { + assert.equal(data.toString('base64'), fileData.toString('base64')) + assert.equal(fileSize, fileData.length); + + db.close(); + }); + }); + }); + }); + + + + A simple example showing how to write a file to Gridstore using a file handle. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Read the filesize of file on disk (provide your own) + var fileSize = fs.statSync('./test/tests/functional/gridstore/test_gs_weird_bug.png').size; + // Read the buffered data for comparision reasons + var data = fs.readFileSync('./test/tests/functional/gridstore/test_gs_weird_bug.png'); + + // Open a file handle for reading the file + var fd = fs.openSync('./test/tests/functional/gridstore/test_gs_weird_bug.png', 'r', 0666); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write the file to gridFS using the file handle + gridStore.writeFile(fd, function(err, doc) { + + // Read back all the written content and verify the correctness + GridStore.read(db, fileId, function(err, fileData) { + assert.equal(data.toString('base64'), fileData.toString('base64')); + assert.equal(fileSize, fileData.length); + + db.close(); + }); + }); + }); + }); + + +----- +close +----- + + +Saves this file to the database. This will overwrite the old entry if it +already exists. This will work properly only if mode was initialized to +"w" or "w+". + +.. js:function:: close(callback) + + :param function callback: this will be called after executing this method. Passes an **{Error}** object to the first parameter and null to the second if an error occured. Otherwise, passes null to the first and a reference to this object to the second. + :returns: null + + +**Examples** + + + + A simple example showing how to use the write command with strings and Buffers. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write a text string + gridStore.write('Hello world', function(err, gridStore) { + + // Close the + gridStore.close(function(err, result) { + assert.equal(err, null); + + db.close(); + }); + }); + }); + }); + + +--------------- +chunkCollection +--------------- + + +Retrieve this file's chunks collection. + +.. js:function:: chunkCollection(callback) + + :param function callback: this will be called after executing this method. An exception object will be passed to the first parameter when an error occured or null otherwise. A new **{Collection}** object will be passed to the second parameter if no error occured. + :returns: null + + +**Examples** + + + + A simple example showing how to access the chunks collection object. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Access the Chunk collection + gridStore.chunkCollection(function(err, collection) { + assert.equal(err, null); + + db.close(); + }); + }); + }); + + +------ +unlink +------ + + +Deletes all the chunks of this file in the database. + +.. js:function:: unlink(callback) + + :param function callback: this will be called after this method executes. Passes null to the first and true to the second argument. + :returns: null + + +**Examples** + + + + A simple example showing how to use the instance level unlink command to delete a gridstore item. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write a text string + gridStore.write('Hello world', function(err, gridStore) { + + // Close the + gridStore.close(function(err, result) { + assert.equal(err, null); + + // Open the file again and unlin it + new GridStore(db, fileId, 'r').open(function(err, gridStore) { + + // Unlink the file + gridStore.unlink(function(err, result) { + assert.equal(null, err); + + // Verify that the file no longer exists + GridStore.exist(db, fileId, function(err, result) { + assert.equal(null, err); + assert.equal(false, result); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + + +---------- +collection +---------- + + +Retrieves the file collection associated with this object. + +.. js:function:: collection(callback) + + :param function callback: this will be called after executing this method. An exception object will be passed to the first parameter when an error occured or null otherwise. A new **{Collection}** object will be passed to the second parameter if no error occured. + :returns: null + + +**Examples** + + + + A simple example showing how to access the files collection object. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Access the Chunk collection + gridStore.collection(function(err, collection) { + assert.equal(err, null); + + db.close(); + }); + }); + }); + + +--------- +readlines +--------- + + +Reads the data of this file. + +.. js:function:: readlines([separator], callback) + + :param string [separator]: the character to be recognized as the newline separator. + :param function callback: This will be called after this method is executed. The first parameter will be null and the second parameter will contain an array of strings representing the entire data, each element representing a line including the separator character. + :returns: null + + +**Examples** + + + + A simple example showing reading back using readlines to split the text into lines by the seperator provided. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write one line to gridStore + gridStore.puts("line one", function(err, gridStore) { + + // Write second line to gridStore + gridStore.puts("line two", function(err, gridStore) { + + // Write third line to gridStore + gridStore.puts("line three", function(err, gridStore) { + + // Flush file to disk + gridStore.close(function(err, result) { + + // Open file for reading + gridStore = new GridStore(db, fileId, 'r'); + gridStore.open(function(err, gridStore) { + + // Read all the lines and verify correctness + gridStore.readlines(function(err, lines) { + assert.deepEqual(["line one\n", "line two\n", "line three\n"], lines); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + }); + + +------ +rewind +------ + + +Deletes all the chunks of this file in the database if mode was set to "w" or +"w+" and resets the read/write head to the initial position. + +.. js:function:: rewind(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing how to rewind and overwrite the file. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Create a new file + var gridStore = new GridStore(db, fileId, "w"); + // Open the file + gridStore.open(function(err, gridStore) { + // Write to the file + gridStore.write("hello, world!", function(err, gridStore) { + // Flush the file to disk + gridStore.close(function(err, result) { + + // Reopen the file + gridStore = new GridStore(db, fileId, "w"); + gridStore.open(function(err, gridStore) { + // Write some more text to the file + gridStore.write('some text is inserted here', function(err, gridStore) { + + // Let's rewind to truncate the file + gridStore.rewind(function(err, gridStore) { + + // Write something from the start + gridStore.write('abc', function(err, gridStore) { + + // Flush the data to mongodb + gridStore.close(function(err, result) { + + // Verify that the new data was written + GridStore.read(db, fileId, function(err, data) { + assert.equal("abc", data); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + + +---- +read +---- + + +Retrieves the contents of this file and advances the read/write head. Works with Buffers only. + +**There are 3 signatures for this method** + + + +(callback) +(length, callback) +(length, buffer, callback) + +.. js:function:: read([length][, buffer], callback) + + :param number [length]: the number of characters to read. Reads all the characters from the read/write head to the EOF if not specified. + :param string [buffer]: a string to hold temporary data. This is used for storing the string data read so far when recursively calling this method. + :param function callback: this will be called after this method is executed. null will be passed to the first parameter and a string containing the contents of the buffer concatenated with the contents read from this file will be passed to the second. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the read method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Read in the content of a file + var data = fs.readFileSync('./test/tests/functional/gridstore/iya_logo_final_bw.jpg'); + // Create a new file + var gs = new GridStore(db, "test", "w"); + // Open the file + gs.open(function(err, gs) { + // Write the file to GridFS + gs.write(data, function(err, gs) { + // Flush to the GridFS + gs.close(function(err, gs) { + + // Define the file we wish to read + var gs2 = new GridStore(db, "test", "r"); + // Open the file + gs2.open(function(err, gs) { + // Set the pointer of the read head to the start of the gridstored file + gs2.seek(0, function() { + // Read the entire file + gs2.read(function(err, data2) { + // Compare the file content against the orgiinal + assert.equal(data.toString('base64'), data2.toString('base64')); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + + +---- +tell +---- + + +Retrieves the position of the read/write head of this file. + +.. js:function:: tell(callback) + + :param function callback: This gets called after this method terminates. null is passed to the first parameter and the position is passed to the second. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the tell method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new file + var gridStore = new GridStore(db, "test_gs_tell", "w"); + // Open the file + gridStore.open(function(err, gridStore) { + // Write a string to the file + gridStore.write("hello, world!", function(err, gridStore) { + // Flush the file to GridFS + gridStore.close(function(err, result) { + + // Open the file in read only mode + var gridStore2 = new GridStore(db, "test_gs_tell", "r"); + gridStore2.open(function(err, gridStore) { + + // Read the first 5 characters + gridStore.read(5, function(err, data) { + assert.equal("hello", data); + + // Get the current position of the read head + gridStore.tell(function(err, position) { + assert.equal(5, position); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + + +---- +seek +---- + + +Moves the read/write head to a new location. + + + +There are 3 signatures for this method + + + +Seek Location Modes + - **GridStore.IO_SEEK_SET**, **(default)** set the position from the start of the file. + - **GridStore.IO_SEEK_CUR**, set the position from the current position in the file. + - **GridStore.IO_SEEK_END**, set the position from the end of the file. + +.. js:function:: seek([position][, seekLocation], callback) + + :param number [position]: the position to seek to + :param number [seekLocation]: seek mode. Use one of the Seek Location modes. + :param function callback: this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the seek method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a file and open it + var gridStore = new GridStore(db, "test_gs_seek_with_buffer", "w"); + gridStore.open(function(err, gridStore) { + // Write some content to the file + gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) { + // Flush the file to GridFS + gridStore.close(function(result) { + + // Open the file in read mode + var gridStore2 = new GridStore(db, "test_gs_seek_with_buffer", "r"); + gridStore2.open(function(err, gridStore) { + // Seek to start + gridStore.seek(0, function(err, gridStore) { + // Read first character and verify + gridStore.getc(function(err, chr) { + assert.equal('h', chr); + }); + }); + }); + + // Open the file in read mode + var gridStore3 = new GridStore(db, "test_gs_seek_with_buffer", "r"); + gridStore3.open(function(err, gridStore) { + // Seek to 7 characters from the beginning off the file and verify + gridStore.seek(7, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('w', chr); + }); + }); + }); + + // Open the file in read mode + var gridStore5 = new GridStore(db, "test_gs_seek_with_buffer", "r"); + gridStore5.open(function(err, gridStore) { + // Seek to -1 characters from the end off the file and verify + gridStore.seek(-1, GridStore.IO_SEEK_END, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('!', chr); + }); + }); + }); + + // Open the file in read mode + var gridStore6 = new GridStore(db, "test_gs_seek_with_buffer", "r"); + gridStore6.open(function(err, gridStore) { + // Seek to -6 characters from the end off the file and verify + gridStore.seek(-6, GridStore.IO_SEEK_END, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('w', chr); + }); + }); + }); + + // Open the file in read mode + var gridStore7 = new GridStore(db, "test_gs_seek_with_buffer", "r"); + gridStore7.open(function(err, gridStore) { + + // Seek forward 7 characters from the current read position and verify + gridStore.seek(7, GridStore.IO_SEEK_CUR, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('w', chr); + + // Seek forward -1 characters from the current read position and verify + gridStore.seek(-1, GridStore.IO_SEEK_CUR, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('w', chr); + + // Seek forward -4 characters from the current read position and verify + gridStore.seek(-4, GridStore.IO_SEEK_CUR, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('o', chr); + + // Seek forward 3 characters from the current read position and verify + gridStore.seek(3, GridStore.IO_SEEK_CUR, function(err, gridStore) { + gridStore.getc(function(err, chr) { + assert.equal('o', chr); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + }); + + +--- +eof +--- + + +Verify if the file is at EOF. + +.. js:function:: eof() + + :returns: boolean true if the read/write head is at the end of this file. + + +**Examples** + + + + A simple example showing the usage of the eof method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Open the file in write mode + var gridStore = new GridStore(db, 'test_gs_empty_file_eof', "w"); + gridStore.open(function(err, gridStore) { + // Flush the empty file to GridFS + gridStore.close(function(err, gridStore) { + + // Open the file in read mode + var gridStore2 = new GridStore(db, 'test_gs_empty_file_eof', "r"); + gridStore2.open(function(err, gridStore) { + // Verify that we are at the end of the file + assert.equal(true, gridStore.eof()); + + db.close(); + }) + }); + }); + }); + + +---- +getc +---- + + +Retrieves a single character from this file. + +.. js:function:: getc(callback) + + :param function callback: this gets called after this method is executed. Passes null to the first parameter and the character read to the second or null to the second if the read/write head is at the end of the file. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the seek method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a file and open it + var gridStore = new GridStore(db, "test_gs_getc_file", "w"); + gridStore.open(function(err, gridStore) { + // Write some content to the file + gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) { + // Flush the file to GridFS + gridStore.close(function(result) { + + // Open the file in read mode + var gridStore2 = new GridStore(db, "test_gs_getc_file", "r"); + gridStore2.open(function(err, gridStore) { + + // Read first character and verify + gridStore.getc(function(err, chr) { + assert.equal('h', chr); + + db.close(); + }); + }); + }); + }); + }); + }); + + +---- +puts +---- + + +Writes a string to the file with a newline character appended at the end if +the given string does not have one. + +.. js:function:: puts(string, callback) + + :param string string: the string to write. + :param function callback: this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the puts method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Open a file for writing + var gridStore = new GridStore(db, "test_gs_puts_and_readlines", "w"); + gridStore.open(function(err, gridStore) { + + // Write a line to the file using the puts method + gridStore.puts("line one", function(err, gridStore) { + + // Flush the file to GridFS + gridStore.close(function(err, result) { + + // Read in the entire contents + GridStore.read(db, 'test_gs_puts_and_readlines', function(err, data) { + assert.equal("line one\n", data.toString()); + + db.close(); + }); + }); + }); + }); + }); + + +------ +stream +------ + + +Returns read stream based on this GridStore file + + + +Events + - **data** {function(item) {}} the data event triggers when a document is ready. + - **end** {function() {}} the end event triggers when there is no more documents available. + - **close** {function() {}} the close event triggers when the stream is closed. + - **error** {function(err) {}} the error event triggers if an error happens. + +.. js:function:: stream(autoclose) + + :param boolean autoclose: if true current GridStore will be closed when EOF and 'close' event will be fired + :returns: null + + +**Examples** + + + + A simple example showing the usage of the stream method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Open a file for reading + var gridStoreR = new GridStore(db, "test_gs_read_stream", "r"); + // Open a file for writing + var gridStoreW = new GridStore(db, "test_gs_read_stream", "w"); + // Read in the data of a file + var data = fs.readFileSync("./test/tests/functional/gridstore/test_gs_weird_bug.png"); + + var readLen = 0; + var gotEnd = 0; + + // Open the file we are writting to + gridStoreW.open(function(err, gs) { + // Write the file content + gs.write(data, function(err, gs) { + // Flush the file to GridFS + gs.close(function(err, result) { + + // Open the read file + gridStoreR.open(function(err, gs) { + + // Create a stream to the file + var stream = gs.stream(true); + + // Register events + stream.on("data", function(chunk) { + // Record the length of the file + readLen += chunk.length; + }); + + stream.on("end", function() { + // Record the end was called + ++gotEnd; + }); + + stream.on("close", function() { + // Verify the correctness of the read data + assert.equal(data.length, readLen); + assert.equal(1, gotEnd); + + db.close(); + }); + }); + }); + }); + }); + }); + + + + A simple example showing how to pipe a file stream through from gridfs to a file + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Open a file for writing + var gridStoreWrite = new GridStore(db, "test_gs_read_stream_pipe", "w", {chunkSize:1024}); + gridStoreWrite.writeFile("./test/tests/functional/gridstore/test_gs_weird_bug.png", function(err, result) { + // Open the gridStore for reading and pipe to a file + var gridStore = new GridStore(db, "test_gs_read_stream_pipe", "r"); + gridStore.open(function(err, gridStore) { + // Grab the read stream + var stream = gridStore.stream(true); + // When the stream is finished close the database + stream.on("end", function(err) { + // Read the original content + var originalData = fs.readFileSync("./test/tests/functional/gridstore/test_gs_weird_bug.png"); + // Ensure we are doing writing before attempting to open the file + fs.readFile("./test_gs_weird_bug_streamed.tmp", function(err, streamedData) { + // Compare the data + assert.deepEqual(originalData, streamedData); + + // Close the database + db.close(); + }); + }) + + // Create a file write stream + var fileStream = fs.createWriteStream("./test_gs_weird_bug_streamed.tmp"); + // Pipe out the data + stream.pipe(fileStream); + }) + }) + }); + + +--------------- +GridStore.exist +--------------- + + +Checks if a file exists in the database. + +.. js:function:: GridStore.exist(db, name[, rootCollection], callback) + + :param db db: the database to query. + :param string name: the name of the file to look for. + :param string [rootCollection]: the root collection that holds the files and chunks collection. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. + :param function callback: this will be called after this method executes. Passes null to the first and passes true to the second if the file exists and false otherwise. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the Gridstore.exist method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Open a file for writing + var gridStore = new GridStore(db, null, "w"); + gridStore.open(function(err, gridStore) { + assert.equal(null, err); + + // Writing some content to the file + gridStore.write("hello world!", function(err, gridStore) { + assert.equal(null, err); + + // Flush the file to GridFS + gridStore.close(function(err, result) { + assert.equal(null, err); + + // Check if the file exists using the id returned from the close function + GridStore.exist(db, result._id, function(err, result) { + assert.equal(null, err); + assert.equal(true, result); + }) + + // Show that the file does not exist for a random ObjectID + GridStore.exist(db, new ObjectID(), function(err, result) { + assert.equal(null, err); + assert.equal(false, result); + }); + + // Show that the file does not exist for a different file root + GridStore.exist(db, result._id, 'another_root', function(err, result) { + assert.equal(null, err); + assert.equal(false, result); + + db.close(); + }); + }); + }); + }); + }); + + +-------------- +GridStore.list +-------------- + + +Gets the list of files stored in the GridFS. + +.. js:function:: GridStore.list(db[, rootCollection], callback) + + :param db db: the database to query. + :param string [rootCollection]: the root collection that holds the files and chunks collection. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. + :param function callback: this will be called after this method executes. Passes null to the first and passes an array of strings containing the names of the files. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the eof method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file id + var fileId = new ObjectID(); + + // Open a file for writing + var gridStore = new GridStore(db, fileId, "foobar2", "w"); + gridStore.open(function(err, gridStore) { + + // Write some content to the file + gridStore.write("hello world!", function(err, gridStore) { + // Flush to GridFS + gridStore.close(function(err, result) { + + // List the existing files + GridStore.list(db, function(err, items) { + var found = false; + items.forEach(function(filename) { + if(filename == 'foobar2') found = true; + }); + + assert.ok(items.length >= 1); + assert.ok(found); + }); + + // List the existing files but return only the file ids + GridStore.list(db, {id:true}, function(err, items) { + var found = false; + items.forEach(function(id) { + assert.ok(typeof id == 'object'); + }); + + assert.ok(items.length >= 1); + }); + + // List the existing files in a specific root collection + GridStore.list(db, 'fs', function(err, items) { + var found = false; + items.forEach(function(filename) { + if(filename == 'foobar2') found = true; + }); + + assert.ok(items.length >= 1); + assert.ok(found); + }); + + // List the existing files in a different root collection where the file is not located + GridStore.list(db, 'my_fs', function(err, items) { + var found = false; + items.forEach(function(filename) { + if(filename == 'foobar2') found = true; + }); + + assert.ok(items.length >= 0); + assert.ok(!found); + + // Specify seperate id + var fileId2 = new ObjectID(); + // Write another file to GridFS + var gridStore2 = new GridStore(db, fileId2, "foobar3", "w"); + gridStore2.open(function(err, gridStore) { + // Write the content + gridStore2.write('my file', function(err, gridStore) { + // Flush to GridFS + gridStore.close(function(err, result) { + + // List all the available files and verify that our files are there + GridStore.list(db, function(err, items) { + var found = false; + var found2 = false; + + items.forEach(function(filename) { + if(filename == 'foobar2') found = true; + if(filename == 'foobar3') found2 = true; + }); + + assert.ok(items.length >= 2); + assert.ok(found); + assert.ok(found2); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + }); + }); + + +-------------- +GridStore.read +-------------- + + +Reads the contents of a file. + + + +This method has the following signatures + + + +(db, name, callback) +(db, name, length, callback) +(db, name, length, offset, callback) +(db, name, length, offset, options, callback) + +.. js:function:: GridStore.read(db, name[, length], [offset], [options], callback) + + :param db db: the database to query. + :param string name: the name of the file. + :param number [length]: the size of data to read. + :param number [offset]: the offset from the head of the file of which to start reading from. + :param object [options]: the options for the file. + :param function callback: this will be called after this method executes. A string with an error message will be passed to the first parameter when the length and offset combination exceeds the length of the file while an Error object will be passed if other forms of error occured, otherwise, a string is passed. The second parameter will contain the data read if successful or null if an error occured. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the read method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Create a new file + var gridStore = new GridStore(db, null, "w"); + // Read in the content from a file, replace with your own + var data = fs.readFileSync("./test/tests/functional/gridstore/test_gs_weird_bug.png"); + + // Open the file + gridStore.open(function(err, gridStore) { + // Write the binary file data to GridFS + gridStore.write(data, function(err, gridStore) { + // Flush the remaining data to GridFS + gridStore.close(function(err, result) { + + // Read in the whole file and check that it's the same content + GridStore.read(db, result._id, function(err, fileData) { + assert.equal(data.length, fileData.length); + + db.close(); + }); + }); + }); + }); + }); + + +------------------- +GridStore.readlines +------------------- + + +Reads the data of this file. + +.. js:function:: GridStore.readlines(db, name[, separator], [options], callback) + + :param db db: the database to query. + :param string name: the name of the file. + :param string [separator]: the character to be recognized as the newline separator. + :param object [options]: file options. + :param function callback: this will be called after this method is executed. The first parameter will be null and the second parameter will contain an array of strings representing the entire data, each element representing a line including the separator character. + :returns: null + + +**Examples** + + + + A simple example showing reading back using readlines to split the text into lines by the seperator provided. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write one line to gridStore + gridStore.puts("line one", function(err, gridStore) { + + // Write second line to gridStore + gridStore.puts("line two", function(err, gridStore) { + + // Write third line to gridStore + gridStore.puts("line three", function(err, gridStore) { + + // Flush file to disk + gridStore.close(function(err, result) { + + // Read back all the lines + GridStore.readlines(db, fileId, function(err, lines) { + assert.deepEqual(["line one\n", "line two\n", "line three\n"], lines); + + db.close(); + }); + }); + }); + }); + }); + }); + }); + + +---------------- +GridStore.unlink +---------------- + + +Deletes the chunks and metadata information of a file from GridFS. + +.. js:function:: GridStore.unlink(db, names[, options]) + + :param db db: the database to interact with. + :param string names: the name/names of the files to delete. + :param object [options]: the options for the files. + :returns: null + + +**Examples** + + + + A simple example showing the usage of the GridStore.unlink method. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + + // Open a new file for writing + var gridStore = new GridStore(db, "test_gs_unlink", "w"); + gridStore.open(function(err, gridStore) { + + // Write some content + gridStore.write("hello, world!", function(err, gridStore) { + + // Flush file to GridFS + gridStore.close(function(err, result) { + + // Verify the existance of the fs.files document + db.collection('fs.files', function(err, collection) { + collection.count(function(err, count) { + assert.equal(1, count); + }) + }); + + // Verify the existance of the fs.chunks chunk document + db.collection('fs.chunks', function(err, collection) { + collection.count(function(err, count) { + assert.equal(1, count); + + // Unlink the file (removing it) + GridStore.unlink(db, 'test_gs_unlink', function(err, gridStore) { + + // Verify that fs.files document is gone + db.collection('fs.files', function(err, collection) { + collection.count(function(err, count) { + assert.equal(0, count); + }) + }); + + // Verify that fs.chunks chunk documents are gone + db.collection('fs.chunks', function(err, collection) { + collection.count(function(err, count) { + assert.equal(0, count); + + db.close(); + }) + }); + }); + }) + }); + }); + }); + }); + }); + + +----- +write +----- + + +Writes some data. This method will work properly only if initialized with mode "w" or "w+". + +.. js:function:: write(data[, close], callback) + + :param string data: the data to write. + :param boolean [close]: closes this file after writing if set to true. + :param function callback: this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. + :returns: null + + +**Examples** + + + + A simple example showing how to use the write command with strings and Buffers. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // Our file ID + var fileId = new ObjectID(); + + // Open a new file + var gridStore = new GridStore(db, fileId, 'w'); + + // Open the new file + gridStore.open(function(err, gridStore) { + + // Write a text string + gridStore.write('Hello world', function(err, gridStore) { + + // Write a buffer + gridStore.write(new Buffer('Buffer Hello world'), function(err, gridStore) { + + // Close the + gridStore.close(function(err, result) { + + // Read back all the written content and verify the correctness + GridStore.read(db, fileId, function(err, fileData) { + assert.equal('Hello worldBuffer Hello world', fileData.toString()); + + db.close(); + }); + }); + }); + }); + }); + }); + + +----- +pause +----- + + +pause + +.. js:function:: pause() + + +------ +resume +------ + + +resume + +.. js:function:: resume() + diff --git a/_sources/api-generated/index.txt b/_sources/api-generated/index.txt new file mode 100644 index 00000000000..fa5d737938a --- /dev/null +++ b/_sources/api-generated/index.txt @@ -0,0 +1,20 @@ +================== +Driver API +================== + +.. toctree:: + :maxdepth: 2 + + admin + collection + mongoclient + db + cursor + cursorstream + gridstore + readstream + grid + server + mongos + replset + readpreference diff --git a/_sources/api-generated/mongoclient.txt b/_sources/api-generated/mongoclient.txt new file mode 100644 index 00000000000..777f02c028a --- /dev/null +++ b/_sources/api-generated/mongoclient.txt @@ -0,0 +1,239 @@ +============= +MongoClient() +============= + +------------------ +Constructor +------------------ + + +Create a new MongoClient instance. + + + .. js:class:: MongoClient() + + :param object serverConfig: server config object. + :param object [options]: additional options for the collection. + + +Options + - **w**, {Number/String, > -1 || 'majority' || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = 'majority' or tag acknowledges the write + - **wtimeout**, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + - **fsync**, (Boolean, default:false) write waits for fsync before returning + - **journal**, (Boolean, default:false) write waits for journal sync before returning + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + - **native_parser** {Boolean, default:false}, use c++ bson parser. + - **forceServerObjectId** {Boolean, default:false}, force server to create _id fields instead of client. + - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. + - **serializeFunctions** {Boolean, default:false}, serialize functions. + - **raw** {Boolean, default:false}, peform operations using raw bson buffers. + - **recordQueryStats** {Boolean, default:false}, record query statistics during execution. + - **retryMiliSeconds** {Number, default:5000}, number of miliseconds between retries. + - **numberOfRetries** {Number, default:5}, number of retries off connection. + + + +Deprecated Options + - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. + + +---- +open +---- + + +Initialize the database connection. + +.. js:function:: open(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the connected mongoclient or null if an error occured. + :returns: null + + +**Examples** + + + + A basic example using the MongoClient to connect using a Server instance, similar to existing Db version + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Set up the connection to the local db + var mongoclient = new MongoClient(new Server("localhost", 27017, {native_parser: true})); + + // Open the connection to the server + mongoclient.open(function(err, mongoclient) { + + // Get the first db and do an update document on it + var db = mongoclient.db("integration_tests"); + db.collection('mongoclient_test').update({a:1}, {b:1}, {upsert:true}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result); + + // Get another db and do an update document on it + var db2 = mongoclient.db("integration_tests2"); + db2.collection('mongoclient_test').update({a:1}, {b:1}, {upsert:true}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result); + + // Close the connection + mongoclient.close(); + }); + }); + }); + + +----- +close +----- + + +Close the current db connection, including all the child db instances. Emits close event if no callback is provided. + +.. js:function:: close(callback) + + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the close method or null if an error occured. + :returns: null + + +-- +db +-- + + +Create a new Db instance sharing the current socket connections. + +.. js:function:: db(dbName) + + :param string dbName: the name of the database we want to use. + :returns: db a db instance using the new database. + + +------------------- +MongoClient.connect +------------------- + + +Connect to MongoDB using a url as documented at + + + +docs.mongodb.org/manual/reference/connection-string/ + + + +Options + - **uri_decode_auth** {Boolean, default:false} uri decode the user name and password for authentication + - **db** {Object, default: null} a hash off options to set on the db object, see **Db constructor** + - **server** {Object, default: null} a hash off options to set on the server objects, see **Server** constructor** + - **replSet** {Object, default: null} a hash off options to set on the replSet object, see **ReplSet** constructor** + - **mongos** {Object, default: null} a hash off options to set on the mongos object, see **Mongos** constructor** + +.. js:function:: MongoClient.connect(url[, options], callback) + + :param string url: connection url for MongoDB. + :param object [options]: optional options for insert command + :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the initialized db object or null if an error occured. + :returns: null + + +**Examples** + + + + Example of a simple url connection string for a single server connection + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + // Connect using the connection string + MongoClient.connect("mongodb://localhost:27017/integration_tests", {native_parser:true}, function(err, db) { + assert.equal(null, err); + + db.collection('mongoclient_test').update({a:1}, {b:1}, {upsert:true}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result); + + db.close(); + }); + }); + + + + Example of a simple url connection string to a replicaset, with acknowledgement of writes. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + MongoClient.connect("mongodb://localhost:30000,localhost:30001,localhost:30002/integration_test_?w=1", function(err, db) { + assert.equal(null, err); + assert.ok(db != null); + + db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result); + + db.close(); + }); + }); + + + + Example of a simple url connection string to a shard, with acknowledgement of writes. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + MongoClient.connect('mongodb://localhost:50000,localhost:50001/sharded_test_db?w=1', function(err, db) { + assert.equal(null, err); + assert.ok(db != null); + + db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) { + assert.equal(null, err); + assert.equal(1, result); + + db.close(); + }); + }); + diff --git a/_sources/api-generated/mongos.txt b/_sources/api-generated/mongos.txt new file mode 100644 index 00000000000..5ca38cbaa6b --- /dev/null +++ b/_sources/api-generated/mongos.txt @@ -0,0 +1,33 @@ +======== +Mongos() +======== + +------------------ +Constructor +------------------ + + +Mongos constructor provides a connection to a mongos proxy including failover to additional servers + + + .. js:class:: Mongos() + + :param array list: of mongos server objects + :param object [options]: additional options for the mongos connection + + +Options + - **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number)) + - **ha** {Boolean, default:true}, turn on high availability, attempts to reconnect to down proxies + - **haInterval** {Number, default:2000}, time between each replicaset status check. + + +----------------- +setReadPreference +----------------- + + +Always ourselves + +.. js:function:: setReadPreference() + diff --git a/_sources/api-generated/readpreference.txt b/_sources/api-generated/readpreference.txt new file mode 100644 index 00000000000..ac6110fb8de --- /dev/null +++ b/_sources/api-generated/readpreference.txt @@ -0,0 +1,26 @@ +================ +ReadPreference() +================ + +------------------ +Constructor +------------------ + + +A class representation of the Read Preference. + + + .. js:class:: ReadPreference() + + :param string the: read preference type + :param object tags: + :returns: readpreference + + +Read Preferences + - **ReadPreference.PRIMARY**, Read from primary only. All operations produce an error (throw an exception where applicable) if primary is unavailable. Cannot be combined with tags (This is the default.). + - **ReadPreference.PRIMARY_PREFERRED**, Read from primary if available, otherwise a secondary. + - **ReadPreference.SECONDARY**, Read from secondary if available, otherwise error. + - **ReadPreference.SECONDARY_PREFERRED**, Read from a secondary if available, otherwise read from the primary. + - **ReadPreference.NEAREST**, All modes read from among the nearest candidates, but unlike other modes, NEAREST will include both the primary and all secondaries in the random selection. + diff --git a/_sources/api-generated/readstream.txt b/_sources/api-generated/readstream.txt new file mode 100644 index 00000000000..4b7a22ee9c7 --- /dev/null +++ b/_sources/api-generated/readstream.txt @@ -0,0 +1,264 @@ +============ +ReadStream() +============ + +------------------ +Constructor +------------------ + + +ReadStream + + + .. js:class:: ReadStream() + + :param boolean autoclose: automatically close file when the stream reaches the end. + :param gridstore cursor: a cursor object that the stream wraps. + :returns: readstream + + +Returns a stream interface for the **file**. + + + +Events + - **data** {function(item) {}} the data event triggers when a document is ready. + - **end** {function() {}} the end event triggers when there is no more documents available. + - **close** {function() {}} the close event triggers when the stream is closed. + - **error** {function(err) {}} the error event triggers if an error happens. + + +----- +pause +----- + + +Pauses this stream, then no farther events will be fired. + +.. js:function:: pause() + + +**Examples** + + + + A simple example showing the use of the readstream pause function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // File id + var fileId = new ObjectID(); + // Create a file + var file = new GridStore(db, fileId, "w", {chunk_size:5}); + file.open(function(err, file) { + // Write some content and flush to disk + file.write('Hello world', function(err, file) { + file.close(function(err, result) { + + // Let's create a read file + file = new GridStore(db, fileId, "r"); + // Open the file + file.open(function(err, file) { + // Peform a find to get a cursor + var stream = file.stream(); + + // For each data item + stream.on("data", function(item) { + // Check if stream is paused + assert.equal(false, stream.paused); + // Pause stream + stream.pause(); + // Restart the stream after 1 miliscecond + setTimeout(function() { + stream.resume(); + // Check if cursor is paused + assert.equal(false, stream.paused); + }, 100); + }); + + // For each data item + stream.on("end", function(item) { + stream.destroy(); + }); + // When the stream is done + stream.on("close", function() { + db.close(); + }); + }); + }); + }); + }); + }); + + +------- +destroy +------- + + +Destroys the stream, then no farther events will be fired. + +.. js:function:: destroy() + + +**Examples** + + + + A simple example showing the use of the readstream destroy function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // File id + var fileId = new ObjectID(); + // Create a file + var file = new GridStore(db, fileId, "w"); + file.open(function(err, file) { + // Write some content and flush to disk + file.write('Hello world', function(err, file) { + file.close(function(err, result) { + + // Let's create a read file + file = new GridStore(db, fileId, "r"); + // Open the file + file.open(function(err, file) { + // Peform a find to get a cursor + var stream = file.stream(); + + // For each data item + stream.on("data", function(item) { + // Destroy the stream + stream.destroy(); + }); + + // When the stream is done + stream.on("close", function() { + db.close(); + }); + }); + }); + }); + }); + }); + + +------ +resume +------ + + +Resumes this stream. + +.. js:function:: resume() + + +**Examples** + + + + A simple example showing the use of the readstream resume function. + + .. code-block:: javascript + + var Db = require('mongodb').Db, + MongoClient = require('mongodb').MongoClient, + Server = require('mongodb').Server, + ReplSetServers = require('mongodb').ReplSetServers, + ObjectID = require('mongodb').ObjectID, + Binary = require('mongodb').Binary, + GridStore = require('mongodb').GridStore, + Code = require('mongodb').Code, + BSON = require('mongodb').pure().BSON, + assert = require('assert'); + + var db = new Db('test', new Server('locahost', 27017)); + // Establish connection to db + db.open(function(err, db) { + // File id + var fileId = new ObjectID(); + // Create a file + var file = new GridStore(db, fileId, "w", {chunk_size:5}); + file.open(function(err, file) { + // Write some content and flush to disk + var fileBody = 'Hello world'; + file.write(fileBody, function(err, file) { + file.close(function(err, result) { + // Let's create a read file + file = new GridStore(db, fileId, "r"); + + // Open the file + file.open(function(err, file) { + // Peform a find to get a cursor + var stream = file.stream(true); + + // Pause the stream initially + stream.pause(); + + // Save read content here + var fileBuffer = ''; + + // For each data item + stream.on("data", function(item) { + // Check if stream is paused + assert.equal(false, stream.paused); + // Pause stream + stream.pause(); + // Check if cursor is paused + // assert.equal(true, stream.paused); + + fileBuffer += item.toString('utf8'); + + // Restart the stream after 1 miliscecond + setTimeout(function() { + stream.resume(); + // Check if cursor is paused + assert.equal(false, stream.paused); + }, 100); + }); + + // For each data item + stream.on("end", function(item) { + }); + // When the stream is done + stream.on("close", function() { + // Have we received the same file back? + assert.equal(fileBuffer, fileBody); + db.close(); + }); + + // Resume the stream + stream.resume(); + }); + }); + }); + }); + }); + diff --git a/_sources/api-generated/replset.txt b/_sources/api-generated/replset.txt new file mode 100644 index 00000000000..76af7b84ab3 --- /dev/null +++ b/_sources/api-generated/replset.txt @@ -0,0 +1,78 @@ +======= +ReplSet +======= + +------------------ +Constructor +------------------ + + +ReplSet constructor provides replicaset functionality + + + .. js:class:: ReplSet + + :param array list: of server objects participating in the replicaset. + :param object [options]: additional options for the replicaset connection. + + +Options + - **ha** {Boolean, default:true}, turn on high availability. + - **haInterval** {Number, default:2000}, time between each replicaset status check. + - **reconnectWait** {Number, default:1000}, time to wait in miliseconds before attempting reconnect. + - **retries** {Number, default:30}, number of times to attempt a replicaset reconnect. + - **rs_name** {String}, the name of the replicaset to connect to. + - **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number)) + - **readPreference** {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + - **strategy** {String, default:'ping'}, selection strategy for reads choose between (ping, statistical and none, default is ping) + - **secondaryAcceptableLatencyMS** {Number, default:15}, sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms) + - **connectArbiter** {Boolean, default:false}, sets if the driver should connect to arbiters or not. + - **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**. + - **ssl** {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support) + - **sslValidate** {Boolean, default:false}, validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslCA** {Array, default:null}, Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslCert** {Buffer/String, default:null}, String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslKey** {Buffer/String, default:null}, String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslPass** {Buffer/String, default:null}, String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher) + + +--------- +_enableHA +--------- + + +Enables high availability pings. + +.. js:function:: _enableHA() + + +------------- +ReplSet.State +------------- + + +Interval state object constructor + +.. js:function:: ReplSet.State() + + +------------------ +_handleOnFullSetup +------------------ + + +Handles the first fullsetup event of this ReplSet. + +.. js:function:: _handleOnFullSetup(parent) + + :param db parent: + +---------- +_disableHA +---------- + + +Disables high availability pings. + +.. js:function:: _disableHA() + diff --git a/_sources/api-generated/server.txt b/_sources/api-generated/server.txt new file mode 100644 index 00000000000..c8df01a9c52 --- /dev/null +++ b/_sources/api-generated/server.txt @@ -0,0 +1,76 @@ +======== +Server() +======== + +------------------ +Constructor +------------------ + + +Class representing a single MongoDB Server connection + + + .. js:class:: Server() + + :param string host: the server host + :param number port: the server port + :param object [options]: optional options for insert command + + +Options + - **readPreference** {String, default:null}, set's the read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST) + - **ssl** {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support) + - **sslValidate** {Boolean, default:false}, validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslCA** {Array, default:null}, Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslCert** {Buffer/String, default:null}, String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslKey** {Buffer/String, default:null}, String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher) + - **sslPass** {Buffer/String, default:null}, String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher) + - **poolSize** {Number, default:5}, number of connections in the connection pool, set to 5 as default for legacy reasons. + - **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number)) + - **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**. + - **auto_reconnect** {Boolean, default:false}, reconnect on error. + - **disableDriverBSONSizeCheck** {Boolean, default:false}, force the server to error if the BSON message is to big + + +----------------- +setReadPreference +----------------- + + +Always ourselves + +.. js:function:: setReadPreference() + + +---------------- +assignReplicaSet +---------------- + + +Assigns a replica set to this server. + +.. js:function:: assignReplicaSet(replset) + + :param replset replset: + +------------------------- +inheritReplSetOptionsFrom +------------------------- + + +Takes needed options from replset and overwrites +our own options. + +.. js:function:: inheritReplSetOptionsFrom(replset) + + :param replset replset: + +------- +connect +------- + + +Opens this server connection. + +.. js:function:: connect() + diff --git a/HISTORY b/_sources/changelog/changelog.txt similarity index 55% rename from HISTORY rename to _sources/changelog/changelog.txt index adfb2fcce5c..b54b7b4f944 100644 --- a/HISTORY +++ b/_sources/changelog/changelog.txt @@ -1,3 +1,277 @@ +========= +Changelog +========= + +1.2.14 2013-03-14 +----------------- +- Refactored test suite to speed up running of replicaset tests +- Fix of async error handling when error happens in callback (Issue #909, https://github.com/medikoo) +- Corrected a slaveOk setting issue (Issue #906, #905) +- Fixed HA issue where ping's would not go to correct server on HA server connection failure. +- Uses setImmediate if on 0.10 otherwise nextTick for cursor stream +- Fixed race condition in Cursor stream (NODE-31) +- Fixed issues related to node 0.10 and process.nextTick now correctly using setImmediate where needed on node 0.10 +- Added support for maxMessageSizeBytes if available (DRIVERS-1) +- Added support for authSource (2.4) to MongoClient URL and db.authenticate method (DRIVER-69/NODE-34) +- Fixed issue in GridStore seek and GridStore read to correctly work on multiple seeks (Issue #895) + +1.2.13 2013-02-22 +----------------- +- Allow strategy 'none' for repliaset if no strategy wanted (will default to round robin selection of servers on a set readPreference) +- Fixed missing MongoErrors on some cursor methods (Issue #882) +- Correctly returning a null for the db instance on MongoClient.connect when auth fails (Issue #890) +- Added dropTarget option support for renameCollection/rename (Issue #891, help from https://github.com/jbottigliero) +- Fixed issue where connection using MongoClient.connect would fail if first server did not exist (Issue #885) + +1.2.12 2013-02-13 +----------------- +- Added limit/skip options to Collection.count (Issue #870) +- Added applySkipLimit option to Cursor.count (Issue #870) +- Enabled ping strategy as default for Replicaset if none specified (Issue #876) +- Should correctly pick nearest server for SECONDARY/SECONDARY_PREFERRED/NEAREST (Issue #878) + +1.2.11 2013-01-29 +----------------- +- Added fixes for handling type 2 binary due to PHP driver (Issue #864) +- Moved callBackStore to Base class to have single unified store (Issue #866) +- Ping strategy now reuses sockets unless they are closed by the server to avoid overhead + +1.2.10 2013-01-25 +----------------- +- Merged in SSL support for 2.4 supporting certificate validation and presenting certificates to the server. +- Only open a new HA socket when previous one dead (Issue #859, #857) +- Minor fixes + +1.2.9 2013-01-15 +---------------- +- Fixed bug in SSL support for MongoClient/Db.connect when discovering servers (Issue #849) +- Connection string with no db specified should default to admin db (Issue #848) +- Support port passed as string to Server class (Issue #844) +- Removed noOpen support for MongoClient/Db.connect as auto discovery of servers for Mongod/Mongos makes it not possible (Issue #842) +- Included toError wrapper code moved to utils.js file (Issue #839, #840) +- Rewrote cursor handling to avoid process.nextTick using trampoline instead to avoid stack overflow, speedup about 40% + +1.2.8 2013-01-07 +---------------- +- Accept function in a Map Reduce scope object not only a function string (Issue #826, https://github.com/aheckmann) +- Typo in db.authenticate caused a check (for provided connection) to return false, causing a connection AND onAll=true to be passed into __executeQueryCommand downstream (Issue #831, https://github.com/m4tty) +- Allow gridfs objects to use non ObjectID ids (Issue #825, https://github.com/nailgun) +- Removed the double wrap, by not passing an Error object to the wrap function (Issue #832, https://github.com/m4tty) +- Fix connection leak (gh-827) for HA replicaset health checks (Issue #833, https://github.com/aheckmann) +- Modified findOne to use nextObject instead of toArray avoiding a nextTick operation (Issue #836) +- Fixes for cursor stream to avoid multiple getmore issues when one in progress (Issue #818) +- Fixes .open replaying all backed up commands correctly if called after operations performed, (Issue #829 and #823) + +1.2.7 2012-12-23 +---------------- +- Rolled back batches as they hang in certain situations +- Fixes for NODE-25, keep reading from secondaries when primary goes down + +1.2.6 2012-12-21 +---------------- +- domain sockets shouldn't require a port arg (Issue #815, https://github.com/aheckmann) +- Cannot read property 'info' of null (Issue #809, https://github.com/thesmart) +- Cursor.each should work in batches (Issue #804, https://github.com/Swatinem) +- Cursor readPreference bug for non-supported read preferences (Issue #817) + +1.2.5 2012-12-12 +---------------- +- Fixed ssl regression, added more test coverage (Issue #800) +- Added better error reporting to the Db.connect if no valid serverConfig setup found (Issue #798) + +1.2.4 2012-12-11 +---------------- +- Fix to ensure authentication is correctly applied across all secondaries when using MongoClient. + +1.2.3 2012-12-10 +---------------- +- Fix for new replicaset members correctly authenticating when being added (Issue #791, https://github.com/m4tty) +- Fixed seek issue in gridstore when using stream (Issue #790) + +1.2.2 2012-12-03 +---------------- +- Fix for journal write concern not correctly being passed under some circumstances. +- Fixed correct behavior and re-auth for servers that get stepped down (Issue #779). + +1.2.1 2012-11-30 +---------------- +- Fix for double callback on insert with w:0 specified (Issue #783) +- Small cleanup of urlparser. + +1.2.0 2012-11-27 +---------------- +- Honor connectTimeoutMS option for replicasets (Issue #750, https://github.com/aheckmann) +- Fix ping strategy regression (Issue #738, https://github.com/aheckmann) +- Small cleanup of code (Issue #753, https://github.com/sokra/node-mongodb-native) +- Fixed index declaration using objects/arrays from other contexts (Issue #755, https://github.com/sokra/node-mongodb-native) +- Intermittent (and rare) null callback exception when using ReplicaSets (Issue #752) +- Force correct setting of read_secondary based on the read preference (Issue #741) +- If using read preferences with secondaries queries will not fail if primary is down (Issue #744) +- noOpen connection for Db.connect removed as not compatible with autodetection of Mongo type +- Mongos connection with auth not working (Issue #737) +- Use the connect method directly from the require. require('mongodb')("mongodb://localhost:27017/db") +- new MongoClient introduced as the point of connecting to MongoDB's instead of the Db + - open/close/db/connect methods implemented +- Implemented common URL connection format using MongoClient.connect allowing for simialar interface across all drivers. +- Fixed a bug with aggregation helper not properly accepting readPreference + +1.1.11 2012-10-10 +----------------- +- Removed strict mode and introduced normal handling of safe at DB level. + +1.1.10 2012-10-08 +----------------- +- fix Admin.serverStatus (Issue #723, https://github.com/Contra) +- logging on connection open/close(Issue #721, https://github.com/asiletto) +- more fixes for windows bson install (Issue #724) + +1.1.9 2012-10-05 +---------------- +- Updated bson to 0.1.5 to fix build problem on sunos/windows. + +1.1.8 2012-10-01 +---------------- +- Fixed db.eval to correctly handle system.js global javascript functions (Issue #709) +- Cleanup of non-closing connections (Issue #706) +- More cleanup of connections under replicaset (Issue #707, https://github.com/elbert3) +- Set keepalive on as default, override if not needed +- Cleanup of jsbon install to correctly build without install.js script (https://github.com/shtylman) +- Added domain socket support new Server("/tmp/mongodb.sock") style + +1.1.7 2012-09-10 +---------------- +- Protect against starting PingStrategy being called more than once (Issue #694, https://github.com/aheckmann) +- Make PingStrategy interval configurable (was 1 second, relaxed to 5) (Issue #693, https://github.com/aheckmann) +- Made PingStrategy api more consistant, callback to start/stop methods are optional (Issue #693, https://github.com/aheckmann) +- Proper stopping of strategy on replicaset stop +- Throw error when gridstore file is not found in read mode (Issue #702, https://github.com/jbrumwell) +- Cursor stream resume now using nextTick to avoid duplicated records (Issue #696) + +1.1.6 2012-09-01 +---------------- +- Fix for readPreference NEAREST for replicasets (Issue #693, https://github.com/aheckmann) +- Emit end correctly on stream cursor (Issue #692, https://github.com/Raynos) + +1.1.5 2012-08-29 +---------------- +- Fix for eval on replicaset Issue #684 +- Use helpful error msg when native parser not compiled (Issue #685, https://github.com/aheckmann) +- Arbiter connect hotfix (Issue #681, https://github.com/fengmk2) +- Upgraded bson parser to 0.1.2 using gyp, deprecated support for node 0.4.X +- Added name parameter to createIndex/ensureIndex to be able to override index names larger than 128 bytes +- Added exhaust option for find for feature completion (not recommended for normal use) +- Added tailableRetryInterval to find for tailable cursors to allow to control getMore retry time interval +- Fixes for read preferences when using MongoS to correctly handle no read preference set when iterating over a cursor (Issue #686) + +1.1.4 2012-08-12 +---------------- +- Added Mongos connection type with a fallback list for mongos proxies, supports ha (on by default) and will attempt to reconnect to failed proxies. +- Documents can now have a toBSON method that lets the user control the serialization behavior for documents being saved. +- Gridstore instance object now works as a readstream or writestream (thanks to code from Aaron heckmann (https://github.com/aheckmann/gridfs-stream)). +- Fix gridfs readstream (Issue #607, https://github.com/tedeh). +- Added disableDriverBSONSizeCheck property to Server.js for people who wish to push the inserts to the limit (Issue #609). +- Fixed bug where collection.group keyf given as Code is processed as a regular object (Issue #608, https://github.com/rrusso2007). +- Case mismatch between driver's ObjectID and mongo's ObjectId, allow both (Issue #618). +- Cleanup map reduce (Issue #614, https://github.com/aheckmann). +- Add proper error handling to gridfs (Issue #615, https://github.com/aheckmann). +- Ensure cursor is using same connection for all operations to avoid potential jump of servers when using replicasets. +- Date identification handled correctly in bson js parser when running in vm context. +- Documentation updates +- GridStore filename not set on read (Issue #621) +- Optimizations on the C++ bson parser to fix a potential memory leak and avoid non-needed calls +- Added support for awaitdata for tailable cursors (Issue #624) +- Implementing read preference setting at collection and cursor level + * collection.find().setReadPreference(Server.SECONDARY_PREFERRED) + * db.collection("some", {readPreference:Server.SECONDARY}) +- Replicaset now returns when the master is discovered on db.open and lets the rest of the connections happen asynchronous. + - ReplSet/ReplSetServers emits "fullsetup" when all servers have been connected to +- Prevent callback from executing more than once in getMore function (Issue #631, https://github.com/shankar0306) +- Corrupt bson messages now errors out to all callbacks and closes up connections correctly, Issue #634 +- Replica set member status update when primary changes bug (Issue #635, https://github.com/alinsilvian) +- Fixed auth to work better when multiple connections are involved. +- Default connection pool size increased to 5 connections. +- Fixes for the ReadStream class to work properly with 0.8 of Node.js +- Added explain function support to aggregation helper +- Added socketTimeoutMS and connectTimeoutMS to socket options for repl_set.js and server.js +- Fixed addUser to correctly handle changes in 2.2 for getLastError authentication required +- Added index to gridstore chunks on file_id (Issue #649, https://github.com/jacobbubu) +- Fixed Always emit db events (Issue #657) +- Close event not correctly resets DB openCalled variable to allow reconnect +- Added open event on connection established for replicaset, mongos and server +- Much faster BSON C++ parser thanks to Lucasfilm Singapore. +- Refactoring of replicaset connection logic to simplify the code. +- Add `options.connectArbiter` to decide connect arbiters or not (Issue #675) +- Minor optimization for findAndModify when not using j,w or fsync for safe + +1.0.2 2012-05-15 +---------------- +- Reconnect functionality for replicaset fix for mongodb 2.0.5 + +1.0.1 2012-05-12 +---------------- +- Passing back getLastError object as 3rd parameter on findAndModify command. +- Fixed a bunch of performance regressions in objectId and cursor. +- Fixed issue #600 allowing for single document delete to be passed in remove command. + +1.0.0 2012-04-25 +---------------- +- Fixes to handling of failover on server error +- Only emits error messages if there are error listeners to avoid uncaught events +- Server.isConnected using the server state variable not the connection pool state + +0.9.9.8 2012-04-12 +------------------ +- _id=0 is being turned into an ObjectID (Issue #551) +- fix for error in GridStore write method (Issue #559) +- Fix for reading a GridStore from arbitrary, non-chunk aligned offsets, added test (Issue #563, https://github.com/subroutine) +- Modified limitRequest to allow negative limits to pass through to Mongo, added test (Issue #561) +- Corrupt GridFS files when chunkSize < fileSize, fixed concurrency issue (Issue #555) +- Handle dead tailable cursors (Issue #568, https://github.com/aheckmann) +- Connection pools handles closing themselves down and clearing the state +- Check bson size of documents against maxBsonSize and throw client error instead of server error, (Issue #553) +- Returning update status document at the end of the callback for updates, (Issue #569) +- Refactor use of Arguments object to gain performance (Issue #574, https://github.com/AaronAsAChimp) + +0.9.9.7 2012-03-16 +------------------ +- Stats not returned from map reduce with inline results (Issue #542) +- Re-enable testing of whether or not the callback is called in the multi-chunk seek, fix small GridStore bug (Issue #543, https://github.com/pgebheim) +- Streaming large files from GridFS causes truncation (Issue #540) +- Make callback type checks agnostic to V8 context boundaries (Issue #545) +- Correctly throw error if an attempt is made to execute an insert/update/remove/createIndex/ensureIndex with safe enabled and no callback +- Db.open throws if the application attemps to call open again without calling close first + +0.9.9.6 2012-03-12 +------------------ +- BSON parser is externalized in it's own repository, currently using git master +- Fixes for Replicaset connectivity issue (Issue #537) +- Fixed issues with node 0.4.X vs 0.6.X (Issue #534) +- Removed SimpleEmitter and replaced with standard EventEmitter +- GridStore.seek fails to change chunks and call callback when in read mode (Issue #532) + +0.9.9.5 2012-03-07 +------------------ +- Merged in replSetGetStatus helper to admin class (Issue #515, https://github.com/mojodna) +- Merged in serverStatus helper to admin class (Issue #516, https://github.com/mojodna) +- Fixed memory leak in C++ bson parser (Issue #526) +- Fix empty MongoError "message" property (Issue #530, https://github.com/aheckmann) +- Cannot save files with the same file name to GridFS (Issue #531) + +0.9.9.4 2012-02-26 +------------------ +* bugfix for findAndModify: Error: corrupt bson message < 5 bytes long (Issue #519) + +0.9.9.3 2012-02-23 +------------------ +* document: save callback arguments are both undefined, (Issue #518) +* Native BSON parser install error with npm, (Issue #517) + +0.9.9.2 2012-02-17 +------------------ +* Improved detection of Buffers using Buffer.isBuffer instead of instanceof. +* Added wrap error around db.dropDatabase to catch all errors (Issue #512) +* Added aggregate helper to collection, only for MongoDB >= 2.1 + 0.9.9.1 2012-02-15 ------------------ * Better handling of safe when using some commands such as createIndex, ensureIndex, addUser, removeUser, createCollection. @@ -28,7 +302,7 @@ * Added stats command to collection to retrieve the statistics on a Collection. * Added listDatabases command to admin object to allow retrieval of all available dbs. * Changed createCreateIndexCommand to work better with options. -* Fixed dereference method on Db class to correctly dereference Db reference objects. +* Fixed dereference method on Db class to correctly dereference Db reference objects. * Moved connect object onto Db class(Db.connect) as well as keeping backward compatibility. * Removed writeBuffer method from gridstore, write handles switching automatically now. * Changed readBuffer to read on Gridstore, Gridstore now only supports Binary Buffers no Strings anymore. @@ -40,10 +314,10 @@ * Added support for $returnKey, $maxScan, $min, $max, $showDiskLoc, $comment to cursor and find/findOne methods. * Added dropDups and v option to createIndex and ensureIndex. * Added isCapped method to Collection. -* Added indexExists method to Collection. +* Added indexExists method to Collection. * Added findAndRemove method to Collection. * Fixed bug for replicaset connection when no active servers in the set. -* Fixed bug for replicaset connections when errors occur during connection. +* Fixed bug for replicaset connections when errors occur during connection. * Merged in patch for BSON Number handling from Lee Salzman, did some small fixes and added test coverage. 0.9.8-3 2012-01-21 @@ -66,7 +340,7 @@ * Fixes formattedOrderClause in collection.js to accept a plain hash as a parameter (Issue #469) https://github.com/tedeh * Removed duplicate code for formattedOrderClause and moved to utils module * Pass in poolSize for ReplSetServers to set default poolSize for new replicaset members -* Bug fix for BSON JS deserializer. Isolating the eval functions in separate functions to avoid V8 deoptimizations +* Bug fix for BSON JS deserializer. Isolating the eval functions in separate functions to avoid V8 deoptimizations * Correct handling of illegal BSON messages during deserialization * Fixed Infinite loop when reading GridFs file with no chunks (Issue #471) * Correctly update existing user password when using addUser (Issue #470) @@ -115,7 +389,7 @@ 0.9.7.2-3 2011-12-18 -------------------- * Fixed error handling for findAndModify while still working for mongodb 1.8.6 (Issue #450). -* Allow for force send query to primary, pass option (read:'primary') on find command. +* Allow for force send query to primary, pass option (read:'primary') on find command. * ``find({a:1}, {read:'primary'}).toArray(function(err, items) {});`` 0.9.7.2-2 2011-12-16 @@ -168,7 +442,7 @@ ------------------ * Better handling of dead server for single server instances * FindOne and find treats selector == null as {}, Issue #403 -* Possible to pass in a strategy for the replicaset to pick secondary reader node +* Possible to pass in a strategy for the replicaset to pick secondary reader node * parameter strategy * ping (default), pings the servers and picks the one with the lowest ping time * statistical, measures each request and pick the one with the lowest mean and std deviation @@ -234,7 +508,7 @@ * Reworked bson.cc to throw error when trying to serialize js bson types * Added MinKey, MaxKey and Double support for JS and C++ parser * Reworked socket handling code to emit errors on unparsable messages -* Added logger option for Db class, lets you pass in a function in the shape +* Added logger option for Db class, lets you pass in a function in the shape { log : function(message, object) {}, error : function(errorMessage, errorObject) {}, @@ -314,7 +588,7 @@ * Bug fix for bson parsing the key '':'' correctly without crashing 0.9.6-8 -------- +------- * Changed to using node.js crypto library MD5 digest * Connect method support documented mongodb: syntax by (https://github.com/sethml) * Support Symbol type for BSON, serializes to it's own type Symbol, Issue #302, #288 @@ -387,7 +661,7 @@ * Replicaset support (failover and reading from secondary servers) * Removed ServerPair and ServerCluster * Added connection pool functionality -* Fixed serious bug in C++ bson parser where bytes > 127 would generate 2 byte sequences +* Fixed serious bug in C++ bson parser where bytes > 127 would generate 2 byte sequences * Allows for forcing the server to assign ObjectID's using the option {forceServerObjectId: true} 0.6.8 diff --git a/_sources/content/awesomeappsvideo.txt b/_sources/content/awesomeappsvideo.txt new file mode 100644 index 00000000000..bacbaf554ac --- /dev/null +++ b/_sources/content/awesomeappsvideo.txt @@ -0,0 +1,14 @@ +====================================== +Awesome Node.js + MongoDB Applications +====================================== + +Node.js blackboard - socket.io +------------------------------ +Nodejs test using express, jade, stylus, socket.io and Mongodb +for persist the data +Source: http://github.com/gotik/nodejs-blackboard +http://node.kamikazepanda.com + +.. raw:: html + + \ No newline at end of file diff --git a/_sources/content/nodejsvideo.txt b/_sources/content/nodejsvideo.txt new file mode 100644 index 00000000000..c8f01a5ce89 --- /dev/null +++ b/_sources/content/nodejsvideo.txt @@ -0,0 +1,160 @@ +============================== +Node.JS Specific Presentations +============================== + +An Introduction to the node.js MongoDB Driver +--------------------------------------------- +Christian Kvalheim gives an introduction to the node.js MongoDB driver. + +.. raw:: html + +
+ + + + + + + + + + + + +
+ +Node.js and MongoDB, a Panel Discussion +--------------------------------------- +Working with Node’s JavaScript means that MongoDB documents get their most natural representation - as JSON - right in the application layer. This session introduces the open source tools available for using MongoDB with Node.js through a panel discussion with the main contributors to these projects. Tom Hughes-Croucher, Node.js Chief Evangelist at Joyent, moderates the discussion. Towards the end, Tom field questions from the attendees. + +.. raw:: html + +
+ +
+ +Schemas for Real Time Analytics with Node.js +-------------------------------------------- +SimpleReach powers the Slide, a recommendation powered content discovery technology for websites. Eric Lublow will discuss how SimpleReach builds schemas in MongoDB and Node.js for powerful, real-time data delivery. Topics will include: + +* Dynamic collection creation +* Updating (Increments over sets) +* Schema +* Next gen schemas for dynamic filters + +.. raw:: html + +
+ + + + + + + + + + + + +
+ +Happy Mongo-ing in Node.js +-------------------------- +Node.js is JavaScript. MongoDB speaks JSON. So why bother with an in-between "ORM" layer like Mongoose? Join us for a look at the object modeling... tool designed and maintained by the team at LearnBoost. Recent updates have made Mongoose even more compelling. We'll share the pros and cons we've experienced in using it day-to-day on our current project. + +.. raw:: html + +
+ + + + + + + + + + + + +
+ +NYC MongoDB User Group - Schemas for Real Time Analytics with Node.js +--------------------------------------------------------------------- +Schemas for Real Time Analytics with Node.js - Eric Lubow and Russell Bradberry, SimpleReach + +SimpleReach powers the Slide, a recommendation powered content discovery technology for websites. Eric Lublow will discuss how SimpleReach builds schemas in MongoDB and Node.js for powerful, real-time data delivery. Topics will include: + +* Dynamic collection creation +* Updating (Increments over sets) +* Schema +* Next gen schemas for dynamic filters + +.. raw:: html + + + +NYC MongoDB User Group - What's in the Trello +--------------------------------------------- +What's in the Trello - Brett Kiefer, Fog Creek + +Trello is a collaboration tool that organizes your projects into boards. Brett Kiefer will discuss how Trello uses Node.js, Socket.io, MongoDB, Redis, and Backbone to create a responsive single-page app. + +.. raw:: html + + + +NYC Node JS Meetup - August 2011 - Mongoose & other MongoDB Connectors +---------------------------------------------------------------------- +Mongoose Meetup August 2011 + +.. raw:: html + +
+ + + + + + + + + + + + + + + +A beautiful marriage: MongoDB and node.js +----------------------------------------- +What does it take to handle a million requests a day with sub 400ms response times? Not much when you marry the appropriate technologies. Learn how Proxlet.com leverages MongoDB & NodeJS to serve over a million daily requests.... on a $10/month server. After briefly setting describing the product context, I will discuss why we chose NodeJS & MongoDB to form the backbone of Proxlet, how the technologies play-nice & poised for scale. + +.. raw:: html + +
+ +
+ +Rapid Realtime App Development with Node.JS & MongoDB +----------------------------------------------------- +Jump on board to learn about combining two of the most exciting technologies to quickly build realtime apps yourself. This talk will introduce the popular Node.js library, Mongoose, which is a MongoDB "ORM" for Node.js. First, the speaker will deliver a quick primer on Node.js. Then, he'll walk you through Mongoose's schema api, powerful query builder, middleware capabilities, and exciting plugin ecosystem. Finally, he'll demonstrate some realtime capabilities using Node.js and Mongoose. + +.. raw:: html + +
+ + + + + + + + + + + +
+ + diff --git a/_sources/content/tutorials.txt b/_sources/content/tutorials.txt new file mode 100644 index 00000000000..d9f84d8df3d --- /dev/null +++ b/_sources/content/tutorials.txt @@ -0,0 +1,33 @@ +=================================== +Tutorials using Node.JS and MongoDB +=================================== + +Node.js and MongoDB Tutorial - Using CoffeeScript and Mongoose (ODM) +-------------------------------------------------------------------- +This is a brief tutorial on how to use Node.js (using CoffeeScript) to connect to a MongoDB (using Mongoose) for a small project I am working on with a group of awesome students. + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + +
Part 1/6 of the tutorialPart 2/6 of the tutorial
Part 3/6 of the tutorialPart 4/6 of the tutorial
Part 5/6 of the tutorialPart 6/6 of the tutorial
diff --git a/docs/sphinx-docs/source/contents.rst b/_sources/contents.txt similarity index 95% rename from docs/sphinx-docs/source/contents.rst rename to _sources/contents.txt index 52a2786da8e..2165ad3cf23 100644 --- a/docs/sphinx-docs/source/contents.rst +++ b/_sources/contents.txt @@ -5,6 +5,7 @@ Node.JS MongoDB Driver Manual Contents .. toctree:: :maxdepth: 3 + api-generated/mongoclient api-generated/db api-generated/collection api-generated/admin diff --git a/_sources/driver-articles/anintroductionto1_1and2_2.txt b/_sources/driver-articles/anintroductionto1_1and2_2.txt new file mode 100644 index 00000000000..25d3e06d6ba --- /dev/null +++ b/_sources/driver-articles/anintroductionto1_1and2_2.txt @@ -0,0 +1,361 @@ +====================================== +Mongo Driver and Mongo DB 2.2 Features +====================================== + + For Mongo DB there are multiple new features and improvements in the driver. This include Mongos failover support, authentication, replicaset support, read preferences and aggregation. Let's move throught the different new features starting with. + + +---------------- +Read preferences +---------------- + + Read preferences is now backed by a specification and is more consistent across drivers. With read preferences you can control from where your Reads are happing in a Replicaset and from Mongo DB also in a shard. Let's go through the different types of read Preferences that are available and what they mean. + + + * **ReadPreference.PRIMARY:** Read from primary only. All operations produce an error (throw an exception where applicable) if primary is unavailable. Cannot be combined with tags **(This is the default.)** + * **ReadPreference.PRIMARY_PREFERRED:** Read from primary if available, otherwise a secondary. + * **ReadPreference.SECONDARY:** Read from secondary if available, otherwise error. + * **ReadPreference.SECONDARY_PREFERRED:** Read from a secondary if available, otherwise read from the primary. + * **ReadPreference.NEAREST:** All modes read from among the nearest candidates, but unlike other modes, NEAREST will include both the primary and all secondaries in the random selection. The name NEAREST is chosen to emphasize its use, when latency is most important. For I/O-bound users who want to distribute reads across all members evenly regardless of ping time, set secondaryAcceptableLatencyMS very high. See "Ping Times" below. **A strategy must be enabled on the ReplSet instance to use NEAREST as it requires intermittent setTimeout events, see Db class documentation** + + + + Additionally you can now use tags with all the read preferences to actively choose specific sets of servers in a replicatset or sharded system located in different data centers. The rules are fairly simple as outline below. A server member matches a tag set if its tags match all the tags in the set. For example, a member tagged **{ dc: 'ny', rack: 2, size: 'large' }** matches the tag set **{ dc: 'ny', rack: 2 }** . A member's extra tags don't affect whether it's a match. + + + + Using a read preference is very simple. Below are some examples using it at the db level, collection level and individual query level as well as an example using tags. + + + + Below is a simple example using readpreferences at the db level. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , format = require('util').format; + + var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s" + , "localhost:27017", + , "localhost:27018" + , "localhost:27019" + , "exampleDb" + , "foo" + , "secondaryPreferred"); + + MongoClient.connect(url, function(err db) { + if(!err) { + console.log("We are connected"); + } + }); + + + + Below is a simple example using readpreferences at the collection level. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , format = require('util').format; + + var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s" + , "localhost:27017", + , "localhost:27018" + , "localhost:27019" + , "exampleDb" + , "foo" + , "secondaryPreferred"); + + MongoClient.connect(url, function(err db) { + if(!err) { + console.log("We are connected"); + + var collection = db.collection('somecollection', {readPreference: ReadPreference.SECONDARY_PREFERRED}); + collection.find({}).toArray(function(err, items) { + // Done reading from secondary if available + }) + } + }); + + + + Below is a simple example using readpreferences at the query level. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , format = require('util').format; + + var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s" + , "localhost:27017", + , "localhost:27018" + , "localhost:27019" + , "exampleDb" + , "foo" + , "secondaryPreferred"); + + MongoClient.connect(url, function(err db) { + if(!err) { + console.log("We are connected"); + + var collection = db.collection('somecollection'); + collection.find({}).setReadPreference(new ReadPreference(ReadPreference.SECONDARY_PREFERRED)).toArray(function(err, items) { + // Done reading from secondary if available + }) + } + }); + + + + Below is a simple example using a readpreference with tags at the query level. This example will pick from the set of servers tagged with **dc1:ny** . + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , format = require('util').format; + + var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s" + , "localhost:27017", + , "localhost:27018" + , "localhost:27019" + , "exampleDb" + , "foo" + , "secondaryPreferred"); + + MongoClient.connect(url, function(err db) { + if(!err) { + console.log("We are connected"); + + var collection = db.collection('somecollection'); + collection.find({}).setReadPreference(new ReadPreference(ReadPreference.SECONDARY_PREFERRED, {"dc1":"ny"})).toArray(function(err, items) { + // Done reading from secondary if available + }) + } + }); + + +------ +Mongos +------ + + There is now a seperate Server type for Mongos that handles not only Mongos read preferences for Mongo DB but also failover and picking the nearest Mongos proxy to your application. To use simply do + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , format = require('util').format; + + var url = format("mongodb://%s,%s/%s" + , "localhost:50000", + , "localhost:50001" + , "exampleDb"); + + MongoClient.connect(url, function(err db) { + if(!err) { + console.log("We are connected"); + } + + db.close(); + }); + + + + Read preferences also work with Mongos from Mongo DB 2.2 or higher allowing you to create more complex deployment setups. + + +---------------------------- +Aggregation framework helper +---------------------------- + + The MongoDB aggregation framework provides a means to calculate aggregate values without having to use map-reduce. While map-reduce is powerful, using map-reduce is more difficult than necessary for many simple aggregation tasks, such as totaling or averaging field values. + + + + The driver supports the aggregation framework by adding a helper at the collection level to execute an aggregation pipeline against the documents in that collection. Below is a simple example of using the aggregation framework to perform a group by tags. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient; + + // Some docs for insertion + var docs = [{ + title : "this is my title", author : "bob", posted : new Date() , + pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 }, + comments : [ + { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" } + ]}]; + + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + // Create a collection + db.createCollection('test', function(err, collection) { + // Insert the docs + collection.insert(docs, {safe:true}, function(err, result) { + + // Execute aggregate, notice the pipeline is expressed as an Array + collection.aggregate([ + { $project : { + author : 1, + tags : 1 + }}, + { $unwind : "$tags" }, + { $group : { + _id : {tags : "$tags"}, + authors : { $addToSet : "$author" } + }} + ], function(err, result) { + console.dir(result); + db.close(); + }); + }); + }); + }); + + +----------------------------------- +Replicaset improvements and changes +----------------------------------- + + Replicasets now return to the driver when a primary has been identified allowing for faster connect time meaning the application does not have to wait for the whole set to be identified before being able to run. That said any secondary queries using read preference **ReadPreference.SECONDARY** might fail until at least one secondary is up. To aid in development of layers above the driver now emits to new events. + + + * **open** is emitted when the driver is ready to be used. + * **fullsetup** is emitted once the whole replicaset is up and running + + + + To ensure better control over timeouts when attempting to connect to replicaset members that might be down there is now two timeout settings. + + + * **connectTimeoutMS:** set the timeout for the intial connect to the mongod or mongos instance. + * **socketTimeoutMS:** set the timeout for established connections to the mongod or mongos instance. + + +--------------------------------- +High availability "on" by default +--------------------------------- + + The high availability code has been rewritten to run outside a setTimeout allowing for better control and handling. It's also on by default now. It can be disabled using the following settings on the ReplSet class. + + + * **ha** {Boolean, default:true}, turn on high availability. + * **haInterval** {Number, default:2000}, time between each replicaset status check. + + This allows the driver to discover new replicaset members or replicaset members who left the set and then returned. + + +-------------------------------- +Better stream support for GridFS +-------------------------------- + + GridFS now supports the streaming api's for node allowing you to pipe content either into or out of a Gridstore object making it easy to work with other streaming api's available. + + + + A simple example is shown below for how to stream from a file on disk to a gridstore object. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , fs = require('fs') + , GridStore = mongo.GridStore; + + // Some docs for insertion + var docs = [{ + title : "this is my title", author : "bob", posted : new Date() , + pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 }, + comments : [ + { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" } + ]}]; + + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + // Set up gridStore + var gridStore = new GridStore(client, "test_stream_write", "w"); + // Create a file reader stream to an object + var fileStream = fs.createReadStream("./test/gridstore/test_gs_working_field_read.pdf"); + gridStore.on("close", function(err) { + // Just read the content and compare to the raw binary + GridStore.read(client, "test_stream_write", function(err, gridData) { + var fileData = fs.readFileSync("./test/gridstore/test_gs_working_field_read.pdf"); + test.deepEqual(fileData, gridData); + test.done(); + }) + }); + + // Pipe it through to the gridStore + fileStream.pipe(gridStore); + }) + + + + A simple example is shown below for how to stream from a gridfs file to a file on disk. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , fs = require('fs') + , GridStore = mongo.GridStore; + + MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) { + // Set up gridStore + var gridStore = new GridStore(client, "test_stream_write_2", "w"); + gridStore.writeFile("./test/gridstore/test_gs_working_field_read.pdf", function(err, result) { + // Open a readable gridStore + gridStore = new GridStore(client, "test_stream_write_2", "r"); + // Create a file write stream + var fileStream = fs.createWriteStream("./test_stream_write_2.tmp"); + fileStream.on("close", function(err) { + // Read the temp file and compare + var compareData = fs.readFileSync("./test_stream_write_2.tmp"); + var originalData = fs.readFileSync("./test/gridstore/test_gs_working_field_read.pdf"); + test.deepEqual(originalData, compareData); + test.done(); + }) + // Pipe out the data + gridStore.pipe(fileStream); + }); + }) + + +------------- +toBSON method +------------- + + If in an object now has a toBSON function it will be called to for custom serialization of the object instance. This can be used to just serialize wanted fields. Deserializing is not affected by this and the application is responsible for deflating objects again. + + + + A simple example below + + + .. code-block:: javascript + + var customObject = { + a:1 + b:2 + toBSON: function() { + return {a:this.a} + } + } + + +--------------------------- +Much faster BSON C++ parser +--------------------------- + + Thanks to the awesome people at Lucasfilm Singapore we have a new BSON C++ serializer/deserializer that performs on average 40-50% faster than the current implementation. + + +------------------- +Other minor changes +------------------- + * Connection pool is now set to 5 by default. Override if there is need for either a bigger or smaller pool per node process. + * Gridfs now ensures an index on the chunks collection on file_id. + diff --git a/_sources/driver-articles/index.txt b/_sources/driver-articles/index.txt new file mode 100644 index 00000000000..ecf95659ccb --- /dev/null +++ b/_sources/driver-articles/index.txt @@ -0,0 +1,9 @@ +================== +Updates +================== + +.. toctree:: + :maxdepth: 2 + + mongoclient + anintroductionto1_1and2_2 diff --git a/_sources/driver-articles/mongoclient.txt b/_sources/driver-articles/mongoclient.txt new file mode 100644 index 00000000000..f86ae80641c --- /dev/null +++ b/_sources/driver-articles/mongoclient.txt @@ -0,0 +1,273 @@ +===================================================== +MongoClient or how to connect in a new and better way +===================================================== + + From driver version **1.2** we are introduction a new connection Class that has the same name across all out official drivers. This is to ensure that we present a recognizable front for all our API's. This does not mean you existing application will break but that we encourage you to use the new connection api to simplify your application development. + + + + Further more we are making the new connection class **MongoClient** acknowledge all write to MongoDB in contrast to the existing connection class Db that has acknowledgements turned off. Let's take a tour of the MongoClient functions. + + + .. code-block:: javascript + + MongoClient = function(server, options); + + MongoClient.prototype.open + + MongoClient.prototype.close + + MongoClient.prototype.db + + MongoClient.connect + + + + Outlined above is the complete MongoClient interface. The methods **open** , **close** and **db** work very similar to the existing methods on the **Db** class. The main difference if you noticed is that the constructor is missing the **database name** from Db. Let's show a simple connection using **open** as a code example speaks a thousand words. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient + , Server = require('mongodb').Server; + + var mongoClient = new MongoClient(new Server('localhost', 27017)); + mongoClient.open(function(err, mongoClient) { + var db1 = mongoClient.db("mydb"); + + mongoClient.close(); + }); + + + + Notice that you configure the MongoClient just as you would have done the Db object. The main difference is that you access the db instances using the **db** method on the MongoClient object instead of using the Db instance directly as you would previously. Don't that seem more intuitive then the previous API. Also MongoClient supports the same options as the previous Db instance you would have created. + + + + So with a minimal change in our app we can apply the new MongoClient connection code. But there is more and one direction you might consider int the future. That is the mongodb connection string. + + +------------------------- +The URL connection format +------------------------- + .. code-block:: javascript + + mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]] + + + + The URL format is unified across official drivers from 10gen with some options not supported on some driver due to natural reasons. The ones not supported by the Node.js driver are left out for simplicities sake. + + + * **mongodb://** is a required prefix to identify that this is a string in the standard connection format. + * **username:password@** are optional. If given, the driver will attempt to login to a database after connecting to a database server. + * **host1** is the only required part of the URI. It identifies either a hostname, IP address, or unix domain socket + * **:portX** is optional and defaults to :27017 if not provided. + * **/database** is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default. + * **?options** are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". For any unrecognized or unsupported option, a driver should log a warning and continue processing. A driver should not support any options that are not explicitly defined in this specification. This is in order to reduce the likelihood that different drivers will support overlapping that differ in small but incompatible ways (like different name, different values, or different default value). + + + * **replicaSet=name** * The driver verifies that the name of the replica set it connects to matches this name. Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set. * No default value. + + + * **ssl=true|false|prefer** + * true: the driver initiates each connections with SSL * false: the driver initiates each connection without SSL * prefer: the driver tries to initiate each connection with SSL, and falls back to without SSL if it fails. * Default value is false. + * **connectTimeoutMS=ms** + * How long a connection can take to be opened before timing out. * Current driver behavior already differs on this, so default must be left to each driver. For new implementations, the default should be to never timeout. + * **socketTimeoutMS=ms** + * How long a send or receive on a socket can take before timing out. * Current driver behavior already differs on this, so default must be left to each driver. For new implementations, the default should be to never timeout. + + + * **maxPoolSize=n:** The maximum number of connections in the connection pool * Default value is 5 + + + + More detailed information about write concerns can be found at `http://www.mongodb.org/display/DOCS/getLastError+Command `_ + + + * **w=wValue** + * For numeric values above 1, the driver adds { w : wValue } to the getLastError command. * wValue is typically a number, but can be any string in order to allow for specifications like "majority" * Default value is 1. + * wValue == -1 ignore network errors * wValue == 0 no write acknowledgement * wValue == 1 perform a write acknowledgement * wValue == 2 perform a write acknowledgement across primary and one secondary * wValue == 'majority' perform a write acknowledgement across the majority of servers in the replicaset * wValue == 'tag name' perform a write acknowledgement against the replicaset tag name + * **wtimeoutMS=ms** + * The driver adds { wtimeout : ms } to the getlasterror command. * Used in combination with w * No default value + * **journal=true|false** + * true: Sync to journal. * false: the driver does not add j to the getlasterror command * Default value is false + * **fsync=true|false** + * true: Sync to disk. * false: the driver does not add fsync to the getlasterror command * Default value is false * If conflicting values for fireAndForget, and any write concern are passed the driver should raise an exception about the conflict. + + + * **authSource=string:** Used when the user for authentication is stored in another database using indirect authentication. * Default value is null + + + * **slaveOk=true|false:** Whether a driver connected to a replica set will send reads to slaves/secondaries. + * Default value is false + * **readPreference=enum:** The read preference for this connection. If set, it overrides any slaveOk value. + * Enumerated values: * primary * primaryPreferred * secondary * secondaryPreferred * nearest * Default value is primary + * **readPreferenceTags=string.** A representation of a tag set as a comma-separated list of colon-separated key-value pairs, e.g. **dc:ny,rack:1** . Spaces should be stripped from beginning and end of all keys and values. To specify a list of tag sets, using multiple readPreferenceTags, e.g. **readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny&readPreferenceTags=** + * Note the empty value, it provides for fallback to any other secondary server if none is available * Order matters when using multiple readPreferenceTags * There is no default value + + +------------------- +MongoClient.connect +------------------- + + The url format can be used with MongoClient.connect. Where possible MongoClient will pick the best possible default values for options but they can be overridden. This includes setting **auto_reconnect to true** and **native_parser to true if it's available** . Below are some example on how to connect to a single server a replicaset and a sharded system using **MongoClient.connect** + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient; + + MongoClient.connect("mongodb://localhost:27017/integration_test", function(err, db) { + test.equal(null, err); + test.ok(db != null); + + db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) { + test.equal(null, err); + test.equal(1, result); + + db.close(); + test.done(); + }); + }); + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient; + + MongoClient.connect("mongodb://localhost:30000,localhost:30001/integration_test_?w=0&readPreference=secondary", function(err, db) { + test.equal(null, err); + test.ok(db != null); + + db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) { + test.equal(null, err); + test.equal(1, result); + + db.close(); + test.done(); + }); + }); + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient; + + MongoClient.connect("mongodb://localhost:50000,localhost:50001/integration_test_?w=0&readPreference=secondary", function(err, db) { + test.equal(null, err); + test.ok(db != null); + + db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) { + test.equal(null, err); + test.equal(1, result); + + db.close(); + test.done(); + }); + }); + + + + Notice that when connecting to the sharded system it's pretty much the same url as for connecting to the replicaset. This is because the driver itself figures out if it's a replicaset or a set of Mongos proxies it's connecting to. No special care is needed to specify if it's one or the other. This is in contrast to having to use the **ReplSet** or **Mongos** instances when using the **open** command. + + +--------------------------- +MongoClient.connect options +--------------------------- + + The connect function also takes a hash of options divided into db/server/replset/mongos allowing you to tweak options not directly supported by the unified url string format. To use these options you do pass in a has like this. + + + .. code-block:: javascript + + var MongoClient = require('mongodb').MongoClient; + + MongoClient.connect("mongodb://localhost:27017/integration_test_?", { + db: { + native_parser: false + }, + server: { + socketOptions: { + connectTimeoutMS: 500 + } + }, + replSet: {}, + mongos: {} + }, function(err, db) { + test.equal(null, err); + test.ok(db != null); + + db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) { + test.equal(null, err); + test.equal(1, result); + + db.close(); + test.done(); + }); + }); + + + + Below are all the options supported for db/server/replset/mongos. + + +---------------------------------------------------------------------------------------------------- +db: A hash of options at the db level overriding or adjusting functionality not supported by the url +---------------------------------------------------------------------------------------------------- + * **w** , {Number/String, > -1 || 'majority'} the write concern for the operation where < 1 is no acknowledgment of write and w >= 1 or w = 'majority' acknowledges the write + * **wtimeout** , {Number, 0} set the timeout for waiting for write concern to finish (combines with w option) + * **fsync** , (Boolean, default:false) write waits for fsync before returning + * **journal** , (Boolean, default:false) write waits for journal sync before returning + * **readPreference** {String}, the preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY *PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY* PREFERRED, ReadPreference.NEAREST). + * **native_parser** {Boolean, default:false}, use c++ bson parser. + * **forceServerObjectId** {Boolean, default:false}, force server to create _id fields instead of client. + * **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. + * **serializeFunctions** {Boolean, default:false}, serialize functions. + * **raw** {Boolean, default:false}, perform operations using raw bson buffers. + * **recordQueryStats** {Boolean, default:false}, record query statistics during execution. + * **retryMiliSeconds** {Number, default:5000}, number of milliseconds between retries. + * **numberOfRetries** {Number, default:5}, number of retries off connection. + + +----------------------------------------------------------------------- +server: A hash of options at the server level not supported by the url. +----------------------------------------------------------------------- + .. code-block:: javascript + + * **readPreference** {String, default:null}, set's the read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST) + * **ssl** {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support) + * **slaveOk** {Boolean, default:false}, legacy option allowing reads from secondary, use **readPrefrence** instead. + * **poolSize** {Number, default:1}, number of connections in the connection pool, set to 1 as default for legacy reasons. + * **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number)) + * **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**. + * **auto_reconnect** {Boolean, default:false}, reconnect on error. + * **disableDriverBSONSizeCheck** {Boolean, default:false}, force the server to error if the BSON message is to big + + +------------------------------------------------------------------------- +replSet: A hash of options at the replSet level not supported by the url. +------------------------------------------------------------------------- + .. code-block:: javascript + + * **ha** {Boolean, default:true}, turn on high availability. + * **haInterval** {Number, default:2000}, time between each replicaset status check. + * **reconnectWait** {Number, default:1000}, time to wait in milliseconds before attempting reconnect. + * **retries** {Number, default:30}, number of times to attempt a replicaset reconnect. + * **rs_name** {String}, the name of the replicaset to connect to. + * **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number)) + * **readPreference** {String}, the preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). + * **strategy** {String, default:null}, selection strategy for reads choose between (ping and statistical, default is round-robin) + * **secondaryAcceptableLatencyMS** {Number, default:15}, sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms) + * **connectArbiter** {Boolean, default:false}, sets if the driver should connect to arbiters or not. + + +----------------------------------------------------------------------- +mongos: A hash of options at the mongos level not supported by the url. +----------------------------------------------------------------------- + .. code-block:: javascript + + * **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number)) + * **ha** {Boolean, default:true}, turn on high availability, attempts to reconnect to down proxies + * **haInterval** {Number, default:2000}, time between each replicaset status check. + diff --git a/_sources/github/github.txt b/_sources/github/github.txt new file mode 100644 index 00000000000..7d5bcce231d --- /dev/null +++ b/_sources/github/github.txt @@ -0,0 +1,1044 @@ +============================================== +Github libraries and projects using the driver +============================================== + +Web frameworks using MongoDB +---------------------------- + +.. topic:: nwt + + Node Web Toolkit - nwt is a modern javascript framework. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 21:2:6 on 11/10/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/nwtjs/nwt + * - **Clone Url** + - https://github.com/nwtjs/nwt.git + * - **Forks** + - 4 + * - **Watchers** + - 16 + +.. topic:: caboose + + Coffeescript-happy express-based server-side MVC framework loosely based on rails + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 6:56:54 on 16/11/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/mattinsler/caboose + * - **Clone Url** + - https://github.com/mattinsler/caboose.git + * - **Forks** + - 6 + * - **Watchers** + - 17 + +.. topic:: node-bread + + file based static website/blog generator + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 23:50:52 on 7/7/2012 + * - **Homepage** + - http://https://npmjs.org/package/bread + * - **Url** + - https://github.com/pvorb/node-bread + * - **Clone Url** + - https://github.com/pvorb/node-bread.git + * - **Forks** + - 3 + * - **Watchers** + - 3 + +.. topic:: arrjs + + HTTP and WebSocket application routing + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 17:2:2 on 8/1/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/tjanczuk/arrjs + * - **Clone Url** + - https://github.com/tjanczuk/arrjs.git + * - **Forks** + - 2 + * - **Watchers** + - 25 + +Object Document Modeling Libraries +---------------------------------- + +.. topic:: noid + + ODM for MongoDB/Node.js with CoffeeScript + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 1:20:59 on 22/11/2010 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/chrisgibson/noid + * - **Clone Url** + - https://github.com/chrisgibson/noid.git + * - **Forks** + - 1 + * - **Watchers** + - 8 + +.. topic:: mongoose + + Node.JS MongoDB utility library with ORM-like functionality + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 3:40:3 on 14/2/2013 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/LearnBoost/mongoose + * - **Clone Url** + - https://github.com/LearnBoost/mongoose.git + * - **Forks** + - 378 + * - **Watchers** + - 2883 + +.. topic:: mongo-model + + Model for MongoDB (Node.JS) + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 11:37:19 on 1/6/2012 + * - **Homepage** + - http://http://alexeypetrushin.github.com/mongo-model + * - **Url** + - https://github.com/alexeypetrushin/mongo-model + * - **Clone Url** + - https://github.com/alexeypetrushin/mongo-model.git + * - **Forks** + - 5 + * - **Watchers** + - 51 + +.. topic:: leaf + + A MongoDB ORM for Node + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 20:2:4 on 29/7/2010 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/colladow/leaf + * - **Clone Url** + - https://github.com/colladow/leaf.git + * - **Forks** + - 1 + * - **Watchers** + - 6 + +Content Management Systems +-------------------------- + +.. topic:: nocr-mongo + + nodejs Content Repository implementation for mongodb + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 6:25:45 on 18/3/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/karacos/nocr-mongo + * - **Clone Url** + - https://github.com/karacos/nocr-mongo.git + * - **Forks** + - 0 + * - **Watchers** + - 4 + +.. topic:: calipso + + Calipso is a simple NodeJS content management system based on Express, Connect & Mongoose. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 3:51:41 on 25/0/2013 + * - **Homepage** + - http://calip.so + * - **Url** + - https://github.com/cliftonc/calipso + * - **Clone Url** + - https://github.com/cliftonc/calipso.git + * - **Forks** + - 183 + * - **Watchers** + - 1045 + +Grid FS libraries or tools +-------------------------- + +.. topic:: nettle + + On-the-fly processing framework for Node.js and MongoDB + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 20:36:16 on 11/6/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/scttnlsn/nettle + * - **Clone Url** + - https://github.com/scttnlsn/nettle.git + * - **Forks** + - 0 + * - **Watchers** + - 9 + +Wrapper libraries to ease the use of development or provide simple ODM like behaviours +-------------------------------------------------------------------------------------- + +.. topic:: node-mongoskin + + The future layer for node-mongodb-native. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 3:50:53 on 4/7/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/guileen/node-mongoskin + * - **Clone Url** + - https://github.com/guileen/node-mongoskin.git + * - **Forks** + - 7 + * - **Watchers** + - 41 + +.. topic:: mongoq + + Use mongoDB like this: mongoq('mongodb://localhost/db').collection('users').find().toArray(function(error, docs){}); + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 7:17:31 on 19/11/2011 + * - **Homepage** + - http://http://zzdhidden.github.com/mongoq + * - **Url** + - https://github.com/zzdhidden/mongoq + * - **Clone Url** + - https://github.com/zzdhidden/mongoq.git + * - **Forks** + - 2 + * - **Watchers** + - 54 + +.. topic:: mongolia + + Flexible non-magical layer for the nodejs MongoDB driver + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 14:3:17 on 3/11/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/masylum/mongolia + * - **Clone Url** + - https://github.com/masylum/mongolia.git + * - **Forks** + - 12 + * - **Watchers** + - 105 + +.. topic:: mongojs + + a simple mongo module that implements the mongo api + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 0:14:0 on 14/2/2013 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/gett/mongojs + * - **Clone Url** + - https://github.com/gett/mongojs.git + * - **Forks** + - 39 + * - **Watchers** + - 326 + +.. topic:: mongode + + Thin wrapper around node-mongodb-native that provides a simpler alternative calling style and provides collection binding. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 14:17:30 on 29/7/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/milewise/mongode + * - **Clone Url** + - https://github.com/milewise/mongode.git + * - **Forks** + - 7 + * - **Watchers** + - 56 + +.. topic:: node-mongodb-wrapper + + A wrapper for node-mongodb-native as close as possible to the command-line javascript driver. Why learn two interfaces? + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 19:38:37 on 24/0/2013 + * - **Homepage** + - http://http://i.tv + * - **Url** + - https://github.com/idottv/node-mongodb-wrapper + * - **Clone Url** + - https://github.com/idottv/node-mongodb-wrapper.git + * - **Forks** + - 9 + * - **Watchers** + - 45 + +.. topic:: mdoq-mongodb + + simplified mongodb-native api w/ middleware + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 17:56:15 on 29/4/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/ritch/mdoq-mongodb + * - **Clone Url** + - https://github.com/ritch/mdoq-mongodb.git + * - **Forks** + - 0 + * - **Watchers** + - 3 + +.. topic:: ferret + + Adorable mongodb library for node.js + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 15:2:55 on 2/7/2011 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/Coreh/ferret + * - **Clone Url** + - https://github.com/Coreh/ferret.git + * - **Forks** + - 3 + * - **Watchers** + - 9 + +.. topic:: easymongo + + Easy MongoDB + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 16:28:18 on 8/0/2013 + * - **Homepage** + - http://http://simonenko.su/projects/easymongo + * - **Url** + - https://github.com/meritt/easymongo + * - **Clone Url** + - https://github.com/meritt/easymongo.git + * - **Forks** + - 3 + * - **Watchers** + - 12 + +REST api's around MongoDB or resource based libraries +----------------------------------------------------- + +.. topic:: mongodb-rest + + REST Server for MongoDB (using node.js) + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 21:12:16 on 20/11/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/tdegrunt/mongodb-rest + * - **Clone Url** + - https://github.com/tdegrunt/mongodb-rest.git + * - **Forks** + - 50 + * - **Watchers** + - 212 + +.. topic:: lazyBum + + Node.js RESTful web framework. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 3:35:54 on 10/11/2011 + * - **Homepage** + - http://http://streetsaheadllc.com + * - **Url** + - https://github.com/streets-ahead/lazyBum + * - **Clone Url** + - https://github.com/streets-ahead/lazyBum.git + * - **Forks** + - 1 + * - **Watchers** + - 2 + +.. topic:: GECK + + A lightweight, resource-based API framework for node.js + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 17:22:29 on 23/7/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/Qard/GECK + * - **Clone Url** + - https://github.com/Qard/GECK.git + * - **Forks** + - 1 + * - **Watchers** + - 10 + +Test helpers and libraries +-------------------------- + +.. topic:: mongodb-fixtures + + Fixtures for mongodb + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 9:59:58 on 10/5/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/tdegrunt/mongodb-fixtures + * - **Clone Url** + - https://github.com/tdegrunt/mongodb-fixtures.git + * - **Forks** + - 1 + * - **Watchers** + - 9 + +.. topic:: node-database-cleaner + + The simplest way to clean your database after tests + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 12:35:16 on 7/4/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/emerleite/node-database-cleaner + * - **Clone Url** + - https://github.com/emerleite/node-database-cleaner.git + * - **Forks** + - 8 + * - **Watchers** + - 37 + +Tools or applications to manage your MongoDB's +---------------------------------------------- + +.. topic:: mon4mongo + + MongoDB management web server boosted with nodejs & express. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 7:35:50 on 13/2/2013 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/erhangundogan/mon4mongo + * - **Clone Url** + - https://github.com/erhangundogan/mon4mongo.git + * - **Forks** + - 0 + * - **Watchers** + - 6 + +Queue libraries using MongoDB +----------------------------- + +.. topic:: mojo + + Node.js job queue backed by MongoDB + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 17:16:38 on 24/1/2013 + * - **Homepage** + - http://http://wereHamster.github.com/mojo + * - **Url** + - https://github.com/wereHamster/mojo + * - **Clone Url** + - https://github.com/wereHamster/mojo.git + * - **Forks** + - 3 + * - **Watchers** + - 10 + +.. topic:: karait + + A ridiculously simple queuing system, with clients in various languages, built on top of MongoDB. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 20:21:36 on 4/11/2011 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/bcoe/karait + * - **Clone Url** + - https://github.com/bcoe/karait.git + * - **Forks** + - 6 + * - **Watchers** + - 77 + +Logging libraries or applications +--------------------------------- + +.. topic:: logmeup-server + + LogMeUp Server - View any log files real-time in your web browser. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 21:53:23 on 17/4/2012 + * - **Homepage** + - http://http://logmeup.com + * - **Url** + - https://github.com/jprichardson/logmeup-server + * - **Clone Url** + - https://github.com/jprichardson/logmeup-server.git + * - **Forks** + - 0 + * - **Watchers** + - 6 + +.. topic:: nodeEventStore + + EventStore Implementation in node.js + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 10:14:54 on 10/4/2012 + * - **Homepage** + - http://http:/jamuhl.github.com/nodeEventStore/ + * - **Url** + - https://github.com/KABA-CCEAC/nodeEventStore + * - **Clone Url** + - https://github.com/KABA-CCEAC/nodeEventStore.git + * - **Forks** + - 2 + * - **Watchers** + - 4 + +.. topic:: devnull + + dev/null, a powerful logging module for Node.js.. Because logging to dev/null is fast! <3 + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 9:53:54 on 2/0/2013 + * - **Homepage** + - http://dev/null + * - **Url** + - https://github.com/observing/devnull + * - **Clone Url** + - https://github.com/observing/devnull.git + * - **Forks** + - 0 + * - **Watchers** + - 21 + +Monitoring applications or libraries +------------------------------------ + +.. topic:: Informant + + A node based server monitor to get real-time status of your ops... + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 21:20:40 on 31/0/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/base698/Informant + * - **Clone Url** + - https://github.com/base698/Informant.git + * - **Forks** + - 0 + * - **Watchers** + - 16 + +General frameworks over MongoDB +------------------------------- + +.. topic:: DJS + + A media sharing framework. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 22:48:0 on 14/2/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/khwang/DJS + * - **Clone Url** + - https://github.com/khwang/DJS.git + * - **Forks** + - 4 + * - **Watchers** + - 23 + +.. topic:: databank + + NoSQL abstraction layer for Node.js + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 15:40:19 on 14/0/2013 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/evanp/databank + * - **Clone Url** + - https://github.com/evanp/databank.git + * - **Forks** + - 2 + * - **Watchers** + - 48 + +Translation libraries or frameworks +----------------------------------- + +.. topic:: dialect-http + + http client to manage your dialect translations + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 1:43:11 on 8/11/2011 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/masylum/dialect-http + * - **Clone Url** + - https://github.com/masylum/dialect-http.git + * - **Forks** + - 8 + * - **Watchers** + - 27 + +.. topic:: dialect + + Translations for nodejs + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 9:21:6 on 22/2/2012 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/masylum/dialect + * - **Clone Url** + - https://github.com/masylum/dialect.git + * - **Forks** + - 22 + * - **Watchers** + - 102 + +Libraries or Applications for analytics +--------------------------------------- + +.. topic:: cube + + Cube: A system for time series visualization. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 2:33:34 on 8/1/2013 + * - **Homepage** + - http://http://square.github.com/cube + * - **Url** + - https://github.com/square/cube + * - **Clone Url** + - https://github.com/square/cube.git + * - **Forks** + - 243 + * - **Watchers** + - 2458 + +Libraries for the connect middleware +------------------------------------ + +.. topic:: connect-session-mongo + + MongoDB Session Storage for Connect Middleware + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 5:6:21 on 24/2/2012 + * - **Homepage** + - http://https://github.com/bartt/connect-session-mongo + * - **Url** + - https://github.com/bartt/connect-session-mongo + * - **Clone Url** + - https://github.com/bartt/connect-session-mongo.git + * - **Forks** + - 8 + * - **Watchers** + - 14 + +.. topic:: connect-mongodb + + SessionStorage for connect's session middleware + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 17:52:14 on 21/0/2013 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/masylum/connect-mongodb + * - **Clone Url** + - https://github.com/masylum/connect-mongodb.git + * - **Forks** + - 60 + * - **Watchers** + - 178 + +.. topic:: connect-mongo + + MongoDB session store for Connect. + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/active.png + * - **Last push** + - 15:2:26 on 21/0/2013 + * - **Homepage** + - http://http://kcbanner.github.com/connect-mongo/ + * - **Url** + - https://github.com/kcbanner/connect-mongo + * - **Clone Url** + - https://github.com/kcbanner/connect-mongo.git + * - **Forks** + - 67 + * - **Watchers** + - 207 + +Libraries or applications for continous integration +--------------------------------------------------- + +.. topic:: concrete + + Simple continuous integration server written with NodeJS and CoffeeScript + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 20:18:30 on 9/6/2012 + * - **Homepage** + - http://http://ryankee.github.com/concrete + * - **Url** + - https://github.com/ryankee/concrete + * - **Clone Url** + - https://github.com/ryankee/concrete.git + * - **Forks** + - 39 + * - **Watchers** + - 248 + +Exampe applications +------------------- + +.. topic:: nodejs-blackboard + + Testing nodejs (with socket.io) + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 3:50:52 on 4/6/2012 + * - **Homepage** + - http://node.kamikazepanda.com + * - **Url** + - https://github.com/gotik/nodejs-blackboard + * - **Clone Url** + - https://github.com/gotik/nodejs-blackboard.git + * - **Forks** + - 8 + * - **Watchers** + - 27 + +.. topic:: node-mongo-cms + + standard blog written in nodejs (express) and mongodb + + .. list-table:: + :widths: 25 85 + :header-rows: 0 + + * - **Activity Level** + - .. image:: ../static/nonactive.png + * - **Last push** + - 19:8:38 on 30/9/2011 + * - **Homepage** + - http:// + * - **Url** + - https://github.com/dynamicguy/node-mongo-cms + * - **Clone Url** + - https://github.com/dynamicguy/node-mongo-cms.git + * - **Forks** + - 0 + * - **Watchers** + - 5 + diff --git a/_sources/index.txt b/_sources/index.txt new file mode 100644 index 00000000000..686a0d0e5b3 --- /dev/null +++ b/_sources/index.txt @@ -0,0 +1,97 @@ +================================= +The Node.JS MongoDB Driver Manual +================================= + +Usage +----- + +.. toctree:: + :maxdepth: 1 + + markdown-docs/index + +Driver Updates +-------------- + +.. toctree:: + :maxdepth: 3 + + driver-articles/index + + +Tutorials +--------- + +.. toctree:: + :maxdepth: 3 + + api-articles/index + +API Documentation +----------------- + +.. toctree:: + :maxdepth: 2 + + api-generated/index + api-bson-generated/index + + +External Tutorials +------------------ + + * http://howtonode.org/express-mongodb, Blog rolling with mongoDB, express and Node.js + * http://nodetuts.com/tutorials/18-mongodb-and-mongoose.html, Node Tuts - episode 18 - Node.js, MongoDB and Mongoose from Pedro Teixeira on Vimeo. + * http://howtonode.org/node-js-and-mongodb-getting-started-with-mongojs, Node.js and MongoDB - Getting started with MongoJS + +Video Presentations about different topics around the MongoDB and Node.js +------------------------------------------------------------------------- + +.. toctree:: + :maxdepth: 3 + + content/nodejsvideo + content/awesomeappsvideo + content/tutorials + +Projects and Libraries using the driver +--------------------------------------- + +.. toctree:: + :maxdepth: 1 + + github/github + +MongoDB in General +------------------ +There are two main places to learn about MongoDB itself. I've included links below. + + * http://www.mongodb.org, all the documentation for the database + * http://www.10gen.com/presentations, lots of presentations and slides about using the database. + +There are also some very good books out these days + + * `MongoDB: The Definitive Guide `_ + * `MongoDB in Action `_ + * `The Definitive Guide to MongoDB: The NoSQL Database for Cloud and Desktop Computing `_ + * `50 Tips and Tricks for MongoDB Developers `_ + * `Scaling MongoDB `_ + * `MongoDB and Python: Patterns and processes for the popular document-oriented database `_ + * `MongoDB and PHP `_ + * `PHP and MongoDB Web Development Beginner's Guide `_ + * `Node Web Development `_ + * `Document Design for MongoDB `_ + +Changelog +--------- + +.. toctree:: + :maxdepth: 1 + + changelog/changelog + +Indices +------- + +- :ref:`genindex` +- :ref:`search` \ No newline at end of file diff --git a/_sources/markdown-docs/collections.txt b/_sources/markdown-docs/collections.txt new file mode 100644 index 00000000000..e34d7f622fd --- /dev/null +++ b/_sources/markdown-docs/collections.txt @@ -0,0 +1,222 @@ +=========== +Collections +=========== + + See also: + + + * `Database `_ + * `Queries `_ + + +------------------ +Collection objects +------------------ + + Collection object is a pointer to a specific collection in the `database `_ . If you want to `insert `_ new records or + `query `_ existing ones then you need to have a valid collection object. + + + + **NB** Collection names can't start or end with a period nor contain a dollar sign! ( ``.tes$t`` is not allowed) + + +-------------------- +Creating collections +-------------------- + + Collections can be created with ``createCollection`` + + + .. code-block:: javascript + + db.createCollection([[name[, options]], callback) + + + + where ``name`` is the name of the collection, options a set of configuration parameters and ``callback`` is a callback function. ``db`` is the database object. + + + + The first parameter for the callback is the error object (null if no error) and the second one is the pointer to the newly created collection. If strict mode is on and the table exists, the operation yields in error. With strict mode off (default) the function simple returns the pointer to the existing collection and does not truncate it. + + + .. code-block:: javascript + + db.createCollection("test", function(err, collection){ + collection.insert({"test":"value"}); + }); + + +---------------------------- +Creating collections options +---------------------------- + + Several options can be passed to the ``createCollection`` function with ``options`` parameter. + + + .. code-block:: javascript + + * `raw` - driver returns documents as bson binary Buffer objects, `default:false` + + + * ``collectionName`` is the name of the collection (not including the database name as a prefix) + * ``db`` is the pointer to the corresponding database object + + + + Example of usage: + + + .. code-block:: javascript + + console.log("Collection name: "+collection.collectionName) + + +------------------------- +List existing collections +------------------------- + + Collections can be listed with ``collectionNames`` + + + .. code-block:: javascript + + db.collectionNames(callback); + + + + ``callback`` gets two parameters - an error object (if error occured) and an array of collection names as strings. + + + + Collection names also include database name, so a collection named ``posts`` in a database ``blog`` will be listed as ``blog.posts`` . + + + + Additionally there's system collections which should not be altered without knowing exactly what you are doing, these sollections can be identified with ``system`` prefix. For example ``posts.system.indexes`` . + + + + Example: + + + .. code-block:: javascript + + var mongodb = require("mongodb"), + mongoserver = new mongodb.Server("localhost"), + db_connector = new mongodb.Db("blog", mongoserver); + + db_connector.open(function(err, db){ + db.collectionNames(function(err, collections){ + console.log(collections); // ["blog.posts", "blog.system.indexes"] + }); + }); + + +---------------- +List collections +---------------- + + Collection objects can be listed with database method ``collections`` + + + .. code-block:: javascript + + db.collections(callback) + + + + Where ``callback`` gets two parameters - an error object (if an error occured) and an array of collection objects. + + +--------------------- +Selecting collections +--------------------- + + Existing collections can be opened with ``collection`` + + + .. code-block:: javascript + + db.collection([[name[, options]], callback); + + + + If strict mode is off, then a new collection is created if not already present. + + +----------------------------- +Selecting collections options +----------------------------- + + Several options can be passed to the ``collection`` function with ``options`` parameter. + + + .. code-block:: javascript + + * `raw` - driver returns documents as bson binary Buffer objects, `default:false` + + +-------------------- +Renaming collections +-------------------- + + A collection can be renamed with collection method ``rename`` + + + .. code-block:: javascript + + collection.rename(new_name, callback); + + + + Passing the optional dropTarget boolean as the thrid parameter will allow overwritting of existing collections + + + .. code-block:: javascript + + collection.rename(new_name, {dropTarget:true}, callback); + + +--------------------------------- +Removing records from collections +--------------------------------- + + Records can be erased from a collection with ``remove`` + + + .. code-block:: javascript + + collection.remove([[query[, options]], callback]); + + + + Where + + + * ``query`` is the query that records to be removed need to match. If not set all records will be removed + * ``options`` indicate advanced options. For example use ``{safe: true}`` when using callbacks + * ``callback`` callback function that gets two parameters - an error object (if an error occured) and the count of removed records + + +-------------------- +Removing collections +-------------------- + + A collection can be dropped with ``drop`` + + + .. code-block:: javascript + + collection.drop(callback); + + + + or with ``dropCollection`` + + + .. code-block:: javascript + + db.dropCollection(collection_name, callback) + diff --git a/_sources/markdown-docs/database.txt b/_sources/markdown-docs/database.txt new file mode 100644 index 00000000000..316f6993cdd --- /dev/null +++ b/_sources/markdown-docs/database.txt @@ -0,0 +1,228 @@ +======== +Database +======== + + The first thing to do in order to make queries to the database is to open one. This can be done with the ``Db`` constructor. + + + .. code-block:: javascript + + var mongodb = require("mongodb"), + mongoserver = new mongodb.Server(host, port, server_options), + db_connector = new mongodb.Db(name, mongoserver, db_options); + + db_connector.open(callback); + + + * ``host`` is a server hostname or IP + * ``port`` is a MongoDB port, use ``mongodb.Connection.DEFAULT_PORT`` for default (27017) + * ``server_options`` see *Server options* + * ``name`` is the databse name that needs to be opened, database will be created automatically if it doesn't yet exist + * ``db_options`` see *DB options* + + +-------------- +Server options +-------------- + + Several options can be passed to the ``Server`` constructor with ``options`` parameter. + + + * ``auto_reconnect`` - to reconnect automatically, ``default:false`` + * ``poolSize`` - specify the number of connections in the pool ``default:5`` + * ``socketOptions`` - a collection of pr socket settings + + +-------------- +Socket options +-------------- + + Several options can be set for the ``socketOptions`` . + + + * ``timeout`` = set seconds before connection times out ``default:0`` + * ``noDelay`` = Disables the Nagle algorithm ``default:true`` + * ``keepAlive`` = Set if keepAlive is used ``default:0`` , which means no keepAlive, set higher than 0 for keepAlive + * ``encoding`` = 'ascii'|'utf8'|'base64' ``default:null`` + + +---------- +DB options +---------- + + Several options can be passed to the ``Db`` constructor with ``options`` parameter. + + + * ``native_parser`` - if true, use native BSON parser + * ``strict`` - sets *strict mode* , if true then existing collections can't be "recreated" etc. + * ``pk`` - custom primary key factory to generate ``_id`` values (see Custom primary keys). + * ``forceServerObjectId`` - generation of objectid is delegated to the mongodb server instead of the driver. default is false + * ``retryMiliSeconds`` - specify the number of milliseconds between connection attempts ``default:5000`` + * ``numberOfRetries`` - specify the number of retries for connection attempts ``default:3`` + * ``reaper`` - enable/disable reaper (true/false) ``default:false`` + * ``reaperInterval`` - specify the number of milliseconds between each reaper attempt ``default:10000`` + * ``reaperTimeout`` - specify the number of milliseconds for timing out callbacks that don't return ``default:30000`` + * ``raw`` - driver expects Buffer raw bson document, ``default:false`` + * ``logger`` - object specifying error(), debug() and log() functions + + +------------------ +Opening a database +------------------ + + Database can be opened with Db method ``open`` . + + + .. code-block:: javascript + + db_connector.open(callback); + + + + ``callback`` is a callback function which gets 2 parameters - an error object (or null, if no errors occured) and a database object. + + + + Resulting database object can be used for creating and selecting `collections `_ . + + + .. code-block:: javascript + + db_connector.open(function(err, db){ + db.collection(...); + }); + + + * ``databaseName`` is the name of the database + * ``serverConfig`` includes information about the server ( ``serverConfig.host`` , ``serverConfig.port`` etc.) + * ``state`` indicates if the database is connected or not + * ``strict`` indicates if *strict mode* is on (true) or off (false, default) + * ``version`` indicates the version of the MongoDB database + + + * ``close`` to indicate that the connection to the database was closed + + + + For example + + + .. code-block:: javascript + + db.on("close", function(error){ + console.log("Connection to the database was closed!"); + }); + + + + NB! If ``auto_reconnect`` was set to true when creating the server, then the connection will be automatically reopened on next database operation. Nevertheless the ``close`` event will be fired. + + +----------------------------------------- +Sharing the connections over multiple dbs +----------------------------------------- + + To share the connection pool across multiple databases you database instance has method ``db`` + + + .. code-block:: javascript + + db_connector.db(name) + + + + this returns a new ``db`` instance that shares the connections off the previous instance but will send all commands to the database ``name`` . This allows for better control of resource usage in a multiple database scenario. + + +------------------- +Deleting a database +------------------- + + To delete a database you need a pointer to it first. Deletion can be done with method ``dropDatabase`` . + + + .. code-block:: javascript + + db_connector.open(function(err, db){ + if (err) { throw err; } + db.dropDatabase(function(err) { + if (err) { throw err; } + console.log("database has been dropped!"); + }); + }); + + +------------------- +Custom primary keys +------------------- + + Every record in the database has an unique primary key called ``_id`` . Default primary keys are 12 byte hashes but a custom key generator can be used for something else. If you set ``_id`` "by hand" when inserting records then you can use whatever you want, primary key factory generates ``_id`` values only for records without ones. + + + + Example 1: No need to generate primary key, as its already defined: + + + .. code-block:: javascript + + collection.insert({name:"Daniel", _id:"12345"}); + + + + Example 2: No primary key, so it needs to be generated before save: + + + .. code-block:: javascript + + collectionn.insert({name:"Daniel"}); + + + + Custom primary key factory is actually an object with method ``createPK`` which returns a primary key. The context (value for ``this`` ) for ``createPK`` is left untouched. + + + .. code-block:: javascript + + var CustomPKFactory = { + counter:0, + createPk: function() { + return ++this.counter; + } + } + + db_connector = new mongodb.Db(name, mongoserver, {pk: CustomPKFactory}); + + +-------------- +debug commands +-------------- + + In order to debug the commands sent to the database you can add a ``logger`` object to the ``DB options`` . Make sure also the property ``doDebug`` is set. + + + + Example + + + .. code-block:: javascript + + options = {} + options.logger = {}; + options.logger.doDebug = true; + options.logger.debug = function (message, object) { + // print the mongo command: + // "writing command to mongodb" + console.log(message); + + // print the collection name + console.log(object.json.collectionName) + + // print the json query sent to MongoDB + console.log(object.json.query) + + // print the binary object + console.log(object.binary) + } + + var db = new Db('some_database', new Server(...), options); + diff --git a/_sources/markdown-docs/gridfs.txt b/_sources/markdown-docs/gridfs.txt new file mode 100644 index 00000000000..c0378bdaa55 --- /dev/null +++ b/_sources/markdown-docs/gridfs.txt @@ -0,0 +1,235 @@ +========= +GridStore +========= + + GridFS is a scalable MongoDB *filesystem* for storing and retrieving large files. The default limit for a MongoDB record is 16MB, so to store data that is larger than this limit, GridFS can be used. GridFS shards the data into smaller chunks automatically. See `MongoDB documentation `_ for details. + + + + GridStore is a single file inside GridFS that can be managed by the script. + + +-------------- +Open GridStore +-------------- + + Opening a GridStore (a single file in GridFS) is a bit similar to opening a database. At first you need to create a GridStore object and then ``open`` it. + + + .. code-block:: javascript + + var gs = new mongodb.GridStore(db, filename, mode[, options]) + + + + Where + + + * ``db`` is the database object + * ``filename`` is the name of the file in GridFS that needs to be accessed/created + * ``mode`` indicated the operation, can be one of: * "r" (Read): Looks for the file information in fs.files collection, or creates a new id for this object. * "w" (Write): Erases all chunks if the file already exist. * "w+" (Append): Finds the last chunk, and keeps writing after it. + * ``options`` can be used to specify some metadata for the file, for example ``content_type`` , ``metadata`` and ``chunk_size`` + + + + Example: + + + .. code-block:: javascript + + var gs = new mongodb.GridStore(db, "test.png", "w", { + "content_type": "image/png", + "metadata":{ + "author": "Daniel" + }, + "chunk_size": 1024*4 + }); + + + + When GridStore object is created, it needs to be opened. + + + .. code-block:: javascript + + gs.open(callback); + + + + ``callback`` gets two parameters - and error object (if error occured) and the GridStore object. + + + + Opened GridStore object has a set of useful properties + + + * ``gs.length`` - length of the file in bytes + * ``gs.contentType`` - the content type for the file + * ``gs.uploadDate`` - when the file was uploaded + * ``gs.metadata`` - metadata that was saved with the file + * ``gs.chunkSize`` - chunk size + + + + Example + + + .. code-block:: javascript + + gs.open(function(err, gs){ + console.log("this file was uploaded at "+gs.uploadDate); + }); + + +-------------------- +Writing to GridStore +-------------------- + + Writing can be done with ``write`` + + + .. code-block:: javascript + + gs.write(data, callback) + + + + where ``data`` is a ``Buffer`` or a string, callback gets two parameters - an error object (if error occured) and result value which indicates if the write was successful or not. + + + + While the GridStore is not closed, every write is appended to the opened GridStore. + + +--------------------------- +Writing a file to GridStore +--------------------------- + + This function opens the GridStore, streams the contents of the file into GridStore, and closes the GridStore. + + + .. code-block:: javascript + + gs.writeFile( file, callback ) + + + + where + + + * ``file`` is a file descriptor, or a string file path + * ``callback`` is a function with two parameters - error object (if error occured) and the GridStore object. + + +---------------------- +Reading from GridStore +---------------------- + + Reading from GridStore can be done with ``read`` + + + .. code-block:: javascript + + gs.read([size], callback) + + + + where + + + * ``size`` is the length of the data to be read + * ``callback`` is a callback function with two parameters - error object (if an error occured) and data (binary string) + + +------------------------ +Streaming from GridStore +------------------------ + + You can stream data as it comes from the database using ``stream`` + + + .. code-block:: javascript + + gs.stream([autoclose=false]) + + + + where + + + * ``autoclose`` If true current GridStore will be closed when EOF and 'close' event will be fired + + + + The function returns `read stream `_ based on this GridStore file. It supports the events 'read', 'error', 'close' and 'end'. + + +------------------ +Delete a GridStore +------------------ + + GridStore files can be unlinked with ``unlink`` + + + .. code-block:: javascript + + mongodb.GridStore.unlink(db, name, callback) + + + + Where + + + * ``db`` is the database object + * ``name`` is either the name of a GridStore object or an array of GridStore object names + * ``callback`` is the callback function + + +--------------------- +Closing the GridStore +--------------------- + + GridStore needs to be closed after usage. This can be done with ``close`` + + + .. code-block:: javascript + + gs.close(callback) + + +--------------------------------------- +Check the existance of a GridStore file +--------------------------------------- + + Checking if a file exists in GridFS can be done with ``exist`` + + + .. code-block:: javascript + + mongodb.GridStore.exist(db, filename, callback) + + + + Where + + + * ``db`` is the database object + * ``filename`` is the name of the file to be checked or a regular expression + * ``callback`` is a callback function with two parameters - an error object (if an error occured) and a boolean value indicating if the file exists or not + + +---------------------- +Seeking in a GridStore +---------------------- + + Seeking can be done with ``seek`` + + + .. code-block:: javascript + + gs.seek(position); + + + + This function moves the internal pointer to the specified position. + diff --git a/_sources/markdown-docs/index.txt b/_sources/markdown-docs/index.txt new file mode 100644 index 00000000000..fb4c72b563b --- /dev/null +++ b/_sources/markdown-docs/index.txt @@ -0,0 +1,10 @@ +.. toctree:: + :maxdepth: 1 + + collections + database + gridfs + indexes + insert + queries + replicaset diff --git a/_sources/markdown-docs/indexes.txt b/_sources/markdown-docs/indexes.txt new file mode 100644 index 00000000000..88da01ff89c --- /dev/null +++ b/_sources/markdown-docs/indexes.txt @@ -0,0 +1,143 @@ +======= +Indexes +======= + + Indexes are needed to make queries faster. For example if you need to find records by a field named *username* and the field has a related index set, then the query will be a lot faster compared to if the index was not present. + + + + See `MongoDB documentation `_ for details. + + +--------------------------------- +Create indexes with createIndex() +--------------------------------- + + ``createIndex`` adds a new index to a collection. For checking if the index was already set, use ``ensureIndex`` instead. + + + .. code-block:: javascript + + collection.createIndex(index[, options], callback) + + + + or + + + .. code-block:: javascript + + db.createIndex(collectionname, index[, options], callback) + + + + where + + + * ``index`` is the field or fields to be indexed. See *index field* + * ``options`` are options, for example ``{sparse: true}`` to include only records that have indexed field set or ``{unique: true}`` for unique indexes. If the ``options`` is a boolean value, then it indicates if it's an unique index or not. + * ``callback`` gets two parameters - an error object (if an error occured) and the name for the newly created index + + +--------------------------------- +Ensure indexes with ensureIndex() +--------------------------------- + + Same as ``createIndex`` with the difference that the index is checked for existence before adding to avoid duplicate indexes. + + +----------- +Index field +----------- + + Index field can be a simple string like ``"username"`` to index certain field (in this case, a field named as *username* ). + + + .. code-block:: javascript + + collection.ensureIndex("username",callback) + + + + It is possible to index fields inside nested objects, for example ``"user.firstname"`` to index field named *firstname* inside a document named *user* . + + + .. code-block:: javascript + + collection.ensureIndex("user.firstname",callback) + + + + It is also possible to create mixed indexes to include several fields at once. + + + .. code-block:: javascript + + collection.ensureIndex({firstname:1, lastname:1}, callback) + + + + or with tuples + + + .. code-block:: javascript + + collection.ensureIndex([["firstname", 1], ["lastname", 1]], callback) + + + + The number value indicates direction - if it's 1, then it is an ascending value, if it's -1 then it's descending. For example if you have documents with a field *date* and you want to sort these records in descending order then you might want to add corresponding index + + + .. code-block:: javascript + + collection.ensureIndex({date:-1}, callback) + + +------------------------------- +Remove indexes with dropIndex() +------------------------------- + + All indexes can be dropped at once with ``dropIndexes`` + + + .. code-block:: javascript + + collection.dropIndexes(callback) + + + + ``callback`` gets two parameters - an error object (if an error occured) and a boolean value true if operation succeeded. + + +--------------------------------------------- +Get index information with indexInformation() +--------------------------------------------- + + ``indexInformation`` can be used to fetch some useful information about collection indexes. + + + .. code-block:: javascript + + collection.indexInformation(callback) + + + + Where ``callback`` gets two parameters - an error object (if an error occured) and an index information object. + + + + The keys in the index object are the index names and the values are tuples of included fields. + + + + For example if a collection has two indexes - as a default an ascending index for the ``_id`` field and an additonal descending index for ``"username"`` field, then the index information object would look like the following + + + .. code-block:: javascript + + { + "_id":[["_id", 1]], + "username_-1":[["username", -1]] + } + diff --git a/_sources/markdown-docs/insert.txt b/_sources/markdown-docs/insert.txt new file mode 100644 index 00000000000..b96e5a0e61c --- /dev/null +++ b/_sources/markdown-docs/insert.txt @@ -0,0 +1,190 @@ +====================== +Inserting and updating +====================== + + See also: + + + * `Database `_ + * `Collections `_ + + +------ +Insert +------ + + Records can be inserted to a collection with ``insert`` + + + .. code-block:: javascript + + collection.insert(docs[, options, callback]) + + + + Where + + + * ``docs`` is a single document object or an array of documents + * ``options`` is an object of parameters, if you use a callback, set ``safe`` to true - this way the callback is executed *after* the record is saved to the database, if ``safe`` is false (default) callback is fired immediately and thus doesn't make much sense. + * ``callback`` - callback function to run after the record is inserted. Set ``safe`` to true in ``options`` when using callback. First parameter for callback is the error object (if an error occured) and the second is an array of records inserted. + + + + For example + + + .. code-block:: javascript + + var document = {name:"David", title:"About MongoDB"}; + collection.insert(document, {safe: true}, function(err, records){ + console.log("Record added as "+records[0]._id); + }); + + + + If trying to insert a record with an existing ``_id`` value, then the operation yields in error. + + + .. code-block:: javascript + + collection.insert({_id:1}, {safe:true}, function(err, doc){ + // no error, inserted new document, with _id=1 + collection.insert({_id:1}, {safe:true}, function(err, doc){ + // error occured since _id=1 already existed + }); + }); + + +---- +Save +---- + + Shorthand for insert/update is ``save`` - if ``_id`` value set, the record is updated if it exists or inserted if it does not; if the ``_id`` value is not set, then the record is inserted as a new one. + + + .. code-block:: javascript + + collection.save({_id:"abc", user:"David"},{safe:true}, callback) + + + + ``callback`` gets two parameters - an error object (if an error occured) and the record if it was inserted or ``1`` if the record was updated. + + +------ +Update +------ + + Updates can be done with ``update`` + + + .. code-block:: javascript + + collection.update(criteria, update[, options[, callback]]); + + + + Where + + + * ``criteria`` is a query object to find records that need to be updated (see `Queries `_ + * ``update`` is the replacement object + * ``options`` is an options object (see below) + * ``callback`` is the callback to be run after the records are updated. Has two parameters, the first is an error object (if error occured), the second is the count of records that were modified. + + + + There are several option values that can be used with an update + + + * ``safe`` - run callback only after the update is done, defaults to false + * ``multi`` - update all records that match the query object, default is false (only the first one found is updated) + * ``upsert`` - if true and no records match the query, insert ``update`` as a new record + * ``raw`` - driver returns updated document as bson binary Buffer, ``default:false`` + + + + If the replacement object is a document, the matching documents will be replaced (except the ``_id`` values if no ``_id`` is set). + + + .. code-block:: javascript + + collection.update({_id:"123"}, {author:"Jessica", title:"Mongo facts"}); + + + + The example above will replace the document contents of id=123 with the replacement object. + + + + To update only selected fields, ``$set`` operator needs to be used. Following replacement object replaces author value but leaves everything else intact. + + + .. code-block:: javascript + + collection.update({_id:"123"}, {$set: {author:"Jessica"}}); + + + + See `MongoDB documentation `_ for all possible operators. + + +--------------- +Find and Modify +--------------- + + To update and retrieve the contents for one single record you can use ``findAndModify`` . + + + .. code-block:: javascript + + collection.findAndModify(criteria, sort, update[, options, callback]) + + + + Where + + + * ``criteria`` is the query object to find the record + * ``sort`` indicates the order of the matches if there's more than one matching record. The first record on the result set will be used. See `Queries->find->options->sort `_ for the format. + * ``update`` is the replacement object + * ``options`` define the behavior of the function + * ``callback`` is the function to run after the update is done. Has two parameters - error object (if error occured) and the record that was updated. + + + + Options object can be used for the following options: + + + * ``remove`` - if set to true (default is false), removes the record from the collection. Callback function still gets the object but it doesn't exist in the collection any more. + * ``new`` - if set to true, callback function returns the modified record. Default is false (original record is returned) + * ``upsert`` - if set to true and no record matched to the query, replacement object is inserted as a new record + + + .. code-block:: javascript + + var mongodb = require('mongodb'), + server = new mongodb.Server("127.0.0.1", 27017, {}); + + new mongodb.Db('test', server, {}).open(function (error, client) { + if (error) throw error; + var collection = new mongodb.Collection(client, 'test_collection'); + collection.findAndModify( + {hello: 'world'}, // query + [['_id','asc']], // sort order + {$set: {hi: 'there'}}, // replacement, replaces only the field "hi" + {}, // options + function(err, object) { + if (err){ + console.warn(err.message); // returns error if no matching object found + }else{ + console.dir(object); + } + }); + }); + + + + + diff --git a/_sources/markdown-docs/queries.txt b/_sources/markdown-docs/queries.txt new file mode 100644 index 00000000000..7d2d380a797 --- /dev/null +++ b/_sources/markdown-docs/queries.txt @@ -0,0 +1,436 @@ +======= +Queries +======= + + See also: + + + * `Database `_ + * `Collections `_ + + +-------------------------- +Making queries with find() +-------------------------- + + `Collections `_ can be queried with ``find`` . + + + .. code-block:: javascript + + collection.find(query[[[, fields], options], callback]); + + + + Where + + + * ``query`` - is a query object, defining the conditions the documents need to apply + * ``fields`` - indicates which fields should be included in the response (default is all) + * ``options`` - defines extra logic (sorting options, paging etc.) + * ``raw`` - driver returns documents as bson binary Buffer objects, ``default:false`` + + + + The result for the query is actually a cursor object. This can be used directly or converted to an array. + + + .. code-block:: javascript + + var cursor = collection.find({}); + cursor.each(...); + + + + To indicate which fields must or must no be returned ``fields`` value can be used. For example the following ``fields`` value + + + .. code-block:: javascript + + { + "name": true, + "title": true + } + + + + retrieves fields ``name`` and ``title`` (and as a default also ``_id`` ) but not any others. + + +----------------------------------- +Find first occurence with findOne() +----------------------------------- + + ``findOne`` is a convinence method finding and returning the first match of a query while regular ``find`` returns a cursor object instead. Use it when you expect only one record, for example when querying with ``_id`` or another unique property. + + + .. code-block:: javascript + + collection.findOne([query], callback) + + + + Where + + + * ``query`` is a query object or an ``_id`` value + * ``callback`` has two parameters - an error object (if an error occured) and the document object. + + + + Example: + + + .. code-block:: javascript + + collection.findOne({_id: doc_id}, function(err, document) { + console.log(document.name); + }); + + +---------- +_id values +---------- + + Default ``_id`` values are 12 byte binary hashes. You can alter the format with custom Primary Key factories (see *Custom Primarky Keys* in `Database `_ . + + + + In order to treat these binary _id values as strings it would be wise to convert binary values to hex strings. This can be done with ``toHexString`` property. + + + .. code-block:: javascript + + var idHex = document._id.toHexString(); + + + + Hex strings can be reverted back to binary (for example to perform queries) with ``ObjectID.createFromHexString`` + + + .. code-block:: javascript + + {_id: ObjectID.createFromHexString(idHex)} + + + + When inserting new records it is possible to use custom ``_id`` values as well which do not need to be binary hashes, for example strings. + + + .. code-block:: javascript + + collection.insert({_id: "abc", ...}); + collection.findOne({_id: "abc"},...); + + + + This way it is not necessary to convert ``_id`` values to hex strings and back. + + +------------ +Query object +------------ + + The simplest query object is an empty one ``{}`` which matches every record in the database. + + + + To make a simple query where one field must match to a defined value, one can do it as simply as + + + .. code-block:: javascript + + {fieldname: "fieldvalue"} + + + + This query matches all the records that a) have fields called *fieldname* and b) its value is *"fieldvalue"* . + + + + For example if we have a collection of blog posts where the structure of the records is ``{title, author, contents}`` and we want to retrieve all the posts for a specific author then we can do it like this: + + + .. code-block:: javascript + + posts = pointer_to_collection; + posts.find({author:"Daniel"}).toArray(function(err, results){ + console.log(results); // output all records + }); + + + + If the queried field is inside an object then that can be queried also. For example if we have a record with the following structure: + + + .. code-block:: javascript + + { + user: { + name: "Daniel" + } + } + + + + Then we can query the "name" field like this: ``{"user.name":"Daniel"}`` + + + + If more than one fieldname is specified, then it's an AND query + + + .. code-block:: javascript + + { + key1: "value1", + name2: "value2" + } + + + + Whis query matches all records where *key1* is *"value1"* and *key2* is *"value2"* + + + + OR queries are a bit trickier but doable with the ``$or`` operator. Query operator takes an array which includes a set of query objects and at least one of these must match a document before it is retrieved + + + .. code-block:: javascript + + { + $or:[ + {author:"Daniel"}, + {author:"Jessica"} + ] + } + + + + This query match all the documents where author is Daniel or Jessica. + + + + To mix AND and OR queries, you just need to use $or as one of regular query fields. + + + .. code-block:: javascript + + { + title:"MongoDB", + $or:[ + {author:"Daniel"}, + {author:"Jessica"} + ] + } + + + + Conditional operators ``<`` , ``<=`` , ``>`` , ``>=`` and ``!=`` can't be used directly, as the query object format doesn't support it but the same can be achieved with their aliases ``$lt`` , ``$lte`` , ``$gt`` , ``$gte`` and ``$ne`` . When a field value needs to match a conditional, the value must be wrapped into a separate object. + + + .. code-block:: javascript + + {"fieldname":{$gte:100}} + + + + This query defines that *fieldname* must be greater than or equal to ``100`` . + + + + Conditionals can also be mixed to create ranges. + + + .. code-block:: javascript + + {"fieldname": {$lte:10, $gte:100}} + + + + Queried field values can also be matched with regular expressions + + + .. code-block:: javascript + + {author:/^Daniel/} + + + + In addition to OR and conditional there's some more operators: + + + * ``$in`` - specifies an array of possible matches, ``{"name":{$in:[1,2,3]}}`` + * ``$nin`` - specifies an array of unwanted matches + * ``$all`` - array value must match to the condition ``{"name":{$all:[1,2,3]}}`` + * ``$exists`` - checks for existence of a field ``{"name":{$exists:true}}`` + * ``$mod`` - check for a modulo ``{"name":{$mod:{3,2}}`` is the same as ``"name" % 3 == 2`` + * ``$size`` - checks the size of an array value ``{"name": {$size:2}}`` matches arrays *name* with 2 elements + + +--------------------------------- +Queries inside objects and arrays +--------------------------------- + + If you have a document with nested objects/arrays then the keys inside these nested objects can still be used for queries. + + + + For example with the following document + + + .. code-block:: javascript + + { + "_id": idvalue, + "author":{ + "firstname":"Daniel", + "lastname": "Defoe" + }, + "books":[ + { + "title":"Robinson Crusoe" + "year": 1714 + } + ] + } + + + + not only the ``_id`` field can be used as a query field - also the ``firstname`` and even ``title`` can be used. This can be done when using nested field names as strings, concated with periods. + + + .. code-block:: javascript + + collection.find({"author.firstname":"Daniel}) + + + + Works even inside arrays + + + .. code-block:: javascript + + collection.find({"books.year":1714}) + + +------------- +Query options +------------- + + Query options define the behavior of the query. + + + .. code-block:: javascript + + var options = { + "limit": 20, + "skip": 10, + "sort": "title" + } + + collection.find({}, options).toArray(...); + + + + Paging can be achieved with option parameters ``limit`` and ``skip`` + + + .. code-block:: javascript + + { + "limit": 20, + "skip" 10 + } + + + + retrieves 10 elements starting from 20 + + + + Sorting can be acieved with option parameter ``sort`` which takes an array of sort preferences + + + .. code-block:: javascript + + { + "sort": [['field1','asc'], ['field2','desc']] + } + + + + With single ascending field the array can be replaced with the name of the field. + + + .. code-block:: javascript + + { + "sort": "name" + } + + + + Option parameter ``explain`` turns the query into an explain query. + + +------- +Cursors +------- + + Cursor objects are the results for queries and can be used to fetch individual fields from the database. + + + + ``cursor.nextObject(function(err, doc){})`` retrieves the next record from database. If doc is null, then there weren't any more records. + + + + ``cursor.each(function(err, doc){})`` retrieves all matching records one by one. + + + + ``cursor.toArray(function(err, docs){})`` converts the cursor object into an array of all the matching records. Probably the most convenient way to retrieve results but be careful with large datasets as every record is loaded into memory. + + + .. code-block:: javascript + + collection.find().toArray(function(err, docs){ + console.log("retrieved records:"); + console.log(docs); + }); + + + + ``cursor.rewind()`` resets the internal pointer in the cursor to the beginning. + + +---------------- +Counting matches +---------------- + + Counting total number of found matches can be done against cursors with method ``count`` . + + + .. code-block:: javascript + + cursor.count(callback) + + + + Where + + + * ``callback`` is the callback function with two parameters - an error object (if an error occured) and the number on matches as an integer. + + + + Example + + + .. code-block:: javascript + + cursor.count(function(err, count){ + console.log("Total matches: "+count); + }); + diff --git a/_sources/markdown-docs/replicaset.txt b/_sources/markdown-docs/replicaset.txt new file mode 100644 index 00000000000..74047572057 --- /dev/null +++ b/_sources/markdown-docs/replicaset.txt @@ -0,0 +1,83 @@ +=========== +Replicasets +=========== +------------ +Introduction +------------ + + Replica sets is the asynchronous master/slave replication added to Mongodb that takes care off all the failover and recovery for the member nodes. According to the mongodb documentation a replicaset is + + + * Two or more nodes that are copies of each other + * Automatic assignment of a primary(master) node if none is available + * Drivers that automatically detect the new master and send writes to it + + + + More information at `Replicasets `_ + + +------------ +Driver usage +------------ + + To create a new replicaset follow the instructions on the mongodb site to setup the config and the replicaset instances. Then using the driver. + + + .. code-block:: javascript + + var replSet = new ReplSetServers( [ + new Server( 127.0.0.1, 30000), + new Server( 127.0.0.1, 30001), + new Server( 127.0.0.1, 30002) + ], + {rs_name:RS.name} + ); + + var db = new Db('integration_test_', replSet); + db.open(function(err, p_db) { + // Do you app stuff :) + }) + + + + The ReplSetSrvers object has the following parameters + + + .. code-block:: javascript + + var replSet = new ReplSetSrvers(servers, options) + + + + Where + + + * ``servers`` is an array of ``Server`` objects + * ``options`` can contain the following options + + +------------------ +Replicaset options +------------------ + + Several options can be passed to the ``Replicaset`` constructor with ``options`` parameter. + + + * ``rs_name`` is the name of the replicaset you configured when you started the server, you can have multiple replicasets running on your servers. + * ``read_secondary`` set's the driver to read from secondary servers (slaves) instead of only from the primary(master) server. + * ``socketOptions`` - a collection of pr socket settings + + +-------------- +Socket options +-------------- + + Several options can be set for the ``socketOptions`` . + + + * ``timeout`` = set seconds before connection times out ``default:0`` + * ``noDelay`` = Disables the Nagle algorithm ``default:true`` + * ``keepAlive`` = Set if keepAlive is used ``default:0`` , which means no keepAlive, set higher than 0 for keepAlive + * ``encoding`` = 'ascii'|'utf8'|'base64' ``default:null`` + diff --git a/_static/active.png b/_static/active.png new file mode 100644 index 00000000000..2373e4ffb42 Binary files /dev/null and b/_static/active.png differ diff --git a/_static/ajax-loader.gif b/_static/ajax-loader.gif new file mode 100644 index 00000000000..61faf8cab23 Binary files /dev/null and b/_static/ajax-loader.gif differ diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 00000000000..43e8bafaf35 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,540 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.refcount { + color: #060; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/comment-bright.png b/_static/comment-bright.png new file mode 100644 index 00000000000..551517b8c83 Binary files /dev/null and b/_static/comment-bright.png differ diff --git a/_static/comment-close.png b/_static/comment-close.png new file mode 100644 index 00000000000..09b54be46da Binary files /dev/null and b/_static/comment-close.png differ diff --git a/_static/comment.png b/_static/comment.png new file mode 100644 index 00000000000..92feb52b882 Binary files /dev/null and b/_static/comment.png differ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000000..d4619fdfb10 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,247 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/_static/down-pressed.png b/_static/down-pressed.png new file mode 100644 index 00000000000..6f7ad782782 Binary files /dev/null and b/_static/down-pressed.png differ diff --git a/_static/down.png b/_static/down.png new file mode 100644 index 00000000000..3003a88770d Binary files /dev/null and b/_static/down.png differ diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000000..d18082e397e Binary files /dev/null and b/_static/file.png differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 00000000000..7c243080233 --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,154 @@ +/*! + * jQuery JavaScript Library v1.4.2 + * http://jquery.com/ + * + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2010, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Sat Feb 13 22:33:48 2010 -0500 + */ +(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, +Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& +(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, +a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== +"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, +function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
a"; +var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, +parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= +false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= +s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, +applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; +else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, +a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== +w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, +cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= +c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); +a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, +function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); +k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), +C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= +e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& +f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; +if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", +e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, +"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, +d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, +e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); +t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| +g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, +CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, +g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, +text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, +setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= +h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== +"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, +h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& +q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; +if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); +(function(){var g=s.createElement("div");g.innerHTML="
";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: +function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= +{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== +"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", +d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? +a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== +1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= +c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, +wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, +prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, +this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); +return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, +""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); +return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", +""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= +c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? +c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= +function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= +Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, +"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= +a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= +a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== +"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, +serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), +function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, +global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& +e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? +"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== +false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= +false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", +c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| +d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); +g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== +1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== +"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; +if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== +"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| +c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; +this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= +this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, +e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
"; +a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); +c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, +d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- +f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": +"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in +e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); diff --git a/docs/sphinx-docs/source/static/logo-mongodb.png b/_static/logo-mongodb.png similarity index 100% rename from docs/sphinx-docs/source/static/logo-mongodb.png rename to _static/logo-mongodb.png diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 00000000000..da1c5620d10 Binary files /dev/null and b/_static/minus.png differ diff --git a/docs/sphinx-docs/themes/mongodb/static/mongodb-docs.css_t b/_static/mongodb-docs.css similarity index 57% rename from docs/sphinx-docs/themes/mongodb/static/mongodb-docs.css_t rename to _static/mongodb-docs.css index 8797db98daa..6ab1fccf0ed 100644 --- a/docs/sphinx-docs/themes/mongodb/static/mongodb-docs.css_t +++ b/_static/mongodb-docs.css @@ -14,10 +14,10 @@ /* -- page layout ----------------------------------------------------------- */ body { - font-family: Arial, sans-serif; + font-family: helvetica,arial,sans-serif; font-size: 100%; - background-color: #111; - color: #555; + background-color: #402817; + color: black; margin: 0; padding: 0; } @@ -25,6 +25,7 @@ body { div.documentwrapper { float: left; width: 100%; + background-color: #F3F4EB; } div.bodywrapper { @@ -36,64 +37,69 @@ hr { } div.document { - background-color: #eee; + background-color: white; + text-shadow: none; } div.body { - background-color: #ffffff; - color: #3E4349; + background-color: white; + color: black; padding: 0 30px 30px 30px; font-size: 0.9em; } div.footer { - color: #555; + color: white; width: 100%; padding: 13px 0; text-align: center; font-size: 75%; + border-top: 1px solid black; } div.footer a { - color: #444; + color: #989898; text-decoration: underline; } div.related { - background-color: #6BA81E; - line-height: 32px; + background-color: #402817; + margin-bottom: 10px; color: #fff; - text-shadow: 0px 1px 0 #444; font-size: 0.9em; + } div.related a { color: #E2F3CC; } +div.related ul { + padding: 0 10px 0; +} + +div.footer-nav div.related ul { + padding: 5px 10px 0; +} + div.sphinxsidebar { - font-size: 0.75em; - line-height: 1.5em; + font-size: 0.72em; + line-height: 1.4em; + width: 230px; } div.sphinxsidebarwrapper{ - padding: 20px 0; + background-color: #F3F4EB; + padding: 12px 5px; } -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Arial, sans-serif; - color: #222; - font-size: 1.2em; - font-weight: normal; +div.sphinxsidebar h3 { + font-family: helvetica,arial,sans-serif; + color: black; + font-size: 1.5em; + font-weight: bold; margin: 0; - padding: 5px 10px; - background-color: #ddd; - text-shadow: 1px 1px 0 white -} - -div.sphinxsidebar h4{ - font-size: 1.1em; + padding: 10px 0 0 10px; } div.sphinxsidebar h3 a { @@ -101,21 +107,31 @@ div.sphinxsidebar h3 a { } div.sphinxsidebar p { - color: #888; - padding: 5px 20px; + color: #333333; + margin: 12px 0 5px 12px; + padding: 0 12p; +} + +div.sphinxsidebar form { + margin-top: 5px; } div.sphinxsidebar p.logo { color: #888; padding: 0px; - margin-top: -10px; + margin: -18px 5px 5px; } div.sphinxsidebar p.topless { } +div.sphinxsidebar ul ul, div.sphinxsidebar ul.want-points { + list-style: square outside none; + margin-left: 15px; +} + div.sphinxsidebar ul { - margin: 10px 20px; + margin: 10px; padding: 0; color: #000; } @@ -129,9 +145,17 @@ div.sphinxsidebar input { font-family: sans-serif; font-size: 1em; } - div.sphinxsidebar input[type=text]{ margin-left: 20px; + width: 11em !important; +} +div.sphinxsidebar input[type="submit"] { + text-align: center; + width: 4.5em !important; +} + +p.searchtip { + font-size: 93%; } /* -- body styles ----------------------------------------------------------- */ @@ -152,21 +176,18 @@ div.body h3, div.body h4, div.body h5, div.body h6 { - font-family: Arial, sans-serif; - background-color: #BED4EB; - font-weight: normal; - color: #212224; - margin: 30px 0px 10px 0px; - padding: 5px 0 5px 10px; - text-shadow: 0px 1px 0 white -} - -div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 150%; background-color: #C8D5E3; } -div.body h3 { font-size: 120%; background-color: #D8DEE3; } -div.body h4 { font-size: 110%; background-color: #D8DEE3; } -div.body h5 { font-size: 100%; background-color: #D8DEE3; } -div.body h6 { font-size: 100%; background-color: #D8DEE3; } + font-family: helvetica,arial,sans-serif; + font-weight: bold; + margin: 30px 0px 0px 0px; + padding: 0; +} + +div.body h1 { border-top: 15px solid white; margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 150%; } +div.body h3 { font-size: 120%; } +div.body h4 { font-size: 110%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } a.headerlink { color: #c60f0f; @@ -192,23 +213,45 @@ div.highlight{ background-color: white; } -div.note { +dl.binary { + display: none; +} + +div.topic { background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} +div.admonition { + margin: 15px; + padding: 7px; +} + +div.note { + background-color: #F3F4EB; border: 1px solid #ccc; } div.seealso { background-color: #ffc; border: 1px solid #ff6; + padding-bottom: 7px; } -div.topic { - background-color: #eee; +div.admonition-optional { + background-color: #ffffee; + border: 1px solid #dfdfdf; + color: #666666; + margin: 10px 25px; } -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; +div.admonition-example { + background-color: #F3F4EB; + border: 1px solid #ccc; + color: #3E4349; } p.admonition-title { @@ -219,6 +262,10 @@ p.admonition-title:after { content: ":"; } +div.admonition pre { + margin: 10px 0; +} + pre { padding: 10px; background-color: White; @@ -226,7 +273,7 @@ pre { line-height: 1.2em; border: 1px solid #C6C9CB; font-size: 1.1em; - margin: 1.5em 0 1.5em 0; + margin: 20px; -webkit-box-shadow: 1px 1px 1px #d8d8d8; -moz-box-shadow: 1px 1px 1px #d8d8d8; } @@ -240,7 +287,7 @@ tt { } .viewcode-back { - font-family: Arial, sans-serif; + font-family: helvetica,arial,sans-serif; } div.viewcode-block:target { @@ -248,3 +295,8 @@ div.viewcode-block:target { border-top: 1px solid #ac9; border-bottom: 1px solid #ac9; } + +p.first { + margin-bottom: 0px !important; + margin-top: 10px !important; +} \ No newline at end of file diff --git a/_static/nonactive.png b/_static/nonactive.png new file mode 100644 index 00000000000..4097e0b1f07 Binary files /dev/null and b/_static/nonactive.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 00000000000..b3cb37425ea Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 00000000000..1a14f2ae1ab --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,62 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #303030 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/reset.css b/_static/reset.css new file mode 100644 index 00000000000..78d0b6e37c5 --- /dev/null +++ b/_static/reset.css @@ -0,0 +1,46 @@ +/* http://meyerweb.com/eric/tools/css/reset/ + v2.0 | 20110126 + License: none (public domain) +*/ + +html, body, div, span, applet, object, iframe, +h1, h2, h3, h4, h5, h6, p, blockquote, pre, +a, abbr, acronym, address, big, cite, code, +del, dfn, em, img, ins, kbd, q, s, samp, +small, strike, strong, sub, sup, tt, var, +b, u, i, center, +dl, dt, dd, ol, ul, li, +fieldset, form, label, legend, +table, caption, tbody, tfoot, thead, tr, th, td, +article, aside, canvas, details, embed, +figure, figcaption, footer, header, hgroup, +menu, nav, output, ruby, section, summary, +time, mark, audio, video { + font-size: 100%; + font: inherit; + vertical-align: baseline; +} +/* HTML5 display-role reset for older browsers */ +article, aside, details, figcaption, figure, +footer, header, hgroup, menu, nav, section { + display: block; +} +body { + line-height: 1; +} +ol, ul { + list-style: none; +} +blockquote, q { + quotes: none; +} +blockquote:before, blockquote:after, +q:before, q:after { + content: ''; + content: none; +} +table { + border-collapse: collapse; + border-spacing: 0; +} + diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 00000000000..663be4c909b --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,560 @@ +/* + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for the full-text search. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurance, the + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('
').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlighted'); + }); + return rv; +} + + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, success: null, + dataType: "script", cache: true}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

' + _('Searching') + '

').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

').appendTo(this.out); + this.output = $('
    ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + query : function(query) { + var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; + + // Stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var objectterms = []; + for (var i = 0; i < tmp.length; i++) { + if (tmp[i] != "") { + objectterms.push(tmp[i].toLowerCase()); + } + + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || + tmp[i] == "") { + // skip this "word" + continue; + } + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + // console.debug('SEARCH: searching for:'); + // console.info('required: ', searchterms); + // console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var fileMap = {}; + var files = null; + // different result priorities + var importantResults = []; + var objectResults = []; + var regularResults = []; + var unimportantResults = []; + $('#search-progress').empty(); + + // lookup as object + for (var i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0,i), + objectterms.slice(i+1, objectterms.length)) + var results = this.performObjectSearch(objectterms[i], others); + // Assume first word is most likely to be the object, + // other words more likely to be in description. + // Therefore put matches for earlier words first. + // (Results are eventually used in reverse order). + objectResults = results[0].concat(objectResults); + importantResults = results[1].concat(importantResults); + unimportantResults = results[2].concat(unimportantResults); + } + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine all results + var results = unimportantResults.concat(regularResults) + .concat(objectResults).concat(importantResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
  • '); + if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { + // dirhtml builder + var dirname = item[0] + '/'; + if (dirname.match(/\/index\/$/)) { + dirname = dirname.substring(0, dirname.length-6); + } else if (dirname == 'index/') { + dirname = ''; + } + listItem.append($('').attr('href', + DOCUMENTATION_OPTIONS.URL_ROOT + dirname + + highlightstring + item[2]).html(item[1])); + } else { + // normal html builders + listItem.append($('').attr('href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + } + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + + item[0] + '.txt', function(data) { + if (data != '') { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + } + listItem.slideDown(5, function() { + displayNextItem(); + }); + }, "text"); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + }, + + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var importantResults = []; + var objectResults = []; + var unimportantResults = []; + + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + var match = objects[prefix][name]; + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (var i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + anchor = match[3]; + if (anchor == '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + result = [filenames[match[0]], fullname, '#'+anchor, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + return [importantResults, objectResults, unimportantResults] + } +} + +$(document).ready(function() { + Search.init(); +}); \ No newline at end of file diff --git a/_static/underscore.js b/_static/underscore.js new file mode 100644 index 00000000000..5d89914340f --- /dev/null +++ b/_static/underscore.js @@ -0,0 +1,23 @@ +// Underscore.js 0.5.5 +// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. +// Underscore is freely distributable under the terms of the MIT license. +// Portions of Underscore are inspired by or borrowed from Prototype.js, +// Oliver Steele's Functional, and John Resig's Micro-Templating. +// For all details and documentation: +// http://documentcloud.github.com/underscore/ +(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); +return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); +var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; +if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== +0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& +a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, +" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); +o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); diff --git a/_static/up-pressed.png b/_static/up-pressed.png new file mode 100644 index 00000000000..8bd587afee2 Binary files /dev/null and b/_static/up-pressed.png differ diff --git a/_static/up.png b/_static/up.png new file mode 100644 index 00000000000..b94625680b4 Binary files /dev/null and b/_static/up.png differ diff --git a/_static/websupport.js b/_static/websupport.js new file mode 100644 index 00000000000..e9bd1b851c6 --- /dev/null +++ b/_static/websupport.js @@ -0,0 +1,808 @@ +/* + * websupport.js + * ~~~~~~~~~~~~~ + * + * sphinx.websupport utilties for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +(function($) { + $.fn.autogrow = function() { + return this.each(function() { + var textarea = this; + + $.fn.autogrow.resize(textarea); + + $(textarea) + .focus(function() { + textarea.interval = setInterval(function() { + $.fn.autogrow.resize(textarea); + }, 500); + }) + .blur(function() { + clearInterval(textarea.interval); + }); + }); + }; + + $.fn.autogrow.resize = function(textarea) { + var lineHeight = parseInt($(textarea).css('line-height'), 10); + var lines = textarea.value.split('\n'); + var columns = textarea.cols; + var lineCount = 0; + $.each(lines, function() { + lineCount += Math.ceil(this.length / columns) || 1; + }); + var height = lineHeight * (lineCount + 1); + $(textarea).css('height', height); + }; +})(jQuery); + +(function($) { + var comp, by; + + function init() { + initEvents(); + initComparator(); + } + + function initEvents() { + $('a.comment-close').live("click", function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }); + $('a.vote').live("click", function(event) { + event.preventDefault(); + handleVote($(this)); + }); + $('a.reply').live("click", function(event) { + event.preventDefault(); + openReply($(this).attr('id').substring(2)); + }); + $('a.close-reply').live("click", function(event) { + event.preventDefault(); + closeReply($(this).attr('id').substring(2)); + }); + $('a.sort-option').live("click", function(event) { + event.preventDefault(); + handleReSort($(this)); + }); + $('a.show-proposal').live("click", function(event) { + event.preventDefault(); + showProposal($(this).attr('id').substring(2)); + }); + $('a.hide-proposal').live("click", function(event) { + event.preventDefault(); + hideProposal($(this).attr('id').substring(2)); + }); + $('a.show-propose-change').live("click", function(event) { + event.preventDefault(); + showProposeChange($(this).attr('id').substring(2)); + }); + $('a.hide-propose-change').live("click", function(event) { + event.preventDefault(); + hideProposeChange($(this).attr('id').substring(2)); + }); + $('a.accept-comment').live("click", function(event) { + event.preventDefault(); + acceptComment($(this).attr('id').substring(2)); + }); + $('a.delete-comment').live("click", function(event) { + event.preventDefault(); + deleteComment($(this).attr('id').substring(2)); + }); + $('a.comment-markup').live("click", function(event) { + event.preventDefault(); + toggleCommentMarkupBox($(this).attr('id').substring(2)); + }); + } + + /** + * Set comp, which is a comparator function used for sorting and + * inserting comments into the list. + */ + function setComparator() { + // If the first three letters are "asc", sort in ascending order + // and remove the prefix. + if (by.substring(0,3) == 'asc') { + var i = by.substring(3); + comp = function(a, b) { return a[i] - b[i]; }; + } else { + // Otherwise sort in descending order. + comp = function(a, b) { return b[by] - a[by]; }; + } + + // Reset link styles and format the selected sort option. + $('a.sel').attr('href', '#').removeClass('sel'); + $('a.by' + by).removeAttr('href').addClass('sel'); + } + + /** + * Create a comp function. If the user has preferences stored in + * the sortBy cookie, use those, otherwise use the default. + */ + function initComparator() { + by = 'rating'; // Default to sort by rating. + // If the sortBy cookie is set, use that instead. + if (document.cookie.length > 0) { + var start = document.cookie.indexOf('sortBy='); + if (start != -1) { + start = start + 7; + var end = document.cookie.indexOf(";", start); + if (end == -1) { + end = document.cookie.length; + by = unescape(document.cookie.substring(start, end)); + } + } + } + setComparator(); + } + + /** + * Show a comment div. + */ + function show(id) { + $('#ao' + id).hide(); + $('#ah' + id).show(); + var context = $.extend({id: id}, opts); + var popup = $(renderTemplate(popupTemplate, context)).hide(); + popup.find('textarea[name="proposal"]').hide(); + popup.find('a.by' + by).addClass('sel'); + var form = popup.find('#cf' + id); + form.submit(function(event) { + event.preventDefault(); + addComment(form); + }); + $('#s' + id).after(popup); + popup.slideDown('fast', function() { + getComments(id); + }); + } + + /** + * Hide a comment div. + */ + function hide(id) { + $('#ah' + id).hide(); + $('#ao' + id).show(); + var div = $('#sc' + id); + div.slideUp('fast', function() { + div.remove(); + }); + } + + /** + * Perform an ajax request to get comments for a node + * and insert the comments into the comments tree. + */ + function getComments(id) { + $.ajax({ + type: 'GET', + url: opts.getCommentsURL, + data: {node: id}, + success: function(data, textStatus, request) { + var ul = $('#cl' + id); + var speed = 100; + $('#cf' + id) + .find('textarea[name="proposal"]') + .data('source', data.source); + + if (data.comments.length === 0) { + ul.html('
  • No comments yet.
    • '); + ul.data('empty', true); + } else { + // If there are comments, sort them and put them in the list. + var comments = sortComments(data.comments); + speed = data.comments.length * 100; + appendComments(comments, ul); + ul.data('empty', false); + } + $('#cn' + id).slideUp(speed + 200); + ul.slideDown(speed); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem retrieving the comments.'); + }, + dataType: 'json' + }); + } + + /** + * Add a comment via ajax and insert the comment into the comment tree. + */ + function addComment(form) { + var node_id = form.find('input[name="node"]').val(); + var parent_id = form.find('input[name="parent"]').val(); + var text = form.find('textarea[name="comment"]').val(); + var proposal = form.find('textarea[name="proposal"]').val(); + + if (text == '') { + showError('Please enter a comment.'); + return; + } + + // Disable the form that is being submitted. + form.find('textarea,input').attr('disabled', 'disabled'); + + // Send the comment to the server. + $.ajax({ + type: "POST", + url: opts.addCommentURL, + dataType: 'json', + data: { + node: node_id, + parent: parent_id, + text: text, + proposal: proposal + }, + success: function(data, textStatus, error) { + // Reset the form. + if (node_id) { + hideProposeChange(node_id); + } + form.find('textarea') + .val('') + .add(form.find('input')) + .removeAttr('disabled'); + var ul = $('#cl' + (node_id || parent_id)); + if (ul.data('empty')) { + $(ul).empty(); + ul.data('empty', false); + } + insertComment(data.comment); + var ao = $('#ao' + node_id); + ao.find('img').attr({'src': opts.commentBrightImage}); + if (node_id) { + // if this was a "root" comment, remove the commenting box + // (the user can get it back by reopening the comment popup) + $('#ca' + node_id).slideUp(); + } + }, + error: function(request, textStatus, error) { + form.find('textarea,input').removeAttr('disabled'); + showError('Oops, there was a problem adding the comment.'); + } + }); + } + + /** + * Recursively append comments to the main comment list and children + * lists, creating the comment tree. + */ + function appendComments(comments, ul) { + $.each(comments, function() { + var div = createCommentDiv(this); + ul.append($(document.createElement('li')).html(div)); + appendComments(this.children, div.find('ul.comment-children')); + // To avoid stagnating data, don't store the comments children in data. + this.children = null; + div.data('comment', this); + }); + } + + /** + * After adding a new comment, it must be inserted in the correct + * location in the comment tree. + */ + function insertComment(comment) { + var div = createCommentDiv(comment); + + // To avoid stagnating data, don't store the comments children in data. + comment.children = null; + div.data('comment', comment); + + var ul = $('#cl' + (comment.node || comment.parent)); + var siblings = getChildren(ul); + + var li = $(document.createElement('li')); + li.hide(); + + // Determine where in the parents children list to insert this comment. + for(i=0; i < siblings.length; i++) { + if (comp(comment, siblings[i]) <= 0) { + $('#cd' + siblings[i].id) + .parent() + .before(li.html(div)); + li.slideDown('fast'); + return; + } + } + + // If we get here, this comment rates lower than all the others, + // or it is the only comment in the list. + ul.append(li.html(div)); + li.slideDown('fast'); + } + + function acceptComment(id) { + $.ajax({ + type: 'POST', + url: opts.acceptCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + $('#cm' + id).fadeOut('fast'); + $('#cd' + id).removeClass('moderate'); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem accepting the comment.'); + } + }); + } + + function deleteComment(id) { + $.ajax({ + type: 'POST', + url: opts.deleteCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + var div = $('#cd' + id); + if (data == 'delete') { + // Moderator mode: remove the comment and all children immediately + div.slideUp('fast', function() { + div.remove(); + }); + return; + } + // User mode: only mark the comment as deleted + div + .find('span.user-id:first') + .text('[deleted]').end() + .find('div.comment-text:first') + .text('[deleted]').end() + .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + + ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) + .remove(); + var comment = div.data('comment'); + comment.username = '[deleted]'; + comment.text = '[deleted]'; + div.data('comment', comment); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem deleting the comment.'); + } + }); + } + + function showProposal(id) { + $('#sp' + id).hide(); + $('#hp' + id).show(); + $('#pr' + id).slideDown('fast'); + } + + function hideProposal(id) { + $('#hp' + id).hide(); + $('#sp' + id).show(); + $('#pr' + id).slideUp('fast'); + } + + function showProposeChange(id) { + $('#pc' + id).hide(); + $('#hc' + id).show(); + var textarea = $('#pt' + id); + textarea.val(textarea.data('source')); + $.fn.autogrow.resize(textarea[0]); + textarea.slideDown('fast'); + } + + function hideProposeChange(id) { + $('#hc' + id).hide(); + $('#pc' + id).show(); + var textarea = $('#pt' + id); + textarea.val('').removeAttr('disabled'); + textarea.slideUp('fast'); + } + + function toggleCommentMarkupBox(id) { + $('#mb' + id).toggle(); + } + + /** Handle when the user clicks on a sort by link. */ + function handleReSort(link) { + var classes = link.attr('class').split(/\s+/); + for (var i=0; iThank you! Your comment will show up ' + + 'once it is has been approved by a moderator.'); + } + // Prettify the comment rating. + comment.pretty_rating = comment.rating + ' point' + + (comment.rating == 1 ? '' : 's'); + // Make a class (for displaying not yet moderated comments differently) + comment.css_class = comment.displayed ? '' : ' moderate'; + // Create a div for this comment. + var context = $.extend({}, opts, comment); + var div = $(renderTemplate(commentTemplate, context)); + + // If the user has voted on this comment, highlight the correct arrow. + if (comment.vote) { + var direction = (comment.vote == 1) ? 'u' : 'd'; + div.find('#' + direction + 'v' + comment.id).hide(); + div.find('#' + direction + 'u' + comment.id).show(); + } + + if (opts.moderator || comment.text != '[deleted]') { + div.find('a.reply').show(); + if (comment.proposal_diff) + div.find('#sp' + comment.id).show(); + if (opts.moderator && !comment.displayed) + div.find('#cm' + comment.id).show(); + if (opts.moderator || (opts.username == comment.username)) + div.find('#dc' + comment.id).show(); + } + return div; + } + + /** + * A simple template renderer. Placeholders such as <%id%> are replaced + * by context['id'] with items being escaped. Placeholders such as <#id#> + * are not escaped. + */ + function renderTemplate(template, context) { + var esc = $(document.createElement('div')); + + function handle(ph, escape) { + var cur = context; + $.each(ph.split('.'), function() { + cur = cur[this]; + }); + return escape ? esc.text(cur || "").html() : cur; + } + + return template.replace(/<([%#])([\w\.]*)\1>/g, function() { + return handle(arguments[2], arguments[1] == '%' ? true : false); + }); + } + + /** Flash an error message briefly. */ + function showError(message) { + $(document.createElement('div')).attr({'class': 'popup-error'}) + .append($(document.createElement('div')) + .attr({'class': 'error-message'}).text(message)) + .appendTo('body') + .fadeIn("slow") + .delay(2000) + .fadeOut("slow"); + } + + /** Add a link the user uses to open the comments popup. */ + $.fn.comment = function() { + return this.each(function() { + var id = $(this).attr('id').substring(1); + var count = COMMENT_METADATA[id]; + var title = count + ' comment' + (count == 1 ? '' : 's'); + var image = count > 0 ? opts.commentBrightImage : opts.commentImage; + var addcls = count == 0 ? ' nocomment' : ''; + $(this) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-open' + addcls, + id: 'ao' + id + }) + .append($(document.createElement('img')).attr({ + src: image, + alt: 'comment', + title: title + })) + .click(function(event) { + event.preventDefault(); + show($(this).attr('id').substring(2)); + }) + ) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-close hidden', + id: 'ah' + id + }) + .append($(document.createElement('img')).attr({ + src: opts.closeCommentImage, + alt: 'close', + title: 'close' + })) + .click(function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }) + ); + }); + }; + + var opts = { + processVoteURL: '/_process_vote', + addCommentURL: '/_add_comment', + getCommentsURL: '/_get_comments', + acceptCommentURL: '/_accept_comment', + deleteCommentURL: '/_delete_comment', + commentImage: '/static/_static/comment.png', + closeCommentImage: '/static/_static/comment-close.png', + loadingImage: '/static/_static/ajax-loader.gif', + commentBrightImage: '/static/_static/comment-bright.png', + upArrow: '/static/_static/up.png', + downArrow: '/static/_static/down.png', + upArrowPressed: '/static/_static/up-pressed.png', + downArrowPressed: '/static/_static/down-pressed.png', + voting: false, + moderator: false + }; + + if (typeof COMMENT_OPTIONS != "undefined") { + opts = jQuery.extend(opts, COMMENT_OPTIONS); + } + + var popupTemplate = '\ +
    \ +

    \ + Sort by:\ + best rated\ + newest\ + oldest\ +

    \ +
    Comments
    \ +
    \ + loading comments...
    \ +
      \ +
      \ +

      Add a comment\ + (markup):

      \ +
      \ + reStructured text markup: *emph*, **strong**, \ + ``code``, \ + code blocks: :: and an indented block after blank line
      \ +
      \ + \ +

      \ + \ + Propose a change ▹\ + \ + \ + Propose a change ▿\ + \ +

      \ + \ + \ + \ + \ +
      \ +
      \ +
      '; + + var commentTemplate = '\ +
      \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ +
      \ +

      \ + <%username%>\ + <%pretty_rating%>\ + <%time.delta%>\ +

      \ +
      <#text#>
      \ +

      \ + \ + reply ▿\ + proposal ▹\ + proposal ▿\ + \ + \ +

      \ + 
      \
+<#proposal_diff#>\
+
      \ +
        \ +
        \ +
        \ +
        \ + '; + + var replyTemplate = '\ +
      • \ +
        \ +
        \ + \ + \ + \ + \ + \ +
        \ +
        \ +
        • '; + + $(document).ready(function() { + init(); + }); +})(jQuery); + +$(document).ready(function() { + // add comment anchors for all paragraphs that are commentable + $('.sphinx-has-comment').comment(); + + // highlight search words in search results + $("div.context").each(function() { + var params = $.getQueryParameters(); + var terms = (params.q) ? params.q[0].split(/\s+/) : []; + var result = $(this); + $.each(terms, function() { + result.highlightText(this.toLowerCase(), 'highlighted'); + }); + }); + + // directly open comment window if requested + var anchor = document.location.hash; + if (anchor.substring(0, 9) == '#comment-') { + $('#ao' + anchor.substring(9)).click(); + document.location.hash = '#s' + anchor.substring(9); + } +}); diff --git a/api-articles/index.html b/api-articles/index.html new file mode 100644 index 00000000000..c4e8eb81266 --- /dev/null +++ b/api-articles/index.html @@ -0,0 +1,267 @@ + + + + + + + + + + Articles — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + + + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-articles/nodekoarticle1.html b/api-articles/nodekoarticle1.html new file mode 100644 index 00000000000..0094b2d3473 --- /dev/null +++ b/api-articles/nodekoarticle1.html @@ -0,0 +1,589 @@ + + + + + + + + + + A Basic introduction to Mongo DB — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        A Basic introduction to Mongo DB

        +
        +

        Mongo DB has rapidly grown to become a popular database for web applications and is a perfect fit for Node.JS applications, letting you write Javascript for the client, backend and database layer. Its schemaless nature is a better match to our constantly evolving data structures in web applications, and the integrated support for location queries is a bonus that’s hard to ignore. Throw in Replica Sets for scaling, and we’re looking at really nice platform to grow your storage needs now and in the future.

        +

        Now to shamelessly plug my driver. It can be downloaded via npm, or fetched from the github repository. To install via npm, do the following:

        +

        npm install mongodb

        +

        or go fetch it from github at https://github.com/christkv/node-mongodb-native

        +

        Once this business is taken care of, let’s move through the types available for the driver and then how to connect to your Mongo DB instance before facing the usage of some CRUD operations.

        +
        +
        +

        Mongo DB data types

        +
        +

        So there is an important thing to keep in mind when working with Mongo DB, and that is the slight mapping difference between types Mongo DB supports and native Javascript data types. Let’s have a look at the types supported out of the box and then how types are promoted by the driver to fit as close to native Javascript types as possible.

        +
        +
          +
        • Float is a 8 byte and is directly convertible to the Javascript type Number
          • +
        • Double class a special class representing a float value, this is especially useful when using capped collections where you need to ensure your values are always floats.
          • +
        • Integers is a bit trickier due to the fact that Javascript represents all Numbers as 64 bit floats meaning that the maximum integer value is at a 53 bit. Mongo has two types for integers, a 32 bit and a 64 bit. The driver will try to fit the value into 32 bits if it can and promote it to 64 bits if it has to. Similarly it will deserialize attempting to fit it into 53 bits if it can. If it cannot it will return an instance of Long to avoid loosing precession.
          • +
        • Long class a special class that let’s you store 64 bit integers and also let’s you operate on the 64 bits integers.
          • +
        • Date maps directly to a Javascript Date
          • +
        • RegExp maps directly to a Javascript RegExp
          • +
        • String maps directly to a Javascript String (encoded in utf8)
          • +
        • Binary class a special class that let’s you store data in Mongo DB
          • +
        • Code class a special class that let’s you store javascript functions in Mongo DB, can also provide a scope to run the method in
          • +
        • ObjectID class a special class that holds a MongoDB document identifier (the equivalent to a Primary key)
          • +
        • DbRef class a special class that let’s you include a reference in a document pointing to another object
          • +
        • Symbol class a special class that let’s you specify a symbol, not really relevant for javascript but for languages that supports the concept of symbols.
          • +
        +
        +

        As we see the number type can be a little tricky due to the way integers are implemented in Javascript. The latest driver will do correct conversion up to 53 bit’s of complexity. If you need to handle big integers the recommendation is to use the Long class to operate on the numbers.

        +
        +
        +
        +

        Getting that connection to the database

        +
        +

        Let’s get around to setting up a connection with the Mongo DB database. Jumping straight into the code let’s do direct connection and then look at the code.

        +
        +
        // Retrieve
+var MongoClient = require('mongodb').MongoClient;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(!err) {
+    console.log("We are connected");
+  }
+});
+
        +
        +
        +

        Let’s have a quick look at how the connection code works. The Db.connect

        +
        +
        +
        method let’s use use a uri to connect to the Mongo database, where
        +
        localhost:27017 is the server host and port and exampleDb the db
        +
        we wish to connect to. After the url notice the hash containing the
        +
        auto_reconnect key. Auto reconnect tells the driver to retry sending
        +
        +

        a command to the server if there is a failure during it’s execution.

        +
        +

        Another useful option you can pass in is

        +

        poolSize , this allows you to control how many tcp connections are

        +
        +

        opened in parallel. The default value for this is 5 but you can set it +as high as you want. The driver will use a round-robin strategy to +dispatch and read from the tcp connection.

        +
        +
        We are up and running with a connection to the database. Let’s move on
        +

        and look at what collections are and how they work.

        +
        +
        +

        Mongo DB and Collections

        +
        +

        Collections are the equivalent of tables in traditional databases and contain all your documents. A database can have many collections. So how do we go about defining and using collections. Well there are a couple of methods that we can use. Let’s jump straight into code and then look at the code.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        // Retrieve
+var MongoClient = require('mongodb').MongoClient;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) { return console.dir(err); }
+
+  db.collection('test', function(err, collection) {});
+
+  db.collection('test', {w:1}, function(err, collection) {});
+
+  db.createCollection('test', function(err, collection) {});
+
+  db.createCollection('test', {w:1}, function(err, collection) {});
+
+});
+
        +
        +
        +

        Three different ways of creating a collection object but slightly different in behavior. Let’s go through them and see what they do

        +
        +
        db.collection('test', function(err, collection) {});
+
        +
        +
        +

        This function will not actually create a collection on the database until you actually insert the first document.

        +
        +
        db.collection('test', {w:1}, function(err, collection) {});
+
        +
        +
        +

        Notice the {w:1} option. This option will make the driver check if the collection exists and issue an error if it does not.

        +
        +
        db.createCollection('test', function(err, collection) {});
+
        +
        +
        +

        This command will create the collection on the Mongo DB database before returning the collection object. If the collection already exists it will ignore the creation of the collection.

        +
        +
        db.createCollection('test', {w:1}, function(err, collection) {});
+
        +
        +
        +

        The {w:1} option will make the method return an error if the collection already exists.

        +

        With an open db connection and a collection defined we are ready to do some CRUD operation on the data.

        +
        +
        +
        +

        And then there was CRUD

        +
        +

        So let’s get dirty with the basic operations for Mongo DB. The Mongo DB wire protocol is built around 4 main operations insert/update/remove/query . Most operations on the database are actually queries with special json objects defining the operation on the database. But I’m getting ahead of myself. Let’s go back and look at insert first and do it with some code.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        // Retrieve
+var MongoClient = require('mongodb').MongoClient;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) { return console.dir(err); }
+
+  var collection = db.collection('test');
+  var doc1 = {'hello':'doc1'};
+  var doc2 = {'hello':'doc2'};
+  var lotsOfDocs = [{'hello':'doc3'}, {'hello':'doc4'}];
+
+  collection.insert(doc1);
+
+  collection.insert(doc2, {w:1}, function(err, result) {});
+
+  collection.insert(lotsOfDocs, {w:1}, function(err, result) {});
+
+});
+
        +
        +
        +

        A couple of variations on the theme of inserting a document as we can see. To understand why it’s important to understand how Mongo DB works during inserts of documents.

        +

        Mongo DB has asynchronous insert/update/remove operations. This means that when you issue an insert operation its a fire and forget operation where the database does not reply with the status of the insert operation. To retrieve the status of the operation you have to issue a query to retrieve the last error status of the connection. To make it simpler to the developer the driver implements the {w:1} options so that this is done automatically when inserting the document. {w:1} becomes especially important when you do update or remove as otherwise it’s not possible to determine the amount of documents modified or removed.

        +

        Now let’s go through the different types of inserts shown in the code above.

        +
        +
        collection.insert(doc1);
+
        +
        +
        +

        Taking advantage of the async behavior and not needing confirmation about the persisting of the data to Mongo DB we just fire off the insert (we are doing live analytics, loosing a couple of records does not matter).

        +
        +
        collection.insert(doc2, {w:1}, function(err, result) {});
+
        +
        +
        +

        That document needs to stick. Using the {w:1} option ensure you get the error back if the document fails to insert correctly.

        +
        +
        collection.insert(lotsOfDocs, {w:1}, function(err, result) {});
+
        +
        +
        +

        A batch insert of document with any errors being reported. This is much more efficient if you need to insert large batches of documents as you incur a lot less overhead.

        +

        Right that’s the basics of insert’s ironed out. We got some documents in there but want to update them as we need to change the content of a field. Let’s have a look at a simple example and then we will dive into how Mongo DB updates work and how to do them efficiently.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        // Retrieve
+var MongoClient = require('mongodb').MongoClient;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) { return console.dir(err); }
+
+  var collection = db.collection('test');
+  var doc = {mykey:1, fieldtoupdate:1};
+
+  collection.insert(doc, {w:1}, function(err, result) {
+    collection.update({mykey:1}, {$set:{fieldtoupdate:2}}, {w:1}, function(err, result) {});
+  });
+
+  var doc2 = {mykey:2, docs:[{doc1:1}]};
+
+  collection.insert(doc2, {w:1}, function(err, result) {
+    collection.update({mykey:2}, {$push:{docs:{doc2:1}}}, {w:1}, function(err, result) {});
+  });
+});
+
        +
        +
        +

        Alright before we look at the code we want to understand how document updates work and how to do the efficiently. The most basic and less efficient way is to replace the whole document, this is not really the way to go if you want to change just a field in your document. Luckily Mongo DB provides a whole set of operations that let you modify just pieces of the document Atomic operations documentation . Basically outlined below.

        +
        +
          +
        • $inc - increment a particular value by a certain amount
          • +
        • $set - set a particular value
          • +
        • $unset - delete a particular field (v1.3+)
          • +
        • $push - append a value to an array
          • +
        • $pushAll - append several values to an array
          • +
        • $addToSet - adds value to the array only if its not in the array already
          • +
        • $pop - removes the last element in an array
          • +
        • $pull - remove a value(s) from an existing array
          • +
        • $pullAll - remove several value(s) from an existing array
          • +
        • $rename - renames the field
          • +
        • $bit - bitwise operations
          • +
        +
        +

        Now that the operations are outline let’s dig into the specific cases show in the code example.

        +
        +
        collection.update({mykey:1}, {$set:{fieldtoupdate:2}}, {w:1}, function(err, result) {});
+
        +
        +
        +

        Right so this update will look for the document that has a field mykey equal to 1 and apply an update to the field fieldtoupdate setting the value to 2 . Since we are using the {w:1} option the result parameter in the callback will return the value 1 indicating that 1 document was modified by the update statement.

        +
        +
        collection.update({mykey:2}, {$push:{docs:{doc2:1}}}, {w:1}, function(err, result) {});
+
        +
        +
        +

        This updates adds another document to the field docs in the document identified by {mykey:2} using the atomic operation $push . This allows you to modify keep such structures as queues in Mongo DB.

        +

        Let’s have a look at the remove operation for the driver. As before let’s start with a piece of code.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        // Retrieve
+var MongoClient = require('mongodb').MongoClient;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) { return console.dir(err); }
+
+  var collection = db.collection('test');
+  var docs = [{mykey:1}, {mykey:2}, {mykey:3}];
+
+  collection.insert(docs, {w:1}, function(err, result) {
+
+    collection.remove({mykey:1});
+
+    collection.remove({mykey:2}, {w:1}, function(err, result) {});
+
+    collection.remove();
+  });
+});
+
        +
        +
        +

        Let’s examine the 3 remove variants and what they do.

        +
        +
        collection.remove({mykey:1});
+
        +
        +
        +

        This leverages the fact that Mongo DB is asynchronous and that it does not return a result for insert/update/remove to allow for synchronous style execution. This particular remove query will remove the document where mykey equals 1 .

        +
        +
        collection.remove({mykey:2}, {w:1}, function(err, result) {});
+
        +
        +
        +

        This remove statement removes the document where mykey equals 2 but since we are using {w:1} it will back to Mongo DB to get the status of the remove operation and return the number of documents removed in the result variable.

        +
        +
        collection.remove();
+
        +
        +
        +

        This last one will remove all documents in the collection.

        +
        +
        +
        +

        Time to Query

        +
        +

        Queries is of course a fundamental part of interacting with a database and Mongo DB is no exception. Fortunately for us it has a rich query interface with cursors and close to SQL concepts for slicing and dicing your datasets. To build queries we have lots of operators to choose from Mongo DB advanced queries . There are literarily tons of ways to search and ways to limit the query. Let’s look at some simple code for dealing with queries in different ways.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        // Retrieve
+var MongoClient = require('mongodb').MongoClient;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) { return console.dir(err); }
+
+  var collection = db.collection('test');
+  var docs = [{mykey:1}, {mykey:2}, {mykey:3}];
+
+  collection.insert(docs, {w:1}, function(err, result) {
+
+    collection.find().toArray(function(err, items) {});
+
+    var stream = collection.find({mykey:{$ne:2}}).stream();
+    stream.on("data", function(item) {});
+    stream.on("end", function() {});
+
+    collection.findOne({mykey:1}, function(err, item) {});
+
+  });
+});
+
        +
        +
        +

        Before we start picking apart the code there is one thing that needs to be understood, the find method does not execute the actual query. It builds an instance of Cursor that you then use to retrieve the data. This lets you manage how you retrieve the data from Mongo DB and keeps state about your current Cursor state on Mongo DB. Now let’s pick apart the queries we have here and look at what they do.

        +
        +
        collection.find().toArray(function(err, items) {});
+
        +
        +
        +

        This query will fetch all the document in the collection and return them as an array of items. Be careful with the function toArray as it might cause a lot of memory usage as it will instantiate all the document into memory before returning the final array of items. If you have a big resultset you could run into memory issues.

        +
        +
        var stream = collection.find({mykey:{$ne:2}}).stream();
+stream.on("data", function(item) {});
+stream.on("end", function() {});
+
        +
        +
        +

        This is the preferred way if you have to retrieve a lot of data for streaming, as data is deserialized a data event is emitted. This keeps the resident memory usage low as the documents are streamed to you. Very useful if you are pushing documents out via websockets or some other streaming socket protocol. Once there is no more document the driver will emit the end event to notify the application that it’s done.

        +
        +
        collection.findOne({mykey:1}, function(err, item) {});
+
        +
        +
        +

        This is special supported function to retrieve just one specific document bypassing the need for a cursor object.

        +

        That’s pretty much it for the quick intro on how to use the database. I have also included a list of links to where to go to find more information and also a sample crude location application I wrote using express JS and mongo DB.

        +
        +
        + +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-articles/nodekoarticle2.html b/api-articles/nodekoarticle2.html new file mode 100644 index 00000000000..ba562516295 --- /dev/null +++ b/api-articles/nodekoarticle2.html @@ -0,0 +1,485 @@ + + + + + + + + + + A primer for GridFS using the Mongo DB driver — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        A primer for GridFS using the Mongo DB driver

        +
        +
        In the first tutorial we targeted general usage of the database. But Mongo DB is much more than this. One of the additional very useful features is to act as a file storage system. This is accomplish in Mongo by having a file collection and a chunks collection where each document in the chunks collection makes up a Block of the file. In this tutorial we will look at how to use the GridFS functionality and what functions are available.
        +
        +

        A simple example

        +
        +

        Let’s dive straight into a simple example on how to write a file to the grid using the simplified Grid class.

        +
        +
        var MongoClient = require('mongodb').MongoClient,
+  Grid = mongo.Grid;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) return console.dir(err);
+
+  var grid = new Grid(db, 'fs');
+  var buffer = new Buffer("Hello world");
+  grid.put(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) {
+    if(!err) {
+      console.log("Finished writing file to Mongo");
+    }
+  });
+});
+
        +
        +
        +

        All right let’s dissect the example. The first thing you’ll notice is the statement

        +
        +
        var grid = new Grid(db, 'fs');
+
        +
        +
        +

        Since GridFS is actually a special structure stored as collections you’ll notice that we are using the db connection that we used in the previous tutorial to operate on collections and documents. The second parameter ‘fs’ allows you to change the collections you want to store the data in. In this example the collections would be fs_files and fs_chunks .

        +

        Having a live grid instance we now go ahead and create some test data stored in a Buffer instance, although you can pass in a string instead. We then write our data to disk.

        +
        +
        var buffer = new Buffer("Hello world");
+grid.put(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) {
+  if(!err) {
+    console.log("Finished writing file to Mongo");
+  }
+});
+
        +
        +
        +

        Let’s deconstruct the call we just made. The put call will write the data you passed in as one or more chunks. The second parameter is a hash of options for the Grid class. In this case we wish to annotate the file we are writing to Mongo DB with some metadata and also specify a content type. Each file entry in GridFS has support for metadata documents which might be very useful if you are for example storing images in you Mongo DB and need to store all the data associated with the image.

        +

        One important thing is to take not that the put method return a document containing a _id , this is an ObjectID identifier that you’ll need to use if you wish to retrieve the file contents later.

        +

        Right so we have written out first file, let’s look at the other two simple functions supported by the Grid class.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        var MongoClient = require('mongodb').MongoClient,
+  Grid = mongo.Grid;
+
+// Connect to the db
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  if(err) return console.dir(err);
+
+  var grid = new Grid(db, 'fs');
+  var buffer = new Buffer("Hello world");
+  grid.put.(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) {
+    grid.get(fileInfo._id, function(err, data) {
+      console.log("Retrieved data: " + data.toString());
+      grid.delete(fileInfo._id, function(err, result) {
+      });
+    });
+  });
+});
+
        +
        +
        +

        Let’s have a look at the two operations get and delete

        +
        +
        grid.get(fileInfo._id, function(err, data) {});
+
        +
        +
        +

        The get method takes an ObjectID as the first argument and as we can se in the code we are using the one provided in fileInfo._id . This will read all the chunks for the file and return it as a Buffer object.

        +

        The delete method also takes an ObjectID as the first argument but will delete the file entry and the chunks associated with the file in Mongo.

        +

        This api is the simplest one you can use to interact with GridFS but it’s not suitable for all kinds of files. One of it’s main drawbacks is you are trying to write large files to Mongo. This api will require you to read the entire file into memory when writing and reading from Mongo which most likely is not feasible if you have to store large files like Video or RAW Pictures. Luckily this is not the only way to work with GridFS. That’s not to say this api is not useful. If you are storing tons of small files the memory usage vs the simplicity might be a worthwhile tradeoff. Let’s dive into some of the more advanced ways of using GridFS.

        +
        +
        +
        +

        Advanced GridFS or how not to run out of memory

        +
        +

        As we just said controlling memory consumption for you file writing and reading is key if you want to scale up the application. That means not reading in entire files before either writing or reading from Mongo DB. The good news is, it’s supported. Let’s throw some code out there straight away and look at how to do chunk sized streaming writes and reads.

        +

        the requires and and other initializing stuff omitted for brevity

        +
        +
        var fileId = new ObjectID();
+var gridStore = new GridStore(db, fileId, "w", {root:'fs'});
+gridStore.chunkSize = 1024 * 256;
+
+gridStore.open(function(err, gridStore) {
+ Step(
+   function writeData() {
+     var group = this.group();
+
+     for(var i = 0; i < 1000000; i += 5000) {
+       gridStore.write(new Buffer(5000), group());
+     }
+   },
+
+   function doneWithWrite() {
+     gridStore.close(function(err, result) {
+       console.log("File has been written to GridFS");
+     });
+   }
+ )
+});
+
        +
        +
        +

        Before we jump into picking apart the code let’s look at

        +
        +
        var gridStore = new GridStore(db, fileId, "w", {root:'fs'});
+
        +
        +
        +

        Notice the parameter “w” this is important. It tells the driver that you are planning to write a new file. The parameters you can use here are.

        +
        +
          +
        • “r” - read only. This is the default mode
          • +
        • “w” - write in truncate mode. Existing data will be overwritten
          • +
        • “w+” - write in edit mode
          • +
        +
        +

        Right so there is a fair bit to digest here. We are simulating writing a file that’s about 1MB big to Mongo DB using GridFS. To do this we are writing it in chunks of 5000 bytes. So to not live with a difficult callback setup we are using the Step library with its’ group functionality to ensure that we are notified when all of the writes are done. After all the writes are done Step will invoke the next function (or step) called doneWithWrite where we finish up by closing the file that flushes out any remaining data to Mongo DB and updates the file document.

        +

        As we are doing it in chunks of 5000 bytes we will notice that memory consumption is low. This is the trick to write large files to GridFS. In pieces. Also notice this line.

        +
        +
        gridStore.chunkSize = 1024 * 256;
+
        +
        +
        +

        This allows you to adjust how big the chunks are in bytes that Mongo DB will write. You can tune the Chunk Size to your needs. If you need to write large files to GridFS it might be worthwhile to trade of memory for CPU by setting a larger Chunk Size.

        +

        Now let’s see how the actual streaming read works.

        +
        +
        new GridStore(db, fileId, "r").open(function(err, gridStore) {
+  var stream = gridStore.stream(true);
+
+  stream.on("data", function(chunk) {
+    console.log("Chunk of file data");
+  });
+
+  stream.on("end", function() {
+    console.log("EOF of file");
+  });
+
+  stream.on("close", function() {
+    console.log("Finished reading the file");
+  });
+});
+
        +
        +
        +

        Right let’s have a quick lock at the streaming functionality supplied with the driver (make sure you are using 0.9.6-12 or higher as there is a bug fix for custom chunksizes that you need)

        +
        +
        var stream = gridStore.stream(true);
+
        +
        +
        +

        This opens a stream to our file, you can pass in a boolean parameter to tell the driver to close the file automatically when it reaches the end. This will fire the close event automatically. Otherwise you’ll have to handle cleanup when you receive the end event. Let’s have a look at the events supported.

        +
        +
        stream.on("data", function(chunk) {
+  console.log("Chunk of file data");
+});
+
        +
        +
        +

        The data event is called for each chunk read. This means that it’s by the chunk size of the written file. So if you file is 1MB big and the file has chunkSize 256K then you’ll get 4 calls to the event handler for data . The chunk returned is a Buffer object.

        +
        +
        stream.on("end", function() {
+  console.log("EOF of file");
+});
+
        +
        +
        +

        The end event is called when the driver reaches the end of data for the file.

        +
        +
        stream.on("close", function() {
+  console.log("Finished reading the file");
+});
+
        +
        +
        +

        The close event is only called if you the autoclose parameter on the gridStore.stream method as shown above. If it’s false or not set handle cleanup of the streaming in the end event handler.

        +

        Right that’s it for writing to GridFS in an efficient Manner. I’ll outline some other useful function on the Gridstore object.

        +
        +
        +
        +

        Other useful methods on the Gridstore object

        +
        +

        There are some other methods that are useful

        +
        +
        gridStore.writeFile(filename/filedescriptor, function(err fileInfo) {});
+
        +
        +
        +

        writeFile takes either a file name or a file descriptor and writes it to GridFS. It does this in chunks to ensure the Eventloop is not tied up.

        +
        +
        gridStore.read(length, function(err, data) {});
+
        +
        +
        +

        read/readBuffer lets you read a #length number of bytes from the current position in the file.

        +
        +
        gridStore.seek(position, seekLocation, function(err, gridStore) {});
+
        +
        +
        +

        seek lets you navigate the file to read from different positions inside the chunks. The seekLocation allows you to specify how to seek. It can be one of three values.

        +
        +
          +
        • GridStore.IO SEEK SET Seek mode where the given length is absolute
          • +
        • GridStore.IO SEEK CUR Seek mode where the given length is an offset to the current read/write head
          • +
        • GridStore.IO SEEK END Seek mode where the given length is an offset to the end of the file
          • +
        +
        +

        GridStore.list(dbInstance, collectionName, {id:true}, function(err, files) {})

        +

        list lists all the files in the collection in GridFS. If you have a lot of files the current version will not work very well as it’s getting all files into memory first. You can have it return either the filenames or the ids for the files using option.

        +
        +
        gridStore.unlink(function(err, result) {});
+
        +
        +
        +

        unlink deletes the file from Mongo DB, that’s to say all the file info and all the chunks.

        +

        This should be plenty to get you on your way building your first GridFS based application. As in the previous article the following links might be useful for you. Good luck and have fun.

        +
        +
        + +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/binary.html b/api-bson-generated/binary.html new file mode 100644 index 00000000000..f40e1b123ca --- /dev/null +++ b/api-bson-generated/binary.html @@ -0,0 +1,439 @@ + + + + + + + + + + Binary() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Binary()

        +
        +

        Constructor

        +

        A class representation of the BSON Binary type.

        +
        +
        +
        +class Binary()
        +
        +++ + + + + + +
        Arguments:
          +
        • buffer (buffer) – a buffer object containing the binary data.
          • +
        • [subType] (number) – the option binary type.
          • +
        +
        Returns:

        grid

        +
        +
        + +
        +
        +
        Sub types
        +
          +
        • BSON.BSON_BINARY_SUBTYPE_DEFAULT, default BSON type.
          • +
        • BSON.BSON_BINARY_SUBTYPE_FUNCTION, BSON function type.
          • +
        • BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY, BSON byte array type.
          • +
        • BSON.BSON_BINARY_SUBTYPE_UUID, BSON uuid type.
          • +
        • BSON.BSON_BINARY_SUBTYPE_MD5, BSON md5 type.
          • +
        • BSON.BSON_BINARY_SUBTYPE_USER_DEFINED, BSON user defined type.
          • +
        +
        +
        +
        +
        +

        Constants

        + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Constant NameValueDescription
        Binary.SUBTYPE_DEFAULT0Default BSON type
        Binary.SUBTYPE_FUNCTION1Function BSON type
        Binary.SUBTYPE_BYTE_ARRAY2Byte Array BSON type
        Binary.SUBTYPE_UUID_OLD3OLD UUID BSON type
        Binary.SUBTYPE_UUID4UUID BSON type
        Binary.SUBTYPE_MD55MD5 BSON type
        Binary.SUBTYPE_USER_DEFINED128User BSON type
        +
        +
        +

        put

        +

        Updates this binary with byte_value.

        +
        +
        +put(byte_value)
        +
        +++ + + + +
        Arguments:
          +
        • byte_value (character) – a single byte we wish to write.
          • +
        +
        +
        + +
        +
        +

        write

        +

        Writes a buffer or string to the binary.

        +
        +
        +write(string, offset)
        +
        +++ + + + +
        Arguments:
          +
        • string (buffer) – a string or buffer to be written to the Binary BSON object.
          • +
        • offset (number) – specify the binary of where to write the content.
          • +
        +
        +
        + +
        +
        +

        read

        +

        Reads length bytes starting at position.

        +
        +
        +read(position, length)
        +
        +++ + + + + + +
        Arguments:
          +
        • position (number) – read from the given position in the Binary.
          • +
        • length (number) – the number of bytes to read.
          • +
        +
        Returns:

        buffer

        +
        +
        + +
        +
        +

        value

        +

        Returns the value of this binary as a string.

        +
        +
        +value()
        +
        +++ + + + +
        Returns:string
        +
        + +
        +
        +

        length

        +

        Length.

        +
        +
        +length()
        +
        +++ + + + +
        Returns:number the length of the binary.
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/bson.html b/api-bson-generated/bson.html new file mode 100644 index 00000000000..3fc2c243204 --- /dev/null +++ b/api-bson-generated/bson.html @@ -0,0 +1,690 @@ + + + + + + + + + + BSON() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        BSON()

        +
        +

        Constructor

        +

        Create a new BSON instance

        +
        +
        +
        +class BSON()
        +
        +++ + + + +
        Returns:bson instance of BSON Parser.
        +
        + +
        +
        +
        +

        Constants

        + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Constant NameValueDescription
        BSON.BSON_DATA_NUMBER1Number BSON Type
        BSON.BSON_DATA_STRING2String BSON Type
        BSON.BSON_DATA_OBJECT3Object BSON Type
        BSON.BSON_DATA_ARRAY4Array BSON Type
        BSON.BSON_DATA_BINARY5Binary BSON Type
        BSON.BSON_DATA_OID7ObjectID BSON Type
        BSON.BSON_DATA_BOOLEAN8Boolean BSON Type
        BSON.BSON_DATA_DATE9Date BSON Type
        BSON.BSON_DATA_NULL10null BSON Type
        BSON.BSON_DATA_REGEXP11RegExp BSON Type
        BSON.BSON_DATA_CODE13Code BSON Type
        BSON.BSON_DATA_SYMBOL14Symbol BSON Type
        BSON.BSON_DATA_CODE_W_SCOPE15Code with Scope BSON Type
        BSON.BSON_DATA_INT1632 bit Integer BSON Type
        BSON.BSON_DATA_TIMESTAMP17Timestamp BSON Type
        BSON.BSON_DATA_LONG18Long BSON Type
        BSON.BSON_DATA_MIN_KEY0xffMinKey BSON Type
        BSON.BSON_DATA_MAX_KEY0x7fMaxKey BSON Type
        BSON.BSON_BINARY_SUBTYPE_DEFAULT0Binary Default Type
        BSON.BSON_BINARY_SUBTYPE_FUNCTION1Binary Function Type
        BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY2Binary Byte Array Type
        BSON.BSON_BINARY_SUBTYPE_UUID3Binary UUID Type
        BSON.BSON_BINARY_SUBTYPE_MD54Binary MD5 Type
        BSON.BSON_BINARY_SUBTYPE_USER_DEFINED128Binary User Defined Type
        +
        +
        +

        BSON.calculateObjectSize

        +

        Calculate the bson size for a passed in Javascript object.

        +
        +
        +BSON.calculateObjectSize(object[, serializeFunctions])
        +
        +++ + + + + + +
        Arguments:
          +
        • object (object) – the Javascript object to calculate the BSON byte size for.
          • +
        • [serializeFunctions] (boolean) – serialize all functions in the object (default:false).
          • +
        +
        Returns:

        number returns the number of bytes the BSON object will take up.

        +
        +
        + +
        +
        +

        BSON.serializeWithBufferAndIndex

        +

        Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.

        +
        +
        +BSON.serializeWithBufferAndIndex(object, checkKeys, buffer, index, serializeFunctions)
        +
        +++ + + + + + +
        Arguments:
          +
        • object (object) – the Javascript object to serialize.
          • +
        • checkKeys (boolean) – the serializer will check if keys are valid.
          • +
        • buffer (buffer) – the Buffer you pre-allocated to store the serialized BSON object.
          • +
        • index (number) – the index in the buffer where we wish to start serializing into.
          • +
        • serializeFunctions (boolean) – serialize the javascript functions (default:false).
          • +
        +
        Returns:

        number returns the new write index in the Buffer.

        +
        +
        + +
        +
        +

        BSON.serialize

        +

        Serialize a Javascript object.

        +
        +
        +BSON.serialize(object, checkKeys, asBuffer, serializeFunctions)
        +
        +++ + + + + + +
        Arguments:
          +
        • object (object) – the Javascript object to serialize.
          • +
        • checkKeys (boolean) – the serializer will check if keys are valid.
          • +
        • asBuffer (boolean) – return the serialized object as a Buffer object (ignore).
          • +
        • serializeFunctions (boolean) – serialize the javascript functions (default:false).
          • +
        +
        Returns:

        buffer returns the Buffer object containing the serialized object.

        +
        +
        + +
        +
        +

        BSON.deserializeStream

        +

        Deserialize stream data as BSON documents.

        +
        +
        Options
        +
          +
        • evalFunctions {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized.
          • +
        • cacheFunctions {Boolean, default:false}, cache evaluated functions for reuse.
          • +
        • cacheFunctionsCrc32 {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function.
          • +
        +
        +
        +
        +
        +BSON.deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex[, options])
        +
        +++ + + + + + +
        Arguments:
          +
        • data (buffer) – the buffer containing the serialized set of BSON documents.
          • +
        • startIndex (number) – the start index in the data Buffer where the deserialization is to start.
          • +
        • numberOfDocuments (number) – number of documents to deserialize.
          • +
        • documents (array) – an array where to store the deserialized documents.
          • +
        • docStartIndex (number) – the index in the documents array from where to start inserting documents.
          • +
        • [options] (object) – additional options used for the deserialization.
          • +
        +
        Returns:

        number returns the next index in the buffer after deserialization x numbers of documents.

        +
        +
        + +
        +
        +

        BSON.deserialize

        +

        Deserialize data as BSON.

        +
        +
        Options
        +
          +
        • evalFunctions {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized.
          • +
        • cacheFunctions {Boolean, default:false}, cache evaluated functions for reuse.
          • +
        • cacheFunctionsCrc32 {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function.
          • +
        +
        +
        +
        +
        +BSON.deserialize(buffer[, options][, isArray])
        +
        +++ + + + + + +
        Arguments:
          +
        • buffer (buffer) – the buffer containing the serialized set of BSON documents.
          • +
        • [options] (object) – additional options used for the deserialization.
          • +
        • [isArray] (boolean) – ignore used for recursive parsing.
          • +
        +
        Returns:

        object returns the deserialized Javascript Object.

        +
        +
        + +
        +
        +

        deserialize

        +

        Deserialize data as BSON.

        +
        +
        Options
        +
          +
        • evalFunctions {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized.
          • +
        • cacheFunctions {Boolean, default:false}, cache evaluated functions for reuse.
          • +
        • cacheFunctionsCrc32 {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function.
          • +
        +
        +
        +
        +
        +deserialize(buffer[, options][, isArray])
        +
        +++ + + + + + +
        Arguments:
          +
        • buffer (buffer) – the buffer containing the serialized set of BSON documents.
          • +
        • [options] (object) – additional options used for the deserialization.
          • +
        • [isArray] (boolean) – ignore used for recursive parsing.
          • +
        +
        Returns:

        object returns the deserialized Javascript Object.

        +
        +
        + +
        +
        +

        deserializeStream

        +

        Deserialize stream data as BSON documents.

        +
        +
        Options
        +
          +
        • evalFunctions {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized.
          • +
        • cacheFunctions {Boolean, default:false}, cache evaluated functions for reuse.
          • +
        • cacheFunctionsCrc32 {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function.
          • +
        +
        +
        +
        +
        +deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex[, options])
        +
        +++ + + + + + +
        Arguments:
          +
        • data (buffer) – the buffer containing the serialized set of BSON documents.
          • +
        • startIndex (number) – the start index in the data Buffer where the deserialization is to start.
          • +
        • numberOfDocuments (number) – number of documents to deserialize.
          • +
        • documents (array) – an array where to store the deserialized documents.
          • +
        • docStartIndex (number) – the index in the documents array from where to start inserting documents.
          • +
        • [options] (object) – additional options used for the deserialization.
          • +
        +
        Returns:

        number returns the next index in the buffer after deserialization x numbers of documents.

        +
        +
        + +
        +
        +

        serialize

        +

        Serialize a Javascript object.

        +
        +
        +serialize(object, checkKeys, asBuffer, serializeFunctions)
        +
        +++ + + + + + +
        Arguments:
          +
        • object (object) – the Javascript object to serialize.
          • +
        • checkKeys (boolean) – the serializer will check if keys are valid.
          • +
        • asBuffer (boolean) – return the serialized object as a Buffer object (ignore).
          • +
        • serializeFunctions (boolean) – serialize the javascript functions (default:false).
          • +
        +
        Returns:

        buffer returns the Buffer object containing the serialized object.

        +
        +
        + +
        +
        +

        calculateObjectSize

        +

        Calculate the bson size for a passed in Javascript object.

        +
        +
        +calculateObjectSize(object[, serializeFunctions])
        +
        +++ + + + + + +
        Arguments:
          +
        • object (object) – the Javascript object to calculate the BSON byte size for.
          • +
        • [serializeFunctions] (boolean) – serialize all functions in the object (default:false).
          • +
        +
        Returns:

        number returns the number of bytes the BSON object will take up.

        +
        +
        + +
        +
        +

        serializeWithBufferAndIndex

        +

        Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization.

        +
        +
        +serializeWithBufferAndIndex(object, checkKeys, buffer, index, serializeFunctions)
        +
        +++ + + + + + +
        Arguments:
          +
        • object (object) – the Javascript object to serialize.
          • +
        • checkKeys (boolean) – the serializer will check if keys are valid.
          • +
        • buffer (buffer) – the Buffer you pre-allocated to store the serialized BSON object.
          • +
        • index (number) – the index in the buffer where we wish to start serializing into.
          • +
        • serializeFunctions (boolean) – serialize the javascript functions (default:false).
          • +
        +
        Returns:

        number returns the new write index in the Buffer.

        +
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/code.html b/api-bson-generated/code.html new file mode 100644 index 00000000000..0a79988c890 --- /dev/null +++ b/api-bson-generated/code.html @@ -0,0 +1,276 @@ + + + + + + + + + + Code() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Code()

        +
        +

        Constructor

        +

        A class representation of the BSON Code type.

        +
        +
        +
        +class Code()
        +
        +++ + + + + + +
        Arguments:
          +
        • code (string) – a string or function.
          • +
        • [scope] (object) – an optional scope for the function.
          • +
        +
        Returns:

        code

        +
        +
        + +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/db_ref.html b/api-bson-generated/db_ref.html new file mode 100644 index 00000000000..77073bd82aa --- /dev/null +++ b/api-bson-generated/db_ref.html @@ -0,0 +1,275 @@ + + + + + + + + + + DBRef() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        DBRef()

        +
        +

        Constructor

        +

        A class representation of the BSON DBRef type.

        +
        +
        +
        +class DBRef()
        +
        +++ + + + + + +
        Arguments:
          +
        • namespace (string) – the collection name.
          • +
        • oid (objectid) – the reference ObjectID.
          • +
        • [db] (string) – optional db name, if omitted the reference is local to the current db.
          • +
        +
        Returns:

        dbref

        +
        +
        + +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/double.html b/api-bson-generated/double.html new file mode 100644 index 00000000000..671f17565f7 --- /dev/null +++ b/api-bson-generated/double.html @@ -0,0 +1,293 @@ + + + + + + + + + + Double() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Double()

        +
        +

        Constructor

        +

        A class representation of the BSON Double type.

        +
        +
        +
        +class Double()
        +
        +++ + + + + + +
        Arguments:
          +
        • value (number) – the number we want to represent as a double.
          • +
        +
        Returns:

        double

        +
        +
        + +
        +
        +
        +

        valueOf

        +

        Access the number value.

        +
        +
        +valueOf()
        +
        +++ + + + +
        Returns:number returns the wrapped double number.
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/index.html b/api-bson-generated/index.html new file mode 100644 index 00000000000..e1d8b5bcab1 --- /dev/null +++ b/api-bson-generated/index.html @@ -0,0 +1,389 @@ + + + + + + + + + + Binary JSON API — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + + + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/long.html b/api-bson-generated/long.html new file mode 100644 index 00000000000..05a8f5a2f95 --- /dev/null +++ b/api-bson-generated/long.html @@ -0,0 +1,1060 @@ + + + + + + + + + + Long() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Long()

        +
        +

        Constructor

        +

        Defines a Long class for representing a 64-bit two’s-complement +integer value, which faithfully simulates the behavior of a Java “Long”. This +implementation is derived from LongLib in GWT.

        +
        +
        +
        +class Long()
        +
        +++ + + + +
        Arguments:
          +
        • low (number) – the low (signed) 32 bits of the Long.
          • +
        • high (number) – the high (signed) 32 bits of the Long.
          • +
        +
        +
        + +
        +

        Constructs a 64-bit two’s-complement integer, given its low and high 32-bit +values as signed integers. See the from* functions below for more +convenient ways of constructing Longs.

        +

        The internal representation of a Long is the two given signed, 32-bit values. +We use 32-bit pieces because these are the size of integers on which +Javascript performs bit-operations. For operations like addition and +multiplication, we split each number into 16-bit pieces, which can easily be +multiplied within Javascript’s floating-point representation without overflow +or change in sign.

        +

        In the algorithms below, we frequently reduce the negative case to the +positive case by negating the input(s) and then post-processing the result. +Note that we must ALWAYS check specially whether those values are MIN_VALUE +(-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as +a positive number, it overflows back into a negative). Not handling this +case would often result in infinite recursion.

        +
        +
        +

        toInt

        +

        Return the int value.

        +
        +
        +toInt()
        +
        +++ + + + +
        Returns:number the value, assuming it is a 32-bit integer.
        +
        + +
        +
        +

        toNumber

        +

        Return the Number value.

        +
        +
        +toNumber()
        +
        +++ + + + +
        Returns:number the closest floating-point representation to this value.
        +
        + +
        +
        +

        toJSON

        +

        Return the JSON value.

        +
        +
        +toJSON()
        +
        +++ + + + +
        Returns:string the JSON representation.
        +
        + +
        +
        +

        toString

        +

        Return the String value.

        +
        +
        +toString([opt_radix])
        +
        +++ + + + + + +
        Arguments:
          +
        • [opt_radix] (number) – the radix in which the text should be written.
          • +
        +
        Returns:

        string the textual representation of this value.

        +
        +
        + +
        +
        +

        getHighBits

        +

        Return the high 32-bits value.

        +
        +
        +getHighBits()
        +
        +++ + + + +
        Returns:number the high 32-bits as a signed value.
        +
        + +
        +
        +

        getLowBits

        +

        Return the low 32-bits value.

        +
        +
        +getLowBits()
        +
        +++ + + + +
        Returns:number the low 32-bits as a signed value.
        +
        + +
        +
        +

        getLowBitsUnsigned

        +

        Return the low unsigned 32-bits value.

        +
        +
        +getLowBitsUnsigned()
        +
        +++ + + + +
        Returns:number the low 32-bits as an unsigned value.
        +
        + +
        +
        +

        getNumBitsAbs

        +

        Returns the number of bits needed to represent the absolute value of this Long.

        +
        +
        +getNumBitsAbs()
        +
        +++ + + + +
        Returns:number Returns the number of bits needed to represent the absolute value of this Long.
        +
        + +
        +
        +

        isZero

        +

        Return whether this value is zero.

        +
        +
        +isZero()
        +
        +++ + + + +
        Returns:boolean whether this value is zero.
        +
        + +
        +
        +

        isNegative

        +

        Return whether this value is negative.

        +
        +
        +isNegative()
        +
        +++ + + + +
        Returns:boolean whether this value is negative.
        +
        + +
        +
        +

        isOdd

        +

        Return whether this value is odd.

        +
        +
        +isOdd()
        +
        +++ + + + +
        Returns:boolean whether this value is odd.
        +
        + +
        +
        +

        equals

        +

        Return whether this Long equals the other

        +
        +
        +equals(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean whether this Long equals the other

        +
        +
        + +
        +
        +

        notEquals

        +

        Return whether this Long does not equal the other.

        +
        +
        +notEquals(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean whether this Long does not equal the other.

        +
        +
        + +
        +
        +

        lessThan

        +

        Return whether this Long is less than the other.

        +
        +
        +lessThan(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean whether this Long is less than the other.

        +
        +
        + +
        +
        +

        lessThanOrEqual

        +

        Return whether this Long is less than or equal to the other.

        +
        +
        +lessThanOrEqual(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean whether this Long is less than or equal to the other.

        +
        +
        + +
        +
        +

        greaterThan

        +

        Return whether this Long is greater than the other.

        +
        +
        +greaterThan(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean whether this Long is greater than the other.

        +
        +
        + +
        +
        +

        greaterThanOrEqual

        +

        Return whether this Long is greater than or equal to the other.

        +
        +
        +greaterThanOrEqual(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean whether this Long is greater than or equal to the other.

        +
        +
        + +
        +
        +

        compare

        +

        Compares this Long with the given one.

        +
        +
        +compare(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to compare against.
          • +
        +
        Returns:

        boolean 0 if they are the same, 1 if the this is greater, and -1 if the given one is greater.

        +
        +
        + +
        +
        +

        negate

        +

        The negation of this value.

        +
        +
        +negate()
        +
        +++ + + + +
        Returns:long the negation of this value.
        +
        + +
        +
        +

        add

        +

        Returns the sum of this and the given Long.

        +
        +
        +add(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to add to this one.
          • +
        +
        Returns:

        long the sum of this and the given Long.

        +
        +
        + +
        +
        +

        subtract

        +

        Returns the difference of this and the given Long.

        +
        +
        +subtract(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to subtract from this.
          • +
        +
        Returns:

        long the difference of this and the given Long.

        +
        +
        + +
        +
        +

        multiply

        +

        Returns the product of this and the given Long.

        +
        +
        +multiply(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long to multiply with this.
          • +
        +
        Returns:

        long the product of this and the other.

        +
        +
        + +
        +
        +

        div

        +

        Returns this Long divided by the given one.

        +
        +
        +div(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long by which to divide.
          • +
        +
        Returns:

        long this Long divided by the given one.

        +
        +
        + +
        +
        +

        modulo

        +

        Returns this Long modulo the given one.

        +
        +
        +modulo(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – Long by which to mod.
          • +
        +
        Returns:

        long this Long modulo the given one.

        +
        +
        + +
        +
        +

        not

        +

        The bitwise-NOT of this value.

        +
        +
        +not()
        +
        +++ + + + +
        Returns:long the bitwise-NOT of this value.
        +
        + +
        +
        +

        and

        +

        Returns the bitwise-AND of this Long and the given one.

        +
        +
        +and(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – the Long with which to AND.
          • +
        +
        Returns:

        long the bitwise-AND of this and the other.

        +
        +
        + +
        +
        +

        or

        +

        Returns the bitwise-OR of this Long and the given one.

        +
        +
        +or(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – the Long with which to OR.
          • +
        +
        Returns:

        long the bitwise-OR of this and the other.

        +
        +
        + +
        +
        +

        xor

        +

        Returns the bitwise-XOR of this Long and the given one.

        +
        +
        +xor(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (long) – the Long with which to XOR.
          • +
        +
        Returns:

        long the bitwise-XOR of this and the other.

        +
        +
        + +
        +
        +

        shiftLeft

        +

        Returns this Long with bits shifted to the left by the given amount.

        +
        +
        +shiftLeft(numBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • numBits (number) – the number of bits by which to shift.
          • +
        +
        Returns:

        long this shifted to the left by the given amount.

        +
        +
        + +
        +
        +

        shiftRight

        +

        Returns this Long with bits shifted to the right by the given amount.

        +
        +
        +shiftRight(numBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • numBits (number) – the number of bits by which to shift.
          • +
        +
        Returns:

        long this shifted to the right by the given amount.

        +
        +
        + +
        +
        +

        shiftRightUnsigned

        +

        Returns this Long with bits shifted to the right by the given amount, with the new top bits matching the current sign bit.

        +
        +
        +shiftRightUnsigned(numBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • numBits (number) – the number of bits by which to shift.
          • +
        +
        Returns:

        long this shifted to the right by the given amount, with zeros placed into the new leading bits.

        +
        +
        + +
        +
        +

        Long.fromInt

        +

        Returns a Long representing the given (32-bit) integer value.

        +
        +
        +Long.fromInt(value)
        +
        +++ + + + + + +
        Arguments:
          +
        • value (number) – the 32-bit integer in question.
          • +
        +
        Returns:

        long the corresponding Long value.

        +
        +
        + +
        +
        +

        Long.fromNumber

        +

        Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned.

        +
        +
        +Long.fromNumber(value)
        +
        +++ + + + + + +
        Arguments:
          +
        • value (number) – the number in question.
          • +
        +
        Returns:

        long the corresponding Long value.

        +
        +
        + +
        +
        +

        Long.fromBits

        +

        Returns a Long representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits.

        +
        +
        +Long.fromBits(lowBits, highBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • lowBits (number) – the low 32-bits.
          • +
        • highBits (number) – the high 32-bits.
          • +
        +
        Returns:

        long the corresponding Long value.

        +
        +
        + +
        +
        +

        Long.fromString

        +

        Returns a Long representation of the given string, written using the given radix.

        +
        +
        +Long.fromString(str, opt_radix)
        +
        +++ + + + + + +
        Arguments:
          +
        • str (string) – the textual representation of the Long.
          • +
        • opt_radix (number) – the radix in which the text is written.
          • +
        +
        Returns:

        long the corresponding Long value.

        +
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/maxkey.html b/api-bson-generated/maxkey.html new file mode 100644 index 00000000000..39f936cdd50 --- /dev/null +++ b/api-bson-generated/maxkey.html @@ -0,0 +1,269 @@ + + + + + + + + + + MaxKey() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        MaxKey()

        +
        +

        Constructor

        +

        A class representation of the BSON MaxKey type.

        +
        +
        +
        +class MaxKey()
        +
        +++ + + + +
        Returns:maxkey
        +
        + +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/minkey.html b/api-bson-generated/minkey.html new file mode 100644 index 00000000000..efabc985c18 --- /dev/null +++ b/api-bson-generated/minkey.html @@ -0,0 +1,267 @@ + + + + + + + + + + MinKey() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        MinKey()

        +
        +

        Constructor

        +

        A class representation of the BSON MinKey type.

        +
        +
        +
        +class MinKey()
        +
        +++ + + + +
        Returns:minkey
        +
        + +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/objectid.html b/api-bson-generated/objectid.html new file mode 100644 index 00000000000..c8c3143ac82 --- /dev/null +++ b/api-bson-generated/objectid.html @@ -0,0 +1,505 @@ + + + + + + + + + + ObjectID() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        ObjectID()

        +
        +

        Constructor

        +

        Create a new ObjectID instance

        +
        +
        +
        +class ObjectID()
        +
        +++ + + + + + +
        Arguments:
          +
        • id (string) – Can be a 24 byte hex string, 12 byte binary string or a Number.
          • +
        +
        Returns:

        object instance of ObjectID.

        +
        +
        + +
        +
        +
        +

        toHexString

        +

        Return the ObjectID id as a 24 byte hex string representation

        +
        +
        +toHexString()
        +
        +++ + + + +
        Returns:string return the 24 byte hex string representation.
        +
        + +

        Examples

        +
        +

        Generate a 24 character hex string representation of the ObjectID

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Create a new ObjectID
+var objectId = new ObjectID();
+// Verify that the hex string is 24 characters long
+assert.equal(24, objectId.toHexString().length);
+
        +
        +
        +
        +
        +

        equals

        +

        Compares the equality of this ObjectID with <code>otherID</code>.

        +
        +
        +equals(otherID)
        +
        +++ + + + + + +
        Arguments:
          +
        • otherID (object) – ObjectID instance to compare against.
          • +
        +
        Returns:

        bool the result of comparing two ObjectID’s

        +
        +
        + +

        Examples

        +
        +

        Compare two different ObjectID’s using the equals method

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Create a new ObjectID
+var objectId = new ObjectID();
+// Create a new ObjectID Based on the first ObjectID
+var objectId2 = new ObjectID(objectId.id);
+// Create another ObjectID
+var objectId3 = new ObjectID();
+// objectId and objectId2 should be the same
+assert.ok(objectId.equals(objectId2));
+// objectId and objectId2 should be different
+assert.ok(!objectId.equals(objectId3));
+
        +
        +
        +
        +
        +

        getTimestamp

        +

        Returns the generation time in seconds that this ID was generated.

        +
        +
        +getTimestamp()
        +
        +++ + + + +
        Returns:number return number of seconds in the timestamp part of the 12 byte id.
        +
        + +

        Examples

        +
        +

        Generate 12 byte binary string representation using a second based timestamp or +default value

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Get a timestamp in seconds
+var timestamp = Math.floor(new Date().getTime()/1000);
+// Create a date with the timestamp
+var timestampDate = new Date(timestamp*1000);
+
+// Create a new ObjectID with a specific timestamp
+var objectId = new ObjectID(timestamp);
+
+// Get the timestamp and validate correctness
+assert.equal(timestampDate.toString(), objectId.getTimestamp().toString());
+
        +
        +
        +
        +
        +

        ObjectID.createFromTime

        +

        Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID.

        +
        +
        +ObjectID.createFromTime(time)
        +
        +++ + + + + + +
        Arguments:
          +
        • time (number) – an integer number representing a number of seconds.
          • +
        +
        Returns:

        objectid return the created ObjectID

        +
        +
        + +

        Examples

        +
        +

        Show the usage of the Objectid createFromTime function

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var objectId = ObjectID.createFromTime(1);
+assert.equal("000000010000000000000000", objectId.toHexString());
+
        +
        +
        +
        +
        +

        ObjectID.createFromHexString

        +

        Creates an ObjectID from a hex string representation of an ObjectID.

        +
        +
        +ObjectID.createFromHexString(hexString)
        +
        +++ + + + + + +
        Arguments:
          +
        • hexString (string) – create a ObjectID from a passed in 24 byte hexstring.
          • +
        +
        Returns:

        objectid return the created ObjectID

        +
        +
        + +

        Examples

        +
        +

        Convert a ObjectID into a hex string representation and then back to an ObjectID

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Create a new ObjectID
+var objectId = new ObjectID();
+// Convert the object id to a hex string
+var originalHex = objectId.toHexString();
+// Create a new ObjectID using the createFromHexString function
+var newObjectId = new ObjectID.createFromHexString(originalHex)
+// Convert the new ObjectID back into a hex string using the toHexString function
+var newHex = newObjectId.toHexString();
+// Compare the two hex strings
+assert.equal(originalHex, newHex);
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/symbol.html b/api-bson-generated/symbol.html new file mode 100644 index 00000000000..1ac3e9780f6 --- /dev/null +++ b/api-bson-generated/symbol.html @@ -0,0 +1,292 @@ + + + + + + + + + + Symbol() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Symbol()

        +
        +

        Constructor

        +

        A class representation of the BSON Symbol type.

        +
        +
        +
        +class Symbol()
        +
        +++ + + + + + +
        Arguments:
          +
        • value (string) – the string representing the symbol.
          • +
        +
        Returns:

        symbol

        +
        +
        + +
        +
        +
        +

        valueOf

        +

        Access the wrapped string value.

        +
        +
        +valueOf()
        +
        +++ + + + +
        Returns:string returns the wrapped string.
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-bson-generated/timestamp.html b/api-bson-generated/timestamp.html new file mode 100644 index 00000000000..8caaef2765d --- /dev/null +++ b/api-bson-generated/timestamp.html @@ -0,0 +1,1060 @@ + + + + + + + + + + Timestamp() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Timestamp()

        +
        +

        Constructor

        +

        Defines a Timestamp class for representing a 64-bit two’s-complement +integer value, which faithfully simulates the behavior of a Java “Timestamp”. This +implementation is derived from TimestampLib in GWT.

        +
        +
        +
        +class Timestamp()
        +
        +++ + + + +
        Arguments:
          +
        • low (number) – the low (signed) 32 bits of the Timestamp.
          • +
        • high (number) – the high (signed) 32 bits of the Timestamp.
          • +
        +
        +
        + +
        +

        Constructs a 64-bit two’s-complement integer, given its low and high 32-bit +values as signed integers. See the from* functions below for more +convenient ways of constructing Timestamps.

        +

        The internal representation of a Timestamp is the two given signed, 32-bit values. +We use 32-bit pieces because these are the size of integers on which +Javascript performs bit-operations. For operations like addition and +multiplication, we split each number into 16-bit pieces, which can easily be +multiplied within Javascript’s floating-point representation without overflow +or change in sign.

        +

        In the algorithms below, we frequently reduce the negative case to the +positive case by negating the input(s) and then post-processing the result. +Note that we must ALWAYS check specially whether those values are MIN_VALUE +(-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as +a positive number, it overflows back into a negative). Not handling this +case would often result in infinite recursion.

        +
        +
        +

        toInt

        +

        Return the int value.

        +
        +
        +toInt()
        +
        +++ + + + +
        Returns:number the value, assuming it is a 32-bit integer.
        +
        + +
        +
        +

        toNumber

        +

        Return the Number value.

        +
        +
        +toNumber()
        +
        +++ + + + +
        Returns:number the closest floating-point representation to this value.
        +
        + +
        +
        +

        toJSON

        +

        Return the JSON value.

        +
        +
        +toJSON()
        +
        +++ + + + +
        Returns:string the JSON representation.
        +
        + +
        +
        +

        toString

        +

        Return the String value.

        +
        +
        +toString([opt_radix])
        +
        +++ + + + + + +
        Arguments:
          +
        • [opt_radix] (number) – the radix in which the text should be written.
          • +
        +
        Returns:

        string the textual representation of this value.

        +
        +
        + +
        +
        +

        getHighBits

        +

        Return the high 32-bits value.

        +
        +
        +getHighBits()
        +
        +++ + + + +
        Returns:number the high 32-bits as a signed value.
        +
        + +
        +
        +

        getLowBits

        +

        Return the low 32-bits value.

        +
        +
        +getLowBits()
        +
        +++ + + + +
        Returns:number the low 32-bits as a signed value.
        +
        + +
        +
        +

        getLowBitsUnsigned

        +

        Return the low unsigned 32-bits value.

        +
        +
        +getLowBitsUnsigned()
        +
        +++ + + + +
        Returns:number the low 32-bits as an unsigned value.
        +
        + +
        +
        +

        getNumBitsAbs

        +

        Returns the number of bits needed to represent the absolute value of this Timestamp.

        +
        +
        +getNumBitsAbs()
        +
        +++ + + + +
        Returns:number Returns the number of bits needed to represent the absolute value of this Timestamp.
        +
        + +
        +
        +

        isZero

        +

        Return whether this value is zero.

        +
        +
        +isZero()
        +
        +++ + + + +
        Returns:boolean whether this value is zero.
        +
        + +
        +
        +

        isNegative

        +

        Return whether this value is negative.

        +
        +
        +isNegative()
        +
        +++ + + + +
        Returns:boolean whether this value is negative.
        +
        + +
        +
        +

        isOdd

        +

        Return whether this value is odd.

        +
        +
        +isOdd()
        +
        +++ + + + +
        Returns:boolean whether this value is odd.
        +
        + +
        +
        +

        equals

        +

        Return whether this Timestamp equals the other

        +
        +
        +equals(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean whether this Timestamp equals the other

        +
        +
        + +
        +
        +

        notEquals

        +

        Return whether this Timestamp does not equal the other.

        +
        +
        +notEquals(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean whether this Timestamp does not equal the other.

        +
        +
        + +
        +
        +

        lessThan

        +

        Return whether this Timestamp is less than the other.

        +
        +
        +lessThan(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean whether this Timestamp is less than the other.

        +
        +
        + +
        +
        +

        lessThanOrEqual

        +

        Return whether this Timestamp is less than or equal to the other.

        +
        +
        +lessThanOrEqual(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean whether this Timestamp is less than or equal to the other.

        +
        +
        + +
        +
        +

        greaterThan

        +

        Return whether this Timestamp is greater than the other.

        +
        +
        +greaterThan(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean whether this Timestamp is greater than the other.

        +
        +
        + +
        +
        +

        greaterThanOrEqual

        +

        Return whether this Timestamp is greater than or equal to the other.

        +
        +
        +greaterThanOrEqual(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean whether this Timestamp is greater than or equal to the other.

        +
        +
        + +
        +
        +

        compare

        +

        Compares this Timestamp with the given one.

        +
        +
        +compare(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to compare against.
          • +
        +
        Returns:

        boolean 0 if they are the same, 1 if the this is greater, and -1 if the given one is greater.

        +
        +
        + +
        +
        +

        negate

        +

        The negation of this value.

        +
        +
        +negate()
        +
        +++ + + + +
        Returns:timestamp the negation of this value.
        +
        + +
        +
        +

        add

        +

        Returns the sum of this and the given Timestamp.

        +
        +
        +add(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to add to this one.
          • +
        +
        Returns:

        timestamp the sum of this and the given Timestamp.

        +
        +
        + +
        +
        +

        subtract

        +

        Returns the difference of this and the given Timestamp.

        +
        +
        +subtract(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to subtract from this.
          • +
        +
        Returns:

        timestamp the difference of this and the given Timestamp.

        +
        +
        + +
        +
        +

        multiply

        +

        Returns the product of this and the given Timestamp.

        +
        +
        +multiply(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp to multiply with this.
          • +
        +
        Returns:

        timestamp the product of this and the other.

        +
        +
        + +
        +
        +

        div

        +

        Returns this Timestamp divided by the given one.

        +
        +
        +div(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp by which to divide.
          • +
        +
        Returns:

        timestamp this Timestamp divided by the given one.

        +
        +
        + +
        +
        +

        modulo

        +

        Returns this Timestamp modulo the given one.

        +
        +
        +modulo(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – Timestamp by which to mod.
          • +
        +
        Returns:

        timestamp this Timestamp modulo the given one.

        +
        +
        + +
        +
        +

        not

        +

        The bitwise-NOT of this value.

        +
        +
        +not()
        +
        +++ + + + +
        Returns:timestamp the bitwise-NOT of this value.
        +
        + +
        +
        +

        and

        +

        Returns the bitwise-AND of this Timestamp and the given one.

        +
        +
        +and(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – the Timestamp with which to AND.
          • +
        +
        Returns:

        timestamp the bitwise-AND of this and the other.

        +
        +
        + +
        +
        +

        or

        +

        Returns the bitwise-OR of this Timestamp and the given one.

        +
        +
        +or(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – the Timestamp with which to OR.
          • +
        +
        Returns:

        timestamp the bitwise-OR of this and the other.

        +
        +
        + +
        +
        +

        xor

        +

        Returns the bitwise-XOR of this Timestamp and the given one.

        +
        +
        +xor(other)
        +
        +++ + + + + + +
        Arguments:
          +
        • other (timestamp) – the Timestamp with which to XOR.
          • +
        +
        Returns:

        timestamp the bitwise-XOR of this and the other.

        +
        +
        + +
        +
        +

        shiftLeft

        +

        Returns this Timestamp with bits shifted to the left by the given amount.

        +
        +
        +shiftLeft(numBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • numBits (number) – the number of bits by which to shift.
          • +
        +
        Returns:

        timestamp this shifted to the left by the given amount.

        +
        +
        + +
        +
        +

        shiftRight

        +

        Returns this Timestamp with bits shifted to the right by the given amount.

        +
        +
        +shiftRight(numBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • numBits (number) – the number of bits by which to shift.
          • +
        +
        Returns:

        timestamp this shifted to the right by the given amount.

        +
        +
        + +
        +
        +

        shiftRightUnsigned

        +

        Returns this Timestamp with bits shifted to the right by the given amount, with the new top bits matching the current sign bit.

        +
        +
        +shiftRightUnsigned(numBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • numBits (number) – the number of bits by which to shift.
          • +
        +
        Returns:

        timestamp this shifted to the right by the given amount, with zeros placed into the new leading bits.

        +
        +
        + +
        +
        +

        Timestamp.fromInt

        +

        Returns a Timestamp representing the given (32-bit) integer value.

        +
        +
        +Timestamp.fromInt(value)
        +
        +++ + + + + + +
        Arguments:
          +
        • value (number) – the 32-bit integer in question.
          • +
        +
        Returns:

        timestamp the corresponding Timestamp value.

        +
        +
        + +
        +
        +

        Timestamp.fromNumber

        +

        Returns a Timestamp representing the given value, provided that it is a finite number. Otherwise, zero is returned.

        +
        +
        +Timestamp.fromNumber(value)
        +
        +++ + + + + + +
        Arguments:
          +
        • value (number) – the number in question.
          • +
        +
        Returns:

        timestamp the corresponding Timestamp value.

        +
        +
        + +
        +
        +

        Timestamp.fromBits

        +

        Returns a Timestamp representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits.

        +
        +
        +Timestamp.fromBits(lowBits, highBits)
        +
        +++ + + + + + +
        Arguments:
          +
        • lowBits (number) – the low 32-bits.
          • +
        • highBits (number) – the high 32-bits.
          • +
        +
        Returns:

        timestamp the corresponding Timestamp value.

        +
        +
        + +
        +
        +

        Timestamp.fromString

        +

        Returns a Timestamp representation of the given string, written using the given radix.

        +
        +
        +Timestamp.fromString(str, opt_radix)
        +
        +++ + + + + + +
        Arguments:
          +
        • str (string) – the textual representation of the Timestamp.
          • +
        • opt_radix (number) – the radix in which the text is written.
          • +
        +
        Returns:

        timestamp the corresponding Timestamp value.

        +
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/admin.html b/api-generated/admin.html new file mode 100644 index 00000000000..229c007dc80 --- /dev/null +++ b/api-generated/admin.html @@ -0,0 +1,1338 @@ + + + + + + + + + + Admin() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Admin()

        +
        +

        Constructor

        +

        Allows the user to access the admin functionality of MongoDB

        +
        +
        +
        +class Admin()
        +
        +++ + + + + + +
        Arguments:
          +
        • db (object) – Current db instance we wish to perform Admin operations on.
          • +
        +
        Returns:

        function Constructor for Admin type.

        +
        +
        + +
        +
        +
        +

        buildInfo

        +

        Retrieve the server information for the current +instance of the db client

        +
        +
        +buildInfo(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from buildInfo or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        Retrieve the buildInfo for the current MongoDB instance

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // Add the new user to the admin database
+  adminDb.addUser('admin3', 'admin3', function(err, result) {
+
+    // Authenticate using the newly added user
+    adminDb.authenticate('admin3', 'admin3', function(err, result) {
+      assert.ok(result);
+
+      // Retrive the build information for the MongoDB instance
+      adminDb.buildInfo(function(err, info) {
+        assert.ok(err == null);
+
+        adminDb.removeUser('admin3', function(err, result) {
+          assert.ok(result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        serverStatus

        +

        Retrieve this db’s server status.

        +
        +
        +serverStatus(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from serverStatus or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Retrieve the current server Info

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w: 1}, function(err, doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin13', 'admin13', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin13', 'admin13', function(err, result) {
+
+        // Retrive the server Info
+        adminDb.serverStatus(function(err, info) {
+          assert.equal(null, err);
+          assert.ok(info != null);
+
+          adminDb.removeUser('admin13', function(err, result) {
+            assert.ok(result);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        profilingLevel

        +

        Retrieve the current profiling Level for MongoDB

        +
        +
        +profilingLevel(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from profilingLevel or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        Retrieve the current profiling level set for the MongoDB instance

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w: 1}, function(err, doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin5', 'admin5', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin5', 'admin5', function(err, replies) {
+
+        // Retrive the profiling level
+        adminDb.profilingLevel(function(err, level) {
+
+          adminDb.removeUser('admin5', function(err, result) {
+            assert.ok(result);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        ping

        +

        Ping the MongoDB server and retrieve results

        +
        +
        +ping(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from ping or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how to add a user to the admin database

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // Add the new user to the admin database
+  adminDb.addUser('admin9', 'admin9', function(err, result) {
+
+    // Authenticate using the newly added user
+    adminDb.authenticate('admin9', 'admin9', function(err, result) {
+      assert.ok(result);
+
+      // Ping the server
+      adminDb.ping(function(err, pingResult) {
+        assert.equal(null, err);
+
+        adminDb.removeUser('admin9', function(err, result) {
+          assert.ok(result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        authenticate

        +

        Authenticate against MongoDB

        +
        +
        +authenticate(username, password, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • username (string) – The user name for the authentication.
          • +
        • password (string) – The password for the authentication.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from authenticate or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        Authenticate against MongoDB Admin user

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+db.open(function(err, db) {
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w:1}, function(err, doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin2', 'admin2', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin2', 'admin2', function(err, result) {
+        assert.ok(result);
+
+        adminDb.removeUser('admin2', function(err, result) {
+          assert.ok(result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        logout

        +

        Logout current authenticated user

        +
        +
        +logout([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (object) – Optional parameters to the command.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from logout or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how add a user, authenticate and logout

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // Add the new user to the admin database
+  adminDb.addUser('admin10', 'admin10', function(err, result) {
+
+    // Authenticate using the newly added user
+    adminDb.authenticate('admin10', 'admin10', function(err, result) {
+      assert.ok(result);
+
+      // Logout the user
+      adminDb.logout(function(err, result) {
+        assert.equal(true, result);
+
+        adminDb.removeUser('admin10', function(err, result) {
+          assert.ok(result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        addUser

        +

        Add a user to the MongoDB server, if the user exists it will +overwrite the current password

        +
        +
        Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +addUser(username, password[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • username (string) – The user name for the authentication.
          • +
        • password (string) – The password for the authentication.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from addUser or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how to add a user to the admin database

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // Add the new user to the admin database
+  adminDb.addUser('admin11', 'admin11', function(err, result) {
+
+    // Authenticate using the newly added user
+    adminDb.authenticate('admin11', 'admin11', function(err, result) {
+      assert.ok(result);
+
+      adminDb.removeUser('admin11', function(err, result) {
+        assert.ok(result);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        removeUser

        +

        Remove a user from the MongoDB server

        +
        +
        Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +removeUser(username[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • username (string) – The user name for the authentication.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from removeUser or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how to remove a user from the admin database

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // Add the new user to the admin database
+  adminDb.addUser('admin12', 'admin12', function(err, result) {
+
+    // Authenticate using the newly added user
+    adminDb.authenticate('admin12', 'admin12', function(err, result) {
+      assert.ok(result);
+
+      // Remove the user
+      adminDb.removeUser('admin12', function(err, result) {
+        assert.equal(null, err);
+        assert.equal(true, result);
+
+        // Authenticate using the removed user should fail
+        adminDb.authenticate('admin12', 'admin12', function(err, result) {
+          assert.ok(err != null);
+          assert.ok(!result);
+
+          db.close();
+        });
+      })
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        setProfilingLevel

        +

        Set the current profiling level of MongoDB

        +
        +
        +setProfilingLevel(level, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • level (string) – The new profiling level (off, slow_only, all)
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from setProfilingLevel or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how to use the setProfilingInfo +Use this command to set the Profiling level on the MongoDB server

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w: 1}, function(err, doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin6', 'admin6', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin6', 'admin6', function(err, replies) {
+
+        // Set the profiling level to only profile slow queries
+        adminDb.setProfilingLevel('slow_only', function(err, level) {
+
+          // Retrive the profiling level and verify that it's set to slow_only
+          adminDb.profilingLevel(function(err, level) {
+            assert.equal('slow_only', level);
+
+            // Turn profiling off
+            adminDb.setProfilingLevel('off', function(err, level) {
+
+              // Retrive the profiling level and verify that it's set to off
+              adminDb.profilingLevel(function(err, level) {
+                assert.equal('off', level);
+
+                // Set the profiling level to log all queries
+                adminDb.setProfilingLevel('all', function(err, level) {
+
+                  // Retrive the profiling level and verify that it's set to all
+                  adminDb.profilingLevel(function(err, level) {
+                    assert.equal('all', level);
+
+                    // Attempt to set an illegal profiling level
+                    adminDb.setProfilingLevel('medium', function(err, level) {
+                      assert.ok(err instanceof Error);
+                      assert.equal("Error: illegal profiling level value medium", err.message);
+
+                      adminDb.removeUser('admin6', function(err, result) {
+                        assert.ok(result);
+
+                        db.close();
+                      });
+                    });
+                  })
+                });
+              })
+            });
+          })
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        profilingInfo

        +

        Retrive the current profiling information for MongoDB

        +
        +
        +profilingInfo(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from profilingInfo or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how to use the profilingInfo +Use this command to pull back the profiling information currently set for Mongodb

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w: 1}, function(doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin7', 'admin7', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin7', 'admin7', function(err, replies) {
+
+        // Set the profiling level to all
+        adminDb.setProfilingLevel('all', function(err, level) {
+
+          // Execute a query command
+          collection.find().toArray(function(err, items) {
+
+            // Turn off profiling
+            adminDb.setProfilingLevel('off', function(err, level) {
+
+              // Retrive the profiling information
+              adminDb.profilingInfo(function(err, infos) {
+                assert.ok(infos.constructor == Array);
+                assert.ok(infos.length >= 1);
+                assert.ok(infos[0].ts.constructor == Date);
+                assert.ok(infos[0].millis.constructor == Number);
+
+                adminDb.removeUser('admin7', function(err, result) {
+                  assert.ok(result);
+
+                  db.close();
+                });
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        command

        +

        Execute a db command against the Admin database

        +
        +
        +command(command[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • command (object) – A command object {ping:1}.
          • +
        • [options] (object) – Optional parameters to the command.
          • +
        • callback (function) – this will be called after executing this method. The command always return the whole result of the command as the second parameter.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        Retrieve the buildInfo using the command function

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // Add the new user to the admin database
+  adminDb.addUser('admin4', 'admin4', function(err, result) {
+
+    // Authenticate using the newly added user
+    adminDb.authenticate('admin4', 'admin4', function(err, result) {
+      assert.ok(result);
+
+      // Retrive the build information using the admin command
+      adminDb.command({buildInfo:1}, function(err, info) {
+        assert.ok(err == null);
+
+        adminDb.removeUser('admin4', function(err, result) {
+          assert.ok(result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        validateCollection

        +

        Validate an existing collection

        +
        +
        +validateCollection(collectionName[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – The name of the collection to validate.
          • +
        • [options] (object) – Optional parameters to the command.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from validateCollection or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of how to use the validateCollection command +Use this command to check that a collection is valid (not corrupt) and to get various statistics.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w: 1}, function(err, doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin8', 'admin8', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin8', 'admin8', function(err, replies) {
+
+        // Validate the 'test' collection
+        adminDb.validateCollection('test', function(err, doc) {
+
+          // Pre 1.9.1 servers
+          if(doc.result != null) {
+            assert.ok(doc.result != null);
+            assert.ok(doc.result.match(/firstExtent/) != null);
+          } else {
+            assert.ok(doc.firstExtent != null);
+          }
+
+          adminDb.removeUser('admin8', function(err, result) {
+            assert.ok(result);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        listDatabases

        +

        List the available databases

        +
        +
        +listDatabases(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from listDatabases or null if an error occured.
          • +
        +
        Returns:

        null Returns no result

        +
        +
        + +

        Examples

        +
        +

        An example of listing all available databases.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin();
+
+  // List all the available databases
+  adminDb.listDatabases(function(err, dbs) {
+    assert.equal(null, err);
+    assert.ok(dbs.databases.length > 0);
+
+    db.close();
+  });
+});
+
        +
        +
        +
        +
        +

        replSetGetStatus

        +

        Get ReplicaSet status

        +
        +
        +replSetGetStatus(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from replSetGetStatus or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Retrieve the current replicaset status if the server is running as part of a replicaset

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Grab a collection object
+  var collection = db.collection('test');
+
+  // Force the creation of the collection by inserting a document
+  // Collections are not created until the first document is inserted
+  collection.insert({'a':1}, {w: 1}, function(err, doc) {
+
+    // Use the admin database for the operation
+    var adminDb = db.admin();
+
+    // Add the new user to the admin database
+    adminDb.addUser('admin14', 'admin14', function(err, result) {
+
+      // Authenticate using the newly added user
+      adminDb.authenticate('admin14', 'admin14', function(err, result) {
+
+        // Retrive the server Info, returns error if we are not
+        // running a replicaset
+        adminDb.replSetGetStatus(function(err, info) {
+
+          adminDb.removeUser('admin14', function(err, result) {
+            assert.ok(result);
+
+            db.close();
+          });
+        })
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/collection.html b/api-generated/collection.html new file mode 100644 index 00000000000..51d710b062a --- /dev/null +++ b/api-generated/collection.html @@ -0,0 +1,3335 @@ + + + + + + + + + + Collection() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Collection()

        +
        +

        Constructor

        +

        Create a new Collection instance (INTERNAL TYPE)

        +
        +
        +
        +class Collection()
        +
        +++ + + + + + +
        Arguments:
          +
        • db (object) – db instance.
          • +
        • collectionName (string) – collection name.
          • +
        • [pkFactory] (object) – alternative primary key factory.
          • +
        • [options] (object) – additional options for the collection.
          • +
        +
        Returns:

        object a collection instance.

        +
        +
        + +
        +
        +
        Options
        +
          +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        • slaveOk {Boolean, default:false}, Allow reads from secondaries.
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions on the document.
          • +
        • raw {Boolean, default:false}, perform all operations using raw bson objects.
          • +
        • pkFactory {Object}, object overriding the basic ObjectID primary key generation.
          • +
        +
        +
        +
        +
        +

        insert

        +

        Inserts a single document or a an array of documents into MongoDB.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • continueOnError/keepGoing {Boolean, default:false}, keep inserting documents even if one document has an error, mongodb 1.9.1 >.
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions on the document.
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +insert(docs[, options][, callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • docs (array) –
          • +
        • [options] (object) – optional options for insert command
          • +
        • [callback] (function) – optional callback for the function, must be provided when using a writeconcern
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple document insert example, not using safe mode to ensure document persistance on MongoDB

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Fetch a collection to insert document into
+var collection = db.collection("simple_document_insert_collection_no_safe");
+// Insert a single document
+collection.insert({hello:'world_no_safe'});
+
+// Wait for a second before finishing up, to ensure we have written the item to disk
+setTimeout(function() {
+
+  // Fetch the document
+  collection.findOne({hello:'world_no_safe'}, function(err, item) {
+    assert.equal(null, err);
+    assert.equal('world_no_safe', item.hello);
+  })
+}, 100);
+
        +
        +

        A batch document insert example, using safe mode to ensure document persistance on MongoDB

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Fetch a collection to insert document into
+var collection = db.collection("batch_document_insert_collection_safe");
+// Insert a single document
+collection.insert([{hello:'world_safe1'}
+  , {hello:'world_safe2'}], {w:1}, function(err, result) {
+  assert.equal(null, err);
+
+  // Fetch the document
+  collection.findOne({hello:'world_safe2'}, function(err, item) {
+    assert.equal(null, err);
+    assert.equal('world_safe2', item.hello);
+  })
+});
+
        +
        +

        Example of inserting a document containing functions

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Fetch a collection to insert document into
+var collection = db.collection("simple_document_insert_with_function_safe");
+// Insert a single document
+collection.insert({hello:'world'
+  , func:function() {}}, {w:1, serializeFunctions:true}, function(err, result) {
+  assert.equal(null, err);
+
+  // Fetch the document
+  collection.findOne({hello:'world'}, function(err, item) {
+    assert.equal(null, err);
+    assert.ok("function() {}", item.code);
+  })
+});
+
        +
        +

        Example of using keepGoing to allow batch insert to complete even when there are illegal documents in the batch

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Only run the rest of the code if we have a mongodb server with version >= 1.9.1
+db.admin().serverInfo(function(err, result){
+
+  // Ensure we are running at least MongoDB v1.9.1
+  if(parseInt((result.version.replace(/\./g, ''))) >= 191) {
+
+    // Create a collection
+    var collection = db.collection('keepGoingExample');
+
+    // Add an unique index to title to force errors in the batch insert
+    collection.ensureIndex({title:1}, {unique:true}, function(err, indexName) {
+
+      // Insert some intial data into the collection
+      collection.insert([{name:"Jim"}
+        , {name:"Sarah", title:"Princess"}], {w:1}, function(err, result) {
+
+        // Force keep going flag, ignoring unique index issue
+        collection.insert([{name:"Jim"}
+          , {name:"Sarah", title:"Princess"}
+          , {name:'Gump', title:"Gump"}], {w:1, keepGoing:true}, function(err, result) {
+
+          // Count the number of documents left (should not include the duplicates)
+          collection.count(function(err, count) {
+            assert.equal(3, count);
+          })
+        });
+      });
+    });
+  } else {
+    test.done();
+  }
+});
+
        +
        +
        +
        +
        +

        remove

        +

        Removes documents specified by <code>selector</code> from the db.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • single {Boolean, default:false}, removes the first document found.
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +remove([selector][, options], [callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • [selector] (object) – optional select, no selector is equivalent to removing all documents.
          • +
        • [options] (object) – additional options during remove.
          • +
        • [callback] (function) – must be provided if you performing a remove with a writeconcern
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example removing all documents in a collection not using safe mode

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch a collection to insert document into
+  db.collection("remove_all_documents_no_safe", function(err, collection) {
+
+    // Insert a bunch of documents
+    collection.insert([{a:1}, {b:2}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Remove all the document
+      collection.remove();
+
+      // Fetch all results
+      collection.find().toArray(function(err, items) {
+        assert.equal(null, err);
+        assert.equal(0, items.length);
+        db.close();
+      });
+    });
+  })
+});
+
        +
        +

        An example removing a subset of documents using safe mode to ensure removal of documents

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch a collection to insert document into
+  db.collection("remove_subset_of_documents_safe", function(err, collection) {
+
+    // Insert a bunch of documents
+    collection.insert([{a:1}, {b:2}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Remove all the document
+      collection.remove({a:1}, {w:1}, function(err, numberOfRemovedDocs) {
+        assert.equal(null, err);
+        assert.equal(1, numberOfRemovedDocs);
+        db.close();
+      });
+    });
+  })
+});
+
        +
        +
        +
        +
        +

        rename

        +

        Renames the collection.

        +
        +
        Options
        +
          +
        • dropTarget {Boolean, default:false}, drop the target name collection if it previously exists.
          • +
        +
        +
        +
        +
        +rename(newName[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • newName (string) – the new name of the collection.
          • +
        • [options] (object) – returns option results.
          • +
        • callback (function) – the callback accepting the result
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of illegal and legal renaming of a collection

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Open a couple of collections
+  db.createCollection('test_rename_collection', function(err, collection1) {
+    db.createCollection('test_rename_collection2', function(err, collection2) {
+
+      // Attemp to rename a collection to a number
+      try {
+        collection1.rename(5, function(err, collection) {});
+      } catch(err) {
+        assert.ok(err instanceof Error);
+        assert.equal("collection name must be a String", err.message);
+      }
+
+      // Attemp to rename a collection to an empty string
+      try {
+        collection1.rename("", function(err, collection) {});
+      } catch(err) {
+        assert.ok(err instanceof Error);
+        assert.equal("collection names cannot be empty", err.message);
+      }
+
+      // Attemp to rename a collection to an illegal name including the character $
+      try {
+        collection1.rename("te$t", function(err, collection) {});
+      } catch(err) {
+        assert.ok(err instanceof Error);
+        assert.equal("collection names must not contain '$'", err.message);
+      }
+
+      // Attemp to rename a collection to an illegal name starting with the character .
+      try {
+        collection1.rename(".test", function(err, collection) {});
+      } catch(err) {
+        assert.ok(err instanceof Error);
+        assert.equal("collection names must not start or end with '.'", err.message);
+      }
+
+      // Attemp to rename a collection to an illegal name ending with the character .
+      try {
+        collection1.rename("test.", function(err, collection) {});
+      } catch(err) {
+        assert.ok(err instanceof Error);
+        assert.equal("collection names must not start or end with '.'", err.message);
+      }
+
+      // Attemp to rename a collection to an illegal name with an empty middle name
+      try {
+        collection1.rename("tes..t", function(err, collection) {});
+      } catch(err) {
+        assert.equal("collection names cannot be empty", err.message);
+      }
+
+      // Insert a couple of documents
+      collection1.insert([{'x':1}, {'x':2}], {w:1}, function(err, docs) {
+
+        // Attemp to rename the first collection to the second one, this will fail
+        collection1.rename('test_rename_collection2', function(err, collection) {
+          assert.ok(err instanceof Error);
+          assert.ok(err.message.length > 0);
+
+          // Attemp to rename the first collection to a name that does not exist
+          // this will be succesful
+          collection1.rename('test_rename_collection3', function(err, collection) {
+            assert.equal("test_rename_collection3", collection.collectionName);
+
+            // Ensure that the collection is pointing to the new one
+            collection1.count(function(err, count) {
+              assert.equal(2, count);
+              db.close();
+            });
+          });
+        });
+      })
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        save

        +

        Save a document. Simple full document replacement function. Not recommended for efficiency, use atomic +operators and update instead for more efficient operations.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +save([doc][, options], [callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • [doc] (object) – the document to save
          • +
        • [options] (object) – additional options during remove.
          • +
        • [callback] (function) – must be provided if you performing a safe save
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple document save with safe set to false

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch the collection
+  var collection = db.collection("save_a_simple_document");
+  // Save a document with no safe option
+  collection.save({hello:'world'});
+
+  // Wait for a second
+  setTimeout(function() {
+
+    // Find the saved document
+    collection.findOne({hello:'world'}, function(err, item) {
+      assert.equal(null, err);
+      assert.equal('world', item.hello);
+      db.close();
+    });
+  }, 1000);
+});
+
        +
        +

        Example of a simple document save and then resave with safe set to true

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch the collection
+  var collection = db.collection("save_a_simple_document_modify_it_and_resave_it");
+
+  // Save a document with no safe option
+  collection.save({hello:'world'}, {w: 0}, function(err, result) {
+
+    // Find the saved document
+    collection.findOne({hello:'world'}, function(err, item) {
+      assert.equal(null, err);
+      assert.equal('world', item.hello);
+
+      // Update the document
+      item['hello2'] = 'world2';
+
+      // Save the item with the additional field
+      collection.save(item, {w: 1}, function(err, result) {
+
+        // Find the changed document
+        collection.findOne({hello:'world'}, function(err, item) {
+          assert.equal(null, err);
+          assert.equal('world', item.hello);
+          assert.equal('world2', item.hello2);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        update

        +

        Updates documents.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • upsert {Boolean, default:false}, perform an upsert operation.
          • +
        • multi {Boolean, default:false}, update all documents matching the selector.
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions on the document.
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +update(selector, document[, options][, callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • selector (object) – the query to select the document/documents to be updated
          • +
        • document (object) – the fields/vals to be updated, or in the case of an upsert operation, inserted.
          • +
        • [options] (object) – additional options during update.
          • +
        • [callback] (function) – must be provided if you performing an update with a writeconcern
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple document update with safe set to false on an existing document

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Get a collection
+  db.collection('update_a_simple_document', function(err, collection) {
+
+    // Insert a document, then update it
+    collection.insert({a:1}, {w: 1}, function(err, doc) {
+
+      // Update the document with an atomic operator
+      collection.update({a:1}, {$set:{b:2}});
+
+      // Wait for a second then fetch the document
+      setTimeout(function() {
+
+        // Fetch the document that we modified
+        collection.findOne({a:1}, function(err, item) {
+          assert.equal(null, err);
+          assert.equal(1, item.a);
+          assert.equal(2, item.b);
+          db.close();
+        });
+      }, 1000);
+    })
+  });
+});
+
        +
        +

        Example of a simple document update using upsert (the document will be inserted if it does not exist)

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Get a collection
+  db.collection('update_a_simple_document_upsert', function(err, collection) {
+
+    // Update the document using an upsert operation, ensuring creation if it does not exist
+    collection.update({a:1}, {b:2, a:1}, {upsert:true, w: 1}, function(err, result) {
+      assert.equal(null, err);
+      assert.equal(1, result);
+
+      // Fetch the document that we modified and check if it got inserted correctly
+      collection.findOne({a:1}, function(err, item) {
+        assert.equal(null, err);
+        assert.equal(1, item.a);
+        assert.equal(2, item.b);
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +

        Example of an update across multiple documents using the multi option.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Get a collection
+  db.collection('update_a_simple_document_multi', function(err, collection) {
+
+    // Insert a couple of documentations
+    collection.insert([{a:1, b:1}, {a:1, b:2}], {w: 1}, function(err, result) {
+
+      // Update multiple documents using the multi option
+      collection.update({a:1}, {$set:{b:0}}, {w: 1, multi:true}, function(err, numberUpdated) {
+        assert.equal(null, err);
+        assert.equal(2, numberUpdated);
+
+        // Fetch all the documents and verify that we have changed the b value
+        collection.find().toArray(function(err, items) {
+          assert.equal(null, err);
+          assert.equal(1, items[0].a);
+          assert.equal(0, items[0].b);
+          assert.equal(1, items[1].a);
+          assert.equal(0, items[1].b);
+
+          db.close();
+        });
+      })
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        distinct

        +

        The distinct command returns returns a list of distinct values for the given key across a collection.

        +
        +
        Options
        +
          +
        • readPreference {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +distinct(key[, query][, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • key (string) – key to run distinct against.
          • +
        • [query] (object) – option query to narrow the returned objects.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from distinct or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of running the distinct command against a collection

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Crete the collection for the distinct example
+  db.createCollection('simple_key_based_distinct', function(err, collection) {
+
+    // Insert documents to perform distinct against
+    collection.insert([{a:0, b:{c:'a'}}, {a:1, b:{c:'b'}}, {a:1, b:{c:'c'}},
+      {a:2, b:{c:'a'}}, {a:3}, {a:3}], {w: 1}, function(err, ids) {
+
+      // Peform a distinct query against the a field
+      collection.distinct('a', function(err, docs) {
+        assert.deepEqual([0, 1, 2, 3], docs.sort());
+
+        // Perform a distinct query against the sub-field b.c
+        collection.distinct('b.c', function(err, docs) {
+          assert.deepEqual(['a', 'b', 'c'], docs.sort());
+
+          db.close();
+        });
+      });
+    })
+  });
+});
+
        +
        +

        Example of running the distinct command against a collection with a filter query

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Crete the collection for the distinct example
+  db.createCollection('simple_key_based_distinct_sub_query_filter', function(err, collection) {
+
+    // Insert documents to perform distinct against
+    collection.insert([{a:0, b:{c:'a'}}, {a:1, b:{c:'b'}}, {a:1, b:{c:'c'}},
+      {a:2, b:{c:'a'}}, {a:3}, {a:3}, {a:5, c:1}], {w: 1}, function(err, ids) {
+
+      // Peform a distinct query with a filter against the documents
+      collection.distinct('a', {c:1}, function(err, docs) {
+        assert.deepEqual([5], docs.sort());
+
+        db.close();
+      });
+    })
+  });
+});
+
        +
        +
        +
        +
        +

        count

        +

        Count number of matching documents in the db to a query.

        +
        +
        Options
        +
          +
        • skip {Number}, The number of documents to skip for the count.
          • +
        • limit {Number}, The limit of documents to count.
          • +
        • readPreference {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +count([query][, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [query] (object) – query to filter by before performing count.
          • +
        • [options] (object) – additional options during count.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the count method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of running simple count commands against a collection.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Crete the collection for the distinct example
+  db.createCollection('simple_count_example', function(err, collection) {
+
+    // Insert documents to perform distinct against
+    collection.insert([{a:1}, {a:2}, {a:3}, {a:4, b:1}], {w: 1}, function(err, ids) {
+
+      // Perform a total count command
+      collection.count(function(err, count) {
+        assert.equal(null, err);
+        assert.equal(4, count);
+
+        // Peform a partial account where b=1
+        collection.count({b:1}, function(err, count) {
+          assert.equal(null, err);
+          assert.equal(1, count);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        drop

        +

        Drop the collection

        +
        +
        +drop(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the drop method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple document save and then resave with safe set to true

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('test_other_drop', function(err, collection) {
+    assert.equal(null, err);
+
+    // Drop the collection
+    collection.drop(function(err, reply) {
+
+      // Ensure we don't have the collection in the set of names
+      db.collectionNames(function(err, replies) {
+
+        var found = false;
+        // For each collection in the list of collection names in this db look for the
+        // dropped collection
+        replies.forEach(function(document) {
+          if(document.name == "test_other_drop") {
+            found = true;
+            return;
+          }
+        });
+
+        // Ensure the collection is not found
+        assert.equal(false, found);
+
+        // Let's close the db
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        findAndModify

        +

        Find and update a document.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • remove {Boolean, default:false}, set to true to remove the object before returning.
          • +
        • upsert {Boolean, default:false}, perform an upsert operation.
          • +
        • new {Boolean, default:false}, set to true if you want to return the modified object rather than the original. Ignored for remove.
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +findAndModify(query, sort, doc[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • query (object) – query object to locate the object to modify
          • +
        • sort (array) –
            +
          • if multiple docs match, choose the first one in the specified sort order as the object to manipulate
            • +
          +
          • +
        • doc (object) –
            +
          • the fields/vals to be updated
            • +
          +
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the findAndModify method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A whole set of different ways to use the findAndModify command.

        +

        The first findAndModify command modifies a document and returns the modified document back. +The second findAndModify command removes the document. +The second findAndModify command upserts a document and returns the new document.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_find_and_modify_operations_', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some test documentations
+    collection.insert([{a:1}, {b:1}, {c:1}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Simple findAndModify command returning the new document
+      collection.findAndModify({a:1}, [['a', 1]], {$set:{b1:1}}, {new:true}, function(err, doc) {
+        assert.equal(null, err);
+        assert.equal(1, doc.a);
+        assert.equal(1, doc.b1);
+
+        // Simple findAndModify command returning the new document and
+        // removing it at the same time
+        collection.findAndModify({b:1}, [['b', 1]],
+          {$set:{b:2}}, {remove:true}, function(err, doc) {
+
+          // Verify that the document is gone
+          collection.findOne({b:1}, function(err, item) {
+            assert.equal(null, err);
+            assert.equal(null, item);
+
+            // Simple findAndModify command performing an upsert and returning the new document
+            // executing the command safely
+            collection.findAndModify({d:1}, [['b', 1]],
+              {d:1, f:1}, {new:true, upsert:true, w:1}, function(err, doc) {
+                assert.equal(null, err);
+                assert.equal(1, doc.d);
+                assert.equal(1, doc.f);
+
+                db.close();
+            })
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        findAndRemove

        +

        Find and remove a document

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +findAndRemove(query, sort[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • query (object) – query object to locate the object to modify
          • +
        • sort (array) –
            +
          • if multiple docs match, choose the first one in the specified sort order as the object to manipulate
            • +
          +
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the findAndRemove method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of using findAndRemove

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_find_and_modify_operations_', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some test documentations
+    collection.insert([{a:1}, {b:1}, {c:1}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Simple findAndModify command returning the new document and
+      // removing it at the same time
+      collection.findAndRemove({b:1}, [['b', 1]], function(err, doc) {
+        assert.equal(null, err);
+        assert.equal(1, doc.b);
+
+        // Verify that the document is gone
+        collection.findOne({b:1}, function(err, item) {
+          assert.equal(null, err);
+          assert.equal(null, item);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        find

        +

        Creates a cursor for a query that can be used to iterate over results from MongoDB

        +
        +
        Various argument possibilities
        +
          +
        • callback?
          • +
        • selector, callback?,
          • +
        • selector, fields, callback?
          • +
        • selector, options, callback?
          • +
        • selector, fields, options, callback?
          • +
        • selector, fields, skip, limit, callback?
          • +
        • selector, fields, skip, limit, timeout, callback?
          • +
        +
        +
        Options
        +
          +
        • limit {Number, default:0}, sets the limit of documents returned in the query.
          • +
        • sort {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [[‘a’, 1]] etc.
          • +
        • fields {Object}, the fields to return in the query. Object of fields to include or exclude (not both), {‘a’:1}
          • +
        • skip {Number, default:0}, set to skip N documents ahead in your query (useful for pagination).
          • +
        • hint {Object}, tell the query to use specific indexes in the query. Object of indexes to use, {‘_id’:1}
          • +
        • explain {Boolean, default:false}, explain the query instead of returning the data.
          • +
        • snapshot {Boolean, default:false}, snapshot query.
          • +
        • timeout {Boolean, default:false}, specify if the cursor can timeout.
          • +
        • tailable {Boolean, default:false}, specify if the cursor is tailable.
          • +
        • tailableRetryInterval {Number, default:100}, specify the miliseconds between getMores on tailable cursor.
          • +
        • numberOfRetries {Number, default:5}, specify the number of times to retry the tailable cursor.
          • +
        • awaitdata {Boolean, default:false} allow the cursor to wait for data, only applicable for tailable cursor.
          • +
        • exhaust {Boolean, default:false} have the server send all the documents at once as getMore packets, not recommended.
          • +
        • batchSize {Number, default:0}, set the batchSize for the getMoreCommand when iterating over the query results.
          • +
        • returnKey {Boolean, default:false}, only return the index key.
          • +
        • maxScan {Number}, Limit the number of items to scan.
          • +
        • min {Number}, Set index bounds.
          • +
        • max {Number}, Set index bounds.
          • +
        • showDiskLoc {Boolean, default:false}, Show disk location of results.
          • +
        • comment {String}, You can put a $comment field on a query to make looking in the profiler logs simpler.
          • +
        • raw {Boolean, default:false}, Return all BSON documents as Raw Buffer documents.
          • +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        • numberOfRetries {Number, default:5}, if using awaidata specifies the number of times to retry on timeout.
          • +
        • partial {Boolean, default:false}, specify if the cursor should return partial results when querying against a sharded system
          • +
        +
        +
        +
        +
        +find(query[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • query (object) – query object to locate the object to modify
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the find method or null if an error occured.
          • +
        +
        Returns:

        cursor returns a cursor to the query

        +
        +
        + +

        Examples

        +
        +

        A simple query using the find method on the collection.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_query', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the testing
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Peform a simple find and return all the documents
+      collection.find().toArray(function(err, docs) {
+        assert.equal(null, err);
+        assert.equal(3, docs.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +

        A simple query showing the explain for a query

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_explain_query', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the testing
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Peform a simple find and return all the documents
+      collection.find({}, {explain:true}).toArray(function(err, docs) {
+        assert.equal(null, err);
+        assert.equal(1, docs.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +

        A simple query showing skip and limit

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_limit_skip_query', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the testing
+    collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Peform a simple find and return all the documents
+      collection.find({}, {skip:1, limit:1, fields:{b:1}}).toArray(function(err, docs) {
+        assert.equal(null, err);
+        assert.equal(1, docs.length);
+        assert.equal(null, docs[0].a);
+        assert.equal(2, docs[0].b);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        findOne

        +

        Finds a single document based on the query

        +
        +
        Various argument possibilities
        +
          +
        • callback?
          • +
        • selector, callback?,
          • +
        • selector, fields, callback?
          • +
        • selector, options, callback?
          • +
        • selector, fields, options, callback?
          • +
        • selector, fields, skip, limit, callback?
          • +
        • selector, fields, skip, limit, timeout, callback?
          • +
        +
        +
        Options
        +
          +
        • limit {Number, default:0}, sets the limit of documents returned in the query.
          • +
        • sort {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [[‘a’, 1]] etc.
          • +
        • fields {Object}, the fields to return in the query. Object of fields to include or exclude (not both), {‘a’:1}
          • +
        • skip {Number, default:0}, set to skip N documents ahead in your query (useful for pagination).
          • +
        • hint {Object}, tell the query to use specific indexes in the query. Object of indexes to use, {‘_id’:1}
          • +
        • explain {Boolean, default:false}, explain the query instead of returning the data.
          • +
        • snapshot {Boolean, default:false}, snapshot query.
          • +
        • timeout {Boolean, default:false}, specify if the cursor can timeout.
          • +
        • tailable {Boolean, default:false}, specify if the cursor is tailable.
          • +
        • batchSize {Number, default:0}, set the batchSize for the getMoreCommand when iterating over the query results.
          • +
        • returnKey {Boolean, default:false}, only return the index key.
          • +
        • maxScan {Number}, Limit the number of items to scan.
          • +
        • min {Number}, Set index bounds.
          • +
        • max {Number}, Set index bounds.
          • +
        • showDiskLoc {Boolean, default:false}, Show disk location of results.
          • +
        • comment {String}, You can put a $comment field on a query to make looking in the profiler logs simpler.
          • +
        • raw {Boolean, default:false}, Return all BSON documents as Raw Buffer documents.
          • +
        • readPreference {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        • partial {Boolean, default:false}, specify if the cursor should return partial results when querying against a sharded system
          • +
        +
        +
        +
        +
        +findOne(query[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • query (object) – query object to locate the object to modify
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the findOne method or null if an error occured.
          • +
        +
        Returns:

        cursor returns a cursor to the query

        +
        +
        + +

        Examples

        +
        +

        A simple query using findOne

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_limit_skip_find_one_query', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the testing
+    collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Peform a simple find and return all the documents
+      collection.findOne({a:2}, {fields:{b:1}}, function(err, doc) {
+        assert.equal(null, err);
+        assert.equal(null, doc.a);
+        assert.equal(2, doc.b);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        createIndex

        +

        Creates an index on the collection.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • unique {Boolean, default:false}, creates an unique index.
          • +
        • sparse {Boolean, default:false}, creates a sparse index.
          • +
        • background {Boolean, default:false}, creates the index in the background, yielding whenever possible.
          • +
        • dropDups {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value
          • +
        • min {Number}, for geospatial indexes set the lower bound for the co-ordinates.
          • +
        • max {Number}, for geospatial indexes set the high bound for the co-ordinates.
          • +
        • v {Number}, specify the format version of the indexes.
          • +
        • expireAfterSeconds {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
          • +
        • name {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes)
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +createIndex(fieldOrSpec[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • fieldOrSpec (object) – fieldOrSpec that defines the index.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the createIndex method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple createIndex using a simple single field index

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('simple_index_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1}, {a:2}, {a:3}, {a:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.createIndex('a', {w:1}, function(err, indexName) {
+        assert.equal("a_1", indexName);
+
+        // Peform a query, with explain to show we hit the query
+        collection.find({a:2}, {explain:true}).toArray(function(err, explanation) {
+          assert.deepEqual([[2, 2]], explanation[0].indexBounds.a);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +

        A more complex createIndex using a compound unique index in the background and dropping duplicated documents

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('more_complex_index_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.createIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Show that duplicate records got dropped
+        collection.find({}).toArray(function(err, items) {
+          assert.equal(null, err);
+          assert.equal(4, items.length);
+
+          // Peform a query, with explain to show we hit the query
+          collection.find({a:2}, {explain:true}).toArray(function(err, explanation) {
+            assert.equal(null, err);
+            assert.ok(explanation[0].indexBounds.a != null);
+            assert.ok(explanation[0].indexBounds.b != null);
+
+            db.close();
+          });
+        })
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        ensureIndex

        +

        Ensures that an index exists, if it does not it creates it

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • unique {Boolean, default:false}, creates an unique index.
          • +
        • sparse {Boolean, default:false}, creates a sparse index.
          • +
        • background {Boolean, default:false}, creates the index in the background, yielding whenever possible.
          • +
        • dropDups {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value
          • +
        • min {Number}, for geospatial indexes set the lower bound for the co-ordinates.
          • +
        • max {Number}, for geospatial indexes set the high bound for the co-ordinates.
          • +
        • v {Number}, specify the format version of the indexes.
          • +
        • expireAfterSeconds {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
          • +
        • name {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes)
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +ensureIndex(fieldOrSpec[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • fieldOrSpec (object) – fieldOrSpec that defines the index.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the ensureIndex method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('more_complex_ensure_index_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Show that duplicate records got dropped
+        collection.find({}).toArray(function(err, items) {
+          assert.equal(null, err);
+          assert.equal(4, items.length);
+
+          // Peform a query, with explain to show we hit the query
+          collection.find({a:2}, {explain:true}).toArray(function(err, explanation) {
+            assert.equal(null, err);
+            assert.ok(explanation[0].indexBounds.a != null);
+            assert.ok(explanation[0].indexBounds.b != null);
+
+            db.close();
+          });
+        })
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        indexInformation

        +

        Retrieves this collections index info.

        +
        +
        Options
        +
          +
        • full {Boolean, default:false}, returns the full raw index information.
          • +
        +
        +
        +
        +
        +indexInformation([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the indexInformation method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An examples showing the information returned by indexInformation

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('more_index_information_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Fetch basic indexInformation for collection
+        collection.indexInformation(function(err, indexInformation) {
+          assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_);
+          assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1);
+
+          // Fetch full index information
+          collection.indexInformation({full:true}, function(err, indexInformation) {
+            assert.deepEqual({ _id: 1 }, indexInformation[0].key);
+            assert.deepEqual({ a: 1, b: 1 }, indexInformation[1].key);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        dropIndex

        +

        Drops an index from this collection.

        +
        +
        +dropIndex(name, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • name (string) –
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the dropIndex method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An examples showing the creation and dropping of an index

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('create_and_drop_an_index', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Drop the index
+        collection.dropIndex("a_1_b_1", function(err, result) {
+          assert.equal(null, err);
+
+          // Verify that the index is gone
+          collection.indexInformation(function(err, indexInformation) {
+            assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_);
+            assert.equal(null, indexInformation.a_1_b_1);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        dropAllIndexes

        +

        Drops all indexes from this collection.

        +
        +
        +dropAllIndexes(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the dropAllIndexes method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +
        +
        +

        reIndex

        +

        Reindex all indexes on the collection +Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections.

        +
        +
        +reIndex(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the reIndex method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example showing how to force a reindex of a collection.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('shouldCorrectlyForceReindexOnCollection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Force a reindex of the collection
+        collection.reIndex(function(err, result) {
+          assert.equal(null, err);
+          assert.equal(true, result);
+
+          // Verify that the index is gone
+          collection.indexInformation(function(err, indexInformation) {
+            assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_);
+            assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        mapReduce

        +

        Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.

        +
        +
        Options
        +
          +
        • out {Object, default:{inline:1}}, sets the output target for the map reduce job. {inline:1} | {replace:’collectionName’} | {merge:’collectionName’} | {reduce:’collectionName’}
          • +
        • query {Object}, query filter object.
          • +
        • sort {Object}, sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces.
          • +
        • limit {Number}, number of objects to return from collection.
          • +
        • keeptemp {Boolean, default:false}, keep temporary data.
          • +
        • finalize {Function | String}, finalize function.
          • +
        • scope {Object}, can pass in variables that can be access from map/reduce/finalize.
          • +
        • jsMode {Boolean, default:false}, it is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X.
          • +
        • verbose {Boolean, default:false}, provide statistics on job execution time.
          • +
        • readPreference {String, only for inline results}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +mapReduce(map, reduce[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • map (function) – the mapping function.
          • +
        • reduce (function) – the reduce function.
          • +
        • [options] (objects) – options for the map reduce job.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the mapReduce method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple map reduce example

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a test collection
+  db.createCollection('test_map_reduce_functions', function(err, collection) {
+
+    // Insert some documents to perform map reduce over
+    collection.insert([{'user_id':1}, {'user_id':2}], {w:1}, function(err, r) {
+
+      // Map function
+      var map = function() { emit(this.user_id, 1); };
+      // Reduce function
+      var reduce = function(k,vals) { return 1; };
+
+      // Peform the map reduce
+      collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}}, function(err, collection) {
+        // Mapreduce returns the temporary collection with the results
+        collection.findOne({'_id':1}, function(err, result) {
+          assert.equal(1, result.value);
+
+          collection.findOne({'_id':2}, function(err, result) {
+            assert.equal(1, result.value);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +

        A simple map reduce example using the inline output type on MongoDB > 1.7.6 returning the statistics

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Parse version of server if available
+  db.admin().serverInfo(function(err, result){
+
+    // Only run if the MongoDB version is higher than 1.7.6
+    if(parseInt((result.version.replace(/\./g, ''))) >= 176) {
+
+      // Create a test collection
+      db.createCollection('test_map_reduce_functions_inline', function(err, collection) {
+
+        // Insert some test documents
+        collection.insert([{'user_id':1}, {'user_id':2}], {w:1}, function(err, r) {
+
+          // Map function
+          var map = function() { emit(this.user_id, 1); };
+          // Reduce function
+          var reduce = function(k,vals) { return 1; };
+
+          // Execute map reduce and return results inline
+          collection.mapReduce(map, reduce, {out : {inline: 1}, verbose:true}, function(err, results, stats) {
+            assert.equal(2, results.length);
+            assert.ok(stats != null);
+
+            collection.mapReduce(map, reduce, {out : {replace: 'mapreduce_integration_test'}, verbose:true}, function(err, results, stats) {
+              assert.ok(stats != null);
+              db.close();
+            });
+          });
+        });
+      });
+    } else {
+      test.done();
+    }
+  });
+});
+
        +
        +

        Mapreduce different test with a provided scope containing a javascript function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a test collection
+  db.createCollection('test_map_reduce_functions_scope', function(err, collection) {
+
+    // Insert some test documents
+    collection.insert([{'user_id':1, 'timestamp':new Date()}
+      , {'user_id':2, 'timestamp':new Date()}], {w:1}, function(err, r) {
+
+      // Map function
+      var map = function(){
+          emit(fn(this.timestamp.getYear()), 1);
+      }
+
+      // Reduce function
+      var reduce = function(k, v){
+          count = 0;
+          for(i = 0; i < v.length; i++) {
+              count += v[i];
+          }
+          return count;
+      }
+
+      // Javascript function available in the map reduce scope
+      var t = function(val){ return val+1; }
+
+      // Execute the map reduce with the custom scope
+      var o = {};
+      o.scope =  { fn: new Code(t.toString()) }
+      o.out = { replace: 'replacethiscollection' }
+
+      collection.mapReduce(map, reduce, o, function(err, outCollection) {
+        assert.equal(null, err);
+
+        // Find all entries in the map-reduce collection
+        outCollection.find().toArray(function(err, results) {
+          assert.equal(null, err);
+          assert.equal(2, results[0].value)
+
+          // mapReduce with scope containing plain function
+          var o = {};
+          o.scope =  { fn: t }
+          o.out = { replace: 'replacethiscollection' }
+
+          collection.mapReduce(map, reduce, o, function(err, outCollection) {
+            assert.equal(null, err);
+
+            // Find all entries in the map-reduce collection
+            outCollection.find().toArray(function(err, results) {
+              assert.equal(2, results[0].value)
+              db.close();
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        group

        +

        Run a group command across a collection

        +
        +
        Options
        +
          +
        • readPreference {String}, the preferred read preference (Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +group(keys, condition, initial, reduce, finalize, command[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • keys (object) – an object, array or function expressing the keys to group by.
          • +
        • condition (object) – an optional condition that must be true for a row to be considered.
          • +
        • initial (object) – initial value of the aggregation counter object.
          • +
        • reduce (function) – the reduce function aggregates (reduces) the objects iterated
          • +
        • finalize (function) – an optional function to be run on each item in the result set just before the item is returned.
          • +
        • command (boolean) – specify if you wish to run using the internal group command or using eval, default is true.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the group method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A whole lot of different wayt to execute the group command

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a test collection
+  db.createCollection('test_group', function(err, collection) {
+
+    // Peform a simple group by on an empty collection
+    collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) {
+      assert.deepEqual([], results);
+
+      // Trigger some inserts on the collection
+      collection.insert([{'a':2}, {'b':5}, {'a':1}], {w:1}, function(err, ids) {
+
+        // Perform a group count
+        collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) {
+          assert.equal(3, results[0].count);
+
+          // Pefrom a group count using the eval method
+          collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", false, function(err, results) {
+            assert.equal(3, results[0].count);
+
+            // Group with a conditional
+            collection.group([], {'a':{'$gt':1}}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) {
+              // Results
+              assert.equal(1, results[0].count);
+
+              // Group with a conditional using the EVAL method
+              collection.group([], {'a':{'$gt':1}}, {"count":0}, "function (obj, prev) { prev.count++; }" , false, function(err, results) {
+                // Results
+                assert.equal(1, results[0].count);
+
+                // Insert some more test data
+                collection.insert([{'a':2}, {'b':3}], {w:1}, function(err, ids) {
+
+                  // Do a Group by field a
+                  collection.group(['a'], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) {
+                    // Results
+                    assert.equal(2, results[0].a);
+                    assert.equal(2, results[0].count);
+                    assert.equal(null, results[1].a);
+                    assert.equal(2, results[1].count);
+                    assert.equal(1, results[2].a);
+                    assert.equal(1, results[2].count);
+
+                    // Do a Group by field a
+                    collection.group({'a':true}, {}, {"count":0}, function (obj, prev) { prev.count++; }, true, function(err, results) {
+                      // Results
+                      assert.equal(2, results[0].a);
+                      assert.equal(2, results[0].count);
+                      assert.equal(null, results[1].a);
+                      assert.equal(2, results[1].count);
+                      assert.equal(1, results[2].a);
+                      assert.equal(1, results[2].count);
+
+                      // Correctly handle illegal function
+                      collection.group([], {}, {}, "5 ++ 5", function(err, results) {
+                        assert.ok(err.message != null);
+
+                        // Use a function to select the keys used to group by
+                        var keyf = function(doc) { return {a: doc.a}; };
+                        collection.group(keyf, {a: {$gt: 0}}, {"count": 0, "value": 0}, function(obj, prev) { prev.count++; prev.value += obj.a; }, true, function(err, results) {
+                          // Results
+                          results.sort(function(a, b) { return b.count - a.count; });
+                          assert.equal(2, results[0].count);
+                          assert.equal(2, results[0].a);
+                          assert.equal(4, results[0].value);
+                          assert.equal(1, results[1].count);
+                          assert.equal(1, results[1].a);
+                          assert.equal(1, results[1].value);
+
+                          // Use a Code object to select the keys used to group by
+                          var keyf = new Code(function(doc) { return {a: doc.a}; });
+                          collection.group(keyf, {a: {$gt: 0}}, {"count": 0, "value": 0}, function(obj, prev) { prev.count++; prev.value += obj.a; }, true, function(err, results) {
+                            // Results
+                            results.sort(function(a, b) { return b.count - a.count; });
+                            assert.equal(2, results[0].count);
+                            assert.equal(2, results[0].a);
+                            assert.equal(4, results[0].value);
+                            assert.equal(1, results[1].count);
+                            assert.equal(1, results[1].a);
+                            assert.equal(1, results[1].value);
+
+                            // Correctly handle illegal function when using the EVAL method
+                            collection.group([], {}, {}, "5 ++ 5", false, function(err, results) {
+                              assert.ok(err.message != null);
+
+                              db.close();
+                            });
+                          });
+                        });
+                      });
+                    });
+                  });
+                });
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        options

        +

        Returns the options of the collection.

        +
        +
        +options(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the options method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example returning the options for a collection.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a test collection that we are getting the options back from
+  db.createCollection('test_collection_options', {'capped':true, 'size':1024}, function(err, collection) {
+    assert.ok(collection instanceof Collection);
+    assert.equal('test_collection_options', collection.collectionName);
+
+    // Let's fetch the collection options
+    collection.options(function(err, options) {
+      assert.equal(true, options.capped);
+      assert.equal(1024, options.size);
+      assert.equal("test_collection_options", options.create);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        isCapped

        +

        Returns if the collection is a capped collection

        +
        +
        +isCapped(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the isCapped method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example showing how to establish if it’s a capped collection

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a test collection that we are getting the options back from
+  db.createCollection('test_collection_is_capped', {'capped':true, 'size':1024}, function(err, collection) {
+    assert.ok(collection instanceof Collection);
+    assert.equal('test_collection_is_capped', collection.collectionName);
+
+    // Let's fetch the collection options
+    collection.isCapped(function(err, capped) {
+      assert.equal(true, capped);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        indexExists

        +

        Checks if one or more indexes exist on the collection

        +
        +
        +indexExists(indexNames, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • indexNames (string) – check if one or more indexes exist on the collection.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the indexExists method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example showing the use of the indexExists function for a single index name and a list of index names.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a test collection that we are getting the options back from
+  db.createCollection('test_collection_index_exists', {w: 1}, function(err, collection) {
+    assert.equal(null, err);
+
+    // Create an index on the collection
+    collection.createIndex('a', {w: 1}, function(err, indexName) {
+
+      // Let's test to check if a single index exists
+      collection.indexExists("a_1", function(err, result) {
+        assert.equal(true, result);
+
+        // Let's test to check if multiple indexes are available
+        collection.indexExists(["a_1", "_id_"], function(err, result) {
+          assert.equal(true, result);
+
+          // Check if a non existing index exists
+          collection.indexExists("c_1", function(err, result) {
+            assert.equal(false, result);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        geoNear

        +

        Execute the geoNear command to search for items in the collection

        +
        +
        Options
        +
          +
        • num {Number}, max number of results to return.
          • +
        • maxDistance {Number}, include results up to maxDistance from the point.
          • +
        • distanceMultiplier {Number}, include a value to multiply the distances with allowing for range conversions.
          • +
        • query {Object}, filter the results by a query.
          • +
        • spherical {Boolean, default:false}, perform query using a spherical model.
          • +
        • uniqueDocs {Boolean, default:false}, the closest location in a document to the center of the search region will always be returned MongoDB > 2.X.
          • +
        • includeLocs {Boolean, default:false}, include the location data fields in the top level of the results MongoDB > 2.X.
          • +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +geoNear(x, y[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • x (number) – point to search on the x axis, ensure the indexes are ordered in the same order.
          • +
        • y (number) – point to search on the y axis, ensure the indexes are ordered in the same order.
          • +
        • [options] (objects) – options for the map reduce job.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the geoNear method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple geoNear query across some documents

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = configuration.newDbInstance({w:0}, {poolSize:1});
+
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch the collection
+  var collection = db.collection("simple_geo_near_command");
+
+  // Add a location based index
+  collection.ensureIndex({loc:"2d"}, function(err, result) {
+
+    // Save a new location tagged document
+    collection.insert([{a:1, loc:[50, 30]}, {a:1, loc:[30, 50]}], {w:1}, function(err, result) {
+
+      // Use geoNear command to find document
+      collection.geoNear(50, 50, {query:{a:1}, num:1}, function(err, docs) {
+        assert.equal(1, docs.results.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        geoHaystackSearch

        +

        Execute a geo search using a geo haystack index on a collection.

        +
        +
        Options
        +
          +
        • maxDistance {Number}, include results up to maxDistance from the point.
          • +
        • search {Object}, filter the results by a query.
          • +
        • limit {Number}, max number of results to return.
          • +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +geoHaystackSearch(x, y[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • x (number) – point to search on the x axis, ensure the indexes are ordered in the same order.
          • +
        • y (number) – point to search on the y axis, ensure the indexes are ordered in the same order.
          • +
        • [options] (objects) – options for the map reduce job.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the geoHaystackSearch method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple geoHaystackSearch query across some documents

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch the collection
+  var collection = db.collection("simple_geo_haystack_command");
+
+  // Add a location based index
+  collection.ensureIndex({loc: "geoHaystack", type: 1}, {bucketSize: 1}, function(err, result) {
+
+    // Save a new location tagged document
+    collection.insert([{a:1, loc:[50, 30]}, {a:1, loc:[30, 50]}], {w:1}, function(err, result) {
+
+      // Use geoNear command to find document
+      collection.geoHaystackSearch(50, 50, {search:{a:1}, limit:1, maxDistance:100}, function(err, docs) {
+        assert.equal(1, docs.results.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        indexes

        +

        Retrieve all the indexes on the collection.

        +
        +
        +indexes(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the indexes method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of retrieving a collections indexes

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Crete the collection for the distinct example
+  db.createCollection('simple_key_based_distinct', function(err, collection) {
+
+    // Create a geo 2d index
+    collection.ensureIndex({loc:"2d"}, {w: 1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create a simple single field index
+      collection.ensureIndex({a:1}, {w: 1}, function(err, result) {
+        assert.equal(null, err);
+
+        // List all of the indexes on the collection
+        collection.indexes(function(err, indexes) {
+          assert.equal(3, indexes.length);
+
+          db.close();
+        });
+      })
+    })
+  });
+});
+
        +
        +
        +
        +
        +

        aggregate

        +

        Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.1

        +
        +
        Options
        +
          +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +aggregate(array[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • array (array) – containing all the aggregation framework commands for the execution.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the aggregate method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Correctly call the aggregation framework using a pipeline in an Array.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Some docs for insertion
+  var docs = [{
+      title : "this is my title", author : "bob", posted : new Date() ,
+      pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 },
+      comments : [
+        { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" }
+      ]}];
+
+  // Validate that we are running on at least version 2.1 of MongoDB
+  db.admin().serverInfo(function(err, result){
+
+    if(parseInt((result.version.replace(/\./g, ''))) >= 210) {
+      // Create a collection
+      var collection = db.collection('shouldCorrectlyExecuteSimpleAggregationPipelineUsingArray');
+      // Insert the docs
+      collection.insert(docs, {w: 1}, function(err, result) {
+
+        // Execute aggregate, notice the pipeline is expressed as an Array
+        collection.aggregate([
+            { $project : {
+              author : 1,
+              tags : 1
+            }},
+            { $unwind : "$tags" },
+            { $group : {
+              _id : {tags : "$tags"},
+              authors : { $addToSet : "$author" }
+            }}
+          ], function(err, result) {
+            assert.equal(null, err);
+            assert.equal('good', result[0]._id.tags);
+            assert.deepEqual(['bob'], result[0].authors);
+            assert.equal('fun', result[1]._id.tags);
+            assert.deepEqual(['bob'], result[1].authors);
+
+            db.close();
+        });
+      });
+    } else {
+      db.close();
+      test.done();
+    }
+  });
+});
+
        +
        +

        Correctly call the aggregation framework using a pipeline expressed as an argument list.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Some docs for insertion
+  var docs = [{
+      title : "this is my title", author : "bob", posted : new Date() ,
+      pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 },
+      comments : [
+        { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" }
+      ]}];
+
+  // Validate that we are running on at least version 2.1 of MongoDB
+  db.admin().serverInfo(function(err, result){
+
+    if(parseInt((result.version.replace(/\./g, ''))) >= 210) {
+      // Create a collection
+      var collection = db.collection('shouldCorrectlyExecuteSimpleAggregationPipelineUsingArguments');
+      // Insert the docs
+      collection.insert(docs, {w: 1}, function(err, result) {
+        // Execute aggregate, notice the pipeline is expressed as function call parameters
+        // instead of an Array.
+        collection.aggregate(
+            { $project : {
+              author : 1,
+              tags : 1
+            }},
+            { $unwind : "$tags" },
+            { $group : {
+              _id : {tags : "$tags"},
+              authors : { $addToSet : "$author" }
+            }}
+          , function(err, result) {
+            assert.equal(null, err);
+            assert.equal('good', result[0]._id.tags);
+            assert.deepEqual(['bob'], result[0].authors);
+            assert.equal('fun', result[1]._id.tags);
+            assert.deepEqual(['bob'], result[1].authors);
+
+            db.close();
+        });
+      });
+    } else {
+      db.close();
+      test.done();
+    }
+  });
+});
+
        +
        +

        Correctly call the aggregation framework using a pipeline expressed as an argument list.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Some docs for insertion
+  var docs = [{
+      title : "this is my title", author : "bob", posted : new Date() ,
+      pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 },
+      comments : [
+        { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" }
+      ]}];
+
+  // Validate that we are running on at least version 2.1 of MongoDB
+  db.admin().serverInfo(function(err, result){
+
+    if(parseInt((result.version.replace(/\./g, ''))) >= 210) {
+      // Create a collection
+      var collection = db.collection('shouldCorrectlyExecuteSimpleAggregationPipelineUsingArguments');
+      // Insert the docs
+      collection.insert(docs, {w: 1}, function(err, result) {
+        // Execute aggregate, notice the pipeline is expressed as function call parameters
+        // instead of an Array.
+        collection.aggregate(
+            { $project : {
+              author : 1,
+              tags : 1
+            }},
+            { $unwind : "$tags" },
+            { $group : {
+              _id : {tags : "$tags"},
+              authors : { $addToSet : "$author" }
+            }}
+          , function(err, result) {
+            assert.equal(null, err);
+            assert.equal('good', result[0]._id.tags);
+            assert.deepEqual(['bob'], result[0].authors);
+            assert.equal('fun', result[1]._id.tags);
+            assert.deepEqual(['bob'], result[1].authors);
+
+            db.close();
+        });
+      });
+    } else {
+      db.close();
+      test.done();
+    }
+  });
+});
+
        +
        +
        +
        +
        +

        stats

        +

        Get all the collection statistics.

        +
        +
        Options
        +
          +
        • scale {Number}, divide the returned sizes by scale value.
          • +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +stats([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (objects) – options for the stats command.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the stats method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of retrieving a collections stats

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Crete the collection for the distinct example
+  db.createCollection('collection_stats_test', function(err, collection) {
+
+      // Insert some documents
+      collection.insert([{a:1}, {hello:'world'}], {w: 1}, function(err, result) {
+
+        // Retrieve the statistics for the collection
+        collection.stats(function(err, stats) {
+          assert.equal(2, stats.count);
+
+          db.close();
+        });
+      });
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/cursor.html b/api-generated/cursor.html new file mode 100644 index 00000000000..8c85e1e67c9 --- /dev/null +++ b/api-generated/cursor.html @@ -0,0 +1,1249 @@ + + + + + + + + + + Cursor() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Cursor()

        +
        +

        Constructor

        +

        Constructor for a cursor object that handles all the operations on query result +using find. This cursor object is unidirectional and cannot traverse backwards. Clients should not be creating a cursor directly, +but use find to acquire a cursor. (INTERNAL TYPE)

        +
        +
        +
        +class Cursor()
        +
        +++ + + + +
        Arguments:
          +
        • db (db) – the database object to work with.
          • +
        • collection (collection) – the collection to query.
          • +
        • selector (object) – the query selector.
          • +
        • fields (object) – an object containing what fields to include or exclude from objects returned.
          • +
        • [options] (object) – additional options for the collection.
          • +
        +
        +
        + +
        +
        +
        Options
        +
          +
        • skip {Number} skip number of documents to skip.
          • +
        • limit {Number}, limit the number of results to return. -1 has a special meaning and is used by Db.eval. A value of 1 will also be treated as if it were -1.
          • +
        • sort {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [[‘a’, 1]] etc.
          • +
        • hint {Object}, hint force the query to use a specific index.
          • +
        • explain {Boolean}, explain return the explaination of the query.
          • +
        • snapshot {Boolean}, snapshot Snapshot mode assures no duplicates are returned.
          • +
        • timeout {Boolean}, timeout allow the query to timeout.
          • +
        • tailable {Boolean}, tailable allow the cursor to be tailable.
          • +
        • awaitdata {Boolean}, awaitdata allow the cursor to wait for data, only applicable for tailable cursor.
          • +
        • batchSize {Number}, batchSize the number of the subset of results to request the database to return for every request. This should initially be greater than 1 otherwise the database will automatically close the cursor. The batch size can be set to 1 with cursorInstance.batchSize after performing the initial query to the database.
          • +
        • raw {Boolean}, raw return all query documents as raw buffers (default false).
          • +
        • read {Boolean}, read specify override of read from source (primary/secondary).
          • +
        • slaveOk {Boolean}, slaveOk, sets the slaveOk flag on the query wire protocol for secondaries.
          • +
        • returnKey {Boolean}, returnKey only return the index key.
          • +
        • maxScan {Number}, maxScan limit the number of items to scan.
          • +
        • min {Number}, min set index bounds.
          • +
        • max {Number}, max set index bounds.
          • +
        • showDiskLoc {Boolean}, showDiskLoc show disk location of results.
          • +
        • comment {String}, comment you can put a $comment field on a query to make looking in the profiler logs simpler.
          • +
        • numberOfRetries {Number}, numberOfRetries if using awaidata specifies the number of times to retry on timeout.
          • +
        • dbName {String}, dbName override the default dbName.
          • +
        • tailableRetryInterval {Number}, tailableRetryInterval specify the miliseconds between getMores on tailable cursor.
          • +
        • exhaust {Boolean}, exhaust have the server send all the documents at once as getMore packets.
          • +
        • partial {Boolean}, partial have the sharded system return a partial result from mongos.
          • +
        +
        +
        +
        +
        +

        Constants

        + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
        Constant NameValueDescription
        Cursor.INIT0Init state
        Cursor.OPEN1Cursor open
        Cursor.CLOSED2Cursor closed
        Cursor.GET_MORE3Cursor performing a get more
        +
        +
        +

        rewind

        +

        Resets this cursor to its initial state. All settings like the query string, +tailable, batchSizeValue, skipValue and limits are preserved.

        +
        +
        +rewind()
        +
        +++ + + + +
        Returns:cursor returns itself with rewind applied.
        +
        + +

        Examples

        +
        +

        An example showing the information returned by indexInformation

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  var docs = [];
+
+  // Insert 100 documents with some data
+  for(var i = 0; i < 100; i++) {
+    var d = new Date().getTime() + i*1000;
+    docs[i] = {'a':i, createdAt:new Date(d)};
+  }
+
+  // Create collection
+  db.createCollection('Should_correctly_rewind_and_restart_cursor', function(err, collection) {
+    assert.equal(null, err);
+
+    // insert all docs
+    collection.insert(docs, {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Grab a cursor using the find
+      var cursor = collection.find({});
+      // Fetch the first object off the cursor
+      cursor.nextObject(function(err, item) {
+        assert.equal(0, item.a)
+        // Rewind the cursor, resetting it to point to the start of the query
+        cursor.rewind();
+
+        // Grab the first object again
+        cursor.nextObject(function(err, item) {
+          assert.equal(0, item.a)
+
+          db.close();
+        })
+      })
+    })
+  });
+});
+
        +
        +
        +
        +
        +

        toArray

        +

        Returns an array of documents. The caller is responsible for making sure that there +is enough memory to store the results. Note that the array only contain partial +results when this cursor had been previouly accessed. In that case, +cursor.rewind() can be used to reset the cursor.

        +
        +
        +toArray(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – This will be called after executing this method successfully. The first parameter will contain the Error object if an error occured, or null otherwise. The second parameter will contain an array of BSON deserialized objects as a result of the query.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example showing the information returned by indexInformation

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection to hold our documents
+  db.createCollection('test_array', function(err, collection) {
+
+    // Insert a test document
+    collection.insert({'b':[1, 2, 3]}, {w:1}, function(err, ids) {
+
+      // Retrieve all the documents in the collection
+      collection.find().toArray(function(err, documents) {
+        assert.equal(1, documents.length);
+        assert.deepEqual([1, 2, 3], documents[0].b);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        each

        +

        Iterates over all the documents for this cursor. As with {cursor.toArray}, +not all of the elements will be iterated if this cursor had been previouly accessed. +In that case, {cursor.rewind} can be used to reset the cursor. However, unlike +{cursor.toArray}, the cursor will only hold a maximum of batch size elements +at any given time if batch size is specified. Otherwise, the caller is responsible +for making sure that the entire result can fit the memory.

        +
        +
        +each(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called for while iterating every document of the query result. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the document.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example iterating over a query using the each function of the cursor.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('test_to_a_after_each', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a document in the collection
+    collection.insert({'a':1}, {w:1}, function(err, ids) {
+
+      // Grab a cursor
+      var cursor = collection.find();
+
+      // Execute the each command, triggers for each document
+      cursor.each(function(err, item) {
+
+        // If the item is null then the cursor is exhausted/empty and closed
+        if(item == null) {
+
+          // Show that the cursor is closed
+          cursor.toArray(function(err, items) {
+            assert.ok(err != null);
+
+            // Let's close the db
+            db.close();
+          });
+        };
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        count

        +

        Determines how many result the query for this cursor will return

        +
        +
        +count(applySkipLimit, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • applySkipLimit (boolean) – if set to true will apply the skip and limits set on the cursor. Defaults to false.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the number of results or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the count function of the cursor.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Creat collection
+  db.createCollection('cursor_count_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some docs
+    collection.insert([{a:1}, {a:2}], {w:1}, function(err, docs) {
+      assert.equal(null, err);
+
+      // Do a find and get the cursor count
+      collection.find().count(function(err, count) {
+        assert.equal(null, err);
+        assert.equal(2, count);
+
+        db.close();
+      })
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        sort

        +

        Sets the sort parameter of this cursor to the given value.

        +

        This method has the following method signatures

        +

        (keyOrList, callback) +(keyOrList, direction, callback)

        +
        +
        +sort(keyOrList, direction, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • keyOrList (string) – This can be a string or an array. If passed as a string, the string will be the field to sort. If passed an array, each element will represent a field to be sorted and should be an array that contains the format [string, direction].
          • +
        • direction (string) – this determines how the results are sorted. &quot;asc&quot;, &quot;ascending&quot; or 1 for asceding order while &quot;desc&quot;, &quot;desceding or -1 for descending order. Note that the strings are case insensitive.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain an error object when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
          • +
        +
        Returns:

        cursor an instance of this object.

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the use of sort on the cursor.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('simple_sort_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some documents we can sort on
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) {
+      assert.equal(null, err);
+
+      // Do normal ascending sort
+      collection.find().sort([['a', 1]]).nextObject(function(err, item) {
+        assert.equal(null, err);
+        assert.equal(1, item.a);
+
+        // Do normal descending sort
+        collection.find().sort([['a', -1]]).nextObject(function(err, item) {
+          assert.equal(null, err);
+          assert.equal(3, item.a);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        limit

        +

        Sets the limit parameter of this cursor to the given value.

        +
        +
        +limit(limit[, callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • limit (number) – the new limit.
          • +
        • [callback] (function) – this optional callback will be called after executing this method. The first parameter will contain an error object when the limit given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
          • +
        +
        Returns:

        cursor an instance of this object.

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the use of limit on the cursor

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('simple_limit_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some documents we can sort on
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) {
+      assert.equal(null, err);
+
+      // Limit to only one document returned
+      collection.find().limit(1).toArray(function(err, items) {
+        assert.equal(null, err);
+        assert.equal(1, items.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        setReadPreference

        +

        Sets the read preference for the cursor

        +
        +
        +setReadPreference(the[, callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • the (string) – read preference for the cursor, one of Server.READ_PRIMARY, Server.READ_SECONDARY, Server.READ_SECONDARY_ONLY
          • +
        • [callback] (function) – this optional callback will be called after executing this method. The first parameter will contain an error object when the read preference given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
          • +
        +
        Returns:

        cursor an instance of this object.

        +
        +
        + +
        + +
        +

        batchSize

        +

        Sets the batch size parameter of this cursor to the given value.

        +
        +
        +batchSize(batchSize[, callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • batchSize (number) – the new batch size.
          • +
        • [callback] (function) – this optional callback will be called after executing this method. The first parameter will contain an error object when the batchSize given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution.
          • +
        +
        Returns:

        cursor an instance of this object.

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the use of batchSize on the cursor, batchSize only regulates how many +documents are returned for each batch using the getMoreCommand against the MongoDB server

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('simple_batch_size_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some documents we can sort on
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) {
+      assert.equal(null, err);
+
+      // Do normal ascending sort
+      collection.find().batchSize(1).nextObject(function(err, item) {
+        assert.equal(null, err);
+        assert.equal(1, item.a);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        nextObject

        +

        Gets the next document from the cursor.

        +
        +
        +nextObject(callback)
        +
        +++ + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain an error object on error while the second parameter will contain a document from the returned result or null if there are no more results.
          • +
        +
        +
        + +

        Examples

        +
        +

        A simple example showing the use of nextObject.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('simple_next_object_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some documents we can sort on
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) {
+      assert.equal(null, err);
+
+      // Do normal ascending sort
+      collection.find().nextObject(function(err, item) {
+        assert.equal(null, err);
+        assert.equal(1, item.a);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        explain

        +

        Gets a detailed information about how the query is performed on this cursor and how +long it took the database to process it.

        +
        +
        +explain(callback)
        +
        +++ + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will always be null while the second parameter will be an object containing the details.
          • +
        +
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursor explain function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('simple_explain_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert some documents we can sort on
+    collection.insert([{a:1}, {a:2}, {a:3}], {w:1}, function(err, docs) {
+      assert.equal(null, err);
+
+      // Do normal ascending sort
+      collection.find().explain(function(err, explaination) {
+        assert.equal(null, err);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        stream

        +

        Returns a Node ReadStream interface for this cursor.

        +
        +
        Options
        +
          +
        • transform {Function} function of type function(object) { return transformed }, allows for transformation of data before emitting.
          • +
        +
        +
        +
        +
        +stream()
        +
        +++ + + + +
        Returns:cursorstream returns a stream object.
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursor stream function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a lot of documents to insert
+  var docs = []
+  for(var i = 0; i < 100; i++) {
+    docs.push({'a':i})
+  }
+
+  // Create a collection
+  db.createCollection('test_stream_function', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert documents into collection
+    collection.insert(docs, {w:1}, function(err, ids) {
+      // Peform a find to get a cursor
+      var stream = collection.find().stream();
+
+      // Execute find on all the documents
+      stream.on('close', function() {
+        db.close();
+      });
+
+      stream.on('data', function(data) {
+        assert.ok(data != null);
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        close

        +

        Close the cursor.

        +
        +
        +close(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will always contain null while the second parameter will contain a reference to this cursor.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursor close function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a lot of documents to insert
+  var docs = []
+  for(var i = 0; i < 100; i++) {
+    docs.push({'a':i})
+  }
+
+  // Create a collection
+  db.createCollection('test_close_function_on_cursor', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert documents into collection
+    collection.insert(docs, {w:1}, function(err, ids) {
+      // Peform a find to get a cursor
+      var cursor = collection.find();
+
+      // Fetch the first object
+      cursor.nextObject(function(err, object) {
+        assert.equal(null, err);
+
+        // Close the cursor, this is the same as reseting the query
+        cursor.close(function(err, result) {
+          assert.equal(null, err);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        isClosed

        +

        Check if the cursor is closed or open.

        +
        +
        +isClosed()
        +
        +++ + + + +
        Returns:boolean returns the state of the cursor.
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursor close function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a lot of documents to insert
+  var docs = []
+  for(var i = 0; i < 100; i++) {
+    docs.push({'a':i})
+  }
+
+  // Create a collection
+  db.createCollection('test_is_close_function_on_cursor', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert documents into collection
+    collection.insert(docs, {w:1}, function(err, ids) {
+      // Peform a find to get a cursor
+      var cursor = collection.find();
+
+      // Fetch the first object
+      cursor.nextObject(function(err, object) {
+        assert.equal(null, err);
+
+        // Close the cursor, this is the same as reseting the query
+        cursor.close(function(err, result) {
+          assert.equal(null, err);
+          assert.equal(true, cursor.isClosed());
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/cursorstream.html b/api-generated/cursorstream.html new file mode 100644 index 00000000000..a6d77b2473e --- /dev/null +++ b/api-generated/cursorstream.html @@ -0,0 +1,497 @@ + + + + + + + + + + CursorStream() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        CursorStream()

        +
        +

        Constructor

        +

        CursorStream

        +
        +
        +
        +class CursorStream()
        +
        +++ + + + + + +
        Arguments:
          +
        • cursor (cursor) – a cursor object that the stream wraps.
          • +
        +
        Returns:

        stream

        +
        +
        + +
        +

        Returns a stream interface for the cursor.

        +
        +
        Options
        +
          +
        • transform {Function} function of type function(object) { return transformed }, allows for transformation of data before emitting.
          • +
        +
        +
        Events
        +
          +
        • data {function(item) {}} the data event triggers when a document is ready.
          • +
        • error {function(err) {}} the error event triggers if an error happens.
          • +
        • close {function() {}} the end event triggers when there is no more documents available.
          • +
        +
        +
        +
        +
        +

        pause

        +

        Pauses the stream.

        +
        +
        +pause()
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursorstream pause function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a lot of documents to insert
+  var docs = []
+  for(var i = 0; i < 1; i++) {
+    docs.push({'a':i})
+  }
+
+  // Create a collection
+  db.createCollection('test_cursorstream_pause', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert documents into collection
+    collection.insert(docs, {w:1}, function(err, ids) {
+      // Peform a find to get a cursor
+      var stream = collection.find().stream();
+
+      // For each data item
+      stream.on("data", function(item) {
+        // Check if cursor is paused
+        assert.equal(false, stream.paused);
+        // Pause stream
+        stream.pause();
+        // Check if cursor is paused
+        assert.equal(true, stream.paused);
+
+        // Restart the stream after 1 miliscecond
+        setTimeout(function() {
+          stream.resume();
+          // Check if cursor is paused
+          process.nextTick(function() {
+            assert.equal(false, stream.paused);
+          })
+        }, 1);
+      });
+
+      // When the stream is done
+      stream.on("close", function() {
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        resume

        +

        Resumes the stream.

        +
        +
        +resume()
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursorstream resume function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a lot of documents to insert
+  var docs = []
+  for(var i = 0; i < 1; i++) {
+    docs.push({'a':i})
+  }
+
+  // Create a collection
+  db.createCollection('test_cursorstream_resume', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert documents into collection
+    collection.insert(docs, {w:1}, function(err, ids) {
+      // Peform a find to get a cursor
+      var stream = collection.find().stream();
+
+      // For each data item
+      stream.on("data", function(item) {
+        // Check if cursor is paused
+        assert.equal(false, stream.paused);
+        // Pause stream
+        stream.pause();
+        // Check if cursor is paused
+        assert.equal(true, stream.paused);
+
+        // Restart the stream after 1 miliscecond
+        setTimeout(function() {
+
+          // Resume the stream
+          stream.resume();
+
+          // Check if cursor is paused
+          process.nextTick(function() {
+            assert.equal(false, stream.paused);
+          });
+        }, 1);
+      });
+
+      // When the stream is done
+      stream.on("close", function() {
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        destroy

        +

        Destroys the stream, closing the underlying +cursor. No more events will be emitted.

        +
        +
        +destroy()
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the cursorstream resume function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a lot of documents to insert
+  var docs = []
+  for(var i = 0; i < 1; i++) {
+    docs.push({'a':i})
+  }
+
+  // Create a collection
+  db.createCollection('test_cursorstream_destroy', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert documents into collection
+    collection.insert(docs, {w:1}, function(err, ids) {
+      // Peform a find to get a cursor
+      var stream = collection.find().stream();
+
+      // For each data item
+      stream.on("data", function(item) {
+        // Destroy stream
+        stream.destroy();
+      });
+
+      // When the stream is done
+      stream.on("close", function() {
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/db.html b/api-generated/db.html new file mode 100644 index 00000000000..eeeb71b0451 --- /dev/null +++ b/api-generated/db.html @@ -0,0 +1,2774 @@ + + + + + + + + + + Db() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Db()

        +
        +

        Constructor

        +

        Create a new Db instance.

        +
        +
        +
        +class Db()
        +
        +++ + + + +
        Arguments:
          +
        • databaseName (string) – name of the database.
          • +
        • serverConfig (object) – server config object.
          • +
        • [options] (object) – additional options for the collection.
          • +
        +
        +
        + +
        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        • native_parser {Boolean, default:false}, use c++ bson parser.
          • +
        • forceServerObjectId {Boolean, default:false}, force server to create _id fields instead of client.
          • +
        • pkFactory {Object}, object overriding the basic ObjectID primary key generation.
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions.
          • +
        • raw {Boolean, default:false}, peform operations using raw bson buffers.
          • +
        • recordQueryStats {Boolean, default:false}, record query statistics during execution.
          • +
        • retryMiliSeconds {Number, default:5000}, number of miliseconds between retries.
          • +
        • numberOfRetries {Number, default:5}, number of retries off connection.
          • +
        • logger {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error ({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}}).
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +

        Constants

        + +++++ + + + + + + + + + + + + +
        Constant NameValueDescription
        Db.DEFAULT_URL‘mongodb://localhost:27017/default’Default URL
        +
        +
        +

        open

        +

        Initialize the database connection.

        +
        +
        +open(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the index information or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of a simple single server db connection

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  db.close();
+});
+
        +
        +

        Simple replicaset connection setup, requires a running replicaset on the correct ports

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var replSet = new ReplSetServers([
+  new Server('localhost', 30000),
+  new Server('localhost', 30001),
+  new Server('localhost', 30002)
+]);
+var db = new Db('integration_test_', replSet, {w:0});
+db.open(function(err, p_db) {
+  assert.equal(null, err);
+  p_db.close();
+});
+
        +
        +

        Example of Read Preference usage at the query level.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var replSet = new ReplSetServers([
+  new Server('localhost', 30000),
+  new Server('localhost', 30001),
+  new Server('localhost', 30002)
+]);
+// Create db instance
+var db = new Db('integration_test_', replSet, {w:0, native_parser: (process.env['TEST_NATIVE'] != null)});
+// Trigger test once whole set is up
+db.on("fullsetup", function() {
+  // Rip out secondaries forcing an attempt to read from the primary
+  db.serverConfig._state.secondaries = {};
+
+  // Grab the collection
+  db.collection("read_preference_replicaset_test_0", function(err, collection) {
+    // Attempt to read (should fail due to the server not being a primary);
+    collection.find().setReadPreference(ReadPreference.SECONDARY).toArray(function(err, items) {
+      assert.ok(err != null);
+      assert.equal("No replica set secondary available for query with ReadPreference SECONDARY", err.message);
+      // Does not get called or we don't care
+      db.close();
+    });
+  });
+});
+
+// Connect to the db
+db.open(function(err, p_db) {
+  db = p_db;
+});
+
        +
        +

        A Simple example off connecting to Mongos with a list of alternative proxies.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Set up mongos connection
+var mongos = new Mongos([
+    new Server("localhost", 50000, { auto_reconnect: true }),
+    new Server("localhost", 50001, { auto_reconnect: true })
+  ])
+
+// Connect using the mongos connections
+var db = new Db('integration_test_', mongos, {w:0});
+db.open(function(err, db) {
+  assert.equal(null, err);
+  assert.ok(db != null);
+
+  // Perform a simple insert into a collection
+  var collection = db.collection("shard_test");
+  // Insert a simple doc
+  collection.insert({test:1}, {w:1}, function(err, result) {
+    assert.equal(null, err);
+
+    collection.findOne({test:1}, {}, {readPreference:new ReadPreference(ReadPreference.SECONDARY)}, function(err, item) {
+      assert.equal(null, err);
+      assert.equal(1, item.test);
+
+      db.close();
+    })
+  });
+});
+
        +
        +
        +
        +
        +

        db

        +

        Create a new Db instance sharing the current socket connections.

        +
        +
        +db(dbName)
        +
        +++ + + + + + +
        Arguments:
          +
        • dbName (string) – the name of the database we want to use.
          • +
        +
        Returns:

        db a db instance using the new database.

        +
        +
        + +

        Examples

        +
        +

        Simple example connecting to two different databases sharing the socket connections below.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Reference a different database sharing the same connections
+  // for the data transfer
+  var secondDb = db.db("integration_tests_2");
+
+  // Fetch the collections
+  var multipleColl1 = db.collection("multiple_db_instances");
+  var multipleColl2 = secondDb.collection("multiple_db_instances");
+
+  // Write a record into each and then count the records stored
+  multipleColl1.insert({a:1}, {w:1}, function(err, result) {
+    multipleColl2.insert({a:1}, {w:1}, function(err, result) {
+
+      // Count over the results ensuring only on record in each collection
+      multipleColl1.count(function(err, count) {
+        assert.equal(1, count);
+
+        multipleColl2.count(function(err, count) {
+          assert.equal(1, count);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        close

        +

        Close the current db connection, including all the child db instances. Emits close event if no callback is provided.

        +
        +
        +close([forceClose], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [forceClose] (boolean) – connection can never be reused.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example that shows how to force close a db connection so it cannot be reused.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Fetch a collection
+  var collection = db.collection('shouldCorrectlyFailOnRetryDueToAppCloseOfDb');
+
+  // Insert a document
+  collection.insert({a:1}, {w:1}, function(err, result) {
+    assert.equal(null, err);
+
+    // Force close the connection
+    db.close(true, function(err, result) {
+
+      // Attemp to insert should fail now with correct message 'db closed by application'
+      collection.insert({a:2}, {w:1}, function(err, result) {
+        assert.equal('db closed by application', err.message);
+      });
+    });
+  });
+});
+
        +
        +

        An example of a simple single server db connection and close function

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Close the connection with a callback that is optional
+  db.close(function(err, result) {
+    assert.equal(null, err);
+
+  });
+});
+
        +
        +
        +
        +
        +

        admin

        +

        Access the Admin database

        +
        +
        +admin([callback])
        +
        +++ + + + + + +
        Arguments:
          +
        • [callback] (function) – returns the results.
          • +
        +
        Returns:

        admin the admin db object.

        +
        +
        + +

        Examples

        +
        +

        Example showing how to access the Admin database for admin level operations.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+db.open(function(err, db) {
+
+  // Use the admin database for the operation
+  var adminDb = db.admin()
+  assert.ok(adminDb != null);
+
+  db.close();
+});
+
        +
        +
        +
        +
        +

        collectionsInfo

        +

        Returns a cursor to all the collection information.

        +
        +
        +collectionsInfo([collectionName], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [collectionName] (string) – the collection name we wish to retrieve the information from.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the options or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of retrieveing the information of all the collections.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a collection
+  db.createCollection('test_collections_info', function(err, r) {
+    assert.equal(null, err);
+
+    // Return the information of a single collection name
+    db.collectionsInfo("test_collections_info").toArray(function(err, items) {
+      assert.equal(1, items.length);
+
+      // Return the information of a all collections, using the callback format
+      db.collectionsInfo(function(err, cursor) {
+
+        // Turn the cursor into an array of results
+        cursor.toArray(function(err, items) {
+          assert.ok(items.length > 0);
+
+          db.close();
+        });
+      })
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        collectionNames

        +

        Get the list of all collection names for the specified db

        +
        +
        Options
        +
          +
        • namesOnly {String, default:false}, Return only the full collection namespace.
          • +
        +
        +
        +
        +
        +collectionNames([collectionName][, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [collectionName] (string) – the collection name we wish to filter by.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the collection names or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of retrieveing the collection names for a database.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a collection
+  db.createCollection('test_collections_info', function(err, r) {
+    assert.equal(null, err);
+
+    // Return the information of a single collection name
+    db.collectionNames("test_collections_info", function(err, items) {
+      assert.equal(1, items.length);
+
+      // Return the information of a all collections, using the callback format
+      db.collectionNames(function(err, items) {
+        assert.ok(items.length > 0);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        collection

        +

        Fetch a specific collection (containing the actual collection information). If the application does not use strict mode you can +can use it without a callback in the following way. var collection = db.collection(‘mycollection’);

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions on the document.
          • +
        • raw {Boolean, default:false}, perform all operations using raw bson objects.
          • +
        • pkFactory {Object}, object overriding the basic ObjectID primary key generation.
          • +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        • strict, (Boolean, default:false) throws and error if the collection does not exist
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +collection(collectionName[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – the collection name we wish to access.
          • +
        • [options] (object) – returns option results.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the collection or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of retrieving a collection from a db using the collection function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Grab a collection without a callback no safe mode
+  var col1 = db.collection('test_correctly_access_collections');
+
+  // Grab a collection with a callback but no safe operation
+  db.collection('test_correctly_access_collections', function(err, col2) {
+    assert.equal(null, err);
+
+    // Grab a collection with a callback in safe mode, ensuring it exists (should fail as it's not created)
+    db.collection('test_correctly_access_collections', {strict:true}, function(err, col3) {
+      assert.ok(err != null);
+
+      // Create the collection
+      db.createCollection('test_correctly_access_collections', function(err, result) {
+
+        // Retry to get the collection, should work as it's now created
+        db.collection('test_correctly_access_collections', {strict:true}, function(err, col3) {
+          assert.equal(null, err);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        collections

        +

        Fetch all collections for the current db.

        +
        +
        +collections(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the collections or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of retrieving all collections for a db as Collection objects

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create the collection
+  db.createCollection('test_correctly_access_collections2', function(err, result) {
+
+    // Retry to get the collection, should work as it's now created
+    db.collections(function(err, collections) {
+      assert.equal(null, err);
+      assert.ok(collections.length > 0);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        eval

        +

        Evaluate javascript on the server

        +
        +
        Options
        +
          +
        • nolock {Boolean, default:false}, Tell MongoDB not to block on the evaulation of the javascript.
          • +
        +
        +
        +
        +
        +eval(code[, parameters][, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • code (code) – javascript to execute on server.
          • +
        • [parameters] (object) – the parameters for the call.
          • +
        • [options] (object) – the options
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from eval or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A whole bunch of examples on how to use eval on the server.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  var numberOfTests =
+
+  // Evaluate a function on the server with the parameter 3 passed in
+  db.eval('function (x) {return x;}', [3], function(err, result) {
+    assert.equal(3, result);
+  });
+
+  // Evaluate a function on the server with the parameter 3 passed in no lock aquired for eval
+  // on server
+  db.eval('function (x) {return x;}', [3], {nolock:true}, function(err, result) {
+    assert.equal(3, result);
+  });
+
+  // Evaluate a function on the server that writes to a server collection
+  db.eval('function (x) {db.test_eval.save({y:x});}', [5], function(err, result) {
+    // Locate the entry
+    db.collection('test_eval', function(err, collection) {
+      collection.findOne(function(err, item) {
+        assert.equal(5, item.y);
+      });
+    });
+  });
+
+  // Evaluate a function with 2 parameters passed in
+  db.eval('function (x, y) {return x + y;}', [2, 3], function(err, result) {
+    assert.equal(5, result);
+  });
+
+  // Evaluate a function with no parameters passed in
+  db.eval('function () {return 5;}', function(err, result) {
+    assert.equal(5, result);
+  });
+
+  // Evaluate a statement
+  db.eval('2 + 3;', function(err, result) {
+    assert.equal(5, result);
+  });
+
+  // Evaluate a statement using the code object
+  db.eval(new Code("2 + 3;"), function(err, result) {
+    assert.equal(5, result);
+  });
+
+  // Evaluate a statement using the code object including a scope
+  db.eval(new Code("return i;", {'i':2}), function(err, result) {
+    assert.equal(2, result);
+  });
+
+  // Evaluate a statement using the code object including a scope
+  db.eval(new Code("i + 3;", {'i':2}), function(err, result) {
+    assert.equal(5, result);
+  });
+
+  // Evaluate an illegal statement
+  db.eval("5 ++ 5;", function(err, result) {
+    assert.ok(err instanceof Error);
+    assert.ok(err.message != null);
+    // Let's close the db
+    db.close();
+  });
+});
+
        +
        +

        Defining and calling a system level javascript function (NOT recommended, <a href=’http://www.mongodb.org/display/DOCS/Server-side+Code+Execution’>http://www.mongodb.org/display/DOCS/Server-side+Code+Execution</a>)

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Clean out the collection
+  db.collection("system.js").remove({}, {w:1}, function(err, result) {
+    assert.equal(null, err);
+
+    // Define a system level function
+    db.collection("system.js").insert({_id: "echo", value: new Code("function(x) { return x; }")}, {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      db.eval("echo(5)", function(err, result) {
+        assert.equal(null, err);
+        assert.equal(5, result);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        dereference

        +

        Dereference a dbref, against a db

        +
        +
        +dereference(dbRef, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • dbRef (dbref) – db reference object we wish to resolve.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dereference or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of dereferencing values.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Get a second db
+  var secondDb = db.db('integration_tests_2');
+
+  // Create a dereference example
+  secondDb.createCollection('test_deref_examples', function(err, collection) {
+
+    // Insert a document in the collection
+    collection.insert({'a':1}, {w:1}, function(err, ids) {
+
+      // Let's build a db reference and resolve it
+      var dbRef = new DBRef('test_deref_examples', ids[0]._id, 'integration_tests_2');
+
+      // Resolve it including a db resolve
+      db.dereference(dbRef, function(err, item) {
+        assert.equal(1, item.a);
+
+        // Let's build a db reference and resolve it
+        var dbRef = new DBRef('test_deref_examples', ids[0]._id);
+
+        // Simple local resolve
+        secondDb.dereference(dbRef, function(err, item) {
+          assert.equal(1, item.a);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        logout

        +

        Logout user from server, fire off on all connections and remove all auth info

        +
        +
        +logout(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from logout or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of using the logout command for the database.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Add a user to the database
+  db.addUser('user', 'name', function(err, result) {
+    assert.equal(null, err);
+
+    // Authenticate
+    db.authenticate('user', 'name', function(err, result) {
+      assert.equal(true, result);
+
+      // Logout the db
+      db.logout(function(err, result) {
+        assert.equal(true, result);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        authenticate

        +

        Authenticate a user against the server.

        +
        +
        Options
        +
          +
        • authSource {String}, The database that the credentials are for, +different from the name of the current DB, for example admin
          • +
        +
        +
        +
        +
        +authenticate(username, password[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • username (string) – username.
          • +
        • password (string) – password.
          • +
        • [options] (object) – the options
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from authentication or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of using the authenticate command.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Add a user to the database
+  db.addUser('user', 'name', function(err, result) {
+    assert.equal(null, err);
+
+    // Authenticate
+    db.authenticate('user', 'name', function(err, result) {
+      assert.equal(true, result);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        addUser

        +

        Add a user to the database.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +addUser(username, password[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • username (string) – username.
          • +
        • password (string) – password.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from addUser or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of adding a user to the database.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Add a user to the database
+  db.addUser('user', 'name', function(err, result) {
+    assert.equal(null, err);
+
+    db.close();
+  });
+});
+
        +
        +
        +
        +
        +

        removeUser

        +

        Remove a user from a database

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +removeUser(username[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • username (string) – username.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from removeUser or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example of dereferencing values.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Add a user to the database
+  db.addUser('user', 'name', function(err, result) {
+    assert.equal(null, err);
+
+    // Authenticate
+    db.authenticate('user', 'name', function(err, result) {
+      assert.equal(true, result);
+
+      // Logout the db
+      db.logout(function(err, result) {
+        assert.equal(true, result);
+
+        // Remove the user from the db
+        db.removeUser('user', function(err, result) {
+
+          // Authenticate
+          db.authenticate('user', 'name', function(err, result) {
+            assert.equal(false, result);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        createCollection

        +

        Creates a collection on a server pre-allocating space, need to create f.ex capped collections.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions on the document.
          • +
        • raw {Boolean, default:false}, perform all operations using raw bson objects.
          • +
        • pkFactory {Object}, object overriding the basic ObjectID primary key generation.
          • +
        • capped {Boolean, default:false}, create a capped collection.
          • +
        • size {Number}, the size of the capped collection in bytes.
          • +
        • max {Number}, the maximum number of documents in the capped collection.
          • +
        • autoIndexId {Boolean, default:true}, create an index on the _id field of the document, True by default on MongoDB 2.2 or higher off for version &lt; 2.2.
          • +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        • strict, (Boolean, default:false) throws and error if collection already exists
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +createCollection(collectionName[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – the collection name we wish to access.
          • +
        • [options] (object) – returns option results.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from createCollection or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the creation of a collection.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a capped collection with a maximum of 1000 documents
+  db.createCollection("a_simple_collection", {capped:true, size:10000, max:1000, w:1}, function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a document in the capped collection
+    collection.insert({a:1}, {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        command

        +

        Execute a command hash against MongoDB. This lets you acess any commands not available through the api on the server.

        +
        +
        +command(selector, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • selector (object) – the command hash to send to the server, ex: {ping:1}.
          • +
        • callback (function) – this will be called after executing this method. The command always return the whole result of the command as the second parameter.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example creating, dropping a collection and then verifying that the collection is gone.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Execute ping against the server
+  db.command({ping:1}, function(err, result) {
+    assert.equal(null, err);
+
+    db.close();
+  });
+});
+
        +
        +
        +
        +
        +

        dropCollection

        +

        Drop a collection from the database, removing it permanently. New accesses will create a new collection.

        +
        +
        +dropCollection(collectionName, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – the name of the collection we wish to drop.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dropCollection or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example executing a command against the server.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Execute ping against the server
+  db.command({ping:1}, function(err, result) {
+    assert.equal(null, err);
+
+    // Create a capped collection with a maximum of 1000 documents
+    db.createCollection("a_simple_create_drop_collection", {capped:true, size:10000, max:1000, w:1}, function(err, collection) {
+      assert.equal(null, err);
+
+      // Insert a document in the capped collection
+      collection.insert({a:1}, {w:1}, function(err, result) {
+        assert.equal(null, err);
+
+        // Drop the collection from this world
+        db.dropCollection("a_simple_create_drop_collection", function(err, result) {
+          assert.equal(null, err);
+
+          // Verify that the collection is gone
+          db.collectionNames("a_simple_create_drop_collection", function(err, names) {
+            assert.equal(0, names.length);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        renameCollection

        +

        Rename a collection.

        +
        +
        Options
        +
          +
        • dropTarget {Boolean, default:false}, drop the target name collection if it previously exists.
          • +
        +
        +
        +
        +
        +renameCollection(fromCollection, toCollection[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • fromCollection (string) – the name of the current collection we wish to rename.
          • +
        • toCollection (string) – the new name of the collection.
          • +
        • [options] (object) – returns option results.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from renameCollection or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example creating, dropping a collection and then verifying that the collection is gone.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a collection
+  db.createCollection("simple_rename_collection", {w:1}, function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a document in the collection
+    collection.insert({a:1}, {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Rename the collection
+      db.renameCollection("simple_rename_collection", "simple_rename_collection_2", function(err, collection2) {
+        assert.equal(null, err);
+
+        // Retrieve the number of documents from the collection
+        collection2.count(function(err, count) {
+          assert.equal(1, count);
+
+          // Verify that the collection is gone
+          db.collectionNames("simple_rename_collection", function(err, names) {
+            assert.equal(0, names.length);
+
+            // Verify that the new collection exists
+            db.collectionNames("simple_rename_collection_2", function(err, names) {
+              assert.equal(1, names.length);
+
+              db.close();
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        lastError

        +

        Return last error message for the given connection, note options can be combined.

        +
        +
        Options
        +
          +
        • fsync {Boolean, default:false}, option forces the database to fsync all files before returning.
          • +
        • j {Boolean, default:false}, awaits the journal commit before returning, > MongoDB 2.0.
          • +
        • w {Number}, until a write operation has been replicated to N servers.
          • +
        • wtimeout {Number}, number of miliseconds to wait before timing out.
          • +
        +
        +
        Connection Options
        +
          +
        • connection {Connection}, fire the getLastError down a specific connection.
          • +
        +
        +
        +
        +
        +lastError([options][, connectionOptions], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (object) – returns option results.
          • +
        • [connectionOptions] (object) – returns option results.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from lastError or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example using lastError on a single connection with a pool of 1.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a collection
+  db.createCollection("simple_rename_collection3", {w:1}, function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a document in the collection
+    collection.insert({a:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Execute lastError
+      db.lastError(function(err, result) {
+        assert.equal(null, err);
+        assert.equal(null, result[0].err);
+
+        // Pick a specific connection and execute lastError against it
+        var connection = db.serverConfig.checkoutWriter();
+        // Execute lastError
+        db.lastError({}, {connection:connection}, function(err, result) {
+          assert.equal(null, err);
+          assert.equal(null, result[0].err);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        previousErrors

        +

        Return all errors up to the last time db reset_error_history was called.

        +
        +
        Options
        +
          +
        • connection {Connection}, fire the getLastError down a specific connection.
          • +
        +
        +
        +
        +
        +previousErrors([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (object) – returns option results.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from previousErrors or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example using previousError to return the list of all errors, might be deprecated in the future.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a collection
+  db.createCollection("simple_previous_error_coll", {w:1}, function(err, collection) {
+    assert.equal(null, err);
+
+    // Force a unique index
+    collection.ensureIndex({a:1}, {unique:true, w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Force some errors
+      collection.insert([{a:1}, {a:1}, {a:1}, {a:2}], function(err, result) {
+
+        // Pick a specific connection and execute lastError against it
+        var connection = db.serverConfig.checkoutWriter();
+
+        // Execute previousErrors
+        db.previousErrors({connection:connection}, function(err, result) {
+          assert.equal(null, err);
+          assert.equal(1, result.length);
+          assert.ok(result[0].err != null);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        resetErrorHistory

        +

        Resets the error history of the mongo instance.

        +
        +
        Options
        +
          +
        • connection {Connection}, fire the getLastError down a specific connection.
          • +
        +
        +
        +
        +
        +resetErrorHistory([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (object) – returns option results.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from resetErrorHistory or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example using resetErrorHistory to clean up the history of errors.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  // Create a collection
+  db.createCollection("simple_reset_error_history_coll", {w:1}, function(err, collection) {
+    assert.equal(null, err);
+
+    // Force a unique index
+    collection.ensureIndex({a:1}, {unique:true, w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Force some errors
+      collection.insert([{a:1}, {a:1}, {a:1}, {a:2}], function(err, result) {
+        // Pick a specific connection and execute lastError against it
+        var connection = db.serverConfig.checkoutWriter();
+
+        // Reset the error history
+        db.resetErrorHistory({connection:connection}, function(err, result) {
+
+          // Execute previousErrors and validate that there are no errors left
+          db.previousErrors({connection:connection}, function(err, result) {
+            assert.equal(null, err);
+            assert.equal(1, result.length);
+            assert.equal(null, result[0].err);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        createIndex

        +

        Creates an index on the collection.

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • unique {Boolean, default:false}, creates an unique index.
          • +
        • sparse {Boolean, default:false}, creates a sparse index.
          • +
        • background {Boolean, default:false}, creates the index in the background, yielding whenever possible.
          • +
        • dropDups {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value
          • +
        • min {Number}, for geospatial indexes set the lower bound for the co-ordinates.
          • +
        • max {Number}, for geospatial indexes set the high bound for the co-ordinates.
          • +
        • v {Number}, specify the format version of the indexes.
          • +
        • expireAfterSeconds {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
          • +
        • name {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes)
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +createIndex(collectionName, fieldOrSpec[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – name of the collection to create the index on.
          • +
        • fieldOrSpec (object) – fieldOrSpec that defines the index.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from createIndex or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A more complex createIndex using a compound unique index in the background and dropping duplicated documents

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('more_complex_index_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      db.createIndex('more_complex_index_test', {a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Show that duplicate records got dropped
+        collection.find({}).toArray(function(err, items) {
+          assert.equal(null, err);
+          assert.equal(4, items.length);
+
+          // Peform a query, with explain to show we hit the query
+          collection.find({a:2}, {explain:true}).toArray(function(err, explanation) {
+            assert.equal(null, err);
+            assert.ok(explanation[0].indexBounds.a != null);
+            assert.ok(explanation[0].indexBounds.b != null);
+
+            db.close();
+          });
+        })
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        ensureIndex

        +

        Ensures that an index exists, if it does not it creates it

        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where &lt; 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • unique {Boolean, default:false}, creates an unique index.
          • +
        • sparse {Boolean, default:false}, creates a sparse index.
          • +
        • background {Boolean, default:false}, creates the index in the background, yielding whenever possible.
          • +
        • dropDups {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value
          • +
        • min {Number}, for geospatial indexes set the lower bound for the co-ordinates.
          • +
        • max {Number}, for geospatial indexes set the high bound for the co-ordinates.
          • +
        • v {Number}, specify the format version of the indexes.
          • +
        • expireAfterSeconds {Number}, allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
          • +
        • name {String}, override the autogenerated index name (useful if the resulting name is larger than 128 bytes)
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +ensureIndex(collectionName, fieldOrSpec[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – name of the collection to create the index on.
          • +
        • fieldOrSpec (object) – fieldOrSpec that defines the index.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from ensureIndex or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('more_complex_ensure_index_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      db.ensureIndex('more_complex_ensure_index_test', {a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Show that duplicate records got dropped
+        collection.find({}).toArray(function(err, items) {
+          assert.equal(null, err);
+          assert.equal(4, items.length);
+
+          // Peform a query, with explain to show we hit the query
+          collection.find({a:2}, {explain:true}).toArray(function(err, explanation) {
+            assert.equal(null, err);
+            assert.ok(explanation[0].indexBounds.a != null);
+            assert.ok(explanation[0].indexBounds.b != null);
+
+            db.close();
+          });
+        })
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        cursorInfo

        +

        Returns the information available on allocated cursors.

        +
        +
        Options
        +
          +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        +
        +
        +
        +
        +cursorInfo([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from cursorInfo or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A Simple example of returning current cursor information in MongoDB

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('cursor_information_collection', function(err, collection) {
+    assert.equal(null, err);
+
+    // Create a bunch of documents so we can force the creation of a cursor
+    var docs = [];
+    for(var i = 0; i < 1000; i++) {
+      docs.push({a:'hello world hello world hello world hello world hello world hello world hello world hello world'});
+    }
+
+    // Insert a bunch of documents for the index
+    collection.insert(docs, {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Let's set a cursor
+      var cursor = collection.find({}, {batchSize:10});
+      cursor.nextObject(function(err, item) {
+        assert.equal(null, err);
+
+        // Let's grab the information about the cursors on the database
+        db.cursorInfo(function(err, cursorInformation) {
+          assert.ok(cursorInformation.totalOpen > 0);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        dropIndex

        +

        Drop an index on a collection.

        +
        +
        +dropIndex(collectionName, indexName, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – the name of the collection where the command will drop an index.
          • +
        • indexName (string) – name of the index to drop.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dropIndex or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An examples showing the creation and dropping of an index

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('create_and_drop_an_index', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Drop the index
+        db.dropIndex("create_and_drop_an_index", "a_1_b_1", function(err, result) {
+          assert.equal(null, err);
+
+          // Verify that the index is gone
+          collection.indexInformation(function(err, indexInformation) {
+            assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_);
+            assert.equal(null, indexInformation.a_1_b_1);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        reIndex

        +

        Reindex all indexes on the collection +Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections.

        +
        +
        +reIndex(collectionName, callback)
        +
        +++ + + + +
        Arguments:
          +
        • collectionName (string) – the name of the collection.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from reIndex or null if an error occured.
          • +
        +
        +
        + +

        Examples

        +
        +

        An example showing how to force a reindex of a collection.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('create_and_drop_all_indexes', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Force a reindex of the collection
+        db.reIndex('create_and_drop_all_indexes', function(err, result) {
+          assert.equal(null, err);
+          assert.equal(true, result);
+
+          // Verify that the index is gone
+          collection.indexInformation(function(err, indexInformation) {
+            assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_);
+            assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        indexInformation

        +

        Retrieves this collections index info.

        +
        +
        Options
        +
          +
        • full {Boolean, default:false}, returns the full raw index information.
          • +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +indexInformation(collectionName[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • collectionName (string) – the name of the collection.
          • +
        • [options] (object) – additional options during update.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from indexInformation or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example showing the information returned by indexInformation

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection we want to drop later
+  db.createCollection('more_index_information_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Create an index on the a field
+      collection.ensureIndex({a:1, b:1}
+        , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) {
+
+        // Fetch basic indexInformation for collection
+        db.indexInformation('more_index_information_test', function(err, indexInformation) {
+          assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_);
+          assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1);
+
+          // Fetch full index information
+          collection.indexInformation({full:true}, function(err, indexInformation) {
+            assert.deepEqual({ _id: 1 }, indexInformation[0].key);
+            assert.deepEqual({ a: 1, b: 1 }, indexInformation[1].key);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        dropDatabase

        +

        Drop a database.

        +
        +
        +dropDatabase(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from dropDatabase or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An examples showing the dropping of a database

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Create a collection
+  db.createCollection('more_index_information_test', function(err, collection) {
+    assert.equal(null, err);
+
+    // Insert a bunch of documents for the index
+    collection.insert([{a:1, b:1}, {a:1, b:1}
+      , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) {
+      assert.equal(null, err);
+
+      // Let's drop the database
+      db.dropDatabase(function(err, result) {
+        assert.equal(null, err);
+
+        // Wait to seconds to let it replicate across
+        setTimeout(function() {
+          // Get the admin database
+          db.admin().listDatabases(function(err, dbs) {
+            // Grab the databases
+            dbs = dbs.databases;
+            // Did we find the db
+            var found = false;
+
+            // Check if we have the db in the list
+            for(var i = 0; i < dbs.length; i++) {
+              if(dbs[i].name == 'integration_tests_to_drop') found = true;
+            }
+
+            // We should not find the databases
+            if(process.env['JENKINS'] == null) assert.equal(false, found);
+
+            db.close();
+          });
+        }, 2000);
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        stats

        +

        Get all the db statistics.

        +
        +
        Options
        +
          +
        • scale {Number}, divide the returned sizes by scale value.
          • +
        • readPreference {String}, the preferred read preference ((Server.PRIMARY, Server.PRIMARY_PREFERRED, Server.SECONDARY, Server.SECONDARY_PREFERRED, Server.NEAREST).
          • +
        +
        +
        +
        +
        +stats([options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [options] (objects) – options for the stats command
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from stats or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        An example showing how to retrieve the db statistics

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  assert.equal(null, err);
+
+  db.stats(function(err, stats) {
+    assert.equal(null, err);
+    assert.ok(stats != null);
+
+    db.close();
+  })
+});
+
        +
        +
        +
        +
        +

        Db.connect

        +

        Connect to MongoDB using a url as documented at

        +

        docs.mongodb.org/manual/reference/connection-string/

        +
        +
        Options
        +
          +
        • uri_decode_auth {Boolean, default:false} uri decode the user name and password for authentication
          • +
        • db {Object, default: null} a hash off options to set on the db object, see Db constructor
          • +
        • server {Object, default: null} a hash off options to set on the server objects, see Server constructor**
          • +
        • replSet {Object, default: null} a hash off options to set on the replSet object, see ReplSet constructor**
          • +
        • mongos {Object, default: null} a hash off options to set on the mongos object, see Mongos constructor**
          • +
        +
        +
        +
        +
        +Db.connect(url[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • url (string) – connection url for MongoDB.
          • +
        • [options] (object) – optional options for insert command
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the db instance or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple url connection string, with no acknowledgement of writes.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Connect to the server
+Db.connect(configuration.url(), function(err, db) {
+  assert.equal(null, err);
+
+  db.close();
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/grid.html b/api-generated/grid.html new file mode 100644 index 00000000000..ff277cbad98 --- /dev/null +++ b/api-generated/grid.html @@ -0,0 +1,544 @@ + + + + + + + + + + Grid() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Grid()

        +
        +

        Constructor

        +

        A class representation of a simple Grid interface.

        +
        +
        +
        +class Grid()
        +
        +++ + + + + + +
        Arguments:
          +
        • db (db) – A database instance to interact with.
          • +
        • [fsName] (string) – optional different root collection for GridFS.
          • +
        +
        Returns:

        grid

        +
        +
        + +
        +
        +
        +

        put

        +

        Puts binary data to the grid

        +
        +
        Options
        +
          +
        • _id {Any}, unique id for this file
          • +
        • root {String}, root collection to use. Defaults to {GridStore.DEFAULT_ROOT_COLLECTION}.
          • +
        • content_type {String}, mime type of the file. Defaults to {GridStore.DEFAULT_CONTENT_TYPE}.
          • +
        • chunk_size {Number}, size for the chunk. Defaults to {Chunk.DEFAULT_CHUNK_SIZE}.
          • +
        • metadata {Object}, arbitrary data the user wants to store.
          • +
        +
        +
        +
        +
        +put(data[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • data (buffer) – buffer with Binary Data.
          • +
        • [options] (object) – the options for the files.
          • +
        • callback (function) – this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the put method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new grid instance
+  var grid = new Grid(db, 'fs');
+  // Some data to write
+  var originalData = new Buffer('Hello world');
+  // Write data to grid
+  grid.put(originalData, {}, function(err, result) {
+    // Fetch the content
+    grid.get(result._id, function(err, data) {
+      assert.deepEqual(originalData.toString('base64'), data.toString('base64'));
+
+      db.close();
+    });
+  });
+});
+
        +
        +

        A simple example showing the usage of the put method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new grid instance
+  var grid = new Grid(db, 'fs');
+  // Some data to write
+  var originalData = new Buffer('Hello world');
+  // Write data to grid
+  var id = 123;
+  grid.put(originalData, {_id: id}, function(err, result) {
+    // Fetch the content
+    grid.get(id, function(err, data) {
+      assert.deepEqual(originalData.toString('base64'), data.toString('base64'));
+
+      db.close();
+    });
+  });
+});
+
        +
        +

        A simple example showing the usage of the put method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new grid instance
+  var grid = new Grid(db, 'fs');
+  // Some data to write
+  var originalData = new Buffer('Hello world');
+  // Write data to grid
+  var id = 'test';
+  grid.put(originalData, {_id: id}, function(err, result) {
+    assert.equal(result._id, id);
+
+    // Fetch the content
+    grid.get(id, function(err, data) {
+      assert.deepEqual(originalData.toString('base64'), data.toString('base64'));
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        get

        +

        Get binary data to the grid

        +
        +
        +get(id, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • id (any) – for file.
          • +
        • callback (function) – this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the get method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new grid instance
+  var grid = new Grid(db, 'fs');
+  // Some data to write
+  var originalData = new Buffer('Hello world');
+  // Write data to grid
+  grid.put(originalData, {}, function(err, result) {
+    // Fetch the content
+    grid.get(result._id, function(err, data) {
+      assert.deepEqual(originalData.toString('base64'), data.toString('base64'));
+
+      // Should fail due to illegal objectID
+      grid.get('not an id', function(err, result) {
+        assert.ok(err != null);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        delete

        +

        Delete file from grid

        +
        +
        +delete(id, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • id (any) – for file.
          • +
        • callback (function) – this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the delete method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new grid instance
+  var grid = new Grid(db, 'fs');
+  // Some data to write
+  var originalData = new Buffer('Hello world');
+  // Write data to grid
+  grid.put(originalData, {}, function(err, result) {
+
+    // Delete file
+    grid.delete(result._id, function(err, result2) {
+      assert.equal(null, err);
+      assert.equal(true, result2);
+
+      // Fetch the content, showing that the file is gone
+      grid.get(result._id, function(err, data) {
+        assert.ok(err != null);
+        assert.equal(null, data);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/gridstore.html b/api-generated/gridstore.html new file mode 100644 index 00000000000..73d01dd484f --- /dev/null +++ b/api-generated/gridstore.html @@ -0,0 +1,2286 @@ + + + + + + + + + + GridStore() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        GridStore()

        +
        +

        Constructor

        +

        A class representation of a file stored in GridFS.

        +
        +
        +
        +class GridStore()
        +
        +++ + + + + + +
        Arguments:
          +
        • db (db) – A database instance to interact with.
          • +
        • [id] (any) – optional unique id for this file
          • +
        • [filename] (string) – optional filename for this file, no unique constrain on the field
          • +
        • mode (string) – set the mode for this file.
          • +
        • options (object) – optional properties to specify.
          • +
        +
        Returns:

        gridstore

        +
        +
        + +
        +
        +
        Modes
        +
          +
        • “r” - read only. This is the default mode.
          • +
        • “w” - write in truncate mode. Existing data will be overwriten.
          • +
        • w+” - write in edit mode.
          • +
        +
        +
        Options
        +
          +
        • root {String}, root collection to use. Defaults to {GridStore.DEFAULT_ROOT_COLLECTION}.
          • +
        • content_type {String}, mime type of the file. Defaults to {GridStore.DEFAULT_CONTENT_TYPE}.
          • +
        • chunk_size {Number}, size for the chunk. Defaults to {Chunk.DEFAULT_CHUNK_SIZE}.
          • +
        • metadata {Object}, arbitrary data the user wants to store.
          • +
        +
        +
        +
        +
        +

        Constants

        + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Constant NameValueDescription
        GridStore.DEFAULT_ROOT_COLLECTION‘fs’The collection to be used for holding the files and chunks collection.
        GridStore.DEFAULT_CONTENT_TYPE‘binary/octet-stream’Default file mime type
        GridStore.IO_SEEK_SET0Seek mode where the given length is absolute.
        GridStore.IO_SEEK_CUR1Seek mode where the given length is an offset to the current read/write head.
        GridStore.IO_SEEK_END2Seek mode where the given length is an offset to the end of the file.
        +
        +
        +

        Properties

        +

        Returns the current chunksize of the file.

        +
        +
        +chunkSize number [Getter|Setter]
        +
        + +

        The md5 checksum for this file.

        +
        +
        +md5 number [Getter|Setter]
        +
        + +
        +
        +

        open

        +

        Opens the file from the database and initialize this object. Also creates a +new one if file does not exist.

        +
        +
        +open(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain an {Error} object and the second parameter will be null if an error occured. Otherwise, the first parameter will be null and the second will contain the reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to save a file with a filename allowing for multiple files with the same name

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a file and open it
+  var gridStore = new GridStore(db, new ObjectID(), "test_gs_getc_file", "w");
+  gridStore.open(function(err, gridStore) {
+    // Write some content to the file
+    gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) {
+      // Flush the file to GridFS
+      gridStore.close(function(err, fileData) {
+        assert.equal(null, err);
+
+        // Create another file with same name and and save content to it
+        gridStore = new GridStore(db, new ObjectID(), "test_gs_getc_file", "w");
+        gridStore.open(function(err, gridStore) {
+          // Write some content to the file
+          gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) {
+            // Flush the file to GridFS
+            gridStore.close(function(err, fileData) {
+              assert.equal(null, err);
+
+              // Open the file in read mode using the filename
+              var gridStore2 = new GridStore(db, "test_gs_getc_file", "r");
+              gridStore2.open(function(err, gridStore) {
+
+                // Read first character and verify
+                gridStore.getc(function(err, chr) {
+                  assert.equal('h', chr);
+
+                  // Open the file using an object id
+                  gridStore2 = new GridStore(db, fileData._id, "r");
+                  gridStore2.open(function(err, gridStore) {
+
+                    // Read first character and verify
+                    gridStore.getc(function(err, chr) {
+                      assert.equal('h', chr);
+
+                      db.close();
+                    })
+                  });
+                });
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +

        A simple example showing opening a file using a filename, writing to it and saving it.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new instance of the gridstore
+  var gridStore = new GridStore(db, 'ourexamplefiletowrite.txt', 'w');
+
+  // Open the file
+  gridStore.open(function(err, gridStore) {
+
+    // Write some data to the file
+    gridStore.write('bar', function(err, gridStore) {
+      assert.equal(null, err);
+
+      // Close (Flushes the data to MongoDB)
+      gridStore.close(function(err, result) {
+        assert.equal(null, err);
+
+        // Verify that the file exists
+        GridStore.exist(db, 'ourexamplefiletowrite.txt', function(err, result) {
+          assert.equal(null, err);
+          assert.equal(true, result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +

        A simple example showing opening a file using an ObjectID, writing to it and saving it.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Create a new instance of the gridstore
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the file
+  gridStore.open(function(err, gridStore) {
+
+    // Write some data to the file
+    gridStore.write('bar', function(err, gridStore) {
+      assert.equal(null, err);
+
+      // Close (Flushes the data to MongoDB)
+      gridStore.close(function(err, result) {
+        assert.equal(null, err);
+
+        // Verify that the file exists
+        GridStore.exist(db, fileId, function(err, result) {
+          assert.equal(null, err);
+          assert.equal(true, result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        writeFile

        +

        Stores a file from the file system to the GridFS database.

        +
        +
        +writeFile(file, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • file (string) – the file to store.
          • +
        • callback (function) – this will be called after this method is executed. The first parameter will be null and the the second will contain the reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to write a file to Gridstore using file location path.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Read the filesize of file on disk (provide your own)
+  var fileSize = fs.statSync('./test/tests/functional/gridstore/test_gs_weird_bug.png').size;
+  // Read the buffered data for comparision reasons
+  var data = fs.readFileSync('./test/tests/functional/gridstore/test_gs_weird_bug.png');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Write the file to gridFS
+    gridStore.writeFile('./test/tests/functional/gridstore/test_gs_weird_bug.png', function(err, doc) {
+
+      // Read back all the written content and verify the correctness
+      GridStore.read(db, fileId, function(err, fileData) {
+        assert.equal(data.toString('base64'), fileData.toString('base64'))
+        assert.equal(fileSize, fileData.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +

        A simple example showing how to write a file to Gridstore using a file handle.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Read the filesize of file on disk (provide your own)
+  var fileSize = fs.statSync('./test/tests/functional/gridstore/test_gs_weird_bug.png').size;
+  // Read the buffered data for comparision reasons
+  var data = fs.readFileSync('./test/tests/functional/gridstore/test_gs_weird_bug.png');
+
+  // Open a file handle for reading the file
+  var fd = fs.openSync('./test/tests/functional/gridstore/test_gs_weird_bug.png', 'r', 0666);
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Write the file to gridFS using the file handle
+    gridStore.writeFile(fd, function(err, doc) {
+
+      // Read back all the written content and verify the correctness
+      GridStore.read(db, fileId, function(err, fileData) {
+        assert.equal(data.toString('base64'), fileData.toString('base64'));
+        assert.equal(fileSize, fileData.length);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        close

        +

        Saves this file to the database. This will overwrite the old entry if it +already exists. This will work properly only if mode was initialized to +“w” or “w+”.

        +
        +
        +close(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. Passes an {Error} object to the first parameter and null to the second if an error occured. Otherwise, passes null to the first and a reference to this object to the second.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to use the write command with strings and Buffers.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Write a text string
+    gridStore.write('Hello world', function(err, gridStore) {
+
+      // Close the
+      gridStore.close(function(err, result) {
+        assert.equal(err, null);
+
+        db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        chunkCollection

        +

        Retrieve this file’s chunks collection.

        +
        +
        +chunkCollection(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. An exception object will be passed to the first parameter when an error occured or null otherwise. A new {Collection} object will be passed to the second parameter if no error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to access the chunks collection object.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Access the Chunk collection
+    gridStore.chunkCollection(function(err, collection) {
+      assert.equal(err, null);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        + +
        +

        collection

        +

        Retrieves the file collection associated with this object.

        +
        +
        +collection(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. An exception object will be passed to the first parameter when an error occured or null otherwise. A new {Collection} object will be passed to the second parameter if no error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to access the files collection object.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Access the Chunk collection
+    gridStore.collection(function(err, collection) {
+      assert.equal(err, null);
+
+      db.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        readlines

        +

        Reads the data of this file.

        +
        +
        +readlines([separator], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [separator] (string) – the character to be recognized as the newline separator.
          • +
        • callback (function) – This will be called after this method is executed. The first parameter will be null and the second parameter will contain an array of strings representing the entire data, each element representing a line including the separator character.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing reading back using readlines to split the text into lines by the seperator provided.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Write one line to gridStore
+    gridStore.puts("line one", function(err, gridStore) {
+
+      // Write second line to gridStore
+      gridStore.puts("line two", function(err, gridStore) {
+
+        // Write third line to gridStore
+        gridStore.puts("line three", function(err, gridStore) {
+
+          // Flush file to disk
+          gridStore.close(function(err, result) {
+
+            // Open file for reading
+            gridStore = new GridStore(db, fileId, 'r');
+            gridStore.open(function(err, gridStore) {
+
+              // Read all the lines and verify correctness
+              gridStore.readlines(function(err, lines) {
+                assert.deepEqual(["line one\n", "line two\n", "line three\n"], lines);
+
+                db.close();
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        rewind

        +

        Deletes all the chunks of this file in the database if mode was set to “w” or +“w+” and resets the read/write head to the initial position.

        +
        +
        +rewind(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to rewind and overwrite the file.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Create a new file
+  var gridStore = new GridStore(db, fileId, "w");
+  // Open the file
+  gridStore.open(function(err, gridStore) {
+    // Write to the file
+    gridStore.write("hello, world!", function(err, gridStore) {
+      // Flush the file to disk
+      gridStore.close(function(err, result) {
+
+        // Reopen the file
+        gridStore = new GridStore(db, fileId, "w");
+        gridStore.open(function(err, gridStore) {
+          // Write some more text to the file
+          gridStore.write('some text is inserted here', function(err, gridStore) {
+
+            // Let's rewind to truncate the file
+            gridStore.rewind(function(err, gridStore) {
+
+              // Write something from the start
+              gridStore.write('abc', function(err, gridStore) {
+
+                // Flush the data to mongodb
+                gridStore.close(function(err, result) {
+
+                  // Verify that the new data was written
+                  GridStore.read(db, fileId, function(err, data) {
+                    assert.equal("abc", data);
+
+                    db.close();
+                  });
+                });
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        read

        +

        Retrieves the contents of this file and advances the read/write head. Works with Buffers only.

        +

        There are 3 signatures for this method

        +

        (callback) +(length, callback) +(length, buffer, callback)

        +
        +
        +read([length][, buffer], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [length] (number) – the number of characters to read. Reads all the characters from the read/write head to the EOF if not specified.
          • +
        • [buffer] (string) – a string to hold temporary data. This is used for storing the string data read so far when recursively calling this method.
          • +
        • callback (function) – this will be called after this method is executed. null will be passed to the first parameter and a string containing the contents of the buffer concatenated with the contents read from this file will be passed to the second.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the read method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Read in the content of a file
+  var data = fs.readFileSync('./test/tests/functional/gridstore/iya_logo_final_bw.jpg');
+  // Create a new file
+  var gs = new GridStore(db, "test", "w");
+  // Open the file
+  gs.open(function(err, gs) {
+    // Write the file to GridFS
+    gs.write(data, function(err, gs) {
+      // Flush to the GridFS
+      gs.close(function(err, gs) {
+
+        // Define the file we wish to read
+        var gs2 = new GridStore(db, "test", "r");
+        // Open the file
+        gs2.open(function(err, gs) {
+          // Set the pointer of the read head to the start of the gridstored file
+          gs2.seek(0, function() {
+            // Read the entire file
+            gs2.read(function(err, data2) {
+              // Compare the file content against the orgiinal
+              assert.equal(data.toString('base64'), data2.toString('base64'));
+
+              db.close();
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        tell

        +

        Retrieves the position of the read/write head of this file.

        +
        +
        +tell(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – This gets called after this method terminates. null is passed to the first parameter and the position is passed to the second.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the tell method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new file
+  var gridStore = new GridStore(db, "test_gs_tell", "w");
+  // Open the file
+  gridStore.open(function(err, gridStore) {
+    // Write a string to the file
+    gridStore.write("hello, world!", function(err, gridStore) {
+      // Flush the file to GridFS
+      gridStore.close(function(err, result) {
+
+        // Open the file in read only mode
+        var gridStore2 = new GridStore(db, "test_gs_tell", "r");
+        gridStore2.open(function(err, gridStore) {
+
+          // Read the first 5 characters
+          gridStore.read(5, function(err, data) {
+            assert.equal("hello", data);
+
+            // Get the current position of the read head
+            gridStore.tell(function(err, position) {
+              assert.equal(5, position);
+
+              db.close();
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        seek

        +

        Moves the read/write head to a new location.

        +

        There are 3 signatures for this method

        +
        +
        Seek Location Modes
        +
          +
        • GridStore.IO_SEEK_SET, (default) set the position from the start of the file.
          • +
        • GridStore.IO_SEEK_CUR, set the position from the current position in the file.
          • +
        • GridStore.IO_SEEK_END, set the position from the end of the file.
          • +
        +
        +
        +
        +
        +seek([position][, seekLocation], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • [position] (number) – the position to seek to
          • +
        • [seekLocation] (number) – seek mode. Use one of the Seek Location modes.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the seek method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a file and open it
+  var gridStore = new GridStore(db, "test_gs_seek_with_buffer", "w");
+  gridStore.open(function(err, gridStore) {
+    // Write some content to the file
+    gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) {
+      // Flush the file to GridFS
+      gridStore.close(function(result) {
+
+        // Open the file in read mode
+        var gridStore2 = new GridStore(db, "test_gs_seek_with_buffer", "r");
+        gridStore2.open(function(err, gridStore) {
+          // Seek to start
+          gridStore.seek(0, function(err, gridStore) {
+            // Read first character and verify
+            gridStore.getc(function(err, chr) {
+              assert.equal('h', chr);
+            });
+          });
+        });
+
+        // Open the file in read mode
+        var gridStore3 = new GridStore(db, "test_gs_seek_with_buffer", "r");
+        gridStore3.open(function(err, gridStore) {
+          // Seek to 7 characters from the beginning off the file and verify
+          gridStore.seek(7, function(err, gridStore) {
+            gridStore.getc(function(err, chr) {
+              assert.equal('w', chr);
+            });
+          });
+        });
+
+        // Open the file in read mode
+        var gridStore5 = new GridStore(db, "test_gs_seek_with_buffer", "r");
+        gridStore5.open(function(err, gridStore) {
+          // Seek to -1 characters from the end off the file and verify
+          gridStore.seek(-1, GridStore.IO_SEEK_END, function(err, gridStore) {
+            gridStore.getc(function(err, chr) {
+              assert.equal('!', chr);
+            });
+          });
+        });
+
+        // Open the file in read mode
+        var gridStore6 = new GridStore(db, "test_gs_seek_with_buffer", "r");
+        gridStore6.open(function(err, gridStore) {
+          // Seek to -6 characters from the end off the file and verify
+          gridStore.seek(-6, GridStore.IO_SEEK_END, function(err, gridStore) {
+            gridStore.getc(function(err, chr) {
+              assert.equal('w', chr);
+            });
+          });
+        });
+
+        // Open the file in read mode
+        var gridStore7 = new GridStore(db, "test_gs_seek_with_buffer", "r");
+        gridStore7.open(function(err, gridStore) {
+
+          // Seek forward 7 characters from the current read position and verify
+          gridStore.seek(7, GridStore.IO_SEEK_CUR, function(err, gridStore) {
+            gridStore.getc(function(err, chr) {
+              assert.equal('w', chr);
+
+              // Seek forward -1 characters from the current read position and verify
+              gridStore.seek(-1, GridStore.IO_SEEK_CUR, function(err, gridStore) {
+                gridStore.getc(function(err, chr) {
+                  assert.equal('w', chr);
+
+                  // Seek forward -4 characters from the current read position and verify
+                  gridStore.seek(-4, GridStore.IO_SEEK_CUR, function(err, gridStore) {
+                    gridStore.getc(function(err, chr) {
+                      assert.equal('o', chr);
+
+                      // Seek forward 3 characters from the current read position and verify
+                      gridStore.seek(3, GridStore.IO_SEEK_CUR, function(err, gridStore) {
+                        gridStore.getc(function(err, chr) {
+                          assert.equal('o', chr);
+
+                          db.close();
+                        });
+                      });
+                    });
+                  });
+                });
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        eof

        +

        Verify if the file is at EOF.

        +
        +
        +eof()
        +
        +++ + + + +
        Returns:boolean true if the read/write head is at the end of this file.
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the eof method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Open the file in write mode
+  var gridStore = new GridStore(db, 'test_gs_empty_file_eof', "w");
+  gridStore.open(function(err, gridStore) {
+    // Flush the empty file to GridFS
+    gridStore.close(function(err, gridStore) {
+
+      // Open the file in read mode
+      var gridStore2 = new GridStore(db, 'test_gs_empty_file_eof', "r");
+      gridStore2.open(function(err, gridStore) {
+        // Verify that we are at the end of the file
+        assert.equal(true, gridStore.eof());
+
+        db.close();
+      })
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        getc

        +

        Retrieves a single character from this file.

        +
        +
        +getc(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this gets called after this method is executed. Passes null to the first parameter and the character read to the second or null to the second if the read/write head is at the end of the file.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the seek method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a file and open it
+  var gridStore = new GridStore(db, "test_gs_getc_file", "w");
+  gridStore.open(function(err, gridStore) {
+    // Write some content to the file
+    gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) {
+      // Flush the file to GridFS
+      gridStore.close(function(result) {
+
+        // Open the file in read mode
+        var gridStore2 = new GridStore(db, "test_gs_getc_file", "r");
+        gridStore2.open(function(err, gridStore) {
+
+          // Read first character and verify
+          gridStore.getc(function(err, chr) {
+            assert.equal('h', chr);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        puts

        +

        Writes a string to the file with a newline character appended at the end if +the given string does not have one.

        +
        +
        +puts(string, callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • string (string) – the string to write.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the puts method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Open a file for writing
+  var gridStore = new GridStore(db, "test_gs_puts_and_readlines", "w");
+  gridStore.open(function(err, gridStore) {
+
+    // Write a line to the file using the puts method
+    gridStore.puts("line one", function(err, gridStore) {
+
+      // Flush the file to GridFS
+      gridStore.close(function(err, result) {
+
+        // Read in the entire contents
+        GridStore.read(db, 'test_gs_puts_and_readlines', function(err, data) {
+          assert.equal("line one\n", data.toString());
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        stream

        +

        Returns read stream based on this GridStore file

        +
        +
        Events
        +
          +
        • data {function(item) {}} the data event triggers when a document is ready.
          • +
        • end {function() {}} the end event triggers when there is no more documents available.
          • +
        • close {function() {}} the close event triggers when the stream is closed.
          • +
        • error {function(err) {}} the error event triggers if an error happens.
          • +
        +
        +
        +
        +
        +stream(autoclose)
        +
        +++ + + + + + +
        Arguments:
          +
        • autoclose (boolean) – if true current GridStore will be closed when EOF and ‘close’ event will be fired
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the stream method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Open a file for reading
+  var gridStoreR = new GridStore(db, "test_gs_read_stream", "r");
+  // Open a file for writing
+  var gridStoreW = new GridStore(db, "test_gs_read_stream", "w");
+  // Read in the data of a file
+  var data = fs.readFileSync("./test/tests/functional/gridstore/test_gs_weird_bug.png");
+
+  var readLen = 0;
+  var gotEnd = 0;
+
+  // Open the file we are writting to
+  gridStoreW.open(function(err, gs) {
+    // Write the file content
+    gs.write(data, function(err, gs) {
+      // Flush the file to GridFS
+      gs.close(function(err, result) {
+
+        // Open the read file
+        gridStoreR.open(function(err, gs) {
+
+          // Create a stream to the file
+          var stream = gs.stream(true);
+
+          // Register events
+          stream.on("data", function(chunk) {
+            // Record the length of the file
+            readLen += chunk.length;
+          });
+
+          stream.on("end", function() {
+            // Record the end was called
+            ++gotEnd;
+          });
+
+          stream.on("close", function() {
+            // Verify the correctness of the read data
+            assert.equal(data.length, readLen);
+            assert.equal(1, gotEnd);
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +

        A simple example showing how to pipe a file stream through from gridfs to a file

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Open a file for writing
+  var gridStoreWrite = new GridStore(db, "test_gs_read_stream_pipe", "w", {chunkSize:1024});
+  gridStoreWrite.writeFile("./test/tests/functional/gridstore/test_gs_weird_bug.png", function(err, result) {
+    // Open the gridStore for reading and pipe to a file
+    var gridStore = new GridStore(db, "test_gs_read_stream_pipe", "r");
+    gridStore.open(function(err, gridStore) {
+      // Grab the read stream
+      var stream = gridStore.stream(true);
+      // When the stream is finished close the database
+      stream.on("end", function(err) {
+        // Read the original content
+        var originalData = fs.readFileSync("./test/tests/functional/gridstore/test_gs_weird_bug.png");
+        // Ensure we are doing writing before attempting to open the file
+        fs.readFile("./test_gs_weird_bug_streamed.tmp", function(err, streamedData) {
+          // Compare the data
+          assert.deepEqual(originalData, streamedData);
+
+          // Close the database
+          db.close();
+        });
+      })
+
+      // Create a file write stream
+      var fileStream = fs.createWriteStream("./test_gs_weird_bug_streamed.tmp");
+      // Pipe out the data
+      stream.pipe(fileStream);
+    })
+  })
+});
+
        +
        +
        +
        +
        +

        GridStore.exist

        +

        Checks if a file exists in the database.

        +
        +
        +GridStore.exist(db, name[, rootCollection], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • db (db) – the database to query.
          • +
        • name (string) – the name of the file to look for.
          • +
        • [rootCollection] (string) – the root collection that holds the files and chunks collection. Defaults to {GridStore.DEFAULT_ROOT_COLLECTION}.
          • +
        • callback (function) – this will be called after this method executes. Passes null to the first and passes true to the second if the file exists and false otherwise.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the Gridstore.exist method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+
+  // Open a file for writing
+  var gridStore = new GridStore(db, null, "w");
+  gridStore.open(function(err, gridStore) {
+    assert.equal(null, err);
+
+    // Writing some content to the file
+    gridStore.write("hello world!", function(err, gridStore) {
+      assert.equal(null, err);
+
+      // Flush the file to GridFS
+      gridStore.close(function(err, result) {
+        assert.equal(null, err);
+
+        // Check if the file exists using the id returned from the close function
+        GridStore.exist(db, result._id, function(err, result) {
+          assert.equal(null, err);
+          assert.equal(true, result);
+        })
+
+        // Show that the file does not exist for a random ObjectID
+        GridStore.exist(db, new ObjectID(), function(err, result) {
+          assert.equal(null, err);
+          assert.equal(false, result);
+        });
+
+        // Show that the file does not exist for a different file root
+        GridStore.exist(db, result._id, 'another_root', function(err, result) {
+          assert.equal(null, err);
+          assert.equal(false, result);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        GridStore.list

        +

        Gets the list of files stored in the GridFS.

        +
        +
        +GridStore.list(db[, rootCollection], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • db (db) – the database to query.
          • +
        • [rootCollection] (string) – the root collection that holds the files and chunks collection. Defaults to {GridStore.DEFAULT_ROOT_COLLECTION}.
          • +
        • callback (function) – this will be called after this method executes. Passes null to the first and passes an array of strings containing the names of the files.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the eof method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file id
+  var fileId = new ObjectID();
+
+  // Open a file for writing
+  var gridStore = new GridStore(db, fileId, "foobar2", "w");
+  gridStore.open(function(err, gridStore) {
+
+    // Write some content to the file
+    gridStore.write("hello world!", function(err, gridStore) {
+      // Flush to GridFS
+      gridStore.close(function(err, result) {
+
+        // List the existing files
+        GridStore.list(db, function(err, items) {
+          var found = false;
+          items.forEach(function(filename) {
+            if(filename == 'foobar2') found = true;
+          });
+
+          assert.ok(items.length >= 1);
+          assert.ok(found);
+        });
+
+        // List the existing files but return only the file ids
+        GridStore.list(db, {id:true}, function(err, items) {
+          var found = false;
+          items.forEach(function(id) {
+            assert.ok(typeof id == 'object');
+          });
+
+          assert.ok(items.length >= 1);
+        });
+
+        // List the existing files in a specific root collection
+        GridStore.list(db, 'fs', function(err, items) {
+          var found = false;
+          items.forEach(function(filename) {
+            if(filename == 'foobar2') found = true;
+          });
+
+          assert.ok(items.length >= 1);
+          assert.ok(found);
+        });
+
+        // List the existing files in a different root collection where the file is not located
+        GridStore.list(db, 'my_fs', function(err, items) {
+          var found = false;
+          items.forEach(function(filename) {
+            if(filename == 'foobar2') found = true;
+          });
+
+          assert.ok(items.length >= 0);
+          assert.ok(!found);
+
+          // Specify seperate id
+          var fileId2 = new ObjectID();
+          // Write another file to GridFS
+          var gridStore2 = new GridStore(db, fileId2, "foobar3", "w");
+          gridStore2.open(function(err, gridStore) {
+            // Write the content
+            gridStore2.write('my file', function(err, gridStore) {
+              // Flush to GridFS
+              gridStore.close(function(err, result) {
+
+                // List all the available files and verify that our files are there
+                GridStore.list(db, function(err, items) {
+                  var found = false;
+                  var found2 = false;
+
+                  items.forEach(function(filename) {
+                    if(filename == 'foobar2') found = true;
+                    if(filename == 'foobar3') found2 = true;
+                  });
+
+                  assert.ok(items.length >= 2);
+                  assert.ok(found);
+                  assert.ok(found2);
+
+                  db.close();
+                });
+              });
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        GridStore.read

        +

        Reads the contents of a file.

        +

        This method has the following signatures

        +

        (db, name, callback) +(db, name, length, callback) +(db, name, length, offset, callback) +(db, name, length, offset, options, callback)

        +
        +
        +GridStore.read(db, name[, length][, offset][, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • db (db) – the database to query.
          • +
        • name (string) – the name of the file.
          • +
        • [length] (number) – the size of data to read.
          • +
        • [offset] (number) – the offset from the head of the file of which to start reading from.
          • +
        • [options] (object) – the options for the file.
          • +
        • callback (function) – this will be called after this method executes. A string with an error message will be passed to the first parameter when the length and offset combination exceeds the length of the file while an Error object will be passed if other forms of error occured, otherwise, a string is passed. The second parameter will contain the data read if successful or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing the usage of the read method.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Create a new file
+  var gridStore = new GridStore(db, null, "w");
+  // Read in the content from a file, replace with your own
+  var data = fs.readFileSync("./test/tests/functional/gridstore/test_gs_weird_bug.png");
+
+  // Open the file
+  gridStore.open(function(err, gridStore) {
+    // Write the binary file data to GridFS
+    gridStore.write(data, function(err, gridStore) {
+      // Flush the remaining data to GridFS
+      gridStore.close(function(err, result) {
+
+        // Read in the whole file and check that it's the same content
+        GridStore.read(db, result._id, function(err, fileData) {
+          assert.equal(data.length, fileData.length);
+
+          db.close();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        GridStore.readlines

        +

        Reads the data of this file.

        +
        +
        +GridStore.readlines(db, name[, separator][, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • db (db) – the database to query.
          • +
        • name (string) – the name of the file.
          • +
        • [separator] (string) – the character to be recognized as the newline separator.
          • +
        • [options] (object) – file options.
          • +
        • callback (function) – this will be called after this method is executed. The first parameter will be null and the second parameter will contain an array of strings representing the entire data, each element representing a line including the separator character.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing reading back using readlines to split the text into lines by the seperator provided.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Write one line to gridStore
+    gridStore.puts("line one", function(err, gridStore) {
+
+      // Write second line to gridStore
+      gridStore.puts("line two", function(err, gridStore) {
+
+        // Write third line to gridStore
+        gridStore.puts("line three", function(err, gridStore) {
+
+          // Flush file to disk
+          gridStore.close(function(err, result) {
+
+            // Read back all the lines
+            GridStore.readlines(db, fileId, function(err, lines) {
+              assert.deepEqual(["line one\n", "line two\n", "line three\n"], lines);
+
+              db.close();
+            });
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        + +
        +

        write

        +

        Writes some data. This method will work properly only if initialized with mode “w” or “w+”.

        +
        +
        +write(data[, close], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • data (string) – the data to write.
          • +
        • [close] (boolean) – closes this file after writing if set to true.
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A simple example showing how to use the write command with strings and Buffers.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // Our file ID
+  var fileId = new ObjectID();
+
+  // Open a new file
+  var gridStore = new GridStore(db, fileId, 'w');
+
+  // Open the new file
+  gridStore.open(function(err, gridStore) {
+
+    // Write a text string
+    gridStore.write('Hello world', function(err, gridStore) {
+
+      // Write a buffer
+      gridStore.write(new Buffer('Buffer Hello world'), function(err, gridStore) {
+
+        // Close the
+        gridStore.close(function(err, result) {
+
+          // Read back all the written content and verify the correctness
+          GridStore.read(db, fileId, function(err, fileData) {
+            assert.equal('Hello worldBuffer Hello world', fileData.toString());
+
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        pause

        +

        pause

        +
        +
        +pause()
        +
        + +
        +
        +

        resume

        +

        resume

        +
        +
        +resume()
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/index.html b/api-generated/index.html new file mode 100644 index 00000000000..d7f3320fc0e --- /dev/null +++ b/api-generated/index.html @@ -0,0 +1,438 @@ + + + + + + + + + + Driver API — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Driver API

        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/mongoclient.html b/api-generated/mongoclient.html new file mode 100644 index 00000000000..40dead63729 --- /dev/null +++ b/api-generated/mongoclient.html @@ -0,0 +1,525 @@ + + + + + + + + + + MongoClient() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        MongoClient()

        +
        +

        Constructor

        +

        Create a new MongoClient instance.

        +
        +
        +
        +class MongoClient()
        +
        +++ + + + +
        Arguments:
          +
        • serverConfig (object) – server config object.
          • +
        • [options] (object) – additional options for the collection.
          • +
        +
        +
        + +
        +
        +
        Options
        +
          +
        • w, {Number/String, > -1 || ‘majority’ || tag name} the write concern for the operation where < 1 is no acknowlegement of write and w >= 1, w = ‘majority’ or tag acknowledges the write
          • +
        • wtimeout, {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync, (Boolean, default:false) write waits for fsync before returning
          • +
        • journal, (Boolean, default:false) write waits for journal sync before returning
          • +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        • native_parser {Boolean, default:false}, use c++ bson parser.
          • +
        • forceServerObjectId {Boolean, default:false}, force server to create _id fields instead of client.
          • +
        • pkFactory {Object}, object overriding the basic ObjectID primary key generation.
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions.
          • +
        • raw {Boolean, default:false}, peform operations using raw bson buffers.
          • +
        • recordQueryStats {Boolean, default:false}, record query statistics during execution.
          • +
        • retryMiliSeconds {Number, default:5000}, number of miliseconds between retries.
          • +
        • numberOfRetries {Number, default:5}, number of retries off connection.
          • +
        +
        +
        Deprecated Options
        +
          +
        • safe {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
          • +
        +
        +
        +
        +
        +

        open

        +

        Initialize the database connection.

        +
        +
        +open(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the connected mongoclient or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        A basic example using the MongoClient to connect using a Server instance, similar to existing Db version

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Set up the connection to the local db
+var mongoclient = new MongoClient(new Server("localhost", 27017, {native_parser: true}));
+
+// Open the connection to the server
+mongoclient.open(function(err, mongoclient) {
+
+  // Get the first db and do an update document on it
+  var db = mongoclient.db("integration_tests");
+  db.collection('mongoclient_test').update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    assert.equal(null, err);
+    assert.equal(1, result);
+
+    // Get another db and do an update document on it
+    var db2 = mongoclient.db("integration_tests2");
+    db2.collection('mongoclient_test').update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+      assert.equal(null, err);
+      assert.equal(1, result);
+
+      // Close the connection
+      mongoclient.close();
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        close

        +

        Close the current db connection, including all the child db instances. Emits close event if no callback is provided.

        +
        +
        +close(callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the results from the close method or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +
        +
        +

        db

        +

        Create a new Db instance sharing the current socket connections.

        +
        +
        +db(dbName)
        +
        +++ + + + + + +
        Arguments:
          +
        • dbName (string) – the name of the database we want to use.
          • +
        +
        Returns:

        db a db instance using the new database.

        +
        +
        + +
        +
        +

        MongoClient.connect

        +

        Connect to MongoDB using a url as documented at

        +

        docs.mongodb.org/manual/reference/connection-string/

        +
        +
        Options
        +
          +
        • uri_decode_auth {Boolean, default:false} uri decode the user name and password for authentication
          • +
        • db {Object, default: null} a hash off options to set on the db object, see Db constructor
          • +
        • server {Object, default: null} a hash off options to set on the server objects, see Server constructor**
          • +
        • replSet {Object, default: null} a hash off options to set on the replSet object, see ReplSet constructor**
          • +
        • mongos {Object, default: null} a hash off options to set on the mongos object, see Mongos constructor**
          • +
        +
        +
        +
        +
        +MongoClient.connect(url[, options], callback)
        +
        +++ + + + + + +
        Arguments:
          +
        • url (string) – connection url for MongoDB.
          • +
        • [options] (object) – optional options for insert command
          • +
        • callback (function) – this will be called after executing this method. The first parameter will contain the Error object if an error occured, or null otherwise. While the second parameter will contain the initialized db object or null if an error occured.
          • +
        +
        Returns:

        null

        +
        +
        + +

        Examples

        +
        +

        Example of a simple url connection string for a single server connection

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+// Connect using the connection string
+MongoClient.connect("mongodb://localhost:27017/integration_tests", {native_parser:true}, function(err, db) {
+  assert.equal(null, err);
+
+  db.collection('mongoclient_test').update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    assert.equal(null, err);
+    assert.equal(1, result);
+
+    db.close();
+  });
+});
+
        +
        +

        Example of a simple url connection string to a replicaset, with acknowledgement of writes.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+MongoClient.connect("mongodb://localhost:30000,localhost:30001,localhost:30002/integration_test_?w=1", function(err, db) {
+  assert.equal(null, err);
+  assert.ok(db != null);
+
+  db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    assert.equal(null, err);
+    assert.equal(1, result);
+
+    db.close();
+  });
+});
+
        +
        +

        Example of a simple url connection string to a shard, with acknowledgement of writes.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+MongoClient.connect('mongodb://localhost:50000,localhost:50001/sharded_test_db?w=1', function(err, db) {
+  assert.equal(null, err);
+  assert.ok(db != null);
+
+  db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    assert.equal(null, err);
+    assert.equal(1, result);
+
+    db.close();
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/mongos.html b/api-generated/mongos.html new file mode 100644 index 00000000000..0dad366fc1a --- /dev/null +++ b/api-generated/mongos.html @@ -0,0 +1,290 @@ + + + + + + + + + + Mongos() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Mongos()

        +
        +

        Constructor

        +

        Mongos constructor provides a connection to a mongos proxy including failover to additional servers

        +
        +
        +
        +class Mongos()
        +
        +++ + + + +
        Arguments:
          +
        • list (array) – of mongos server objects
          • +
        • [options] (object) – additional options for the mongos connection
          • +
        +
        +
        + +
        +
        +
        Options
        +
          +
        • socketOptions {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number))
          • +
        • ha {Boolean, default:true}, turn on high availability, attempts to reconnect to down proxies
          • +
        • haInterval {Number, default:2000}, time between each replicaset status check.
          • +
        +
        +
        +
        +
        +

        setReadPreference

        +

        Always ourselves

        +
        +
        +setReadPreference()
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/readpreference.html b/api-generated/readpreference.html new file mode 100644 index 00000000000..d01a8537e5d --- /dev/null +++ b/api-generated/readpreference.html @@ -0,0 +1,285 @@ + + + + + + + + + + ReadPreference() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        ReadPreference()

        +
        +

        Constructor

        +

        A class representation of the Read Preference.

        +
        +
        +
        +class ReadPreference()
        +
        +++ + + + + + +
        Arguments:
          +
        • the (string) – read preference type
          • +
        • tags (object) –
          • +
        +
        Returns:

        readpreference

        +
        +
        + +
        +
        +
        Read Preferences
        +
          +
        • ReadPreference.PRIMARY, Read from primary only. All operations produce an error (throw an exception where applicable) if primary is unavailable. Cannot be combined with tags (This is the default.).
          • +
        • ReadPreference.PRIMARY_PREFERRED, Read from primary if available, otherwise a secondary.
          • +
        • ReadPreference.SECONDARY, Read from secondary if available, otherwise error.
          • +
        • ReadPreference.SECONDARY_PREFERRED, Read from a secondary if available, otherwise read from the primary.
          • +
        • ReadPreference.NEAREST, All modes read from among the nearest candidates, but unlike other modes, NEAREST will include both the primary and all secondaries in the random selection.
          • +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/readstream.html b/api-generated/readstream.html new file mode 100644 index 00000000000..cf3630130f3 --- /dev/null +++ b/api-generated/readstream.html @@ -0,0 +1,510 @@ + + + + + + + + + + ReadStream() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        ReadStream()

        +
        +

        Constructor

        +

        ReadStream

        +
        +
        +
        +class ReadStream()
        +
        +++ + + + + + +
        Arguments:
          +
        • autoclose (boolean) – automatically close file when the stream reaches the end.
          • +
        • cursor (gridstore) – a cursor object that the stream wraps.
          • +
        +
        Returns:

        readstream

        +
        +
        + +
        +

        Returns a stream interface for the file.

        +
        +
        Events
        +
          +
        • data {function(item) {}} the data event triggers when a document is ready.
          • +
        • end {function() {}} the end event triggers when there is no more documents available.
          • +
        • close {function() {}} the close event triggers when the stream is closed.
          • +
        • error {function(err) {}} the error event triggers if an error happens.
          • +
        +
        +
        +
        +
        +

        pause

        +

        Pauses this stream, then no farther events will be fired.

        +
        +
        +pause()
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the readstream pause function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // File id
+  var fileId = new ObjectID();
+  // Create a file
+  var file = new GridStore(db, fileId, "w", {chunk_size:5});
+  file.open(function(err, file) {
+    // Write some content and flush to disk
+    file.write('Hello world', function(err, file) {
+      file.close(function(err, result) {
+
+        // Let's create a read file
+        file = new GridStore(db, fileId, "r");
+        // Open the file
+        file.open(function(err, file) {
+          // Peform a find to get a cursor
+          var stream = file.stream();
+
+          // For each data item
+          stream.on("data", function(item) {
+            // Check if stream is paused
+            assert.equal(false, stream.paused);
+            // Pause stream
+            stream.pause();
+            // Restart the stream after 1 miliscecond
+            setTimeout(function() {
+              stream.resume();
+              // Check if cursor is paused
+              assert.equal(false, stream.paused);
+            }, 100);
+          });
+
+          // For each data item
+          stream.on("end", function(item) {
+            stream.destroy();
+          });
+          // When the stream is done
+          stream.on("close", function() {
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        destroy

        +

        Destroys the stream, then no farther events will be fired.

        +
        +
        +destroy()
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the readstream destroy function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // File id
+  var fileId = new ObjectID();
+  // Create a file
+  var file = new GridStore(db, fileId, "w");
+  file.open(function(err, file) {
+    // Write some content and flush to disk
+    file.write('Hello world', function(err, file) {
+      file.close(function(err, result) {
+
+        // Let's create a read file
+        file = new GridStore(db, fileId, "r");
+        // Open the file
+        file.open(function(err, file) {
+          // Peform a find to get a cursor
+          var stream = file.stream();
+
+          // For each data item
+          stream.on("data", function(item) {
+            // Destroy the stream
+            stream.destroy();
+          });
+
+          // When the stream is done
+          stream.on("close", function() {
+            db.close();
+          });
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +

        resume

        +

        Resumes this stream.

        +
        +
        +resume()
        +
        + +

        Examples

        +
        +

        A simple example showing the use of the readstream resume function.

        +
        var Db = require('mongodb').Db,
+    MongoClient = require('mongodb').MongoClient,
+    Server = require('mongodb').Server,
+    ReplSetServers = require('mongodb').ReplSetServers,
+    ObjectID = require('mongodb').ObjectID,
+    Binary = require('mongodb').Binary,
+    GridStore = require('mongodb').GridStore,
+    Code = require('mongodb').Code,
+    BSON = require('mongodb').pure().BSON,
+    assert = require('assert');
+
+var db = new Db('test', new Server('locahost', 27017));
+// Establish connection to db
+db.open(function(err, db) {
+  // File id
+  var fileId = new ObjectID();
+  // Create a file
+  var file = new GridStore(db, fileId, "w", {chunk_size:5});
+  file.open(function(err, file) {
+    // Write some content and flush to disk
+    var fileBody = 'Hello world';
+    file.write(fileBody, function(err, file) {
+      file.close(function(err, result) {
+        // Let's create a read file
+        file = new GridStore(db, fileId, "r");
+
+        // Open the file
+        file.open(function(err, file) {
+          // Peform a find to get a cursor
+          var stream = file.stream(true);
+
+          // Pause the stream initially
+          stream.pause();
+
+          // Save read content here
+          var fileBuffer = '';
+
+          // For each data item
+          stream.on("data", function(item) {
+            // Check if stream is paused
+            assert.equal(false, stream.paused);
+            // Pause stream
+            stream.pause();
+            // Check if cursor is paused
+            // assert.equal(true, stream.paused);
+
+            fileBuffer += item.toString('utf8');
+
+            // Restart the stream after 1 miliscecond
+            setTimeout(function() {
+              stream.resume();
+              // Check if cursor is paused
+              assert.equal(false, stream.paused);
+            }, 100);
+          });
+
+          // For each data item
+          stream.on("end", function(item) {
+          });
+          // When the stream is done
+          stream.on("close", function() {
+            // Have we received the same file back?
+            assert.equal(fileBuffer, fileBody);
+            db.close();
+          });
+
+          // Resume the stream
+          stream.resume();
+        });
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/replset.html b/api-generated/replset.html new file mode 100644 index 00000000000..949a48020b0 --- /dev/null +++ b/api-generated/replset.html @@ -0,0 +1,345 @@ + + + + + + + + + + ReplSet — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        ReplSet

        +
        +

        Constructor

        +

        ReplSet constructor provides replicaset functionality

        +
        +
        +
        +class ReplSet()
        +
        +++ + + + +
        Arguments:
          +
        • list (array) – of server objects participating in the replicaset.
          • +
        • [options] (object) – additional options for the replicaset connection.
          • +
        +
        +
        + +
        +
        +
        Options
        +
          +
        • ha {Boolean, default:true}, turn on high availability.
          • +
        • haInterval {Number, default:2000}, time between each replicaset status check.
          • +
        • reconnectWait {Number, default:1000}, time to wait in miliseconds before attempting reconnect.
          • +
        • retries {Number, default:30}, number of times to attempt a replicaset reconnect.
          • +
        • rs_name {String}, the name of the replicaset to connect to.
          • +
        • socketOptions {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number))
          • +
        • readPreference {String}, the prefered read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
          • +
        • strategy {String, default:’ping’}, selection strategy for reads choose between (ping, statistical and none, default is ping)
          • +
        • secondaryAcceptableLatencyMS {Number, default:15}, sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms)
          • +
        • connectArbiter {Boolean, default:false}, sets if the driver should connect to arbiters or not.
          • +
        • logger {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error ({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}}).
          • +
        • ssl {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support)
          • +
        • sslValidate {Boolean, default:false}, validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslCA {Array, default:null}, Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslCert {Buffer/String, default:null}, String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslKey {Buffer/String, default:null}, String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslPass {Buffer/String, default:null}, String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        +
        +
        +
        +
        +

        _enableHA

        +

        Enables high availability pings.

        +
        +
        +_enableHA()
        +
        + +
        +
        +

        ReplSet.State

        +

        Interval state object constructor

        +
        +
        +ReplSet.State()
        +
        + +
        +
        +

        _handleOnFullSetup

        +

        Handles the first <code>fullsetup</code> event of this ReplSet.

        +
        +
        +_handleOnFullSetup(parent)
        +
        +++ + + + +
        Arguments:
          +
        • parent (db) –
          • +
        +
        +
        + +
        +
        +

        _disableHA

        +

        Disables high availability pings.

        +
        +
        +_disableHA()
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/api-generated/server.html b/api-generated/server.html new file mode 100644 index 00000000000..a8d414008aa --- /dev/null +++ b/api-generated/server.html @@ -0,0 +1,353 @@ + + + + + + + + + + Server() — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Server()

        +
        +

        Constructor

        +

        Class representing a single MongoDB Server connection

        +
        +
        +
        +class Server()
        +
        +++ + + + +
        Arguments:
          +
        • host (string) – the server host
          • +
        • port (number) – the server port
          • +
        • [options] (object) – optional options for insert command
          • +
        +
        +
        + +
        +
        +
        Options
        +
          +
        • readPreference {String, default:null}, set’s the read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST)
          • +
        • ssl {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support)
          • +
        • sslValidate {Boolean, default:false}, validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslCA {Array, default:null}, Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslCert {Buffer/String, default:null}, String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslKey {Buffer/String, default:null}, String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • sslPass {Buffer/String, default:null}, String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher)
          • +
        • poolSize {Number, default:5}, number of connections in the connection pool, set to 5 as default for legacy reasons.
          • +
        • socketOptions {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number))
          • +
        • logger {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error ({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}}).
          • +
        • auto_reconnect {Boolean, default:false}, reconnect on error.
          • +
        • disableDriverBSONSizeCheck {Boolean, default:false}, force the server to error if the BSON message is to big
          • +
        +
        +
        +
        +
        +

        setReadPreference

        +

        Always ourselves

        +
        +
        +setReadPreference()
        +
        + +
        +
        +

        assignReplicaSet

        +

        Assigns a replica set to this <code>server</code>.

        +
        +
        +assignReplicaSet(replset)
        +
        +++ + + + +
        Arguments:
          +
        • replset (replset) –
          • +
        +
        +
        + +
        +
        +

        inheritReplSetOptionsFrom

        +

        Takes needed options from <code>replset</code> and overwrites +our own options.

        +
        +
        +inheritReplSetOptionsFrom(replset)
        +
        +++ + + + +
        Arguments:
          +
        • replset (replset) –
          • +
        +
        +
        + +
        +
        +

        connect

        +

        Opens this server connection.

        +
        +
        +connect()
        +
        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/changelog/changelog.html b/changelog/changelog.html new file mode 100644 index 00000000000..a2ed48f991f --- /dev/null +++ b/changelog/changelog.html @@ -0,0 +1,1341 @@ + + + + + + + + + + Changelog — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Changelog

        +
        +

        1.2.14 2013-03-14

        +
          +
        • Refactored test suite to speed up running of replicaset tests
          • +
        • Fix of async error handling when error happens in callback (Issue #909, https://github.com/medikoo)
          • +
        • Corrected a slaveOk setting issue (Issue #906, #905)
          • +
        • Fixed HA issue where ping’s would not go to correct server on HA server connection failure.
          • +
        • Uses setImmediate if on 0.10 otherwise nextTick for cursor stream
          • +
        • Fixed race condition in Cursor stream (NODE-31)
          • +
        • Fixed issues related to node 0.10 and process.nextTick now correctly using setImmediate where needed on node 0.10
          • +
        • Added support for maxMessageSizeBytes if available (DRIVERS-1)
          • +
        • Added support for authSource (2.4) to MongoClient URL and db.authenticate method (DRIVER-69/NODE-34)
          • +
        • Fixed issue in GridStore seek and GridStore read to correctly work on multiple seeks (Issue #895)
          • +
        +
        +
        +

        1.2.13 2013-02-22

        +
          +
        • Allow strategy ‘none’ for repliaset if no strategy wanted (will default to round robin selection of servers on a set readPreference)
          • +
        • Fixed missing MongoErrors on some cursor methods (Issue #882)
          • +
        • Correctly returning a null for the db instance on MongoClient.connect when auth fails (Issue #890)
          • +
        • Added dropTarget option support for renameCollection/rename (Issue #891, help from https://github.com/jbottigliero)
          • +
        • Fixed issue where connection using MongoClient.connect would fail if first server did not exist (Issue #885)
          • +
        +
        +
        +

        1.2.12 2013-02-13

        +
          +
        • Added limit/skip options to Collection.count (Issue #870)
          • +
        • Added applySkipLimit option to Cursor.count (Issue #870)
          • +
        • Enabled ping strategy as default for Replicaset if none specified (Issue #876)
          • +
        • Should correctly pick nearest server for SECONDARY/SECONDARY_PREFERRED/NEAREST (Issue #878)
          • +
        +
        +
        +

        1.2.11 2013-01-29

        +
          +
        • Added fixes for handling type 2 binary due to PHP driver (Issue #864)
          • +
        • Moved callBackStore to Base class to have single unified store (Issue #866)
          • +
        • Ping strategy now reuses sockets unless they are closed by the server to avoid overhead
          • +
        +
        +
        +

        1.2.10 2013-01-25

        +
          +
        • Merged in SSL support for 2.4 supporting certificate validation and presenting certificates to the server.
          • +
        • Only open a new HA socket when previous one dead (Issue #859, #857)
          • +
        • Minor fixes
          • +
        +
        +
        +

        1.2.9 2013-01-15

        +
          +
        • Fixed bug in SSL support for MongoClient/Db.connect when discovering servers (Issue #849)
          • +
        • Connection string with no db specified should default to admin db (Issue #848)
          • +
        • Support port passed as string to Server class (Issue #844)
          • +
        • Removed noOpen support for MongoClient/Db.connect as auto discovery of servers for Mongod/Mongos makes it not possible (Issue #842)
          • +
        • Included toError wrapper code moved to utils.js file (Issue #839, #840)
          • +
        • Rewrote cursor handling to avoid process.nextTick using trampoline instead to avoid stack overflow, speedup about 40%
          • +
        +
        +
        +

        1.2.8 2013-01-07

        +
          +
        • Accept function in a Map Reduce scope object not only a function string (Issue #826, https://github.com/aheckmann)
          • +
        • Typo in db.authenticate caused a check (for provided connection) to return false, causing a connection AND onAll=true to be passed into __executeQueryCommand downstream (Issue #831, https://github.com/m4tty)
          • +
        • Allow gridfs objects to use non ObjectID ids (Issue #825, https://github.com/nailgun)
          • +
        • Removed the double wrap, by not passing an Error object to the wrap function (Issue #832, https://github.com/m4tty)
          • +
        • Fix connection leak (gh-827) for HA replicaset health checks (Issue #833, https://github.com/aheckmann)
          • +
        • Modified findOne to use nextObject instead of toArray avoiding a nextTick operation (Issue #836)
          • +
        • Fixes for cursor stream to avoid multiple getmore issues when one in progress (Issue #818)
          • +
        • Fixes .open replaying all backed up commands correctly if called after operations performed, (Issue #829 and #823)
          • +
        +
        +
        +

        1.2.7 2012-12-23

        +
          +
        • Rolled back batches as they hang in certain situations
          • +
        • Fixes for NODE-25, keep reading from secondaries when primary goes down
          • +
        +
        +
        +

        1.2.6 2012-12-21

        + +
        +
        +

        1.2.5 2012-12-12

        +
          +
        • Fixed ssl regression, added more test coverage (Issue #800)
          • +
        • Added better error reporting to the Db.connect if no valid serverConfig setup found (Issue #798)
          • +
        +
        +
        +

        1.2.4 2012-12-11

        +
          +
        • Fix to ensure authentication is correctly applied across all secondaries when using MongoClient.
          • +
        +
        +
        +

        1.2.3 2012-12-10

        +
          +
        • Fix for new replicaset members correctly authenticating when being added (Issue #791, https://github.com/m4tty)
          • +
        • Fixed seek issue in gridstore when using stream (Issue #790)
          • +
        +
        +
        +

        1.2.2 2012-12-03

        +
          +
        • Fix for journal write concern not correctly being passed under some circumstances.
          • +
        • Fixed correct behavior and re-auth for servers that get stepped down (Issue #779).
          • +
        +
        +
        +

        1.2.1 2012-11-30

        +
          +
        • Fix for double callback on insert with w:0 specified (Issue #783)
          • +
        • Small cleanup of urlparser.
          • +
        +
        +
        +

        1.2.0 2012-11-27

        +
          +
        • Honor connectTimeoutMS option for replicasets (Issue #750, https://github.com/aheckmann)
          • +
        • Fix ping strategy regression (Issue #738, https://github.com/aheckmann)
          • +
        • Small cleanup of code (Issue #753, https://github.com/sokra/node-mongodb-native)
          • +
        • Fixed index declaration using objects/arrays from other contexts (Issue #755, https://github.com/sokra/node-mongodb-native)
          • +
        • Intermittent (and rare) null callback exception when using ReplicaSets (Issue #752)
          • +
        • Force correct setting of read_secondary based on the read preference (Issue #741)
          • +
        • If using read preferences with secondaries queries will not fail if primary is down (Issue #744)
          • +
        • noOpen connection for Db.connect removed as not compatible with autodetection of Mongo type
          • +
        • Mongos connection with auth not working (Issue #737)
          • +
        • Use the connect method directly from the require. require(‘mongodb’)(&quot;mongodb://localhost:27017/db&quot;)
          • +
        • new MongoClient introduced as the point of connecting to MongoDB’s instead of the Db +- open/close/db/connect methods implemented
          • +
        • Implemented common URL connection format using MongoClient.connect allowing for simialar interface across all drivers.
          • +
        • Fixed a bug with aggregation helper not properly accepting readPreference
          • +
        +
        +
        +

        1.1.11 2012-10-10

        +
          +
        • Removed strict mode and introduced normal handling of safe at DB level.
          • +
        +
        +
        +

        1.1.10 2012-10-08

        + +
        +
        +

        1.1.9 2012-10-05

        +
          +
        • Updated bson to 0.1.5 to fix build problem on sunos/windows.
          • +
        +
        +
        +

        1.1.8 2012-10-01

        +
          +
        • Fixed db.eval to correctly handle system.js global javascript functions (Issue #709)
          • +
        • Cleanup of non-closing connections (Issue #706)
          • +
        • More cleanup of connections under replicaset (Issue #707, https://github.com/elbert3)
          • +
        • Set keepalive on as default, override if not needed
          • +
        • Cleanup of jsbon install to correctly build without install.js script (https://github.com/shtylman)
          • +
        • Added domain socket support new Server(&quot;/tmp/mongodb.sock&quot;) style
          • +
        +
        +
        +

        1.1.7 2012-09-10

        +
          +
        • Protect against starting PingStrategy being called more than once (Issue #694, https://github.com/aheckmann)
          • +
        • Make PingStrategy interval configurable (was 1 second, relaxed to 5) (Issue #693, https://github.com/aheckmann)
          • +
        • Made PingStrategy api more consistant, callback to start/stop methods are optional (Issue #693, https://github.com/aheckmann)
          • +
        • Proper stopping of strategy on replicaset stop
          • +
        • Throw error when gridstore file is not found in read mode (Issue #702, https://github.com/jbrumwell)
          • +
        • Cursor stream resume now using nextTick to avoid duplicated records (Issue #696)
          • +
        +
        +
        +

        1.1.6 2012-09-01

        + +
        +
        +

        1.1.5 2012-08-29

        +
          +
        • Fix for eval on replicaset Issue #684
          • +
        • Use helpful error msg when native parser not compiled (Issue #685, https://github.com/aheckmann)
          • +
        • Arbiter connect hotfix (Issue #681, https://github.com/fengmk2)
          • +
        • Upgraded bson parser to 0.1.2 using gyp, deprecated support for node 0.4.X
          • +
        • Added name parameter to createIndex/ensureIndex to be able to override index names larger than 128 bytes
          • +
        • Added exhaust option for find for feature completion (not recommended for normal use)
          • +
        • Added tailableRetryInterval to find for tailable cursors to allow to control getMore retry time interval
          • +
        • Fixes for read preferences when using MongoS to correctly handle no read preference set when iterating over a cursor (Issue #686)
          • +
        +
        +
        +

        1.1.4 2012-08-12

        +
          +

        • Added Mongos connection type with a fallback list for mongos proxies, supports ha (on by default) and will attempt to reconnect to failed proxies.

          +
          • +

        • Documents can now have a toBSON method that lets the user control the serialization behavior for documents being saved.

          +
          • +

        • Gridstore instance object now works as a readstream or writestream (thanks to code from Aaron heckmann (https://github.com/aheckmann/gridfs-stream)).

          +
          • +

        • Fix gridfs readstream (Issue #607, https://github.com/tedeh).

          +
          • +

        • Added disableDriverBSONSizeCheck property to Server.js for people who wish to push the inserts to the limit (Issue #609).

          +
          • +

        • Fixed bug where collection.group keyf given as Code is processed as a regular object (Issue #608, https://github.com/rrusso2007).

          +
          • +

        • Case mismatch between driver’s ObjectID and mongo’s ObjectId, allow both (Issue #618).

          +
          • +

        • Cleanup map reduce (Issue #614, https://github.com/aheckmann).

          +
          • +

        • Add proper error handling to gridfs (Issue #615, https://github.com/aheckmann).

          +
          • +

        • Ensure cursor is using same connection for all operations to avoid potential jump of servers when using replicasets.

          +
          • +

        • Date identification handled correctly in bson js parser when running in vm context.

          +
          • +

        • Documentation updates

          +
          • +

        • GridStore filename not set on read (Issue #621)

          +
          • +

        • Optimizations on the C++ bson parser to fix a potential memory leak and avoid non-needed calls

          +
          • +

        • Added support for awaitdata for tailable cursors (Issue #624)

          +
          • +
        • +
          Implementing read preference setting at collection and cursor level
          +
            +
          • collection.find().setReadPreference(Server.SECONDARY_PREFERRED)
            • +
          • db.collection(&quot;some&quot;, {readPreference:Server.SECONDARY})
            • +
          +
          +
          +
          • +

        • Replicaset now returns when the master is discovered on db.open and lets the rest of the connections happen asynchronous. +- ReplSet/ReplSetServers emits &quot;fullsetup&quot; when all servers have been connected to

          +
          • +

        • Prevent callback from executing more than once in getMore function (Issue #631, https://github.com/shankar0306)

          +
          • +

        • Corrupt bson messages now errors out to all callbacks and closes up connections correctly, Issue #634

          +
          • +

        • Replica set member status update when primary changes bug (Issue #635, https://github.com/alinsilvian)

          +
          • +

        • Fixed auth to work better when multiple connections are involved.

          +
          • +

        • Default connection pool size increased to 5 connections.

          +
          • +

        • Fixes for the ReadStream class to work properly with 0.8 of Node.js

          +
          • +

        • Added explain function support to aggregation helper

          +
          • +

        • Added socketTimeoutMS and connectTimeoutMS to socket options for repl_set.js and server.js

          +
          • +

        • Fixed addUser to correctly handle changes in 2.2 for getLastError authentication required

          +
          • +

        • Added index to gridstore chunks on file_id (Issue #649, https://github.com/jacobbubu)

          +
          • +

        • Fixed Always emit db events (Issue #657)

          +
          • +

        • Close event not correctly resets DB openCalled variable to allow reconnect

          +
          • +

        • Added open event on connection established for replicaset, mongos and server

          +
          • +

        • Much faster BSON C++ parser thanks to Lucasfilm Singapore.

          +
          • +

        • Refactoring of replicaset connection logic to simplify the code.

          +
          • +

        • Add options.connectArbiter to decide connect arbiters or not (Issue #675)

          +
          • +

        • Minor optimization for findAndModify when not using j,w or fsync for safe

          +
          • +
        +
        +
        +

        1.0.2 2012-05-15

        +
          +
        • Reconnect functionality for replicaset fix for mongodb 2.0.5
          • +
        +
        +
        +

        1.0.1 2012-05-12

        +
          +
        • Passing back getLastError object as 3rd parameter on findAndModify command.
          • +
        • Fixed a bunch of performance regressions in objectId and cursor.
          • +
        • Fixed issue #600 allowing for single document delete to be passed in remove command.
          • +
        +
        +
        +

        1.0.0 2012-04-25

        +
          +
        • Fixes to handling of failover on server error
          • +
        • Only emits error messages if there are error listeners to avoid uncaught events
          • +
        • Server.isConnected using the server state variable not the connection pool state
          • +
        +
        +
        +

        0.9.9.8 2012-04-12

        +
          +
        • _id=0 is being turned into an ObjectID (Issue #551)
          • +
        • fix for error in GridStore write method (Issue #559)
          • +
        • Fix for reading a GridStore from arbitrary, non-chunk aligned offsets, added test (Issue #563, https://github.com/subroutine)
          • +
        • Modified limitRequest to allow negative limits to pass through to Mongo, added test (Issue #561)
          • +
        • Corrupt GridFS files when chunkSize &lt; fileSize, fixed concurrency issue (Issue #555)
          • +
        • Handle dead tailable cursors (Issue #568, https://github.com/aheckmann)
          • +
        • Connection pools handles closing themselves down and clearing the state
          • +
        • Check bson size of documents against maxBsonSize and throw client error instead of server error, (Issue #553)
          • +
        • Returning update status document at the end of the callback for updates, (Issue #569)
          • +
        • Refactor use of Arguments object to gain performance (Issue #574, https://github.com/AaronAsAChimp)
          • +
        +
        +
        +

        0.9.9.7 2012-03-16

        +
          +
        • Stats not returned from map reduce with inline results (Issue #542)
          • +
        • Re-enable testing of whether or not the callback is called in the multi-chunk seek, fix small GridStore bug (Issue #543, https://github.com/pgebheim)
          • +
        • Streaming large files from GridFS causes truncation (Issue #540)
          • +
        • Make callback type checks agnostic to V8 context boundaries (Issue #545)
          • +
        • Correctly throw error if an attempt is made to execute an insert/update/remove/createIndex/ensureIndex with safe enabled and no callback
          • +
        • Db.open throws if the application attemps to call open again without calling close first
          • +
        +
        +
        +

        0.9.9.6 2012-03-12

        +
          +
        • BSON parser is externalized in it’s own repository, currently using git master
          • +
        • Fixes for Replicaset connectivity issue (Issue #537)
          • +
        • Fixed issues with node 0.4.X vs 0.6.X (Issue #534)
          • +
        • Removed SimpleEmitter and replaced with standard EventEmitter
          • +
        • GridStore.seek fails to change chunks and call callback when in read mode (Issue #532)
          • +
        +
        +
        +

        0.9.9.5 2012-03-07

        + +
        +
        +

        0.9.9.4 2012-02-26

        +
          +
        • bugfix for findAndModify: Error: corrupt bson message &lt; 5 bytes long (Issue #519)
          • +
        +
        +
        +

        0.9.9.3 2012-02-23

        +
          +
        • document: save callback arguments are both undefined, (Issue #518)
          • +
        • Native BSON parser install error with npm, (Issue #517)
          • +
        +
        +
        +

        0.9.9.2 2012-02-17

        +
          +
        • Improved detection of Buffers using Buffer.isBuffer instead of instanceof.
          • +
        • Added wrap error around db.dropDatabase to catch all errors (Issue #512)
          • +
        • Added aggregate helper to collection, only for MongoDB &gt;= 2.1
          • +
        +
        +
        +

        0.9.9.1 2012-02-15

        +
          +
        • Better handling of safe when using some commands such as createIndex, ensureIndex, addUser, removeUser, createCollection.
          • +
        • Mapreduce now throws error if out parameter is not specified.
          • +
        +
        +
        +

        0.9.9 2012-02-13

        +
          +
        • Added createFromTime method on ObjectID to allow for queries against _id more easily using the timestamp.
          • +
        • Db.close(true) now makes connection unusable as it’s been force closed by app.
          • +
        • Fixed mapReduce and group functions to correctly send slaveOk on queries.
          • +
        • Fixes for find method to correctly work with find(query, fields, callback) (Issue #506).
          • +
        • A fix for connection error handling when using the SSL on MongoDB.
          • +
        +
        +
        +

        0.9.8-7 2012-02-06

        +
          +
        • Simplified findOne to use the find command instead of the custom code (Issue #498).
          • +
        • BSON JS parser not also checks for _bsonType variable in case BSON object is in weird scope (Issue #495).
          • +
        +
        +
        +

        0.9.8-6 2012-02-04

        +
          +
        • Removed the check for replicaset change code as it will never work with node.js.
          • +
        +
        +
        +

        0.9.8-5 2012-02-02

        +
          +
        • Added geoNear command to Collection.
          • +
        • Added geoHaystackSearch command to Collection.
          • +
        • Added indexes command to collection to retrieve the indexes on a Collection.
          • +
        • Added stats command to collection to retrieve the statistics on a Collection.
          • +
        • Added listDatabases command to admin object to allow retrieval of all available dbs.
          • +
        • Changed createCreateIndexCommand to work better with options.
          • +
        • Fixed dereference method on Db class to correctly dereference Db reference objects.
          • +
        • Moved connect object onto Db class(Db.connect) as well as keeping backward compatibility.
          • +
        • Removed writeBuffer method from gridstore, write handles switching automatically now.
          • +
        • Changed readBuffer to read on Gridstore, Gridstore now only supports Binary Buffers no Strings anymore.
          • +
        • Moved Long class to bson directory.
          • +
        +
        +
        +

        0.9.8-4 2012-01-28

        +
          +
        • Added reIndex command to collection and db level.
          • +
        • Added support for $returnKey, $maxScan, $min, $max, $showDiskLoc, $comment to cursor and find/findOne methods.
          • +
        • Added dropDups and v option to createIndex and ensureIndex.
          • +
        • Added isCapped method to Collection.
          • +
        • Added indexExists method to Collection.
          • +
        • Added findAndRemove method to Collection.
          • +
        • Fixed bug for replicaset connection when no active servers in the set.
          • +
        • Fixed bug for replicaset connections when errors occur during connection.
          • +
        • Merged in patch for BSON Number handling from Lee Salzman, did some small fixes and added test coverage.
          • +
        +
        +
        +

        0.9.8-3 2012-01-21

        +
          +
        • Workaround for issue with Object.defineProperty (Issue #484)
          • +
        • ObjectID generation with date does not set rest of fields to zero (Issue #482)
          • +
        +
        +
        +

        0.9.8-2 2012-01-20

        +
          +
        • Fixed a missing this in the ReplSetServers constructor.
          • +
        +
        +
        +

        0.9.8-1 2012-01-17

        +
          +
        • FindAndModify bug fix for duplicate errors (Issue #481)
          • +
        +
        +
        +

        0.9.8 2012-01-17

        +
          +
        • Replicasets now correctly adjusts to live changes in the replicaset configuration on the servers, reconnecting correctly. +- Set the interval for checking for changes setting the replicaSetCheckInterval property when creating the ReplSetServers instance or on db.serverConfig.replicaSetCheckInterval. (default 1000 miliseconds)
          • +
        • Fixes formattedOrderClause in collection.js to accept a plain hash as a parameter (Issue #469) https://github.com/tedeh
          • +
        • Removed duplicate code for formattedOrderClause and moved to utils module
          • +
        • Pass in poolSize for ReplSetServers to set default poolSize for new replicaset members
          • +
        • Bug fix for BSON JS deserializer. Isolating the eval functions in separate functions to avoid V8 deoptimizations
          • +
        • Correct handling of illegal BSON messages during deserialization
          • +
        • Fixed Infinite loop when reading GridFs file with no chunks (Issue #471)
          • +
        • Correctly update existing user password when using addUser (Issue #470)
          • +
        +
        +
        +

        0.9.7.3-5 2012-01-04

        +
          +
        • Fix for RegExp serialization for 0.4.X where typeof /regexp/ == ‘function’ vs in 0.6.X typeof /regexp/ == ‘object’
          • +
        • Don’t allow keepAlive and setNoDelay for 0.4.X as it throws errors
          • +
        +
        +
        +

        0.9.7.3-4 2012-01-04

        +
          +
        • Chased down potential memory leak on findAndModify, Issue #467 (node.js removeAllListeners leaves the key in the _events object, node.js bug on eventlistener?, leads to extremely slow memory leak on listener object)
          • +
        • Sanity checks for GridFS performance with benchmark added
          • +
        +
        +
        +

        0.9.7.3-3 2012-01-04

        +
          +
        • Bug fixes for performance issues going form 0.9.6.X to 0.9.7.X on linux
          • +
        • BSON bug fixes for performance
          • +
        +
        +
        +

        0.9.7.3-2 2012-01-02

        +
          +
        • Fixed up documentation to reflect the preferred way of instantiating bson types
          • +
        • GC bug fix for JS bson parser to avoid stop-and-go GC collection
          • +
        +
        +
        +

        0.9.7.3-1 2012-01-02

        +
          +
        • Fix to make db.bson_serializer and db.bson_deserializer work as it did previously
          • +
        +
        +
        +

        0.9.7.3 2011-12-30

        +
          +
        • Moved BSON_BINARY_SUBTYPE_DEFAULT from BSON object to Binary object and removed the BSON_BINARY_ prefixes
          • +
        • Removed Native BSON types, C++ parser uses JS types (faster due to cost of crossing the JS-C++ barrier for each call)
          • +
        • Added build fix for 0.4.X branch of Node.js where GetOwnPropertyNames is not defined in v8
          • +
        • Fix for wire protocol parser for corner situation where the message is larger than the maximum socket buffer in node.js (Issue #464, #461, #447)
          • +
        • Connection pool status set to connected on poolReady, isConnected returns false on anything but connected status (Issue #455)
          • +
        +
        +
        +

        0.9.7.2-5 2011-12-22

        + +
        +
        +

        0.9.7.2-4 2011-12-21

        +
          +
        • Refactoring of callback code to work around performance regression on linux
          • +
        • Fixed group function to correctly use the command mode as default
          • +
        +
        +
        +

        0.9.7.2-3 2011-12-18

        +
          +

        • Fixed error handling for findAndModify while still working for mongodb 1.8.6 (Issue #450).

          +
          • +
        • +
          Allow for force send query to primary, pass option (read:’primary’) on find command.
          +
            +
          • find({a:1}, {read:'primary'}).toArray(function(err, items) {});
            • +
          +
          +
          +
          • +
        +
        +
        +

        0.9.7.2-2 2011-12-16

        +
          +
        • Fixes infinite streamRecords QueryFailure fix when using Mongos (Issue #442)
          • +
        +
        +
        +

        0.9.7.2-1 2011-12-16

        +
          +
        • ~10% perf improvement for ObjectId#toHexString (Issue #448, https://github.com/aheckmann)
          • +
        • Only using process.nextTick on errors emitted on callbacks not on all parsing, reduces number of ticks in the driver
          • +
        • Changed parsing off bson messages to use process.nextTick to do bson parsing in batches if the message is over 10K as to yield more time to the event look increasing concurrency on big mongoreply messages with multiple documents
          • +
        +
        +
        +

        0.9.7.2 2011-12-15

        +
          +
        • +
          Added SSL support for future version of mongodb (VERY VERY EXPERIMENTAL)
          +
            +
          • pass in the ssl:true option to the server or replicaset server config to enable
            • +
          • a bug either in mongodb or node.js does not allow for more than 1 connection pr db instance (poolSize:1).
            • +
          +
          +
          +
          • +

        • Added getTimestamp() method to objectID that returns a date object

          +
          • +
        • +
          Added finalize function to collection.group
          +
            +
          • function group (keys, condition, initial, reduce, finalize, command, callback)
            • +
          +
          +
          +
          • +
        • +
          Reaper no longer using setTimeout to handle reaping. Triggering is done in the general flow leading to predictable behavior.
          +
            +
          • reaperInterval, set interval for reaper (default 10000 miliseconds)
            • +
          • reaperTimeout, set timeout for calls (default 30000 miliseconds)
            • +
          • reaper, enable/disable reaper (default false)
            • +
          +
          +
          +
          • +

        • Work around for issues with findAndModify during high concurrency load, insure that the behavior is the same across the 1.8.X branch and 2.X branch of MongoDb

          +
          • +

        • Reworked multiple db’s sharing same connection pool to behave correctly on error, timeout and close

          +
          • +

        • EnsureIndex command can be executed without a callback (Issue #438)

          +
          • +
        • +
          Eval function no accepts options including nolock (Issue #432)
          +
            +
          • eval(code, parameters, options, callback) (where options = {nolock:true})
            • +
          +
          +
          +
          • +
        +
        +
        +

        0.9.7.1-4 2011-11-27

        +
          +
        • Replaced install.sh with install.js to install correctly on all supported os’s
          • +
        +
        +
        +

        0.9.7.1-3 2011-11-27

        + +
        +
        +

        0.9.7.1-2 2011-11-27

        +
          +
        • Set statistical selection strategy as default for secondary choice.
          • +
        +
        +
        +

        0.9.7.1-1 2011-11-27

        +
          +
        • Better handling of single server reconnect (fixes some bugs)
          • +
        • Better test coverage of single server failure
          • +
        • Correct handling of callbacks on replicaset servers when firewall dropping packets, correct reconnect
          • +
        +
        +
        +

        0.9.7.1 2011-11-24

        +
          +

        • Better handling of dead server for single server instances

          +
          • +

        • FindOne and find treats selector == null as {}, Issue #403

          +
          • +
        • +
          Possible to pass in a strategy for the replicaset to pick secondary reader node
          +
            +
          • +
            parameter strategy
            +
              +
            • ping (default), pings the servers and picks the one with the lowest ping time
              • +
            • statistical, measures each request and pick the one with the lowest mean and std deviation
              • +
            +
            +
            +
            • +
          +
          +
          +
          • +
        • +
          Set replicaset read preference replicaset.setReadPreference()
          +
            +
          • Server.READ_PRIMARY (use primary server for reads)
            • +
          • Server.READ_SECONDARY (from a secondary server (uses the strategy set))
            • +
          • tags, {object of tags}
            • +
          +
          +
          +
          • +

        • Added replay of commands issued to a closed connection when the connection is re-established

          +
          • +

        • Fix isConnected and close on unopened connections. Issue #409, fix by (https://github.com/sethml)

          +
          • +

        • Moved reaper to db.open instead of constructor (Issue #406)

          +
          • +
        • +
          Allows passing through of socket connection settings to Server or ReplSetServer under the option socketOptions
          +
            +
          • timeout = set seconds before connection times out (default 0)
            • +
          • noDelay = Disables the Nagle algorithm (default true)
            • +
          • keepAlive = Set if keepAlive is used (default 0, which means no keepAlive, set higher than 0 for keepAlive)
            • +
          • encoding = [‘ascii’, ‘utf8’, or ‘base64’] (default null)
            • +
          +
          +
          +
          • +

        • Fixes for handling of errors during shutdown off a socket connection

          +
          • +

        • Correctly applies socket options including timeout

          +
          • +

        • Cleanup of test management code to close connections correctly

          +
          • +

        • Handle parser errors better, closing down the connection and emitting an error

          +
          • +

        • Correctly emit errors from server.js only wrapping errors that are strings

          +
          • +
        +
        +
        +

        0.9.7 2011-11-10

        +
          +

        • Added priority setting to replicaset manager

          +
          • +

        • Added correct handling of passive servers in replicaset

          +
          • +

        • Reworked socket code for simpler clearer handling

          +
          • +

        • Correct handling of connections in test helpers

          +
          • +
        • +
          Added control of retries on failure
          +
            +
          • control with parameters retryMiliSeconds and numberOfRetries when creating a db instance
            • +
          +
          +
          +
          • +
        • +
          Added reaper that will timeout and cleanup queries that never return
          +
            +
          • control with parameters reaperInterval and reaperTimeout when creating a db instance
            • +
          +
          +
          +
          • +

        • Refactored test helper classes for replicaset tests

          +
          • +
        • +
          Allows raw (no bson parser mode for insert, update, remove, find and findOne)
          +
            +
          • control raw mode passing in option raw:true on the commands
            • +
          • will return buffers with the binary bson objects
            • +
          +
          +
          +
          • +

        • Fixed memory leak in cursor.toArray

          +
          • +

        • Fixed bug in command creation for mongodb server with wrong scope of call

          +
          • +

        • Added db(dbName) method to db.js to allow for reuse of connections against other databases

          +
          • +
        • +
          Serialization of functions in an object is off by default, override with parameter
          +
            +
          • serializeFunctions [true/false] on db level, collection level or individual insert/update/findAndModify
            • +
          +
          +
          +
          • +

        • Added Long.fromString to c++ class and fixed minor bug in the code (Test case for $gt operator on 64-bit integers, Issue #394)

          +
          • +

        • FindOne and find now share same code execution and will work in the same manner, Issue #399

          +
          • +

        • Fix for tailable cursors, Issue #384

          +
          • +

        • Fix for Cursor rewind broken, Issue #389

          +
          • +

        • Allow Gridstore.exist to query using regexp, Issue #387, fix by (https://github.com/kaij)

          +
          • +

        • Updated documentation on https://github.com/christkv/node-mongodb-native

          +
          • +

        • Fixed toJSON methods across all objects for BSON, Binary return Base64 Encoded data

          +
          • +
        +
        +
        +

        0.9.6-22 2011-10-15

        +
          +
        • Fixed bug in js bson parser that could cause wrong object size on serialization, Issue #370
          • +
        • Fixed bug in findAndModify that did not throw error on replicaset timeout, Issue #373
          • +
        +
        +
        +

        0.9.6-21 2011-10-05

        +
          +
        • Reworked reconnect code to work correctly
          • +
        • Handling errors in different parts of the code to ensure that it does not lock the connection
          • +
        • Consistent error handling for Object.createFromHexString for JS and C++
          • +
        +
        +
        +

        0.9.6-20 2011-10-04

        +
          +

        • Reworked bson.js parser to get rid off Array.shift() due to it allocating new memory for each call. Speedup varies between 5-15% depending on doc

          +
          • +

        • Reworked bson.cc to throw error when trying to serialize js bson types

          +
          • +

        • Added MinKey, MaxKey and Double support for JS and C++ parser

          +
          • +

        • Reworked socket handling code to emit errors on unparsable messages

          +
          • +
        • +
          Added logger option for Db class, lets you pass in a function in the shape
          +
          +
          {
          +

          log : function(message, object) {}, +error : function(errorMessage, errorObject) {}, +debug : function(debugMessage, object) {},

          +
          +
          +

          }

          +
          +
          +

          Usage is new Db(new Server(..), {logger: loggerInstance})

          +
          • +
        +
        +
        +

        0.9.6-19 2011-09-29

        +
          +
        • Fixing compatibility issues between C++ bson parser and js parser
          • +
        • Added Symbol support to C++ parser
          • +
        • Fixed socket handling bug for seldom misaligned message from mongodb
          • +
        • Correctly handles serialization of functions using the C++ bson parser
          • +
        +
        +
        +

        0.9.6-18 2011-09-22

        +
          +
        • Fixed bug in waitForConnection that would lead to 100% cpu usage, Issue #352
          • +
        +
        +
        +

        0.9.6-17 2011-09-21

        +
          +
        • Fixed broken exception test causing bamboo to hang
          • +
        • Handling correctly command+lastError when both return results as in findAndModify, Issue #351
          • +
        +
        +
        +

        0.9.6-16 2011-09-14

        +
          +
        • Fixing a bunch of issues with compatibility with MongoDB 2.0.X branch. Some fairly big changes in behavior from 1.8.X to 2.0.X on the server.
          • +
        • Error Connection MongoDB V2.0.0 with Auth=true, Issue #348
          • +
        +
        +
        +

        0.9.6-15 2011-09-09

        +
          +
        • Fixed issue where pools would not be correctly cleaned up after an error, Issue #345
          • +
        • Fixed authentication issue with secondary servers in Replicaset, Issue #334
          • +
        • Duplicate replica-set servers when omitting port, Issue #341
          • +
        • Fixing findAndModify to correctly work with Replicasets ensuring proper error handling, Issue #336
          • +
        • Merged in code from (https://github.com/aheckmann) that checks for global variable leaks
          • +
        +
        +
        +

        0.9.6-14 2011-09-05

        +
          +
        • Minor fixes for error handling in cursor streaming (https://github.com/sethml), Issue #332
          • +
        • Minor doc fixes
          • +
        • Some more cursor sort tests added, Issue #333
          • +
        • Fixes to work with 0.5.X branch
          • +
        • Fix Db not removing reconnect listener from serverConfig, (https://github.com/sbrekken), Issue #337
          • +
        • Removed node_events.h includes (https://github.com/jannehietamaki), Issue #339
          • +
        • Implement correct safe/strict mode for findAndModify.
          • +
        +
        +
        +

        0.9.6-13 2011-08-24

        +
          +
        • Db names correctly error checked for illegal characters
          • +
        +
        +
        +

        0.9.6-12 2011-08-24

        +
          +
        • Nasty bug in GridFS if you changed the default chunk size
          • +
        • Fixed error handling bug in findOne
          • +
        +
        +
        +

        0.9.6-11 2011-08-23

        +
          +
        • Timeout option not correctly making it to the cursor, Issue #320, Fix from (https://github.com/year2013)
          • +
        • Fixes for memory leaks when using buffers and C++ parser
          • +
        • Fixes to make tests pass on 0.5.X
          • +
        • Cleanup of bson.js to remove duplicated code paths
          • +
        • Fix for errors occurring in ensureIndex, Issue #326
          • +
        • Removing require.paths to make tests work with the 0.5.X branch
          • +
        +
        +
        +

        0.9.6-10 2011-08-11

        +
          +
        • Specific type Double for capped collections (https://github.com/mbostock), Issue #312
          • +
        • Decorating Errors with all all object info from Mongo (https://github.com/laurie71), Issue #308
          • +
        • Implementing fixes for mongodb 1.9.1 and higher to make tests pass
          • +
        • Admin validateCollection now takes an options argument for you to pass in full option
          • +
        • Implemented keepGoing parameter for mongodb 1.9.1 or higher, Issue #310
          • +
        • Added test for read_secondary count issue, merged in fix from (https://github.com/year2013), Issue #317
          • +
        +
        +
        +

        0.9.6-9

        +
          +
        • Bug fix for bson parsing the key ‘’:’’ correctly without crashing
          • +
        +
        +
        +

        0.9.6-8

        +
          +
        • Changed to using node.js crypto library MD5 digest
          • +
        • Connect method support documented mongodb: syntax by (https://github.com/sethml)
          • +
        • Support Symbol type for BSON, serializes to it’s own type Symbol, Issue #302, #288
          • +
        • Code object without scope serializing to correct BSON type
          • +
        • Lot’s of fixes to avoid double callbacks (https://github.com/aheckmann) Issue #304
          • +
        • Long deserializes as Number for values in the range -2^53 to 2^53, Issue #305 (https://github.com/sethml)
          • +
        • Fixed C++ parser to reflect JS parser handling of long deserialization
          • +
        • Bson small optimizations
          • +
        +
        +
        +

        0.9.6-7 2011-07-13

        +
          +
        • JS Bson deserialization bug #287
          • +
        +
        +
        +

        0.9.6-6 2011-07-12

        +
          +
        • FindAndModify not returning error message as other methods Issue #277
          • +
        • Added test coverage for $push, $pushAll and $inc atomic operations
          • +
        • Correct Error handling for non 12/24 bit ids on Pure JS ObjectID class Issue #276
          • +
        • Fixed terrible deserialization bug in js bson code #285
          • +
        • Fix by andrewjstone to avoid throwing errors when this.primary not defined
          • +
        +
        +
        +

        0.9.6-5 2011-07-06

        +
          +
        • Rewritten BSON js parser now faster than the C parser on my core2duo laptop
          • +
        • Added option full to indexInformation to get all index info Issue #265
          • +
        • Passing in ObjectID for new Gridstore works correctly Issue #272
          • +
        +
        +
        +

        0.9.6-4 2011-07-01

        +
          +
        • Added test and bug fix for insert/update/remove without callback supplied
          • +
        +
        +
        +

        0.9.6-3 2011-07-01

        +
          +
        • Added simple grid class called Grid with put, get, delete methods
          • +
        • Fixed writeBuffer/readBuffer methods on GridStore so they work correctly
          • +
        • Automatic handling of buffers when using write method on GridStore
          • +
        • GridStore now accepts a ObjectID instead of file name for write and read methods
          • +
        • GridStore.list accepts id option to return of file ids instead of filenames
          • +
        • GridStore close method returns document for the file allowing user to reference _id field
          • +
        +
        +
        +

        0.9.6-2 2011-06-30

        +
          +
        • Fixes for reconnect logic for server object (replays auth correctly)
          • +
        • More testcases for auth
          • +
        • Fixes in error handling for replicaset
          • +
        • Fixed bug with safe parameter that would fail to execute safe when passing w or wtimeout
          • +
        • Fixed slaveOk bug for findOne method
          • +
        • Implemented auth support for replicaset and test cases
          • +
        • Fixed error when not passing in rs_name
          • +
        +
        +
        +

        0.9.6-1 2011-06-25

        +
          +
        • Fixes for test to run properly using c++ bson parser
          • +
        • Fixes for dbref in native parser (correctly handles ref without db component)
          • +
        • Connection fixes for replicasets to avoid runtime conditions in cygwin (https://github.com/vincentcr)
          • +
        • Fixes for timestamp in js bson parser (distinct timestamp type now)
          • +
        +
        +
        +

        0.9.6 2011-06-21

        + +
        +
        +

        0.9.5-1 2011-06-21

        +
          +
        • Extracted Timestamp as separate class for bson js parser to avoid instanceof problems
          • +
        • Fixed driver strict mode issue
          • +
        +
        +
        +

        0.9.5 2011-06-20

        +
          +
        • Replicaset support (failover and reading from secondary servers)
          • +
        • Removed ServerPair and ServerCluster
          • +
        • Added connection pool functionality
          • +
        • Fixed serious bug in C++ bson parser where bytes &gt; 127 would generate 2 byte sequences
          • +
        • Allows for forcing the server to assign ObjectID’s using the option {forceServerObjectId: true}
          • +
        +
        +
        +

        0.6.8

        +
          +
        • Removed multiple message concept from bson
          • +
        • Changed db.open(db) to be db.open(err, db)
          • +
        +
        +
        +

        0.1 2010-01-30

        +
          +
        • Initial release support of driver using native node.js interface
          • +
        • Supports gridfs specification
          • +
        • Supports admin functionality
          • +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/content/awesomeappsvideo.html b/content/awesomeappsvideo.html new file mode 100644 index 00000000000..aa790dec50a --- /dev/null +++ b/content/awesomeappsvideo.html @@ -0,0 +1,255 @@ + + + + + + + + + + Awesome Node.js + MongoDB Applications — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Awesome Node.js + MongoDB Applications

        +
        +

        Node.js blackboard - socket.io

        +

        Nodejs test using express, jade, stylus, socket.io and Mongodb +for persist the data +Source: http://github.com/gotik/nodejs-blackboard +http://node.kamikazepanda.com

        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/content/nodejsvideo.html b/content/nodejsvideo.html new file mode 100644 index 00000000000..f17cd0c11a1 --- /dev/null +++ b/content/nodejsvideo.html @@ -0,0 +1,375 @@ + + + + + + + + + + Node.JS Specific Presentations — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Node.JS Specific Presentations

        +
        +

        An Introduction to the node.js MongoDB Driver

        +

        Christian Kvalheim gives an introduction to the node.js MongoDB driver.

        +
        + + + + + + + + + + + + +
        +
        +

        Node.js and MongoDB, a Panel Discussion

        +

        Working with Node’s JavaScript means that MongoDB documents get their most natural representation - as JSON - right in the application layer. This session introduces the open source tools available for using MongoDB with Node.js through a panel discussion with the main contributors to these projects. Tom Hughes-Croucher, Node.js Chief Evangelist at Joyent, moderates the discussion. Towards the end, Tom field questions from the attendees.

        +
        + +
        +
        +

        Schemas for Real Time Analytics with Node.js

        +

        SimpleReach powers the Slide, a recommendation powered content discovery technology for websites. Eric Lublow will discuss how SimpleReach builds schemas in MongoDB and Node.js for powerful, real-time data delivery. Topics will include:

        +
          +
        • Dynamic collection creation
          • +
        • Updating (Increments over sets)
          • +
        • Schema
          • +
        • Next gen schemas for dynamic filters
          • +
        +
        + + + + + + + + + + + + +
        +
        +

        Happy Mongo-ing in Node.js

        +

        Node.js is JavaScript. MongoDB speaks JSON. So why bother with an in-between “ORM” layer like Mongoose? Join us for a look at the object modeling... tool designed and maintained by the team at LearnBoost. Recent updates have made Mongoose even more compelling. We’ll share the pros and cons we’ve experienced in using it day-to-day on our current project.

        +
        + + + + + + + + + + + + +
        +
        +

        NYC MongoDB User Group - Schemas for Real Time Analytics with Node.js

        +

        Schemas for Real Time Analytics with Node.js - Eric Lubow and Russell Bradberry, SimpleReach

        +

        SimpleReach powers the Slide, a recommendation powered content discovery technology for websites. Eric Lublow will discuss how SimpleReach builds schemas in MongoDB and Node.js for powerful, real-time data delivery. Topics will include:

        +
          +
        • Dynamic collection creation
          • +
        • Updating (Increments over sets)
          • +
        • Schema
          • +
        • Next gen schemas for dynamic filters
          • +
        +
        +
        +

        NYC MongoDB User Group - What’s in the Trello

        +

        What’s in the Trello - Brett Kiefer, Fog Creek

        +

        Trello is a collaboration tool that organizes your projects into boards. Brett Kiefer will discuss how Trello uses Node.js, Socket.io, MongoDB, Redis, and Backbone to create a responsive single-page app.

        +
        +
        +

        NYC Node JS Meetup - August 2011 - Mongoose & other MongoDB Connectors

        +

        Mongoose Meetup August 2011

        +
        + + + + + + + + + + + + + +
        +
        +

        A beautiful marriage: MongoDB and node.js

        +

        What does it take to handle a million requests a day with sub 400ms response times? Not much when you marry the appropriate technologies. Learn how Proxlet.com leverages MongoDB & NodeJS to serve over a million daily requests.... on a $10/month server. After briefly setting describing the product context, I will discuss why we chose NodeJS & MongoDB to form the backbone of Proxlet, how the technologies play-nice & poised for scale.

        +
        + +
        +
        +

        Rapid Realtime App Development with Node.JS & MongoDB

        +

        Jump on board to learn about combining two of the most exciting technologies to quickly build realtime apps yourself. This talk will introduce the popular Node.js library, Mongoose, which is a MongoDB “ORM” for Node.js. First, the speaker will deliver a quick primer on Node.js. Then, he’ll walk you through Mongoose’s schema api, powerful query builder, middleware capabilities, and exciting plugin ecosystem. Finally, he’ll demonstrate some realtime capabilities using Node.js and Mongoose.

        +
        + + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/content/tutorials.html b/content/tutorials.html new file mode 100644 index 00000000000..e1db418ac58 --- /dev/null +++ b/content/tutorials.html @@ -0,0 +1,274 @@ + + + + + + + + + + Tutorials using Node.JS and MongoDB — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Tutorials using Node.JS and MongoDB

        +
        +

        Node.js and MongoDB Tutorial - Using CoffeeScript and Mongoose (ODM)

        +

        This is a brief tutorial on how to use Node.js (using CoffeeScript) to connect to a MongoDB (using Mongoose) for a small project I am working on with a group of awesome students.

        + + + + + + + + + + + + + + + + + + + + + + +
        Part 1/6 of the tutorialPart 2/6 of the tutorial
        Part 3/6 of the tutorialPart 4/6 of the tutorial
        Part 5/6 of the tutorialPart 6/6 of the tutorial
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/contents.html b/contents.html new file mode 100644 index 00000000000..746d88db4ea --- /dev/null +++ b/contents.html @@ -0,0 +1,547 @@ + + + + + + + + + + Node.JS MongoDB Driver Manual Contents — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Node.JS MongoDB Driver Manual Contents

        +
        + +
        + +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + + +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/dev/benchmark/bson_benchmark.js b/dev/benchmark/bson_benchmark.js deleted file mode 100644 index 884f9ea724e..00000000000 --- a/dev/benchmark/bson_benchmark.js +++ /dev/null @@ -1,86 +0,0 @@ -var BSON = require('../lib/mongodb').BSONNative.BSON, - ObjectID = require('../lib/mongodb').BSONNative.ObjectID, - Code = require('../lib/mongodb').BSONNative.Code, - Long = require('../lib/mongodb').BSONNative.Long, - Binary = require('../lib/mongodb').BSONNative.Binary, - debug = require('util').debug, - inspect = require('util').inspect; - -// var BSON = require('../lib/mongodb').BSONPure.BSON, -// ObjectID = require('../lib/mongodb').BSONPure.ObjectID, -// Code = require('../lib/mongodb').BSONPure.Code, -// Long = require('../lib/mongodb').BSONPure.Long, -// Binary = require('../lib/mongodb').BSONPure.Binary; - -var COUNT = 1000; -var COUNT = 100; - -var object = { - string: "Strings are great", - decimal: 3.14159265, - bool: true, - integer: 5, - long: Long.fromNumber(100), - bin: new Binary(), - - subObject: { - moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", - longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin." - }, - - subArray: [1,2,3,4,5,6,7,8,9,10], - anotherString: "another string", - code: new Code("function() {}", {i:1}) -} - -// Number of objects -var numberOfObjects = 100; -// var numberOfObjects = 2; - -// Object serialized -objectBSON = BSON.serialize(object, null, true) - -// Buffer With copies of the objectBSON -var data = new Buffer(objectBSON.length * numberOfObjects); -var index = 0; - -// Copy the buffer 1000 times to create a strea m of objects -for(var i = 0; i < numberOfObjects; i++) { - // Copy data - objectBSON.copy(data, index); - // Adjust index - index = index + objectBSON.length; -} - -// console.log("-----------------------------------------------------------------------------------") -// console.dir(objectBSON) - -var x, start, end, j -var objectBSON, objectJSON - -// Allocate the return array (avoid concatinating everything) -var results = new Array(numberOfObjects); - -console.log(COUNT + "x (objectBSON = BSON.serialize(object))") -start = new Date - -// var objects = BSON.deserializeStream(data, 0, numberOfObjects); -// console.log("----------------------------------------------------------------------------------- 0") -// var objects = BSON.deserialize(data); -// console.log("----------------------------------------------------------------------------------- 1") -// console.dir(objects) - -for (j=COUNT; --j>=0; ) { - var nextIndex = BSON.deserializeStream(data, 0, numberOfObjects, results, 0); -} - -end = new Date -var opsprsecond = COUNT / ((end - start)/1000); -console.log("bson size (bytes): ", objectBSON.length); -console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); -console.log("MB/s = " + ((opsprsecond*objectBSON.length)/1024)); - -// console.dir(nextIndex) -// console.dir(results) - - diff --git a/dev/benchmark/bson_buffalo_benchmark.js b/dev/benchmark/bson_buffalo_benchmark.js deleted file mode 100644 index 43848b24a62..00000000000 --- a/dev/benchmark/bson_buffalo_benchmark.js +++ /dev/null @@ -1,299 +0,0 @@ -var BSON = require('/Users/christiankvalheim/coding/checkout/node-buffalo/buffalo') -var mongoNative = require('../lib/mongodb'), - assert = require('assert'), - Long = require('../lib/mongodb/bson/long').Long, - ObjectID = require('../lib/mongodb/bson/bson').ObjectID, - Binary = require('../lib/mongodb/bson/bson').Binary, - Code = require('../lib/mongodb/bson/bson').Code, - DBRef = require('../lib/mongodb/bson/bson').DBRef, - Symbol = require('../lib/mongodb/bson/bson').Symbol, - Double = require('../lib/mongodb/bson/bson').Double, - MaxKey = require('../lib/mongodb/bson/bson').MaxKey, - MinKey = require('../lib/mongodb/bson/bson').MinKey, - Timestamp = require('../lib/mongodb/bson/bson').Timestamp; - -var BSONPure = new mongoNative.BSONPure.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); -var BSONNative = new mongoNative.BSONNative.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); - -var COUNT = 100000 -// var COUNT = 20000 -// var COUNT = 10000 -// var COUNT = 1 - -// Function with scope -var function2 = function() {}; -function2.scope = {a:1}; - -// var COUNT = 1 -var object = { - string: "Strings are great", - decimal: 3.14159265, - 'undefined': undefined, - bool: true, - integer: 5, - regexp:/fdfdfd/, - // regexp:/fdfdfd/mig, - subObject: { - moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", - longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin.", - - subObject: { - moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", - longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin.", - }, - }, - date: new Date(), - code: function() {}, - function2: function2, - buffer:new Buffer('hello world'), - 'null': null, - subArray: [1,2,3,4,5,6,7,8,9,10], - anotherString: "another string" -} - -// var object2 = { -// string: "Strings are great", -// obj: { -// string2: "This is String 2", -// }, -// -// decimal: 3.14159265, -// 'undefined': undefined, -// bool: true, -// integer: 5, -// regexp:/fdfdfd/mig, -// regexp:/fdfdfd/, -// subObject: { -// moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", -// longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin.", -// -// subObject: { -// moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", -// longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin." -// } -// }, -// dbref: new DBRef('collection', new ObjectID(), 'db'), -// long: Long.fromNumber(1000), -// double: new Double(3.14), -// code1: new Code((function() {}).toString(), {a:1}), -// code: new Code((function() {}).toString()), -// minKey: new MinKey(), -// maxKey: new MaxKey(), -// objectId: new ObjectID(), -// binary: new Binary('hello world'), -// symbol: new Symbol('hello'), -// timestamp: Timestamp.fromNumber(1000), -// date: new Date(), -// function1: function() {}, -// function2: function2, -// buffer:new Buffer('hello world'), -// 'null': null, -// subArray: [1,2,3,4,5,6,7,8,9,10], -// anotherString: "another string" -// } -// -// var object2 = { -// cursorId: Long.fromString("3688496768165567218"), -// } - -// Serialize the object -var serializedDoc = BSONPure.serialize(object, null, true); - -// Read a test doc -// var bufferData = require('fs').readFileSync("/Users/christiankvalheim/coding/projects/node-mongodb-native/1325633340440_18.txt", 'ascii'); -// Serialized doc -// var serializedDoc = new Buffer(bufferData, 'hex'); - -// console.dir(serializedDoc) -// var index = 0; -// var binary_reply = serializedDoc; -// -// console.log("---------------------------------------------------------") -// while(index < serializedDoc.length) { -// // Read the size of the bson object -// var bsonObjectSize = binary_reply[index] | binary_reply[index + 1] << 8 | binary_reply[index + 2] << 16 | binary_reply[index + 3] << 24; -// // var d_doc = BSONNative.deserialize(binary_reply.slice(index, index + bsonObjectSize)); -// var d_doc = BSONPure.deserialize(binary_reply.slice(index, index + bsonObjectSize)); -// console.dir(d_doc); -// index = index + bsonObjectSize; -// } -// -// Deserialize the object -// var d_doc = BSONPure.deserialize2(serializedDoc, {evalFunctions:true, cacheFunctions:true}); -// var d_doc = BSONPure.deserialize(serializedDoc); -// var d_doc = BSONNative.deserialize(serializedDoc); -// -// console.log("---------------------------------------------------------") -// console.dir(d_doc); -// return - -// Warm up the method -for(var i = 0 ; i < COUNT; i++) { - BSONPure.deserialize(serializedDoc); - BSON.parse(serializedDoc); - BSONNative.deserialize(serializedDoc); -} - -// var object2 = { authenticate: 1, -// user: 'admin', -// nonce: '2e8e9e9533db3dae', -// key: 'e75fea840d9f52bab39903b011898b8f' } -// -// var object2 = {'name' : 'child', 'parent' : new DBRef("test_resave_dbref", new ObjectID())} -// -// var object2 = {'doc': {'doc2': new Code('this.a > i', {i:1})}}; -// // var object2 = {'doc2': new Code('this.a > i', {i:1})}; -// var object2 = {'doc': {'doc2': new Code('this.a > i', {})}}; -// -// var object3 = { -// // function2: new Code((function() {}).toString(), {a:1}), -// // function1: new Code((function() {}).toString()), -// } - -// // object2 = object; -// var x, start, end, i -// var serializedBSON, serializedBSONPure, serializedBSONNative, serializedJSON -// var deserializedBSON, deserializedBSONPure, deserializedBSONNative, deserializedJSON -// -// for (i=COUNT; --i>=0; ) { -// calculate1 = BSON.calculate(object) -// // calculate2 = BSONPure.calculateObjectSize(object2, true) -// calculate3 = BSONPure.calculateObjectSize2(object2, true) -// calculate4 = BSONNative.calculateObjectSize(object2) -// } -// -// start = new Date -// for (i=COUNT; --i>=0; ) { -// calculate1 = BSON.calculate(object) -// } -// end = new Date -// console.log(COUNT + "x buffalo.calculate(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// -// start = new Date -// for (i=COUNT; --i>=0; ) { -// calculate2 = BSONPure.calculateObjectSize2(object, true) -// } -// end = new Date -// console.log(COUNT + "x BSONPure.calculateObjectSize(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// -// -// start = new Date -// for (i=COUNT; --i>=0; ) { -// calculate3 = BSONPure.calculateObjectSize2(object2) -// } -// end = new Date -// console.log(COUNT + "x BSONPure.calculateObjectSize2(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// -// -// console.log("==================================================================") -// console.dir("BSON.calculate :: " + calculate1) -// // console.dir("BSONPure.calculateObjectSize :: " + calculate2) -// console.dir("BSONPure.calculateObjectSize2 :: " + calculate3) -// console.dir("BSONNative.calculateObjectSize :: " + calculate4) - -// console.log("========================================================== serialize") -// console.log("BSON.serialize :: ") -// console.dir(BSON.serialize(object).toString('hex')) -// console.log("BSONPure.serialize2 :: ") -// console.dir(BSONPure.serialize2(object2, null, true).toString('hex')) -// console.dir(BSONPure.serialize2(object2, null, true).toString('ascii')) -// console.log("BSONPure.serialize :: ") -// console.dir(BSONPure.serialize(object, null, true).toString('hex')) -// console.log("BSONNative.serialize :: ") -// console.dir(BSONNative.serialize(object2, null, true).toString('hex')) -// console.dir(BSONNative.serialize(object2, null, true).toString('ascii')) - -// // Serialize -// var a = BSONPure.serialize(object2, null, true); -// var b = BSONNative.serialize(object2, null, true); -// -// console.log("==================================== check") -// for(var i = 0; i < b.length; i++) { -// console.log("[" + a[i] + "] = [" + b[i] + "] :: " + (a[i] === b[i] ? 'true' : "FALSE FALSE FALSE")); -// } -// -// assert.equal(BSONNative.serialize(object2, null, true).toString('hex'), -// BSONPure.serialize2(object2, null, true).toString('hex')) -// -// -// start = new Date -// for (i=COUNT; --i>=0; ) { -// serializedBSON = BSON.serialize(object) -// } -// end = new Date -// console.log(COUNT + "x buffalo.serialize(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// -// start = new Date -// for (i=COUNT; --i>=0; ) { -// serializedBSONPure = BSONPure.serialize2(object, null, true) -// } -// end = new Date -// console.log(COUNT + "x mongodb.BSONPure.serialize2(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -// start = new Date -// for (i=COUNT; --i>=0; ) { -// serializedBSONPure = BSONPure.serialize(object, null, true) -// } -// end = new Date -// console.log(COUNT + "x mongodb.BSONPure.serialize(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// -// if (BSONNative) { -// start = new Date -// for (i=COUNT; --i>=0; ) { -// serializedBSONNative = BSONNative.serialize(object, null, true) -// } -// end = new Date -// console.log(COUNT + "x mongodb.BSONNative.serialize(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// } -// -// start = new Date -// for (i=COUNT; --i>=0; ) { -// serializedJSON = JSON.stringify(object) -// } -// end = new Date -// console.log(COUNT + "x JSON.stringify(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -// start = new Date -// for (i=COUNT; --i>=0; ) { -// deserializedBSONPure = BSONPure.deserialize2(serializedDoc) -// } -// end = new Date -// console.log(COUNT + "x mongodb.BSONPure.deserialize2(buffer) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -start = new Date -for (i=COUNT; --i>=0; ) { - deserializedBSON = BSON.parse(serializedDoc) -} -end = new Date -console.log(COUNT + "x buffalo.parse(buffer) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -if (BSONNative) { - start = new Date - for (i=COUNT; --i>=0; ) { - deserializedBSONNative = BSONNative.deserialize(serializedDoc) - } - end = new Date - console.log(COUNT + "x mongodb.BSONNative.deserialize(buffer) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -} - -start = new Date -for (i=COUNT; --i>=0; ) { - deserializedBSONPure = BSONPure.deserialize(serializedDoc) -} -end = new Date -console.log(COUNT + "x mongodb.BSONPure.deserialize(buffer) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -console.log("---------------------------------------------------------") -console.dir(deserializedBSON) -console.dir(deserializedBSONNative) -console.dir(deserializedBSONPure) - -function compare(b1, b2) { - try { - require('assert').deepEqual(b1,b2) - return true - } catch (e) { - console.error(e) - return false - } -} diff --git a/dev/benchmark/bson_native_benchmark.js b/dev/benchmark/bson_native_benchmark.js deleted file mode 100644 index 09d6afd894f..00000000000 --- a/dev/benchmark/bson_native_benchmark.js +++ /dev/null @@ -1,112 +0,0 @@ -var BSON = require('/Users/christiankvalheim/coding/checkout/node-buffalo/buffalo') -var mongoNative = require('../lib/mongodb'), - assert = require('assert'), - Long = require('../lib/mongodb/bson/long').Long, - ObjectID = require('../lib/mongodb/bson/bson').ObjectID, - Binary = require('../lib/mongodb/bson/bson').Binary, - Code = require('../lib/mongodb/bson/bson').Code, - DBRef = require('../lib/mongodb/bson/bson').DBRef, - Symbol = require('../lib/mongodb/bson/bson').Symbol, - Double = require('../lib/mongodb/bson/bson').Double, - MaxKey = require('../lib/mongodb/bson/bson').MaxKey, - MinKey = require('../lib/mongodb/bson/bson').MinKey, - Timestamp = require('../lib/mongodb/bson/bson').Timestamp; - -var BSONPure = new mongoNative.BSONPure.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); -var BSONNative = new mongoNative.BSONNative.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); - -var COUNT = 500000 -// var COUNT = 100000 -// var COUNT = 20000 -// var COUNT = 10000 -// var COUNT = 1 - -// Function with scope -var function2 = function() {}; -function2.scope = {a:1}; - -var object = { - string: "Strings are great", - // obj: { - // string2: "This is String 2", - // }, - // - // decimal: 3.14159265, - // 'undefined': undefined, - // bool: true, - // integer: 5, - // regexp:/fdfdfd/mig, - // regexp:/fdfdfd/, - // subObject: { - // moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", - // longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin.", - // - // subObject: { - // moreText: "Bacon ipsum dolor sit amet cow pork belly rump ribeye pastrami andouille. Tail hamburger pork belly, drumstick flank salami t-bone sirloin pork chop ribeye ham chuck pork loin shankle. Ham fatback pork swine, sirloin shankle short loin andouille shank sausage meatloaf drumstick. Pig chicken cow bresaola, pork loin jerky meatball tenderloin brisket strip steak jowl spare ribs. Biltong sirloin pork belly boudin, bacon pastrami rump chicken. Jowl rump fatback, biltong bacon t-bone turkey. Turkey pork loin boudin, tenderloin jerky beef ribs pastrami spare ribs biltong pork chop beef.", - // longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly boudin shoulder ribeye pork chop brisket biltong short ribs. Salami beef pork belly, t-bone sirloin meatloaf tail jowl spare ribs. Sirloin biltong bresaola cow turkey. Biltong fatback meatball, bresaola tail shankle turkey pancetta ham ribeye flank bacon jerky pork chop. Boudin sirloin shoulder, salami swine flank jerky t-bone pork chop pork beef tongue. Bresaola ribeye jerky andouille. Ribeye ground round sausage biltong beef ribs chuck, shank hamburger chicken short ribs spare ribs tenderloin meatloaf pork loin." - // } - // }, - // dbref: new DBRef('collection', new ObjectID(), 'db'), - // long: Long.fromNumber(1000), - // double: new Double(3.14), - // code1: new Code((function() {}).toString(), {a:1}), - // code: new Code((function() {}).toString()), - // minKey: new MinKey(), - // maxKey: new MaxKey(), - // objectId: new ObjectID(), - // binary: new Binary('hello world'), - // symbol: new Symbol('hello'), - // timestamp: Timestamp.fromNumber(1000), - // date: new Date(), - // function1: function() {}, - // function2: function2, - // buffer:new Buffer('hello world'), - // 'null': null, - // subArray: [1,2,3,4,5,6,7,8,9,10], - // anotherString: "another string" -} - -var start = new Date -for (i=COUNT; --i>=0; ) { - // calculate1 = BSONPure.calculateObjectSize(object, true); - serialize1 = BSONPure.serialize(object, null, true) -} -var end = new Date -console.log(COUNT + "x BSONPure.calculateObjectSize(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -start = new Date -for (i=COUNT; --i>=0; ) { - // calculate2 = BSONNative.calculateObjectSize(object, true); - serialize2 = BSONNative.serialize(object, null, true) -} -end = new Date -console.log(COUNT + "x BSONNative.calculateObjectSize(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - - -start = new Date -for (i=COUNT; --i>=0; ) { - // calculate3 = BSONNative.calculateObjectSize2(object) - serialize3 = BSONNative.serialize2(object, null, true) -} -end = new Date -console.log(COUNT + "x BSONNative.calculateObjectSize2(object) time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - -// console.log("----------------------------------------------------------------------- size"); -// console.log("calculate1 = " + calculate1); -// console.log("calculate2 = " + calculate2); -// console.log("calculate3 = " + calculate3); - -console.log("----------------------------------------------------------------------- serialize"); -console.log(serialize1.toString('hex')) -console.log(serialize2.toString('hex')) -console.log(serialize3.toString('hex')) - -function compare(b1, b2) { - try { - require('assert').deepEqual(b1,b2) - return true - } catch (e) { - console.error(e) - return false - } -} diff --git a/dev/benchmark/emit_benchmark.js b/dev/benchmark/emit_benchmark.js deleted file mode 100644 index aa365dee089..00000000000 --- a/dev/benchmark/emit_benchmark.js +++ /dev/null @@ -1,49 +0,0 @@ -var debug = require('util').debug, - inspect = require('util').inspect, - inherits = require('util').inherits, - net = require('net'), - EventEmitter = require("events").EventEmitter; - -var COUNT = 1000000; - -var Emitter = function() { -} - -inherits(Emitter, EventEmitter); - -Emitter.prototype.start = function() { - for(var i = 0; i < COUNT; i++) { - this.emit("data", "============================================== data") - } -} - -Emitter.prototype.start2 = function(callback) { - for(var i = 0; i < COUNT; i++) { - callback(null, "============================================== data") - } -} - -// Create test object -var emitObj = new Emitter(); -emitObj.on("data", function(data) { -}) - -console.log(COUNT + "x (objectBSON = BSON.serialize(object))") -start = new Date - -emitObj.start(); - -end = new Date -console.log("time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - - -console.log(COUNT + "x (objectBSON = BSON.serialize(object))") -start = new Date - -emitObj.start2(function(err, data) { - // debug(data) -}); - -end = new Date -console.log("time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") - diff --git a/dev/benchmark/grid_fs_write_benchmark.js b/dev/benchmark/grid_fs_write_benchmark.js deleted file mode 100644 index ae454f2b98f..00000000000 --- a/dev/benchmark/grid_fs_write_benchmark.js +++ /dev/null @@ -1,25 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Server = require('../lib/mongodb').Server, - ObjectID = require('../lib/mongodb').ObjectID, - GridStore = require('../lib/mongodb').GridStore; - -var simulated_buffer = new Buffer(1024*1000*10).toString(); - -new Db('grid_fs_write_benchmark', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {}).open(function(err, new_client) { - new_client.dropDatabase(function(err, result) { - new_client.close(); - - for(var i = 0; i < 1; i++) { - new Db('grid_fs_write_benchmark', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {}).open(function(err, client) { - var gridStore = new GridStore(client, "foobar" + i, "w"); - gridStore.open(function(err, gridStore) { - gridStore.write(simulated_buffer.toString(), function(err, gridStore) { - gridStore.close(function(err, result) { - client.close(); - }); - }); - }); - }); - } - }) -}); diff --git a/dev/benchmark/gridfs_benchmark.js b/dev/benchmark/gridfs_benchmark.js deleted file mode 100644 index 23d7aa56782..00000000000 --- a/dev/benchmark/gridfs_benchmark.js +++ /dev/null @@ -1,104 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Server = require('../lib/mongodb').Server, - ObjectID = require('../lib/mongodb').ObjectID, - GridStore = require('../lib/mongodb').GridStore; - -var Mongolian = require('mongolian'); -var COUNT = 1000; -var currentWritingIndex = 0; -var server = new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize:1, native_parser:true}); - -// Read in the test file -var fileData = require('fs').readFileSync("./test/gridstore/iya_logo_final_bw.jpg"); - -// ------------------------------------------------------------------------------ -// TEST MONGODB NATIVE -// ------------------------------------------------------------------------------ -// Open a db for the file -new Db('gridfs_benchmark', server, {}).open(function(err, new_client) { - new_client.dropDatabase(function(err, result) { - new_client.close(); - - new Db('gridfs_benchmark', server, {}).open(function(err, client) { - // Start Time - var startTime = new Date().getTime(); - - // Iterate COUNT times writing file to gridfs - for(var i = 0; i < COUNT; i++) { - var gridStore = new GridStore(client, "foobar" + i, "w"); - gridStore.open(function(err, gridStore) { - gridStore.writeBuffer(fileData, true, function(err, gridStore) { - // Update current write index - currentWritingIndex = currentWritingIndex + 1; - - // finish up - if(currentWritingIndex >= COUNT) { - // Start Time - var endTime = new Date().getTime(); - var totalTime = (endTime - startTime); - var msPerOperation = totalTime/COUNT; - var operationsPrSecond = 1000/msPerOperation; - var bytesPrSecond = Math.floor(fileData.length * operationsPrSecond); - var mbsPrSecond = (bytesPrSecond/1024)/1024 ; - - console.log("-------------------------------------------------- DONE NATIVE") - console.log("total time ms :: " + totalTime); - console.log("ms pr operation :: " + msPerOperation); - console.log("operations pr second :: " + operationsPrSecond); - console.log("bytes pr second :: " + bytesPrSecond); - console.log("MB pr second :: " + mbsPrSecond); - // Close db - client.close(); - // Execute mongolian test - executeMongolianTest(); - } - }) - }); - } - }); - }) -}); - -// ------------------------------------------------------------------------------ -// TEST MONGODB NATIVE -// ------------------------------------------------------------------------------ -var executeMongolianTest = function() { - var db = new Mongolian('mongo://localhost/mongolian_test', { log:false }) - var gridfs = db.gridfs('testfs') - - // Number of executed operations - var currentWritingIndexM = 0; - // Start Time - var startTime = new Date().getTime(); - - // Execute Mongolian Count times writing data - for(var i = 0; i < COUNT; i++) { - var stream = gridfs.create('foo' + i).writeStream(); - stream.on('close', function() { - currentWritingIndexM = currentWritingIndexM + 1; - - if(currentWritingIndexM >= COUNT) { - // Start Time - var endTime = new Date().getTime(); - var totalTime = (endTime - startTime); - var msPerOperation = totalTime/COUNT; - var operationsPrSecond = 1000/msPerOperation; - var bytesPrSecond = Math.floor(fileData.length * operationsPrSecond); - var mbsPrSecond = (bytesPrSecond/1024)/1024 ; - - console.log("-------------------------------------------------- DONE MONGOLIAN") - console.log("total time ms :: " + totalTime); - console.log("ms pr operation :: " + msPerOperation); - console.log("operations pr second :: " + operationsPrSecond); - console.log("bytes pr second :: " + bytesPrSecond); - console.log("MB pr second :: " + mbsPrSecond); - - // Close connection - db.server.close() - } - }); - - // Write file - stream.end(fileData); - } -} diff --git a/dev/benchmark/hammer.js b/dev/benchmark/hammer.js deleted file mode 100644 index fa8d5336c7f..00000000000 --- a/dev/benchmark/hammer.js +++ /dev/null @@ -1,143 +0,0 @@ -var BSON = require('../../lib/mongodb').BSONNative.BSON, - ObjectID = require('../../lib/mongodb').BSONNative.ObjectID, - Code = require('../../lib/mongodb').BSONNative.Code, - debug = require('util').debug, - inspect = require('util').inspect, - mongodb = require('../../lib/mongodb'), - Db = mongodb.Db, - Server = mongodb.Server, - Step = require("../../deps/step/lib/step"); - -var BSON = require('../../lib/mongodb').BSONPure.BSON, - ObjectID = require('../../lib/mongodb').BSONPure.ObjectID; - -// Open the db connection -new Db('hammer_db', new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 1}), {native_parser: false}).open(function(err, db) { - db.dropCollection('hammer_collection', function(err, result) { - db.admin().authenticate('admin', 'admin', function(err, result) { - var i = 0; - // Fire random command - setInterval(function() { - var command = Math.round(Math.random() * 4); - // command = 1; - - // debug("================= execute :: " + i++ + " = " + command) - - // Execute the command - if(command == 1) { - // Execute an insert - db.collection('hammer_collection', function(err, collection) { - collection.insert(randomDoc(), {safe:false}, function(err, result) { - debug("---------------------------------------- INSERT") - }); - }); - } else if(command == 2) { - // Update some random record - db.collection('hammer_collection', function(err, collection) { - collection.findOne({}, function(err, item) { - if(!err && item != null) { - // Grab key before we bork it - var _id = item._id; - var keys = Object.keys(item); - var objLength = keys.length; - var pickRandomItem = Math.round(Math.random() * objLength); - // Show a random doc in - item[keys[pickRandomItem]] = randomDoc(); - // Update doc - collection.update({'_id':_id}, item, {safe:false}, function(err, result) { - debug("---------------------------------------- UPDATE") - }); - } - }) - }); - } else if(command == 3) { - // Update some random record - db.collection('hammer_collection', function(err, collection) { - collection.findOne({}, function(err, item) { - if(!err && item != null) { - // Update doc - collection.remove({'_id':item._id}, {safe:false}, function(err, result) { - debug("---------------------------------------- REMOVE") - }); - } - }) - }); - } else if(command == 4) { - db.collection('hammer_collection', function(err, collection) { - collection.find().limit(100).toArray(function(err, items) { - debug("---------------------------------------- QUERY :: " + items.length) - }) - }) - } - }, 0); - }) - }); -}); - -// -// Create a random document -var randomDoc = function() { - var numberOfElements = Math.round(Math.random() * 100); - var object = {}; - - for(var i = 0; i< numberOfElements; i++) { - // Pick an element and add it - var element = Math.round(Math.random() * 4); - var name = randomName(); - - if(element == 1) { - object[name] = randomString(); - } else if(element == 2) { - object[name] = Math.round(Math.random() * 4294967295); - } else if(element == 3) { - object[name] = Math.round(Math.random() * -4294967295); - } else if(element == 4) { - - } - } - - return object; -} - -// -// Create a random name -var randomName = function() { - var numberOfElements = Math.round(Math.random() * 250); - var buffer = new Buffer(numberOfElements); - - for(var i = 0; i< numberOfElements; i++) { - buffer[i] = 97 + Math.round(Math.random() * (122-97)); - } - - return buffer.toString(); -} - -// -// Create a random string -var randomString = function() { - var numberOfElements = Math.round(Math.random() * 250); - var buffer = new Buffer(numberOfElements); - - for(var i = 0; i< numberOfElements; i++) { - buffer[i] = Math.round(Math.random() * 255); - } - - return buffer.toString(); -} - - - - - - - - - - - - - - - - - diff --git a/dev/benchmark/hammer_replicaset.js b/dev/benchmark/hammer_replicaset.js deleted file mode 100644 index fc2d038e2f5..00000000000 --- a/dev/benchmark/hammer_replicaset.js +++ /dev/null @@ -1,197 +0,0 @@ -var BSON = require('../../lib/mongodb').BSONNative.BSON, - ObjectID = require('../../lib/mongodb').BSONNative.ObjectID, - Code = require('../../lib/mongodb').BSONNative.Code, - debug = require('util').debug, - inspect = require('util').inspect, - mongodb = require('../../lib/mongodb'), - Db = mongodb.Db, - Server = mongodb.Server, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager, - Step = require("../../deps/step/lib/step"); - -var BSON = require('../../lib/mongodb').BSONPure.BSON, - ObjectID = require('../../lib/mongodb').BSONPure.ObjectID; - -var db = null; -var poolSize = 1; -var RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); -RS.startSet(true, function(err, result) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true, poolSize: poolSize } ), - // new Server( RS.host, RS.ports[0], { auto_reconnect: true, poolSize: poolSize } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true, poolSize: poolSize } ) - ], - {rs_name:RS.name, readPreference:Server.READ_SECONDARY, poolSize: poolSize} - ); - - // Open the db connection - new Db('hammer_db', replSet, {native_parser: false, retryMiliSeconds: 1000}).open(function(err, p_db) { - db = p_db; - if(err != null) throw err; - // Start hammering - hammerTime(); - }); -}); - -// Hammer the set -var hammerTime = function() { - db.dropCollection('hammer_collection', function(err, result) { - var i = 0; - // Fire random command - setInterval(function() { - var command = Math.round(Math.random() * 4); - // command = 2; - - debug("================= execute :: " + i++ + " = " + command) - - // Execute the command - if(command == 1) { - // Execute an insert - db.collection('hammer_collection', function(err, collection) { - collection.insert(randomDoc(), {safe:false}, function(err, result) { - debug("---------------------------------------- INSERT ") - debug(inspect(err)) - }); - }); - } else if(command == 2) { - // Update some random record - db.collection('hammer_collection', function(err, collection) { - // console.log("================================================================== update :: 0") - if(err != null) { - console.log("------------------------------------- error update 1") - console.dir(err) - } - - collection.findOne({}, function(err, item) { - if(err == null && item != null) { - // console.log("================================================================== update :: 1") - // Grab key before we bork it - var _id = item._id; - var keys = Object.keys(item); - var objLength = keys.length; - var pickRandomItem = Math.round(Math.random() * objLength); - // Show a random doc in - item[keys[pickRandomItem]] = randomDoc(); - // Update doc - collection.update({'_id':_id}, item, {safe:false}, function(err, result) { - debug("---------------------------------------- UPDATE") - }); - } else { - console.log("------------------------------------- error update 2") - console.dir(err) - } - }) - }); - } else if(command == 3) { - // Update some random record - db.collection('hammer_collection', function(err, collection) { - // if(err != null) { - // console.log("------------------------------------- error remove 1") - // console.dir(err) - // } - - collection.findOne({}, function(err, item) { - // debug(inspect(err)) - // debug(inspect(item)) - - if(err == null && item != null) { - // Update doc - collection.remove({'_id':item._id}, {safe:false}, function(err, result) { - debug("---------------------------------------- REMOVE") - }); - } else { - // console.log("------------------------------------- error remove 2") - // console.dir(err) - } - }) - }); - } else if(command == 4) { - db.collection('hammer_collection', function(err, collection) { - // if(err != null) { - // console.log("------------------------------------- error query 1") - // console.dir(err) - // } - - collection.find().limit(100).toArray(function(err, items) { - if(err != null) { - console.log("------------------------------------- error query 2") - console.dir(err) - } else { - debug("---------------------------------------- QUERY :: " + items.length) - } - }) - }) - } - }, 100); - }); -} - -// -// Create a random document -var randomDoc = function() { - var numberOfElements = Math.round(Math.random() * 100); - var object = {}; - - for(var i = 0; i< numberOfElements; i++) { - // Pick an element and add it - var element = Math.round(Math.random() * 4); - var name = randomName(); - - if(element == 1) { - object[name] = randomString(); - } else if(element == 2) { - object[name] = Math.round(Math.random() * 4294967295); - } else if(element == 3) { - object[name] = Math.round(Math.random() * -4294967295); - } else if(element == 4) { - - } - } - - return object; -} - -// -// Create a random name -var randomName = function() { - var numberOfElements = Math.round(Math.random() * 250); - var buffer = new Buffer(numberOfElements); - - for(var i = 0; i< numberOfElements; i++) { - buffer[i] = 97 + Math.round(Math.random() * (122-97)); - } - - return buffer.toString(); -} - -// -// Create a random string -var randomString = function() { - var numberOfElements = Math.round(Math.random() * 250); - var buffer = new Buffer(numberOfElements); - - for(var i = 0; i< numberOfElements; i++) { - buffer[i] = Math.round(Math.random() * 255); - } - - return buffer.toString(); -} - - - - - - - - - - - - - - - - - diff --git a/dev/benchmark/streaming_benchmark.js b/dev/benchmark/streaming_benchmark.js deleted file mode 100644 index 44014da40b3..00000000000 --- a/dev/benchmark/streaming_benchmark.js +++ /dev/null @@ -1,43 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Server = require('../lib/mongodb').Server, - Cursor = require('../lib/mongodb').Cursor, - Collection = require('../lib/mongodb').Collection, - sys = require('util'), - debug = require('util').debug, - inspect = require('util').inspect; - -var parser = require('../lib/mongodb').BSONPure; -var objectID = require('../lib/mongodb').ObjectID; - -var db = new Db('streaming_benchmark', new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize:4}), {}) -// Open the db -db.open(function(err, client) { - client.collection('streaming_benchmark', function(err, collection) { - collection.remove({}, function(err, result) { - // Benchmark - var started_at = new Date().getTime(); - // Add documents - for(var i = 0; i < 100000; i++) { - // for(var i = 0; i < 10000; i++) { - collection.save({'i':i, 'a':i, 'c':i, 'd':{'i':i}}, function(err, result){}); - } - sys.puts("save recs: " + ((new Date().getTime() - started_at)/1000) + "seconds"); - - // Benchmark - var started_at = new Date().getTime(); - var count = 0; - collection.find(function(err, cursor) { - var stream = cursor.streamRecords(function(er,item) {}); - stream.addListener('end', function() { - client.close(); - }); - stream.addListener('data',function(data){ - if(count == 0) started_at = new Date().getTime(); - count++; - if ((count%10000)==0) sys.puts("recs:" + count + " :: " + - ((new Date().getTime() - started_at)/10000) + "seconds"); - }); - }); - }) - }) -}); \ No newline at end of file diff --git a/dev/harness/memory_leak_harness.js b/dev/harness/memory_leak_harness.js deleted file mode 100644 index e61ba73464d..00000000000 --- a/dev/harness/memory_leak_harness.js +++ /dev/null @@ -1,46 +0,0 @@ -var http = require('http'), - Server = require('../lib/mongodb').Server, - ObjectID = require('../lib/mongodb').ObjectID, - Db = require('../lib/mongodb').Db; - -// Set up the mongodb instance -var db = new Db('memory_leak_harness', new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4}), {native_parser:false}); - -// Set up http server -var server = http.createServer(); -server.on('request', function(request, response) { - // Fetch the url - var url = request.url; - - // Switch on the url - if(url === "/findAndModify") { - findAndModifyCommand(request, response); - } else { - response.end('Command not supported'); - } -}) - -// Open the db connection -db.open(function(err, db) { - server.listen(8080, '127.0.0.1'); -}); - -// Find And Modify Command -var findAndModifyCommand = function(request, response) { - // Perform an insert and the modify that one - var objectId = new ObjectID(); - // Fetch collection and insert document then modify it - db.createCollection('findAndModify', function(err, collection) { - collection.insert({_id:objectId, a:1, b:true, date:new Date()}, {safe:true}, function(err, result) { - if(err != null) { - response.end("findAndModifyCommand ERROR :: " + err.toString()); - return; - } - - // Perform the modifyAndModify - collection.findAndModify({_id:objectId}, [['_id', 1]], {'$set':{'a':2}}, {'new':true, safe:true}, function(err, updated_doc) { - response.end("findAndModifyCommand SUCCESS :: " + JSON.stringify(updated_doc)); - }); - }) - }); -} \ No newline at end of file diff --git a/dev/tools/build-docs.js b/dev/tools/build-docs.js deleted file mode 100644 index b5f97bc8881..00000000000 --- a/dev/tools/build-docs.js +++ /dev/null @@ -1,174 +0,0 @@ -var fs = require('fs'), - dox = require('dox'), - parseJS = require('uglify-js').parser, - ejs = require('ejs'), - exec = require('child_process').exec, - format = require('util').format, - format = require('util').format, - docs = require('./docs'); - -// ---------------------------------------------------------------------------- -// INITALIZE -// ---------------------------------------------------------------------------- -// All source files for the api generation -var apiClasses = [ - {tag:"admin", path:"./lib/mongodb/admin.js"}, - {tag:"collection", path:"./lib/mongodb/collection.js"}, - {tag:"db", path:"./lib/mongodb/db.js"}, - {tag:"cursor", path:"./lib/mongodb/cursor.js"}, - {tag:"cursorstream", path:"./lib/mongodb/cursorstream.js"}, - {tag:"gridstore", path:"./lib/mongodb/gridfs/gridstore.js"}, - {tag:"readstream", path:"./lib/mongodb/gridfs/readstream.js"}, - {tag:"grid", path:"./lib/mongodb/gridfs/grid.js"} - ]; - -// All test files -var testClasses = [ - {path:"./test/admin_test.js"}, - {path:"./test/objectid_test.js"}, - {path:"./test/insert_test.js"}, - {path:"./test/remove_test.js"}, - {path:"./test/collection_test.js"}, - {path:"./test/db_test.js"}, - {path:"./test/find_test.js"}, - {path:"./test/map_reduce_test.js"}, - {path:"./test/index_test.js"}, - {path:"./test/geo_search_test.js"}, - {path:"./test/replicaset/connect_test.js"}, - {path:"./test/connect_test.js"}, - {path:"./test/multiple_dbs_on_connection_pool_test.js"}, - {path:"./test/cursor_test.js"}, - {path:"./test/cursorstream_test.js"}, - {path:"./test/gridstore/grid_store_test.js"}, - {path:"./test/gridstore/grid_store_file_test.js"}, - {path:"./test/gridstore/grid_store_stream_test.js"}, - {path:"./test/gridstore/readstream_test.js"}, - {path:"./test/gridstore/grid_test.js"}, - {path:"./test/bson_types_test.js"}, - {path:"./test/bson/bson_test.js"} - ] - -// Read all the templates -var templates = [ - {tag:'index', path:'./dev/tools/doc-templates/index.ejs'}, - {tag:'changelog', path:'./dev/tools/doc-templates/changelog.ejs'}, - {tag:'index_no_header', path:'./dev/tools/doc-templates/index_no_header.ejs'}, - {tag:'class', path:'./dev/tools/doc-templates/class.ejs'}, - {tag:'github', path:'./dev/tools/doc-templates/github.ejs'}, - {tag:'function', path:'./dev/tools/doc-templates/function.ejs'} -] - -// Output directory -var outputDirectory = "./docs/sphinx-docs/source/api-generated" - -// ---------------------------------------------------------------------------- -// PROCESS Driver API -// ---------------------------------------------------------------------------- -docs.renderAPIDocs(outputDirectory, apiClasses, testClasses, templates, {index_title:'Driver API'}); - -// ---------------------------------------------------------------------------- -// PROCESS BSON API -// ---------------------------------------------------------------------------- -// Output directory -var outputDirectory2 = "./docs/sphinx-docs/source/api-bson-generated" -// Force create the directory for the generated docs -exec('rm -rf ' + outputDirectory2, function (error, stdout, stderr) {}); -exec('mkdir ' + outputDirectory2, function (error, stdout, stderr) {}); - -var apiClasses2 = [ - {tag:"objectid", path:"./lib/mongodb/bson/objectid.js"}, - {tag:"binary", path:"./lib/mongodb/bson/binary.js"}, - {tag:"code", path:"./lib/mongodb/bson/code.js"}, - {tag:"code", path:"./lib/mongodb/bson/db_ref.js"}, - {tag:"double", path:"./lib/mongodb/bson/double.js"}, - {tag:"minkey", path:"./lib/mongodb/bson/min_key.js"}, - {tag:"maxkey", path:"./lib/mongodb/bson/max_key.js"}, - {tag:"symbol", path:"./lib/mongodb/bson/symbol.js"}, - {tag:"timestamp", path:"./lib/mongodb/bson/timestamp.js"}, - {tag:"long", path:"./lib/mongodb/bson/long.js"}, - {tag:"bson", path:"./lib/mongodb/bson/bson.js"} - ]; - -// Render the API docs -docs.renderAPIDocs(outputDirectory2, apiClasses2, testClasses, templates, {index_title:'Binary JSON API'}); - -// ---------------------------------------------------------------------------- -// PROCESS MARKDOWN DOCUMENTS TO STRUCTURED TEXT -// ---------------------------------------------------------------------------- -// Transform the tutorials -var articles = [ - {name:"NodeKOArticle1", output:"NodeKOArticle1.rst", path:"./docs/articles/NodeKOArticle1.md"}, - {name:"NodeKOArticle2", output:"NodeKOArticle2.rst", path:"./docs/articles/NodeKOArticle2.md"} - ]; -// Tranform the markdown to restructured text -docs.writeMarkDownFile("./docs/sphinx-docs/source/api-articles", articles, templates, - {title:'Articles', template:'index'}); - -// Transform the tutorials -var articles = [ - {name:"collections", output:"collections.rst", path:"./docs/collections.md"}, - {name:"database", output:"database.rst", path:"./docs/database.md"}, - {name:"gridfs", output:"gridfs.rst", path:"./docs/gridfs.md"}, - {name:"indexes", output:"indexes.rst", path:"./docs/indexes.md"}, - {name:"insert", output:"insert.rst", path:"./docs/insert.md"}, - {name:"queries", output:"queries.rst", path:"./docs/queries.md"}, - {name:"replicaset", output:"replicaset.rst", path:"./docs/replicaset.md"}, - ]; - -// Tranform the markdown to restructured text -docs.writeMarkDownFile("./docs/sphinx-docs/source/markdown-docs", articles, templates, - {title:'Using the driver', template:'index_no_header'}); - -// ---------------------------------------------------------------------------- -// WRITE CHANGELOG TO THE DOCUMENTATION -// ---------------------------------------------------------------------------- -// Outputdiectory -var outputDirectoryChangelog = "./docs/sphinx-docs/source/changelog"; -// Force create the directory for the generated docs -exec('rm -rf ' + outputDirectoryChangelog, function (error, stdout, stderr) {}); -exec('mkdir ' + outputDirectoryChangelog, function (error, stdout, stderr) { - // Read all the templates - var templateObjects = docs.readAllTemplates(templates); - // Read the changelog - var changelog = fs.readFileSync('./HISTORY').toString(); - // Just write out the index - var content = ejs.render(templateObjects["changelog"], {content:changelog}); - // Write it out - fs.writeFileSync(format("%s/changelog.rst", outputDirectoryChangelog), content); -}); - -// ---------------------------------------------------------------------------- -// Generate using the driver pages -// ---------------------------------------------------------------------------- -// Outputdiectory -var outputDirectoryGithub = "./docs/sphinx-docs/source/github"; -var inputFile = "./docs/sphinx-docs/npm_dependent_packages.json"; - -// tag descriptions -var tagDescriptions = { - odm: "Object Document Modeling Libraries", - webframework: "Web frameworks using MongoDB", - cms: "Content Management Systems", - gridfs: "Grid FS libraries or tools", - wrapper: "Wrapper libraries to ease the use of development or provide simple ODM like behaviours", - rest: "REST api's around MongoDB or resource based libraries", - test: "Test helpers and libraries", - manage: "Tools or applications to manage your MongoDB's", - queue: "Queue libraries using MongoDB", - logging: "Logging libraries or applications", - monitoring: "Monitoring applications or libraries", - framework: "General frameworks over MongoDB", - translation: "Translation libraries or frameworks", - analytics: "Libraries or Applications for analytics", - connect: "Libraries for the connect middleware", - continuosintegration: "Libraries or applications for continous integration", - example: "Exampe applications" -} - -// Create the github documents -// docs.generateGithubPackageList(inputFile, outputDirectory, templates, tagDescriptions, {dontfetch:true}); -docs.generateGithubPackageList(inputFile, outputDirectoryGithub, templates, tagDescriptions, {}); - - - - diff --git a/dev/tools/doc-templates/changelog.ejs b/dev/tools/doc-templates/changelog.ejs deleted file mode 100644 index 54626d17cda..00000000000 --- a/dev/tools/doc-templates/changelog.ejs +++ /dev/null @@ -1,5 +0,0 @@ -========= -Changelog -========= - -<%= content %> \ No newline at end of file diff --git a/dev/tools/doc-templates/class.ejs b/dev/tools/doc-templates/class.ejs deleted file mode 100644 index 96624a9b8ca..00000000000 --- a/dev/tools/doc-templates/class.ejs +++ /dev/null @@ -1,317 +0,0 @@ -<% -// for(var i = 0; i < entries.length; i++) { -// if(isClass(entries[i].tags)) { -// -// } -// } - -var addLine = function(char, length) { - var chars = []; - for(var i = 0; i < length; i++) chars[i] = char; - return chars.join(''); -} - -// Contains the current class name -var className = null; - -for(var i = 0; i < entries.length; i++) { - if(isClass(entries[i].tags)) { - var _name = entries[i].ctx.string.trim(); - - %><%= format("%s\n%s\n%s\n", addLine("=", _name.length), _name, addLine("=", _name.length)) %><% - className = entries[i].ctx.string.replace("()", ""); - - %><%= format("\n------------------\nConstructor\n------------------\n") %><% - - // Get full description and clean it - var fullDescription = entries[i].description.summary; - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/strong\>/g, "**") - .replace(/\|\<\/em\>/g, "*") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - %><%- format("%s\n\n", fullDescription) %><% - %><%= format("\n .. js:class:: %s\n\n", entries[i].ctx.string) %><% - - for(var ti = 0; ti < entries[i].tags.length; ti++) { - // Get the current tag - var tag = entries[i].tags[ti]; - // If we have a parameter render it - if(tag.type == 'param') { - // Unpack the tag - var type = tag.types[0].toLowerCase(); - var name = tag.name; - var description = tag.description; - // Render the parameter - %><%= format(" :param %s %s: %s\n", type, name, description) %><% - } else if(tag.type == 'return') { - // Unpack the tag - var type = tag.types[0].toLowerCase(); - var description = tag.description; - // Render the parameter - %><%= format(" :returns: %s %s\n", type, description) %><% - } - } - - // Get full description and clean it - var fullDescription = entries[i].description.body; - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/strong\>/g, "**") - .replace(/\|\<\/em\>/g, "*") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - %><%- format("%s\n\n", fullDescription) %><% - } -} - -for(var i = 0; i < entries.length; i++) { - if(isClassConstant(entries[i])) { - %><%= format("\n------------------\nConstants\n------------------\n") %><% -%> -.. csv-table:: - :header: "Constant Name", "Value", "Description" - :widths: 15, 10, 30 - -<% - break; - } -} - -for(var i = 0; i < entries.length; i++) { - if(isClassConstant(entries[i])) { - // Extract values - var attributeName = format("%s = %s;", entries[i].ctx.string, entries[i].ctx.value); - var getterSetters = []; - var type = ""; - - // Get full description and clean it - var fullDescription = entries[i].description.full; - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - - // Write out the class definition row - %><%- format(" \"%s\", \"%s\", \"%s\"\n", entries[i].ctx.string.trim(), entries[i].ctx.value.trim(), fullDescription.trim()) %><% - } -} - -for(var i = 0; i < entries.length; i++) { - if(isProperty(entries[i])) { - %><%= format("\n------------------\nProperties\n------------------\n") %><% - break; - } -} - -for(var i = 0; i < entries.length; i++) { - if(isProperty(entries[i])) { - // Extract values - var attributeName = ""; - var getterSetters = []; - var type = ""; - - // Loop over all tags - for(var ti = 0; ti < entries[i].tags.length; ti++) { - if(entries[i].tags[ti].type == 'field') attributeName = entries[i].tags[ti].string; - if(entries[i].tags[ti].type == 'getter') getterSetters.push("Getter"); - if(entries[i].tags[ti].type == 'setter') getterSetters.push("Setter"); - if(entries[i].tags[ti].type == 'type') type = entries[i].tags[ti].types[0].toLowerCase(); - } - - // Get full description and clean it - var fullDescription = entries[i].description.full; - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - - // Write out the text - %><%- format("%s\n\n", fullDescription) %><% - %><%= format(".. js:attribute:: %s %s [%s]\n\n", attributeName, type, getterSetters.join("|")) %><% - - // If we have examples render them - if(examples != null && examples[attributeName]) { - %><%= format("\n**Examples**\n\n") %><% - var examplesArray = examples[attributeName]; - // Iterate over all the examples - for(var ei = 0; ei < examplesArray.length; ei++) { - // Fetch an example - var example = examplesArray[ei]; - var code = example.code; - code = code.replace(", ssl:useSSL", "") - .replace("native_parser: native_parser", "native_parser: false") - .replace(/test\.ok/g, "assert.ok") - .replace(/test\.equal/g, "assert.equal") - .replace(/test\.deepEqual/g, "assert.deepEqual") - .replace(/\n[ |\t]*test\.done\(\)\;/, ""); - - // Split and adjust code - var codeLines = code.split(/\n/); - for(var ci = 0; ci < codeLines.length; ci++) { - codeLines[ci] = " " + codeLines[ci]; - } - - var fullDescription = example.description.full; - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - - // Split up and move - var fullDescriptionLines = fullDescription.split(/\n/); - for(var ci = 0; ci < fullDescriptionLines.length; ci++) { - fullDescriptionLines[ci] = " " + fullDescriptionLines[ci]; - } - - // Starting template Lines - var startingTemplateLines = [ - " var Db = require('mongodb').Db,", - " Server = require('mongodb').Server,", - " ReplSetServers = require('mongodb').ReplSetServers,", - " ObjectID = require('mongodb').ObjectID,", - " Binary = require('mongodb').Binary,", - " GridStore = require('mongodb').GridStore,", - " Code = require('mongodb').Code,", - " BSON = require('mongodb').pure().BSON,", - " assert = require('assert');\n\n" - ]; - - // Let's render it - %><%- format("%s\n\n", fullDescriptionLines.join("\n")) %><% - %><%- format(" .. code-block:: javascript\n\n%s%s\n\n", startingTemplateLines.join("\n"), codeLines.join("\n")) %><% - } - } - } -} - -for(var i = 0; i < entries.length; i++) { - // If it's a function parse it - if(isFunction(entries[i])) { - var paramsStrings = []; - var paramNames = []; - - for(var ti = 0; ti < entries[i].tags.length; ti++) { - // Get the current tag - var tag = entries[i].tags[ti]; - // If we have a parameter render it - if(tag.type == 'param') { - // Unpack the tag - var type = tag.types[0].toLowerCase(); - var name = tag.name; - var description = tag.description; - // Add to list of params - paramNames.push(name); - // Render the parameter - paramsStrings.push(format(" :param %s %s: %s\n", type, name, description)); - } else if(tag.type == 'return') { - // Unpack the tag - var type = tag.types[0].toLowerCase(); - var description = tag.description; - // Render the parameter - paramsStrings.push(format(" :returns: %s %s\n\n", type, description)); - } - } - - // Reformat any optional parameters from ,[] to [,] - var paramsString = paramNames.join(", ").replace(/\, \[/, "[, "); - // Write out the methods - var fullDescription = entries[i].description.full; - - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/strong\>/g, "**") - .replace(/\|\<\/em\>/g, "*") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - - // The name of examples - var examplesName = entries[i].ctx.name; - - // Write header depending on if it's class or instance level - if(entries[i].ctx.receiver != null) { - // Change examples Name to include class name - var examplesName = format("%s.%s", className, entries[i].ctx.name); - var _length = format("%s.%s", className, entries[i].ctx.name).length; - %><%= format("\n%s\n%s.%s\n%s\n", addLine("-", _length), className, entries[i].ctx.name, addLine("-", _length)) %><% - %><%- format("%s\n\n", fullDescription) %><% - %><%= format(".. js:function:: %s.%s(%s)\n\n", className, entries[i].ctx.name, paramsString) %><% - } else { - var _length = entries[i].ctx.name.length; - %><%= format("\n%s\n%s\n%s\n", addLine("-", _length), entries[i].ctx.name, addLine("-", _length)) %><% - %><%- format("%s\n\n", fullDescription) %><% - %><%= format(".. js:function:: %s(%s)\n\n", entries[i].ctx.name, paramsString) %><% - } - - %><%= Array.isArray(paramsStrings) ? paramsStrings.join("") : paramsStrings %><% - - // If we have examples render them - if(examples != null && examples[examplesName]) { - %><%= format("\n**Examples**\n\n") %><% - var examplesArray = examples[examplesName]; - // Iterate over all the examples - for(var ei = 0; ei < examplesArray.length; ei++) { - // Fetch an example - var example = examplesArray[ei]; - var code = example.code; - code = code.replace(", ssl:useSSL", "") - .replace("native_parser: native_parser", "native_parser: false") - .replace(/test\.ok/g, "assert.ok") - .replace(/test\.equal/g, "assert.equal") - .replace(/test\.deepEqual/g, "assert.deepEqual") - .replace(/\n[ |\t]*test\.done\(\)\;/, ""); - - // Split and adjust code - var codeLines = code.split(/\n/); - for(var ci = 0; ci < codeLines.length; ci++) { - codeLines[ci] = " " + codeLines[ci]; - } - - var fullDescription = example.description.full; - fullDescription = fullDescription.replace(/\\/g, ".. code-block:: javascript\n\n ") - .replace(/\<\/code\>\<\/pre\>/g, "") - .replace(/\|\<\/h2\>/g, "**") - .replace(/\/g, "\n\n") - .replace(/\<\/p\>/g, "") - .replace(/\|\<\/br[ ]*\>|\/g, "\n"); - - // Split up and move - var fullDescriptionLines = fullDescription.split(/\n/); - for(var ci = 0; ci < fullDescriptionLines.length; ci++) { - fullDescriptionLines[ci] = " " + fullDescriptionLines[ci]; - } - - // Starting template Lines - var startingTemplateLines = [ - " var Db = require('mongodb').Db,", - " Server = require('mongodb').Server,", - " ReplSetServers = require('mongodb').ReplSetServers,", - " ObjectID = require('mongodb').ObjectID,", - " Binary = require('mongodb').Binary,", - " GridStore = require('mongodb').GridStore,", - " Code = require('mongodb').Code,", - " BSON = require('mongodb').pure().BSON,", - " assert = require('assert');\n\n" - ]; - - // Let's render it - %><%- format("%s\n\n", fullDescriptionLines.join("\n")) %><% - %><%- format(" .. code-block:: javascript\n\n%s%s\n\n", startingTemplateLines.join("\n"), codeLines.join("\n")) %><% - } - } - } -} -%> \ No newline at end of file diff --git a/dev/tools/doc-templates/function.ejs b/dev/tools/doc-templates/function.ejs deleted file mode 100644 index 1ff17c59a14..00000000000 --- a/dev/tools/doc-templates/function.ejs +++ /dev/null @@ -1 +0,0 @@ -Function \ No newline at end of file diff --git a/dev/tools/doc-templates/github.ejs b/dev/tools/doc-templates/github.ejs deleted file mode 100644 index fa8815572d0..00000000000 --- a/dev/tools/doc-templates/github.ejs +++ /dev/null @@ -1,76 +0,0 @@ -============================================== -Github libraries and projects using the driver -============================================== - -<% -var addLine = function(char, length) { - var chars = []; - for(var i = 0; i < length; i++) chars[i] = char; - return chars.join(''); -} - -var keys = Object.keys(objectByTags); -for(var j = 0; j < keys.length; j++) { - var key = keys[j]; - var entries = objectByTags[key]; - var title = tags[key] != null ? tags[key] : key; - -%><%= format("%s\n%s\n\n", title, addLine('-', title.length)) %><% - - // Iterate over all the objects - for(var i = 0; i < entries.length; i++) { - // for(var i = 0; i < 1; i++) { - var entry = entries[i]; - var content = entry.content; - - if(content != null) { - // Parse the pushed at date - var t = Date.parse(content.pushed_at ); - var d = new Date(); - d.setTime(t); - - // If there is no activity newer than 6 months it's dead - var fourMonths = 1000*60*60*24*31*4; - var currentDate = (new Date()).getTime() - fourMonths; - - var activityArrow = ".. image:: ../static/active.png"; - if(t < currentDate) { - var activityArrow = ".. image:: ../static/nonactive.png"; - } - - // var minutes = 1000 * 60; - // var hours = minutes * 60; - // var days = hours * 24; - // var years = days * 365; - // var y = t / years; - - // document.write("It's been: " + y + " years from Jan 1, 1970"); - // document.write(" to Jul 8, 2005."); - - %><%- format(".. topic:: %s\n\n\ %s\n", content.name, content.description) %><% - %> - .. list-table:: - :widths: 25 85 - :header-rows: 0 - - * - **Activity Level** - - <%- activityArrow %> - * - **Last push** - - <%= format("%s:%s:%s on %s/%s/%s", d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds(), d.getUTCDate(), d.getUTCMonth(), d.getUTCFullYear()) %> - * - **Homepage** - - <%= format("http://%s", content.homepage) %> - * - **Url** - - <%= content.html_url %> - * - **Clone Url** - - <%= content.clone_url %> - * - **Forks** - - <%= content.forks %> - * - **Watchers** - - <%= content.watchers %> - -<% - } - } -} - -%> \ No newline at end of file diff --git a/dev/tools/doc-templates/index.ejs b/dev/tools/doc-templates/index.ejs deleted file mode 100644 index 453e61d64b1..00000000000 --- a/dev/tools/doc-templates/index.ejs +++ /dev/null @@ -1,15 +0,0 @@ -================== -<%- title %> -================== - -.. toctree:: - :maxdepth: 2 - -<% - for(var i = 0; i < entries.length; i++) { - // Classname - var name = entries[i]; - // Write out the name - %><%= format(" %s\n", name) %><% - } -%> \ No newline at end of file diff --git a/dev/tools/doc-templates/index_no_header.ejs b/dev/tools/doc-templates/index_no_header.ejs deleted file mode 100644 index 62b582a3315..00000000000 --- a/dev/tools/doc-templates/index_no_header.ejs +++ /dev/null @@ -1,11 +0,0 @@ -.. toctree:: - :maxdepth: 1 - -<% - for(var i = 0; i < entries.length; i++) { - // Classname - var name = entries[i]; - // Write out the name - %><%= format(" %s\n", name) %><% - } -%> \ No newline at end of file diff --git a/dev/tools/docs.js b/dev/tools/docs.js deleted file mode 100644 index 05d6841e658..00000000000 --- a/dev/tools/docs.js +++ /dev/null @@ -1,476 +0,0 @@ -var fs = require('fs'), - dox = require('dox'), - parseJS = require('uglify-js').parser, - ejs = require('ejs'), - exec = require('child_process').exec, - markdown = require('markdown').markdown, - github = require('github3'), - format = require('util').format; - -// ----------------------------------------------------------------------------------------------------- -// -// Markdown converter -// -// ----------------------------------------------------------------------------------------------------- -// Parse markdown to Rich text format -var transformMarkdownToStructuredText = exports.transformMarkdownToStructuredText = function(markDownText) { - // Parse the md file and generate a json tree - var jsonTree = markdown.parse(markDownText); - var documentLines = []; - return convert_tree_to_rs(jsonTree, documentLines).join('\n'); -} - -var addLine = function(char, length) { - var chars = []; - for(var i = 0; i < length; i++) chars[i] = char; - return chars.join(''); -} - -var convert_tree_to_rs = function(nodes, documentLines) { - if(!Array.isArray(nodes)) throw new Error("Malformed tree structure"); - // Go through all the tags and render - for(var i = 0; i < nodes.length; i++) { - var line = nodes[i]; - - if(Array.isArray(line)) { - switch(line[0]) { - case 'header': - // Unpack the parts - var options = line[1]; - var title = line[2]; - // Add lines to the document - if(options.level == 1) { - documentLines.push(addLine("=", title.length)) - documentLines.push(title); - documentLines.push(addLine("=", title.length)) - } else if(options.level == 2) { - documentLines.push(addLine("-", title.length)) - documentLines.push(title); - documentLines.push(addLine("-", title.length)) - } - break; - case 'para': - var paraLines = []; - paraLines.push("\n"); - - for(var j = 1; j < line.length; j++) { - // bullet list item - if(Array.isArray(line[j])) { - var subdocs = []; - convert_tree_to_rs([line[j]], subdocs); - paraLines.push(subdocs.join('')); - } else { - paraLines.push(line[j]); - } - } - - // Merge the docs in - documentLines.push(paraLines.join(' ')); - documentLines.push('\n'); - break; - case 'link': - documentLines.push(format("`%s <%s>`_", line[2], line[1].href.replace(".md", ".html"))); - break; - case 'inlinecode': - documentLines.push(format("``%s``", line[1])); - break; - case 'code_block': - // Unpack code block - var codeLines = line[1].split("\n"); - // Format all the lines - documentLines.push(" .. code-block:: javascript\n"); - for(var j = 0; j < codeLines.length; j++) { - documentLines.push(format(" %s", codeLines[j])); - } - - documentLines.push("\n"); - break; - case 'bulletlist': - // Render the list (line.length - 1) - for(var j = 1; j < line.length; j++) { - // bullet list item - if(Array.isArray(line[j])) { - var subdocs = []; - convert_tree_to_rs([line[j]], subdocs); - documentLines.push(subdocs.join(' ')); - } else { - documentLines.push(line[j]); - } - } - - // Add an empty line - documentLines.push("\n"); - break; - case 'listitem': - var listitemLines = []; - - for(var j = 1; j < line.length; j++) { - // bullet list item - if(Array.isArray(line[j])) { - var subdocs = []; - convert_tree_to_rs([line[j]], subdocs); - listitemLines.push(subdocs.join(' ')); - } else { - listitemLines.push(line[j]); - } - } - - // Merge the docs in - documentLines.push(format(" * %s", listitemLines.join(' ').trim())); - break; - case 'em': - documentLines.push(format("*%s*", line[1])); - break; - case 'strong': - documentLines.push(format("**%s**", line[1])); - break; - default: - console.dir(line) - break; - } - } - } - - return documentLines; -} - -exports.writeMarkDownFile = function(outputDirectory, articles, templates, options) { - // Read all the templates - var templateObjects = exports.readAllTemplates(templates); - - // Force create the directory for the generated docs - exec('rm -rf ' + outputDirectory, function (error, stdout, stderr) { - exec('mkdir ' + outputDirectory, function (error, stdout, stderr) { - // Contains all the names for the index - var names = []; - - // Process all the articles - for(var i = 0 ; i < articles.length; i++) { - // Fetch the article markdown content - var article = fs.readFileSync(articles[i].path).toString(); - // Convert the text into restructured text for sphinx - var text = transformMarkdownToStructuredText(article); - // Write out the content - fs.writeFileSync(format("%s/%s", outputDirectory, articles[i].output.toLowerCase()), text); - names.push(articles[i].name.toLowerCase()); - } - - // Just write out the index - var indexContent = ejs.render(templateObjects[options.template], {entries:names, format:format, title:options.title}); - fs.writeFileSync(format("%s/%s", outputDirectory, 'index.rst'), indexContent); - }); - }); -} - -// ----------------------------------------------------------------------------------------------------- -// -// API Doc generation -// -// ----------------------------------------------------------------------------------------------------- -exports.renderAPIDocs = function(outputDirectory, apiClasses, testClasses, templates, templateDocObjects) { - // Force create the directory for the generated docs - exec('rm -rf ' + outputDirectory, function (error, stdout, stderr) { - exec('mkdir ' + outputDirectory, function (error, stdout, stderr) { - // Extract meta data from source files - var dataObjects = exports.extractLibraryMetaData(apiClasses); - // Filter out and prepare the test Objects hash - var testObjects = exports.buildTestHash(exports.extractLibraryMetaData(testClasses)); - // Read all the templates - var templateObject = exports.readAllTemplates(templates); - // Render all the classes that are decorated - exports.renderAllTemplates(outputDirectory, templateObject, dataObjects, testObjects, templateDocObjects); - }); - }); -} - - -// Parses all the files and extracts the dox data for the library -exports.extractLibraryMetaData = function(sourceFiles) { - var dataObjects = {}; - // Iterate over all source files - for(var i = 0; i < sourceFiles.length; i++) { - // Read source file content - var sourceFile = fs.readFileSync(sourceFiles[i].path); - // Parse the content - var metaData = dox.parseComments(sourceFile.toString()); - // Save the metadata - dataObjects[sourceFiles[i]["tag"] != null ? sourceFiles[i].tag : i] = metaData; - } - - // Return all objects - return dataObjects; -} - -// Build a hash to easy access to the objects -exports.buildTestHash = function(objects) { - // Organize the objects by class-function so we can query them - var objectsByClassAndMethod = {}; - var objectKeys = Object.keys(objects); - - // Get all the objects - for(var i = 0; i < objectKeys.length; i++) { - // Get the object with the metadata - var object = objects[objectKeys[i]]; - // Go through each example and pull them out - for(var j = 0; j < object.length; j++) { - var block = object[j]; - var tags = block.tags; - - // Build a class type - var tagObject = {}; - - // Check for the _class tag - for(var tagIndex = 0; tagIndex < tags.length; tagIndex++) { - // Get the tag - var tag = tags[tagIndex]; - // Grab the tag if it's got it - if(tag['type'] != null && tag['string'] != null) { - tagObject[tag['type']] = tag['string']; - } - } - - // Check if we have the tags _class and _function signaling a test - if(tagObject['_class'] != null && tagObject['_function'] != null) { - // Add a class reference if none exists - if(objectsByClassAndMethod[tagObject['_class']] == null) { - objectsByClassAndMethod[tagObject['_class']] = {}; - } - - // Add a method reference if none exists - if(objectsByClassAndMethod[tagObject['_class']][tagObject['_function']] == null) { - objectsByClassAndMethod[tagObject['_class']][tagObject['_function']] = []; - } - - // Push the object on the list - objectsByClassAndMethod[tagObject['_class']][tagObject['_function']].push(block); - - // Format the block code - var codeLines = block.code.split(/\n/); - // Drop first and last line - codeLines = codeLines.slice(1, codeLines.length - 1); - // Indent the code - for(var k = 0; k < codeLines.length; k++) { - codeLines[k] = codeLines[k].replace(/^ /, "") - } - // Reasign the code block - block.code = codeLines.join("\n"); - } - } - } - - // Return the object mapped by _class and _function - return objectsByClassAndMethod; -} - -// Render all the templates -exports.renderAllTemplates = function(outputDirectory, templates, dataObjects, testObjects, attributeTags) { - // Helper methods used in the rendering - var isClass = function(tags) { - for(var k = 0; k < tags.length; k++) { - if(tags[k].type == 'class') return true; - } - return false; - } - - var isFunction = function(entry) { - return entry.ctx != null && entry.ctx.type == 'method' && entry.isPrivate == false; - } - - var isProperty = function(entry) { - var tags = entry.tags; - for(var k = 0; k < tags.length; k++) { - if(tags[k].type == 'property') return true; - } - return false; - } - - var isClassConstant = function(entry) { - var tags = entry.tags; - for(var k = 0; k < tags.length; k++) { - if(tags[k].type == 'classconstant') return true; - } - return false; - } - - // Iterate over all classes - var classNames = Object.keys(dataObjects); - - // For each class generate output - for(var i = 0; i < classNames.length; i++) { - var className = classNames[i]; - // The meta data object - var classMetaData = dataObjects[className]; - // Grab the examples for this Metadata class - var classExamplesData = testObjects[className]; - // Render the class template - var classContent = ejs.render(templates['class'], - {entries:classMetaData, examples:classExamplesData, isClass:isClass, - isFunction:isFunction, isProperty:isProperty, isClassConstant:isClassConstant, - format:format}); - // Write out the content to disk - fs.writeFileSync(format("%s/%s.rst", outputDirectory, className), classContent); - } - - // Let's render the index api file - var indexContent = ejs.render(templates['index'], - {entries:classNames, isClass:isClass, isFunction:isFunction, isProperty:isProperty, - isClassConstant:isClassConstant, format:format, title:attributeTags['index_title']}); - // Write out the api index to disk - fs.writeFileSync(format("%s/%s.rst", outputDirectory, "index"), indexContent); -} - -// Read all the templates -exports.readAllTemplates = function(templates) { - var finishedTemplates = {}; - // Read in all the templates - for(var i = 0; i < templates.length; i++) { - finishedTemplates[templates[i].tag] = fs.readFileSync(templates[i].path).toString(); - } - - // Return the finished templates - return finishedTemplates; -} - -// ----------------------------------------------------------------------------------------------------- -// -// Pull down github and generate docs -// -// ----------------------------------------------------------------------------------------------------- -exports.generateGithubPackageList = function(inputFile, outputDirectory, templates, tagDescriptions, options) { - if(options == null || options.dontfetch == null) { - // Force create the directory for the generated docs - exec('rm -rf ' + outputDirectory, function (error, stdout, stderr) { - exec('mkdir ' + outputDirectory, function (error, stdout, stderr) { - _generateGithubPackageList(inputFile, outputDirectory, templates, tagDescriptions, options); - }); - }); - } else { - _generateGithubPackageList(inputFile, outputDirectory, templates, tagDescriptions, options); - } -} - -var _generateGithubPackageList = function(inputFile, outputDirectory, templates, tagDescriptions, options) { - // Set credentials - github.setCredentials(user, password); - // Read all the templates - var templateObjects = exports.readAllTemplates(templates); - // Check the user and password - var user = process.env['GITHUB_USER']; - var password = process.env['GITHUB_PASSWORD']; - // Make sure we have user and password - if(user == null && password == null) throw "Please provide a GITHUB_USER and GITHUB_PASSWORD environment variable"; - - // Read in the json file - var jsonData = fs.readFileSync(inputFile, 'ascii'); - var objects = JSON.parse(jsonData); - var length = objects.length; - var totalNumberOfRepos = length; - - // Iterate over all the repos - for(var i = 0; i < length; i++) { - // Fetch the object - var object = objects[i]; - // Unpack the object - var description = object.description; - var location = object.location; - var url = object.url; - var tag = object.tag; - // Unpack the url - var urlparts = url.split(/\//); - // Chop of the 2 last elements so we can get the parts - urlparts = urlparts.slice(urlparts.length - 2) - // Unpack url - var username = urlparts[0]; - var repo = urlparts[1]; - // Add stuff back to the object - object.username = username; - object.repo = repo; - // Let's fetch the content - if(options == null || options.dontfetch == null) { - // Get repo information - new function(_repo, _username) { - // Get the repo information - github.getRepository(_repo, _username, function(err, result) { - // Correct the number of remaining repos - totalNumberOfRepos = totalNumberOfRepos - 1; - // Write the content to disk - fs.writeFileSync(format("%s/%s.%s.json", outputDirectory, _repo, _username), JSON.stringify(result, null, 2), 'ascii'); - - // If we are done skip to next processing step - if(totalNumberOfRepos == 0) { - return _processGithub(objects, outputDirectory, templateObjects, tagDescriptions); - } - }); - }(repo, username) - } - } - - // If don't want to download just skip to processing - if(options != null && options.dontfetch) { - // Do the processing instead - return _processGithub(objects, outputDirectory, templateObjects, tagDescriptions); - } -} - -var _processGithub = function(objects, outputDirectory, templates, tagDescriptions) { - // Let's read all the json files in and map them to the correct object - var directoryListing = fs.readdirSync(outputDirectory); - // Iterate over all entries - for(var i = 0; i < directoryListing.length; i++) { - var file = directoryListing[i]; - - // If we have a json file - if(file.indexOf('.json') != -1) { - var fileContent = fs.readFileSync(format("%s/%s", outputDirectory, file), 'ascii'); - var fileObject = JSON.parse(fileContent); - // Did not retrive document correctly - if(fileObject != null) { - // Unpack parameters used for matching - var username = fileObject.owner.login; - var repo = fileObject.name; - - // Map it to the correct object - for(var j = 0; j < objects.length; j++) { - var object = objects[j]; - - // If we match username and repo add to the object - if(object.username == username && object.repo == repo) { - // Add the content to the object - object.content = fileObject; - } - } - } - } - } - - // Group object by tags - var objectByTags = {}; - // Iterate over all the objects - for(var i = 0; i < objects.length; i++) { - var object = objects[i]; - var tag = object.tag; - - if(objectByTags[tag] == null) { - objectByTags[tag] = []; - } - - objectByTags[tag].push(object); - } - - // Just write out the index - var indexContent = ejs.render(templates['github'], {objectByTags:objectByTags, format:format, tags:tagDescriptions}); - fs.writeFileSync(format("%s/%s", outputDirectory, 'github.rst'), indexContent); -} - - - - - - - - - - - - - diff --git a/dev/tools/gleak.js b/dev/tools/gleak.js deleted file mode 100644 index 1890e1e42f0..00000000000 --- a/dev/tools/gleak.js +++ /dev/null @@ -1,7 +0,0 @@ - -var gleak = require('gleak')(); -gleak.ignore('AssertionError'); -gleak.ignore('testFullSpec_param_found'); -gleak.ignore('events'); - -module.exports = gleak; diff --git a/dev/tools/test_all.js b/dev/tools/test_all.js deleted file mode 100644 index d271c2a27d5..00000000000 --- a/dev/tools/test_all.js +++ /dev/null @@ -1,176 +0,0 @@ -var nodeunit = require('nodeunit'), - debug = require('util').debug, - inspect = require('util').inspect, - fs = require('fs'), - exec = require('child_process').exec, - spawn = require('child_process').spawn, - Step = require('step/lib/step'), - ServerManager = require('../../test/tools/server_manager').ServerManager, - ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager; - -// Manage the test server -var serverManager = new ServerManager(); -var replicaSetManager = new ReplicaSetManager(); -// test directories -var files = []; -var directories = [{dir: __dirname + "/../../test", path: "/test/"}, - {dir: __dirname + "/../../test/gridstore", path: "/test/gridstore/"}, - {dir: __dirname + "/../../test/connection", path: "/test/connection/"}, - {dir: __dirname + "/../../test/bson", path: "/test/bson/"}]; - -// Generate a list of tests -directories.forEach(function(dirEntry) { - // Add the files - files = files.concat(fs.readdirSync(dirEntry.dir).filter(function(item) { - return /_test\.js$/i.test(item); - }).map(function(file) { - return dirEntry.path + file; - })); -}); - -// Replicasetfiles -var replicasetFiles = fs.readdirSync(__dirname + "/../../test/replicaset").filter(function(item) { - return /_test\.js$/i.test(item); -}).map(function(file) { - return "/test/replicaset/" + file; -}); - -var specifedParameter = function(arguments, param) { - for(var i = 0; i < arguments.length; i++) { - if(arguments[i] == param) return true; - } - return false; -} - -// Different options -var junit = specifedParameter(process.argv, '--junit', false); -var noReplicaSet = specifedParameter(process.argv, '--noreplicaset', false); -var boot = specifedParameter(process.argv, '--boot', false); -// Basic default test runner -var runner = nodeunit.reporters.default; -var options = { error_prefix: '\u001b[31m', - error_suffix: '\u001b[39m', - ok_prefix: '\u001b[32m', - ok_suffix: '\u001b[39m', - bold_prefix: '\u001b[1m', - bold_suffix: '\u001b[22m', - assertion_prefix: '\u001b[35m', - assertion_suffix: '\u001b[39m' }; - -// cleanup output directory -exec('rm -rf ./output', function(err, stdout, stderr) { - // if we have a junit reporter - if(junit) { - // Remove directory - fs.mkdirSync("./output", 0777); - // Set up options - options.output = './output'; - options.junit = true; - } - - // Run all tests including replicaset ones - if(!noReplicaSet) { - // Boot up the test server and run the tests - Step( - // Start the single server - function startSingleServer() { - if(boot) { - serverManager.start(true, {purgedirectories:true}, this); - } else { - this(null, null); - } - }, - - // Run all the integration tests using the pure js bson parser - function runPureJS() { - options.suffix = 'pure'; - var test_set_runner = spawn('node', ['./dev/tools/test_set_runner.js', JSON.stringify(files), JSON.stringify(options)]); - test_set_runner.stdout.on('data', function(data) { - process.stdout.write(data.toString()); - }); - test_set_runner.stderr.on('data', function(data) { - process.stdout.write("err: " + data.toString()); - }); - - test_set_runner.on('exit', this); - }, - - // Execute all the replicaset tests - function executeReplicaSetTests() { - options.suffix = 'pure'; - var test_set_runner = spawn('node', ['./dev/tools/test_set_runner.js', JSON.stringify(replicasetFiles), JSON.stringify(options)]); - test_set_runner.stdout.on('data', function(data) { - process.stdout.write(data.toString()); - }); - test_set_runner.stderr.on('data', function(data) { - process.stdout.write("err: " + data.toString()); - }); - - test_set_runner.on('exit', this); - }, - - function done() { - if(boot) { - // Kill all mongod server - replicaSetManager.killAll(function() { - // Force exit - process.exit(); - }) - } else { - process.exit(); - } - } - ); - } else { - // Execute without replicaset tests - Step( - function startSingleServer() { - if(boot) { - serverManager.start(true, {purgedirectories:true}, this); - } else { - this(null, null); - } - }, - - function runPureJS() { - options.suffix = 'pure'; - var test_set_runner = spawn('node', ['./dev/tools/test_set_runner.js', JSON.stringify(files), JSON.stringify(options)]); - test_set_runner.stdout.on('data', function(data) { - process.stdout.write(data.toString()); - }); - test_set_runner.stderr.on('data', function(data) { - process.stdout.write("err: " + data.toString()); - }); - - test_set_runner.on('exit', this); - }, - - function runNativeJS() { - options.suffix = 'native'; - options.native = true; - - var test_set_runner = spawn('node', ['./dev/tools/test_set_runner.js', JSON.stringify(files), JSON.stringify(options)]); - test_set_runner.stdout.on('data', function(data) { - process.stdout.write(data.toString()); - }); - test_set_runner.stderr.on('data', function(data) { - process.stdout.write("err: " + data.toString()); - }); - - test_set_runner.on('exit', this); - }, - - function done() { - if(boot) { - // Kill all mongod server - replicaSetManager.killAll(function() { - // Force exit - process.exit(); - }) - } else { - process.exit(); - } - } - ); - } -}); diff --git a/dev/tools/test_set_runner.js b/dev/tools/test_set_runner.js deleted file mode 100644 index b75155eb45a..00000000000 --- a/dev/tools/test_set_runner.js +++ /dev/null @@ -1,27 +0,0 @@ -var nodeunit = require('nodeunit'); - -// Let's parse the argv (ensure we have all the number of parameters) -if(process.argv.length === 4) { - // Pop the arguments off - var options = JSON.parse(process.argv.pop()); - var files = JSON.parse(process.argv.pop()); - - // Basic default test runner - var runner = options['junit'] == true ? nodeunit.reporters.junit : nodeunit.reporters.default; - var nativeExecution = options['native'] == null ? false : options['native']; - // Remove junit tag if it exists - delete options['junit']; - delete options['native']; - - // Set native process - if(nativeExecution) { - process.env['TEST_NATIVE'] = 'TRUE'; - } - - // Let's set up nodeunit to run - runner.run(files, options, function() { - process.exit(0); - }); -} else { - console.error("Must pass in a list of files and options object"); -} diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 6bae039cf9a..00000000000 --- a/docs/README.md +++ /dev/null @@ -1,14 +0,0 @@ -node-mongodb-native -=================== - -Select a topic of interest for detailed description: - - * [Database](https://github.com/christkv/node-mongodb-native/tree/master/docs/database.md) - * [Collections](https://github.com/christkv/node-mongodb-native/tree/master/docs/collections.md) - * [Querying documents](https://github.com/christkv/node-mongodb-native/tree/master/docs/queries.md) - * [Inserting/updating documents](https://github.com/christkv/node-mongodb-native/tree/master/docs/insert.md) - * [GridStore](https://github.com/christkv/node-mongodb-native/tree/master/docs/gridfs.md) - * [Indexes](https://github.com/christkv/node-mongodb-native/tree/master/docs/indexes.md) - * [Replicasets](https://github.com/christkv/node-mongodb-native/tree/master/docs/replicaset.md) - -This documentation is incomplete, the best source for documentation on all possible methods is [the source for node-mongodb-native](https://github.com/christkv/node-mongodb-native) and [the MongoDB manual](http://www.mongodb.org/display/DOCS/Manual). \ No newline at end of file diff --git a/docs/articles/NodeKOArticle1.md b/docs/articles/NodeKOArticle1.md deleted file mode 100644 index 2a54aef230c..00000000000 --- a/docs/articles/NodeKOArticle1.md +++ /dev/null @@ -1,279 +0,0 @@ -# A Basic introduction to Mongo DB -Mongo DB has rapidly grown to become a popular database for web applications and is a perfect fit for Node.JS applications, letting you write Javascript for the client, backend and database layer. It's schemaless nature is a better match to our constantly evolving data structures in web applications and the integrated support for location queries a bonus that it's hard to ignore. Throw Replicasets for scaling and we are looking at really nice platform to grow your storage needs now and in the future. - -Now to shamelessly plug my driver. It can be downloaded either using npm or fetched from the github repository. To install via npm do the following. - -`npm install mongodb` - -or go fetch it from github at [https://github.com/christkv/node-mongodb-native](https://github.com/christkv/node-mongodb-native) - -Once this business is taken care of let's move through the types available for the driver and then how to connect to your Mongo DB instance before facing the usage of some crud operations. - -## Mongo DB data types -So there is an important thing to keep in mind when working with Mongo DB and that is that there is a slight mapping difference between the types supported in Mongo DB and what is native types in Javascript. Let's have a look at the types supported out of the box and then how types are promoted by the driver to try to fit as close to the native Javascript types as possible. - -* **Float** is a 8 byte and is directly convertible to the Javascript type Number -* **Double class** a special class representing a float value, this is especially useful when using capped collections where you need to ensure your values are always floats. -* **Integers** is a bit trickier due to the fact that Javascript represents all Numbers as 64 bit floats meaning that the maximum integer value is at a 53 bit. Mongo has two types for integers, a 32 bit and a 64 bit. The driver will try to fit the value into 32 bits if it can and promote it to 64 bits if it has to. Similarly it will deserialize attempting to fit it into 53 bits if it can. If it cannot it will return an instance of **Long** to avoid loosing precession. -* **Long class** a special class that let's you store 64 bit integers and also let's you operate on the 64 bits integers. -* **Date** maps directly to a Javascript Date -* **RegEp** maps directly to a Javascript RegExp -* **String** maps directly to a Javascript String (encoded in utf8) -* **Binary class** a special class that let's you store data in Mongo DB -* **Code class** a special class that let's you store javascript functions in Mongo DB, can also provide a scope to run the method in -* **ObjectID class** a special class that holds a MongoDB document identifier (the equivalent to a Primary key) -* **DbRef class** a special class that let's you include a reference in a document pointing to another object -* **Symbol class** a special class that let's you specify a symbol, not really relevant for javascript but for languages that supports the concept of symbols. - -As we see the number type can be a little tricky due to the way integers are implemented in Javascript. The latest driver will do correct conversion up to 53 bit's of complexity. If you need to handle big integers the recommendation is to use the Long class to operate on the numbers. - -## Getting that connection to the database -Let's get around to setting up a connection with the Mongo DB database. Jumping straight into the code let's do direct connection and then look at the code. - - var mongo = require('mongodb'), - Server = mongo.Server, - Db = mongo.Db; - - var server = new Server('localhost', 27017, {auto_reconnect: true}); - var db = new Db('exampleDb', server); - - db.open(function(err, db) { - if(!err) { - console.log("We are connected"); - } - }); - -Let's have a quick look at the simple connection. The **new Server(...)** sets up a configuration for the connection and the **auto_reconnect** tells the driver to retry sending a command to the server if there is a failure. Another option you can set is **poolSize**, this allows you to control how many tcp connections are opened in parallel. The default value for this is 1 but you can set it as high as you want. The driver will use a round-robin strategy to dispatch and read from the tcp connection. - -We are up and running with a connection to the database. Let's move on and look at what collections are and how they work. - -## Mongo DB and Collections -Collections are the equivalent of tables in traditional databases and contain all your documents. A database can have many collections. So how do we go about defining and using collections. Well there are a couple of methods that we can use. Let's jump straight into code and then look at the code. - -**the requires and and other initializing stuff omitted for brevity** - - db.open(function(err, db) { - if(!err) { - db.collection('test', function(err, collection) {}); - - db.collection('test', {safe:true}, function(err, collection) {}); - - db.createCollection('test', function(err, collection) {}); - - db.createCollection('test', {safe:true}, function(err, collection) {}); - } - }); - -Three different ways of creating a collection object but slightly different in behavior. Let's go through them and see what they do - - db.collection('test', function(err, collection) {}); - -This function will not actually create a collection on the database until you actually insert the first document. - - db.collection('test', {safe:true}, function(err, collection) {}); - -Notice the **{safe:true}** option. This option will make the driver check if the collection exists and issue an error if it does not. - - db.createCollection('test', function(err, collection) {}); - -This command will create the collection on the Mongo DB database before returning the collection object. If the collection already exists it will ignore the creation of the collection. - - db.createCollection('test', {safe:true}, function(err, collection) {}); - -The **{safe:true}** option will make the method return an error if the collection already exists. - -With an open db connection and a collection defined we are ready to do some CRUD operation on the data. - -## And then there was CRUD - -So let's get dirty with the basic operations for Mongo DB. The Mongo DB wire protocol is built around 4 main operations **insert/update/remove/query**. Most operations on the database are actually queries with special json objects defining the operation on the database. But I'm getting ahead of myself. Let's go back and look at insert first and do it with some code. - -**the requires and and other initializing stuff omitted for brevity** - - db.open(function(err, db) { - if(!err) { - db.collection('test', function(err, collection) { - var doc1 = {'hello':'doc1'}; - var doc2 = {'hello':'doc2'}; - var lotsOfDocs = [{'hello':'doc3'}, {'hello':'doc4'}]; - - collection.insert(doc1); - - collection.insert(doc2, {safe:true}, function(err, result) {}); - - collection.insert(lotsOfDocs, {safe:true}, function(err, result) {}); - }); - } - }); - -A couple of variations on the theme of inserting a document as we can see. To understand why it's important to understand how Mongo DB works during inserts of documents. - -Mongo DB has asynchronous **insert/update/remove** operations. This means that when you issue an **insert** operation its a fire and forget operation where the database does not reply with the status of the insert operation. To retrieve the status of the operation you have to issue a query to retrieve the last error status of the connection. To make it simpler to the developer the driver implements the **{safe:true}** options so that this is done automatically when inserting the document. **{safe:true}** becomes especially important when you do **update** or **remove** as otherwise it's not possible to determine the amount of documents modified or removed. - -Now let's go through the different types of inserts shown in the code above. - - collection.insert(doc1); - -Taking advantage of the async behavior and not needing confirmation about the persisting of the data to Mongo DB we just fire off the insert (we are doing live analytics, loosing a couple of records does not matter). - - collection.insert(doc2, {safe:true}, function(err, result) {}); - -That document needs to stick. Using the **{safe:true}** option ensure you get the error back if the document fails to insert correctly. - - collection.insert(lotsOfDocs, {safe:true}, function(err, result) {}); - -A batch insert of document with any errors being reported. This is much more efficient if you need to insert large batches of documents as you incur a lot less overhead. - -Right that's the basics of insert's ironed out. We got some documents in there but want to update them as we need to change the content of a field. Let's have a look at a simple example and then we will dive into how Mongo DB updates work and how to do them efficiently. - -**the requires and and other initializing stuff omitted for brevity** - - db.open(function(err, db) { - if(!err) { - db.collection('test', function(err, collection) { - var doc = {mykey:1, fieldtoupdate:1}; - - collection.insert(doc, {safe:true}, function(err, result) { - collection.update({mykey:1}, {$set:{fieldtoupdate:2}}, {safe:true}, function(err, result) {}); - }); - - var doc2 = {mykey:2, docs:[{doc1:1}]}; - - collection.insert(doc2, {safe:true}, function(err, result) { - collection.update({mykey:2}, {$push:{docs:{doc2:1}}, {safe:true}, function(err, result) {}); - }); - }); - }; - }); - -Alright before we look at the code we want to understand how document updates work and how to do the efficiently. The most basic and less efficient way is to replace the whole document, this is not really the way to go if you want to change just a field in your document. Luckily Mongo DB provides a whole set of operations that let you modify just pieces of the document [Atomic operations documentation](http://www.mongodb.org/display/DOCS/Atomic+Operations). Basically outlined below. - -* $inc - increment a particular value by a certain amount -* $set - set a particular value -* $unset - delete a particular field (v1.3+) -* $push - append a value to an array -* $pushAll - append several values to an array -* $addToSet - adds value to the array only if its not in the array already -* $pop - removes the last element in an array -* $pull - remove a value(s) from an existing array -* $pullAll - remove several value(s) from an existing array -* $rename - renames the field -* $bit - bitwise operations - -Now that the operations are outline let's dig into the specific cases show in the code example. - - collection.update({mykey:1}, {$set:{fieldtoupdate:2}}, {safe:true}, function(err, result) {}); - -Right so this update will look for the document that has a field **mykey** equal to **1** and apply an update to the field **fieldtoupdate** setting the value to **2**. Since we are using the **{safe:true}** option the result parameter in the callback will return the value **1** indicating that 1 document was modified by the update statement. - - collection.update({mykey:2}, {$push:{docs:{doc2:1}}, {safe:true}, function(err, result) {}); - -This updates adds another document to the field **docs** in the document identified by **{mykey:2}** using the atomic operation **$push**. This allows you to modify keep such structures as queues in Mongo DB. - -Let's have a look at the remove operation for the driver. As before let's start with a piece of code. - -**the requires and and other initializing stuff omitted for brevity** - - db.open(function(err, db) { - if(!err) { - db.collection('test', function(err, collection) { - var docs = [{mykey:1}, {mykey:2}, {mykey:3}]; - - collection.insert(docs, {safe:true}, function(err, result) { - - collection.remove({mykey:1}); - - collection.remove({mykey:2}, {safe:true}, function(err, result) {}); - - collection.remove(); - }); - }); - }; - }); - -Let's examine the 3 remove variants and what they do. - - collection.remove({mykey:1}); - -This leverages the fact that Mongo DB is asynchronous and that it does not return a result for **insert/update/remove** to allow for **synchronous** style execution. This particular remove query will remove the document where **mykey** equals **1**. - - collection.remove({mykey:2}, {safe:true}, function(err, result) {}); - -This remove statement removes the document where **mykey** equals **2** but since we are using **{safe:true}** it will back to Mongo DB to get the status of the remove operation and return the number of documents removed in the result variable. - - collection.remove(); - -This last one will remove all documents in the collection. - -## Time to Query -Queries is of course a fundamental part of interacting with a database and Mongo DB is no exception. Fortunately for us it has a rich query interface with cursors and close to SQL concepts for slicing and dicing your datasets. To build queries we have lots of operators to choose from [Mongo DB advanced queries](http://www.mongodb.org/display/DOCS/Advanced+Queries). There are literarily tons of ways to search and ways to limit the query. Let's look at some simple code for dealing with queries in different ways. - -**the requires and and other initializing stuff omitted for brevity** - - db.open(function(err, db) { - if(!err) { - db.collection('test', function(err, collection) { - var docs = [{mykey:1}, {mykey:2}, {mykey:3}]; - - collection.insert(docs, {safe:true}, function(err, result) { - - collection.find().toArray(function(err, items) {}); - - var stream = collection.find({mykey:{$ne:2}}).streamRecords(); - stream.on("data", function(item) {}); - stream.on("end", function() {}); - - collection.findOne({mykey:1}, function(err, item) {}); - - }); - }); - }; - }); - -Before we start picking apart the code there is one thing that needs to be understood, the **find** method does not execute the actual query. It builds an instance of **Cursor** that you then use to retrieve the data. This lets you manage how you retrieve the data from Mongo DB and keeps state about your current Cursor state on Mongo DB. Now let's pick apart the queries we have here and look at what they do. - - collection.find().toArray(function(err, items) {}); - -This query will fetch all the document in the collection and return them as an array of items. Be careful with the function **toArray** as it might cause a lot of memory usage as it will instantiate all the document into memory before returning the final array of items. If you have a big resultset you could run into memory issues. - - var stream = collection.find({mykey:{$ne:2}}).streamRecords(); - stream.on("data", function(item) {}); - stream.on("end", function() {}); - -This is the preferred way if you have to retrieve a lot of data for streaming, as data is deserialized a **data** event is emitted. This keeps the resident memory usage low as the documents are streamed to you. Very useful if you are pushing documents out via websockets or some other streaming socket protocol. Once there is no more document the driver will emit the **end** event to notify the application that it's done. - - collection.findOne({mykey:1}, function(err, item) {}); - -This is special supported function to retrieve just one specific document bypassing the need for a cursor object. - -That's pretty much it for the quick intro on how to use the database. I have also included a list of links to where to go to find more information and also a sample crude location application I wrote using express JS and mongo DB. - -## Links and stuff -* [The driver examples, good starting point for basic usage](https://github.com/christkv/node-mongodb-native/tree/master/examples) -* [All the integration tests, they have tons of different usage cases](https://github.com/christkv/node-mongodb-native/tree/master/test) -* [The Mongo DB wiki pages such as the advanced query link](http://www.mongodb.org/display/DOCS/Advanced+Queries) -* [A silly simple location based application using Express JS and Mongo DB](https://github.com/christkv/mongodb-hamburg) - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/articles/NodeKOArticle2.md b/docs/articles/NodeKOArticle2.md deleted file mode 100644 index f84fef5ef39..00000000000 --- a/docs/articles/NodeKOArticle2.md +++ /dev/null @@ -1,199 +0,0 @@ -# A primer for GridFS using the Mongo DB driver -In the first tutorial we targeted general usage of the database. But Mongo DB is much more than this. One of the additional very useful features is to act as a file storage system. This is accomplish in Mongo by having a file collection and a chunks collection where each document in the chunks collection makes up a **Block** of the file. In this tutorial we will look at how to use the GridFS functionality and what functions are available. - -## A simple example -Let's dive straight into a simple example on how to write a file to the grid using the simplified Grid class. - - var mongo = require('mongodb'), - Server = mongo.Server, - Db = mongo.Db, - Grid = mongo.Grid; - - var server = new Server('localhost', 27017, {auto_reconnect: true}); - var db = new Db('exampleDb', server); - - db.open(function(err, db) { - if(!err) { - var grid = new Grid(db, 'fs'); - var buffer = new Buffer("Hello world"); - grid.put.(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) { - if(!err) { - console.log("Finished writing file to Mongo"); - } - }); - } - }); - -All right let's dissect the example. The first thing you'll notice is the statement - - var grid = new Grid(db, 'fs'); - -Since GridFS is actually a special structure stored as collections you'll notice that we are using the db connection that we used in the previous tutorial to operate on collections and documents. The second parameter **'fs'** allows you to change the collections you want to store the data in. In this example the collections would be **fs_files** and **fs_chunks**. - -Having a life grid instance we now go ahead and create some test data stored in a Buffer instance, although you can pass in a string instead. We then write our data to disk. - - var buffer = new Buffer("Hello world"); - grid.put.(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) { - if(!err) { - console.log("Finished writing file to Mongo"); - } - }); - -Let's deconstruct the call we just made. The **put** call will write the data you passed in as one or more chunks. The second parameter is a hash of options for the Grid class. In this case we wish to annotate the file we are writing to Mongo DB with some metadata and also specify a content type. Each file entry in GridFS has support for metadata documents which might be very useful if you are for example storing images in you Mongo DB and need to store all the data associated with the image. - -One important thing is to take not that the put method return a document containing a **_id**, this is an **ObjectID** identifier that you'll need to use if you wish to retrieve the file contents later. - -Right so we have written out first file, let's look at the other two simple functions supported by the Grid class. - -**the requires and and other initializing stuff omitted for brevity** - - db.open(function(err, db) { - if(!err) { - var grid = new Grid(db, 'fs'); - var buffer = new Buffer("Hello world"); - grid.put.(buffer, {metadata:{category:'text'}, content_type: 'text'}, function(err, fileInfo) { - grid.get(fileInfo._id, function(err, data) { - console.log("Retrieved data: " + data.toString()); - grid.delete(fileInfo._id, function(err, result) { - }); - }); - }); - } - }); - -Let's have a look at the two operations **get** and **delete** - - grid.get(fileInfo._id, function(err, data) {}); - -The **get** method takes an ObjectID as the first argument and as we can se in the code we are using the one provided in **fileInfo._id**. This will read all the chunks for the file and return it as a Buffer object. - -The **delete** method also takes an ObjectID as the first argument but will delete the file entry and the chunks associated with the file in Mongo. - -This **api** is the simplest one you can use to interact with GridFS but it's not suitable for all kinds of files. One of it's main drawbacks is you are trying to write large files to Mongo. This api will require you to read the entire file into memory when writing and reading from Mongo which most likely is not feasible if you have to store large files like Video or RAW Pictures. Luckily this is not the only way to work with GridFS. That's not to say this api is not useful. If you are storing tons of small files the memory usage vs the simplicity might be a worthwhile tradeoff. Let's dive into some of the more advanced ways of using GridFS. - -## Advanced GridFS or how not to run out of memory -As we just said controlling memory consumption for you file writing and reading is key if you want to scale up the application. That means not reading in entire files before either writing or reading from Mongo DB. The good news it's supported. Let's throw some code out there straight away and look at how to do chunk sized streaming writes and reads. - -**the requires and and other initializing stuff omitted for brevity** - - var fileId = new ObjectID(); - var gridStore = new GridStore(db, fileId, "w", {root:'fs'}); - gridStore.chunkSize = 1024 * 256; - - gridStore.open(function(err, gridStore) { - Step( - function writeData() { - var group = this.group(); - - for(var i = 0; i < 1000000; i += 5000) { - gridStore.write(new Buffer(5000), group()); - } - }, - - function doneWithWrite() { - gridStore.close(function(err, result) { - console.log("File has been written to GridFS"); - }); - } - ) - }); - -Before we jump into picking apart the code let's look at - - var gridStore = new GridStore(db, fileId, "w", {root:'fs'}); - -Notice the parameter **"w"** this is important. It tells the driver that you are planning to write a new file. The parameters you can use here are. - - * **"r"** - read only. This is the default mode - * **"w"** - write in truncate mode. Existing data will be overwritten - * **"w+"** - write in edit mode - -Right so there is a fair bit to digest here. We are simulating writing a file that's about 1MB big to Mongo DB using GridFS. To do this we are writing it in chunks of 5000 bytes. So to not live with a difficult callback setup we are using the Step library with its' group functionality to ensure that we are notified when all of the writes are done. After all the writes are done Step will invoke the next function (or step) called **doneWithWrite** where we finish up by closing the file that flushes out any remaining data to Mongo DB and updates the file document. - -As we are doing it in chunks of 5000 bytes we will notice that memory consumption is low. This is the trick to write large files to GridFS. In pieces. Also notice this line. - - gridStore.chunkSize = 1024 * 256; - -This allows you to adjust how big the chunks are in bytes that Mongo DB will write. You can tune the Chunk Size to your needs. If you need to write large files to GridFS it might be worthwhile to trade of memory for CPU by setting a larger Chunk Size. - -Now let's see how the actual streaming read works. - - var gridStore = new GridStore(db, fileId, "r"); - gridStore.open(function(err, gridStore) { - var stream = gridStore.stream(true); - - stream.on("data", function(chunk) { - console.log("Chunk of file data"); - }); - - stream.on("end", function() { - console.log("EOF of file"); - }); - - stream.on("close", function() { - console.log("Finished reading the file"); - }); - }); - -Right let's have a quick lock at the streaming functionality supplied with the driver **(make sure you are using 0.9.6-12 or higher as there is a bug fix for custom chunksizes that you need)** - - var stream = gridStore.stream(true); - -This opens a stream to our file, you can pass in a boolean parameter to tell the driver to close the file automatically when it reaches the end. This will fire the **close** event automatically. Otherwise you'll have to handle cleanup when you receive the **end** event. Let's have a look at the events supported. - - stream.on("data", function(chunk) { - console.log("Chunk of file data"); - }); - -The **data** event is called for each chunk read. This means that it's by the chunk size of the written file. So if you file is 1MB big and the file has chunkSize 256K then you'll get 4 calls to the event handler for **data**. The chunk returned is a **Buffer** object. - - stream.on("end", function() { - console.log("EOF of file"); - }); - -The **end** event is called when the driver reaches the end of data for the file. - - stream.on("close", function() { - console.log("Finished reading the file"); - }); - -The **close** event is only called if you the **autoclose** parameter on the **gridStore.stream** method as shown above. If it's false or not set handle cleanup of the streaming in the **end** event handler. - -Right that's it for writing to GridFS in an efficient Manner. I'll outline some other useful function on the Gridstore object. - -## Other useful methods on the Gridstore object -There are some other methods that are useful - - gridStore.writeFile(filename/filedescriptor, function(err fileInfo) {}); - -**writeFile** takes either a file name or a file descriptor and writes it to GridFS. It does this in chunks to ensure the Eventloop is not tied up. - - gridStore.read(length, function(err, data) {}); - -**read/readBuffer** lets you read a #length number of bytes from the current position in the file. - - gridStore.seek(position, seekLocation, function(err, gridStore) {}); - -**seek** lets you navigate the file to read from different positions inside the chunks. The seekLocation allows you to specify how to seek. It can be one of three values. - -* GridStore.IO_SEEK_SET Seek mode where the given length is absolute -* GridStore.IO_SEEK_CUR Seek mode where the given length is an offset to the current read/write head -* GridStore.IO_SEEK_END Seek mode where the given length is an offset to the end of the file - - GridStore.list(dbInstance, collectionName, {id:true}, function(err, files) {}) - -**list** lists all the files in the collection in GridFS. If you have a lot of files the current version will not work very well as it's getting all files into memory first. You can have it return either the filenames or the ids for the files using option. - - gridStore.unlink(function(err, result) {}); - -**unlink** deletes the file from Mongo DB, that's to say all the file info and all the chunks. - -This should be plenty to get you on your way building your first GridFS based application. As in the previous article the following links might be useful for you. Good luck and have fun. - -## Links and stuff -* [The driver examples, good starting point for basic usage](https://github.com/christkv/node-mongodb-native/tree/master/examples) -* [All the integration tests, they have tons of different usage cases](https://github.com/christkv/node-mongodb-native/tree/master/test) - - - - diff --git a/docs/collections.md b/docs/collections.md deleted file mode 100644 index 7180e30fc75..00000000000 --- a/docs/collections.md +++ /dev/null @@ -1,117 +0,0 @@ -Collections -=========== - -See also: - - * [Database](database.md) - * [Queries](queries.md) - -## Collection objects - -Collection object is a pointer to a specific collection in the [database](database.md). If you want to [insert](insert.md) new records or -[query](queries.md) existing ones then you need to have a valid collection object. - -**NB** Collection names can't start or end with a period nor contain a dollar sign! (`.tes$t` is not allowed) - -## Creating collections - -Collections can be created with `createCollection` - - db.createCollection([[name[, options]], callback) - -where `name` is the name of the collection, options a set of configuration parameters and `callback` is a callback function. `db` is the database object. - -The first parameter for the callback is the error object (null if no error) and the second one is the pointer to the newly created collection. If strict mode is on and the table exists, the operation yields in error. With strict mode off (default) the function simple returns the pointer to the existing collection and does not truncate it. - - db.createCollection("test", function(err, collection){ - collection.insert({"test":"value"}); - }); - -## Creating collections options -Several options can be passed to the `createCollection` function with `options` parameter. - - * `raw` - driver returns documents as bson binary Buffer objects, `default:false` - -### Collection properties - - * `collectionName` is the name of the collection (not including the database name as a prefix) - * `db` is the pointer to the corresponding databse object - -Example of usage: - - console.log("Collection name: "+collection.collectionName) - -## List existing collections - -### List names - -Collections can be listed with `collectionNames` - - db.collectionNames(callback); - -`callback` gets two parameters - an error object (if error occured) and an array of collection names as strings. - -Collection names also include database name, so a collection named `posts` in a database `blog` will be listed as `blog.posts`. - -Additionally there's system collections which should not be altered without knowing exactly what you are doing, these sollections can be identified with `system` prefix. For example `posts.system.indexes`. - -Example: - - var mongodb = require("mongodb"), - mongoserver = new mongodb.Server("localhost"), - db_connector = new mongodb.Db("blog", mongoserver); - - db_connector.open(function(err, db){ - db.collectionNames(function(err, collections){ - console.log(collections); // ["blog.posts", "blog.system.indexes"] - }); - }); - -## List collections - -Collection objects can be listed with database method `collections` - - db.collections(callback) - -Where `callback` gets two parameters - an error object (if an error occured) and an array of collection objects. - -## Selecting collections - -Existing collections can be opened with `collection` - - db.collection([[name[, options]], callback); - -If strict mode is off, then a new collection is created if not already present. - -## Selecting collections options -Several options can be passed to the `collection` function with `options` parameter. - - * `raw` - driver returns documents as bson binary Buffer objects, `default:false` - -## Renaming collections - -A collection can be renamed with collection method `rename` - - collection.rename(new_name, callback); - -## Removing records from collections - -Records can be erased from a collection with `remove` - - collection.remove([[query[, options]], callback]); - -Where - - * `query` is the query that records to be removed need to match. If not set all records will be removed - * `options` indicate advanced options. For example use `{safe: true}` when using callbacks - * `callback` callback function that gets two parameters - an error object (if an error occured) and the count of removed records - -## Removing collections - -A collection can be dropped with `drop` - - collection.drop(callback); - -or with `dropCollection` - - db.dropCollection(collection_name, callback) \ No newline at end of file diff --git a/docs/database.md b/docs/database.md deleted file mode 100644 index ed14b85a324..00000000000 --- a/docs/database.md +++ /dev/null @@ -1,120 +0,0 @@ -Database -======== - -The first thing to do in order to make queries to the database is to open one. This can be done with the `Db` constructor. - - var mongodb = require("mongodb"), - mongoserver = new mongodb.Server(host, port, server_options), - db_connector = new mongodb.Db(name, mongoserver, db_options); - - db_connector.open(callback); - -* `host` is a server hostname or IP -* `port` is a MongoDB port, use `mongodb.Connection.DEFAULT_PORT` for default (27017) -* `server_options` see *Server options* -* `name` is the databse name that needs to be opened, database will be created automatically if it doesn't yet exist -* `db_options` see *DB options* - -## Server options -Several options can be passed to the `Server` constructor with `options` parameter. - -* `auto_reconnect` - to reconnect automatically, `default:false` -* `poolSize` - specify the number of connections in the pool `default:1` -* `socketOptions` - a collection of pr socket settings - -## Socket options -Several options can be set for the `socketOptions`. - -* `timeout` = set seconds before connection times out `default:0` -* `noDelay` = Disables the Nagle algorithm `default:true` -* `keepAlive` = Set if keepAlive is used `default:0`, which means no keepAlive, set higher than 0 for keepAlive -* `encoding` = 'ascii'|'utf8'|'base64' `default:null` - -## DB options - -Several options can be passed to the `Db` constructor with `options` parameter. - -* `native_parser` - if true, use native BSON parser -* `strict` - sets *strict mode*, if true then existing collections can't be "recreated" etc. -* `pk` - custom primary key factory to generate `_id` values (see Custom primary keys). -* `forceServerObjectId` - generation of objectid is delegated to the mongodb server instead of the driver. default is false -* `retryMiliSeconds` - specify the number of milliseconds between connection attempts `default:5000` -* `numberOfRetries` - specify the number of retries for connection attempts `default:3` -* `reaper` - enable/disable reaper (true/false) `default:false` -* `reaperInterval` - specify the number of milliseconds between each reaper attempt `default:10000` -* `reaperTimeout` - specify the number of milliseconds for timing out callbacks that don't return `default:30000` -* `raw` - driver expects Buffer raw bson document, `default:false` - -## Opening a database - -Database can be opened with Db method `open`. - - db_connector.open(callback); - -`callback` is a callback function which gets 2 parameters - an error object (or null, if no errors occured) and a database object. - -Resulting database object can be used for creating and selecting [collections](collections.md). - - db_connector.open(function(err, db){ - db.collection(...); - }); - -### Database properties - -* `databaseName` is the name of the database -* `serverConfig` includes information about the server (`serverConfig.host`, `serverConfig.port` etc.) -* `state` indicates if the database is connected or not -* `strict` indicates if *strict mode* is on (true) or off (false, default) -* `version` indicates the version of the MongoDB database - -### Database events - -* `close` to indicate that the connection to the database was closed - -For example - - db.on("close", function(error){ - console.log("Connection to the database was closed!"); - }); - -NB! If `auto_reconnect` was set to true when creating the server, then the connection will be automatically reopened on next database operation. Nevertheless the `close` event will be fired. - -## Sharing the connections over multiple dbs - -To share the connection pool across multiple databases you database instance has method `db` - - db_connector.db(name) - -this returns a new `db` instance that shares the connections off the previous instance but will send all commands to the database `name`. This allows for better control of resource usage in a multiple database scenario. - -## Deleting a database - -To delete a database you need a pointer to it first. Deletion can be done with method `dropDatabase`. - - db_connector.open(function(err, db){ - db.dropDatabase() - }); - -## Custom primary keys - -Every record in the database has an unique primary key called `_id`. Default primary keys are 12 byte hashes but a custom key generator can be used for something else. If you set `_id` "by hand" when inserting records then you can use whatever you want, primary key factory generates `_id` values only for records without ones. - -Example 1: No need to generate primary key, as its already defined: - - collection.insert({name:"Daniel", _id:"12345"}); - -Example 2: No primary key, so it needs to be generated before save: - - collectionn.insert({name:"Daniel"}); - -Custom primary key factory is actually an object with method `createPK` which returns a primary key. The context (value for `this`) for `createPK` is left untouched. - - var CustomPKFactory = { - counter:0, - createPk: function() { - return ++this.counter; - } - } - - db_connector = new mongodb.Db(name, mongoserver, {pk: CustomPKFactory}); - diff --git a/docs/gridfs.md b/docs/gridfs.md deleted file mode 100644 index 2edad692cd5..00000000000 --- a/docs/gridfs.md +++ /dev/null @@ -1,135 +0,0 @@ -GridStore -====== - -GridFS is a scalable MongoDB *filesystem* for storing and retrieving large files. The default limit for a MongoDB record is 16MB, so to store data that is larger than this limit, GridFS can be used. GridFS shards the data into smaller chunks automatically. See [MongoDB documentation](http://www.mongodb.org/display/DOCS/GridFS+Specification) for details. - -GridStore is a single file inside GridFS that can be managed by the script. - -## Open GridStore - -Opening a GridStore (a single file in GridFS) is a bit similar to opening a database. At first you need to create a GridStore object and then `open` it. - - var gs = new mongodb.GridStore(db, filename, mode[, options]) - -Where - - * `db` is the database object - * `filename` is the name of the file in GridFS that needs to be accessed/created - * `mode` indicated the operaion, can be one of: - * "r" (Read): Looks for the file information in fs.files collection, or creates a new id for this object. - * "w" (Write): Erases all chunks if the file already exist. - * "w+" (Append): Finds the last chunk, and keeps writing after it. - * `options` can be used to specify some metadata for the file, for example `content_type`, `metadata` and `chunk_size` - -Example: - - var gs = new mongodb.GridStore(db, "test.png", "w", { - "content_type": "image/png", - "metadata":{ - "author": "Daniel" - }, - "chunk_size": 1024*4 - }); - -When GridStore object is created, it needs to be opened. - - gs.open(callback); - -`callback` gets two parameters - and error object (if error occured) and the GridStore object. - -Opened GridStore object has a set of useful properties - - * `gs.length` - length of the file in bytes - * `gs.contentType` - the content type for the file - * `gs.uploadDate` - when the file was uploaded - * `gs.metadata` - metadata that was saved with the file - * `gs.chunkSize` - chunk size - -Example - - gs.open(function(err, gs){ - console.log("this file was uploaded at "+gs.uploadDate); - }); - -## Writing to GridStore - -Writing can be done with `write` - - gs.write(data, callback) - -where `data` is a `Buffer` or a string, callback gets two parameters - an error object (if error occured) and result value which indicates if the write was successful or not. - -While the GridStore is not closed, every write is appended to the opened GridStore. - -## Writing a file to GridStore - -This functions opens the gridstore, streams the contents of the file into gridstore, and closes the gridstore. - - gs.writeFile( file, callback ) - -where - - * `file` is a file descriptior, or a string file path - * `callback` is a function with two parameters - error object (if error occured) and the GridStore object. - - -## Reading from GridStore - -Reading from GridStore can be done with `read` - - gs.read([size], callback) - -where - - * `size` is the length of the data to be read - * `callback` is a callback function with two parameters - error object (if an error occured) and data (binary string) - -## Streaming from GridStore - -You can stream data as it comes from the database using `stream` - - gs.stream([autoclose=false]) - -where - - * `autoclose` If true current GridStore will be closed when EOF and 'close' event will be fired - -The function returns [read stream](http://nodejs.org/docs/v0.4.12/api/streams.html#readable_Stream) based on this GridStore file. It supports the events 'read', 'error', 'close' and 'end'. - -## Delete a GridStore - -GridStore files can be unlinked with `unlink` - - mongodb.GridStore.unlink(db, name, callback) - -Where - - * `db` is the databse object - * `name` is either the name of a GridStore object or an array of GridStore object names - * `callback` is the callback function - -## Closing the GridStore - -GridStore needs to be closed after usage. This can be done with `close` - - gs.close(callback) - -## Check the existance of a GridStore file - -Checking if a file exists in GridFS can be done with `exist` - - mongodb.GridStore.exist(db, filename, callback) - -Where - - * `db` is the database object - * `filename` is the name of the file to be checked or a regular expression - * `callback` is a callback function with two parameters - an error object (if an error occured) and a boolean value indicating if the file exists or not - -## Seeking in a GridStore - -Seeking can be done with `seek` - - gs.seek(position); - -This function moves the internal pointer to the specified position. \ No newline at end of file diff --git a/docs/indexes.md b/docs/indexes.md deleted file mode 100644 index 8e65a3e0094..00000000000 --- a/docs/indexes.md +++ /dev/null @@ -1,73 +0,0 @@ -Indexes -======= - -Indexes are needed to make queries faster. For example if you need to find records by a field named *username* and the field has a related index set, then the query will be a lot faster compared to if the index was not present. - -See [MongoDB documentation](http://www.mongodb.org/display/DOCS/Indexes) for details. - -## Create indexes with createIndex() - -`createIndex` adds a new index to a collection. For checking if the index was already set, use `ensureIndex` instead. - - collection.createIndex(index[, options], callback) - -or - - db.createIndex(collectionname, index[, options], callback) - -where - - * `index` is the field or fields to be indexed. See *index field* - * `options` are options, for example `{sparse: true}` to include only records that have indexed field set or `{unique: true}` for unique indexes. If the `options` is a boolean value, then it indicates if it's an unique index or not. - * `callback` gets two parameters - an error object (if an error occured) and the name for the newly created index - -## Ensure indexes with ensureIndex() - -Same as `createIndex` with the difference that the index is checked for existence before adding to avoid duplicate indexes. - -## Index field - -Index field can be a simple string like `"username"` to index certain field (in this case, a field named as *username*). - - collection.ensureIndex("username",callback) - -It is possible to index fields inside nested objects, for example `"user.firstname"` to index field named *firstname* inside a document named *user*. - - collection.ensureIndex("user.firstname",callback) - -It is also possible to create mixed indexes to include several fields at once. - - collection.ensureIndex({firstname:1, lastname:1}, callback) - -or with tuples - - collection.ensureIndex([["firstname", 1], ["lastname", 1]], callback) - -The number value indicates direction - if it's 1, then it is an ascending value, if it's -1 then it's descending. For example if you have documents with a field *date* and you want to sort these records in descending order then you might want to add corresponding index - - collection.ensureIndex({date:-1}, callback) - -## Remove indexes with dropIndex() - -All indexes can be dropped at once with `dropIndexes` - - collection.dropIndexes(callback) - -`callback` gets two parameters - an error object (if an error occured) and a boolean value true if operation succeeded. - -## Get index information with indexInformation() - -`indexInformation` can be used to fetch some useful information about collection indexes. - - collection.indexInformation(callback) - -Where `callback` gets two parameters - an error object (if an error occured) and an index information object. - -The keys in the index object are the index names and the values are tuples of included fields. - -For example if a collection has two indexes - as a default an ascending index for the `_id` field and an additonal descending index for `"username"` field, then the index information object would look like the following - - { - "_id":[["_id", 1]], - "username_-1":[["username", -1]] - } \ No newline at end of file diff --git a/docs/insert.md b/docs/insert.md deleted file mode 100644 index bcbf16e49f5..00000000000 --- a/docs/insert.md +++ /dev/null @@ -1,124 +0,0 @@ -Inserting and updating -====================== - -See also: - - * [Database](database.md) - * [Collections](collections.md) - -## Insert - -Records can be inserted to a collection with `insert` - - collection.insert(docs[, options, callback]) - -Where - - * `docs` is a single document object or an array of documents - * `options` is an object of parameters, if you use a callback, set `safe` to true - this way the callback is executed *after* the record is saved to the database, if `safe` is false (default) callback is fired immediately and thus doesn't make much sense. - * `callback` - callback function to run after the record is inserted. Set `safe` to true in `options` when using callback. First parameter for callback is the error object (if an error occured) and the second is an array of records inserted. - -For example - - var document = {name:"David", title:"About MongoDB"}; - collection.insert(document, {safe: true}, function(err, records){ - console.log("Record added as "+records[0]._id); - }); - -If trying to insert a record with an existing `_id` value, then the operation yields in error. - - collection.insert({_id:1}, {safe:true}, function(err, doc){ - // no error, inserted new document, with _id=1 - collection.insert({_id:1}, {safe:true}, function(err, doc){ - // error occured since _id=1 already existed - }); - }); - -## Save - -Shorthand for insert/update is `save` - if `_id` value set, the record is updated if it exists or inserted if it does not; if the `_id` value is not set, then the record is inserted as a new one. - - collection.save({_id:"abc", user:"David"},{safe:true}, callback) - -`callback` gets two parameters - an error object (if an error occured) and the record if it was inserted or `1` if the record was updated. - -## Update - -Updates can be done with `update` - - collection.update(criteria, update[, options[, callback]]); - -Where - - * `criteria` is a query object to find records that need to be updated (see [Queries](queries.md)) - * `update` is the replacement object - * `options` is an options object (see below) - * `callback` is the callback to be run after the records are updated. Has two parameters, the first is an error object (if error occured), the second is the count of records that were modified. - -### Update options - -There are several option values that can be used with an update - - * `safe` - run callback only after the update is done, defaults to false - * `multi` - update all records that match the query object, default is false (only the first one found is updated) - * `upsert` - if true and no records match the query, insert `update` as a new record - * `raw` - driver returns updated document as bson binary Buffer, `default:false` - -### Replacement object - -If the replacement object is a document, the matching documents will be replaced (except the `_id` values if no `_id` is set). - - collection.update({_id:"123"}, {author:"Jessica", title:"Mongo facts"}); - -The example above will replace the document contents of id=123 with the replacement object. - -To update only selected fields, `$set` operator needs to be used. Following replacement object replaces author value but leaves everything else intact. - - collection.update({_id:"123"}, {$set: {author:"Jessica"}}); - -See [MongoDB documentation](http://www.mongodb.org/display/DOCS/Updating) for all possible operators. - -## Find and Modify - -To update and retrieve the contents for one single record you can use `findAndModify`. - - collection.findAndModify(criteria, sort, update[, options, callback]) - -Where - - * `criteria` is the query object to find the record - * `sort` indicates the order of the matches if there's more than one matching record. The first record on the result set will be used. See [Queries->find->options->sort](queries.md) for the format. - * `update` is the replacement object - * `options` define the behavior of the function - * `callback` is the function to run after the update is done. Has two parameters - error object (if error occured) and the record that was updated. - -### Options - -Options object can be used for the following options: - - * `remove` - if set to true (default is false), removes the record from the collection. Callback function still gets the object but it doesn't exist in the collection any more. - * `new` - if set to true, callback function returns the modified record. Default is false (original record is returned) - * `upsert` - if set to true and no record matched to the query, replacement object is inserted as a new record - -### Example - - var mongodb = require('mongodb'), - server = new mongodb.Server("127.0.0.1", 27017, {}); - - new mongodb.Db('test', server, {}).open(function (error, client) { - if (error) throw error; - var collection = new mongodb.Collection(client, 'test_collection'); - collection.findAndModify( - {hello: 'world'}, // query - [['_id','asc']], // sort order - {$set: {hi: 'there'}}, // replacement, replaces only the field "hi" - {}, // options - function(err, object) { - if (err){ - console.warn(err.message); // returns error if no matching object found - }else{ - console.dir(object); - } - }); - }); - \ No newline at end of file diff --git a/docs/queries.md b/docs/queries.md deleted file mode 100644 index bad927b4e78..00000000000 --- a/docs/queries.md +++ /dev/null @@ -1,271 +0,0 @@ -Queries -======= - -See also: - - * [Database](database.md) - * [Collections](collections.md) - -## Making queries with find() - -[Collections](collections.md) can be queried with `find`. - - collection.find(query[[[, fields], options], callback]); - -Where - - * `query` - is a query object, defining the conditions the documents need to apply - * `fields` - indicates which fields should be included in the response (default is all) - * `options` - defines extra logic (sorting options, paging etc.) - * `raw` - driver returns documents as bson binary Buffer objects, `default:false` - -The result for the query is actually a cursor object. This can be used directly or converted to an array. - - var cursor = collection.find({}); - cursor.each(...); - -To indicate which fields must or must no be returned `fields` value can be used. For example the following `fields` value - - { - "name": true, - "title": true - } - -retrieves fields `name` and `title` (and as a default also `_id`) but not any others. - -## Find first occurence with findOne() - -`findOne` is a convinence method finding and returning the first match of a query while regular `find` returns a cursor object instead. Use it when you expect only one record, for example when querying with `_id` or another unique property. - - collection.findOne([query], callback) - -Where - - * `query` is a query object or an `_id` value - * `callback` has two parameters - an error object (if an error occured) and the document object. - -Example: - - collection.findOne({_id: doc_id}, function(err, document) { - console.log(document.name); - }); - -## _id values - -Default `_id` values are 12 byte binary hashes. You can alter the format with custom Primary Key factories (see *Custom Primarky Keys* in [Database](database.md)). - -In order to treat these binary _id values as strings it would be wise to convert binary values to hex strings. This can be done with `toHexString` property. - - var idHex = document._id.toHexString(); - -Hex strings can be reverted back to binary (for example to perform queries) with `ObjectID.createFromHexString` - - {_id: ObjectID.createFromHexString(idHex)} - -When inserting new records it is possible to use custom `_id` values as well which do not need to be binary hashes, for example strings. - - collection.insert({_id: "abc", ...}); - collection.findOne({_id: "abc"},...); - -This way it is not necessary to convert `_id` values to hex strings and back. - -## Query object - -The simplest query object is an empty one `{}` which matches every record in the database. - -To make a simple query where one field must match to a defined value, one can do it as simply as - - {fieldname: "fieldvalue"} - -This query matches all the records that a) have fields called *fieldname* and b) its value is *"fieldvalue"*. - -For example if we have a collection of blog posts where the structure of the records is `{title, author, contents}` and we want to retrieve all the posts for a specific author then we can do it like this: - - posts = pointer_to_collection; - posts.find({author:"Daniel"}).toArray(function(err, results){ - console.log(results); // output all records - }); - -If the queried field is inside an object then that can be queried also. For example if we have a record with the following structure: - - { - user: { - name: "Daniel" - } - } - -Then we can query the "name" field like this: `{"user.name":"Daniel"}` - -### AND - -If more than one fieldname is specified, then it's an AND query - - { - key1: "value1", - name2: "value2" - } - -Whis query matches all records where *key1* is *"value1"* and *key2* is *"value2"* - -### OR - -OR queries are a bit trickier but doable with the `$or` operator. Query operator takes an array which includes a set of query objects and at least one of these must match a document before it is retrieved - - { - $or:[ - {author:"Daniel"}, - {author:"Jessica"} - ] - } - -This query match all the documents where author is Daniel or Jessica. - -To mix AND and OR queries, you just need to use $or as one of regular query fields. - - { - title:"MongoDB", - $or:[ - {author:"Daniel"}, - {author:"Jessica"} - ] - } - -### Conditionals - -Conditional operators `<`, `<=`, `>`, `>=` and `!=` can't be used directly, as the query object format doesn't support it but the same can be achieved with their aliases `$lt`, `$lte`, `$gt`, `$gte` and `$ne`. When a field value needs to match a conditional, the value must be wrapped into a separate object. - - {"fieldname":{$gte:100}} - -This query defines that *fieldname* must be greater than or equal to `100`. - -Conditionals can also be mixed to create ranges. - - {"fieldname": {$lte:10, $gte:100}} - -### Regular expressions in queries - -Queried field values can also be matched with regular expressions - - {author:/^Daniel/} - -### Special query operators - -In addition to OR and conditional there's some more operators: - - * `$in` - specifies an array of possible matches, `{"name":{$in:[1,2,3]}}` - * `$nin` - specifies an array of unwanted matches - * `$all` - array value must match to the condition `{"name":{$all:[1,2,3]}}` - * `$exists` - checks for existence of a field `{"name":{$exists:true}}` - * `$mod` - check for a modulo `{"name":{$mod:{3,2}}` is the same as `"name" % 3 == 2` - * `$size` - checks the size of an array value `{"name": {$size:2}}` matches arrays *name* with 2 elements - - -## Queries inside objects and arrays - -If you have a document with nested objects/arrays then the keys inside these nested objects can still be used for queries. - -For example with the following document - - { - "_id": idvalue, - "author":{ - "firstname":"Daniel", - "lastname": "Defoe" - }, - "books":[ - { - "title":"Robinson Crusoe" - "year": 1714 - } - ] - } - -not only the `_id` field can be used as a query field - also the `firstname` and even `title` can be used. This can be done when using nested field names as strings, concated with periods. - - collection.find({"author.firstname":"Daniel}) - -Works even inside arrays - - collection.find({"books.year":1714}) - -## Query options - -Query options define the behavior of the query. - - var options = { - "limit": 20, - "skip": 10, - "sort": title - } - - collection.find({}, options).toArray(...); - -### Paging - -Paging can be achieved with option parameters `limit` and `skip` - - { - "limit": 20, - "skip" 10 - } - -retrieves 10 elements starting from 20 - -### Sorting - -Sorting can be acieved with option parameter `sort` which takes an array of sort preferences - - { - "sort": [['field1','asc'], ['field2','desc']] - } - -With single ascending field the array can be replaced with the name of the field. - - { - "sort": "name" - } - -### Explain - -Option parameter `explain` turns the query into an explain query. - -## Cursors - -Cursor objects are the results for queries and can be used to fetch individual fields from the database. - -### nextObject - -`cursor.nextObject(function(err, doc){})` retrieves the next record from database. If doc is null, then there weren't any more records. - -### each - -`cursor.each(function(err, doc){})` retrieves all matching records one by one. - -### toArray - -`cursor.toArray(function(err, docs){})` converts the cursor object into an array of all the matching records. Probably the most convenient way to retrieve results but be careful with large datasets as every record is loaded into memory. - - collection.find().toArray(function(err, docs){ - console.log("retrieved records:"); - console.log(docs); - }); - -### rewind - -`cursor.rewind()` resets the internal pointer in the cursor to the beginning. - -## Counting matches - -Counting total number of found matches can be done against cursors with method `count`. - - cursor.count(callback) - -Where - - * `callback` is the callback function with two parameters - an error object (if an error occured) and the number on matches as an integer. - -Example - - cursor.count(function(err, count){ - console.log("Total matches: "+count); - }); diff --git a/docs/replicaset.md b/docs/replicaset.md deleted file mode 100644 index 98f8c0bd00a..00000000000 --- a/docs/replicaset.md +++ /dev/null @@ -1,53 +0,0 @@ -Replicasets -=========== - -## Introduction - -Replica sets is the asynchronous master/slave replication added to Mongodb that takes care off all the failover and recovery for the member nodes. According to the mongodb documentation a replicaset is - -* Two or more nodes that are copies of each other -* Automatic assignment of a primary(master) node if none is available -* Drivers that automatically detect the new master and send writes to it - -More information at [Replicasets](http://www.mongodb.org/display/DOCS/Replica+Sets) - -## Driver usage - -To create a new replicaset follow the instructions on the mongodb site to setup the config and the replicaset instances. Then using the driver. - - var replSet = new ReplSetServers( [ - new Server( 127.0.0.1, 30000, { auto_reconnect: true } ), - new Server( 127.0.0.1, 30001, { auto_reconnect: true } ), - new Server( 127.0.0.1, 30002, { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Do you app stuff :) - }) - -The ReplSetSrvers object has the following parameters - - var replSet = new ReplSetSrvers(servers, options) - -Where - -* `servers` is an array of `Server` objects -* `options` can contain the following options - -## Replicaset options -Several options can be passed to the `Replicaset` constructor with `options` parameter. - -* `rs_name` is the name of the replicaset you configured when you started the server, you can have multiple replicasets running on your servers. -* `read_secondary` set's the driver to read from secondary servers (slaves) instead of only from the primary(master) server. -* `socketOptions` - a collection of pr socket settings - -## Socket options -Several options can be set for the `socketOptions`. - -* `timeout` = set seconds before connection times out `default:0` -* `noDelay` = Disables the Nagle algorithm `default:true` -* `keepAlive` = Set if keepAlive is used `default:0`, which means no keepAlive, set higher than 0 for keepAlive -* `encoding` = 'ascii'|'utf8'|'base64' `default:null` \ No newline at end of file diff --git a/docs/sphinx-docs/.gitignore b/docs/sphinx-docs/.gitignore deleted file mode 100644 index b636545b725..00000000000 --- a/docs/sphinx-docs/.gitignore +++ /dev/null @@ -1,7 +0,0 @@ -build/ -source/api-generated -source/api-bson-generated -source/api-articles -source/markdown-docs -source/changelog -source/github diff --git a/docs/sphinx-docs/Makefile b/docs/sphinx-docs/Makefile deleted file mode 100644 index 24a59a6cb5c..00000000000 --- a/docs/sphinx-docs/Makefile +++ /dev/null @@ -1,130 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -c ./ -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MongoDB.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MongoDB.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/MongoDB" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MongoDB" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/sphinx-docs/conf.py b/docs/sphinx-docs/conf.py deleted file mode 100644 index a246c9d547a..00000000000 --- a/docs/sphinx-docs/conf.py +++ /dev/null @@ -1,256 +0,0 @@ -# -*- coding: utf-8 -*- -# -# MongoDB documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 3 09:58:40 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.todo'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'contents' - -# General information about the project. -project = u'MongoDB Node.JS Driver' -copyright = u'2011, MongoDB Node.JS Team' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.9' -# The full version, including alpha/beta/rc tags. -release = '0.9.9.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes... -html_theme = 'mongodb' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['themes'] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = "source/static/logo-mongodb.png" - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['source/static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'MongoDBdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('contents', 'MongoDB.tex', u'MongoDB Node.JS Documentation', - u'MongoDB Node.JS Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'mongodb', u'MongoDB Node.JS Documentation', - [u'MongoDB Node.JS Team'], 1) -] - - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'MongoDB' -epub_author = u'MongoDB Node.JS Team' -epub_publisher = u'MongoDB Node.JS Team' -epub_copyright = u'2011, MongoDB Node.JS Team' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True diff --git a/docs/sphinx-docs/npm_dependent_packages.json b/docs/sphinx-docs/npm_dependent_packages.json deleted file mode 100644 index e2d537db84a..00000000000 --- a/docs/sphinx-docs/npm_dependent_packages.json +++ /dev/null @@ -1,266 +0,0 @@ -[ - { - "description" : "Node Web Toolkit, web framework with mongodb support", - "location": "github", - "url": "https://github.com/nwtjs/nwt", - "tag": "webframework" - }, - { - "description" : "ODM for MongoDB/Node.js with CoffeeScript", - "location": "github", - "url": "https://github.com/chrisgibson/noid", - "tag": "odm" - }, - { - "description" : "nodejs Content Repository implementation for mongodb", - "location": "github", - "url": "https://github.com/karacos/nocr-mongo", - "tag": "cms" - }, - { - "description" : "On-the-fly processing framework for Node.js and MongoDB.", - "location": "github", - "url": "https://github.com/scttnlsn/nettle", - "tag": "gridfs" - }, - { - "description" : "Node.JS MongoDB utility library with ORM-like functionality", - "location": "github", - "url": "https://github.com/LearnBoost/mongoose", - "tag": "odm" - }, - { - "description" : "The future layer for node-mongodb-native.", - "location": "github", - "url": "https://github.com/guileen/node-mongoskin", - "tag": "wrapper" - }, - { - "description" : "Use mongoDB like this: mongoq('mongodb://localhost/db').collection('users').find().toArray(function(error, docs){});", - "location": "github", - "url": "https://github.com/zzdhidden/mongoq", - "tag": "wrapper" - }, - { - "description" : "Model for MongoDB (Node.JS)", - "location": "github", - "url": "https://github.com/alexeypetrushin/mongo-model", - "tag": "odm" - }, - { - "description" : "Flexible non-magical layer for the nodejs MongoDB driver", - "location": "github", - "url": "https://github.com/masylum/mongolia", - "tag": "wrapper" - }, - { - "description" : "a simple mongo module that implements the mongo api", - "location": "github", - "url": "https://github.com/gett/mongojs", - "tag": "wrapper" - }, - { - "description" : "Thin wrapper around node-mongodb-native that provides a simpler alternative calling style and provides collection binding.", - "location": "github", - "url": "https://github.com/milewise/mongode", - "tag": "wrapper" - }, - { - "description" : "A wrapper for node-mongodb-native as close as possible to the command-line javascript driver. Why learn two interfaces?", - "location": "github", - "url": "https://github.com/idottv/node-mongodb-wrapper", - "tag": "wrapper" - }, - { - "description" : "REST Server for MongoDB (using node.js)", - "location": "github", - "url": "https://github.com/tdegrunt/mongodb-rest", - "tag": "rest" - }, - { - "description" : "Fixtures for mongodb", - "location": "github", - "url": "https://github.com/tdegrunt/mongodb-fixtures", - "tag": "test" - }, - { - "description" : "MongoDB expressions for fire.js", - "location": "github", - "url": "https://github.com/firebaseco/mongodb-expressions", - "tag": "odm" - }, - { - "description" : "Thin & clean async wrapper for mongodb ", - "location": "github", - "url": "https://github.com/zir/mongodb-async", - "tag": "wrapper" - }, - { - "description" : "MongoDB management web server boosted with nodejs & express", - "location": "github", - "url": "https://github.com/erhangundogan/mon4mongo", - "tag": "manage" - }, - { - "description" : "Node.js job queue backed by MongoDB", - "location": "github", - "url": "https://github.com/wereHamster/mojo", - "tag": "queue" - }, - { - "description" : "simplified mongodb-native api with middleware", - "location": "github", - "url": "https://github.com/ritch/mdoq-mongodb", - "tag": "wrapper" - }, - { - "description" : "LogMeUp Server - View any log files real-time in your web browser.", - "location": "github", - "url": "https://github.com/jprichardson/logmeup-server", - "tag": "logging" - }, - { - "description" : "A MongoDB ORM for Node", - "location": "github", - "url": "https://github.com/colladow/leaf", - "tag": "odm" - }, - { - "description" : "Node.js RESTful web framework.", - "location": "github", - "url": "https://github.com/streets-ahead/lazyBum", - "tag": "rest" - }, - { - "description" : "A ridiculously simple queuing system, with clients in various languages, built on top of MongoDB.", - "location": "github", - "url": "https://github.com/bcoe/karait", - "tag": "queue" - }, - { - "description" : "Informant is a lightweight way to monitor server resources in real-time. It can be used as an Express.JS middleware or standalone. ", - "location": "github", - "url": "https://github.com/base698/Informant", - "tag": "monitoring" - }, - { - "description" : "A lightweight, resource-based API framework for node.js ", - "location": "github", - "url": "https://github.com/Qard/GECK", - "tag": "rest" - }, - { - "description" : "Adorable mongodb library for node.js", - "location": "github", - "url": "https://github.com/Coreh/ferret", - "tag": "wrapper" - }, - { - "description" : "EventStore Implementation in node.js", - "location": "github", - "url": "https://github.com/KABA-CCEAC/nodeEventStore", - "tag": "logging" - }, - { - "description" : "Easy MongoDB", - "location": "github", - "url": "https://github.com/meritt/easymongo", - "tag": "wrapper" - }, - { - "description" : "A media sharing framework.", - "location": "github", - "url": "https://github.com/khwang/DJS", - "tag": "framework" - }, - { - "description" : "dialect-http is a web client to manage your dialect translations.", - "location": "github", - "url": "https://github.com/masylum/dialect-http", - "tag": "translation" - }, - { - "description" : "Dialect is a painless nodejs module to manage your translations.", - "location": "github", - "url": "https://github.com/masylum/dialect", - "tag": "translation" - }, - { - "description" : "dev/null, a powerful logging module for Node.js.. Because logging to dev/null is fast! <3", - "location": "github", - "url": "https://github.com/observing/devnull", - "tag": "logging" - }, - { - "description" : "The simplest way to clean your database after tests", - "location": "github", - "url": "https://github.com/emerleite/node-database-cleaner", - "tag": "test" - }, - { - "description" : "NoSQL abstraction layer for Node.js ", - "location": "github", - "url": "https://github.com/evanp/databank", - "tag": "framework" - }, - { - "description" : "Cube: A system for time series visualization.", - "location": "github", - "url": "https://github.com/square/cube", - "tag": "analytics" - }, - { - "description" : "MongoDB Session Storage for Connect Middleware", - "location": "github", - "url": "https://github.com/bartt/connect-session-mongo", - "tag": "connect" - }, - { - "description" : "SessionStorage for connect's session middleware", - "location": "github", - "url": "https://github.com/masylum/connect-mongodb", - "tag": "connect" - }, - { - "description" : "MongoDB session store for Connect", - "location": "github", - "url": "https://github.com/kcbanner/connect-mongo", - "tag": "connect" - }, - { - "description" : "Simple continuous integration server written with NodeJS and CoffeeScript ", - "location": "github", - "url": "https://github.com/ryankee/concrete", - "tag": "continuosintegration" - }, - { - "description" : "Calipso is a simple NodeJS content management system based on Express, Connect & Mongoose.", - "location": "github", - "url": "https://github.com/cliftonc/calipso", - "tag": "cms" - }, - { - "description" : "Coffeescript-happy express-based server-side MVC framework loosely based on rails ", - "location": "github", - "url": "https://github.com/mattinsler/caboose", - "tag": "webframework" - }, - { - "description" : "file based static website/blog generator", - "location": "github", - "url": "https://github.com/pvorb/node-bread", - "tag": "webframework" - }, - { - "description" : "HTTP and WebSocket application routing", - "location": "github", - "url": "https://github.com/tjanczuk/arrjs", - "tag": "webframework" - }, - { - "description" : "standard blog written in nodejs (express) and mongodb ", - "location": "github", - "url": "https://github.com/dynamicguy/node-mongo-cms", - "tag": "example" - } -] diff --git a/docs/sphinx-docs/source/index.rst b/docs/sphinx-docs/source/index.rst deleted file mode 100644 index 3767bf14b7b..00000000000 --- a/docs/sphinx-docs/source/index.rst +++ /dev/null @@ -1,50 +0,0 @@ -================================= -The Node.JS MongoDB Driver Manual -================================= - -Usage ------ - -.. toctree:: - :maxdepth: 1 - - markdown-docs/index - -Tutorials ---------- - -.. toctree:: - :maxdepth: 3 - - api-articles/index - -API Documentation ------------------ - -.. toctree:: - :maxdepth: 2 - - api-generated/index - api-bson-generated/index - -Projects and Libraries using the driver ---------------------------------------- - -.. toctree:: - :maxdepth: 1 - - github/github - -Changelog ---------- - -.. toctree:: - :maxdepth: 1 - - changelog/changelog - -Indices -------- - -- :ref:`genindex` -- :ref:`search` \ No newline at end of file diff --git a/docs/sphinx-docs/templates/.mongodb b/docs/sphinx-docs/templates/.mongodb deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/sphinx-docs/themes/mongodb/globaltoc.html b/docs/sphinx-docs/themes/mongodb/globaltoc.html deleted file mode 100644 index e8e068a4dbb..00000000000 --- a/docs/sphinx-docs/themes/mongodb/globaltoc.html +++ /dev/null @@ -1,12 +0,0 @@ -{# - basic/globaltoc.html - ~~~~~~~~~~~~~~~~~~~~ - - Sphinx sidebar template: global table of contents. - - :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} - -

        {{ _('Core Documentation') }}

        -{{ toctree(maxdepth=3) }} diff --git a/docs/sphinx-docs/themes/mongodb/layout.html b/docs/sphinx-docs/themes/mongodb/layout.html deleted file mode 100644 index a05fd9d49f1..00000000000 --- a/docs/sphinx-docs/themes/mongodb/layout.html +++ /dev/null @@ -1,210 +0,0 @@ -{# - basic/layout.html - ~~~~~~~~~~~~~~~~~ - - Master layout template for Sphinx themes. - - :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{%- block doctype -%} - -{%- endblock %} -{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %} -{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %} -{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and - (sidebars != []) %} -{%- set url_root = pathto('', 1) %} -{# XXX necessary? #} -{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} -{%- if not embedded and docstitle %} - {%- set titlesuffix = " — "|safe + docstitle|e %} -{%- else %} - {%- set titlesuffix = "" %} -{%- endif %} - -{%- macro relbar() %} -
        -

        {{ _('Navigation') }}

        -
          - {%- for rellink in rellinks %} -
        • - {{ rellink[3] }} - {%- if not loop.first %}{{ reldelim2 }}{% endif %}
          • - {%- endfor %} - {%- block rootrellink %} -
        • {{ shorttitle|e }}{{ reldelim1 }}
          • - {%- endblock %} - {%- for parent in parents %} -
        • {{ parent.title }}{{ reldelim1 }}
          • - {%- endfor %} - {%- block relbaritems %} {% endblock %} -
        -
        -{%- endmacro %} - -{%- macro sidebar() %} - {%- if render_sidebar %} -
        -
        - {%- block sidebarlogo %} - {%- if logo %} - - {%- endif %} - {%- endblock %} - {%- if sidebars != None %} - {#- new style sidebar: explicitly include/exclude templates #} - {%- for sidebartemplate in sidebars %} - {%- include sidebartemplate %} - {%- endfor %} - {%- else %} - {#- old style sidebars: using blocks -- should be deprecated #} - {%- block sidebartoc %} - {%- include "localtoc.html" %} - {%- include "globaltoc.html" %} - {%- endblock %} - {%- block sidebarsearch %} - {%- include "searchbox.html" %} - {%- endblock %} - {%- if customsidebar %} - {%- include customsidebar %} - {%- endif %} - {%- block sidebarsourcelink %} - {%- include "sourcelink.html" %} - {%- endblock %} - {%- block sidebarrel %} - {%- include "relations.html" %} - {%- endblock %} - - {%- endif %} -
        -
        - {%- endif %} -{%- endmacro %} - -{%- macro script() %} - - {%- for scriptfile in script_files %} - - {%- endfor %} -{%- endmacro %} - -{%- macro css() %} - - - {%- for cssfile in css_files %} - - {%- endfor %} -{%- endmacro %} - - - - - {{ metatags }} - {%- block htmltitle %} - {{ title|striptags|e }}{{ titlesuffix }} - {%- endblock %} - {{ css() }} - {%- if not embedded %} - {{ script() }} - {%- if use_opensearch %} - - {%- endif %} - {%- if favicon %} - - {%- endif %} - {%- endif %} -{%- block linktags %} - {%- if hasdoc('about') %} - - {%- endif %} - {%- if hasdoc('genindex') %} - - {%- endif %} - {%- if hasdoc('search') %} - - {%- endif %} - {%- if hasdoc('copyright') %} - - {%- endif %} - - {%- if parents %} - - {%- endif %} - {%- if next %} - - {%- endif %} - {%- if prev %} - - {%- endif %} -{%- endblock %} -{%- block extrahead %} {% endblock %} - - -{%- block header %}{% endblock %} - -{%- block relbar1 %}{{ relbar() }}{% endblock %} - -{%- block content %} - {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %} - -
        - {%- block document %} -
        - {%- if render_sidebar %} -
        - {%- endif %} -
        - {% block body %} {% endblock %} -
        - {%- if render_sidebar %} -
        - {%- endif %} -
        - {%- endblock %} - - {%- block sidebar2 %}{{ sidebar() }}{% endblock %} -
        -
        -{%- endblock %} - -{%- block relbar2 %}{{ relbar() }}{% endblock %} - -{%- block footer %} -
        - {%- if show_copyright %} - {%- if hasdoc('copyright') %} - {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} - {%- else %} - {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} - {%- endif %} - {%- endif %} - {%- if last_updated %} - {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} - {%- endif %} - {%- if show_sphinx %} - {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %} - {%- endif %} -
        -{%- endblock %} - - - - - diff --git a/docs/sphinx-docs/themes/mongodb/localtoc.html b/docs/sphinx-docs/themes/mongodb/localtoc.html deleted file mode 100644 index 60187929dca..00000000000 --- a/docs/sphinx-docs/themes/mongodb/localtoc.html +++ /dev/null @@ -1,11 +0,0 @@ -{# - basic/localtoc.html - ~~~~~~~~~~~~~~~~~~~ - - Sphinx sidebar template: local table of contents. - - :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -

        {{ _('Page Contents') }}

        -{{ toc }} diff --git a/docs/sphinx-docs/themes/mongodb/relations.html b/docs/sphinx-docs/themes/mongodb/relations.html deleted file mode 100644 index 008a0a07162..00000000000 --- a/docs/sphinx-docs/themes/mongodb/relations.html +++ /dev/null @@ -1,19 +0,0 @@ -{# - basic/relations.html - ~~~~~~~~~~~~~~~~~~~~ - - Sphinx sidebar template: relation links. - - :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{%- if prev %} -

        {{ _('Previous page') }}

        -

        {{ prev.title }}

        -{%- endif %} -{%- if next %} -

        {{ _('Next page') }}

        -

        {{ next.title }}

        -{%- endif %} diff --git a/docs/sphinx-docs/themes/mongodb/theme.conf b/docs/sphinx-docs/themes/mongodb/theme.conf deleted file mode 100644 index 3493f868640..00000000000 --- a/docs/sphinx-docs/themes/mongodb/theme.conf +++ /dev/null @@ -1,4 +0,0 @@ -[theme] -inherit = basic -stylesheet = mongodb-docs.css -pygments_style = tango diff --git a/driver-articles/anintroductionto1_1and2_2.html b/driver-articles/anintroductionto1_1and2_2.html new file mode 100644 index 00000000000..5cb2d092287 --- /dev/null +++ b/driver-articles/anintroductionto1_1and2_2.html @@ -0,0 +1,577 @@ + + + + + + + + + + Mongo Driver and Mongo DB 2.2 Features — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Mongo Driver and Mongo DB 2.2 Features

        +
        +
        For Mongo DB there are multiple new features and improvements in the driver. This include Mongos failover support, authentication, replicaset support, read preferences and aggregation. Let’s move throught the different new features starting with.
        +
        +

        Read preferences

        +
        +

        Read preferences is now backed by a specification and is more consistent across drivers. With read preferences you can control from where your Reads are happing in a Replicaset and from Mongo DB also in a shard. Let’s go through the different types of read Preferences that are available and what they mean.

        +
        +
          +
        • ReadPreference.PRIMARY: Read from primary only. All operations produce an error (throw an exception where applicable) if primary is unavailable. Cannot be combined with tags (This is the default.)
          • +
        • ReadPreference.PRIMARY_PREFERRED: Read from primary if available, otherwise a secondary.
          • +
        • ReadPreference.SECONDARY: Read from secondary if available, otherwise error.
          • +
        • ReadPreference.SECONDARY_PREFERRED: Read from a secondary if available, otherwise read from the primary.
          • +
        • ReadPreference.NEAREST: All modes read from among the nearest candidates, but unlike other modes, NEAREST will include both the primary and all secondaries in the random selection. The name NEAREST is chosen to emphasize its use, when latency is most important. For I/O-bound users who want to distribute reads across all members evenly regardless of ping time, set secondaryAcceptableLatencyMS very high. See “Ping Times” below. A strategy must be enabled on the ReplSet instance to use NEAREST as it requires intermittent setTimeout events, see Db class documentation
          • +
        +
        +

        Additionally you can now use tags with all the read preferences to actively choose specific sets of servers in a replicatset or sharded system located in different data centers. The rules are fairly simple as outline below. A server member matches a tag set if its tags match all the tags in the set. For example, a member tagged { dc: ‘ny’, rack: 2, size: ‘large’ } matches the tag set { dc: ‘ny’, rack: 2 } . A member’s extra tags don’t affect whether it’s a match.

        +

        Using a read preference is very simple. Below are some examples using it at the db level, collection level and individual query level as well as an example using tags.

        +

        Below is a simple example using readpreferences at the db level.

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , format = require('util').format;
+
+var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s"
+  , "localhost:27017",
+  , "localhost:27018"
+  , "localhost:27019"
+  , "exampleDb"
+  , "foo"
+  , "secondaryPreferred");
+
+MongoClient.connect(url, function(err db) {
+  if(!err) {
+    console.log("We are connected");
+  }
+});
+
        +
        +
        +

        Below is a simple example using readpreferences at the collection level.

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , format = require('util').format;
+
+var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s"
+  , "localhost:27017",
+  , "localhost:27018"
+  , "localhost:27019"
+  , "exampleDb"
+  , "foo"
+  , "secondaryPreferred");
+
+MongoClient.connect(url, function(err db) {
+  if(!err) {
+    console.log("We are connected");
+
+    var collection = db.collection('somecollection', {readPreference: ReadPreference.SECONDARY_PREFERRED});
+    collection.find({}).toArray(function(err, items) {
+      // Done reading from secondary if available
+    })
+  }
+});
+
        +
        +
        +

        Below is a simple example using readpreferences at the query level.

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , format = require('util').format;
+
+var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s"
+  , "localhost:27017",
+  , "localhost:27018"
+  , "localhost:27019"
+  , "exampleDb"
+  , "foo"
+  , "secondaryPreferred");
+
+MongoClient.connect(url, function(err db) {
+  if(!err) {
+    console.log("We are connected");
+
+    var collection = db.collection('somecollection');
+    collection.find({}).setReadPreference(new ReadPreference(ReadPreference.SECONDARY_PREFERRED)).toArray(function(err, items) {
+      // Done reading from secondary if available
+    })
+  }
+});
+
        +
        +
        +

        Below is a simple example using a readpreference with tags at the query level. This example will pick from the set of servers tagged with dc1:ny .

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , format = require('util').format;
+
+var url = format("mongodb://%s,%s,%s/%s?replicaSet=%s&readPreference=%s"
+  , "localhost:27017",
+  , "localhost:27018"
+  , "localhost:27019"
+  , "exampleDb"
+  , "foo"
+  , "secondaryPreferred");
+
+MongoClient.connect(url, function(err db) {
+  if(!err) {
+    console.log("We are connected");
+
+    var collection = db.collection('somecollection');
+    collection.find({}).setReadPreference(new ReadPreference(ReadPreference.SECONDARY_PREFERRED, {"dc1":"ny"})).toArray(function(err, items) {
+      // Done reading from secondary if available
+    })
+  }
+});
+
        +
        +
        +
        +
        +
        +

        Mongos

        +
        +

        There is now a seperate Server type for Mongos that handles not only Mongos read preferences for Mongo DB but also failover and picking the nearest Mongos proxy to your application. To use simply do

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , format = require('util').format;
+
+var url = format("mongodb://%s,%s/%s"
+  , "localhost:50000",
+  , "localhost:50001"
+  , "exampleDb");
+
+MongoClient.connect(url, function(err db) {
+  if(!err) {
+    console.log("We are connected");
+  }
+
+  db.close();
+});
+
        +
        +
        +

        Read preferences also work with Mongos from Mongo DB 2.2 or higher allowing you to create more complex deployment setups.

        +
        +
        +
        +

        Aggregation framework helper

        +
        +

        The MongoDB aggregation framework provides a means to calculate aggregate values without having to use map-reduce. While map-reduce is powerful, using map-reduce is more difficult than necessary for many simple aggregation tasks, such as totaling or averaging field values.

        +

        The driver supports the aggregation framework by adding a helper at the collection level to execute an aggregation pipeline against the documents in that collection. Below is a simple example of using the aggregation framework to perform a group by tags.

        +
        +
        var MongoClient = require('mongodb').MongoClient;
+
+// Some docs for insertion
+var docs = [{
+    title : "this is my title", author : "bob", posted : new Date() ,
+    pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 },
+    comments : [
+      { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" }
+    ]}];
+
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  // Create a collection
+  db.createCollection('test', function(err, collection) {
+    // Insert the docs
+    collection.insert(docs, {safe:true}, function(err, result) {
+
+      // Execute aggregate, notice the pipeline is expressed as an Array
+      collection.aggregate([
+          { $project : {
+            author : 1,
+            tags : 1
+          }},
+          { $unwind : "$tags" },
+          { $group : {
+            _id : {tags : "$tags"},
+            authors : { $addToSet : "$author" }
+          }}
+        ], function(err, result) {
+          console.dir(result);
+          db.close();
+      });
+    });
+  });
+});
+
        +
        +
        +
        +
        +
        +

        Replicaset improvements and changes

        +
        +

        Replicasets now return to the driver when a primary has been identified allowing for faster connect time meaning the application does not have to wait for the whole set to be identified before being able to run. That said any secondary queries using read preference ReadPreference.SECONDARY might fail until at least one secondary is up. To aid in development of layers above the driver now emits to new events.

        +
        +
          +
        • open is emitted when the driver is ready to be used.
          • +
        • fullsetup is emitted once the whole replicaset is up and running
          • +
        +
        +

        To ensure better control over timeouts when attempting to connect to replicaset members that might be down there is now two timeout settings.

        +
        +
          +
        • connectTimeoutMS: set the timeout for the intial connect to the mongod or mongos instance.
          • +
        • socketTimeoutMS: set the timeout for established connections to the mongod or mongos instance.
          • +
        +
        +
        +
        +
        +

        High availability “on” by default

        +
        +

        The high availability code has been rewritten to run outside a setTimeout allowing for better control and handling. It’s also on by default now. It can be disabled using the following settings on the ReplSet class.

        +
        +
          +
        • ha {Boolean, default:true}, turn on high availability.
          • +
        • haInterval {Number, default:2000}, time between each replicaset status check.
          • +
        +
        +

        This allows the driver to discover new replicaset members or replicaset members who left the set and then returned.

        +
        +
        +
        +

        Better stream support for GridFS

        +
        +

        GridFS now supports the streaming api’s for node allowing you to pipe content either into or out of a Gridstore object making it easy to work with other streaming api’s available.

        +

        A simple example is shown below for how to stream from a file on disk to a gridstore object.

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , fs = require('fs')
+  , GridStore = mongo.GridStore;
+
+// Some docs for insertion
+var docs = [{
+    title : "this is my title", author : "bob", posted : new Date() ,
+    pageViews : 5, tags : [ "fun" , "good" , "fun" ], other : { foo : 5 },
+    comments : [
+      { author :"joe", text : "this is cool" }, { author :"sam", text : "this is bad" }
+    ]}];
+
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  // Set up gridStore
+  var gridStore = new GridStore(client, "test_stream_write", "w");
+  // Create a file reader stream to an object
+  var fileStream = fs.createReadStream("./test/gridstore/test_gs_working_field_read.pdf");
+  gridStore.on("close", function(err) {
+    // Just read the content and compare to the raw binary
+    GridStore.read(client, "test_stream_write", function(err, gridData) {
+      var fileData = fs.readFileSync("./test/gridstore/test_gs_working_field_read.pdf");
+      test.deepEqual(fileData, gridData);
+      test.done();
+    })
+  });
+
+  // Pipe it through to the gridStore
+  fileStream.pipe(gridStore);
+})
+
        +
        +
        +

        A simple example is shown below for how to stream from a gridfs file to a file on disk.

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , fs = require('fs')
+  , GridStore = mongo.GridStore;
+
+MongoClient.connect("mongodb://localhost:27017/exampleDb", function(err, db) {
+  // Set up gridStore
+  var gridStore = new GridStore(client, "test_stream_write_2", "w");
+  gridStore.writeFile("./test/gridstore/test_gs_working_field_read.pdf", function(err, result) {
+    // Open a readable gridStore
+    gridStore = new GridStore(client, "test_stream_write_2", "r");
+    // Create a file write stream
+    var fileStream = fs.createWriteStream("./test_stream_write_2.tmp");
+    fileStream.on("close", function(err) {
+      // Read the temp file and compare
+      var compareData = fs.readFileSync("./test_stream_write_2.tmp");
+      var originalData = fs.readFileSync("./test/gridstore/test_gs_working_field_read.pdf");
+      test.deepEqual(originalData, compareData);
+      test.done();
+    })
+    // Pipe out the data
+    gridStore.pipe(fileStream);
+  });
+})
+
        +
        +
        +
        +
        +
        +

        toBSON method

        +
        +

        If in an object now has a toBSON function it will be called to for custom serialization of the object instance. This can be used to just serialize wanted fields. Deserializing is not affected by this and the application is responsible for deflating objects again.

        +

        A simple example below

        +
        +
        var customObject = {
+    a:1
+    b:2
+    toBSON: function() {
+      return {a:this.a}
+    }
+  }
+
        +
        +
        +
        +
        +
        +

        Much faster BSON C++ parser

        +
        +
        Thanks to the awesome people at Lucasfilm Singapore we have a new BSON C++ serializer/deserializer that performs on average 40-50% faster than the current implementation.
        +
        +
        +

        Other minor changes

        +
        +
          +
        • Connection pool is now set to 5 by default. Override if there is need for either a bigger or smaller pool per node process.
          • +
        • Gridfs now ensures an index on the chunks collection on file_id.
          • +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/driver-articles/index.html b/driver-articles/index.html new file mode 100644 index 00000000000..c009cd181b1 --- /dev/null +++ b/driver-articles/index.html @@ -0,0 +1,273 @@ + + + + + + + + + + Updates — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + + + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/driver-articles/mongoclient.html b/driver-articles/mongoclient.html new file mode 100644 index 00000000000..d32a8353027 --- /dev/null +++ b/driver-articles/mongoclient.html @@ -0,0 +1,549 @@ + + + + + + + + + + MongoClient or how to connect in a new and better way — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        MongoClient or how to connect in a new and better way

        +
        +

        From driver version 1.2 we are introduction a new connection Class that has the same name across all out official drivers. This is to ensure that we present a recognizable front for all our API’s. This does not mean you existing application will break but that we encourage you to use the new connection api to simplify your application development.

        +

        Further more we are making the new connection class MongoClient acknowledge all write to MongoDB in contrast to the existing connection class Db that has acknowledgements turned off. Let’s take a tour of the MongoClient functions.

        +
        +
        MongoClient = function(server, options);
+
+MongoClient.prototype.open
+
+MongoClient.prototype.close
+
+MongoClient.prototype.db
+
+MongoClient.connect
+
        +
        +
        +

        Outlined above is the complete MongoClient interface. The methods open , close and db work very similar to the existing methods on the Db class. The main difference if you noticed is that the constructor is missing the database name from Db. Let’s show a simple connection using open as a code example speaks a thousand words.

        +
        +
        var MongoClient = require('mongodb').MongoClient
+  , Server = require('mongodb').Server;
+
+var mongoClient = new MongoClient(new Server('localhost', 27017));
+mongoClient.open(function(err, mongoClient) {
+  var db1 = mongoClient.db("mydb");
+
+  mongoClient.close();
+});
+
        +
        +
        +

        Notice that you configure the MongoClient just as you would have done the Db object. The main difference is that you access the db instances using the db method on the MongoClient object instead of using the Db instance directly as you would previously. Don’t that seem more intuitive then the previous API. Also MongoClient supports the same options as the previous Db instance you would have created.

        +

        So with a minimal change in our app we can apply the new MongoClient connection code. But there is more and one direction you might consider int the future. That is the mongodb connection string.

        +
        +
        +

        The URL connection format

        +
        +
        +
        mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
+
        +
        +
        +

        The URL format is unified across official drivers from 10gen with some options not supported on some driver due to natural reasons. The ones not supported by the Node.js driver are left out for simplicities sake.

        +
        +
          +
        • mongodb:// is a required prefix to identify that this is a string in the standard connection format.
          • +
        • username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server.
          • +
        • host1 is the only required part of the URI. It identifies either a hostname, IP address, or unix domain socket
          • +
        • :portX is optional and defaults to :27017 if not provided.
          • +
        • /database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the “admin” database will be used by default.
          • +
        • ?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by “&”. For any unrecognized or unsupported option, a driver should log a warning and continue processing. A driver should not support any options that are not explicitly defined in this specification. This is in order to reduce the likelihood that different drivers will support overlapping that differ in small but incompatible ways (like different name, different values, or different default value).
          • +
        • replicaSet=name * The driver verifies that the name of the replica set it connects to matches this name. Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set. * No default value.
          • +
        • ssl=true|false|prefer
          • +
        +
        +
          +
        • true: the driver initiates each connections with SSL * false: the driver initiates each connection without SSL * prefer: the driver tries to initiate each connection with SSL, and falls back to without SSL if it fails. * Default value is false.
          • +
        +
        +
          +
        • connectTimeoutMS=ms
          • +
        +
        +
          +
        • How long a connection can take to be opened before timing out. * Current driver behavior already differs on this, so default must be left to each driver. For new implementations, the default should be to never timeout.
          • +
        +
        +
          +
        • socketTimeoutMS=ms
          • +
        +
        +
          +
        • How long a send or receive on a socket can take before timing out. * Current driver behavior already differs on this, so default must be left to each driver. For new implementations, the default should be to never timeout.
          • +
        +
        +
          +
        • maxPoolSize=n: The maximum number of connections in the connection pool * Default value is 5
          • +
        +
        +

        More detailed information about write concerns can be found at http://www.mongodb.org/display/DOCS/getLastError+Command

        +
        +
          +
        • w=wValue
          • +
        +
        +
          +
        • For numeric values above 1, the driver adds { w : wValue } to the getLastError command. * wValue is typically a number, but can be any string in order to allow for specifications like “majority” * Default value is 1.
          • +
        • wValue == -1 ignore network errors * wValue == 0 no write acknowledgement * wValue == 1 perform a write acknowledgement * wValue == 2 perform a write acknowledgement across primary and one secondary * wValue == ‘majority’ perform a write acknowledgement across the majority of servers in the replicaset * wValue == ‘tag name’ perform a write acknowledgement against the replicaset tag name
          • +
        +
        +
          +
        • wtimeoutMS=ms
          • +
        +
        +
          +
        • The driver adds { wtimeout : ms } to the getlasterror command. * Used in combination with w * No default value
          • +
        +
        +
          +
        • journal=true|false
          • +
        +
        +
          +
        • true: Sync to journal. * false: the driver does not add j to the getlasterror command * Default value is false
          • +
        +
        +
          +
        • fsync=true|false
          • +
        +
        +
          +
        • true: Sync to disk. * false: the driver does not add fsync to the getlasterror command * Default value is false * If conflicting values for fireAndForget, and any write concern are passed the driver should raise an exception about the conflict.
          • +
        +
        +
          +
        • authSource=string: Used when the user for authentication is stored in another database using indirect authentication. * Default value is null
          • +
        • slaveOk=true|false: Whether a driver connected to a replica set will send reads to slaves/secondaries.
          • +
        +
        +
          +
        • Default value is false
          • +
        +
        +
          +
        • readPreference=enum: The read preference for this connection. If set, it overrides any slaveOk value.
          • +
        +
        +
          +
        • Enumerated values: * primary * primaryPreferred * secondary * secondaryPreferred * nearest * Default value is primary
          • +
        +
        +
          +
        • readPreferenceTags=string. A representation of a tag set as a comma-separated list of colon-separated key-value pairs, e.g. dc:ny,rack:1 . Spaces should be stripped from beginning and end of all keys and values. To specify a list of tag sets, using multiple readPreferenceTags, e.g. readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny&readPreferenceTags=
          • +
        +
        +
          +
        • Note the empty value, it provides for fallback to any other secondary server if none is available * Order matters when using multiple readPreferenceTags * There is no default value
          • +
        +
        +
        +
        +
        +
        +

        MongoClient.connect

        +
        +

        The url format can be used with MongoClient.connect. Where possible MongoClient will pick the best possible default values for options but they can be overridden. This includes setting auto_reconnect to true and native_parser to true if it’s available . Below are some example on how to connect to a single server a replicaset and a sharded system using MongoClient.connect

        +
        +
        var MongoClient = require('mongodb').MongoClient;
+
+MongoClient.connect("mongodb://localhost:27017/integration_test", function(err, db) {
+  test.equal(null, err);
+  test.ok(db != null);
+
+  db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    test.equal(null, err);
+    test.equal(1, result);
+
+    db.close();
+    test.done();
+  });
+});
+
        +
        +
        var MongoClient = require('mongodb').MongoClient;
+
+MongoClient.connect("mongodb://localhost:30000,localhost:30001/integration_test_?w=0&readPreference=secondary", function(err, db) {
+  test.equal(null, err);
+  test.ok(db != null);
+
+  db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    test.equal(null, err);
+    test.equal(1, result);
+
+    db.close();
+    test.done();
+  });
+});
+
        +
        +
        var MongoClient = require('mongodb').MongoClient;
+
+MongoClient.connect("mongodb://localhost:50000,localhost:50001/integration_test_?w=0&readPreference=secondary", function(err, db) {
+  test.equal(null, err);
+  test.ok(db != null);
+
+  db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    test.equal(null, err);
+    test.equal(1, result);
+
+    db.close();
+    test.done();
+  });
+});
+
        +
        +
        +

        Notice that when connecting to the sharded system it’s pretty much the same url as for connecting to the replicaset. This is because the driver itself figures out if it’s a replicaset or a set of Mongos proxies it’s connecting to. No special care is needed to specify if it’s one or the other. This is in contrast to having to use the ReplSet or Mongos instances when using the open command.

        +
        +
        +
        +

        MongoClient.connect options

        +
        +

        The connect function also takes a hash of options divided into db/server/replset/mongos allowing you to tweak options not directly supported by the unified url string format. To use these options you do pass in a has like this.

        +
        +
        var MongoClient = require('mongodb').MongoClient;
+
+MongoClient.connect("mongodb://localhost:27017/integration_test_?", {
+    db: {
+      native_parser: false
+    },
+    server: {
+      socketOptions: {
+        connectTimeoutMS: 500
+      }
+    },
+    replSet: {},
+    mongos: {}
+  }, function(err, db) {
+  test.equal(null, err);
+  test.ok(db != null);
+
+  db.collection("replicaset_mongo_client_collection").update({a:1}, {b:1}, {upsert:true}, function(err, result) {
+    test.equal(null, err);
+    test.equal(1, result);
+
+    db.close();
+    test.done();
+  });
+});
+
        +
        +
        +

        Below are all the options supported for db/server/replset/mongos.

        +
        +
        +
        +

        db: A hash of options at the db level overriding or adjusting functionality not supported by the url

        +
        +
          +
        • w , {Number/String, > -1 || ‘majority’} the write concern for the operation where < 1 is no acknowledgment of write and w >= 1 or w = ‘majority’ acknowledges the write
          • +
        • wtimeout , {Number, 0} set the timeout for waiting for write concern to finish (combines with w option)
          • +
        • fsync , (Boolean, default:false) write waits for fsync before returning
          • +
        • journal , (Boolean, default:false) write waits for journal sync before returning
          • +
        • readPreference {String}, the preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY PREFERRED, ReadPreference.NEAREST).
          • +
        • native_parser {Boolean, default:false}, use c++ bson parser.
          • +
        • forceServerObjectId {Boolean, default:false}, force server to create _id fields instead of client.
          • +
        • pkFactory {Object}, object overriding the basic ObjectID primary key generation.
          • +
        • serializeFunctions {Boolean, default:false}, serialize functions.
          • +
        • raw {Boolean, default:false}, perform operations using raw bson buffers.
          • +
        • recordQueryStats {Boolean, default:false}, record query statistics during execution.
          • +
        • retryMiliSeconds {Number, default:5000}, number of milliseconds between retries.
          • +
        • numberOfRetries {Number, default:5}, number of retries off connection.
          • +
        +
        +
        +
        +

        server: A hash of options at the server level not supported by the url.

        +
        +
        *  **readPreference** {String, default:null}, set's the read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST)
+*  **ssl** {Boolean, default:false}, use ssl connection (needs to have a mongod server with ssl support)
+*  **slaveOk** {Boolean, default:false}, legacy option allowing reads from secondary, use **readPrefrence** instead.
+*  **poolSize** {Number, default:1}, number of connections in the connection pool, set to 1 as default for legacy reasons.
+*  **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number))
+*  **logger** {Object, default:null}, an object representing a logger that you want to use, needs to support functions debug, log, error **({error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}})**.
+*  **auto_reconnect** {Boolean, default:false}, reconnect on error.
+*  **disableDriverBSONSizeCheck** {Boolean, default:false}, force the server to error if the BSON message is to big
        +
        +
        +
        +
        +

        replSet: A hash of options at the replSet level not supported by the url.

        +
        +
        *  **ha** {Boolean, default:true}, turn on high availability.
+*  **haInterval** {Number, default:2000}, time between each replicaset status check.
+*  **reconnectWait** {Number, default:1000}, time to wait in milliseconds before attempting reconnect.
+*  **retries** {Number, default:30}, number of times to attempt a replicaset reconnect.
+*  **rs_name** {String}, the name of the replicaset to connect to.
+*  **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number))
+*  **readPreference** {String}, the preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
+*  **strategy** {String, default:null}, selection strategy for reads choose between (ping and statistical, default is round-robin)
+*  **secondaryAcceptableLatencyMS** {Number, default:15}, sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms)
+*  **connectArbiter** {Boolean, default:false}, sets if the driver should connect to arbiters or not.
+
        +
        +
        +
        +
        +

        mongos: A hash of options at the mongos level not supported by the url.

        +
        +
        *  **socketOptions** {Object, default:null}, an object containing socket options to use (noDelay:(boolean), keepAlive:(number), connectTimeoutMS:(number), socketTimeoutMS:(number))
+*  **ha** {Boolean, default:true}, turn on high availability, attempts to reconnect to down proxies
+*  **haInterval** {Number, default:2000}, time between each replicaset status check.
+
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/examples/admin.js b/examples/admin.js deleted file mode 100644 index 2619e7ea021..00000000000 --- a/examples/admin.js +++ /dev/null @@ -1,53 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.dropDatabase(function(err, result){ - db.dropCollection('test', function(err, result) { - db.createCollection('test', function(err, collection) { - - // Erase all records in collection - collection.remove({}, function(err, r) { - db.admin(function(err, admin) { - - // Profiling level set/get - admin.profilingLevel(function(err, profilingLevel) { - console.log("Profiling level: " + profilingLevel); - }); - - // Start profiling everything - admin.setProfilingLevel('all', function(err, level) { - console.log("Profiling level: " + level); - - // Read records, creating a profiling event - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - // Stop profiling - admin.setProfilingLevel('off', function(err, level) { - // Print all profiling info - admin.profilingInfo(function(err, info) { - console.dir(info); - - // Validate returns a hash if all is well or return an error hash if there is a - // problem. - admin.validateCollection(collection.collectionName, function(err, result) { - console.dir(result); - db.close(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/blog.js b/examples/blog.js deleted file mode 100644 index ff9c16b61fb..00000000000 --- a/examples/blog.js +++ /dev/null @@ -1,102 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -var LINE_SIZE = 120; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-blog', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.dropDatabase(function(err, result) { - console.log("==================================================================================="); - console.log(">> Adding Authors"); - db.collection('authors', function(err, collection) { - collection.createIndex(["meta", ['_id', 1], ['name', 1], ['age', 1]], function(err, indexName) { - console.log("==================================================================================="); - var authors = {}; - - // Insert authors - collection.insert([{'name':'William Shakespeare', 'email':'william@shakespeare.com', 'age':587}, - {'name':'Jorge Luis Borges', 'email':'jorge@borges.com', 'age':123}], function(err, docs) { - docs.forEach(function(doc) { - console.dir(doc); - authors[doc.name] = doc; - }); - }); - - console.log("==================================================================================="); - console.log(">> Authors ordered by age ascending"); - console.log("==================================================================================="); - collection.find({}, {'sort':[['age', 1]]}, function(err, cursor) { - cursor.each(function(err, author) { - if(author != null) { - console.log("[" + author.name + "]:[" + author.email + "]:[" + author.age + "]"); - } else { - console.log("==================================================================================="); - console.log(">> Adding users"); - console.log("==================================================================================="); - db.collection('users', function(err, userCollection) { - var users = {}; - - userCollection.insert([{'login':'jdoe', 'name':'John Doe', 'email':'john@doe.com'}, - {'login':'lsmith', 'name':'Lucy Smith', 'email':'lucy@smith.com'}], function(err, docs) { - docs.forEach(function(doc) { - console.dir(doc); - users[doc.login] = doc; - }); - }); - - console.log("==================================================================================="); - console.log(">> Users ordered by login ascending"); - console.log("==================================================================================="); - userCollection.find({}, {'sort':[['login', 1]]}, function(err, cursor) { - cursor.each(function(err, user) { - if(user != null) { - console.log("[" + user.login + "]:[" + user.name + "]:[" + user.email + "]"); - } else { - console.log("==================================================================================="); - console.log(">> Adding articles"); - console.log("==================================================================================="); - db.collection('articles', function(err, articlesCollection) { - articlesCollection.insert([ - { 'title':'Caminando por Buenos Aires', - 'body':'Las callecitas de Buenos Aires tienen ese no se que...', - 'author_id':authors['Jorge Luis Borges']._id}, - { 'title':'I must have seen thy face before', - 'body':'Thine eyes call me in a new way', - 'author_id':authors['William Shakespeare']._id, - 'comments':[{'user_id':users['jdoe']._id, 'body':"great article!"}] - } - ], function(err, docs) { - docs.forEach(function(doc) { - console.dir(doc); - }); - }) - - console.log("==================================================================================="); - console.log(">> Articles ordered by title ascending"); - console.log("==================================================================================="); - articlesCollection.find({}, {'sort':[['title', 1]]}, function(err, cursor) { - cursor.each(function(err, article) { - if(article != null) { - console.log("[" + article.title + "]:[" + article.body + "]:[" + article.author_id.toHexString() + "]"); - console.log(">> Closing connection"); - db.close(); - } - }); - }); - }); - } - }); - }); - }); - } - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/capped.js b/examples/capped.js deleted file mode 100644 index fb98911d0af..00000000000 --- a/examples/capped.js +++ /dev/null @@ -1,27 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.dropCollection('test', function(err, result) { - // A capped collection has a max size and optionally a max number of records. - // Old records get pushed out by new ones once the size or max num records is - // reached. - db.createCollection('test', {'capped':true, 'size':1024, 'max':12}, function(err, collection) { - for(var i = 0; i < 100; i++) { collection.insert({'a':i}); } - - // We will only see the last 12 records - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - console.log("The number of records: " + items.length); - db.close(); - }) - }) - }); - }); -}); \ No newline at end of file diff --git a/examples/cursor.js b/examples/cursor.js deleted file mode 100644 index cd5c5f3bc54..00000000000 --- a/examples/cursor.js +++ /dev/null @@ -1,70 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.collection('test', function(err, collection) { - // Erase all records from collection, if any - collection.remove(function(err, result) { - - // Insert 3 records - for(var i = 0; i < 3; i++) { - collection.insert({'a':i}); - } - - // Cursors don't run their queries until you actually attempt to retrieve data - // from them. - - // Find returns a Cursor, which is Enumerable. You can iterate: - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) console.dir(item); - }); - }); - - // You can turn it into an array - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - console.log("count: " + items.length); - }); - }); - - // You can iterate after turning it into an array (the cursor will iterate over - // the copy of the array that it saves internally.) - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - cursor.each(function(err, item) { - if(item != null) console.dir(item); - }); - }); - }); - - // You can get the next object - collection.find(function(err, cursor) { - cursor.nextObject(function(err, item) { - if(item != null) console.dir(item); - }); - }); - - // next_object returns null if there are no more objects that match - collection.find(function(err, cursor) { - cursor.nextObject(function(err, item) { - cursor.nextObject(function(err, item) { - cursor.nextObject(function(err, item) { - cursor.nextObject(function(err, item) { - console.log("nextObject returned: "); - console.dir(item); - db.close(); - }); - }); - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/gridfs.js b/examples/gridfs.js deleted file mode 100644 index 359af250e29..00000000000 --- a/examples/gridfs.js +++ /dev/null @@ -1,149 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server, - GridStore = require('../lib/mongodb').GridStore; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log(">> Connecting to " + host + ":" + port); -var db1 = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db1.open(function(err, db) { - // Write a new file - var gridStore = new GridStore(db, "foobar", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello world!", function(err, gridStore) { - gridStore.close(function(err, result) { - // Read the file and dump the contents - dump(db, 'foobar'); - - // Append more data - gridStore = new GridStore(db, 'foobar', "w+"); - gridStore.open(function(err, gridStore) { - gridStore.write('\n', function(err, gridStore) { - gridStore.puts('line two', function(err, gridStore) { - gridStore.close(function(err, result) { - dump(db, 'foobar'); - - // Overwrite - gridStore = new GridStore(db, 'foobar', "w"); - gridStore.open(function(err, gridStore) { - gridStore.write('hello, sailor!', function(err, gridStore) { - gridStore.close(function(err, result) { - dump(db, 'foobar', function() { - db.close(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -}); - -var db2 = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db2.open(function(err, db) { - // File existence tests - var gridStore = new GridStore(db, "foobar2", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write( 'hello sailor', function(err, gridStore) { - gridStore.close(function(err, result) { - GridStore.exist(db, 'foobar2', function(err, result) { - console.log("File 'foobar2' exists: " + result); - }); - - GridStore.exist(db, 'does-not-exist', function(err, result) { - console.log("File 'does-not-exist' exists: " + result); - }); - - // Read with offset(uses seek) - GridStore.read(db, 'foobar2', 6, 7, function(err, data) { - console.log(data); - }); - - // Rewind/seek/tell - var gridStore2 = new GridStore(db, 'foobar2', 'w'); - gridStore2.open(function(err, gridStore) { - gridStore.write('hello, world!', function(err, gridStore){}); - gridStore.rewind(function(){}); - gridStore.write('xyzzz', function(err, gridStore){}); - gridStore.tell(function(tell) { - console.log("tell: " + tell); // Should be 5 - }); - gridStore.seek(4, function(err, gridStore){}); - gridStore.write('y', function(){}); - gridStore.close(function() { - dump(db, 'foobar2'); - - // Unlink file (delete) - GridStore.unlink(db, 'foobar2', function(err, gridStore) { - GridStore.exist(db, 'foobar2', function(err, result) { - console.log("File 'foobar2' exists: " + result); - db.close(); - }); - }); - }); - }); - }); - }); - }); -}); - -var db3 = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db3.open(function(err, db) { - // Metadata - var gridStore = new GridStore(db, "foobar3", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write('hello, world!', function(err, gridStore){}); - gridStore.close(function(err, gridStore) { - gridStore = new GridStore(db, 'foobar3', "r"); - gridStore.open(function(err, gridStore) { - console.log("contentType: " + gridStore.contentType); - console.log("uploadDate: " + gridStore.uploadDate); - console.log("chunkSize: " + gridStore.chunkSize); - console.log("metadata: " + gridStore.metadata); - }); - - // Add some metadata - gridStore = new GridStore(db, 'foobar3', "w+"); - gridStore.open(function(err, gridStore) { - gridStore.contentType = 'text/xml'; - gridStore.metadata = {'a':1}; - gridStore.close(function(err, gridStore) { - // Print the metadata - gridStore = new GridStore(db, 'foobar3', "r"); - gridStore.open(function(err, gridStore) { - console.log("contentType: " + gridStore.contentType); - console.log("uploadDate: " + gridStore.uploadDate); - console.log("chunkSize: " + gridStore.chunkSize); - console.log("metadata: " + gridStore.metadata); - db.close(); - }); - }); - }); - }); - }); - - // You can also set meta data when initially writing to a file - // setting root means that the file and its chunks are stored in a different root - // collection: instead of gridfs.files and gridfs.chunks, here we use - // my_files.files and my_files.chunks - var gridStore = new GridStore(db, "foobar3", "w", {'content_type':'text/plain', - 'metadata':{'a':1}, 'chunk_size': 1024*4, 'root':'my_files'}); - gridStore.open(function(err, gridStore) { - gridStore.write('hello, world!', function(err, gridStore){}); - gridStore.close(function() { - }); - }); -}); - -function dump(db, filename, callback) { - GridStore.read(db, filename, function(err, data) { - console.log(data); - if(callback != null) callback(); - }); -} \ No newline at end of file diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 73d3348a857..00000000000 --- a/examples/index.js +++ /dev/null @@ -1,62 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server, - mongo = require('../lib/mongodb'); - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log(">> Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - console.log(">> Dropping collection test"); - db.dropCollection('test', function(err, result) { - console.log("dropped: "); - console.dir(result); - }); - - console.log(">> Creating collection test"); - db.collection('test', function(err, collection) { - console.log("created: "); - console.dir(collection); - - var objectCount = 100; - var objects = []; - var messages = ["hola", "hello", "aloha", "ciao"]; - console.log(">> Generate test data"); - for(var i = 0; i < objectCount; i++) { - objects.push({'number':i, 'rndm':((5*Math.random()) + 1), 'msg':messages[parseInt(4*Math.random())]}) - } - console.log("generated"); - - console.log(">> Inserting data (" + objects.length + ")"); - collection.insert(objects); - console.log("inserted"); - - console.log(">> Creating index") - collection.createIndex([['all'], ['_id', 1], ['number', 1], ['rndm', 1], ['msg', 1]], function(err, indexName) { - console.log("created index: " + indexName); - - console.log(">> Gathering index information"); - - collection.indexInformation(function(err, doc) { - console.log("indexInformation: "); - console.dir(doc); - - console.log(">> Dropping index"); - collection.dropIndex('all_1__id_1_number_1_rndm_1_msg_1', function(err, result) { - console.log("dropped: "); - console.dir(result); - - console.log(">> Gathering index information"); - collection.indexInformation(function(err, doc) { - console.log("indexInformation: "); - console.dir(doc); - console.log(">> Closing connection"); - db.close(); - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/info.js b/examples/info.js deleted file mode 100644 index 54ca60ce9ee..00000000000 --- a/examples/info.js +++ /dev/null @@ -1,48 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.collection('test', function(err, collection) { - - // Remove all existing documents in collection - collection.remove(function(err, result) { - - // Insert 3 records - for(var i = 0; i < 3; i++) { - collection.insert({'a':i}); - } - - // Show collection names in the database - db.collectionNames(function(err, names) { - names.forEach(function(name) { - console.dir(name); - }); - }); - - // More information about each collection - db.collectionsInfo(function(err, cursor) { - cursor.toArray(function(err, items) { - items.forEach(function(item) { - console.dir(item); - }); - }); - }) - - // Index information - db.createIndex('test', 'a', function(err, indexName) { - db.indexInformation('test', function(err, doc) { - console.dir(doc); - collection.drop(function(err, result) { - db.close(); - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/oplog.js b/examples/oplog.js deleted file mode 100644 index 4441a6135f9..00000000000 --- a/examples/oplog.js +++ /dev/null @@ -1,114 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server, - Cursor = require('../lib/mongodb').Cursor; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -Slave = function() { - this.running = false; - this.callbacks = []; - //no native_parser right now (because timestamps) - //no strict mode (because system db signed with $ db.js line 189) - //connect without dbName for querying not only "local" db - console.log("Connecting to " + host + ":" + port); - this.db = new Db('testing', new Server(host, port, {}), {}); -} - -//start watching -Slave.prototype.start = function() { - var self = this; - if (this.running) return; - - this.db.open(function(err, db) { - if (err) { - console.log('> MongoSlave error' + err); - process.exit(1); - } - - db.collection('local.oplog.$main', function(err, collection) { - if (! collection) { - console.log('> MongoSlave - local.oplog.$main not found'); - self.stop(); - return false; - } - - process.on('SIGINT', function () { - self.stop(); //tailable cursor should be stopped manually - }); - - //get last row for init TS - collection.find({}, {'limit': 1, 'sort': [['$natural', -1]]}, function(err, cursor) { - cursor.toArray(function(err, items) { - if (items.length) { - console.log('> MongoSlave started'); - self.running = true; - self._runSlave(collection, items[0]['ts']); - } else if (err) { - console.log(err); - self.stop(); - } - }); - }); - }); - }); -} - -//stop watching -Slave.prototype.stop = function() { - if (!this.running) return; - console.log('> MongoSlave stopped'); - this.running = false; - this.db.close(); -} - -Slave.prototype._runSlave = function(collection, time) { - - var self = this; - - //watch oplog INFINITE (until Slave.stop()) - collection.find({'ts': {'$gt': time}}, {'tailable': 1, 'sort': [['$natural', 1]]}, function(err, cursor) { - cursor.each(function(err, item) { - if (cursor.state == Cursor.CLOSED) { //broken cursor - self.running && self._runSlave(collection, time); - return; - } - time = item['ts']; - - switch(item['op']) { - case 'i': //inserted - self._emitObj(item['o']); - break; - case 'u': //updated - self.db.collection(item['ns'], function(err, collection) { - collection.findOne(item['o2']['_id'], {}, function(err, item) { - item && self._emitObj(item); - }); - }); - break; - case 'd': //deleted - //nothing to do - break; - } - }); - }); -} - -Slave.prototype._emitObj = function (obj) { - for(var i in this.callbacks) this.callbacks[i].call(this, obj); -} - -Slave.prototype.onObject = function(callback) { - this.callbacks.push(callback); -} - - -//just for example -var watcher = new Slave(); - -watcher.onObject(function(obj) { - console.dir(obj); -}); - -watcher.start(); \ No newline at end of file diff --git a/examples/queries.js b/examples/queries.js deleted file mode 100644 index 19cc4737587..00000000000 --- a/examples/queries.js +++ /dev/null @@ -1,125 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); - -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.dropDatabase(function() { - // Fetch the collection test - db.collection('test', function(err, collection) { - // Remove all records in collection if any - collection.remove(function(err, result) { - // Insert three records - collection.insert([{'a':1}, {'a':2}, {'b':3}], function(docs) { - // Count the number of records - collection.count(function(err, count) { - console.log("There are " + count + " records."); - }); - - // Find all records. find() returns a cursor - collection.find(function(err, cursor) { - // Print each row, each document has an _id field added on insert - // to override the basic behaviour implement a primary key factory - // that provides a 12 byte value - console.log("Printing docs from Cursor Each") - cursor.each(function(err, doc) { - if(doc != null) console.log("Doc from Each "); - console.dir(doc); - }) - }); - // Cursor has an to array method that reads in all the records to memory - collection.find(function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Printing docs from Array") - docs.forEach(function(doc) { - console.log("Doc from Array "); - console.dir(doc); - }); - }); - }); - - // Different methods to access records (no printing of the results) - - // Locate specific document by key - collection.find({'a':1}, function(err, cursor) { - cursor.nextObject(function(err, doc) { - console.log("Returned #1 documents"); - }); - }); - - // Find records sort by 'a', skip 1, limit 2 records - // Sort can be a single name, array, associate array or ordered hash - collection.find({}, {'skip':1, 'limit':1, 'sort':'a'}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }) - }); - - // Find all records with 'a' > 1, you can also use $lt, $gte or $lte - collection.find({'a':{'$gt':1}}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - collection.find({'a':{'$gt':1, '$lte':3}}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - // Find all records with 'a' in a set of values - collection.find({'a':{'$in':[1,2]}}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - // Find by regexp - collection.find({'a':/[1|2]/}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - // Print Query explanation - collection.find({'a':/[1|2]/}, function(err, cursor) { - cursor.explain(function(err, doc) { - console.log("-------------------------- Explanation"); - console.dir(doc); - }) - }); - - // Use a hint with a query, hint's can also be store in the collection - // and will be applied to each query done through the collection. - // Hint's can also be specified by query which will override the - // hint's associated with the collection - collection.createIndex('a', function(err, indexName) { - collection.hint = 'a'; - - // You will see a different explanation now that the hint was set - collection.find({'a':/[1|2]/}, function(err, cursor) { - cursor.explain(function(err, doc) { - console.log("-------------------------- Explanation"); - console.dir(doc); - }) - }); - - collection.find({'a':/[1|2]/}, {'hint':'a'}, function(err, cursor) { - cursor.explain(function(err, doc) { - console.log("-------------------------- Explanation"); - console.dir(doc); - db.close(); - }) - }); - }); - }); - }); - }); - }); -}); diff --git a/examples/replSetServersQueries.js b/examples/replSetServersQueries.js deleted file mode 100644 index ab82ac68142..00000000000 --- a/examples/replSetServersQueries.js +++ /dev/null @@ -1,138 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server, - ReplSetServers = require('../lib/mongodb').ReplSetServers; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -var port1 = 27018; -var port2 = 27019; -var server = new Server(host, port, {}); -var server1 = new Server(host, port1, {}); -var server2 = new Server(host, port2, {}); -var servers = new Array(); -servers[0] = server2; -servers[1] = server1; -servers[2] = server; - -var replStat = new ReplSetServers(servers); -console.log("Connecting to " + host + ":" + port); -console.log("Connecting to " + host1 + ":" + port1); -console.log("Connecting to " + host2 + ":" + port2); -var db = new Db('node-mongo-examples', replStat, {native_parser:true}); -db.open(function(err, db) { - db.dropDatabase(function() { - // Fetch the collection test - db.collection('test', function(err, collection) { - // Remove all records in collection if any - collection.remove(function(err, collection) { - // Insert three records - collection.insert([{'a':1}, {'a':2}, {'b':3}], function(docs) { - // Count the number of records - collection.count(function(err, count) { - console.log("There are " + count + " records."); - }); - - // Find all records. find() returns a cursor - collection.find(function(err, cursor) { - // Print each row, each document has an _id field added on insert - // to override the basic behaviour implement a primary key factory - // that provides a 12 byte value - console.log("Printing docs from Cursor Each") - cursor.each(function(err, doc) { - if(doc != null) console.log("Doc from Each "); - console.dir(doc); - }) - }); - // Cursor has an to array method that reads in all the records to memory - collection.find(function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Printing docs from Array") - docs.forEach(function(doc) { - console.log("Doc from Array "); - console.dir(doc); - }); - }); - }); - - // Different methods to access records (no printing of the results) - - // Locate specific document by key - collection.find({'a':1}, function(err, cursor) { - cursor.nextObject(function(err, doc) { - console.log("Returned #1 documents"); - }); - }); - - // Find records sort by 'a', skip 1, limit 2 records - // Sort can be a single name, array, associate array or ordered hash - collection.find({}, {'skip':1, 'limit':1, 'sort':'a'}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }) - }); - - // Find all records with 'a' > 1, you can also use $lt, $gte or $lte - collection.find({'a':{'$gt':1}}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - collection.find({'a':{'$gt':1, '$lte':3}}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - // Find all records with 'a' in a set of values - collection.find({'a':{'$in':[1,2]}}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - // Find by regexp - collection.find({'a':/[1|2]/}, function(err, cursor) { - cursor.toArray(function(err, docs) { - console.log("Returned #" + docs.length + " documents"); - }); - }); - - // Print Query explanation - collection.find({'a':/[1|2]/}, function(err, cursor) { - cursor.explain(function(err, doc) { - console.log("-------------------------- Explanation"); - console.dir(doc); - }) - }); - - // Use a hint with a query, hint's can also be store in the collection - // and will be applied to each query done through the collection. - // Hint's can also be specified by query which will override the - // hint's associated with the collection - collection.createIndex('a', function(err, indexName) { - collection.hint = 'a'; - - // You will see a different explanation now that the hint was set - collection.find({'a':/[1|2]/}, function(err, cursor) { - cursor.explain(function(err, doc) { - console.log("-------------------------- Explanation"); - console.dir(doc); - }) - }); - - collection.find({'a':/[1|2]/}, {'hint':'a'}, function(err, cursor) { - cursor.explain(function(err, doc) { - console.log("-------------------------- Explanation"); - console.dir(doc); - db.close(); - }) - }); - }); - }); - }); - }); - }); -}); diff --git a/examples/replSetServersSimple.js b/examples/replSetServersSimple.js deleted file mode 100644 index 9ca3f3f78b1..00000000000 --- a/examples/replSetServersSimple.js +++ /dev/null @@ -1,66 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Admin = require('../lib/mongodb').Admin, - DbCommand = require('../lib/mongodb/commands/db_command').DbCommand, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server, - ReplSetServers = require('../lib/mongodb').ReplSetServers, - CheckMaster = require('../lib/mongodb').CheckMaster; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -var port1 = 27018; -var port2 = 27019; - - -console.log("Connecting to " + host + ":" + port); -console.log("Connecting to " + host + ":" + port1); -console.log("Connecting to " + host + ":" + port2); - -var server = new Server(host, port, {}); -var server1 = new Server(host, port1, {}); -var server2 = new Server(host, port2, {}); -var servers = new Array(); -servers[0] = server2; -servers[1] = server1; -servers[2] = server; - -var replStat = new ReplSetServers(servers); - -var db = new Db('mongo-example', replStat, {native_parser:true}); -db.open(function(err, db) { - - db.dropDatabase(function(err, result) { - db.collection('test', function(err, collection) { - collection.remove(function(err, collection) { - // Insert 3 records - for(var i = 0; i < 3; i++) { - collection.insert({'a':i}); - } - - collection.count(function(err, count) { - console.log("There are " + count + " records in the test collection. Here they are:"); - - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - console.dir(item); - console.log("created at " + new Date(item._id.generationTime) + "\n") - } - // Null signifies end of iterator - if(item == null) { - // Destory the collection - collection.drop(function(err, collection) { - db.close(); - }); - } - }); - }); - }); - }); - }); - }); -}); - - - diff --git a/examples/simple.js b/examples/simple.js deleted file mode 100644 index 9bcdf250d90..00000000000 --- a/examples/simple.js +++ /dev/null @@ -1,42 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.dropDatabase(function(err, result) { - db.collection('test', function(err, collection) { - // Erase all records from the collection, if any - collection.remove({}, function(err, result) { - // Insert 3 records - for(var i = 0; i < 3; i++) { - collection.insert({'a':i}); - } - - collection.count(function(err, count) { - console.log("There are " + count + " records in the test collection. Here they are:"); - - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - console.dir(item); - console.log("created at " + new Date(item._id.generationTime) + "\n") - } - // Null signifies end of iterator - if(item == null) { - // Destory the collection - collection.drop(function(err, collection) { - db.close(); - }); - } - }); - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/strict.js b/examples/strict.js deleted file mode 100644 index 45c739c05d9..00000000000 --- a/examples/strict.js +++ /dev/null @@ -1,36 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {native_parser:true}); -db.open(function(err, db) { - db.dropCollection('does-not-exist', function(err, result) { - db.createCollection('test', function(err, collection) { - db.strict = true; - - // Can't reference collections that does not exist in strict mode - db.collection('does-not-exist', function(err, collection) { - if(err instanceof Error) { - console.log("expected error: " + err.message); - } - - // Can't create collections that does not exist in strict mode - db.createCollection('test', function(err, collection) { - if(err instanceof Error) { - console.log("expected error: " + err.message); - } - - // Remove the strict mode - db.strict = false; - db.dropCollection('test', function(err, collection) { - db.close(); - }); - }); - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/types.js b/examples/types.js deleted file mode 100644 index efff89a9df6..00000000000 --- a/examples/types.js +++ /dev/null @@ -1,42 +0,0 @@ -var Db = require('../lib/mongodb').Db, - Connection = require('../lib/mongodb').Connection, - Server = require('../lib/mongodb').Server, - BSON = require('../lib/mongodb').BSONPure; - -var host = process.env['MONGO_NODE_DRIVER_HOST'] != null ? process.env['MONGO_NODE_DRIVER_HOST'] : 'localhost'; -var port = process.env['MONGO_NODE_DRIVER_PORT'] != null ? process.env['MONGO_NODE_DRIVER_PORT'] : Connection.DEFAULT_PORT; - -console.log("Connecting to " + host + ":" + port); -var db = new Db('node-mongo-examples', new Server(host, port, {}), {}); -db.open(function(err, db) { - db.collection('test', function(err, collection) { - // Remove all existing documents in collection - collection.remove(function(err, result) { - // Insert record with all the available types of values - collection.insert({ - 'array':[1,2,3], - 'string':'hello', - 'hash':{'a':1, 'b':2}, - 'date':new Date(), // Stores only milisecond resolution - 'oid':new BSON.ObjectID(), - 'binary':new BSON.Binary("123"), - 'int':42, - 'float':33.3333, - 'regexp':/foobar/i, - 'regexp2':/foobar2/, - 'boolean':true, - 'where':new BSON.Code('this.x == 3'), - 'dbref':new BSON.DBRef(collection.collectionName, new BSON.ObjectID()), - 'null':null - }, function(err, doc) { - // Locate the first document - collection.findOne(function(err, document) { - console.dir(document); - collection.remove(function(err, collection) { - db.close(); - }); - }) - }); - }); - }); -}); \ No newline at end of file diff --git a/examples/url.js b/examples/url.js deleted file mode 100644 index b04c29fe48f..00000000000 --- a/examples/url.js +++ /dev/null @@ -1,12 +0,0 @@ -var Db = require('../lib/mongodb').Db, - connect = require('../lib/mongodb').connect; - -console.log('Connecting to ' + Db.DEFAULT_URL); -connect(Db.DEFAULT_URL, function(err, db) { - db.dropDatabase(function(err, result) { - db.collection('test', function(err, collection) { - collection.insert({'a':1}); - db.close(); - }); - }); -}); diff --git a/external-libs/bson/.gitignore b/external-libs/bson/.gitignore deleted file mode 100644 index 92bdc577731..00000000000 --- a/external-libs/bson/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -build/ -bson.node -.lock-wscript \ No newline at end of file diff --git a/external-libs/bson/Makefile b/external-libs/bson/Makefile deleted file mode 100644 index ad877d4bd3c..00000000000 --- a/external-libs/bson/Makefile +++ /dev/null @@ -1,45 +0,0 @@ -NODE = node -name = all -JOBS = 1 - -all: - rm -rf build .lock-wscript bson.node - node-waf configure build - cp -R ./build/Release/bson.node . || true - @$(NODE) --expose-gc test/test_bson.js - @$(NODE) --expose-gc test/test_full_bson.js - # @$(NODE) --expose-gc test/test_stackless_bson.js - -all_debug: - rm -rf build .lock-wscript bson.node - node-waf --debug configure build - cp -R ./build/Release/bson.node . || true - @$(NODE) --expose-gc test/test_bson.js - @$(NODE) --expose-gc test/test_full_bson.js - # @$(NODE) --expose-gc test/test_stackless_bson.js - -test: - @$(NODE) --expose-gc test/test_bson.js - @$(NODE) --expose-gc test/test_full_bson.js - # @$(NODE) --expose-gc test/test_stackless_bson.js - -clang: - rm -rf build .lock-wscript bson.node - CXX=clang node-waf configure build - cp -R ./build/Release/bson.node . || true - @$(NODE) --expose-gc test/test_bson.js - @$(NODE) --expose-gc test/test_full_bson.js - # @$(NODE) --expose-gc test/test_stackless_bson.js - -clang_debug: - rm -rf build .lock-wscript bson.node - CXX=clang node-waf --debug configure build - cp -R ./build/Release/bson.node . || true - @$(NODE) --expose-gc test/test_bson.js - @$(NODE) --expose-gc test/test_full_bson.js - # @$(NODE) --expose-gc test/test_stackless_bson.js - -clean: - rm -rf build .lock-wscript bson.node - -.PHONY: all \ No newline at end of file diff --git a/external-libs/bson/bson.cc b/external-libs/bson/bson.cc deleted file mode 100644 index decc28f1ac6..00000000000 --- a/external-libs/bson/bson.cc +++ /dev/null @@ -1,2334 +0,0 @@ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "bson.h" - -using namespace v8; -using namespace node; -using namespace std; - -// BSON DATA TYPES -const uint32_t BSON_DATA_NUMBER = 1; -const uint32_t BSON_DATA_STRING = 2; -const uint32_t BSON_DATA_OBJECT = 3; -const uint32_t BSON_DATA_ARRAY = 4; -const uint32_t BSON_DATA_BINARY = 5; -const uint32_t BSON_DATA_OID = 7; -const uint32_t BSON_DATA_BOOLEAN = 8; -const uint32_t BSON_DATA_DATE = 9; -const uint32_t BSON_DATA_NULL = 10; -const uint32_t BSON_DATA_REGEXP = 11; -const uint32_t BSON_DATA_CODE = 13; -const uint32_t BSON_DATA_SYMBOL = 14; -const uint32_t BSON_DATA_CODE_W_SCOPE = 15; -const uint32_t BSON_DATA_INT = 16; -const uint32_t BSON_DATA_TIMESTAMP = 17; -const uint32_t BSON_DATA_LONG = 18; -const uint32_t BSON_DATA_MIN_KEY = 0xff; -const uint32_t BSON_DATA_MAX_KEY = 0x7f; - -const int32_t BSON_INT32_MAX = (int32_t)2147483647L; -const int32_t BSON_INT32_MIN = (int32_t)(-1) * 2147483648L; - -const int64_t BSON_INT64_MAX = ((int64_t)1 << 63) - 1; -const int64_t BSON_INT64_MIN = (int64_t)-1 << 63; - -const int64_t JS_INT_MAX = (int64_t)1 << 53; -const int64_t JS_INT_MIN = (int64_t)-1 << 53; - -static Handle VException(const char *msg) { - HandleScope scope; - return ThrowException(Exception::Error(String::New(msg))); - }; - -Persistent BSON::constructor_template; - -void BSON::Initialize(v8::Handle target) { - // Grab the scope of the call from Node - HandleScope scope; - // Define a new function template - Local t = FunctionTemplate::New(New); - constructor_template = Persistent::New(t); - constructor_template->InstanceTemplate()->SetInternalFieldCount(1); - constructor_template->SetClassName(String::NewSymbol("BSON")); - - // Instance methods - NODE_SET_PROTOTYPE_METHOD(constructor_template, "calculateObjectSize", CalculateObjectSize); - NODE_SET_PROTOTYPE_METHOD(constructor_template, "serialize", BSONSerialize); - NODE_SET_PROTOTYPE_METHOD(constructor_template, "serializeWithBufferAndIndex", SerializeWithBufferAndIndex); - NODE_SET_PROTOTYPE_METHOD(constructor_template, "deserialize", BSONDeserialize); - NODE_SET_PROTOTYPE_METHOD(constructor_template, "deserializeStream", BSONDeserializeStream); - - // Experimental - // NODE_SET_PROTOTYPE_METHOD(constructor_template, "calculateObjectSize2", CalculateObjectSize2); - // NODE_SET_PROTOTYPE_METHOD(constructor_template, "serialize2", BSONSerialize2); - // NODE_SET_METHOD(constructor_template->GetFunction(), "serialize2", BSONSerialize2); - - target->ForceSet(String::NewSymbol("BSON"), constructor_template->GetFunction()); -} - -// Create a new instance of BSON and assing it the existing context -Handle BSON::New(const Arguments &args) { - HandleScope scope; - - // Check that we have an array - if(args.Length() == 1 && args[0]->IsArray()) { - // Cast the array to a local reference - Local array = Local::Cast(args[0]); - - if(array->Length() > 0) { - // Create a bson object instance and return it - BSON *bson = new BSON(); - - // Setup pre-allocated comparision objects - bson->_bsontypeString = Persistent::New(String::New("_bsontype")); - bson->_longLowString = Persistent::New(String::New("low_")); - bson->_longHighString = Persistent::New(String::New("high_")); - bson->_objectIDidString = Persistent::New(String::New("id")); - bson->_binaryPositionString = Persistent::New(String::New("position")); - bson->_binarySubTypeString = Persistent::New(String::New("sub_type")); - bson->_binaryBufferString = Persistent::New(String::New("buffer")); - bson->_doubleValueString = Persistent::New(String::New("value")); - bson->_symbolValueString = Persistent::New(String::New("value")); - bson->_dbRefRefString = Persistent::New(String::New("$ref")); - bson->_dbRefIdRefString = Persistent::New(String::New("$id")); - bson->_dbRefDbRefString = Persistent::New(String::New("$db")); - bson->_dbRefNamespaceString = Persistent::New(String::New("namespace")); - bson->_dbRefDbString = Persistent::New(String::New("db")); - bson->_dbRefOidString = Persistent::New(String::New("oid")); - - // total number of found classes - uint32_t numberOfClasses = 0; - - // Iterate over all entries to save the instantiate funtions - for(uint32_t i = 0; i < array->Length(); i++) { - // Let's get a reference to the function - Local func = Local::Cast(array->Get(i)); - Local functionName = func->GetName()->ToString(); - - // Save the functions making them persistant handles (they don't get collected) - if(functionName->StrictEquals(String::New("Long"))) { - bson->longConstructor = Persistent::New(func); - bson->longString = Persistent::New(String::New("Long")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("ObjectID"))) { - bson->objectIDConstructor = Persistent::New(func); - bson->objectIDString = Persistent::New(String::New("ObjectID")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("Binary"))) { - bson->binaryConstructor = Persistent::New(func); - bson->binaryString = Persistent::New(String::New("Binary")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("Code"))) { - bson->codeConstructor = Persistent::New(func); - bson->codeString = Persistent::New(String::New("Code")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("DBRef"))) { - bson->dbrefConstructor = Persistent::New(func); - bson->dbrefString = Persistent::New(String::New("DBRef")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("Symbol"))) { - bson->symbolConstructor = Persistent::New(func); - bson->symbolString = Persistent::New(String::New("Symbol")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("Double"))) { - bson->doubleConstructor = Persistent::New(func); - bson->doubleString = Persistent::New(String::New("Double")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("Timestamp"))) { - bson->timestampConstructor = Persistent::New(func); - bson->timestampString = Persistent::New(String::New("Timestamp")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("MinKey"))) { - bson->minKeyConstructor = Persistent::New(func); - bson->minKeyString = Persistent::New(String::New("MinKey")); - numberOfClasses = numberOfClasses + 1; - } else if(functionName->StrictEquals(String::New("MaxKey"))) { - bson->maxKeyConstructor = Persistent::New(func); - bson->maxKeyString = Persistent::New(String::New("MaxKey")); - numberOfClasses = numberOfClasses + 1; - } - } - - // Check if we have the right number of constructors otherwise throw an error - if(numberOfClasses != 10) { - // Destroy object - delete(bson); - // Fire exception - return VException("Missing function constructor for either [Long/ObjectID/Binary/Code/DbRef/Symbol/Double/Timestamp/MinKey/MaxKey]"); - } else { - bson->Wrap(args.This()); - return args.This(); - } - } else { - return VException("No types passed in"); - } - } else { - return VException("Argument passed in must be an array of types"); - } -} - -void BSON::write_int32(char *data, uint32_t value) { - // Write the int to the char* - memcpy(data, &value, 4); -} - -void BSON::write_double(char *data, double value) { - // Write the double to the char* - memcpy(data, &value, 8); -} - -void BSON::write_int64(char *data, int64_t value) { - // Write the int to the char* - memcpy(data, &value, 8); -} - -char *BSON::check_key(Local key) { - // Allocate space for they key string - char *key_str = (char *)malloc(key->Utf8Length() * sizeof(char) + 1); - // Error string - char *error_str = (char *)malloc(256 * sizeof(char)); - // Decode the key - ssize_t len = DecodeBytes(key, BINARY); - ssize_t written = DecodeWrite(key_str, len, key, BINARY); - *(key_str + key->Utf8Length()) = '\0'; - // Check if we have a valid key - if(key->Utf8Length() > 0 && *(key_str) == '$') { - // Create the string - sprintf(error_str, "key %s must not start with '$'", key_str); - // Free up memory - free(key_str); - // Throw exception with string - throw error_str; - } else if(key->Utf8Length() > 0 && strchr(key_str, '.') != NULL) { - // Create the string - sprintf(error_str, "key %s must not contain '.'", key_str); - // Free up memory - free(key_str); - // Throw exception with string - throw error_str; - } - // Free allocated space - free(key_str); - free(error_str); - // Return No check key error - return NULL; -} - -const char* BSON::ToCString(const v8::String::Utf8Value& value) { - return *value ? *value : ""; -} - -Handle BSON::decodeDBref(BSON *bson, Local ref, Local oid, Local db) { - HandleScope scope; - Local argv[] = {ref, oid, db}; - Handle dbrefObj = bson->dbrefConstructor->NewInstance(3, argv); - return scope.Close(dbrefObj); -} - -Handle BSON::decodeCode(BSON *bson, char *code, Handle scope_object) { - HandleScope scope; - - Local argv[] = {String::New(code), scope_object->ToObject()}; - Handle codeObj = bson->codeConstructor->NewInstance(2, argv); - return scope.Close(codeObj); -} - -Handle BSON::decodeBinary(BSON *bson, uint32_t sub_type, uint32_t number_of_bytes, char *data) { - HandleScope scope; - - // Create a buffer object that wraps the raw stream - Buffer *bufferObj = Buffer::New(data, number_of_bytes); - // Arguments to be passed to create the binary - Handle argv[] = {bufferObj->handle_, Uint32::New(sub_type)}; - // Return the buffer handle - Local bufferObjHandle = bson->binaryConstructor->NewInstance(2, argv); - // Close the scope - return scope.Close(bufferObjHandle); -} - -Handle BSON::decodeOid(BSON *bson, char *oid) { - HandleScope scope; - - // Encode the string (string - null termiating character) - Local bin_value = Encode(oid, 12, BINARY)->ToString(); - - // Return the id object - Local argv[] = {bin_value}; - Local oidObj = bson->objectIDConstructor->NewInstance(1, argv); - return scope.Close(oidObj); -} - -Handle BSON::decodeLong(BSON *bson, char *data, uint32_t index) { - HandleScope scope; - - // Decode the integer value - int32_t lowBits = 0; - int32_t highBits = 0; - memcpy(&lowBits, (data + index), 4); - memcpy(&highBits, (data + index + 4), 4); - - // Decode 64bit value - int64_t value = 0; - memcpy(&value, (data + index), 8); - - // If value is < 2^53 and >-2^53 - if((highBits < 0x200000 || (highBits == 0x200000 && lowBits == 0)) && highBits >= -0x200000) { - int64_t finalValue = 0; - memcpy(&finalValue, (data + index), 8); - return scope.Close(Number::New(finalValue)); - } - - // Instantiate the js object and pass it back - Local argv[] = {Int32::New(lowBits), Int32::New(highBits)}; - Local longObject = bson->longConstructor->NewInstance(2, argv); - return scope.Close(longObject); -} - -Handle BSON::decodeTimestamp(BSON *bson, char *data, uint32_t index) { - HandleScope scope; - - // Decode the integer value - int32_t lowBits = 0; - int32_t highBits = 0; - memcpy(&lowBits, (data + index), 4); - memcpy(&highBits, (data + index + 4), 4); - - // Build timestamp - Local argv[] = {Int32::New(lowBits), Int32::New(highBits)}; - Handle timestamp_obj = bson->timestampConstructor->NewInstance(2, argv); - return scope.Close(timestamp_obj); -} - -// Search for 0 terminated C string and return the string -char* BSON::extract_string(char *data, uint32_t offset) { - char *prt = strchr((data + offset), '\0'); - if(prt == NULL) return NULL; - // Figure out the length of the string - uint32_t length = (prt - data) - offset; - // Allocate memory for the new string - char *string_name = (char *)malloc((length * sizeof(char)) + 1); - // Copy the variable into the string_name - strncpy(string_name, (data + offset), length); - // Ensure the string is null terminated - *(string_name + length) = '\0'; - // Return the unpacked string - return string_name; -} - -// Decode a byte -uint16_t BSON::deserialize_int8(char *data, uint32_t offset) { - uint16_t value = 0; - value |= *(data + offset + 0); - return value; -} - -// Requires a 4 byte char array -uint32_t BSON::deserialize_int32(char* data, uint32_t offset) { - uint32_t value = 0; - memcpy(&value, (data + offset), 4); - return value; -} - -//------------------------------------------------------------------------------------------------ -// -// Experimental -// -//------------------------------------------------------------------------------------------------ -Handle BSON::CalculateObjectSize2(const Arguments &args) { - HandleScope scope; - // Ensure we have a valid object - if(args.Length() == 1 && !args[0]->IsObject()) return VException("One argument required - [object]"); - if(args.Length() > 1) return VException("One argument required - [object]"); - // Calculate size of the object - uint32_t object_size = BSON::calculate_object_size2(args[0]); - // Return the object size - return scope.Close(Uint32::New(object_size)); -} - -uint32_t BSON::calculate_object_size2(Handle value) { - // Final object size - uint32_t object_size = (4 + 1); - uint32_t stackIndex = 0; - // Controls the flow - bool done = false; - bool finished = false; - bool isObject = false; - - // Define a local vector that keeps the stack - // vector > > stack;// = new vector > >(0); - - // My own stack max of 1024 objects deep - Local *stack[64]; - - // Current object we are processing - Local currentObject = value->ToObject(); - - // Current list of object keys - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - Local keys = currentObject->GetPropertyNames(); - #else - Local keys = currentObject->GetOwnPropertyNames(); - #endif - - // Contains pointer to keysIndex - uint32_t keysIndex = 0; - uint32_t keysLength = keys->Length(); - - // printf("=================================================================================\n"); - // printf("Start serializing\n"); - - while(!done) { - // If the index is bigger than the number of keys for the object - // we finished up the previous object and are ready for the next one - if(keysIndex >= keysLength) { - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - keys = currentObject->GetPropertyNames(); - #else - keys = currentObject->GetOwnPropertyNames(); - #endif - keysLength = keys->Length(); - } - - // Iterate over all the keys - while(keysIndex < keysLength) { - // Fetch the key name - Local name = keys->Get(keysIndex++)->ToString(); - // Fetch the object related to the key - Local value = currentObject->Get(name); - // Add size of the name, plus zero, plus type - object_size += name->Utf8Length() + 1 + 1; - - // If we have a string - if(value->IsString()) { - object_size += value->ToString()->Utf8Length() + 1 + 4; - } else if(value->IsNumber()) { - // Check if we have a float value or a long value - Local number = value->ToNumber(); - double d_number = number->NumberValue(); - int64_t l_number = number->IntegerValue(); - // Check if we have a double value and not a int64 - double d_result = d_number - l_number; - // If we have a value after subtracting the integer value we have a float - if(d_result > 0 || d_result < 0) { - object_size = object_size + 8; - } else if(l_number <= BSON_INT32_MAX && l_number >= BSON_INT32_MIN) { - object_size = object_size + 4; - } else { - object_size = object_size + 8; - } - } else if(value->IsBoolean()) { - object_size = object_size + 1; - } else if(value->IsDate()) { - object_size = object_size + 8; - } else if(value->IsRegExp()) { - // Fetch the string for the regexp - Handle regExp = Handle::Cast(value); - ssize_t len = DecodeBytes(regExp->GetSource(), UTF8); - int flags = regExp->GetFlags(); - - // global - if((flags & (1 << 0)) != 0) len++; - // ignorecase - if((flags & (1 << 1)) != 0) len++; - //multiline - if((flags & (1 << 2)) != 0) len++; - // if((flags & (1 << 2)) != 0) len++; - // Calculate the space needed for the regexp: size of string - 2 for the /'ses +2 for null termiations - object_size = object_size + len + 2; - } else if(value->IsNull() || value->IsUndefined()) { - } - // } else if(value->IsNumber()) { - // // Check if we have a float value or a long value - // Local number = value->ToNumber(); - // double d_number = number->NumberValue(); - // int64_t l_number = number->IntegerValue(); - // // Check if we have a double value and not a int64 - // double d_result = d_number - l_number; - // // If we have a value after subtracting the integer value we have a float - // if(d_result > 0 || d_result < 0) { - // object_size = name->Utf8Length() + 1 + object_size + 8 + 1; - // } else if(l_number <= BSON_INT32_MAX && l_number >= BSON_INT32_MIN) { - // object_size = name->Utf8Length() + 1 + object_size + 4 + 1; - // } else { - // object_size = name->Utf8Length() + 1 + object_size + 8 + 1; - // } - // } else if(value->IsObject()) { - // printf("------------- hello\n"); - // } - } - - // If we have finished all the keys - if(keysIndex == keysLength) { - finished = false; - } - - // Validate the stack - if(stackIndex == 0) { - // printf("======================================================================== 3\n"); - done = true; - } else if(finished || keysIndex == keysLength) { - // Pop off the stack - stackIndex = stackIndex - 1; - // Fetch the current object stack - // vector > currentObjectStored = stack.back(); - // stack.pop_back(); - // // Unroll the current object - // currentObject = currentObjectStored.back()->ToObject(); - // currentObjectStored.pop_back(); - // // Unroll the keysIndex - // keys = Local::Cast(currentObjectStored.back()->ToObject()); - // currentObjectStored.pop_back(); - // // Unroll the keysIndex - // keysIndex = currentObjectStored.back()->ToUint32()->Value(); - // currentObjectStored.pop_back(); - // // Check if we finished up - // if(keysIndex == keys->Length()) { - // finished = true; - // } - } - } - - return object_size; -} - -Handle BSON::BSONSerialize2(const Arguments &args) { - HandleScope scope; - - if(args.Length() == 1 && !args[0]->IsObject()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - if(args.Length() == 2 && !args[0]->IsObject() && !args[1]->IsBoolean()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - if(args.Length() == 3 && !args[0]->IsObject() && !args[1]->IsBoolean() && !args[2]->IsBoolean()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - if(args.Length() > 3) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - - // Calculate the total size of the document in binary form to ensure we only allocate memory once - uint32_t object_size = BSON::calculate_object_size2(args[0]); - // Allocate the memory needed for the serializtion - char *serialized_object = (char *)malloc(object_size * sizeof(char)); - // Catch any errors - try { - // Check if we have a boolean value - bool check_key = false; - if(args.Length() == 3 && args[1]->IsBoolean()) { - check_key = args[1]->BooleanValue(); - } - - // Serialize the object - BSON::serialize2(serialized_object, 0, Null(), args[0], object_size, check_key); - } catch(char *err_msg) { - // Free up serialized object space - free(serialized_object); - V8::AdjustAmountOfExternalAllocatedMemory(-object_size); - // Throw exception with the string - Handle error = VException(err_msg); - // free error message - free(err_msg); - // Return error - return error; - } - - // Write the object size - BSON::write_int32((serialized_object), object_size); - - // If we have 3 arguments - if(args.Length() == 3) { - // Local asBuffer = args[2]->ToBoolean(); - Buffer *buffer = Buffer::New(serialized_object, object_size); - // Release the serialized string - free(serialized_object); - return scope.Close(buffer->handle_); - } else { - // Encode the string (string - null termiating character) - Local bin_value = Encode(serialized_object, object_size, BINARY)->ToString(); - // Return the serialized content - return bin_value; - } -} - -uint32_t BSON::serialize2(char *serialized_object, uint32_t index, Handle name, Handle value, uint32_t objectSize, bool check_key) { - // Scope for method execution - HandleScope scope; - - // Final object size - uint32_t object_size = (4 + 1); - uint32_t stackIndex = 0; - // Controls the flow - bool done = false; - bool finished = false; - bool isObject = false; - - // Define a local vector that keeps the stack - // vector > > stack;// = new vector > >(0); - - // My own stack max of 1024 objects deep - Local *stack[64]; - - // Current object we are processing - Local currentObject = value->ToObject(); - // Current list of object keys - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - Local keys = currentObject->GetPropertyNames(); - #else - Local keys = currentObject->GetOwnPropertyNames(); - #endif - - // Contains pointer to keysIndex - uint32_t keysIndex = 0; - uint32_t keysLength = keys->Length(); - // Add pointer to start of new object - index = index + 4; - - // printf("=================================================================================\n"); - // printf("Start serializing\n"); - - while(!done) { - // If the index is bigger than the number of keys for the object - // we finished up the previous object and are ready for the next one - if(keysIndex >= keysLength) { - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - keys = currentObject->GetPropertyNames(); - #else - keys = currentObject->GetOwnPropertyNames(); - #endif - - keysLength = keys->Length(); - } - - // Iterate over all the keys - while(keysIndex < keysLength) { - // Fetch the key name - Local name = keys->Get(keysIndex++)->ToString(); - // Fetch the object related to the key - Local value = currentObject->Get(name); - - // If it's a string - if(value->IsString()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_STRING; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // Write the actual string into the char array - Local str = value->ToString(); - // Let's fetch the int value - uint32_t utf8_length = str->Utf8Length(); - // Write the integer to the char * - BSON::write_int32((serialized_object + index), utf8_length + 1); - // Adjust the index - index = index + 4; - // Write string to char in utf8 format - written = DecodeWrite((serialized_object + index), utf8_length, str, BINARY); - // Add the null termination - *(serialized_object + index + utf8_length) = '\0'; - // Adjust the index - index = index + utf8_length + 1; - } - } - - // If we have finished all the keys - if(keysIndex == keysLength) { - finished = false; - } - - // Validate the stack - if(stackIndex == 0) { - // printf("======================================================================== 3\n"); - done = true; - // Set last byte to zero - *(serialized_object + objectSize - 1) = 0x00; - } else if(finished || keysIndex == keysLength) { - // printf("======================================================================== 4\n"); - // Pop off the stack - stackIndex = stackIndex - 1; - // Set last byte to zero - *(serialized_object + objectSize - 1) = 0x00; - - // Fetch the current object stack - // vector > currentObjectStored = stack.back(); - // stack.pop_back(); - // // Unroll the current object - // currentObject = currentObjectStored.back()->ToObject(); - // currentObjectStored.pop_back(); - // // Unroll the keysIndex - // keys = Local::Cast(currentObjectStored.back()->ToObject()); - // currentObjectStored.pop_back(); - // // Unroll the keysIndex - // keysIndex = currentObjectStored.back()->ToUint32()->Value(); - // currentObjectStored.pop_back(); - // // Check if we finished up - // if(keysIndex == keys->Length()) { - // finished = true; - // } - } - } - - return 0; -} - -//------------------------------------------------------------------------------------------------ -//------------------------------------------------------------------------------------------------ -//------------------------------------------------------------------------------------------------ -//------------------------------------------------------------------------------------------------ -Handle BSON::BSONDeserialize(const Arguments &args) { - HandleScope scope; - - // Ensure that we have an parameter - if(Buffer::HasInstance(args[0]) && args.Length() > 1) return VException("One argument required - buffer1."); - if(args[0]->IsString() && args.Length() > 1) return VException("One argument required - string1."); - // Throw an exception if the argument is not of type Buffer - if(!Buffer::HasInstance(args[0]) && !args[0]->IsString()) return VException("Argument must be a Buffer or String."); - - // Define pointer to data - char *data; - uint32_t length; - Local obj = args[0]->ToObject(); - - // Unpack the BSON parser instance - BSON *bson = ObjectWrap::Unwrap(args.This()); - - // If we passed in a buffer, let's unpack it, otherwise let's unpack the string - if(Buffer::HasInstance(obj)) { - - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 3 - Buffer *buffer = ObjectWrap::Unwrap(obj); - data = buffer->data(); - uint32_t length = buffer->length(); - #else - data = Buffer::Data(obj); - uint32_t length = Buffer::Length(obj); - #endif - - // Validate that we have at least 5 bytes - if(length < 5) { - return VException("corrupt bson message < 5 bytes long"); - } - - // Deserialize the data - return BSON::deserialize(bson, data, length, 0, NULL); - } else { - // The length of the data for this encoding - ssize_t len = DecodeBytes(args[0], BINARY); - - // Validate that we have at least 5 bytes - if(len < 5) { - return VException("corrupt bson message < 5 bytes long"); - } - - // Let's define the buffer size - data = (char *)malloc(len); - // Write the data to the buffer from the string object - ssize_t written = DecodeWrite(data, len, args[0], BINARY); - // Assert that we wrote the same number of bytes as we have length - assert(written == len); - // Get result - Handle result = BSON::deserialize(bson, data, len, 0, NULL); - // Free memory - free(data); - // Deserialize the content - return result; - } -} - -// Deserialize the stream -Handle BSON::deserialize(BSON *bson, char *data, uint32_t inDataLength, uint32_t startIndex, bool is_array_item) { - HandleScope scope; - // Holds references to the objects that are going to be returned - Local return_data = Object::New(); - Local return_array = Array::New(); - // The current index in the char data - uint32_t index = startIndex; - // Decode the size of the BSON data structure - uint32_t size = BSON::deserialize_int32(data, index); - - // If we have an illegal message size - if(size < 0 || size > inDataLength) return VException("corrupt bson message"); - - // Data length - uint32_t dataLength = index + size; - - // Adjust the index to point to next piece - index = index + 4; - - // While we have data left let's decode - while(index < dataLength) { - // Read the first to bytes to indicate the type of object we are decoding - uint8_t type = BSON::deserialize_int8(data, index); - // Handles the internal size of the object - uint32_t insert_index = 0; - // Adjust index to skip type byte - index = index + 1; - - if(type == BSON_DATA_STRING) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Read the length of the string (next 4 bytes) - uint32_t string_size = BSON::deserialize_int32(data, index); - // Adjust index to point to start of string - index = index + 4; - // Decode the string and add zero terminating value at the end of the string - char *value = (char *)malloc((string_size * sizeof(char))); - strncpy(value, (data + index), string_size); - // Encode the string (string - null termiating character) - Local utf8_encoded_str = Encode(value, string_size - 1, UTF8)->ToString(); - // Add the value to the data - if(is_array_item) { - return_array->Set(Number::New(insert_index), utf8_encoded_str); - } else { - return_data->ForceSet(String::New(string_name), utf8_encoded_str); - } - - // Adjust index - index = index + string_size; - // Free up the memory - free(value); - free(string_name); - } else if(type == BSON_DATA_INT) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Decode the integer value - uint32_t value = 0; - memcpy(&value, (data + index), 4); - - // Adjust the index for the size of the value - index = index + 4; - // Add the element to the object - if(is_array_item) { - return_array->Set(Integer::New(insert_index), Integer::New(value)); - } else { - return_data->ForceSet(String::New(string_name), Integer::New(value)); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_TIMESTAMP) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), BSON::decodeTimestamp(bson, data, index)); - } else { - return_data->ForceSet(String::New(string_name), BSON::decodeTimestamp(bson, data, index)); - } - - // Adjust the index for the size of the value - index = index + 8; - - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_LONG) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), BSON::decodeLong(bson, data, index)); - } else { - return_data->ForceSet(String::New(string_name), BSON::decodeLong(bson, data, index)); - } - - // Adjust the index for the size of the value - index = index + 8; - - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_NUMBER) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Decode the integer value - double value = 0; - memcpy(&value, (data + index), 8); - // Adjust the index for the size of the value - index = index + 8; - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), Number::New(value)); - } else { - return_data->ForceSet(String::New(string_name), Number::New(value)); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_MIN_KEY) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Create new MinKey - Local minKey = bson->minKeyConstructor->NewInstance(); - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), minKey); - } else { - return_data->ForceSet(String::New(string_name), minKey); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_MAX_KEY) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Create new MinKey - Local maxKey = bson->maxKeyConstructor->NewInstance(); - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), maxKey); - } else { - return_data->ForceSet(String::New(string_name), maxKey); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_NULL) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), Null()); - } else { - return_data->ForceSet(String::New(string_name), Null()); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_BOOLEAN) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Decode the boolean value - char bool_value = *(data + index); - // Adjust the index for the size of the value - index = index + 1; - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), bool_value == 1 ? Boolean::New(true) : Boolean::New(false)); - } else { - return_data->ForceSet(String::New(string_name), bool_value == 1 ? Boolean::New(true) : Boolean::New(false)); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_DATE) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Decode the value 64 bit integer - int64_t value = 0; - memcpy(&value, (data + index), 8); - // Adjust the index for the size of the value - index = index + 8; - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), Date::New((double)value)); - } else { - return_data->ForceSet(String::New(string_name), Date::New((double)value)); - } - // Free up the memory - free(string_name); - } else if(type == BSON_DATA_REGEXP) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Length variable - int32_t length_regexp = 0; - int32_t start_index = index; - char chr; - - // Locate end of the regexp expression \0 - while((chr = *(data + index + length_regexp)) != '\0') { - length_regexp = length_regexp + 1; - } - - // Contains the reg exp - char *reg_exp = (char *)malloc(length_regexp * sizeof(char) + 2); - // Copy the regexp from the data to the char * - memcpy(reg_exp, (data + index), (length_regexp + 1)); - // Adjust the index to skip the first part of the regular expression - index = index + length_regexp + 1; - - // Reset the length - int32_t options_length = 0; - // Locate the end of the options for the regexp terminated with a '\0' - while((chr = *(data + index + options_length)) != '\0') { - options_length = options_length + 1; - } - - // Contains the reg exp - char *options = (char *)malloc(options_length * sizeof(char) + 1); - // Copy the options from the data to the char * - memcpy(options, (data + index), (options_length + 1)); - // Adjust the index to skip the option part of the regular expression - index = index + options_length + 1; - // ARRRRGH Google does not expose regular expressions through the v8 api - // Have to use Script to instantiate the object (slower) - - // Generate the string for execution in the string context - int flag = 0; - - for(int i = 0; i < options_length; i++) { - // Multiline - if(*(options + i) == 'm') { - flag = flag | 4; - } else if(*(options + i) == 'i') { - flag = flag | 2; - } - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), RegExp::New(String::New(reg_exp), (v8::RegExp::Flags)flag)); - } else { - return_data->ForceSet(String::New(string_name), RegExp::New(String::New(reg_exp), (v8::RegExp::Flags)flag)); - } - - // Free memory - free(reg_exp); - free(options); - free(string_name); - } else if(type == BSON_DATA_OID) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // The id string - char *oid_string = (char *)malloc(12 * sizeof(char)); - // Copy the options from the data to the char * - memcpy(oid_string, (data + index), 12); - - // Adjust the index - index = index + 12; - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), BSON::decodeOid(bson, oid_string)); - } else { - return_data->ForceSet(String::New(string_name), BSON::decodeOid(bson, oid_string)); - } - - // Free memory - free(oid_string); - free(string_name); - } else if(type == BSON_DATA_BINARY) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Read the binary data size - uint32_t number_of_bytes = BSON::deserialize_int32(data, index); - // Adjust the index - index = index + 4; - // Decode the subtype, ensure it's positive - uint32_t sub_type = (int)*(data + index) & 0xff; - // Adjust the index - index = index + 1; - // Copy the binary data into a buffer - char *buffer = (char *)malloc(number_of_bytes * sizeof(char) + 1); - memcpy(buffer, (data + index), number_of_bytes); - *(buffer + number_of_bytes) = '\0'; - - // Adjust the index - index = index + number_of_bytes; - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), BSON::decodeBinary(bson, sub_type, number_of_bytes, buffer)); - } else { - return_data->ForceSet(String::New(string_name), BSON::decodeBinary(bson, sub_type, number_of_bytes, buffer)); - } - // Free memory - free(buffer); - free(string_name); - } else if(type == BSON_DATA_SYMBOL) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Read the length of the string (next 4 bytes) - uint32_t string_size = BSON::deserialize_int32(data, index); - // Adjust index to point to start of string - index = index + 4; - // Decode the string and add zero terminating value at the end of the string - char *value = (char *)malloc((string_size * sizeof(char))); - strncpy(value, (data + index), string_size); - // Encode the string (string - null termiating character) - Local utf8_encoded_str = Encode(value, string_size - 1, UTF8)->ToString(); - - // Wrap up the string in a Symbol Object - Local argv[] = {utf8_encoded_str}; - Handle symbolObj = bson->symbolConstructor->NewInstance(1, argv); - - // Add the value to the data - if(is_array_item) { - return_array->Set(Number::New(insert_index), symbolObj); - } else { - return_data->ForceSet(String::New(string_name), symbolObj); - } - - // Adjust index - index = index + string_size; - // Free up the memory - free(value); - free(string_name); - } else if(type == BSON_DATA_CODE) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Read the string size - uint32_t string_size = BSON::deserialize_int32(data, index); - // Adjust the index - index = index + 4; - // Read the string - char *code = (char *)malloc(string_size * sizeof(char) + 1); - // Copy string + terminating 0 - memcpy(code, (data + index), string_size); - - // Define empty scope object - Handle scope_object = Object::New(); - - // Define the try catch block - TryCatch try_catch; - // Decode the code object - Handle obj = BSON::decodeCode(bson, code, scope_object); - // If an error was thrown push it up the chain - if(try_catch.HasCaught()) { - free(string_name); - free(code); - // Rethrow exception - return try_catch.ReThrow(); - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), obj); - } else { - return_data->ForceSet(String::New(string_name), obj); - } - - // Clean up memory allocation - free(code); - free(string_name); - } else if(type == BSON_DATA_CODE_W_SCOPE) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Total number of bytes after array index - uint32_t total_code_size = BSON::deserialize_int32(data, index); - // Adjust the index - index = index + 4; - // Read the string size - uint32_t string_size = BSON::deserialize_int32(data, index); - // Adjust the index - index = index + 4; - // Read the string - char *code = (char *)malloc(string_size * sizeof(char) + 1); - // Copy string + terminating 0 - memcpy(code, (data + index), string_size); - // Adjust the index - index = index + string_size; - // Get the scope object (bson object) - uint32_t bson_object_size = total_code_size - string_size - 8; - // Allocate bson object buffer and copy out the content - char *bson_buffer = (char *)malloc(bson_object_size * sizeof(char)); - memcpy(bson_buffer, (data + index), bson_object_size); - // Adjust the index - index = index + bson_object_size; - // Parse the bson object - Handle scope_object = BSON::deserialize(bson, bson_buffer, inDataLength, 0, false); - // Define the try catch block - TryCatch try_catch; - // Decode the code object - Handle obj = BSON::decodeCode(bson, code, scope_object); - // If an error was thrown push it up the chain - if(try_catch.HasCaught()) { - // Clean up memory allocation - free(string_name); - free(bson_buffer); - free(code); - // Rethrow exception - return try_catch.ReThrow(); - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), obj); - } else { - return_data->ForceSet(String::New(string_name), obj); - } - - // Clean up memory allocation - free(code); - free(bson_buffer); - free(string_name); - } else if(type == BSON_DATA_OBJECT) { - // If this is the top level object we need to skip the undecoding - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Get the object size - uint32_t bson_object_size = BSON::deserialize_int32(data, index); - // Define the try catch block - TryCatch try_catch; - // Decode the code object - Handle obj = BSON::deserialize(bson, data + index, inDataLength, 0, false); - // Adjust the index - index = index + bson_object_size; - // If an error was thrown push it up the chain - if(try_catch.HasCaught()) { - // Rethrow exception - return try_catch.ReThrow(); - } - - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), obj); - } else { - return_data->ForceSet(String::New(string_name), obj); - } - - // Clean up memory allocation - free(string_name); - } else if(type == BSON_DATA_ARRAY) { - // Read the null terminated index String - char *string_name = BSON::extract_string(data, index); - if(string_name == NULL) return VException("Invalid C String found."); - // Let's create a new string - index = index + strlen(string_name) + 1; - // Handle array value if applicable - uint32_t insert_index = 0; - if(is_array_item) { - insert_index = atoi(string_name); - } - - // Get the size - uint32_t array_size = BSON::deserialize_int32(data, index); - // Define the try catch block - TryCatch try_catch; - - // Decode the code object - Handle obj = BSON::deserialize(bson, data + index, inDataLength, 0, true); - // If an error was thrown push it up the chain - if(try_catch.HasCaught()) { - // Rethrow exception - return try_catch.ReThrow(); - } - // Adjust the index for the next value - index = index + array_size; - // Add the element to the object - if(is_array_item) { - return_array->Set(Number::New(insert_index), obj); - } else { - return_data->ForceSet(String::New(string_name), obj); - } - // Clean up memory allocation - free(string_name); - } - } - - // Check if we have a db reference - if(!is_array_item && return_data->Has(String::New("$ref")) && return_data->Has(String::New("$id"))) { - Handle dbrefValue = BSON::decodeDBref(bson, return_data->Get(String::New("$ref")), return_data->Get(String::New("$id")), return_data->Get(String::New("$db"))); - return scope.Close(dbrefValue); - } - - // Return the data object to javascript - if(is_array_item) { - return scope.Close(return_array); - } else { - return scope.Close(return_data); - } -} - -Handle BSON::BSONSerialize(const Arguments &args) { - HandleScope scope; - - if(args.Length() == 1 && !args[0]->IsObject()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - if(args.Length() == 2 && !args[0]->IsObject() && !args[1]->IsBoolean()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - if(args.Length() == 3 && !args[0]->IsObject() && !args[1]->IsBoolean() && !args[2]->IsBoolean()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean]"); - if(args.Length() == 4 && !args[0]->IsObject() && !args[1]->IsBoolean() && !args[2]->IsBoolean() && !args[3]->IsBoolean()) return VException("One, two or tree arguments required - [object] or [object, boolean] or [object, boolean, boolean] or [object, boolean, boolean, boolean]"); - if(args.Length() > 4) return VException("One, two, tree or four arguments required - [object] or [object, boolean] or [object, boolean, boolean] or [object, boolean, boolean, boolean]"); - - // Unpack the BSON parser instance - BSON *bson = ObjectWrap::Unwrap(args.This()); - - uint32_t object_size = 0; - // Calculate the total size of the document in binary form to ensure we only allocate memory once - // With serialize function - if(args.Length() == 4) { - object_size = BSON::calculate_object_size(bson, args[0], args[3]->BooleanValue()); - } else { - object_size = BSON::calculate_object_size(bson, args[0], false); - } - - // Allocate the memory needed for the serializtion - char *serialized_object = (char *)malloc(object_size * sizeof(char)); - // Catch any errors - try { - // Check if we have a boolean value - bool check_key = false; - if(args.Length() >= 3 && args[1]->IsBoolean()) { - check_key = args[1]->BooleanValue(); - } - - // Check if we have a boolean value - bool serializeFunctions = false; - if(args.Length() == 4 && args[1]->IsBoolean()) { - serializeFunctions = args[3]->BooleanValue(); - } - - // Serialize the object - BSON::serialize(bson, serialized_object, 0, Null(), args[0], check_key, serializeFunctions); - } catch(char *err_msg) { - // Free up serialized object space - free(serialized_object); - V8::AdjustAmountOfExternalAllocatedMemory(-object_size); - // Throw exception with the string - Handle error = VException(err_msg); - // free error message - free(err_msg); - // Return error - return error; - } - - // Write the object size - BSON::write_int32((serialized_object), object_size); - - // If we have 3 arguments - if(args.Length() == 3 || args.Length() == 4) { - // Local asBuffer = args[2]->ToBoolean(); - Buffer *buffer = Buffer::New(serialized_object, object_size); - // Release the serialized string - free(serialized_object); - return scope.Close(buffer->handle_); - } else { - // Encode the string (string - null termiating character) - Local bin_value = Encode(serialized_object, object_size, BINARY)->ToString(); - // Return the serialized content - return bin_value; - } -} - -Handle BSON::CalculateObjectSize(const Arguments &args) { - HandleScope scope; - // Ensure we have a valid object - if(args.Length() == 1 && !args[0]->IsObject()) return VException("One argument required - [object]"); - if(args.Length() == 2 && !args[0]->IsObject() && !args[1]->IsBoolean()) return VException("Two arguments required - [object, boolean]"); - if(args.Length() > 3) return VException("One or two arguments required - [object] or [object, boolean]"); - - // Unpack the BSON parser instance - BSON *bson = ObjectWrap::Unwrap(args.This()); - - // Object size - uint32_t object_size = 0; - // Check if we have our argument, calculate size of the object - if(args.Length() == 2) { - object_size = BSON::calculate_object_size(bson, args[0], args[1]->BooleanValue()); - } else { - object_size = BSON::calculate_object_size(bson, args[0], false); - } - - // Return the object size - return scope.Close(Uint32::New(object_size)); -} - -uint32_t BSON::calculate_object_size(BSON *bson, Handle value, bool serializeFunctions) { - uint32_t object_size = 0; - - // If we have an object let's unwrap it and calculate the sub sections - if(value->IsString()) { - // Let's calculate the size the string adds, length + type(1 byte) + size(4 bytes) - object_size += value->ToString()->Utf8Length() + 1 + 4; - } else if(value->IsNumber()) { - // Check if we have a float value or a long value - Local number = value->ToNumber(); - double d_number = number->NumberValue(); - int64_t l_number = number->IntegerValue(); - // Check if we have a double value and not a int64 - double d_result = d_number - l_number; - // If we have a value after subtracting the integer value we have a float - if(d_result > 0 || d_result < 0) { - object_size = object_size + 8; - } else if(l_number <= BSON_INT32_MAX && l_number >= BSON_INT32_MIN) { - object_size = object_size + 4; - } else { - object_size = object_size + 8; - } - } else if(value->IsBoolean()) { - object_size = object_size + 1; - } else if(value->IsDate()) { - object_size = object_size + 8; - } else if(value->IsRegExp()) { - // Fetch the string for the regexp - Handle regExp = Handle::Cast(value); - ssize_t len = DecodeBytes(regExp->GetSource(), UTF8); - int flags = regExp->GetFlags(); - - // global - if((flags & (1 << 0)) != 0) len++; - // ignorecase - if((flags & (1 << 1)) != 0) len++; - //multiline - if((flags & (1 << 2)) != 0) len++; - // if((flags & (1 << 2)) != 0) len++; - // Calculate the space needed for the regexp: size of string - 2 for the /'ses +2 for null termiations - object_size = object_size + len + 2; - } else if(value->IsNull() || value->IsUndefined()) { - } else if(value->IsArray()) { - // Cast to array - Local array = Local::Cast(value->ToObject()); - // Turn length into string to calculate the size of all the strings needed - char *length_str = (char *)malloc(256 * sizeof(char)); - // Calculate the size of each element - for(uint32_t i = 0; i < array->Length(); i++) { - // Add "index" string size for each element - sprintf(length_str, "%d", i); - // Add the size of the string length - uint32_t label_length = strlen(length_str) + 1; - // Add the type definition size for each item - object_size = object_size + label_length + 1; - // Add size of the object - uint32_t object_length = BSON::calculate_object_size(bson, array->Get(Integer::New(i)), serializeFunctions); - object_size = object_size + object_length; - } - // Add the object size - object_size = object_size + 4 + 1; - // Free up memory - free(length_str); - } else if(value->IsFunction()) { - if(serializeFunctions) { - object_size += value->ToString()->Utf8Length() + 4 + 1; - } - } else if(value->ToObject()->Has(bson->_bsontypeString)) { - // Handle holder - Local constructorString = value->ToObject()->GetConstructorName(); - - // BSON type object, avoid non-needed checking unless we have a type - if(bson->longString->StrictEquals(constructorString)) { - object_size = object_size + 8; - } else if(bson->timestampString->StrictEquals(constructorString)) { - object_size = object_size + 8; - } else if(bson->objectIDString->StrictEquals(constructorString)) { - object_size = object_size + 12; - } else if(bson->binaryString->StrictEquals(constructorString)) { - // Unpack the object and encode - Local positionObj = value->ToObject()->Get(String::New("position"))->ToUint32(); - // Adjust the object_size, binary content lengt + total size int32 + binary size int32 + subtype - object_size += positionObj->Value() + 4 + 1; - } else if(bson->codeString->StrictEquals(constructorString)) { - // Unpack the object and encode - Local obj = value->ToObject(); - // Get the function - Local function = obj->Get(String::New("code"))->ToString(); - // Get the scope object - Local scope = obj->Get(String::New("scope"))->ToObject(); - - // For Node < 0.6.X use the GetPropertyNames - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - uint32_t propertyNameLength = scope->GetPropertyNames()->Length(); - #else - uint32_t propertyNameLength = scope->GetOwnPropertyNames()->Length(); - #endif - - // Check if the scope has any parameters - // Let's calculate the size the code object adds adds - if(propertyNameLength > 0) { - object_size += function->Utf8Length() + 4 + BSON::calculate_object_size(bson, scope, serializeFunctions) + 4 + 1; - } else { - object_size += function->Utf8Length() + 4 + 1; - } - } else if(bson->dbrefString->StrictEquals(constructorString)) { - // Unpack the dbref - Local dbref = value->ToObject(); - // Create an object containing the right namespace variables - Local obj = Object::New(); - // Build the new object - obj->Set(bson->_dbRefRefString, dbref->Get(bson->_dbRefNamespaceString)); - obj->Set(bson->_dbRefIdRefString, dbref->Get(bson->_dbRefOidString)); - if(!dbref->Get(bson->_dbRefDbString)->IsNull() && !dbref->Get(bson->_dbRefDbString)->IsUndefined()) obj->Set(bson->_dbRefDbRefString, dbref->Get(bson->_dbRefDbString)); - // Calculate size - object_size += BSON::calculate_object_size(bson, obj, serializeFunctions); - } else if(bson->minKeyString->StrictEquals(constructorString) || bson->maxKeyString->Equals(constructorString)) { - } else if(bson->symbolString->StrictEquals(constructorString)) { - // Get string - Local str = value->ToObject()->Get(String::New("value"))->ToString(); - // Get the utf8 length - uint32_t utf8_length = str->Utf8Length(); - // Check if we have a utf8 encoded string or not - if(utf8_length != str->Length()) { - // Let's calculate the size the string adds, length + type(1 byte) + size(4 bytes) - object_size += str->Utf8Length() + 1 + 4; - } else { - object_size += str->Length() + 1 + 4; - } - } else if(bson->doubleString->StrictEquals(constructorString)) { - object_size = object_size + 8; - } - } else if(value->IsObject()) { - // Unwrap the object - Local object = value->ToObject(); - - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - Local property_names = object->GetPropertyNames(); - #else - Local property_names = object->GetOwnPropertyNames(); - #endif - - // Length of the property - uint32_t propertyLength = property_names->Length(); - - // Process all the properties on the object - for(uint32_t index = 0; index < propertyLength; index++) { - // Fetch the property name - Local property_name = property_names->Get(index)->ToString(); - - // Fetch the object for the property - Local property = object->Get(property_name); - // Get size of property (property + property name length + 1 for terminating 0) - if(!property->IsFunction() || (property->IsFunction() && serializeFunctions)) { - // Convert name to char* - object_size += BSON::calculate_object_size(bson, property, serializeFunctions) + property_name->Utf8Length() + 1 + 1; - } - } - - object_size = object_size + 4 + 1; - } - - return object_size; -} - -uint32_t BSON::serialize(BSON *bson, char *serialized_object, uint32_t index, Handle name, Handle value, bool check_key, bool serializeFunctions) { - // Scope for method execution - HandleScope scope; - - // If we have a name check that key is valid - if(!name->IsNull() && check_key) { - if(BSON::check_key(name->ToString()) != NULL) return -1; - } - - // If we have an object let's serialize it - if(value->IsString()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_STRING; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // Write the actual string into the char array - Local str = value->ToString(); - // Let's fetch the int value - uint32_t utf8_length = str->Utf8Length(); - - // Write the integer to the char * - BSON::write_int32((serialized_object + index), utf8_length + 1); - // Adjust the index - index = index + 4; - // Write string to char in utf8 format - str->WriteUtf8((serialized_object + index), utf8_length); - // Add the null termination - *(serialized_object + index + utf8_length) = '\0'; - // Adjust the index - index = index + utf8_length + 1; - } else if(value->IsNumber()) { - uint32_t first_pointer = index; - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_INT; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - Local number = value->ToNumber(); - // Get the values - double d_number = number->NumberValue(); - int64_t l_number = number->IntegerValue(); - - // Check if we have a double value and not a int64 - double d_result = d_number - l_number; - // If we have a value after subtracting the integer value we have a float - if(d_result > 0 || d_result < 0) { - // Write the double to the char array - BSON::write_double((serialized_object + index), d_number); - // Adjust type to be double - *(serialized_object + first_pointer) = BSON_DATA_NUMBER; - // Adjust index for double - index = index + 8; - } else if(l_number <= BSON_INT32_MAX && l_number >= BSON_INT32_MIN) { - // Smaller than 32 bit, write as 32 bit value - BSON::write_int32(serialized_object + index, value->ToInt32()->Value()); - // Adjust the size of the index - index = index + 4; - } else if(l_number <= JS_INT_MAX && l_number >= JS_INT_MIN) { - // Write the double to the char array - BSON::write_double((serialized_object + index), d_number); - // Adjust type to be double - *(serialized_object + first_pointer) = BSON_DATA_NUMBER; - // Adjust index for double - index = index + 8; - } else { - BSON::write_double((serialized_object + index), d_number); - // Adjust type to be double - *(serialized_object + first_pointer) = BSON_DATA_NUMBER; - // Adjust the size of the index - index = index + 8; - } - } else if(value->IsBoolean()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_BOOLEAN; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // Save the boolean value - *(serialized_object + index) = value->BooleanValue() ? '\1' : '\0'; - // Adjust the index - index = index + 1; - } else if(value->IsDate()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_DATE; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // Fetch the Integer value - int64_t integer_value = value->IntegerValue(); - BSON::write_int64((serialized_object + index), integer_value); - // Adjust the index - index = index + 8; - } else if(value->IsNull() || value->IsUndefined()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_NULL; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - } else if(value->IsArray()) { - // Cast to array - Local array = Local::Cast(value->ToObject()); - // Turn length into string to calculate the size of all the strings needed - char *length_str = (char *)malloc(256 * sizeof(char)); - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_ARRAY; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - // Object size - uint32_t object_size = BSON::calculate_object_size(bson, value, serializeFunctions); - // Write the size of the object - BSON::write_int32((serialized_object + index), object_size); - // Adjust the index - index = index + 4; - // Write out all the elements - for(uint32_t i = 0; i < array->Length(); i++) { - // Add "index" string size for each element - sprintf(length_str, "%d", i); - // Encode the values - index = BSON::serialize(bson, serialized_object, index, String::New(length_str), array->Get(Integer::New(i)), check_key, serializeFunctions); - // Write trailing '\0' for object - *(serialized_object + index) = '\0'; - } - - // Pad the last item - *(serialized_object + index) = '\0'; - index = index + 1; - // Free up memory - free(length_str); - } else if(value->IsRegExp()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_REGEXP; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // Fetch the string for the regexp - Handle regExp = Handle::Cast(value); - len = DecodeBytes(regExp->GetSource(), UTF8); - written = DecodeWrite((serialized_object + index), len, regExp->GetSource(), UTF8); - int flags = regExp->GetFlags(); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // global - if((flags & (1 << 0)) != 0) { - *(serialized_object + index) = 's'; - index = index + 1; - } - - // ignorecase - if((flags & (1 << 1)) != 0) { - *(serialized_object + index) = 'i'; - index = index + 1; - } - - //multiline - if((flags & (1 << 2)) != 0) { - *(serialized_object + index) = 'm'; - index = index + 1; - } - - // Add null termiation for the string - *(serialized_object + index) = '\0'; - // Adjust the index - index = index + 1; - } else if(value->IsFunction()) { - if(serializeFunctions) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_CODE; - - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - - // Function String - Local function = value->ToString(); - - // Decode the function - len = DecodeBytes(function, BINARY); - // Write the size of the code string + 0 byte end of cString - BSON::write_int32((serialized_object + index), len + 1); - // Adjust the index - index = index + 4; - - // Write the data into the serialization stream - written = DecodeWrite((serialized_object + index), len, function, BINARY); - // Write \0 for string - *(serialized_object + index + len) = 0x00; - // Adjust the index - index = index + len + 1; - } - } else if(value->ToObject()->Has(bson->_bsontypeString)) { - // Handle holder - Local constructorString = value->ToObject()->GetConstructorName(); - uint32_t originalIndex = index; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = 0x00; - // Adjust the index - index = index + len + 1; - - // BSON type object, avoid non-needed checking unless we have a type - if(bson->longString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_LONG; - // Object reference - Local longObject = value->ToObject(); - - // Fetch the low and high bits - int32_t lowBits = longObject->Get(bson->_longLowString)->ToInt32()->Value(); - int32_t highBits = longObject->Get(bson->_longHighString)->ToInt32()->Value(); - - // Write the content to the char array - BSON::write_int32((serialized_object + index), lowBits); - BSON::write_int32((serialized_object + index + 4), highBits); - // Adjust the index - index = index + 8; - } else if(bson->timestampString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_TIMESTAMP; - // Object reference - Local timestampObject = value->ToObject(); - - // Fetch the low and high bits - int32_t lowBits = timestampObject->Get(bson->_longLowString)->ToInt32()->Value(); - int32_t highBits = timestampObject->Get(bson->_longHighString)->ToInt32()->Value(); - - // Write the content to the char array - BSON::write_int32((serialized_object + index), lowBits); - BSON::write_int32((serialized_object + index + 4), highBits); - // Adjust the index - index = index + 8; - } else if(bson->objectIDString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_OID; - // Convert to object - Local objectIDObject = value->ToObject(); - // Let's grab the id - Local idString = objectIDObject->Get(bson->_objectIDidString)->ToString(); - // Let's decode the raw chars from the string - len = DecodeBytes(idString, BINARY); - written = DecodeWrite((serialized_object + index), len, idString, BINARY); - // Adjust the index - index = index + 12; - } else if(bson->binaryString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_BINARY; - - // Let's get the binary object - Local binaryObject = value->ToObject(); - - // Grab the size(position of the binary) - uint32_t position = value->ToObject()->Get(bson->_binaryPositionString)->ToUint32()->Value(); - // Grab the subtype - uint32_t subType = value->ToObject()->Get(bson->_binarySubTypeString)->ToUint32()->Value(); - // Grab the buffer object - Local bufferObj = value->ToObject()->Get(bson->_binaryBufferString)->ToObject(); - - // Buffer data pointers - char *data; - uint32_t length; - - // Unpack the buffer variable - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 3 - Buffer *buffer = ObjectWrap::Unwrap(bufferObj); - data = buffer->data(); - length = buffer->length(); - #else - data = Buffer::Data(bufferObj); - length = Buffer::Length(bufferObj); - #endif - - // Write the size of the buffer out - BSON::write_int32((serialized_object + index), position); - // Adjust index - index = index + 4; - // Write subtype - *(serialized_object + index) = (char)subType; - // Adjust index - index = index + 1; - // Write binary content - memcpy((serialized_object + index), data, position); - // Adjust index.rar">_ - index = index + position; - } else if(bson->doubleString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_NUMBER; - - // Unpack the double - Local doubleObject = value->ToObject(); - - // Fetch the double value - Local doubleValue = doubleObject->Get(bson->_doubleValueString)->ToNumber(); - // Write the double to the char array - BSON::write_double((serialized_object + index), doubleValue->NumberValue()); - // Adjust index for double - index = index + 8; - } else if(bson->symbolString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_SYMBOL; - // Unpack symbol object - Local symbolObj = value->ToObject(); - - // Grab the actual string - Local str = symbolObj->Get(bson->_symbolValueString)->ToString(); - // Let's fetch the int value - uint32_t utf8_length = str->Utf8Length(); - - // If the Utf8 length is different from the string length then we - // have a UTF8 encoded string, otherwise write it as ascii - if(utf8_length != str->Length()) { - // Write the integer to the char * - BSON::write_int32((serialized_object + index), utf8_length + 1); - // Adjust the index - index = index + 4; - // Write string to char in utf8 format - str->WriteUtf8((serialized_object + index), utf8_length); - // Add the null termination - *(serialized_object + index + utf8_length) = '\0'; - // Adjust the index - index = index + utf8_length + 1; - } else { - // Write the integer to the char * - BSON::write_int32((serialized_object + index), str->Length() + 1); - // Adjust the index - index = index + 4; - // Write string to char in utf8 format - written = DecodeWrite((serialized_object + index), str->Length(), str, BINARY); - // Add the null termination - *(serialized_object + index + str->Length()) = '\0'; - // Adjust the index - index = index + str->Length() + 1; - } - } else if(bson->codeString->StrictEquals(constructorString)) { - // Unpack the object and encode - Local obj = value->ToObject(); - // Get the function - Local function = obj->Get(String::New("code"))->ToString(); - // Get the scope object - Local scope = obj->Get(String::New("scope"))->ToObject(); - - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - uint32_t propertyNameLength = scope->GetPropertyNames()->Length(); - #else - uint32_t propertyNameLength = scope->GetOwnPropertyNames()->Length(); - #endif - - // Set the right type if we have a scope or not - if(propertyNameLength > 0) { - // Set basic data code object with scope object - *(serialized_object + originalIndex) = BSON_DATA_CODE_W_SCOPE; - - // Calculate the size of the whole object - uint32_t scopeSize = BSON::calculate_object_size(bson, scope, false); - // Decode the function length - ssize_t len = DecodeBytes(function, UTF8); - // Calculate total size - uint32_t size = 4 + len + 1 + 4 + scopeSize; - - // Write the total size - BSON::write_int32((serialized_object + index), size); - // Adjust the index - index = index + 4; - - // Write the function size - BSON::write_int32((serialized_object + index), len + 1); - // Adjust the index - index = index + 4; - - // Write the data into the serialization stream - ssize_t written = DecodeWrite((serialized_object + index), len, function, UTF8); - // Write \0 for string - *(serialized_object + index + len) = 0x00; - // Adjust the index with the length of the function - index = index + len + 1; - // Write the scope object - BSON::serialize(bson, (serialized_object + index), 0, Null(), scope, check_key, serializeFunctions); - // Adjust the index - index = index + scopeSize; - } else { - // Set basic data code object - *(serialized_object + originalIndex) = BSON_DATA_CODE; - // Decode the function - ssize_t len = DecodeBytes(function, BINARY); - // Write the size of the code string + 0 byte end of cString - BSON::write_int32((serialized_object + index), len + 1); - // Adjust the index - index = index + 4; - - // Write the data into the serialization stream - ssize_t written = DecodeWrite((serialized_object + index), len, function, BINARY); - // Write \0 for string - *(serialized_object + index + len) = 0x00; - // Adjust the index - index = index + len + 1; - } - } else if(bson->dbrefString->StrictEquals(constructorString)) { - // Unpack the dbref - Local dbref = value->ToObject(); - // Create an object containing the right namespace variables - Local obj = Object::New(); - - // Build the new object - obj->Set(bson->_dbRefRefString, dbref->Get(bson->_dbRefNamespaceString)); - obj->Set(bson->_dbRefIdRefString, dbref->Get(bson->_dbRefOidString)); - if(!dbref->Get(bson->_dbRefDbString)->IsNull() && !dbref->Get(bson->_dbRefDbString)->IsUndefined()) obj->Set(bson->_dbRefDbRefString, dbref->Get(bson->_dbRefDbString)); - - // Encode the variable - index = BSON::serialize(bson, serialized_object, originalIndex, name, obj, false, serializeFunctions); - } else if(bson->minKeyString->StrictEquals(constructorString)) { - // Save the string at the offset provided - *(serialized_object + originalIndex) = BSON_DATA_MIN_KEY; - } else if(bson->maxKeyString->StrictEquals(constructorString)) { - *(serialized_object + originalIndex) = BSON_DATA_MAX_KEY; - } - } else if(value->IsObject()) { - if(!name->IsNull()) { - // Save the string at the offset provided - *(serialized_object + index) = BSON_DATA_OBJECT; - // Adjust writing position for the first byte - index = index + 1; - // Convert name to char* - ssize_t len = DecodeBytes(name, UTF8); - ssize_t written = DecodeWrite((serialized_object + index), len, name, UTF8); - // Add null termiation for the string - *(serialized_object + index + len) = '\0'; - // Adjust the index - index = index + len + 1; - } - - // Unwrap the object - Local object = value->ToObject(); - - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 6 - Local property_names = object->GetPropertyNames(); - #else - Local property_names = object->GetOwnPropertyNames(); - #endif - - // Calculate size of the total object - uint32_t object_size = BSON::calculate_object_size(bson, value, serializeFunctions); - // Write the size - BSON::write_int32((serialized_object + index), object_size); - // Adjust size - index = index + 4; - - // Process all the properties on the object - for(uint32_t i = 0; i < property_names->Length(); i++) { - // Fetch the property name - Local property_name = property_names->Get(i)->ToString(); - // Fetch the object for the property - Local property = object->Get(property_name); - // Write the next serialized object - // printf("========== !property->IsFunction() || (property->IsFunction() && serializeFunctions) = %d\n", !property->IsFunction() || (property->IsFunction() && serializeFunctions) == true ? 1 : 0); - if(!property->IsFunction() || (property->IsFunction() && serializeFunctions)) { - // Convert name to char* - ssize_t len = DecodeBytes(property_name, UTF8); - // char *data = new char[len]; - char *data = (char *)malloc(len + 1); - *(data + len) = '\0'; - ssize_t written = DecodeWrite(data, len, property_name, UTF8); - // Serialize the content - index = BSON::serialize(bson, serialized_object, index, property_name, property, check_key, serializeFunctions); - // Free up memory of data - free(data); - } - } - // Pad the last item - *(serialized_object + index) = '\0'; - index = index + 1; - - // Null out reminding fields if we have a toplevel object and nested levels - if(name->IsNull()) { - for(uint32_t i = 0; i < (object_size - index); i++) { - *(serialized_object + index + i) = '\0'; - } - } - } - - return index; -} - -Handle BSON::SerializeWithBufferAndIndex(const Arguments &args) { - HandleScope scope; - - //BSON.serializeWithBufferAndIndex = function serializeWithBufferAndIndex(object, checkKeys, buffer, index) { - // Ensure we have the correct values - if(args.Length() > 5) return VException("Four or five parameters required [object, boolean, Buffer, int] or [object, boolean, Buffer, int, boolean]"); - if(args.Length() == 4 && !args[0]->IsObject() && !args[1]->IsBoolean() && !Buffer::HasInstance(args[2]) && !args[3]->IsUint32()) return VException("Four parameters required [object, boolean, Buffer, int]"); - if(args.Length() == 5 && !args[0]->IsObject() && !args[1]->IsBoolean() && !Buffer::HasInstance(args[2]) && !args[3]->IsUint32() && !args[4]->IsBoolean()) return VException("Four parameters required [object, boolean, Buffer, int, boolean]"); - - // Unpack the BSON parser instance - BSON *bson = ObjectWrap::Unwrap(args.This()); - - // Define pointer to data - char *data; - uint32_t length; - // Unpack the object - Local obj = args[2]->ToObject(); - - // Unpack the buffer object and get pointers to structures - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 3 - Buffer *buffer = ObjectWrap::Unwrap(obj); - data = buffer->data(); - length = buffer->length(); - #else - data = Buffer::Data(obj); - length = Buffer::Length(obj); - #endif - - uint32_t object_size = 0; - // Calculate the total size of the document in binary form to ensure we only allocate memory once - if(args.Length() == 5) { - object_size = BSON::calculate_object_size(bson, args[0], args[4]->BooleanValue()); - } else { - object_size = BSON::calculate_object_size(bson, args[0], false); - } - - // Unpack the index variable - Local indexObject = args[3]->ToUint32(); - uint32_t index = indexObject->Value(); - - // Allocate the memory needed for the serializtion - char *serialized_object = (char *)malloc(object_size * sizeof(char)); - - // Catch any errors - try { - // Check if we have a boolean value - bool check_key = false; - if(args.Length() >= 4 && args[1]->IsBoolean()) { - check_key = args[1]->BooleanValue(); - } - - bool serializeFunctions = false; - if(args.Length() == 5) { - serializeFunctions = args[4]->BooleanValue(); - } - - // Serialize the object - BSON::serialize(bson, serialized_object, 0, Null(), args[0], check_key, serializeFunctions); - } catch(char *err_msg) { - // Free up serialized object space - free(serialized_object); - V8::AdjustAmountOfExternalAllocatedMemory(-object_size); - // Throw exception with the string - Handle error = VException(err_msg); - // free error message - free(err_msg); - // Return error - return error; - } - - for(int i = 0; i < object_size; i++) { - *(data + index + i) = *(serialized_object + i); - } - - return scope.Close(Uint32::New(index + object_size - 1)); -} - -Handle BSON::BSONDeserializeStream(const Arguments &args) { - HandleScope scope; - - // At least 3 arguments required - if(args.Length() < 5) VException("Arguments required (Buffer(data), Number(index in data), Number(number of documents to deserialize), Array(results), Number(index in the array), Object(optional))"); - - // If the number of argumets equals 3 - if(args.Length() >= 5) { - if(!Buffer::HasInstance(args[0])) return VException("First argument must be Buffer instance"); - if(!args[1]->IsUint32()) return VException("Second argument must be a positive index number"); - if(!args[2]->IsUint32()) return VException("Third argument must be a positive number of documents to deserialize"); - if(!args[3]->IsArray()) return VException("Fourth argument must be an array the size of documents to deserialize"); - if(!args[4]->IsUint32()) return VException("Sixth argument must be a positive index number"); - } - - // If we have 4 arguments - if(args.Length() == 6 && !args[5]->IsObject()) return VException("Fifth argument must be an object with options"); - - // Define pointer to data - char *data; - uint32_t length; - Local obj = args[0]->ToObject(); - uint32_t numberOfDocuments = args[2]->ToUint32()->Value(); - uint32_t index = args[1]->ToUint32()->Value(); - uint32_t resultIndex = args[4]->ToUint32()->Value(); - - // Unpack the BSON parser instance - BSON *bson = ObjectWrap::Unwrap(args.This()); - - // Unpack the buffer variable - #if NODE_MAJOR_VERSION == 0 && NODE_MINOR_VERSION < 3 - Buffer *buffer = ObjectWrap::Unwrap(obj); - data = buffer->data(); - length = buffer->length(); - #else - data = Buffer::Data(obj); - length = Buffer::Length(obj); - #endif - - // Fetch the documents - Local documents = args[3]->ToObject(); - - for(uint32_t i = 0; i < numberOfDocuments; i++) { - // Decode the size of the BSON data structure - uint32_t size = BSON::deserialize_int32(data, index); - - // Get result - Handle result = BSON::deserialize(bson, data, size, index, NULL); - - // Add result to array - documents->Set(i + resultIndex, result); - - // Adjust the index for next pass - index = index + size; - } - - // Return new index of parsing - return scope.Close(Uint32::New(index)); -} - -// Exporting function -extern "C" void init(Handle target) { - HandleScope scope; - BSON::Initialize(target); -} - -// NODE_MODULE(bson, BSON::Initialize); -// NODE_MODULE(l, Long::Initialize); diff --git a/external-libs/bson/bson.h b/external-libs/bson/bson.h deleted file mode 100644 index dcf21d17af6..00000000000 --- a/external-libs/bson/bson.h +++ /dev/null @@ -1,105 +0,0 @@ -#ifndef BSON_H_ -#define BSON_H_ - -#include -#include -#include - -using namespace v8; -using namespace node; - -class BSON : public ObjectWrap { - public: - BSON() : ObjectWrap() {} - ~BSON() {} - - static void Initialize(Handle target); - static Handle BSONDeserializeStream(const Arguments &args); - - // JS based objects - static Handle BSONSerialize(const Arguments &args); - static Handle BSONDeserialize(const Arguments &args); - - // Calculate size of function - static Handle CalculateObjectSize(const Arguments &args); - static Handle SerializeWithBufferAndIndex(const Arguments &args); - - // Experimental - static Handle CalculateObjectSize2(const Arguments &args); - static Handle BSONSerialize2(const Arguments &args); - - // Constructor used for creating new BSON objects from C++ - static Persistent constructor_template; - - private: - static Handle New(const Arguments &args); - static Handle deserialize(BSON *bson, char *data, uint32_t dataLength, uint32_t startIndex, bool is_array_item); - static uint32_t serialize(BSON *bson, char *serialized_object, uint32_t index, Handle name, Handle value, bool check_key, bool serializeFunctions); - - static char* extract_string(char *data, uint32_t offset); - static const char* ToCString(const v8::String::Utf8Value& value); - static uint32_t calculate_object_size(BSON *bson, Handle object, bool serializeFunctions); - - static void write_int32(char *data, uint32_t value); - static void write_int64(char *data, int64_t value); - static void write_double(char *data, double value); - static uint16_t deserialize_int8(char *data, uint32_t offset); - static uint32_t deserialize_int32(char* data, uint32_t offset); - static char *check_key(Local key); - - // BSON type instantiate functions - Persistent longConstructor; - Persistent objectIDConstructor; - Persistent binaryConstructor; - Persistent codeConstructor; - Persistent dbrefConstructor; - Persistent symbolConstructor; - Persistent doubleConstructor; - Persistent timestampConstructor; - Persistent minKeyConstructor; - Persistent maxKeyConstructor; - - // Equality Objects - Persistent longString; - Persistent objectIDString; - Persistent binaryString; - Persistent codeString; - Persistent dbrefString; - Persistent symbolString; - Persistent doubleString; - Persistent timestampString; - Persistent minKeyString; - Persistent maxKeyString; - - // Equality speed up comparision objects - Persistent _bsontypeString; - Persistent _longLowString; - Persistent _longHighString; - Persistent _objectIDidString; - Persistent _binaryPositionString; - Persistent _binarySubTypeString; - Persistent _binaryBufferString; - Persistent _doubleValueString; - Persistent _symbolValueString; - - Persistent _dbRefRefString; - Persistent _dbRefIdRefString; - Persistent _dbRefDbRefString; - Persistent _dbRefNamespaceString; - Persistent _dbRefDbString; - Persistent _dbRefOidString; - - // Decode JS function - static Handle decodeLong(BSON *bson, char *data, uint32_t index); - static Handle decodeTimestamp(BSON *bson, char *data, uint32_t index); - static Handle decodeOid(BSON *bson, char *oid); - static Handle decodeBinary(BSON *bson, uint32_t sub_type, uint32_t number_of_bytes, char *data); - static Handle decodeCode(BSON *bson, char *code, Handle scope); - static Handle decodeDBref(BSON *bson, Local ref, Local oid, Local db); - - // Experimental - static uint32_t calculate_object_size2(Handle object); - static uint32_t serialize2(char *serialized_object, uint32_t index, Handle name, Handle value, uint32_t object_size, bool check_key); -}; - -#endif // BSON_H_ diff --git a/external-libs/bson/index.js b/external-libs/bson/index.js deleted file mode 100644 index 2c66dee6cca..00000000000 --- a/external-libs/bson/index.js +++ /dev/null @@ -1,20 +0,0 @@ -var bson = require('./bson'); -exports.BSON = bson.BSON; -exports.Long = require('../../lib/mongodb/bson/long').Long; -exports.ObjectID = require('../../lib/mongodb/bson/objectid').ObjectID; -exports.DBRef = require('../../lib/mongodb/bson/db_ref').DBRef; -exports.Code = require('../../lib/mongodb/bson/code').Code; -exports.Timestamp = require('../../lib/mongodb/bson/timestamp').Timestamp; -exports.Binary = require('../../lib/mongodb/bson/binary').Binary; -exports.Double = require('../../lib/mongodb/bson/double').Double; -exports.MaxKey = require('../../lib/mongodb/bson/max_key').MaxKey; -exports.MinKey = require('../../lib/mongodb/bson/min_key').MinKey; -exports.Symbol = require('../../lib/mongodb/bson/symbol').Symbol; - -// Just add constants tot he Native BSON parser -exports.BSON.BSON_BINARY_SUBTYPE_DEFAULT = 0; -exports.BSON.BSON_BINARY_SUBTYPE_FUNCTION = 1; -exports.BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY = 2; -exports.BSON.BSON_BINARY_SUBTYPE_UUID = 3; -exports.BSON.BSON_BINARY_SUBTYPE_MD5 = 4; -exports.BSON.BSON_BINARY_SUBTYPE_USER_DEFINED = 128; diff --git a/external-libs/bson/test/test_bson.js b/external-libs/bson/test/test_bson.js deleted file mode 100644 index a3c096e0f8e..00000000000 --- a/external-libs/bson/test/test_bson.js +++ /dev/null @@ -1,347 +0,0 @@ -var sys = require('util'), - debug = require('util').debug, - inspect = require('util').inspect, - Buffer = require('buffer').Buffer, - BSON = require('../bson').BSON, - Buffer = require('buffer').Buffer, - BSONJS = require('../../../lib/mongodb/bson/bson').BSON, - BinaryParser = require('../../../lib/mongodb/bson/binary_parser').BinaryParser, - Long = require('../../../lib/mongodb/bson/long').Long, - ObjectID = require('../../../lib/mongodb/bson/bson').ObjectID, - Binary = require('../../../lib/mongodb/bson/bson').Binary, - Code = require('../../../lib/mongodb/bson/bson').Code, - DBRef = require('../../../lib/mongodb/bson/bson').DBRef, - Symbol = require('../../../lib/mongodb/bson/bson').Symbol, - Double = require('../../../lib/mongodb/bson/bson').Double, - MaxKey = require('../../../lib/mongodb/bson/bson').MaxKey, - MinKey = require('../../../lib/mongodb/bson/bson').MinKey, - Timestamp = require('../../../lib/mongodb/bson/bson').Timestamp, - assert = require('assert'); - -sys.puts("=== EXECUTING TEST_BSON ==="); - -// Should fail due to illegal key -assert.throws(function() { new ObjectID('foo'); }) -assert.throws(function() { new ObjectID('foo'); }) - -// Parsers -var bsonC = new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); -var bsonJS = new BSONJS([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); - -// Simple serialization and deserialization of edge value -var doc = {doc:0x1ffffffffffffe}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -var doc = {doc:-0x1ffffffffffffe}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// -// Assert correct toJSON -// -var a = Long.fromNumber(10); -assert.equal(10, a); - -var a = Long.fromNumber(9223372036854775807); -assert.equal(9223372036854775807, a); - -// Simple serialization and deserialization test for a Single String value -var doc = {doc:'Serialize'}; -var simple_string_serialized = bsonC.serialize(doc, true, false); - -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Nested doc -var doc = {a:{b:{c:1}}}; -var simple_string_serialized = bsonC.serialize(doc, false, true); - -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple integer serialization/deserialization test, including testing boundary conditions -var doc = {doc:-1}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -var doc = {doc:2147483648}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -var doc = {doc:-2147483648}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple serialization and deserialization test for a Long value -var doc = {doc:Long.fromNumber(9223372036854775807)}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize({doc:Long.fromNumber(9223372036854775807)}, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -var doc = {doc:Long.fromNumber(-9223372036854775807)}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize({doc:Long.fromNumber(-9223372036854775807)}, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple serialization and deserialization for a Float value -var doc = {doc:2222.3333}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -var doc = {doc:-2222.3333}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple serialization and deserialization for a null value -var doc = {doc:null}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple serialization and deserialization for a boolean value -var doc = {doc:true}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple serialization and deserialization for a date value -var date = new Date(); -var doc = {doc:date}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')), bsonC.deserialize(simple_string_serialized)); - -// Simple serialization and deserialization for a boolean value -var doc = {doc:/abcd/mi}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.equal(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')).doc.toString(), bsonC.deserialize(simple_string_serialized).doc.toString()); - -var doc = {doc:/abcd/}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc, false, true)); -assert.equal(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')).doc.toString(), bsonC.deserialize(simple_string_serialized).doc.toString()); - -// Simple serialization and deserialization for a objectId value -var doc = {doc:new ObjectID()}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -var doc2 = {doc:ObjectID.createFromHexString(doc.doc.toHexString())}; - -assert.deepEqual(simple_string_serialized, bsonJS.serialize(doc2, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')).doc.toString(), bsonC.deserialize(simple_string_serialized).doc.toString()); - -// Simple serialization and deserialization for a Binary value -var binary = new Binary(); -var string = 'binstring' -for(var index = 0; index < string.length; index++) { binary.put(string.charAt(index)); } - -var Binary = new Binary(); -var string = 'binstring' -for(var index = 0; index < string.length; index++) { Binary.put(string.charAt(index)); } - -var simple_string_serialized = bsonC.serialize({doc:binary}, false, true); -assert.deepEqual(simple_string_serialized, bsonJS.serialize({doc:Binary}, false, true)); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized, 'binary')).doc.value(), bsonC.deserialize(simple_string_serialized).doc.value()); - -// Simple serialization and deserialization for a Code value -var code = new Code('this.a > i', {'i': 1}); -var Code = new Code('this.a > i', {'i': 1}); -var simple_string_serialized_2 = bsonJS.serialize({doc:Code}, false, true); -var simple_string_serialized = bsonC.serialize({doc:code}, false, true); - -assert.deepEqual(simple_string_serialized, simple_string_serialized_2); -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized_2, 'binary')).doc.scope, bsonC.deserialize(simple_string_serialized).doc.scope); - -// Simple serialization and deserialization for an Object -var simple_string_serialized = bsonC.serialize({doc:{a:1, b:{c:2}}}, false, true); -var simple_string_serialized_2 = bsonJS.serialize({doc:{a:1, b:{c:2}}}, false, true); -assert.deepEqual(simple_string_serialized, simple_string_serialized_2) -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized_2, 'binary')).doc, bsonC.deserialize(simple_string_serialized).doc); - -// Simple serialization and deserialization for an Array -var simple_string_serialized = bsonC.serialize({doc:[9, 9, 1, 2, 3, 1, 1, 1, 1, 1, 1, 1]}, false, true); -var simple_string_serialized_2 = bsonJS.serialize({doc:[9, 9, 1, 2, 3, 1, 1, 1, 1, 1, 1, 1]}, false, true); - -assert.deepEqual(simple_string_serialized, simple_string_serialized_2) -assert.deepEqual(bsonJS.deserialize(new Buffer(simple_string_serialized_2, 'binary')).doc, bsonC.deserialize(simple_string_serialized).doc); - -// Simple serialization and deserialization for a DBRef -var oid = new ObjectID() -var oid2 = new ObjectID.createFromHexString(oid.toHexString()) -var simple_string_serialized = bsonJS.serialize({doc:new DBRef('namespace', oid2, 'integration_tests_')}, false, true); -var simple_string_serialized_2 = bsonC.serialize({doc:new DBRef('namespace', oid, 'integration_tests_')}, false, true); - -assert.deepEqual(simple_string_serialized, simple_string_serialized_2) -// Ensure we have the same values for the dbref -var object_js = bsonJS.deserialize(new Buffer(simple_string_serialized_2, 'binary')); -var object_c = bsonC.deserialize(simple_string_serialized); - -assert.equal(object_js.doc.namespace, object_c.doc.namespace); -assert.equal(object_js.doc.oid.toHexString(), object_c.doc.oid.toHexString()); -assert.equal(object_js.doc.db, object_c.doc.db); - -// Serialized document -var bytes = [47,0,0,0,2,110,97,109,101,0,6,0,0,0,80,97,116,116,121,0,16,97,103,101,0,34,0,0,0,7,95,105,100,0,76,100,12,23,11,30,39,8,89,0,0,1,0]; -var serialized_data = ''; -// Convert to chars -for(var i = 0; i < bytes.length; i++) { - serialized_data = serialized_data + BinaryParser.fromByte(bytes[i]); -} -var object = bsonC.deserialize(new Buffer(serialized_data, 'binary')); -assert.equal('Patty', object.name) -assert.equal(34, object.age) -assert.equal('4c640c170b1e270859000001', object._id.toHexString()) - -// Serialize utf8 -var doc = { "name" : "本荘由利地域に洪水警報", "name1" : "öüóőúéáűíÖÜÓŐÚÉÁŰÍ", "name2" : "abcdedede"}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -var simple_string_serialized2 = bsonJS.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, simple_string_serialized2) - -var object = bsonC.deserialize(simple_string_serialized); -assert.equal(doc.name, object.name) -assert.equal(doc.name1, object.name1) -assert.equal(doc.name2, object.name2) - -// Serialize object with array -var doc = {b:[1, 2, 3]}; -var simple_string_serialized = bsonC.serialize(doc, false, true); -var simple_string_serialized_2 = bsonJS.serialize(doc, false, true); -assert.deepEqual(simple_string_serialized, simple_string_serialized_2) - -var object = bsonC.deserialize(simple_string_serialized); -assert.deepEqual(doc, object) - -// Test equality of an object ID -var object_id = new ObjectID(); -var object_id_2 = new ObjectID(); -assert.ok(object_id.equals(object_id)); -assert.ok(!(object_id.equals(object_id_2))) - -// Test same serialization for Object ID -var object_id = new ObjectID(); -var object_id2 = ObjectID.createFromHexString(object_id.toString()) -var simple_string_serialized = bsonJS.serialize({doc:object_id}, false, true); -var simple_string_serialized_2 = bsonC.serialize({doc:object_id2}, false, true); - -assert.equal(simple_string_serialized_2.length, simple_string_serialized.length); -assert.deepEqual(simple_string_serialized, simple_string_serialized_2) -var object = bsonJS.deserialize(new Buffer(simple_string_serialized_2, 'binary')); -var object2 = bsonC.deserialize(simple_string_serialized); -assert.equal(object.doc.id, object2.doc.id) - -// JS Object -var c1 = { _id: new ObjectID, comments: [], title: 'number 1' }; -var c2 = { _id: new ObjectID, comments: [], title: 'number 2' }; -var doc = { - numbers: [] - , owners: [] - , comments: [c1, c2] - , _id: new ObjectID -}; - -var simple_string_serialized = bsonJS.serialize(doc, false, true); - -// C++ Object -var c1 = { _id: ObjectID.createFromHexString(c1._id.toHexString()), comments: [], title: 'number 1' }; -var c2 = { _id: ObjectID.createFromHexString(c2._id.toHexString()), comments: [], title: 'number 2' }; -var doc = { - numbers: [] - , owners: [] - , comments: [c1, c2] - , _id: ObjectID.createFromHexString(doc._id.toHexString()) -}; - -var simple_string_serialized_2 = bsonC.serialize(doc, false, true); - -for(var i = 0; i < simple_string_serialized_2.length; i++) { - // debug(i + "[" + simple_string_serialized_2[i] + "] = [" + simple_string_serialized[i] + "]") - assert.equal(simple_string_serialized_2[i], simple_string_serialized[i]); -} - -// Deserialize the string -var doc1 = bsonJS.deserialize(new Buffer(simple_string_serialized_2)); -var doc2 = bsonC.deserialize(new Buffer(simple_string_serialized_2)); -assert.equal(doc._id.id, doc1._id.id) -assert.equal(doc._id.id, doc2._id.id) -assert.equal(doc1._id.id, doc2._id.id) - -var doc = { - _id: 'testid', - key1: { code: 'test1', time: {start:1309323402727,end:1309323402727}, x:10, y:5 }, - key2: { code: 'test1', time: {start:1309323402727,end:1309323402727}, x:10, y:5 } -}; - -var simple_string_serialized = bsonJS.serialize(doc, false, true); -var simple_string_serialized_2 = bsonC.serialize(doc, false, true); - -// Deserialize the string -var doc1 = bsonJS.deserialize(new Buffer(simple_string_serialized_2)); -var doc2 = bsonC.deserialize(new Buffer(simple_string_serialized_2)); -assert.deepEqual(doc2, doc1) -assert.deepEqual(doc, doc2) -assert.deepEqual(doc, doc1) - -// Serialize function -var doc = { - _id: 'testid', - key1: function() {} -} - -var simple_string_serialized = bsonJS.serialize(doc, false, true, true); -var simple_string_serialized_2 = bsonC.serialize(doc, false, true, true); - -// Deserialize the string -var doc1 = bsonJS.deserialize(new Buffer(simple_string_serialized_2)); -var doc2 = bsonC.deserialize(new Buffer(simple_string_serialized_2)); -assert.equal(doc1.key1.code.toString(), doc2.key1.code.toString()) - -var doc = {"user_id":"4e9fc8d55883d90100000003","lc_status":{"$ne":"deleted"},"owner_rating":{"$exists":false}}; -var simple_string_serialized = bsonJS.serialize(doc, false, true, true); -var simple_string_serialized_2 = bsonC.serialize(doc, false, true, true); - -// Should serialize to the same value -assert.equal(simple_string_serialized_2.toString('hex'), simple_string_serialized.toString('hex')) -var doc1 = bsonJS.deserialize(simple_string_serialized_2); -var doc2 = bsonC.deserialize(simple_string_serialized); -assert.deepEqual(doc1, doc2) - -// Hex Id -var hexId = new ObjectID().toString(); -var docJS = {_id: ObjectID.createFromHexString(hexId), 'funds.remaining': {$gte: 1.222}, 'transactions.id': {$ne: ObjectID.createFromHexString(hexId)}}; -var docC = {_id: ObjectID.createFromHexString(hexId), 'funds.remaining': {$gte: 1.222}, 'transactions.id': {$ne: ObjectID.createFromHexString(hexId)}}; -var docJSBin = bsonJS.serialize(docJS, false, true, true); -var docCBin = bsonC.serialize(docC, false, true, true); -assert.equal(docCBin.toString('hex'), docJSBin.toString('hex')); - -// // Complex document serialization -// doc = {"DateTime": "Tue Nov 40 2011 17:27:55 GMT+0000 (WEST)","isActive": true,"Media": {"URL": "http://videos.sapo.pt/Tc85NsjaKjj8o5aV7Ubb"},"Title": "Lisboa fecha a ganhar 0.19%","SetPosition": 60,"Type": "videos","Thumbnail": [{"URL": "http://rd3.videos.sapo.pt/Tc85NsjaKjj8o5aV7Ubb/pic/320x240","Dimensions": {"Height": 240,"Width": 320}}],"Source": {"URL": "http://videos.sapo.pt","SetID": "1288","SourceID": "http://videos.sapo.pt/tvnet/rss2","SetURL": "http://noticias.sapo.pt/videos/tv-net_1288/","ItemID": "Tc85NsjaKjj8o5aV7Ubb","Name": "SAPO Vídeos"},"Category": "Tec_ciencia","Description": "Lisboa fecha a ganhar 0.19%","GalleryID": new ObjectID("4eea2a634ce8573200000000"),"InternalRefs": {"RegisterDate": "Thu Dec 15 2011 17:12:51 GMT+0000 (WEST)","ChangeDate": "Thu Dec 15 2011 17:12:51 GMT+0000 (WEST)","Hash": 332279244514},"_id": new ObjectID("4eea2a96e52778160000003a")} -// var docJSBin = bsonJS.serialize(docJS, false, true, true); -// var docCBin = bsonC.serialize(docC, false, true, true); -// -// - -// // Force garbage collect -// global.gc(); - - - - - - - - - - - - - - - diff --git a/external-libs/bson/test/test_full_bson.js b/external-libs/bson/test/test_full_bson.js deleted file mode 100644 index 3efee430250..00000000000 --- a/external-libs/bson/test/test_full_bson.js +++ /dev/null @@ -1,216 +0,0 @@ -var sys = require('util'), - fs = require('fs'), - Buffer = require('buffer').Buffer, - BSON = require('../bson').BSON, - Buffer = require('buffer').Buffer, - assert = require('assert'), - BinaryParser = require('../../../lib/mongodb/bson/binary_parser').BinaryParser, - BSONJS = require('../../../lib/mongodb/bson/bson').BSON, - Long = require('../../../lib/mongodb/bson/long').Long, - ObjectID = require('../../../lib/mongodb/bson/bson').ObjectID, - Binary = require('../../../lib/mongodb/bson/bson').Binary, - Code = require('../../../lib/mongodb/bson/bson').Code, - DBRef = require('../../../lib/mongodb/bson/bson').DBRef, - Symbol = require('../../../lib/mongodb/bson/bson').Symbol, - Double = require('../../../lib/mongodb/bson/bson').Double, - MaxKey = require('../../../lib/mongodb/bson/bson').MaxKey, - MinKey = require('../../../lib/mongodb/bson/bson').MinKey, - Timestamp = require('../../../lib/mongodb/bson/bson').Timestamp; - -sys.puts("=== EXECUTING TEST_FULL_BSON ==="); - -// Parsers -var bsonC = new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); -var bsonJS = new BSONJS([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); - -// Should Correctly Deserialize object -var bytes = [95,0,0,0,2,110,115,0,42,0,0,0,105,110,116,101,103,114,97,116,105,111,110,95,116,101,115,116,115,95,46,116,101,115,116,95,105,110,100,101,120,95,105,110,102,111,114,109,97,116,105,111,110,0,8,117,110,105,113,117,101,0,0,3,107,101,121,0,12,0,0,0,16,97,0,1,0,0,0,0,2,110,97,109,101,0,4,0,0,0,97,95,49,0,0]; -var serialized_data = ''; -// Convert to chars -for(var i = 0; i < bytes.length; i++) { - serialized_data = serialized_data + BinaryParser.fromByte(bytes[i]); -} -var object = bsonC.deserialize(serialized_data); -assert.equal("a_1", object.name); -assert.equal(false, object.unique); -assert.equal(1, object.key.a); - -// Should Correctly Deserialize object with all types -var bytes = [26,1,0,0,7,95,105,100,0,161,190,98,75,118,169,3,0,0,3,0,0,4,97,114,114,97,121,0,26,0,0,0,16,48,0,1,0,0,0,16,49,0,2,0,0,0,16,50,0,3,0,0,0,0,2,115,116,114,105,110,103,0,6,0,0,0,104,101,108,108,111,0,3,104,97,115,104,0,19,0,0,0,16,97,0,1,0,0,0,16,98,0,2,0,0,0,0,9,100,97,116,101,0,161,190,98,75,0,0,0,0,7,111,105,100,0,161,190,98,75,90,217,18,0,0,1,0,0,5,98,105,110,97,114,121,0,7,0,0,0,2,3,0,0,0,49,50,51,16,105,110,116,0,42,0,0,0,1,102,108,111,97,116,0,223,224,11,147,169,170,64,64,11,114,101,103,101,120,112,0,102,111,111,98,97,114,0,105,0,8,98,111,111,108,101,97,110,0,1,15,119,104,101,114,101,0,25,0,0,0,12,0,0,0,116,104,105,115,46,120,32,61,61,32,51,0,5,0,0,0,0,3,100,98,114,101,102,0,37,0,0,0,2,36,114,101,102,0,5,0,0,0,116,101,115,116,0,7,36,105,100,0,161,190,98,75,2,180,1,0,0,2,0,0,0,10,110,117,108,108,0,0]; -var serialized_data = ''; -// Convert to chars -for(var i = 0; i < bytes.length; i++) { - serialized_data = serialized_data + BinaryParser.fromByte(bytes[i]); -} - -var object = bsonJS.deserialize(new Buffer(serialized_data, 'binary')); -assert.equal("hello", object.string); -assert.deepEqual([1, 2, 3], object.array); -assert.equal(1, object.hash.a); -assert.equal(2, object.hash.b); -assert.ok(object.date != null); -assert.ok(object.oid != null); -assert.ok(object.binary != null); -assert.equal(42, object.int); -assert.equal(33.3333, object.float); -assert.ok(object.regexp != null); -assert.equal(true, object.boolean); -assert.ok(object.where != null); -assert.ok(object.dbref != null); -assert.ok(object['null'] == null); - -// Should Serialize and Deserialze String -var test_string = {hello: 'world'} -var serialized_data = bsonC.serialize(test_string) -assert.deepEqual(test_string, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize Integer -var test_number = {doc: 5} -var serialized_data = bsonC.serialize(test_number) -assert.deepEqual(test_number, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize null value -var test_null = {doc:null} -var serialized_data = bsonC.serialize(test_null) -var object = bsonC.deserialize(serialized_data); -assert.deepEqual(test_null, object); - -// Should Correctly Serialize and Deserialize undefined value -var test_undefined = {doc:undefined} -var serialized_data = bsonC.serialize(test_undefined) -var object = bsonJS.deserialize(new Buffer(serialized_data, 'binary')); -assert.equal(null, object.doc) - -// Should Correctly Serialize and Deserialize Number -var test_number = {doc: 5.5} -var serialized_data = bsonC.serialize(test_number) -assert.deepEqual(test_number, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize Integer -var test_int = {doc: 42} -var serialized_data = bsonC.serialize(test_int) -assert.deepEqual(test_int, bsonC.deserialize(serialized_data)); - -test_int = {doc: -5600} -serialized_data = bsonC.serialize(test_int) -assert.deepEqual(test_int, bsonC.deserialize(serialized_data)); - -test_int = {doc: 2147483647} -serialized_data = bsonC.serialize(test_int) -assert.deepEqual(test_int, bsonC.deserialize(serialized_data)); - -test_int = {doc: -2147483648} -serialized_data = bsonC.serialize(test_int) -assert.deepEqual(test_int, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize Object -var doc = {doc: {age: 42, name: 'Spongebob', shoe_size: 9.5}} -var serialized_data = bsonC.serialize(doc) -assert.deepEqual(doc, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize Array -var doc = {doc: [1, 2, 'a', 'b']} -var serialized_data = bsonC.serialize(doc) -assert.deepEqual(doc, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize Array with added on functions -var doc = {doc: [1, 2, 'a', 'b']} -var serialized_data = bsonC.serialize(doc) -assert.deepEqual(doc, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize A Boolean -var doc = {doc: true} -var serialized_data = bsonC.serialize(doc) -assert.deepEqual(doc, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize a Date -var date = new Date() -//(2009, 11, 12, 12, 00, 30) -date.setUTCDate(12) -date.setUTCFullYear(2009) -date.setUTCMonth(11 - 1) -date.setUTCHours(12) -date.setUTCMinutes(0) -date.setUTCSeconds(30) -var doc = {doc: date} -var serialized_data = bsonC.serialize(doc) -assert.deepEqual(doc, bsonC.deserialize(serialized_data)); - -// // Should Correctly Serialize and Deserialize Oid -var doc = {doc: new ObjectID()} -var serialized_data = bsonC.serialize(doc) -assert.deepEqual(doc.doc.toHexString(), bsonC.deserialize(serialized_data).doc.toHexString()) - -// Should Correctly encode Empty Hash -var test_code = {} -var serialized_data = bsonC.serialize(test_code) -assert.deepEqual(test_code, bsonC.deserialize(serialized_data)); - -// Should Correctly Serialize and Deserialize Ordered Hash -var doc = {doc: {b:1, a:2, c:3, d:4}} -var serialized_data = bsonC.serialize(doc) -var decoded_hash = bsonC.deserialize(serialized_data).doc -var keys = [] -for(name in decoded_hash) keys.push(name) -assert.deepEqual(['b', 'a', 'c', 'd'], keys) - -// Should Correctly Serialize and Deserialize Regular Expression -// Serialize the regular expression -var doc = {doc: /foobar/mi} -var serialized_data = bsonC.serialize(doc) -var doc2 = bsonC.deserialize(serialized_data); -assert.equal(doc.doc.toString(), doc2.doc.toString()) - -// Should Correctly Serialize and Deserialize a Binary object -var bin = new Binary() -var string = 'binstring' -for(var index = 0; index < string.length; index++) { - bin.put(string.charAt(index)) -} -var doc = {doc: bin} -var serialized_data = bsonC.serialize(doc) -var deserialized_data = bsonC.deserialize(serialized_data); -assert.equal(doc.doc.value(), deserialized_data.doc.value()) - -// Should Correctly Serialize and Deserialize a big Binary object -var data = fs.readFileSync("../../test/gridstore/test_gs_weird_bug.png", 'binary'); -var bin = new Binary() -bin.write(data) -var doc = {doc: bin} -var serialized_data = bsonC.serialize(doc) -var deserialized_data = bsonC.deserialize(serialized_data); -assert.equal(doc.doc.value(), deserialized_data.doc.value()) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/external-libs/bson/test/test_stackless_bson.js b/external-libs/bson/test/test_stackless_bson.js deleted file mode 100644 index 5f43c4702b9..00000000000 --- a/external-libs/bson/test/test_stackless_bson.js +++ /dev/null @@ -1,130 +0,0 @@ -var Buffer = require('buffer').Buffer, - BSON = require('../bson').BSON, - Buffer = require('buffer').Buffer, - BSONJS = require('../../../lib/mongodb/bson/bson').BSON, - BinaryParser = require('../../../lib/mongodb/bson/binary_parser').BinaryParser, - Long = require('../../../lib/mongodb/bson/long').Long, - ObjectID = require('../../../lib/mongodb/bson/bson').ObjectID, - Binary = require('../../../lib/mongodb/bson/bson').Binary, - Code = require('../../../lib/mongodb/bson/bson').Code, - DBRef = require('../../../lib/mongodb/bson/bson').DBRef, - Symbol = require('../../../lib/mongodb/bson/bson').Symbol, - Double = require('../../../lib/mongodb/bson/bson').Double, - MaxKey = require('../../../lib/mongodb/bson/bson').MaxKey, - MinKey = require('../../../lib/mongodb/bson/bson').MinKey, - Timestamp = require('../../../lib/mongodb/bson/bson').Timestamp; - assert = require('assert'); - -console.log("=== EXECUTING TEST_STACKLESS_BSON ==="); - -// Parsers -var bsonC = new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); -var bsonJS = new BSONJS([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); - -// Number of iterations for the benchmark -var COUNT = 10000; -// var COUNT = 1; -// Sample simple doc -var doc = {key:"Hello world", key2:"šđžčćŠĐŽČĆ", key3:'客家话', key4:'how are you doing dog!!'}; -// var doc = {}; -// for(var i = 0; i < 100; i++) { -// doc['string' + i] = "dumdyms fsdfdsfdsfdsfsdfdsfsdfsdfsdfsdfsdfsdfsdffsfsdfs"; -// } - -// // Calculate size -console.log(bsonC.calculateObjectSize2(doc)); -console.log(bsonJS.calculateObjectSize(doc)); -// assert.equal(bsonJS.calculateObjectSize(doc), bsonC.calculateObjectSize2(doc)); - -// ---------------------------------------------------------------------------- -// ---------------------------------------------------------------------------- -// Benchmark calculateObjectSize -// ---------------------------------------------------------------------------- -// ---------------------------------------------------------------------------- - -// Benchmark 1 JS BSON -console.log(COUNT + "x (objectBSON = bsonC.calculateObjectSize(object))") -start = new Date - -for (j=COUNT; --j>=0; ) { - var objectBSON = bsonJS.calculateObjectSize(doc); -} - -end = new Date -var opsprsecond = COUNT / ((end - start)/1000); -console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); - -// Benchmark 2 C++ BSON calculateObjectSize -console.log(COUNT + "x (objectBSON = bsonC.calculateObjectSize(object))") -start = new Date - -for (j=COUNT; --j>=0; ) { - var objectBSON = bsonC.calculateObjectSize(doc); -} - -end = new Date -var opsprsecond = COUNT / ((end - start)/1000); -console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); - -// Benchmark 3 C++ BSON calculateObjectSize2 -console.log(COUNT + "x (objectBSON = bsonC.calculateObjectSize2(object))") -start = new Date - -for (j=COUNT; --j>=0; ) { - var objectBSON = bsonC.calculateObjectSize2(doc); -} - -end = new Date -var opsprsecond = COUNT / ((end - start)/1000); -console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); - -// // Serialize the content -// var _serializedDoc1 = bsonJS.serialize(doc, true, false); -// var _serializedDoc2 = bsonC.serialize2(doc, true, false); -// console.dir(_serializedDoc1); -// console.dir(_serializedDoc2); -// assert.equal(_serializedDoc1.toString('hex'), _serializedDoc2.toString('hex')) -// -// -// // Benchmark 1 -// console.log(COUNT + "x (objectBSON = bsonC.serialize(object))") -// start = new Date -// -// for (j=COUNT; --j>=0; ) { -// // var objectBSON = bsonC.serialize2(doc, true, false); -// var objectBSON = bsonJS.serialize(doc, true, false); -// } -// -// end = new Date -// var opsprsecond = COUNT / ((end - start)/1000); -// console.log("bson size (bytes): ", objectbsonC.length); -// console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); -// console.log("MB/s = " + ((opsprsecond*objectbsonC.length)/1024)); -// -// // Benchmark 2 -// console.log(COUNT + "x (objectBSON = bsonC.serialize(object))") -// start = new Date -// -// for (j=COUNT; --j>=0; ) { -// var objectBSON = bsonC.serialize2(doc, true, false); -// } -// -// end = new Date -// var opsprsecond = COUNT / ((end - start)/1000); -// console.log("bson size (bytes): ", objectbsonC.length); -// console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); -// console.log("MB/s = " + ((opsprsecond*objectbsonC.length)/1024)); -// -// // Benchmark 3 -// console.log(COUNT + "x (objectBSON = bsonC.serialize(object))") -// start = new Date -// -// for (j=COUNT; --j>=0; ) { -// var objectBSON = bsonC.serialize(doc, true, false); -// } -// -// end = new Date -// var opsprsecond = COUNT / ((end - start)/1000); -// console.log("bson size (bytes): ", objectbsonC.length); -// console.log("time = ", end - start, "ms -", COUNT / ((end - start)/1000), " ops/sec"); -// console.log("MB/s = " + ((opsprsecond*objectbsonC.length)/1024)); diff --git a/external-libs/bson/wscript b/external-libs/bson/wscript deleted file mode 100644 index 40f5317f116..00000000000 --- a/external-libs/bson/wscript +++ /dev/null @@ -1,39 +0,0 @@ -import Options -from os import unlink, symlink, popen -from os.path import exists - -srcdir = "." -blddir = "build" -VERSION = "0.1.0" - -def set_options(opt): - opt.tool_options("compiler_cxx") - opt.add_option( '--debug' - , action='store_true' - , default=False - , help='Build debug variant [Default: False]' - , dest='debug' - ) - -def configure(conf): - conf.check_tool("compiler_cxx") - conf.check_tool("node_addon") - conf.env.append_value('CXXFLAGS', ['-O3', '-funroll-loops']) - - # conf.env.append_value('CXXFLAGS', ['-DDEBUG', '-g', '-O0', '-Wall', '-Wextra']) - # conf.check(lib='node', libpath=['/usr/lib', '/usr/local/lib'], uselib_store='NODE') - -def build(bld): - obj = bld.new_task_gen("cxx", "shlib", "node_addon") - obj.target = "bson" - obj.source = ["bson.cc"] - # obj.uselib = "NODE" - -def shutdown(): - # HACK to get compress.node out of build directory. - # better way to do this? - if Options.commands['clean']: - if exists('bson.node'): unlink('bson.node') - else: - if exists('build/default/bson.node') and not exists('bson.node'): - symlink('build/default/bson.node', 'bson.node') diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000000..6a237d91097 --- /dev/null +++ b/genindex.html @@ -0,0 +1,1174 @@ + + + + + + + + + + + + Index — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + + +

        Index

        + +
        + _ + | A + | B + | C + | D + | E + | F + | G + | I + | L + | M + | N + | O + | P + | R + | S + | T + | U + | V + | W + | X + +
        +

        _

        + + + +
        + +
        _disableHA() (built-in function) +
        + + +
        _enableHA() (built-in function) +
        + +
        + +
        _handleOnFullSetup() (built-in function) +
        + +
        + +

        A

        + + + +
        + +
        add() (built-in function), [1] +
        + + +
        addUser() (built-in function), [1] +
        + + +
        admin() (built-in function) +
        + + +
        Admin() (class) +
        + +
        + +
        aggregate() (built-in function) +
        + + +
        and() (built-in function), [1] +
        + + +
        assignReplicaSet() (built-in function) +
        + + +
        authenticate() (built-in function), [1] +
        + +
        + +

        B

        + + + +
        + +
        batchSize() (built-in function) +
        + + +
        Binary() (class) +
        + + +
        BSON() (class) +
        + + +
        BSON.calculateObjectSize() (BSON method) +
        + + +
        BSON.deserialize() (BSON method) +
        + +
        + +
        BSON.deserializeStream() (BSON method) +
        + + +
        BSON.serialize() (BSON method) +
        + + +
        BSON.serializeWithBufferAndIndex() (BSON method) +
        + + +
        buildInfo() (built-in function) +
        + +
        + +

        C

        + + + +
        + +
        calculateObjectSize() (built-in function) +
        + + +
        chunkCollection() (built-in function) +
        + + +
        chunkSize number [Getter|Setter] (None attribute) +
        + + +
        close() (built-in function), [1], [2], [3] +
        + + +
        Code() (class) +
        + + +
        collection() (built-in function), [1] +
        + + +
        Collection() (class) +
        + + +
        collectionNames() (built-in function) +
        + + +
        collections() (built-in function) +
        + + +
        collectionsInfo() (built-in function) +
        + +
        + +
        command() (built-in function), [1] +
        + + +
        compare() (built-in function), [1] +
        + + +
        connect() (built-in function) +
        + + +
        count() (built-in function), [1] +
        + + +
        createCollection() (built-in function) +
        + + +
        createIndex() (built-in function), [1] +
        + + +
        Cursor() (class) +
        + + +
        cursorInfo() (built-in function) +
        + + +
        CursorStream() (class) +
        + +
        + +

        D

        + + + +
        + +
        db() (built-in function), [1] +
        + + +
        Db() (class) +
        + + +
        Db.connect() (Db method) +
        + + +
        DBRef() (class) +
        + + +
        delete() (built-in function) +
        + + +
        dereference() (built-in function) +
        + + +
        deserialize() (built-in function) +
        + + +
        deserializeStream() (built-in function) +
        + + +
        destroy() (built-in function), [1] +
        + +
        + +
        distinct() (built-in function) +
        + + +
        div() (built-in function), [1] +
        + + +
        Double() (class) +
        + + +
        drop() (built-in function) +
        + + +
        dropAllIndexes() (built-in function) +
        + + +
        dropCollection() (built-in function) +
        + + +
        dropDatabase() (built-in function) +
        + + +
        dropIndex() (built-in function), [1] +
        + +
        + +

        E

        + + + +
        + +
        each() (built-in function) +
        + + +
        ensureIndex() (built-in function), [1] +
        + + +
        eof() (built-in function) +
        + +
        + +
        equals() (built-in function), [1], [2] +
        + + +
        eval() (built-in function) +
        + + +
        explain() (built-in function) +
        + +
        + +

        F

        + + + +
        + +
        find() (built-in function) +
        + + +
        findAndModify() (built-in function) +
        + +
        + +
        findAndRemove() (built-in function) +
        + + +
        findOne() (built-in function) +
        + +
        + +

        G

        + + + +
        + +
        geoHaystackSearch() (built-in function) +
        + + +
        geoNear() (built-in function) +
        + + +
        get() (built-in function) +
        + + +
        getc() (built-in function) +
        + + +
        getHighBits() (built-in function), [1] +
        + + +
        getLowBits() (built-in function), [1] +
        + + +
        getLowBitsUnsigned() (built-in function), [1] +
        + + +
        getNumBitsAbs() (built-in function), [1] +
        + + +
        getTimestamp() (built-in function) +
        + + +
        greaterThan() (built-in function), [1] +
        + +
        + +
        greaterThanOrEqual() (built-in function), [1] +
        + + +
        Grid() (class) +
        + + +
        GridStore() (class) +
        + + +
        GridStore.exist() (GridStore method) +
        + + +
        GridStore.list() (GridStore method) +
        + + +
        GridStore.read() (GridStore method) +
        + + +
        GridStore.readlines() (GridStore method) +
        + + +
        GridStore.unlink() (GridStore method) +
        + + +
        group() (built-in function) +
        + +
        + +

        I

        + + + +
        + +
        indexes() (built-in function) +
        + + +
        indexExists() (built-in function) +
        + + +
        indexInformation() (built-in function), [1] +
        + + +
        inheritReplSetOptionsFrom() (built-in function) +
        + + +
        insert() (built-in function) +
        + +
        + +
        isCapped() (built-in function) +
        + + +
        isClosed() (built-in function) +
        + + +
        isNegative() (built-in function), [1] +
        + + +
        isOdd() (built-in function), [1] +
        + + +
        isZero() (built-in function), [1] +
        + +
        + +

        L

        + + + +
        + +
        lastError() (built-in function) +
        + + +
        length() (built-in function) +
        + + +
        lessThan() (built-in function), [1] +
        + + +
        lessThanOrEqual() (built-in function), [1] +
        + + +
        limit() (built-in function) +
        + + +
        listDatabases() (built-in function) +
        + +
        + +
        logout() (built-in function), [1] +
        + + +
        Long() (class) +
        + + +
        Long.fromBits() (Long method) +
        + + +
        Long.fromInt() (Long method) +
        + + +
        Long.fromNumber() (Long method) +
        + + +
        Long.fromString() (Long method) +
        + +
        + +

        M

        + + + +
        + +
        mapReduce() (built-in function) +
        + + +
        MaxKey() (class) +
        + + +
        md5 number [Getter|Setter] (None attribute) +
        + + +
        MinKey() (class) +
        + + +
        modulo() (built-in function), [1] +
        + +
        + +
        MongoClient() (class) +
        + + +
        MongoClient.connect() (MongoClient method) +
        + + +
        Mongos() (class) +
        + + +
        multiply() (built-in function), [1] +
        + +
        + +

        N

        + + + +
        + +
        negate() (built-in function), [1] +
        + + +
        nextObject() (built-in function) +
        + +
        + +
        not() (built-in function), [1] +
        + + +
        notEquals() (built-in function), [1] +
        + +
        + +

        O

        + + + +
        + +
        ObjectID() (class) +
        + + +
        ObjectID.createFromHexString() (ObjectID method) +
        + + +
        ObjectID.createFromTime() (ObjectID method) +
        + +
        + +
        open() (built-in function), [1], [2] +
        + + +
        options() (built-in function) +
        + + +
        or() (built-in function), [1] +
        + +
        + +

        P

        + + + +
        + +
        pause() (built-in function), [1], [2] +
        + + +
        ping() (built-in function) +
        + + +
        previousErrors() (built-in function) +
        + + +
        profilingInfo() (built-in function) +
        + +
        + +
        profilingLevel() (built-in function) +
        + + +
        put() (built-in function), [1] +
        + + +
        puts() (built-in function) +
        + +
        + +

        R

        + + + +
        + +
        read() (built-in function), [1] +
        + + +
        readlines() (built-in function) +
        + + +
        ReadPreference() (class) +
        + + +
        ReadStream() (class) +
        + + +
        reIndex() (built-in function), [1] +
        + + +
        remove() (built-in function) +
        + + +
        removeUser() (built-in function), [1] +
        + + +
        rename() (built-in function) +
        + +
        + +
        renameCollection() (built-in function) +
        + + +
        ReplSet() (class) +
        + + +
        ReplSet.State() (ReplSet method) +
        + + +
        replSetGetStatus() (built-in function) +
        + + +
        resetErrorHistory() (built-in function) +
        + + +
        resume() (built-in function), [1], [2] +
        + + +
        rewind() (built-in function), [1] +
        + +
        + +

        S

        + + + +
        + +
        save() (built-in function) +
        + + +
        seek() (built-in function) +
        + + +
        serialize() (built-in function) +
        + + +
        serializeWithBufferAndIndex() (built-in function) +
        + + +
        Server() (class) +
        + + +
        serverStatus() (built-in function) +
        + + +
        setProfilingLevel() (built-in function) +
        + + +
        setReadPreference() (built-in function), [1], [2] +
        + + +
        shiftLeft() (built-in function), [1] +
        + +
        + +
        shiftRight() (built-in function), [1] +
        + + +
        shiftRightUnsigned() (built-in function), [1] +
        + + +
        skip() (built-in function) +
        + + +
        sort() (built-in function) +
        + + +
        stats() (built-in function), [1] +
        + + +
        stream() (built-in function), [1] +
        + + +
        subtract() (built-in function), [1] +
        + + +
        Symbol() (class) +
        + +
        + +

        T

        + + + +
        + +
        tell() (built-in function) +
        + + +
        Timestamp() (class) +
        + + +
        Timestamp.fromBits() (Timestamp method) +
        + + +
        Timestamp.fromInt() (Timestamp method) +
        + + +
        Timestamp.fromNumber() (Timestamp method) +
        + + +
        Timestamp.fromString() (Timestamp method) +
        + +
        + +
        toArray() (built-in function) +
        + + +
        toHexString() (built-in function) +
        + + +
        toInt() (built-in function), [1] +
        + + +
        toJSON() (built-in function), [1] +
        + + +
        toNumber() (built-in function), [1] +
        + + +
        toString() (built-in function), [1] +
        + +
        + +

        U

        + + + +
        + +
        unlink() (built-in function) +
        + +
        + +
        update() (built-in function) +
        + +
        + +

        V

        + + + +
        + +
        validateCollection() (built-in function) +
        + + +
        value() (built-in function) +
        + +
        + +
        valueOf() (built-in function), [1] +
        + +
        + +

        W

        + + + +
        + +
        write() (built-in function), [1] +
        + +
        + +
        writeFile() (built-in function) +
        + +
        + +

        X

        + + +
        + +
        xor() (built-in function), [1] +
        + +
        + + + +
        +
        +
        +
        +
        +

        Contents

        + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/github/github.html b/github/github.html new file mode 100644 index 00000000000..2ff5ebbb5cf --- /dev/null +++ b/github/github.html @@ -0,0 +1,1863 @@ + + + + + + + + + + Github libraries and projects using the driver — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Github libraries and projects using the driver

        +
        +

        Web frameworks using MongoDB

        +
        +

        nwt

        +

        Node Web Toolkit - nwt is a modern javascript framework.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push21:2:6 on 11/10/2012
        Homepagehttp://
        Urlhttps://github.com/nwtjs/nwt
        Clone Urlhttps://github.com/nwtjs/nwt.git
        Forks4
        Watchers16
        +
        +
        +
        +

        caboose

        +

        Coffeescript-happy express-based server-side MVC framework loosely based on rails

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push6:56:54 on 16/11/2012
        Homepagehttp://
        Urlhttps://github.com/mattinsler/caboose
        Clone Urlhttps://github.com/mattinsler/caboose.git
        Forks6
        Watchers17
        +
        +
        +
        +

        node-bread

        +

        file based static website/blog generator

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push23:50:52 on 7/7/2012
        Homepagehttp://https://npmjs.org/package/bread
        Urlhttps://github.com/pvorb/node-bread
        Clone Urlhttps://github.com/pvorb/node-bread.git
        Forks3
        Watchers3
        +
        +
        +
        +

        arrjs

        +

        HTTP and WebSocket application routing

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push17:2:2 on 8/1/2012
        Homepagehttp://
        Urlhttps://github.com/tjanczuk/arrjs
        Clone Urlhttps://github.com/tjanczuk/arrjs.git
        Forks2
        Watchers25
        +
        +
        +
        +
        +

        Object Document Modeling Libraries

        +
        +

        noid

        +

        ODM for MongoDB/Node.js with CoffeeScript

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push1:20:59 on 22/11/2010
        Homepagehttp://
        Urlhttps://github.com/chrisgibson/noid
        Clone Urlhttps://github.com/chrisgibson/noid.git
        Forks1
        Watchers8
        +
        +
        +
        +

        mongoose

        +

        Node.JS MongoDB utility library with ORM-like functionality

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push3:40:3 on 14/2/2013
        Homepagehttp://
        Urlhttps://github.com/LearnBoost/mongoose
        Clone Urlhttps://github.com/LearnBoost/mongoose.git
        Forks378
        Watchers2883
        +
        +
        +
        +

        mongo-model

        +

        Model for MongoDB (Node.JS)

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push11:37:19 on 1/6/2012
        Homepagehttp://http://alexeypetrushin.github.com/mongo-model
        Urlhttps://github.com/alexeypetrushin/mongo-model
        Clone Urlhttps://github.com/alexeypetrushin/mongo-model.git
        Forks5
        Watchers51
        +
        +
        +
        +

        leaf

        +

        A MongoDB ORM for Node

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push20:2:4 on 29/7/2010
        Homepagehttp://
        Urlhttps://github.com/colladow/leaf
        Clone Urlhttps://github.com/colladow/leaf.git
        Forks1
        Watchers6
        +
        +
        +
        +
        +

        Content Management Systems

        +
        +

        nocr-mongo

        +

        nodejs Content Repository implementation for mongodb

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push6:25:45 on 18/3/2012
        Homepagehttp://
        Urlhttps://github.com/karacos/nocr-mongo
        Clone Urlhttps://github.com/karacos/nocr-mongo.git
        Forks0
        Watchers4
        +
        +
        +
        +

        calipso

        +

        Calipso is a simple NodeJS content management system based on Express, Connect & Mongoose.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push3:51:41 on 25/0/2013
        Homepagehttp://calip.so
        Urlhttps://github.com/cliftonc/calipso
        Clone Urlhttps://github.com/cliftonc/calipso.git
        Forks183
        Watchers1045
        +
        +
        +
        +
        +

        Grid FS libraries or tools

        +
        +

        nettle

        +

        On-the-fly processing framework for Node.js and MongoDB

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push20:36:16 on 11/6/2012
        Homepagehttp://
        Urlhttps://github.com/scttnlsn/nettle
        Clone Urlhttps://github.com/scttnlsn/nettle.git
        Forks0
        Watchers9
        +
        +
        +
        +
        +

        Wrapper libraries to ease the use of development or provide simple ODM like behaviours

        +
        +

        node-mongoskin

        +

        The future layer for node-mongodb-native.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push3:50:53 on 4/7/2012
        Homepagehttp://
        Urlhttps://github.com/guileen/node-mongoskin
        Clone Urlhttps://github.com/guileen/node-mongoskin.git
        Forks7
        Watchers41
        +
        +
        +
        +

        mongoq

        +

        Use mongoDB like this: mongoq(‘mongodb://localhost/db’).collection(‘users’).find().toArray(function(error, docs){});

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push7:17:31 on 19/11/2011
        Homepagehttp://http://zzdhidden.github.com/mongoq
        Urlhttps://github.com/zzdhidden/mongoq
        Clone Urlhttps://github.com/zzdhidden/mongoq.git
        Forks2
        Watchers54
        +
        +
        +
        +

        mongolia

        +

        Flexible non-magical layer for the nodejs MongoDB driver

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push14:3:17 on 3/11/2012
        Homepagehttp://
        Urlhttps://github.com/masylum/mongolia
        Clone Urlhttps://github.com/masylum/mongolia.git
        Forks12
        Watchers105
        +
        +
        +
        +

        mongojs

        +

        a simple mongo module that implements the mongo api

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push0:14:0 on 14/2/2013
        Homepagehttp://
        Urlhttps://github.com/gett/mongojs
        Clone Urlhttps://github.com/gett/mongojs.git
        Forks39
        Watchers326
        +
        +
        +
        +

        mongode

        +

        Thin wrapper around node-mongodb-native that provides a simpler alternative calling style and provides collection binding.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push14:17:30 on 29/7/2012
        Homepagehttp://
        Urlhttps://github.com/milewise/mongode
        Clone Urlhttps://github.com/milewise/mongode.git
        Forks7
        Watchers56
        +
        +
        +
        +

        node-mongodb-wrapper

        +

        A wrapper for node-mongodb-native as close as possible to the command-line javascript driver. Why learn two interfaces?

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push19:38:37 on 24/0/2013
        Homepagehttp://http://i.tv
        Urlhttps://github.com/idottv/node-mongodb-wrapper
        Clone Urlhttps://github.com/idottv/node-mongodb-wrapper.git
        Forks9
        Watchers45
        +
        +
        +
        +

        mdoq-mongodb

        +

        simplified mongodb-native api w/ middleware

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push17:56:15 on 29/4/2012
        Homepagehttp://
        Urlhttps://github.com/ritch/mdoq-mongodb
        Clone Urlhttps://github.com/ritch/mdoq-mongodb.git
        Forks0
        Watchers3
        +
        +
        +
        +

        ferret

        +

        Adorable mongodb library for node.js

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push15:2:55 on 2/7/2011
        Homepagehttp://
        Urlhttps://github.com/Coreh/ferret
        Clone Urlhttps://github.com/Coreh/ferret.git
        Forks3
        Watchers9
        +
        +
        +
        +

        easymongo

        +

        Easy MongoDB

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push16:28:18 on 8/0/2013
        Homepagehttp://http://simonenko.su/projects/easymongo
        Urlhttps://github.com/meritt/easymongo
        Clone Urlhttps://github.com/meritt/easymongo.git
        Forks3
        Watchers12
        +
        +
        +
        +
        +

        REST api’s around MongoDB or resource based libraries

        +
        +

        mongodb-rest

        +

        REST Server for MongoDB (using node.js)

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push21:12:16 on 20/11/2012
        Homepagehttp://
        Urlhttps://github.com/tdegrunt/mongodb-rest
        Clone Urlhttps://github.com/tdegrunt/mongodb-rest.git
        Forks50
        Watchers212
        +
        +
        +
        +

        lazyBum

        +

        Node.js RESTful web framework.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push3:35:54 on 10/11/2011
        Homepagehttp://http://streetsaheadllc.com
        Urlhttps://github.com/streets-ahead/lazyBum
        Clone Urlhttps://github.com/streets-ahead/lazyBum.git
        Forks1
        Watchers2
        +
        +
        +
        +

        GECK

        +

        A lightweight, resource-based API framework for node.js

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push17:22:29 on 23/7/2012
        Homepagehttp://
        Urlhttps://github.com/Qard/GECK
        Clone Urlhttps://github.com/Qard/GECK.git
        Forks1
        Watchers10
        +
        +
        +
        +
        +

        Test helpers and libraries

        +
        +

        mongodb-fixtures

        +

        Fixtures for mongodb

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push9:59:58 on 10/5/2012
        Homepagehttp://
        Urlhttps://github.com/tdegrunt/mongodb-fixtures
        Clone Urlhttps://github.com/tdegrunt/mongodb-fixtures.git
        Forks1
        Watchers9
        +
        +
        +
        +

        node-database-cleaner

        +

        The simplest way to clean your database after tests

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push12:35:16 on 7/4/2012
        Homepagehttp://
        Urlhttps://github.com/emerleite/node-database-cleaner
        Clone Urlhttps://github.com/emerleite/node-database-cleaner.git
        Forks8
        Watchers37
        +
        +
        +
        +
        +

        Tools or applications to manage your MongoDB’s

        +
        +

        mon4mongo

        +

        MongoDB management web server boosted with nodejs & express.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push7:35:50 on 13/2/2013
        Homepagehttp://
        Urlhttps://github.com/erhangundogan/mon4mongo
        Clone Urlhttps://github.com/erhangundogan/mon4mongo.git
        Forks0
        Watchers6
        +
        +
        +
        +
        +

        Queue libraries using MongoDB

        +
        +

        mojo

        +

        Node.js job queue backed by MongoDB

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push17:16:38 on 24/1/2013
        Homepagehttp://http://wereHamster.github.com/mojo
        Urlhttps://github.com/wereHamster/mojo
        Clone Urlhttps://github.com/wereHamster/mojo.git
        Forks3
        Watchers10
        +
        +
        +
        +

        karait

        +

        A ridiculously simple queuing system, with clients in various languages, built on top of MongoDB.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push20:21:36 on 4/11/2011
        Homepagehttp://
        Urlhttps://github.com/bcoe/karait
        Clone Urlhttps://github.com/bcoe/karait.git
        Forks6
        Watchers77
        +
        +
        +
        +
        +

        Logging libraries or applications

        +
        +

        logmeup-server

        +

        LogMeUp Server - View any log files real-time in your web browser.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push21:53:23 on 17/4/2012
        Homepagehttp://http://logmeup.com
        Urlhttps://github.com/jprichardson/logmeup-server
        Clone Urlhttps://github.com/jprichardson/logmeup-server.git
        Forks0
        Watchers6
        +
        +
        +
        +

        nodeEventStore

        +

        EventStore Implementation in node.js

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push10:14:54 on 10/4/2012
        Homepagehttp://http:/jamuhl.github.com/nodeEventStore/
        Urlhttps://github.com/KABA-CCEAC/nodeEventStore
        Clone Urlhttps://github.com/KABA-CCEAC/nodeEventStore.git
        Forks2
        Watchers4
        +
        +
        +
        +

        devnull

        +

        dev/null, a powerful logging module for Node.js.. Because logging to dev/null is fast! <3

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push9:53:54 on 2/0/2013
        Homepagehttp://dev/null
        Urlhttps://github.com/observing/devnull
        Clone Urlhttps://github.com/observing/devnull.git
        Forks0
        Watchers21
        +
        +
        +
        +
        +

        Monitoring applications or libraries

        +
        +

        Informant

        +

        A node based server monitor to get real-time status of your ops...

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push21:20:40 on 31/0/2012
        Homepagehttp://
        Urlhttps://github.com/base698/Informant
        Clone Urlhttps://github.com/base698/Informant.git
        Forks0
        Watchers16
        +
        +
        +
        +
        +

        General frameworks over MongoDB

        +
        +

        DJS

        +

        A media sharing framework.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push22:48:0 on 14/2/2012
        Homepagehttp://
        Urlhttps://github.com/khwang/DJS
        Clone Urlhttps://github.com/khwang/DJS.git
        Forks4
        Watchers23
        +
        +
        +
        +

        databank

        +

        NoSQL abstraction layer for Node.js

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push15:40:19 on 14/0/2013
        Homepagehttp://
        Urlhttps://github.com/evanp/databank
        Clone Urlhttps://github.com/evanp/databank.git
        Forks2
        Watchers48
        +
        +
        +
        +
        +

        Translation libraries or frameworks

        +
        +

        dialect-http

        +

        http client to manage your dialect translations

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push1:43:11 on 8/11/2011
        Homepagehttp://
        Urlhttps://github.com/masylum/dialect-http
        Clone Urlhttps://github.com/masylum/dialect-http.git
        Forks8
        Watchers27
        +
        +
        +
        +

        dialect

        +

        Translations for nodejs

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push9:21:6 on 22/2/2012
        Homepagehttp://
        Urlhttps://github.com/masylum/dialect
        Clone Urlhttps://github.com/masylum/dialect.git
        Forks22
        Watchers102
        +
        +
        +
        +
        +

        Libraries or Applications for analytics

        +
        +

        cube

        +

        Cube: A system for time series visualization.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push2:33:34 on 8/1/2013
        Homepagehttp://http://square.github.com/cube
        Urlhttps://github.com/square/cube
        Clone Urlhttps://github.com/square/cube.git
        Forks243
        Watchers2458
        +
        +
        +
        +
        +

        Libraries for the connect middleware

        +
        +

        connect-session-mongo

        +

        MongoDB Session Storage for Connect Middleware

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push5:6:21 on 24/2/2012
        Homepagehttp://https://github.com/bartt/connect-session-mongo
        Urlhttps://github.com/bartt/connect-session-mongo
        Clone Urlhttps://github.com/bartt/connect-session-mongo.git
        Forks8
        Watchers14
        +
        +
        +
        +

        connect-mongodb

        +

        SessionStorage for connect’s session middleware

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push17:52:14 on 21/0/2013
        Homepagehttp://
        Urlhttps://github.com/masylum/connect-mongodb
        Clone Urlhttps://github.com/masylum/connect-mongodb.git
        Forks60
        Watchers178
        +
        +
        +
        +

        connect-mongo

        +

        MongoDB session store for Connect.

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/active.png +
        Last push15:2:26 on 21/0/2013
        Homepagehttp://http://kcbanner.github.com/connect-mongo/
        Urlhttps://github.com/kcbanner/connect-mongo
        Clone Urlhttps://github.com/kcbanner/connect-mongo.git
        Forks67
        Watchers207
        +
        +
        +
        +
        +

        Libraries or applications for continous integration

        +
        +

        concrete

        +

        Simple continuous integration server written with NodeJS and CoffeeScript

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push20:18:30 on 9/6/2012
        Homepagehttp://http://ryankee.github.com/concrete
        Urlhttps://github.com/ryankee/concrete
        Clone Urlhttps://github.com/ryankee/concrete.git
        Forks39
        Watchers248
        +
        +
        +
        +
        +

        Exampe applications

        +
        +

        nodejs-blackboard

        +

        Testing nodejs (with socket.io)

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push3:50:52 on 4/6/2012
        Homepagehttp://node.kamikazepanda.com
        Urlhttps://github.com/gotik/nodejs-blackboard
        Clone Urlhttps://github.com/gotik/nodejs-blackboard.git
        Forks8
        Watchers27
        +
        +
        +
        +

        node-mongo-cms

        +

        standard blog written in nodejs (express) and mongodb

        +
        +
        ++++ + + + + + + + + + + + + + + + + + + + + + + + +
        Activity Level../_images/nonactive.png +
        Last push19:8:38 on 30/9/2011
        Homepagehttp://
        Urlhttps://github.com/dynamicguy/node-mongo-cms
        Clone Urlhttps://github.com/dynamicguy/node-mongo-cms.git
        Forks0
        Watchers5
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000000..6dc76440207 --- /dev/null +++ b/index.html @@ -0,0 +1,464 @@ + + + + + + + + + + The Node.JS MongoDB Driver Manual — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        The Node.JS MongoDB Driver Manual

        + + + + +
        +

        External Tutorials

        +
        +
        +
        +
        + +
        +

        Projects and Libraries using the driver

        +
        +
          +
        +
        +
        +
        +

        MongoDB in General

        +

        There are two main places to learn about MongoDB itself. I’ve included links below.

        +
        +
        +
        +

        There are also some very good books out these days

        +
        +
        +
        +
        +

        Changelog

        +
        + +
        +
        +
        +

        Indices

        + +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/index.js b/index.js deleted file mode 100755 index 4f59e9d9262..00000000000 --- a/index.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = require('./lib/mongodb'); diff --git a/install.js b/install.js deleted file mode 100644 index a6bebfa6720..00000000000 --- a/install.js +++ /dev/null @@ -1,41 +0,0 @@ -var spawn = require('child_process').spawn, - exec = require('child_process').exec; - -process.stdout.write("================================================================================\n"); -process.stdout.write("= =\n"); -process.stdout.write("= To install with C++ bson parser do =\n"); -process.stdout.write("= =\n"); -process.stdout.write("================================================================================\n"); - -// Check if we want to build the native code -var build_native = process.env['npm_package_config_native'] != null ? process.env['npm_package_config_native'] : 'false'; -build_native = build_native == 'true' ? true : false; - -// If we are building the native bson extension ensure we use gmake if available -if(build_native) { - // Check if we need to use gmake - exec('which gmake', function(err, stdout, stderr) { - // Set up spawn command - var make = null; - // No gmake build using make - if(err != null) { - make = spawn('make', ['total']); - } else { - make = spawn('gmake', ['total']); - } - - // Execute spawn - make.stdout.on('data', function(data) { - process.stdout.write(data); - }) - - make.stderr.on('data', function(data) { - process.stdout.write(data); - }) - - make.on('exit', function(code) { - process.stdout.write('child process exited with code ' + code + "\n"); - }) - }); -} - diff --git a/lib/mongodb/admin.js b/lib/mongodb/admin.js deleted file mode 100644 index 89ca706c24a..00000000000 --- a/lib/mongodb/admin.js +++ /dev/null @@ -1,342 +0,0 @@ -/*! - * Module dependencies. - */ -var Collection = require('./collection').Collection, - Cursor = require('./cursor').Cursor, - DbCommand = require('./commands/db_command').DbCommand; - -/** - * Allows the user to access the admin functionality of MongoDB - * - * @class Represents the Admin methods of MongoDB. - * @param {Object} db Current db instance we wish to perform Admin operations on. - * @return {Function} Constructor for Admin type. - */ -function Admin(db) { - this.db = db; -}; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.buildInfo = function(callback) { - this.serverInfo(callback); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api private - */ -Admin.prototype.serverInfo = function(callback) { - var self = this; - var command = {buildinfo:1}; - this.command(command, function(err, doc) { - if(err != null) return callback(err, null); - return callback(null, doc.documents[0]); - }); -} - -/** - * Retrieve the current profiling Level for MongoDB - * - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.profilingLevel = function(callback) { - var self = this; - var command = {profile:-1}; - - this.command(command, function(err, doc) { - doc = doc.documents[0]; - - if(err == null && (doc.ok == 1 || typeof doc.was === 'number')) { - var was = doc.was; - if(was == 0) { - callback(null, "off"); - } else if(was == 1) { - callback(null, "slow_only"); - } else if(was == 2) { - callback(null, "all"); - } else { - callback(new Error("Error: illegal profiling level value " + was), null); - } - } else { - err != null ? callback(err, null) : callback(new Error("Error with profile command"), null); - } - }); -}; - -/** - * Ping the MongoDB server and retrieve results - * - * @param {Object} [options] Optional parameters to the command. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.ping = function(options, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - options = args.length ? args.shift() : {}; - // Set self - var self = this; - var databaseName = this.db.databaseName; - this.db.databaseName = 'admin'; - this.db.executeDbCommand({ping:1}, options, function(err, result) { - self.db.databaseName = databaseName; - return callback(err, result); - }) -} - -/** - * Authenticate against MongoDB - * - * @param {String} username The user name for the authentication. - * @param {String} password The password for the authentication. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.authenticate = function(username, password, callback) { - var self = this; - var databaseName = this.db.databaseName; - this.db.databaseName = 'admin'; - this.db.authenticate(username, password, function(err, result) { - self.db.databaseName = databaseName; - return callback(err, result); - }) -} - -/** - * Logout current authenticated user - * - * @param {Object} [options] Optional parameters to the command. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.logout = function(callback) { - var self = this; - var databaseName = this.db.databaseName; - this.db.databaseName = 'admin'; - this.db.logout(function(err, result) { - return callback(err, result); - }) - - self.db.databaseName = databaseName; -} - -/** - * Add a user to the MongoDB server, if the user exists it will - * overwrite the current password - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {String} username The user name for the authentication. - * @param {String} password The password for the authentication. - * @param {Object} [options] additional options during update. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.addUser = function(username, password, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - var self = this; - var databaseName = this.db.databaseName; - this.db.databaseName = 'admin'; - this.db.addUser(username, password, options, function(err, result) { - self.db.databaseName = databaseName; - return callback(err, result); - }) -} - -/** - * Remove a user from the MongoDB server - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {String} username The user name for the authentication. - * @param {Object} [options] additional options during update. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.removeUser = function(username, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - var self = this; - var databaseName = this.db.databaseName; - this.db.databaseName = 'admin'; - this.db.removeUser(username, options, function(err, result) { - self.db.databaseName = databaseName; - return callback(err, result); - }) -} - -/** - * Set the current profiling level of MongoDB - * - * @param {String} level The new profiling level (off, slow_only, all) - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.setProfilingLevel = function(level, callback) { - var self = this; - var command = {}; - var profile = 0; - - if(level == "off") { - profile = 0; - } else if(level == "slow_only") { - profile = 1; - } else if(level == "all") { - profile = 2; - } else { - return callback(new Error("Error: illegal profiling level value " + level)); - } - - // Set up the profile number - command['profile'] = profile; - // Execute the command to set the profiling level - this.command(command, function(err, doc) { - doc = doc.documents[0]; - - if(err == null && (doc.ok == 1 || typeof doc.was === 'number')) { - return callback(null, level); - } else { - return err != null ? callback(err, null) : callback(new Error("Error with profile command"), null); - } - }); -}; - -/** - * Retrive the current profiling information for MongoDB - * - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.profilingInfo = function(callback) { - var self = this; - var databaseName = this.db.databaseName; - this.db.databaseName = 'admin'; - - try { - new Cursor(this.db, new Collection(this.db, DbCommand.SYSTEM_PROFILE_COLLECTION), {}).toArray(function(err, items) { - return callback(err, items); - }); - } catch (err) { - return callback(err, null); - } - - self.db.databaseName = databaseName; -}; - -/** - * Execute a db command against the Admin database - * - * @param {Object} command A command object `{ping:1}`. - * @param {Object} [options] Optional parameters to the command. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.command = function(command, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Execute a command - this.db.executeDbAdminCommand(command, options, function(err, result) { - // Ensure change before event loop executes - return callback != null ? callback(err, result) : null; - }); -} - -/** - * Validate an existing collection - * - * @param {String} collectionName The name of the collection to validate. - * @param {Object} [options] Optional parameters to the command. - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.validateCollection = function(collectionName, options, callback) { - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - var self = this; - var command = {validate: collectionName}; - var keys = Object.keys(options); - - // Decorate command with extra options - for(var i = 0; i < keys.length; i++) { - if(options.hasOwnProperty(keys[i])) { - command[keys[i]] = options[keys[i]]; - } - } - - this.db.executeDbCommand(command, function(err, doc) { - if(err != null) return callback(err, null); - doc = doc.documents[0]; - - if(doc.ok == 0) { - return callback(new Error("Error with validate command"), null); - } else if(doc.result != null && doc.result.constructor != String) { - return callback(new Error("Error with validation data"), null); - } else if(doc.result != null && doc.result.match(/exception|corrupt/) != null) { - return callback(new Error("Error: invalid collection " + collectionName), null); - } else if(doc.valid != null && !doc.valid) { - return callback(new Error("Error: invalid collection " + collectionName), null); - } else { - return callback(null, doc); - } - }); -}; - -/** - * List the available databases - * - * @param {Function} callback Callback function of format `function(err, result) {}`. - * @return {null} Returns no result - * @api public - */ -Admin.prototype.listDatabases = function(callback) { - // Execute the listAllDatabases command - this.db.executeDbAdminCommand({listDatabases:1}, {}, function(err, result) { - if(err != null) { - callback(err, null); - } else { - callback(null, result.documents[0]); - } - }); -} - -/** - * @ignore - */ -exports.Admin = Admin; diff --git a/lib/mongodb/bson/binary.js b/lib/mongodb/bson/binary.js deleted file mode 100644 index 7df0f36b647..00000000000 --- a/lib/mongodb/bson/binary.js +++ /dev/null @@ -1,186 +0,0 @@ -/** - * Module dependencies. - */ -var Buffer = require('buffer').Buffer; // TODO just use global Buffer -var bson = require('./bson'); - -/** - * A class representation of the BSON Binary type. - * - * Sub types - * - **BSON.BSON_BINARY_SUBTYPE_DEFAULT**, default BSON type. - * - **BSON.BSON_BINARY_SUBTYPE_FUNCTION**, BSON function type. - * - **BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY**, BSON byte array type. - * - **BSON.BSON_BINARY_SUBTYPE_UUID**, BSON uuid type. - * - **BSON.BSON_BINARY_SUBTYPE_MD5**, BSON md5 type. - * - **BSON.BSON_BINARY_SUBTYPE_USER_DEFINED**, BSON user defined type. - * - * @class Represents the Binary BSON type. - * @param {Buffer} buffer a buffer object containing the binary data. - * @param {Number} [subType] the option binary type. - * @return {Grid} - */ -function Binary(buffer, subType) { - this._bsontype = 'Binary'; - - if(buffer instanceof Number) { - this.sub_type = buffer; - this.position = 0; - } else { - this.sub_type = subType == null ? bson.BSON.BSON_BINARY_SUBTYPE_DEFAULT : subType; - this.position = 0; - } - - if(buffer != null && !(buffer instanceof Number)) { - this.buffer = typeof buffer == 'string' ? new Buffer(buffer) : buffer; - this.position = buffer.length; - } else { - this.buffer = new Buffer(Binary.BUFFER_SIZE); - this.position = 0; - } -}; - -/** - * Updates this binary with byte_value. - * - * @param {Character} byte_value a single byte we wish to write. - * @api public - */ -Binary.prototype.put = function put (byte_value) { - if(this.buffer.length > this.position) { - this.buffer[this.position++] = byte_value.charCodeAt(0); - } else { - // Create additional overflow buffer - var buffer = new Buffer(Binary.BUFFER_SIZE + this.buffer.length); - // Combine the two buffers together - this.buffer.copy(buffer, 0, 0, this.buffer.length); - this.buffer = buffer; - this.buffer[this.position++] = byte_value.charCodeAt(0); - } -}; - -/** - * Writes. - * - * @param {Buffer|String} string a string or buffer to be written to the Binary BSON object. - * @param {Number} offset specify the binary of where to write the content. - * @api public - */ -Binary.prototype.write = function write(string, offset) { - offset = offset ? offset : this.position; - - // If the buffer is to small let's extend the buffer - if (this.buffer.length < offset + string.length) { - var buffer = new Buffer(this.buffer.length + string.length); - this.buffer.copy(buffer, 0, 0, this.buffer.length); - // Assign the new buffer - this.buffer = buffer; - } - - if (string instanceof Buffer) { - string.copy(this.buffer, offset, 0, string.length); - } else { - this.buffer.write(string, 'binary', offset); - } - - this.position = offset + string.length; -}; - -/** - * Reads **length** bytes starting at **position**. - * - * @param {Number} position read from the given position in the Binary. - * @param {Number} length the number of bytes to read. - * @return {Buffer} - * @api public - */ -Binary.prototype.read = function read(position, length) { - length = length && length > 0 - ? length - : this.position; - - // Return the buffer - return this.buffer.slice(position, position + length); -}; - -/** - * Returns the value of this binary as a string. - * - * @return {String} - * @api public - */ -Binary.prototype.value = function value(asRaw) { - asRaw = asRaw == null ? false : asRaw; - return asRaw ? this.buffer.slice(0, this.position) : this.buffer.toString('binary', 0, this.position); -}; - -/** - * Length. - * - * @return {Number} the length of the binary. - * @api public - */ -Binary.prototype.length = function length() { - return this.position; -}; - -/** - * @ignore - * @api private - */ -Binary.prototype.toJSON = function() { - return this.buffer != null ? this.buffer.toString('base64') : ''; -} - -/** - * @ignore - * @api private - */ -Binary.prototype.toString = function(format) { - return this.buffer != null ? this.buffer.slice(0, this.position).toString(format) : ''; -} - -Binary.BUFFER_SIZE = 256; - -/** - * Default BSON type - * - * @classconstant SUBTYPE_DEFAULT - **/ -Binary.SUBTYPE_DEFAULT = 0; -/** - * Function BSON type - * - * @classconstant SUBTYPE_DEFAULT - **/ -Binary.SUBTYPE_FUNCTION = 1; -/** - * Byte Array BSON type - * - * @classconstant SUBTYPE_DEFAULT - **/ -Binary.SUBTYPE_BYTE_ARRAY = 2; -/** - * UUID BSON type - * - * @classconstant SUBTYPE_DEFAULT - **/ -Binary.SUBTYPE_UUID = 3; -/** - * MD5 BSON type - * - * @classconstant SUBTYPE_DEFAULT - **/ -Binary.SUBTYPE_MD5 = 4; -/** - * User BSON type - * - * @classconstant SUBTYPE_DEFAULT - **/ -Binary.SUBTYPE_USER_DEFINED = 128; - -/** - * Expose. - */ -exports.Binary = Binary; - diff --git a/lib/mongodb/bson/binary_parser.js b/lib/mongodb/bson/binary_parser.js deleted file mode 100644 index 1d6b07ce8a0..00000000000 --- a/lib/mongodb/bson/binary_parser.js +++ /dev/null @@ -1,392 +0,0 @@ - -/** - * Module dependencies. - */ - -var sys = require('util'); - -/** - * Binary Parser. - * Jonas Raoni Soares Silva - * http://jsfromhell.com/classes/binary-parser [v1.0] - */ - -var chr = String.fromCharCode; - -var maxBits = []; -for (var i = 0; i < 64; i++) { - maxBits[i] = Math.pow(2, i); -} - -function BinaryParser (bigEndian, allowExceptions) { - this.bigEndian = bigEndian; - this.allowExceptions = allowExceptions; -}; - -BinaryParser.warn = function warn (msg) { - if (this.allowExceptions) { - throw new Error(msg); - } - - return 1; -}; - -BinaryParser.decodeFloat = function decodeFloat (data, precisionBits, exponentBits) { - var b = new this.Buffer(this.bigEndian, data); - - b.checkBuffer(precisionBits + exponentBits + 1); - - var bias = maxBits[exponentBits - 1] - 1 - , signal = b.readBits(precisionBits + exponentBits, 1) - , exponent = b.readBits(precisionBits, exponentBits) - , significand = 0 - , divisor = 2 - , curByte = b.buffer.length + (-precisionBits >> 3) - 1; - - do { - for (var byteValue = b.buffer[ ++curByte ], startBit = precisionBits % 8 || 8, mask = 1 << startBit; mask >>= 1; ( byteValue & mask ) && ( significand += 1 / divisor ), divisor *= 2 ); - } while (precisionBits -= startBit); - - return exponent == ( bias << 1 ) + 1 ? significand ? NaN : signal ? -Infinity : +Infinity : ( 1 + signal * -2 ) * ( exponent || significand ? !exponent ? Math.pow( 2, -bias + 1 ) * significand : Math.pow( 2, exponent - bias ) * ( 1 + significand ) : 0 ); -}; - -BinaryParser.decodeInt = function decodeInt (data, bits, signed, forceBigEndian) { - var b = new this.Buffer(this.bigEndian || forceBigEndian, data) - , x = b.readBits(0, bits) - , max = maxBits[bits]; //max = Math.pow( 2, bits ); - - return signed && x >= max / 2 - ? x - max - : x; -}; - -BinaryParser.encodeFloat = function encodeFloat (data, precisionBits, exponentBits) { - var bias = maxBits[exponentBits - 1] - 1 - , minExp = -bias + 1 - , maxExp = bias - , minUnnormExp = minExp - precisionBits - , n = parseFloat(data) - , status = isNaN(n) || n == -Infinity || n == +Infinity ? n : 0 - , exp = 0 - , len = 2 * bias + 1 + precisionBits + 3 - , bin = new Array(len) - , signal = (n = status !== 0 ? 0 : n) < 0 - , intPart = Math.floor(n = Math.abs(n)) - , floatPart = n - intPart - , lastBit - , rounded - , result - , i - , j; - - for (i = len; i; bin[--i] = 0); - - for (i = bias + 2; intPart && i; bin[--i] = intPart % 2, intPart = Math.floor(intPart / 2)); - - for (i = bias + 1; floatPart > 0 && i; (bin[++i] = ((floatPart *= 2) >= 1) - 0 ) && --floatPart); - - for (i = -1; ++i < len && !bin[i];); - - if (bin[(lastBit = precisionBits - 1 + (i = (exp = bias + 1 - i) >= minExp && exp <= maxExp ? i + 1 : bias + 1 - (exp = minExp - 1))) + 1]) { - if (!(rounded = bin[lastBit])) { - for (j = lastBit + 2; !rounded && j < len; rounded = bin[j++]); - } - - for (j = lastBit + 1; rounded && --j >= 0; (bin[j] = !bin[j] - 0) && (rounded = 0)); - } - - for (i = i - 2 < 0 ? -1 : i - 3; ++i < len && !bin[i];); - - if ((exp = bias + 1 - i) >= minExp && exp <= maxExp) { - ++i; - } else if (exp < minExp) { - exp != bias + 1 - len && exp < minUnnormExp && this.warn("encodeFloat::float underflow"); - i = bias + 1 - (exp = minExp - 1); - } - - if (intPart || status !== 0) { - this.warn(intPart ? "encodeFloat::float overflow" : "encodeFloat::" + status); - exp = maxExp + 1; - i = bias + 2; - - if (status == -Infinity) { - signal = 1; - } else if (isNaN(status)) { - bin[i] = 1; - } - } - - for (n = Math.abs(exp + bias), j = exponentBits + 1, result = ""; --j; result = (n % 2) + result, n = n >>= 1); - - for (n = 0, j = 0, i = (result = (signal ? "1" : "0") + result + bin.slice(i, i + precisionBits).join("")).length, r = []; i; j = (j + 1) % 8) { - n += (1 << j) * result.charAt(--i); - if (j == 7) { - r[r.length] = String.fromCharCode(n); - n = 0; - } - } - - r[r.length] = n - ? String.fromCharCode(n) - : ""; - - return (this.bigEndian ? r.reverse() : r).join(""); -}; - -BinaryParser.encodeInt = function encodeInt (data, bits, signed, forceBigEndian) { - var max = maxBits[bits]; - - if (data >= max || data < -(max / 2)) { - this.warn("encodeInt::overflow"); - data = 0; - } - - if (data < 0) { - data += max; - } - - for (var r = []; data; r[r.length] = String.fromCharCode(data % 256), data = Math.floor(data / 256)); - - for (bits = -(-bits >> 3) - r.length; bits--; r[r.length] = "\0"); - - return ((this.bigEndian || forceBigEndian) ? r.reverse() : r).join(""); -}; - -BinaryParser.toSmall = function( data ){ return this.decodeInt( data, 8, true ); }; -BinaryParser.fromSmall = function( data ){ return this.encodeInt( data, 8, true ); }; -BinaryParser.toByte = function( data ){ return this.decodeInt( data, 8, false ); }; -BinaryParser.fromByte = function( data ){ return this.encodeInt( data, 8, false ); }; -BinaryParser.toShort = function( data ){ return this.decodeInt( data, 16, true ); }; -BinaryParser.fromShort = function( data ){ return this.encodeInt( data, 16, true ); }; -BinaryParser.toWord = function( data ){ return this.decodeInt( data, 16, false ); }; -BinaryParser.fromWord = function( data ){ return this.encodeInt( data, 16, false ); }; -BinaryParser.toInt = function( data ){ return this.decodeInt( data, 32, true ); }; -BinaryParser.fromInt = function( data ){ return this.encodeInt( data, 32, true ); }; -BinaryParser.toLong = function( data ){ return this.decodeInt( data, 64, true ); }; -BinaryParser.fromLong = function( data ){ return this.encodeInt( data, 64, true ); }; -BinaryParser.toDWord = function( data ){ return this.decodeInt( data, 32, false ); }; -BinaryParser.fromDWord = function( data ){ return this.encodeInt( data, 32, false ); }; -BinaryParser.toQWord = function( data ){ return this.decodeInt( data, 64, true ); }; -BinaryParser.fromQWord = function( data ){ return this.encodeInt( data, 64, true ); }; -BinaryParser.toFloat = function( data ){ return this.decodeFloat( data, 23, 8 ); }; -BinaryParser.fromFloat = function( data ){ return this.encodeFloat( data, 23, 8 ); }; -BinaryParser.toDouble = function( data ){ return this.decodeFloat( data, 52, 11 ); }; -BinaryParser.fromDouble = function( data ){ return this.encodeFloat( data, 52, 11 ); }; - -// Factor out the encode so it can be shared by add_header and push_int32 -BinaryParser.encode_int32 = function encode_int32 (number, asArray) { - var a, b, c, d, unsigned; - unsigned = (number < 0) ? (number + 0x100000000) : number; - a = Math.floor(unsigned / 0xffffff); - unsigned &= 0xffffff; - b = Math.floor(unsigned / 0xffff); - unsigned &= 0xffff; - c = Math.floor(unsigned / 0xff); - unsigned &= 0xff; - d = Math.floor(unsigned); - return asArray ? [chr(a), chr(b), chr(c), chr(d)] : chr(a) + chr(b) + chr(c) + chr(d); -}; - -BinaryParser.encode_int64 = function encode_int64 (number) { - var a, b, c, d, e, f, g, h, unsigned; - unsigned = (number < 0) ? (number + 0x10000000000000000) : number; - a = Math.floor(unsigned / 0xffffffffffffff); - unsigned &= 0xffffffffffffff; - b = Math.floor(unsigned / 0xffffffffffff); - unsigned &= 0xffffffffffff; - c = Math.floor(unsigned / 0xffffffffff); - unsigned &= 0xffffffffff; - d = Math.floor(unsigned / 0xffffffff); - unsigned &= 0xffffffff; - e = Math.floor(unsigned / 0xffffff); - unsigned &= 0xffffff; - f = Math.floor(unsigned / 0xffff); - unsigned &= 0xffff; - g = Math.floor(unsigned / 0xff); - unsigned &= 0xff; - h = Math.floor(unsigned); - return chr(a) + chr(b) + chr(c) + chr(d) + chr(e) + chr(f) + chr(g) + chr(h); -}; - -/** - * UTF8 methods - */ - -// Take a raw binary string and return a utf8 string -BinaryParser.decode_utf8 = function decode_utf8 (binaryStr) { - var len = binaryStr.length - , decoded = '' - , i = 0 - , c = 0 - , c1 = 0 - , c2 = 0 - , c3; - - while (i < len) { - c = binaryStr.charCodeAt(i); - if (c < 128) { - decoded += String.fromCharCode(c); - i++; - } else if ((c > 191) && (c < 224)) { - c2 = binaryStr.charCodeAt(i+1); - decoded += String.fromCharCode(((c & 31) << 6) | (c2 & 63)); - i += 2; - } else { - c2 = binaryStr.charCodeAt(i+1); - c3 = binaryStr.charCodeAt(i+2); - decoded += String.fromCharCode(((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63)); - i += 3; - } - } - - return decoded; -}; - -// Encode a cstring -BinaryParser.encode_cstring = function encode_cstring (s) { - return unescape(encodeURIComponent(s)) + BinaryParser.fromByte(0); -}; - -// Take a utf8 string and return a binary string -BinaryParser.encode_utf8 = function encode_utf8 (s) { - var a = "" - , c; - - for (var n = 0, len = s.length; n < len; n++) { - c = s.charCodeAt(n); - - if (c < 128) { - a += String.fromCharCode(c); - } else if ((c > 127) && (c < 2048)) { - a += String.fromCharCode((c>>6) | 192) ; - a += String.fromCharCode((c&63) | 128); - } else { - a += String.fromCharCode((c>>12) | 224); - a += String.fromCharCode(((c>>6) & 63) | 128); - a += String.fromCharCode((c&63) | 128); - } - } - - return a; -}; - -BinaryParser.hprint = function hprint (s) { - var number; - - for (var i = 0, len = s.length; i < len; i++) { - if (s.charCodeAt(i) < 32) { - number = s.charCodeAt(i) <= 15 - ? "0" + s.charCodeAt(i).toString(16) - : s.charCodeAt(i).toString(16); - process.stdout.write(number + " ") - } else { - number = s.charCodeAt(i) <= 15 - ? "0" + s.charCodeAt(i).toString(16) - : s.charCodeAt(i).toString(16); - process.stdout.write(number + " ") - } - } - - process.stdout.write("\n\n"); -}; - -BinaryParser.ilprint = function hprint (s) { - var number; - - for (var i = 0, len = s.length; i < len; i++) { - if (s.charCodeAt(i) < 32) { - number = s.charCodeAt(i) <= 15 - ? "0" + s.charCodeAt(i).toString(10) - : s.charCodeAt(i).toString(10); - - sys.debug(number+' : '); - } else { - number = s.charCodeAt(i) <= 15 - ? "0" + s.charCodeAt(i).toString(10) - : s.charCodeAt(i).toString(10); - sys.debug(number+' : '+ s.charAt(i)); - } - } -}; - -BinaryParser.hlprint = function hprint (s) { - var number; - - for (var i = 0, len = s.length; i < len; i++) { - if (s.charCodeAt(i) < 32) { - number = s.charCodeAt(i) <= 15 - ? "0" + s.charCodeAt(i).toString(16) - : s.charCodeAt(i).toString(16); - sys.debug(number+' : '); - } else { - number = s.charCodeAt(i) <= 15 - ? "0" + s.charCodeAt(i).toString(16) - : s.charCodeAt(i).toString(16); - sys.debug(number+' : '+ s.charAt(i)); - } - } -}; - -/** - * BinaryParser buffer constructor. - */ - -function BinaryParserBuffer (bigEndian, buffer) { - this.bigEndian = bigEndian || 0; - this.buffer = []; - this.setBuffer(buffer); -}; - -BinaryParserBuffer.prototype.setBuffer = function setBuffer (data) { - var l, i, b; - - if (data) { - i = l = data.length; - b = this.buffer = new Array(l); - for (; i; b[l - i] = data.charCodeAt(--i)); - this.bigEndian && b.reverse(); - } -}; - -BinaryParserBuffer.prototype.hasNeededBits = function hasNeededBits (neededBits) { - return this.buffer.length >= -(-neededBits >> 3); -}; - -BinaryParserBuffer.prototype.checkBuffer = function checkBuffer (neededBits) { - if (!this.hasNeededBits(neededBits)) { - throw new Error("checkBuffer::missing bytes"); - } -}; - -BinaryParserBuffer.prototype.readBits = function readBits (start, length) { - //shl fix: Henri Torgemane ~1996 (compressed by Jonas Raoni) - - function shl (a, b) { - for (; b--; a = ((a %= 0x7fffffff + 1) & 0x40000000) == 0x40000000 ? a * 2 : (a - 0x40000000) * 2 + 0x7fffffff + 1); - return a; - } - - if (start < 0 || length <= 0) { - return 0; - } - - this.checkBuffer(start + length); - - var offsetLeft - , offsetRight = start % 8 - , curByte = this.buffer.length - ( start >> 3 ) - 1 - , lastByte = this.buffer.length + ( -( start + length ) >> 3 ) - , diff = curByte - lastByte - , sum = ((this.buffer[ curByte ] >> offsetRight) & ((1 << (diff ? 8 - offsetRight : length)) - 1)) + (diff && (offsetLeft = (start + length) % 8) ? (this.buffer[lastByte++] & ((1 << offsetLeft) - 1)) << (diff-- << 3) - offsetRight : 0); - - for(; diff; sum += shl(this.buffer[lastByte++], (diff-- << 3) - offsetRight)); - - return sum; -}; - -/** - * Expose. - */ - -exports.BinaryParser = BinaryParser; -BinaryParser.Buffer = BinaryParserBuffer; diff --git a/lib/mongodb/bson/binary_utils.js b/lib/mongodb/bson/binary_utils.js deleted file mode 100644 index c52accdf724..00000000000 --- a/lib/mongodb/bson/binary_utils.js +++ /dev/null @@ -1,29 +0,0 @@ -exports.encodeInt = function(value) { - var buffer = new Buffer(4); - buffer[3] = (value >> 24) & 0xff; - buffer[2] = (value >> 16) & 0xff; - buffer[1] = (value >> 8) & 0xff; - buffer[0] = value & 0xff; - return buffer; -} - -exports.encodeIntInPlace = function(value, buffer, index) { - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; -} - -exports.encodeCString = function(string) { - var buf = new Buffer(string, 'utf8'); - return [buf, new Buffer([0])]; -} - -exports.decodeUInt32 = function(array, index) { - return array[index] | array[index + 1] << 8 | array[index + 2] << 16 | array[index + 3] << 24; -} - -// Decode the int -exports.decodeUInt8 = function(array, index) { - return array[index]; -} diff --git a/lib/mongodb/bson/bson.js b/lib/mongodb/bson/bson.js deleted file mode 100644 index 53eec196ba4..00000000000 --- a/lib/mongodb/bson/bson.js +++ /dev/null @@ -1,1344 +0,0 @@ -/** - * Module dependencies. - * @ignore - */ -var BinaryParser = require('./binary_parser').BinaryParser - , Long = require('./long').Long - , Double = require('./double').Double - , Timestamp = require('./timestamp').Timestamp - , ObjectID = require('./objectid').ObjectID - , Symbol = require('./symbol').Symbol - , Code = require('./code').Code - , MinKey = require('./min_key').MinKey - , MaxKey = require('./max_key').MaxKey - , DBRef = require('./db_ref').DBRef - , Binary = require('./binary').Binary - , debug = require('util').debug - , crypto = require('crypto') - , inspect = require('util').inspect - , inherits = require('util').inherits - , ieee754 = require('./float_parser'); - - -/** - * Create a new BSON instance - * - * @class Represents the BSON Parser - * @return {BSON} instance of BSON Parser. - */ -function BSON () {}; - -/** - * @ignore - * @api private - */ -// BSON MAX VALUES -BSON.BSON_INT32_MAX = 0x7FFFFFFF; -BSON.BSON_INT32_MIN = -0x80000000; - -BSON.BSON_INT64_MAX = Math.pow(2, 63) - 1; -BSON.BSON_INT64_MIN = -Math.pow(2, 63); - -// JS MAX PRECISE VALUES -BSON.JS_INT_MAX = 0x20000000000000; // Any integer up to 2^53 can be precisely represented by a double. -BSON.JS_INT_MIN = -0x20000000000000; // Any integer down to -2^53 can be precisely represented by a double. - -// Internal long versions -var JS_INT_MAX_LONG = Long.fromNumber(0x20000000000000); // Any integer up to 2^53 can be precisely represented by a double. -var JS_INT_MIN_LONG = Long.fromNumber(-0x20000000000000); // Any integer down to -2^53 can be precisely represented by a double. - -/** - * Number BSON Type - * - * @classconstant BSON_DATA_NUMBER - **/ -BSON.BSON_DATA_NUMBER = 1; -/** - * String BSON Type - * - * @classconstant BSON_DATA_STRING - **/ -BSON.BSON_DATA_STRING = 2; -/** - * Object BSON Type - * - * @classconstant BSON_DATA_OBJECT - **/ -BSON.BSON_DATA_OBJECT = 3; -/** - * Array BSON Type - * - * @classconstant BSON_DATA_ARRAY - **/ -BSON.BSON_DATA_ARRAY = 4; -/** - * Binary BSON Type - * - * @classconstant BSON_DATA_BINARY - **/ -BSON.BSON_DATA_BINARY = 5; -/** - * ObjectID BSON Type - * - * @classconstant BSON_DATA_OID - **/ -BSON.BSON_DATA_OID = 7; -/** - * Boolean BSON Type - * - * @classconstant BSON_DATA_BOOLEAN - **/ -BSON.BSON_DATA_BOOLEAN = 8; -/** - * Date BSON Type - * - * @classconstant BSON_DATA_DATE - **/ -BSON.BSON_DATA_DATE = 9; -/** - * null BSON Type - * - * @classconstant BSON_DATA_NULL - **/ -BSON.BSON_DATA_NULL = 10; -/** - * RegExp BSON Type - * - * @classconstant BSON_DATA_REGEXP - **/ -BSON.BSON_DATA_REGEXP = 11; -/** - * Code BSON Type - * - * @classconstant BSON_DATA_CODE - **/ -BSON.BSON_DATA_CODE = 13; -/** - * Symbol BSON Type - * - * @classconstant BSON_DATA_SYMBOL - **/ -BSON.BSON_DATA_SYMBOL = 14; -/** - * Code with Scope BSON Type - * - * @classconstant BSON_DATA_CODE_W_SCOPE - **/ -BSON.BSON_DATA_CODE_W_SCOPE = 15; -/** - * 32 bit Integer BSON Type - * - * @classconstant BSON_DATA_INT - **/ -BSON.BSON_DATA_INT = 16; -/** - * Timestamp BSON Type - * - * @classconstant BSON_DATA_TIMESTAMP - **/ -BSON.BSON_DATA_TIMESTAMP = 17; -/** - * Long BSON Type - * - * @classconstant BSON_DATA_LONG - **/ -BSON.BSON_DATA_LONG = 18; -/** - * MinKey BSON Type - * - * @classconstant BSON_DATA_MIN_KEY - **/ -BSON.BSON_DATA_MIN_KEY = 0xff; -/** - * MaxKey BSON Type - * - * @classconstant BSON_DATA_MAX_KEY - **/ -BSON.BSON_DATA_MAX_KEY = 0x7f; - -/** - * Binary Default Type - * - * @classconstant BSON_BINARY_SUBTYPE_DEFAULT - **/ -BSON.BSON_BINARY_SUBTYPE_DEFAULT = 0; -/** - * Binary Function Type - * - * @classconstant BSON_BINARY_SUBTYPE_FUNCTION - **/ -BSON.BSON_BINARY_SUBTYPE_FUNCTION = 1; -/** - * Binary Byte Array Type - * - * @classconstant BSON_BINARY_SUBTYPE_BYTE_ARRAY - **/ -BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY = 2; -/** - * Binary UUID Type - * - * @classconstant BSON_BINARY_SUBTYPE_UUID - **/ -BSON.BSON_BINARY_SUBTYPE_UUID = 3; -/** - * Binary MD5 Type - * - * @classconstant BSON_BINARY_SUBTYPE_MD5 - **/ -BSON.BSON_BINARY_SUBTYPE_MD5 = 4; -/** - * Binary User Defined Type - * - * @classconstant BSON_BINARY_SUBTYPE_USER_DEFINED - **/ -BSON.BSON_BINARY_SUBTYPE_USER_DEFINED = 128; - -/** - * Calculate the bson size for a passed in Javascript object. - * - * @param {Object} object the Javascript object to calculate the BSON byte size for. - * @param {Boolean} [serializeFunctions] serialize all functions in the object **(default:false)**. - * @return {Number} returns the number of bytes the BSON object will take up. - * @api public - */ -BSON.calculateObjectSize = function calculateObjectSize(object, serializeFunctions) { - var totalLength = (4 + 1); - - if(Array.isArray(object)) { - for(var i = 0; i < object.length; i++) { - totalLength += calculateElement(i.toString(), object[i], serializeFunctions) - } - } else { - for(var key in object) { - totalLength += calculateElement(key, object[key], serializeFunctions) - } - } - - return totalLength; -} - -/** - * @ignore - * @api private - */ -function calculateElement(name, value, serializeFunctions) { - switch(typeof value) { - case 'string': - return 1 + Buffer.byteLength(name, 'utf8') + 1 + 4 + Buffer.byteLength(value, 'utf8') + 1; - case 'number': - if(Math.floor(value) === value && value >= BSON.JS_INT_MIN && value <= BSON.JS_INT_MAX) { - if(value >= BSON.BSON_INT32_MIN && value <= BSON.BSON_INT32_MAX) { // 32 bit - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (4 + 1); - } else { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (8 + 1); - } - } else { // 64 bit - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (8 + 1); - } - case 'undefined': - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (1); - case 'boolean': - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (1 + 1); - case 'object': - if(value == null || value instanceof MinKey || value instanceof MaxKey || value['_bsontype'] == 'MinKey' || value['_bsontype'] == 'MaxKey') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (1); - } else if(value instanceof ObjectID || value['_bsontype'] == 'ObjectID') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (12 + 1); - } else if(value instanceof Date) { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (8 + 1); - } else if(Buffer.isBuffer(value)) { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (1 + 4 + 1) + value.length; - } else if(value instanceof Long || value instanceof Double || value instanceof Timestamp - || value['_bsontype'] == 'Long' || value['_bsontype'] == 'Double' || value['_bsontype'] == 'Timestamp') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (8 + 1); - } else if(value instanceof Code || value['_bsontype'] == 'Code') { - // Calculate size depending on the availability of a scope - if(value.scope != null && Object.keys(value.scope).length > 0) { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + 4 + 4 + Buffer.byteLength(value.code.toString(), 'utf8') + 1 + BSON.calculateObjectSize(value.scope); - } else { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + 4 + Buffer.byteLength(value.code.toString(), 'utf8') + 1; - } - } else if(value instanceof Binary || value['_bsontype'] == 'Binary') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (value.position + 1 + 4 + 1); - } else if(value instanceof Symbol || value['_bsontype'] == 'Symbol') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + (Buffer.byteLength(value.value, 'utf8') + 4 + 1 + 1); - } else if(value instanceof DBRef || value['_bsontype'] == 'DBRef') { - // Set up correct object for serialization - var ordered_values = { - '$ref': value.namespace - , '$id' : value.oid - }; - - // Add db reference if it exists - if(null != value.db) { - ordered_values['$db'] = value.db; - } - - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + BSON.calculateObjectSize(ordered_values, serializeFunctions); - } else if(value instanceof RegExp || toString.call(value) === '[object RegExp]') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + Buffer.byteLength(value.source, 'utf8') + 1 - + (value.global ? 1 : 0) + (value.ignoreCase ? 1 : 0) + (value.multiline ? 1 : 0) + 1 - } else { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + BSON.calculateObjectSize(value, serializeFunctions) + 1; - } - case 'function': - // WTF for 0.4.X where typeof /someregexp/ === 'function' - if(value instanceof RegExp || toString.call(value) === '[object RegExp]') { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + Buffer.byteLength(value.source, 'utf8') + 1 - + (value.global ? 1 : 0) + (value.ignoreCase ? 1 : 0) + (value.multiline ? 1 : 0) + 1 - } else { - if(serializeFunctions && value.scope != null && Object.keys(value.scope).length > 0) { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + 4 + 4 + Buffer.byteLength(value.toString(), 'utf8') + 1 + BSON.calculateObjectSize(value.scope); - } else if(serializeFunctions) { - return (name != null ? (Buffer.byteLength(name) + 1) : 0) + 1 + 4 + Buffer.byteLength(value.toString(), 'utf8') + 1; - } - } - } - - return 0; -} - -/** - * Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization. - * - * @param {Object} object the Javascript object to serialize. - * @param {Boolean} checkKeys the serializer will check if keys are valid. - * @param {Buffer} buffer the Buffer you pre-allocated to store the serialized BSON object. - * @param {Number} index the index in the buffer where we wish to start serializing into. - * @param {Boolean} serializeFunctions serialize the javascript functions **(default:false)**. - * @return {Number} returns the new write index in the Buffer. - * @api public - */ -BSON.serializeWithBufferAndIndex = function serializeWithBufferAndIndex(object, checkKeys, buffer, index, serializeFunctions) { - // Default setting false - serializeFunctions = serializeFunctions == null ? false : serializeFunctions; - // Write end information (length of the object) - var size = buffer.length; - // Write the size of the object - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - return serializeObject(object, checkKeys, buffer, index, serializeFunctions) - 1; -} - -/** - * @ignore - * @api private - */ -var serializeObject = function(object, checkKeys, buffer, index, serializeFunctions) { - // Process the object - if(Array.isArray(object)) { - for(var i = 0; i < object.length; i++) { - index = packElement(i.toString(), object[i], checkKeys, buffer, index, serializeFunctions); - } - } else { - for(var key in object) { - // Check the key and throw error if it's illegal - if(checkKeys == true && (key != '$db' && key != '$ref' && key != '$id')) { - BSON.checkKey(key); - } - - // Pack the element - index = packElement(key, object[key], checkKeys, buffer, index, serializeFunctions); - } - } - - // Write zero - buffer[index++] = 0; - return index; -} - -/** - * @ignore - * @api private - */ -var packElement = function(name, value, checkKeys, buffer, index, serializeFunctions) { - // console.log("packElement: " + name + " :: " + value) - var startIndex = index; - - switch(typeof value) { - case 'string': - // Encode String type - buffer[index++] = BSON.BSON_DATA_STRING; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - - // Calculate size - var size = Buffer.byteLength(value) + 1; - // Write the size of the string to buffer - buffer[index + 3] = (size >> 24) & 0xff; - buffer[index + 2] = (size >> 16) & 0xff; - buffer[index + 1] = (size >> 8) & 0xff; - buffer[index] = size & 0xff; - // Ajust the index - index = index + 4; - // Write the string - buffer.write(value, index, 'utf8'); - // Update index - index = index + size - 1; - // Write zero - buffer[index++] = 0; - // Return index - return index; - case 'number': - // We have an integer value - if(Math.floor(value) === value && value >= BSON.JS_INT_MIN && value <= BSON.JS_INT_MAX) { - // If the value fits in 32 bits encode as int, if it fits in a double - // encode it as a double, otherwise long - if(value >= BSON.BSON_INT32_MIN && value <= BSON.BSON_INT32_MAX) { - // Set int type 32 bits or less - buffer[index++] = BSON.BSON_DATA_INT; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Write the int value - buffer[index++] = value & 0xff; - buffer[index++] = (value >> 8) & 0xff; - buffer[index++] = (value >> 16) & 0xff; - buffer[index++] = (value >> 24) & 0xff; - } else if(value >= BSON.JS_INT_MIN && value <= BSON.JS_INT_MAX) { - // Encode as double - buffer[index++] = BSON.BSON_DATA_NUMBER; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Write float - ieee754.writeIEEE754(buffer, value, index, 'little', 52, 8); - // Ajust index - index = index + 8; - } else { - // Set long type - buffer[index++] = BSON.BSON_DATA_LONG; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - var longVal = Long.fromNumber(value); - var lowBits = longVal.getLowBits(); - var highBits = longVal.getHighBits(); - // Encode low bits - buffer[index++] = lowBits & 0xff; - buffer[index++] = (lowBits >> 8) & 0xff; - buffer[index++] = (lowBits >> 16) & 0xff; - buffer[index++] = (lowBits >> 24) & 0xff; - // Encode high bits - buffer[index++] = highBits & 0xff; - buffer[index++] = (highBits >> 8) & 0xff; - buffer[index++] = (highBits >> 16) & 0xff; - buffer[index++] = (highBits >> 24) & 0xff; - } - } else { - // Encode as double - buffer[index++] = BSON.BSON_DATA_NUMBER; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Write float - ieee754.writeIEEE754(buffer, value, index, 'little', 52, 8); - // Ajust index - index = index + 8; - } - - return index; - case 'undefined': - // Set long type - buffer[index++] = BSON.BSON_DATA_NULL; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - return index; - case 'boolean': - // Write the type - buffer[index++] = BSON.BSON_DATA_BOOLEAN; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Encode the boolean value - buffer[index++] = value ? 1 : 0; - return index; - case 'object': - if(value === null || value instanceof MinKey || value instanceof MaxKey - || value['_bsontype'] == 'MinKey' || value['_bsontype'] == 'MaxKey') { - // Write the type of either min or max key - if(value === null) { - buffer[index++] = BSON.BSON_DATA_NULL; - } else if(value instanceof MinKey) { - buffer[index++] = BSON.BSON_DATA_MIN_KEY; - } else { - buffer[index++] = BSON.BSON_DATA_MAX_KEY; - } - - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - return index; - } else if(value instanceof ObjectID || value['_bsontype'] == 'ObjectID') { - // Write the type - buffer[index++] = BSON.BSON_DATA_OID; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Write objectid - buffer.write(value.id, index, 'binary'); - // Ajust index - index = index + 12; - return index; - } else if(value instanceof Date) { - // Write the type - buffer[index++] = BSON.BSON_DATA_DATE; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - - // Write the date - var dateInMilis = Long.fromNumber(value.getTime()); - var lowBits = dateInMilis.getLowBits(); - var highBits = dateInMilis.getHighBits(); - // Encode low bits - buffer[index++] = lowBits & 0xff; - buffer[index++] = (lowBits >> 8) & 0xff; - buffer[index++] = (lowBits >> 16) & 0xff; - buffer[index++] = (lowBits >> 24) & 0xff; - // Encode high bits - buffer[index++] = highBits & 0xff; - buffer[index++] = (highBits >> 8) & 0xff; - buffer[index++] = (highBits >> 16) & 0xff; - buffer[index++] = (highBits >> 24) & 0xff; - return index; - } else if(Buffer.isBuffer(value)) { - // Write the type - buffer[index++] = BSON.BSON_DATA_BINARY; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Get size of the buffer (current write point) - var size = value.length; - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - // Write the default subtype - buffer[index++] = BSON.BSON_BINARY_SUBTYPE_DEFAULT; - // Copy the content form the binary field to the buffer - value.copy(buffer, index, 0, size); - // Adjust the index - index = index + size; - return index; - } else if(value instanceof Long || value instanceof Timestamp || value['_bsontype'] == 'Long' || value['_bsontype'] == 'Timestamp') { - // Write the type - buffer[index++] = value instanceof Long ? BSON.BSON_DATA_LONG : BSON.BSON_DATA_TIMESTAMP; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Write the date - var lowBits = value.getLowBits(); - var highBits = value.getHighBits(); - // Encode low bits - buffer[index++] = lowBits & 0xff; - buffer[index++] = (lowBits >> 8) & 0xff; - buffer[index++] = (lowBits >> 16) & 0xff; - buffer[index++] = (lowBits >> 24) & 0xff; - // Encode high bits - buffer[index++] = highBits & 0xff; - buffer[index++] = (highBits >> 8) & 0xff; - buffer[index++] = (highBits >> 16) & 0xff; - buffer[index++] = (highBits >> 24) & 0xff; - return index; - } else if(value instanceof Double || value['_bsontype'] == 'Double') { - // Encode as double - buffer[index++] = BSON.BSON_DATA_NUMBER; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Write float - ieee754.writeIEEE754(buffer, value, index, 'little', 52, 8); - // Ajust index - index = index + 8; - return index; - } else if(value instanceof Code || value['_bsontype'] == 'Code') { - if(value.scope != null && Object.keys(value.scope).length > 0) { - // Write the type - buffer[index++] = BSON.BSON_DATA_CODE_W_SCOPE; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Calculate the scope size - var scopeSize = BSON.calculateObjectSize(value.scope); - // Function string - var functionString = value.code.toString(); - // Function Size - var codeSize = Buffer.byteLength(functionString) + 1; - - // Calculate full size of the object - var totalSize = 4 + codeSize + scopeSize + 4; - - // Write the total size of the object - buffer[index++] = totalSize & 0xff; - buffer[index++] = (totalSize >> 8) & 0xff; - buffer[index++] = (totalSize >> 16) & 0xff; - buffer[index++] = (totalSize >> 24) & 0xff; - - // Write the size of the string to buffer - buffer[index++] = codeSize & 0xff; - buffer[index++] = (codeSize >> 8) & 0xff; - buffer[index++] = (codeSize >> 16) & 0xff; - buffer[index++] = (codeSize >> 24) & 0xff; - - // Write the string - buffer.write(functionString, index, 'utf8'); - // Update index - index = index + codeSize - 1; - // Write zero - buffer[index++] = 0; - // Serialize the scope object - var scopeObjectBuffer = new Buffer(scopeSize); - // Execute the serialization into a seperate buffer - serializeObject(value.scope, checkKeys, scopeObjectBuffer, 0, serializeFunctions); - - // Adjusted scope Size (removing the header) - var scopeDocSize = scopeSize; - // Write scope object size - buffer[index++] = scopeDocSize & 0xff; - buffer[index++] = (scopeDocSize >> 8) & 0xff; - buffer[index++] = (scopeDocSize >> 16) & 0xff; - buffer[index++] = (scopeDocSize >> 24) & 0xff; - - // Write the scopeObject into the buffer - scopeObjectBuffer.copy(buffer, index, 0, scopeSize); - - // Adjust index, removing the empty size of the doc (5 bytes 0000000005) - index = index + scopeDocSize - 5; - // Write trailing zero - buffer[index++] = 0; - return index - } else { - buffer[index++] = BSON.BSON_DATA_CODE; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Function string - var functionString = value.code.toString(); - // Function Size - var size = Buffer.byteLength(functionString) + 1; - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - // Write the string - buffer.write(functionString, index, 'utf8'); - // Update index - index = index + size - 1; - // Write zero - buffer[index++] = 0; - return index; - } - } else if(value instanceof Binary || value['_bsontype'] == 'Binary') { - // Write the type - buffer[index++] = BSON.BSON_DATA_BINARY; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Extract the buffer - var data = value.value(true); - // Calculate size - var size = value.position; - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - // Write the subtype to the buffer - buffer[index++] = value.sub_type; - // Write the data to the object - data.copy(buffer, index, 0, value.position); - // Ajust index - index = index + value.position; - return index; - } else if(value instanceof Symbol || value['_bsontype'] == 'Symbol') { - // Write the type - buffer[index++] = BSON.BSON_DATA_SYMBOL; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Calculate size - size = Buffer.byteLength(value.value) + 1; - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - // Write the string - buffer.write(value.value, index, 'utf8'); - // Update index - index = index + size - 1; - // Write zero - buffer[index++] = 0x00; - return index; - } else if(value instanceof DBRef || value['_bsontype'] == 'DBRef') { - // Write the type - buffer[index++] = BSON.BSON_DATA_OBJECT; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Set up correct object for serialization - var ordered_values = { - '$ref': value.namespace - , '$id' : value.oid - }; - - // Add db reference if it exists - if(null != value.db) { - ordered_values['$db'] = value.db; - } - - // Message size - var size = BSON.calculateObjectSize(ordered_values); - // Serialize the object - var endIndex = BSON.serializeWithBufferAndIndex(ordered_values, checkKeys, buffer, index, serializeFunctions); - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - // Write zero for object - buffer[endIndex++] = 0x00; - // Return the end index - return endIndex; - } else if(value instanceof RegExp || toString.call(value) === '[object RegExp]') { - // Write the type - buffer[index++] = BSON.BSON_DATA_REGEXP; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - - // Write the regular expression string - buffer.write(value.source, index, 'utf8'); - // Adjust the index - index = index + Buffer.byteLength(value.source); - // Write zero - buffer[index++] = 0x00; - // Write the parameters - if(value.global) buffer[index++] = 0x73; // s - if(value.ignoreCase) buffer[index++] = 0x69; // i - if(value.multiline) buffer[index++] = 0x6d; // m - // Add ending zero - buffer[index++] = 0x00; - return index; - } else { - // Write the type - buffer[index++] = Array.isArray(value) ? BSON.BSON_DATA_ARRAY : BSON.BSON_DATA_OBJECT; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Serialize the object - var endIndex = serializeObject(value, checkKeys, buffer, index + 4, serializeFunctions); - // Write size - var size = endIndex - index; - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - return endIndex; - } - case 'function': - // WTF for 0.4.X where typeof /someregexp/ === 'function' - if(value instanceof RegExp || toString.call(value) === '[object RegExp]') { - // Write the type - buffer[index++] = BSON.BSON_DATA_REGEXP; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - - // Write the regular expression string - buffer.write(value.source, index, 'utf8'); - // Adjust the index - index = index + Buffer.byteLength(value.source); - // Write zero - buffer[index++] = 0x00; - // Write the parameters - if(value.global) buffer[index++] = 0x73; // s - if(value.ignoreCase) buffer[index++] = 0x69; // i - if(value.multiline) buffer[index++] = 0x6d; // m - // Add ending zero - buffer[index++] = 0x00; - return index; - } else { - if(serializeFunctions && value.scope != null && Object.keys(value.scope).length > 0) { - // Write the type - buffer[index++] = BSON.BSON_DATA_CODE_W_SCOPE; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Calculate the scope size - var scopeSize = BSON.calculateObjectSize(value.scope); - // Function string - var functionString = value.toString(); - // Function Size - var codeSize = Buffer.byteLength(functionString) + 1; - - // Calculate full size of the object - var totalSize = 4 + codeSize + scopeSize; - - // Write the total size of the object - buffer[index++] = totalSize & 0xff; - buffer[index++] = (totalSize >> 8) & 0xff; - buffer[index++] = (totalSize >> 16) & 0xff; - buffer[index++] = (totalSize >> 24) & 0xff; - - // Write the size of the string to buffer - buffer[index++] = codeSize & 0xff; - buffer[index++] = (codeSize >> 8) & 0xff; - buffer[index++] = (codeSize >> 16) & 0xff; - buffer[index++] = (codeSize >> 24) & 0xff; - - // Write the string - buffer.write(functionString, index, 'utf8'); - // Update index - index = index + codeSize - 1; - // Write zero - buffer[index++] = 0; - // Serialize the scope object - var scopeObjectBuffer = new Buffer(scopeSize); - // Execute the serialization into a seperate buffer - serializeObject(value.scope, checkKeys, scopeObjectBuffer, 0, serializeFunctions); - - // Adjusted scope Size (removing the header) - var scopeDocSize = scopeSize - 4; - // Write scope object size - buffer[index++] = scopeDocSize & 0xff; - buffer[index++] = (scopeDocSize >> 8) & 0xff; - buffer[index++] = (scopeDocSize >> 16) & 0xff; - buffer[index++] = (scopeDocSize >> 24) & 0xff; - - // Write the scopeObject into the buffer - scopeObjectBuffer.copy(buffer, index, 0, scopeSize); - - // Adjust index, removing the empty size of the doc (5 bytes 0000000005) - index = index + scopeDocSize - 5; - // Write trailing zero - buffer[index++] = 0; - return index - } else if(serializeFunctions) { - buffer[index++] = BSON.BSON_DATA_CODE; - // Encode the name - index = index + buffer.write(name, index, 'utf8') + 1; - buffer[index - 1] = 0; - // Function string - var functionString = value.toString(); - // Function Size - var size = Buffer.byteLength(functionString) + 1; - // Write the size of the string to buffer - buffer[index++] = size & 0xff; - buffer[index++] = (size >> 8) & 0xff; - buffer[index++] = (size >> 16) & 0xff; - buffer[index++] = (size >> 24) & 0xff; - // Write the string - buffer.write(functionString, index, 'utf8'); - // Update index - index = index + size - 1; - // Write zero - buffer[index++] = 0; - return index; - } - } - } - - // If no value to serialize - return index; -} - -/** - * Serialize a Javascript object. - * - * @param {Object} object the Javascript object to serialize. - * @param {Boolean} checkKeys the serializer will check if keys are valid. - * @param {Boolean} asBuffer return the serialized object as a Buffer object **(ignore)**. - * @param {Boolean} serializeFunctions serialize the javascript functions **(default:false)**. - * @return {Buffer} returns the Buffer object containing the serialized object. - * @api public - */ -BSON.serialize = function(object, checkKeys, asBuffer, serializeFunctions) { - var buffer = new Buffer(BSON.calculateObjectSize(object, serializeFunctions)); - BSON.serializeWithBufferAndIndex(object, checkKeys, buffer, 0, serializeFunctions); - return buffer; -} - -/** - * Contains the function cache if we have that enable to allow for avoiding the eval step on each deserialization, comparison is by md5 - * - * @ignore - * @api private - */ -var functionCache = BSON.functionCache = {}; - -/** - * Crc state variables shared by function - * - * @ignore - * @api private - */ -var table = [0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D]; - -/** - * CRC32 hash method, Fast and enough versitility for our usage - * - * @ignore - * @api private - */ -var crc32 = function(string, start, end) { - var crc = 0 - var x = 0; - var y = 0; - crc = crc ^ (-1); - - for(var i = start, iTop = end; i < iTop;i++) { - y = (crc ^ string[i]) & 0xFF; - x = table[y]; - crc = (crc >>> 8) ^ x; - } - - return crc ^ (-1); -} - -/** - * Deserialize stream data as BSON documents. - * - * Options - * - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. - * - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. - * - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. - * - * @param {Buffer} data the buffer containing the serialized set of BSON documents. - * @param {Number} startIndex the start index in the data Buffer where the deserialization is to start. - * @param {Number} numberOfDocuments number of documents to deserialize. - * @param {Array} documents an array where to store the deserialized documents. - * @param {Number} docStartIndex the index in the documents array from where to start inserting documents. - * @param {Object} [options] additional options used for the deserialization. - * @return {Number} returns the next index in the buffer after deserialization **x** numbers of documents. - * @api public - */ -BSON.deserializeStream = function(data, startIndex, numberOfDocuments, documents, docStartIndex, options) { - // if(numberOfDocuments !== documents.length) throw new Error("Number of expected results back is less than the number of documents"); - options = options != null ? options : {}; - var index = startIndex; - // Loop over all documents - for(var i = 0; i < numberOfDocuments; i++) { - // Find size of the document - var size = data[index] | data[index + 1] << 8 | data[index + 2] << 16 | data[index + 3] << 24; - // Update options with index - options['index'] = index; - // Parse the document at this point - documents[docStartIndex + i] = BSON.deserialize(data, options); - // Adjust index by the document size - index = index + size; - } - - // Return object containing end index of parsing and list of documents - return index; -} - -/** - * Ensure eval is isolated. - * - * @ignore - * @api private - */ -var isolateEvalWithHash = function(functionCache, hash, functionString, object) { - // Contains the value we are going to set - var value = null; - - // Check for cache hit, eval if missing and return cached function - if(functionCache[hash] == null) { - eval("value = " + functionString); - functionCache[hash] = value; - } - // Set the object - return functionCache[hash].bind(object); -} - -/** - * Ensure eval is isolated. - * - * @ignore - * @api private - */ -var isolateEval = function(functionString) { - // Contains the value we are going to set - var value = null; - // Eval the function - eval("value = " + functionString); - return value; -} - -/** - * Deserialize data as BSON. - * - * Options - * - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. - * - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. - * - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. - * - * @param {Buffer} buffer the buffer containing the serialized set of BSON documents. - * @param {Object} [options] additional options used for the deserialization. - * @param {Boolean} [isArray] ignore used for recursive parsing. - * @return {Object} returns the deserialized Javascript Object. - * @api public - */ -BSON.deserialize = function(buffer, options, isArray) { - // Options - options = options == null ? {} : options; - var evalFunctions = options['evalFunctions'] == null ? false : options['evalFunctions']; - var cacheFunctions = options['cacheFunctions'] == null ? false : options['cacheFunctions']; - var cacheFunctionsCrc32 = options['cacheFunctionsCrc32'] == null ? false : options['cacheFunctionsCrc32']; - - // Validate that we have at least 4 bytes of buffer - if(buffer.length < 5) throw new Error("corrupt bson message < 5 bytes long"); - - // Set up index - var index = typeof options['index'] == 'number' ? options['index'] : 0; - // Reads in a C style string - var readCStyleString = function() { - // Get the start search index - var i = index; - // Locate the end of the c string - while(buffer[i] !== 0x00) { i++ } - // Grab utf8 encoded string - var string = buffer.toString('utf8', index, i); - // Update index position - index = i + 1; - // Return string - return string; - } - - // Create holding object - var object = isArray ? [] : {}; - - // Read the document size - var size = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - - // Ensure buffer is valid size - if(size < 0 || size > buffer.length) throw new Error("corrupt bson message"); - - // While we have more left data left keep parsing - while(true) { - // Read the type - var elementType = buffer[index++]; - // If we get a zero it's the last byte, exit - if(elementType == 0) break; - // Read the name of the field - var name = readCStyleString(); - // Switch on the type - switch(elementType) { - case BSON.BSON_DATA_OID: - // Decode the oid - object[name] = new ObjectID(buffer.toString('binary', index, index + 12)); - // Update index - index = index + 12; - break; - case BSON.BSON_DATA_STRING: - // Read the content of the field - var stringSize = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Add string to object - object[name] = buffer.toString('utf8', index, index + stringSize - 1); - // Update parse index position - index = index + stringSize; - break; - case BSON.BSON_DATA_INT: - // Decode the 32bit value - object[name] = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - break; - case BSON.BSON_DATA_NUMBER: - // Decode the double value - object[name] = ieee754.readIEEE754(buffer, index, 'little', 52, 8); - // Update the index - index = index + 8; - break; - case BSON.BSON_DATA_DATE: - // Unpack the low and high bits - var lowBits = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - var highBits = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Set date object - object[name] = new Date(new Long(lowBits, highBits).toNumber()); - break; - case BSON.BSON_DATA_BOOLEAN: - // Parse the boolean value - object[name] = buffer[index++] == 1; - break; - case BSON.BSON_DATA_NULL: - // Parse the boolean value - object[name] = null; - break; - case BSON.BSON_DATA_BINARY: - // Decode the size of the binary blob - var binarySize = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Decode the subtype - var subType = buffer[index++]; - // Decode as raw Buffer object if options specifies it - object[name] = new Binary(buffer.slice(index, index + binarySize), subType); - // Update the index - index = index + binarySize; - break; - case BSON.BSON_DATA_ARRAY: - options['index'] = index; - // Decode the size of the array document - var objectSize = buffer[index] | buffer[index + 1] << 8 | buffer[index + 2] << 16 | buffer[index + 3] << 24; - // Set the array to the object - object[name] = BSON.deserialize(buffer, options, true); - // Adjust the index - index = index + objectSize; - break; - case BSON.BSON_DATA_OBJECT: - options['index'] = index; - // Decode the size of the object document - var objectSize = buffer[index] | buffer[index + 1] << 8 | buffer[index + 2] << 16 | buffer[index + 3] << 24; - // Set the array to the object - object[name] = BSON.deserialize(buffer, options, false); - // Adjust the index - index = index + objectSize; - break; - case BSON.BSON_DATA_REGEXP: - // Create the regexp - var source = readCStyleString(); - var regExpOptions = readCStyleString(); - // For each option add the corresponding one for javascript - var optionsArray = new Array(regExpOptions.length); - - // Parse options - for(var i = 0; i < regExpOptions.length; i++) { - switch(regExpOptions[i]) { - case 'm': - optionsArray[i] = 'm'; - break; - case 's': - optionsArray[i] = 'g'; - break; - case 'i': - optionsArray[i] = 'i'; - break; - } - } - - object[name] = new RegExp(source, optionsArray.join('')); - break; - case BSON.BSON_DATA_LONG: - // Unpack the low and high bits - var lowBits = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - var highBits = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Create long object - var long = new Long(lowBits, highBits); - // Set the object - object[name] = long.lessThanOrEqual(JS_INT_MAX_LONG) && long.greaterThanOrEqual(JS_INT_MIN_LONG) ? long.toNumber() : long; - break; - case BSON.BSON_DATA_SYMBOL: - // Read the content of the field - var stringSize = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Add string to object - object[name] = new Symbol(buffer.toString('utf8', index, index + stringSize - 1)); - // Update parse index position - index = index + stringSize; - break; - case BSON.BSON_DATA_TIMESTAMP: - // Unpack the low and high bits - var lowBits = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - var highBits = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Set the object - object[name] = new Timestamp(lowBits, highBits); - break; - case BSON.BSON_DATA_MIN_KEY: - // Parse the object - object[name] = new MinKey(); - break; - case BSON.BSON_DATA_MAX_KEY: - // Parse the object - object[name] = new MaxKey(); - break; - case BSON.BSON_DATA_CODE: - // Read the content of the field - var stringSize = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Function string - var functionString = buffer.toString('utf8', index, index + stringSize - 1); - - // If we are evaluating the functions - if(evalFunctions) { - // Contains the value we are going to set - var value = null; - // If we have cache enabled let's look for the md5 of the function in the cache - if(cacheFunctions) { - var hash = cacheFunctionsCrc32 ? crc32(functionString) : functionString; - // Got to do this to avoid V8 deoptimizing the call due to finding eval - object[name] = isolateEvalWithHash(functionCache, hash, functionString, object); - } else { - // Set directly - object[name] = isolateEval(functionString); - } - } else { - object[name] = new Code(functionString, {}); - } - - // Update parse index position - index = index + stringSize; - break; - case BSON.BSON_DATA_CODE_W_SCOPE: - // Read the content of the field - var totalSize = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - var stringSize = buffer[index++] | buffer[index++] << 8 | buffer[index++] << 16 | buffer[index++] << 24; - // Javascript function - var functionString = buffer.toString('utf8', index, index + stringSize - 1); - // Update parse index position - index = index + stringSize; - // Parse the element - options['index'] = index; - // Decode the size of the object document - var objectSize = buffer[index] | buffer[index + 1] << 8 | buffer[index + 2] << 16 | buffer[index + 3] << 24; - // Decode the scope object - var scopeObject = BSON.deserialize(buffer, options, false); - // Adjust the index - index = index + objectSize; - - // If we are evaluating the functions - if(evalFunctions) { - // Contains the value we are going to set - var value = null; - // If we have cache enabled let's look for the md5 of the function in the cache - if(cacheFunctions) { - var hash = cacheFunctionsCrc32 ? crc32(functionString) : functionString; - // Got to do this to avoid V8 deoptimizing the call due to finding eval - object[name] = isolateEvalWithHash(functionCache, hash, functionString, object); - } else { - // Set directly - object[name] = isolateEval(functionString); - } - - // Set the scope on the object - object[name].scope = scopeObject; - } else { - object[name] = new Code(functionString, scopeObject); - } - - // Add string to object - break; - } - } - - // Check if we have a db ref object - if(object['$id'] != null) object = new DBRef(object['$ref'], object['$id'], object['$db']); - - // Return the final objects - return object; -} - -/** - * Check if key name is valid. - * - * @ignore - * @api private - */ -BSON.checkKey = function checkKey (key) { - if (!key.length) return; - // Check if we have a legal key for the object - if('$' == key[0]) { - throw Error("key " + key + " must not start with '$'"); - } else if (!!~key.indexOf('.')) { - throw Error("key " + key + " must not contain '.'"); - } -}; - -/** - * Deserialize data as BSON. - * - * Options - * - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. - * - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. - * - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. - * - * @param {Buffer} buffer the buffer containing the serialized set of BSON documents. - * @param {Object} [options] additional options used for the deserialization. - * @param {Boolean} [isArray] ignore used for recursive parsing. - * @return {Object} returns the deserialized Javascript Object. - * @api public - */ -BSON.prototype.deserialize = function(data, options) { - return BSON.deserialize(data, options); -} - -/** - * Deserialize stream data as BSON documents. - * - * Options - * - **evalFunctions** {Boolean, default:false}, evaluate functions in the BSON document scoped to the object deserialized. - * - **cacheFunctions** {Boolean, default:false}, cache evaluated functions for reuse. - * - **cacheFunctionsCrc32** {Boolean, default:false}, use a crc32 code for caching, otherwise use the string of the function. - * - * @param {Buffer} data the buffer containing the serialized set of BSON documents. - * @param {Number} startIndex the start index in the data Buffer where the deserialization is to start. - * @param {Number} numberOfDocuments number of documents to deserialize. - * @param {Array} documents an array where to store the deserialized documents. - * @param {Number} docStartIndex the index in the documents array from where to start inserting documents. - * @param {Object} [options] additional options used for the deserialization. - * @return {Number} returns the next index in the buffer after deserialization **x** numbers of documents. - * @api public - */ -BSON.prototype.deserializeStream = function(data, startIndex, numberOfDocuments, documents, docStartIndex, options) { - return BSON.deserializeStream(data, startIndex, numberOfDocuments, documents, docStartIndex, options); -} - -/** - * Serialize a Javascript object. - * - * @param {Object} object the Javascript object to serialize. - * @param {Boolean} checkKeys the serializer will check if keys are valid. - * @param {Boolean} asBuffer return the serialized object as a Buffer object **(ignore)**. - * @param {Boolean} serializeFunctions serialize the javascript functions **(default:false)**. - * @return {Buffer} returns the Buffer object containing the serialized object. - * @api public - */ -BSON.prototype.serialize = function(object, checkKeys, asBuffer, serializeFunctions) { - return BSON.serialize(object, checkKeys, asBuffer, serializeFunctions); -} - -/** - * Calculate the bson size for a passed in Javascript object. - * - * @param {Object} object the Javascript object to calculate the BSON byte size for. - * @param {Boolean} [serializeFunctions] serialize all functions in the object **(default:false)**. - * @return {Number} returns the number of bytes the BSON object will take up. - * @api public - */ -BSON.prototype.calculateObjectSize = function(object, serializeFunctions) { - return BSON.calculateObjectSize(object, serializeFunctions); -} - -/** - * Serialize a Javascript object using a predefined Buffer and index into the buffer, useful when pre-allocating the space for serialization. - * - * @param {Object} object the Javascript object to serialize. - * @param {Boolean} checkKeys the serializer will check if keys are valid. - * @param {Buffer} buffer the Buffer you pre-allocated to store the serialized BSON object. - * @param {Number} index the index in the buffer where we wish to start serializing into. - * @param {Boolean} serializeFunctions serialize the javascript functions **(default:false)**. - * @return {Number} returns the new write index in the Buffer. - * @api public - */ -BSON.prototype.serializeWithBufferAndIndex = function(object, checkKeys, buffer, startIndex, serializeFunctions) { - return BSON.serializeWithBufferAndIndex(object, checkKeys, buffer, startIndex, serializeFunctions); -} - -/** - * @ignore - * @api private - */ -exports.Code = Code; -exports.Symbol = Symbol; -exports.BSON = BSON; -exports.DBRef = DBRef; -exports.Binary = Binary; -exports.ObjectID = ObjectID; -exports.Long = Long; -exports.Timestamp = Timestamp; -exports.Double = Double; -exports.MinKey = MinKey; -exports.MaxKey = MaxKey; diff --git a/lib/mongodb/bson/code.js b/lib/mongodb/bson/code.js deleted file mode 100644 index b2675385506..00000000000 --- a/lib/mongodb/bson/code.js +++ /dev/null @@ -1,23 +0,0 @@ -/** - * A class representation of the BSON Code type. - * - * @class Represents the BSON Code type. - * @param {String|Function} code a string or function. - * @param {Object} [scope] an optional scope for the function. - * @return {Code} - */ -function Code(code, scope) { - this._bsontype = 'Code'; - this.code = code; - this.scope = scope == null ? {} : scope; -}; - -/** - * @ignore - * @api private - */ -Code.prototype.toJSON = function() { - return {scope:this.scope, code:this.code}; -} - -exports.Code = Code; \ No newline at end of file diff --git a/lib/mongodb/bson/db_ref.js b/lib/mongodb/bson/db_ref.js deleted file mode 100644 index d44abb02423..00000000000 --- a/lib/mongodb/bson/db_ref.js +++ /dev/null @@ -1,29 +0,0 @@ -/** - * A class representation of the BSON DBRef type. - * - * @class Represents the BSON DBRef type. - * @param {String} namespace the collection name. - * @param {ObjectID} oid the reference ObjectID. - * @param {String} [db] optional db name, if omitted the reference is local to the current db. - * @return {DBRef} - */ -function DBRef(namespace, oid, db) { - this._bsontype = 'DBRef'; - this.namespace = namespace; - this.oid = oid; - this.db = db; -}; - -/** - * @ignore - * @api private - */ -DBRef.prototype.toJSON = function() { - return { - '$ref':this.namespace, - '$id':this.oid, - '$db':this.db == null ? '' : this.db - }; -} - -exports.DBRef = DBRef; \ No newline at end of file diff --git a/lib/mongodb/bson/double.js b/lib/mongodb/bson/double.js deleted file mode 100644 index d77bc718670..00000000000 --- a/lib/mongodb/bson/double.js +++ /dev/null @@ -1,31 +0,0 @@ -/** - * A class representation of the BSON Double type. - * - * @class Represents the BSON Double type. - * @param {Number} value the number we want to represent as a double. - * @return {Double} - */ -function Double(value) { - this._bsontype = 'Double'; - this.value = value; -} - -/** - * Access the number value. - * - * @return {Number} returns the wrapped double number. - * @api public - */ -Double.prototype.valueOf = function() { - return this.value; -}; - -/** - * @ignore - * @api private - */ -Double.prototype.toJSON = function() { - return this.value; -} - -exports.Double = Double; \ No newline at end of file diff --git a/lib/mongodb/bson/float_parser.js b/lib/mongodb/bson/float_parser.js deleted file mode 100644 index 5d2af613b94..00000000000 --- a/lib/mongodb/bson/float_parser.js +++ /dev/null @@ -1,118 +0,0 @@ -// Copyright (c) 2008, Fair Oaks Labs, Inc. -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// * Redistributions of source code must retain the above copyright notice, -// this list of conditions and the following disclaimer. -// -// * Redistributions in binary form must reproduce the above copyright notice, -// this list of conditions and the following disclaimer in the documentation -// and/or other materials provided with the distribution. -// -// * Neither the name of Fair Oaks Labs, Inc. nor the names of its contributors -// may be used to endorse or promote products derived from this software -// without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -// POSSIBILITY OF SUCH DAMAGE. -// -// -// Modifications to writeIEEE754 to support negative zeroes made by Brian White - -exports.readIEEE754 = function(buffer, offset, endian, mLen, nBytes) { - var e, m, - bBE = (endian === 'big'), - eLen = nBytes * 8 - mLen - 1, - eMax = (1 << eLen) - 1, - eBias = eMax >> 1, - nBits = -7, - i = bBE ? 0 : (nBytes - 1), - d = bBE ? 1 : -1, - s = buffer[offset + i]; - - i += d; - - e = s & ((1 << (-nBits)) - 1); - s >>= (-nBits); - nBits += eLen; - for (; nBits > 0; e = e * 256 + buffer[offset + i], i += d, nBits -= 8); - - m = e & ((1 << (-nBits)) - 1); - e >>= (-nBits); - nBits += mLen; - for (; nBits > 0; m = m * 256 + buffer[offset + i], i += d, nBits -= 8); - - if (e === 0) { - e = 1 - eBias; - } else if (e === eMax) { - return m ? NaN : ((s ? -1 : 1) * Infinity); - } else { - m = m + Math.pow(2, mLen); - e = e - eBias; - } - return (s ? -1 : 1) * m * Math.pow(2, e - mLen); -}; - -exports.writeIEEE754 = function(buffer, value, offset, endian, mLen, nBytes) { - var e, m, c, - bBE = (endian === 'big'), - eLen = nBytes * 8 - mLen - 1, - eMax = (1 << eLen) - 1, - eBias = eMax >> 1, - rt = (mLen === 23 ? Math.pow(2, -24) - Math.pow(2, -77) : 0), - i = bBE ? (nBytes-1) : 0, - d = bBE ? -1 : 1, - s = value < 0 || (value === 0 && 1 / value < 0) ? 1 : 0; - - value = Math.abs(value); - - if (isNaN(value) || value === Infinity) { - m = isNaN(value) ? 1 : 0; - e = eMax; - } else { - e = Math.floor(Math.log(value) / Math.LN2); - if (value * (c = Math.pow(2, -e)) < 1) { - e--; - c *= 2; - } - if (e+eBias >= 1) { - value += rt / c; - } else { - value += rt * Math.pow(2, 1 - eBias); - } - if (value * c >= 2) { - e++; - c /= 2; - } - - if (e + eBias >= eMax) { - m = 0; - e = eMax; - } else if (e + eBias >= 1) { - m = (value * c - 1) * Math.pow(2, mLen); - e = e + eBias; - } else { - m = value * Math.pow(2, eBias - 1) * Math.pow(2, mLen); - e = 0; - } - } - - for (; mLen >= 8; buffer[offset + i] = m & 0xff, i += d, m /= 256, mLen -= 8); - - e = (e << mLen) | m; - eLen += mLen; - for (; eLen > 0; buffer[offset + i] = e & 0xff, i += d, e /= 256, eLen -= 8); - - buffer[offset + i - d] |= s * 128; -}; diff --git a/lib/mongodb/bson/long.js b/lib/mongodb/bson/long.js deleted file mode 100644 index a3c7e0763ab..00000000000 --- a/lib/mongodb/bson/long.js +++ /dev/null @@ -1,852 +0,0 @@ -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -// Copyright 2009 Google Inc. All Rights Reserved - -/** - * Defines a Long class for representing a 64-bit two's-complement - * integer value, which faithfully simulates the behavior of a Java "Long". This - * implementation is derived from LongLib in GWT. - * - * Constructs a 64-bit two's-complement integer, given its low and high 32-bit - * values as *signed* integers. See the from* functions below for more - * convenient ways of constructing Longs. - * - * The internal representation of a Long is the two given signed, 32-bit values. - * We use 32-bit pieces because these are the size of integers on which - * Javascript performs bit-operations. For operations like addition and - * multiplication, we split each number into 16-bit pieces, which can easily be - * multiplied within Javascript's floating-point representation without overflow - * or change in sign. - * - * In the algorithms below, we frequently reduce the negative case to the - * positive case by negating the input(s) and then post-processing the result. - * Note that we must ALWAYS check specially whether those values are MIN_VALUE - * (-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as - * a positive number, it overflows back into a negative). Not handling this - * case would often result in infinite recursion. - * - * @class Represents the BSON Long type. - * @param {Number} low the low (signed) 32 bits of the Long. - * @param {Number} high the high (signed) 32 bits of the Long. - */ -function Long(low, high) { - this._bsontype = 'Long'; - /** - * @type {number} - * @api private - */ - this.low_ = low | 0; // force into 32 signed bits. - - /** - * @type {number} - * @api private - */ - this.high_ = high | 0; // force into 32 signed bits. -}; - -/** - * Return the int value. - * - * @return {Number} the value, assuming it is a 32-bit integer. - * @api public - */ -Long.prototype.toInt = function() { - return this.low_; -}; - -/** - * Return the Number value. - * - * @return {Number} the closest floating-point representation to this value. - * @api public - */ -Long.prototype.toNumber = function() { - return this.high_ * Long.TWO_PWR_32_DBL_ + - this.getLowBitsUnsigned(); -}; - -/** - * Return the JSON value. - * - * @return {String} the JSON representation. - * @api public - */ -Long.prototype.toJSON = function() { - return this.toString(); -} - -/** - * Return the String value. - * - * @param {Number} [opt_radix] the radix in which the text should be written. - * @return {String} the textual representation of this value. - * @api public - */ -Long.prototype.toString = function(opt_radix) { - var radix = opt_radix || 10; - if (radix < 2 || 36 < radix) { - throw Error('radix out of range: ' + radix); - } - - if (this.isZero()) { - return '0'; - } - - if (this.isNegative()) { - if (this.equals(Long.MIN_VALUE)) { - // We need to change the Long value before it can be negated, so we remove - // the bottom-most digit in this base and then recurse to do the rest. - var radixLong = Long.fromNumber(radix); - var div = this.div(radixLong); - var rem = div.multiply(radixLong).subtract(this); - return div.toString(radix) + rem.toInt().toString(radix); - } else { - return '-' + this.negate().toString(radix); - } - } - - // Do several (6) digits each time through the loop, so as to - // minimize the calls to the very expensive emulated div. - var radixToPower = Long.fromNumber(Math.pow(radix, 6)); - - var rem = this; - var result = ''; - while (true) { - var remDiv = rem.div(radixToPower); - var intval = rem.subtract(remDiv.multiply(radixToPower)).toInt(); - var digits = intval.toString(radix); - - rem = remDiv; - if (rem.isZero()) { - return digits + result; - } else { - while (digits.length < 6) { - digits = '0' + digits; - } - result = '' + digits + result; - } - } -}; - -/** - * Return the high 32-bits value. - * - * @return {Number} the high 32-bits as a signed value. - * @api public - */ -Long.prototype.getHighBits = function() { - return this.high_; -}; - -/** - * Return the low 32-bits value. - * - * @return {Number} the low 32-bits as a signed value. - * @api public - */ -Long.prototype.getLowBits = function() { - return this.low_; -}; - -/** - * Return the low unsigned 32-bits value. - * - * @return {Number} the low 32-bits as an unsigned value. - * @api public - */ -Long.prototype.getLowBitsUnsigned = function() { - return (this.low_ >= 0) ? - this.low_ : Long.TWO_PWR_32_DBL_ + this.low_; -}; - -/** - * Returns the number of bits needed to represent the absolute value of this Long. - * - * @return {Number} Returns the number of bits needed to represent the absolute value of this Long. - * @api public - */ -Long.prototype.getNumBitsAbs = function() { - if (this.isNegative()) { - if (this.equals(Long.MIN_VALUE)) { - return 64; - } else { - return this.negate().getNumBitsAbs(); - } - } else { - var val = this.high_ != 0 ? this.high_ : this.low_; - for (var bit = 31; bit > 0; bit--) { - if ((val & (1 << bit)) != 0) { - break; - } - } - return this.high_ != 0 ? bit + 33 : bit + 1; - } -}; - -/** - * Return whether this value is zero. - * - * @return {Boolean} whether this value is zero. - * @api public - */ -Long.prototype.isZero = function() { - return this.high_ == 0 && this.low_ == 0; -}; - -/** - * Return whether this value is negative. - * - * @return {Boolean} whether this value is negative. - * @api public - */ -Long.prototype.isNegative = function() { - return this.high_ < 0; -}; - -/** - * Return whether this value is odd. - * - * @return {Boolean} whether this value is odd. - * @api public - */ -Long.prototype.isOdd = function() { - return (this.low_ & 1) == 1; -}; - -/** - * Return whether this Long equals the other - * - * @param {Long} other Long to compare against. - * @return {Boolean} whether this Long equals the other - * @api public - */ -Long.prototype.equals = function(other) { - return (this.high_ == other.high_) && (this.low_ == other.low_); -}; - -/** - * Return whether this Long does not equal the other. - * - * @param {Long} other Long to compare against. - * @return {Boolean} whether this Long does not equal the other. - * @api public - */ -Long.prototype.notEquals = function(other) { - return (this.high_ != other.high_) || (this.low_ != other.low_); -}; - -/** - * Return whether this Long is less than the other. - * - * @param {Long} other Long to compare against. - * @return {Boolean} whether this Long is less than the other. - * @api public - */ -Long.prototype.lessThan = function(other) { - return this.compare(other) < 0; -}; - -/** - * Return whether this Long is less than or equal to the other. - * - * @param {Long} other Long to compare against. - * @return {Boolean} whether this Long is less than or equal to the other. - * @api public - */ -Long.prototype.lessThanOrEqual = function(other) { - return this.compare(other) <= 0; -}; - -/** - * Return whether this Long is greater than the other. - * - * @param {Long} other Long to compare against. - * @return {Boolean} whether this Long is greater than the other. - * @api public - */ -Long.prototype.greaterThan = function(other) { - return this.compare(other) > 0; -}; - -/** - * Return whether this Long is greater than or equal to the other. - * - * @param {Long} other Long to compare against. - * @return {Boolean} whether this Long is greater than or equal to the other. - * @api public - */ -Long.prototype.greaterThanOrEqual = function(other) { - return this.compare(other) >= 0; -}; - -/** - * Compares this Long with the given one. - * - * @param {Long} other Long to compare against. - * @return {Boolean} 0 if they are the same, 1 if the this is greater, and -1 if the given one is greater. - * @api public - */ -Long.prototype.compare = function(other) { - if (this.equals(other)) { - return 0; - } - - var thisNeg = this.isNegative(); - var otherNeg = other.isNegative(); - if (thisNeg && !otherNeg) { - return -1; - } - if (!thisNeg && otherNeg) { - return 1; - } - - // at this point, the signs are the same, so subtraction will not overflow - if (this.subtract(other).isNegative()) { - return -1; - } else { - return 1; - } -}; - -/** - * The negation of this value. - * - * @return {Long} the negation of this value. - * @api public - */ -Long.prototype.negate = function() { - if (this.equals(Long.MIN_VALUE)) { - return Long.MIN_VALUE; - } else { - return this.not().add(Long.ONE); - } -}; - -/** - * Returns the sum of this and the given Long. - * - * @param {Long} other Long to add to this one. - * @return {Long} the sum of this and the given Long. - * @api public - */ -Long.prototype.add = function(other) { - // Divide each number into 4 chunks of 16 bits, and then sum the chunks. - - var a48 = this.high_ >>> 16; - var a32 = this.high_ & 0xFFFF; - var a16 = this.low_ >>> 16; - var a00 = this.low_ & 0xFFFF; - - var b48 = other.high_ >>> 16; - var b32 = other.high_ & 0xFFFF; - var b16 = other.low_ >>> 16; - var b00 = other.low_ & 0xFFFF; - - var c48 = 0, c32 = 0, c16 = 0, c00 = 0; - c00 += a00 + b00; - c16 += c00 >>> 16; - c00 &= 0xFFFF; - c16 += a16 + b16; - c32 += c16 >>> 16; - c16 &= 0xFFFF; - c32 += a32 + b32; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c48 += a48 + b48; - c48 &= 0xFFFF; - return Long.fromBits((c16 << 16) | c00, (c48 << 16) | c32); -}; - -/** - * Returns the difference of this and the given Long. - * - * @param {Long} other Long to subtract from this. - * @return {Long} the difference of this and the given Long. - * @api public - */ -Long.prototype.subtract = function(other) { - return this.add(other.negate()); -}; - -/** - * Returns the product of this and the given Long. - * - * @param {Long} other Long to multiply with this. - * @return {Long} the product of this and the other. - * @api public - */ -Long.prototype.multiply = function(other) { - if (this.isZero()) { - return Long.ZERO; - } else if (other.isZero()) { - return Long.ZERO; - } - - if (this.equals(Long.MIN_VALUE)) { - return other.isOdd() ? Long.MIN_VALUE : Long.ZERO; - } else if (other.equals(Long.MIN_VALUE)) { - return this.isOdd() ? Long.MIN_VALUE : Long.ZERO; - } - - if (this.isNegative()) { - if (other.isNegative()) { - return this.negate().multiply(other.negate()); - } else { - return this.negate().multiply(other).negate(); - } - } else if (other.isNegative()) { - return this.multiply(other.negate()).negate(); - } - - // If both Longs are small, use float multiplication - if (this.lessThan(Long.TWO_PWR_24_) && - other.lessThan(Long.TWO_PWR_24_)) { - return Long.fromNumber(this.toNumber() * other.toNumber()); - } - - // Divide each Long into 4 chunks of 16 bits, and then add up 4x4 products. - // We can skip products that would overflow. - - var a48 = this.high_ >>> 16; - var a32 = this.high_ & 0xFFFF; - var a16 = this.low_ >>> 16; - var a00 = this.low_ & 0xFFFF; - - var b48 = other.high_ >>> 16; - var b32 = other.high_ & 0xFFFF; - var b16 = other.low_ >>> 16; - var b00 = other.low_ & 0xFFFF; - - var c48 = 0, c32 = 0, c16 = 0, c00 = 0; - c00 += a00 * b00; - c16 += c00 >>> 16; - c00 &= 0xFFFF; - c16 += a16 * b00; - c32 += c16 >>> 16; - c16 &= 0xFFFF; - c16 += a00 * b16; - c32 += c16 >>> 16; - c16 &= 0xFFFF; - c32 += a32 * b00; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c32 += a16 * b16; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c32 += a00 * b32; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c48 += a48 * b00 + a32 * b16 + a16 * b32 + a00 * b48; - c48 &= 0xFFFF; - return Long.fromBits((c16 << 16) | c00, (c48 << 16) | c32); -}; - -/** - * Returns this Long divided by the given one. - * - * @param {Long} other Long by which to divide. - * @return {Long} this Long divided by the given one. - * @api public - */ -Long.prototype.div = function(other) { - if (other.isZero()) { - throw Error('division by zero'); - } else if (this.isZero()) { - return Long.ZERO; - } - - if (this.equals(Long.MIN_VALUE)) { - if (other.equals(Long.ONE) || - other.equals(Long.NEG_ONE)) { - return Long.MIN_VALUE; // recall that -MIN_VALUE == MIN_VALUE - } else if (other.equals(Long.MIN_VALUE)) { - return Long.ONE; - } else { - // At this point, we have |other| >= 2, so |this/other| < |MIN_VALUE|. - var halfThis = this.shiftRight(1); - var approx = halfThis.div(other).shiftLeft(1); - if (approx.equals(Long.ZERO)) { - return other.isNegative() ? Long.ONE : Long.NEG_ONE; - } else { - var rem = this.subtract(other.multiply(approx)); - var result = approx.add(rem.div(other)); - return result; - } - } - } else if (other.equals(Long.MIN_VALUE)) { - return Long.ZERO; - } - - if (this.isNegative()) { - if (other.isNegative()) { - return this.negate().div(other.negate()); - } else { - return this.negate().div(other).negate(); - } - } else if (other.isNegative()) { - return this.div(other.negate()).negate(); - } - - // Repeat the following until the remainder is less than other: find a - // floating-point that approximates remainder / other *from below*, add this - // into the result, and subtract it from the remainder. It is critical that - // the approximate value is less than or equal to the real value so that the - // remainder never becomes negative. - var res = Long.ZERO; - var rem = this; - while (rem.greaterThanOrEqual(other)) { - // Approximate the result of division. This may be a little greater or - // smaller than the actual value. - var approx = Math.max(1, Math.floor(rem.toNumber() / other.toNumber())); - - // We will tweak the approximate result by changing it in the 48-th digit or - // the smallest non-fractional digit, whichever is larger. - var log2 = Math.ceil(Math.log(approx) / Math.LN2); - var delta = (log2 <= 48) ? 1 : Math.pow(2, log2 - 48); - - // Decrease the approximation until it is smaller than the remainder. Note - // that if it is too large, the product overflows and is negative. - var approxRes = Long.fromNumber(approx); - var approxRem = approxRes.multiply(other); - while (approxRem.isNegative() || approxRem.greaterThan(rem)) { - approx -= delta; - approxRes = Long.fromNumber(approx); - approxRem = approxRes.multiply(other); - } - - // We know the answer can't be zero... and actually, zero would cause - // infinite recursion since we would make no progress. - if (approxRes.isZero()) { - approxRes = Long.ONE; - } - - res = res.add(approxRes); - rem = rem.subtract(approxRem); - } - return res; -}; - -/** - * Returns this Long modulo the given one. - * - * @param {Long} other Long by which to mod. - * @return {Long} this Long modulo the given one. - * @api public - */ -Long.prototype.modulo = function(other) { - return this.subtract(this.div(other).multiply(other)); -}; - -/** - * The bitwise-NOT of this value. - * - * @return {Long} the bitwise-NOT of this value. - * @api public - */ -Long.prototype.not = function() { - return Long.fromBits(~this.low_, ~this.high_); -}; - -/** - * Returns the bitwise-AND of this Long and the given one. - * - * @param {Long} other the Long with which to AND. - * @return {Long} the bitwise-AND of this and the other. - * @api public - */ -Long.prototype.and = function(other) { - return Long.fromBits(this.low_ & other.low_, this.high_ & other.high_); -}; - -/** - * Returns the bitwise-OR of this Long and the given one. - * - * @param {Long} other the Long with which to OR. - * @return {Long} the bitwise-OR of this and the other. - * @api public - */ -Long.prototype.or = function(other) { - return Long.fromBits(this.low_ | other.low_, this.high_ | other.high_); -}; - -/** - * Returns the bitwise-XOR of this Long and the given one. - * - * @param {Long} other the Long with which to XOR. - * @return {Long} the bitwise-XOR of this and the other. - * @api public - */ -Long.prototype.xor = function(other) { - return Long.fromBits(this.low_ ^ other.low_, this.high_ ^ other.high_); -}; - -/** - * Returns this Long with bits shifted to the left by the given amount. - * - * @param {Number} numBits the number of bits by which to shift. - * @return {Long} this shifted to the left by the given amount. - * @api public - */ -Long.prototype.shiftLeft = function(numBits) { - numBits &= 63; - if (numBits == 0) { - return this; - } else { - var low = this.low_; - if (numBits < 32) { - var high = this.high_; - return Long.fromBits( - low << numBits, - (high << numBits) | (low >>> (32 - numBits))); - } else { - return Long.fromBits(0, low << (numBits - 32)); - } - } -}; - -/** - * Returns this Long with bits shifted to the right by the given amount. - * - * @param {Number} numBits the number of bits by which to shift. - * @return {Long} this shifted to the right by the given amount. - * @api public - */ -Long.prototype.shiftRight = function(numBits) { - numBits &= 63; - if (numBits == 0) { - return this; - } else { - var high = this.high_; - if (numBits < 32) { - var low = this.low_; - return Long.fromBits( - (low >>> numBits) | (high << (32 - numBits)), - high >> numBits); - } else { - return Long.fromBits( - high >> (numBits - 32), - high >= 0 ? 0 : -1); - } - } -}; - -/** - * Returns this Long with bits shifted to the right by the given amount, with the new top bits matching the current sign bit. - * - * @param {Number} numBits the number of bits by which to shift. - * @return {Long} this shifted to the right by the given amount, with zeros placed into the new leading bits. - * @api public - */ -Long.prototype.shiftRightUnsigned = function(numBits) { - numBits &= 63; - if (numBits == 0) { - return this; - } else { - var high = this.high_; - if (numBits < 32) { - var low = this.low_; - return Long.fromBits( - (low >>> numBits) | (high << (32 - numBits)), - high >>> numBits); - } else if (numBits == 32) { - return Long.fromBits(high, 0); - } else { - return Long.fromBits(high >>> (numBits - 32), 0); - } - } -}; - -/** - * Returns a Long representing the given (32-bit) integer value. - * - * @param {Number} value the 32-bit integer in question. - * @return {Long} the corresponding Long value. - * @api public - */ -Long.fromInt = function(value) { - if (-128 <= value && value < 128) { - var cachedObj = Long.INT_CACHE_[value]; - if (cachedObj) { - return cachedObj; - } - } - - var obj = new Long(value | 0, value < 0 ? -1 : 0); - if (-128 <= value && value < 128) { - Long.INT_CACHE_[value] = obj; - } - return obj; -}; - -/** - * Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned. - * - * @param {Number} value the number in question. - * @return {Long} the corresponding Long value. - * @api public - */ -Long.fromNumber = function(value) { - if (isNaN(value) || !isFinite(value)) { - return Long.ZERO; - } else if (value <= -Long.TWO_PWR_63_DBL_) { - return Long.MIN_VALUE; - } else if (value + 1 >= Long.TWO_PWR_63_DBL_) { - return Long.MAX_VALUE; - } else if (value < 0) { - return Long.fromNumber(-value).negate(); - } else { - return new Long( - (value % Long.TWO_PWR_32_DBL_) | 0, - (value / Long.TWO_PWR_32_DBL_) | 0); - } -}; - -/** - * Returns a Long representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits. - * - * @param {Number} lowBits the low 32-bits. - * @param {Number} highBits the high 32-bits. - * @return {Long} the corresponding Long value. - * @api public - */ -Long.fromBits = function(lowBits, highBits) { - return new Long(lowBits, highBits); -}; - -/** - * Returns a Long representation of the given string, written using the given radix. - * - * @param {String} str the textual representation of the Long. - * @param {Number} opt_radix the radix in which the text is written. - * @return {Long} the corresponding Long value. - * @api public - */ -Long.fromString = function(str, opt_radix) { - if (str.length == 0) { - throw Error('number format error: empty string'); - } - - var radix = opt_radix || 10; - if (radix < 2 || 36 < radix) { - throw Error('radix out of range: ' + radix); - } - - if (str.charAt(0) == '-') { - return Long.fromString(str.substring(1), radix).negate(); - } else if (str.indexOf('-') >= 0) { - throw Error('number format error: interior "-" character: ' + str); - } - - // Do several (8) digits each time through the loop, so as to - // minimize the calls to the very expensive emulated div. - var radixToPower = Long.fromNumber(Math.pow(radix, 8)); - - var result = Long.ZERO; - for (var i = 0; i < str.length; i += 8) { - var size = Math.min(8, str.length - i); - var value = parseInt(str.substring(i, i + size), radix); - if (size < 8) { - var power = Long.fromNumber(Math.pow(radix, size)); - result = result.multiply(power).add(Long.fromNumber(value)); - } else { - result = result.multiply(radixToPower); - result = result.add(Long.fromNumber(value)); - } - } - return result; -}; - -// NOTE: Common constant values ZERO, ONE, NEG_ONE, etc. are defined below the -// from* methods on which they depend. - - -/** - * A cache of the Long representations of small integer values. - * @type {Object} - * @api private - */ -Long.INT_CACHE_ = {}; - -// NOTE: the compiler should inline these constant values below and then remove -// these variables, so there should be no runtime penalty for these. - -/** - * Number used repeated below in calculations. This must appear before the - * first call to any from* function below. - * @type {number} - * @api private - */ -Long.TWO_PWR_16_DBL_ = 1 << 16; - -/** - * @type {number} - * @api private - */ -Long.TWO_PWR_24_DBL_ = 1 << 24; - -/** - * @type {number} - * @api private - */ -Long.TWO_PWR_32_DBL_ = Long.TWO_PWR_16_DBL_ * Long.TWO_PWR_16_DBL_; - -/** - * @type {number} - * @api private - */ -Long.TWO_PWR_31_DBL_ = Long.TWO_PWR_32_DBL_ / 2; - -/** - * @type {number} - * @api private - */ -Long.TWO_PWR_48_DBL_ = Long.TWO_PWR_32_DBL_ * Long.TWO_PWR_16_DBL_; - -/** - * @type {number} - * @api private - */ -Long.TWO_PWR_64_DBL_ = Long.TWO_PWR_32_DBL_ * Long.TWO_PWR_32_DBL_; - -/** - * @type {number} - * @api private - */ -Long.TWO_PWR_63_DBL_ = Long.TWO_PWR_64_DBL_ / 2; - -/** @type {Long} */ -Long.ZERO = Long.fromInt(0); - -/** @type {Long} */ -Long.ONE = Long.fromInt(1); - -/** @type {Long} */ -Long.NEG_ONE = Long.fromInt(-1); - -/** @type {Long} */ -Long.MAX_VALUE = - Long.fromBits(0xFFFFFFFF | 0, 0x7FFFFFFF | 0); - -/** @type {Long} */ -Long.MIN_VALUE = Long.fromBits(0, 0x80000000 | 0); - -/** - * @type {Long} - * @api private - */ -Long.TWO_PWR_24_ = Long.fromInt(1 << 24); - -/** - * Expose. - */ -exports.Long = Long; \ No newline at end of file diff --git a/lib/mongodb/bson/max_key.js b/lib/mongodb/bson/max_key.js deleted file mode 100644 index 20b4586cdd0..00000000000 --- a/lib/mongodb/bson/max_key.js +++ /dev/null @@ -1,11 +0,0 @@ -/** - * A class representation of the BSON MaxKey type. - * - * @class Represents the BSON MaxKey type. - * @return {MaxKey} - */ -function MaxKey() { - this._bsontype = 'MaxKey'; -} - -exports.MaxKey = MaxKey; \ No newline at end of file diff --git a/lib/mongodb/bson/min_key.js b/lib/mongodb/bson/min_key.js deleted file mode 100644 index 265e563acb9..00000000000 --- a/lib/mongodb/bson/min_key.js +++ /dev/null @@ -1,11 +0,0 @@ -/** - * A class representation of the BSON MinKey type. - * - * @class Represents the BSON MinKey type. - * @return {MinKey} - */ -function MinKey() { - this._bsontype = 'MinKey'; -} - -exports.MinKey = MinKey; \ No newline at end of file diff --git a/lib/mongodb/bson/objectid.js b/lib/mongodb/bson/objectid.js deleted file mode 100644 index a78b2637dd1..00000000000 --- a/lib/mongodb/bson/objectid.js +++ /dev/null @@ -1,247 +0,0 @@ -/** - * Module dependencies. - */ -var BinaryParser = require('./binary_parser').BinaryParser, - inspect = require('util').inspect, - debug = require('util').debug; - -/** - * Machine id. - * - * Create a random 3-byte value (i.e. unique for this - * process). Other drivers use a md5 of the machine id here, but - * that would mean an asyc call to gethostname, so we don't bother. - */ -var MACHINE_ID = parseInt(Math.random() * 0xFFFFFF, 10); - -// Regular expression that checks for hex value -var checkForHexRegExp = new RegExp("^[0-9a-fA-F]{24}$"); - -/** -* Create a new ObjectID instance -* -* @class Represents the BSON ObjectID type -* @param {String|Number} id Can be a 24 byte hex string, 12 byte binary string or a Number. -* @return {Object} instance of ObjectID. -*/ -function ObjectID(id) { - this._bsontype = 'ObjectID'; - - var self = this; - // Throw an error if it's not a valid setup - if(id != null && 'number' != typeof id && (id.length != 12 && id.length != 24)) throw new Error("Argument passed in must be a single String of 12 bytes or a string of 24 hex characters in hex format"); - // Generate id based on the input - if(id == null || typeof id == 'number') { - this.id = this.generate(id); - } else if(id != null && id.length === 12) { - this.id = id; - } else if(checkForHexRegExp.test(id)) { - return ObjectID.createFromHexString(id); - } else { - this.id = id; - } - - /** - * Returns the generation time in seconds that this ID was generated. - * - * @field generationTime - * @type {Number} - * @getter - * @setter - * @property return number of seconds in the timestamp part of the 12 byte id. - */ - Object.defineProperty(this, "generationTime", { - enumerable: true - , get: function () { - return Math.floor(BinaryParser.decodeInt(this.id.substring(0,4), 32, true, true)); - } - , set: function (value) { - var value = BinaryParser.encodeInt(value, 32, true, true); - this.id = value + this.id.substr(4); - } - }); -}; - -/** -* Update the ObjectID index used in generating new ObjectID's on the driver -* -* @return {Number} returns next index value. -* @api private -*/ -ObjectID.prototype.get_inc = function() { - return ObjectID.index = (ObjectID.index + 1) % 0xFFFFFF; -}; - -/** -* Update the ObjectID index used in generating new ObjectID's on the driver -* -* @return {Number} returns next index value. -* @api private -*/ -ObjectID.prototype.getInc = function() { - return this.get_inc(); -}; - -/** -* Generate a 12 byte id string used in ObjectID's -* -* @param {Number} [time] optional parameter allowing to pass in a second based timestamp. -* @return {String} return the 12 byte id binary string. -* @api private -*/ -ObjectID.prototype.generate = function(time) { - if ('number' == typeof time) { - var time4Bytes = BinaryParser.encodeInt(time, 32, true, true); - /* for time-based ObjectID the bytes following the time will be zeroed */ - var machine3Bytes = BinaryParser.encodeInt(MACHINE_ID, 24, false); - var pid2Bytes = BinaryParser.fromShort(process.pid); - var index3Bytes = BinaryParser.encodeInt(this.get_inc(), 24, false, true); - } else { - var unixTime = parseInt(Date.now()/1000,10); - var time4Bytes = BinaryParser.encodeInt(unixTime, 32, true, true); - var machine3Bytes = BinaryParser.encodeInt(MACHINE_ID, 24, false); - var pid2Bytes = BinaryParser.fromShort(process.pid); - var index3Bytes = BinaryParser.encodeInt(this.get_inc(), 24, false, true); - } - - return time4Bytes + machine3Bytes + pid2Bytes + index3Bytes; -}; - -/** -* Return the ObjectID id as a 24 byte hex string representation -* -* @return {String} return the 24 byte hex string representation. -* @api public -*/ -ObjectID.prototype.toHexString = function() { - if(this.__id) return this.__id; - - var hexString = '' - , number - , value; - - for (var index = 0, len = this.id.length; index < len; index++) { - value = BinaryParser.toByte(this.id[index]); - number = value <= 15 - ? '0' + value.toString(16) - : value.toString(16); - hexString = hexString + number; - } - - return this.__id = hexString; -}; - -/** -* Converts the id into a 24 byte hex string for printing -* -* @return {String} return the 24 byte hex string representation. -* @api private -*/ -ObjectID.prototype.toString = function() { - return this.toHexString(); -}; - -/** -* Converts to a string representation of this Id. -* -* @return {String} return the 24 byte hex string representation. -* @api private -*/ -ObjectID.prototype.inspect = ObjectID.prototype.toString; - -/** -* Converts to its JSON representation. -* -* @return {String} return the 24 byte hex string representation. -* @api private -*/ -ObjectID.prototype.toJSON = function() { - return this.toHexString(); -}; - -/** -* Compares the equality of this ObjectID with `otherID`. -* -* @param {Object} otherID ObjectID instance to compare against. -* @return {Bool} the result of comparing two ObjectID's -* @api public -*/ -ObjectID.prototype.equals = function equals (otherID) { - var id = (otherID instanceof ObjectID || otherID.toHexString) - ? otherID.id - : ObjectID.createFromHexString(otherID).id; - - return this.id === id; -} - -/** -* Returns the generation time in seconds that this ID was generated. -* -* @return {Number} return number of seconds in the timestamp part of the 12 byte id. -* @api public -*/ -ObjectID.prototype.getTimestamp = function() { - var timestamp = new Date(); - timestamp.setTime(Math.floor(BinaryParser.decodeInt(this.id.substring(0,4), 32, true, true)) * 1000); - return timestamp; -} - -/** -* @ignore -* @api private -*/ -ObjectID.index = 0; - -ObjectID.createPk = function createPk () { - return new ObjectID(); -}; - -/** -* Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID. -* -* @param {Number} time an integer number representing a number of seconds. -* @return {ObjectID} return the created ObjectID -* @api public -*/ -ObjectID.createFromTime = function createFromHexString(time) { - var time4Bytes = BinaryParser.encodeInt(time, 32, true, true); - var objectID = new ObjectID(); - objectID.id = BinaryParser.encodeInt(time, 32, true, true) + BinaryParser.encodeInt(0, 64, true, true) - return objectID; -}; - -/** -* Creates an ObjectID from a hex string representation of an ObjectID. -* -* @param {String} hexString create a ObjectID from a passed in 24 byte hexstring. -* @return {ObjectID} return the created ObjectID -* @api public -*/ -ObjectID.createFromHexString = function createFromHexString (hexString) { - // Throw an error if it's not a valid setup - if(hexString != null && hexString.length != 24) throw new Error("Argument passed in must be a single String of 12 bytes or a string of 24 hex characters in hex format"); - - var len = hexString.length; - - if(len > 12*2) { - throw new Error('Id cannot be longer than 12 bytes'); - } - - var result = '' - , string - , number; - - for (var index = 0; index < len; index += 2) { - string = hexString.substr(index, 2); - number = parseInt(string, 16); - result += BinaryParser.fromByte(number); - } - - return new ObjectID(result); -}; - -/** - * Expose. - */ -exports.ObjectID = ObjectID; - diff --git a/lib/mongodb/bson/symbol.js b/lib/mongodb/bson/symbol.js deleted file mode 100644 index 67174157617..00000000000 --- a/lib/mongodb/bson/symbol.js +++ /dev/null @@ -1,47 +0,0 @@ -/** - * A class representation of the BSON Symbol type. - * - * @class Represents the BSON Symbol type. - * @param {String} value the string representing the symbol. - * @return {Symbol} - */ -function Symbol(value) { - this._bsontype = 'Symbol'; - this.value = value; -} - -/** - * Access the wrapped string value. - * - * @return {String} returns the wrapped string. - * @api public - */ -Symbol.prototype.valueOf = function() { - return this.value; -}; - -/** - * @ignore - * @api private - */ -Symbol.prototype.toString = function() { - return this.value; -} - -/** - * @ignore - * @api private - */ -Symbol.prototype.inspect = function() { - return this.value; -} - -/** - * @ignore - * @api private - */ -Symbol.prototype.toJSON = function() { - return this.value; -} - -exports.Symbol = Symbol; \ No newline at end of file diff --git a/lib/mongodb/bson/timestamp.js b/lib/mongodb/bson/timestamp.js deleted file mode 100644 index db6003c03e1..00000000000 --- a/lib/mongodb/bson/timestamp.js +++ /dev/null @@ -1,852 +0,0 @@ -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -// Copyright 2009 Google Inc. All Rights Reserved - -/** - * Defines a Timestamp class for representing a 64-bit two's-complement - * integer value, which faithfully simulates the behavior of a Java "Timestamp". This - * implementation is derived from TimestampLib in GWT. - * - * Constructs a 64-bit two's-complement integer, given its low and high 32-bit - * values as *signed* integers. See the from* functions below for more - * convenient ways of constructing Timestamps. - * - * The internal representation of a Timestamp is the two given signed, 32-bit values. - * We use 32-bit pieces because these are the size of integers on which - * Javascript performs bit-operations. For operations like addition and - * multiplication, we split each number into 16-bit pieces, which can easily be - * multiplied within Javascript's floating-point representation without overflow - * or change in sign. - * - * In the algorithms below, we frequently reduce the negative case to the - * positive case by negating the input(s) and then post-processing the result. - * Note that we must ALWAYS check specially whether those values are MIN_VALUE - * (-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as - * a positive number, it overflows back into a negative). Not handling this - * case would often result in infinite recursion. - * - * @class Represents the BSON Timestamp type. - * @param {Number} low the low (signed) 32 bits of the Timestamp. - * @param {Number} high the high (signed) 32 bits of the Timestamp. - */ -function Timestamp(low, high) { - this._bsontype = 'Timestamp'; - /** - * @type {number} - * @api private - */ - this.low_ = low | 0; // force into 32 signed bits. - - /** - * @type {number} - * @api private - */ - this.high_ = high | 0; // force into 32 signed bits. -}; - -/** - * Return the int value. - * - * @return {Number} the value, assuming it is a 32-bit integer. - * @api public - */ -Timestamp.prototype.toInt = function() { - return this.low_; -}; - -/** - * Return the Number value. - * - * @return {Number} the closest floating-point representation to this value. - * @api public - */ -Timestamp.prototype.toNumber = function() { - return this.high_ * Timestamp.TWO_PWR_32_DBL_ + - this.getLowBitsUnsigned(); -}; - -/** - * Return the JSON value. - * - * @return {String} the JSON representation. - * @api public - */ -Timestamp.prototype.toJSON = function() { - return this.toString(); -} - -/** - * Return the String value. - * - * @param {Number} [opt_radix] the radix in which the text should be written. - * @return {String} the textual representation of this value. - * @api public - */ -Timestamp.prototype.toString = function(opt_radix) { - var radix = opt_radix || 10; - if (radix < 2 || 36 < radix) { - throw Error('radix out of range: ' + radix); - } - - if (this.isZero()) { - return '0'; - } - - if (this.isNegative()) { - if (this.equals(Timestamp.MIN_VALUE)) { - // We need to change the Timestamp value before it can be negated, so we remove - // the bottom-most digit in this base and then recurse to do the rest. - var radixTimestamp = Timestamp.fromNumber(radix); - var div = this.div(radixTimestamp); - var rem = div.multiply(radixTimestamp).subtract(this); - return div.toString(radix) + rem.toInt().toString(radix); - } else { - return '-' + this.negate().toString(radix); - } - } - - // Do several (6) digits each time through the loop, so as to - // minimize the calls to the very expensive emulated div. - var radixToPower = Timestamp.fromNumber(Math.pow(radix, 6)); - - var rem = this; - var result = ''; - while (true) { - var remDiv = rem.div(radixToPower); - var intval = rem.subtract(remDiv.multiply(radixToPower)).toInt(); - var digits = intval.toString(radix); - - rem = remDiv; - if (rem.isZero()) { - return digits + result; - } else { - while (digits.length < 6) { - digits = '0' + digits; - } - result = '' + digits + result; - } - } -}; - -/** - * Return the high 32-bits value. - * - * @return {Number} the high 32-bits as a signed value. - * @api public - */ -Timestamp.prototype.getHighBits = function() { - return this.high_; -}; - -/** - * Return the low 32-bits value. - * - * @return {Number} the low 32-bits as a signed value. - * @api public - */ -Timestamp.prototype.getLowBits = function() { - return this.low_; -}; - -/** - * Return the low unsigned 32-bits value. - * - * @return {Number} the low 32-bits as an unsigned value. - * @api public - */ -Timestamp.prototype.getLowBitsUnsigned = function() { - return (this.low_ >= 0) ? - this.low_ : Timestamp.TWO_PWR_32_DBL_ + this.low_; -}; - -/** - * Returns the number of bits needed to represent the absolute value of this Timestamp. - * - * @return {Number} Returns the number of bits needed to represent the absolute value of this Timestamp. - * @api public - */ -Timestamp.prototype.getNumBitsAbs = function() { - if (this.isNegative()) { - if (this.equals(Timestamp.MIN_VALUE)) { - return 64; - } else { - return this.negate().getNumBitsAbs(); - } - } else { - var val = this.high_ != 0 ? this.high_ : this.low_; - for (var bit = 31; bit > 0; bit--) { - if ((val & (1 << bit)) != 0) { - break; - } - } - return this.high_ != 0 ? bit + 33 : bit + 1; - } -}; - -/** - * Return whether this value is zero. - * - * @return {Boolean} whether this value is zero. - * @api public - */ -Timestamp.prototype.isZero = function() { - return this.high_ == 0 && this.low_ == 0; -}; - -/** - * Return whether this value is negative. - * - * @return {Boolean} whether this value is negative. - * @api public - */ -Timestamp.prototype.isNegative = function() { - return this.high_ < 0; -}; - -/** - * Return whether this value is odd. - * - * @return {Boolean} whether this value is odd. - * @api public - */ -Timestamp.prototype.isOdd = function() { - return (this.low_ & 1) == 1; -}; - -/** - * Return whether this Timestamp equals the other - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} whether this Timestamp equals the other - * @api public - */ -Timestamp.prototype.equals = function(other) { - return (this.high_ == other.high_) && (this.low_ == other.low_); -}; - -/** - * Return whether this Timestamp does not equal the other. - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} whether this Timestamp does not equal the other. - * @api public - */ -Timestamp.prototype.notEquals = function(other) { - return (this.high_ != other.high_) || (this.low_ != other.low_); -}; - -/** - * Return whether this Timestamp is less than the other. - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} whether this Timestamp is less than the other. - * @api public - */ -Timestamp.prototype.lessThan = function(other) { - return this.compare(other) < 0; -}; - -/** - * Return whether this Timestamp is less than or equal to the other. - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} whether this Timestamp is less than or equal to the other. - * @api public - */ -Timestamp.prototype.lessThanOrEqual = function(other) { - return this.compare(other) <= 0; -}; - -/** - * Return whether this Timestamp is greater than the other. - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} whether this Timestamp is greater than the other. - * @api public - */ -Timestamp.prototype.greaterThan = function(other) { - return this.compare(other) > 0; -}; - -/** - * Return whether this Timestamp is greater than or equal to the other. - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} whether this Timestamp is greater than or equal to the other. - * @api public - */ -Timestamp.prototype.greaterThanOrEqual = function(other) { - return this.compare(other) >= 0; -}; - -/** - * Compares this Timestamp with the given one. - * - * @param {Timestamp} other Timestamp to compare against. - * @return {Boolean} 0 if they are the same, 1 if the this is greater, and -1 if the given one is greater. - * @api public - */ -Timestamp.prototype.compare = function(other) { - if (this.equals(other)) { - return 0; - } - - var thisNeg = this.isNegative(); - var otherNeg = other.isNegative(); - if (thisNeg && !otherNeg) { - return -1; - } - if (!thisNeg && otherNeg) { - return 1; - } - - // at this point, the signs are the same, so subtraction will not overflow - if (this.subtract(other).isNegative()) { - return -1; - } else { - return 1; - } -}; - -/** - * The negation of this value. - * - * @return {Timestamp} the negation of this value. - * @api public - */ -Timestamp.prototype.negate = function() { - if (this.equals(Timestamp.MIN_VALUE)) { - return Timestamp.MIN_VALUE; - } else { - return this.not().add(Timestamp.ONE); - } -}; - -/** - * Returns the sum of this and the given Timestamp. - * - * @param {Timestamp} other Timestamp to add to this one. - * @return {Timestamp} the sum of this and the given Timestamp. - * @api public - */ -Timestamp.prototype.add = function(other) { - // Divide each number into 4 chunks of 16 bits, and then sum the chunks. - - var a48 = this.high_ >>> 16; - var a32 = this.high_ & 0xFFFF; - var a16 = this.low_ >>> 16; - var a00 = this.low_ & 0xFFFF; - - var b48 = other.high_ >>> 16; - var b32 = other.high_ & 0xFFFF; - var b16 = other.low_ >>> 16; - var b00 = other.low_ & 0xFFFF; - - var c48 = 0, c32 = 0, c16 = 0, c00 = 0; - c00 += a00 + b00; - c16 += c00 >>> 16; - c00 &= 0xFFFF; - c16 += a16 + b16; - c32 += c16 >>> 16; - c16 &= 0xFFFF; - c32 += a32 + b32; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c48 += a48 + b48; - c48 &= 0xFFFF; - return Timestamp.fromBits((c16 << 16) | c00, (c48 << 16) | c32); -}; - -/** - * Returns the difference of this and the given Timestamp. - * - * @param {Timestamp} other Timestamp to subtract from this. - * @return {Timestamp} the difference of this and the given Timestamp. - * @api public - */ -Timestamp.prototype.subtract = function(other) { - return this.add(other.negate()); -}; - -/** - * Returns the product of this and the given Timestamp. - * - * @param {Timestamp} other Timestamp to multiply with this. - * @return {Timestamp} the product of this and the other. - * @api public - */ -Timestamp.prototype.multiply = function(other) { - if (this.isZero()) { - return Timestamp.ZERO; - } else if (other.isZero()) { - return Timestamp.ZERO; - } - - if (this.equals(Timestamp.MIN_VALUE)) { - return other.isOdd() ? Timestamp.MIN_VALUE : Timestamp.ZERO; - } else if (other.equals(Timestamp.MIN_VALUE)) { - return this.isOdd() ? Timestamp.MIN_VALUE : Timestamp.ZERO; - } - - if (this.isNegative()) { - if (other.isNegative()) { - return this.negate().multiply(other.negate()); - } else { - return this.negate().multiply(other).negate(); - } - } else if (other.isNegative()) { - return this.multiply(other.negate()).negate(); - } - - // If both Timestamps are small, use float multiplication - if (this.lessThan(Timestamp.TWO_PWR_24_) && - other.lessThan(Timestamp.TWO_PWR_24_)) { - return Timestamp.fromNumber(this.toNumber() * other.toNumber()); - } - - // Divide each Timestamp into 4 chunks of 16 bits, and then add up 4x4 products. - // We can skip products that would overflow. - - var a48 = this.high_ >>> 16; - var a32 = this.high_ & 0xFFFF; - var a16 = this.low_ >>> 16; - var a00 = this.low_ & 0xFFFF; - - var b48 = other.high_ >>> 16; - var b32 = other.high_ & 0xFFFF; - var b16 = other.low_ >>> 16; - var b00 = other.low_ & 0xFFFF; - - var c48 = 0, c32 = 0, c16 = 0, c00 = 0; - c00 += a00 * b00; - c16 += c00 >>> 16; - c00 &= 0xFFFF; - c16 += a16 * b00; - c32 += c16 >>> 16; - c16 &= 0xFFFF; - c16 += a00 * b16; - c32 += c16 >>> 16; - c16 &= 0xFFFF; - c32 += a32 * b00; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c32 += a16 * b16; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c32 += a00 * b32; - c48 += c32 >>> 16; - c32 &= 0xFFFF; - c48 += a48 * b00 + a32 * b16 + a16 * b32 + a00 * b48; - c48 &= 0xFFFF; - return Timestamp.fromBits((c16 << 16) | c00, (c48 << 16) | c32); -}; - -/** - * Returns this Timestamp divided by the given one. - * - * @param {Timestamp} other Timestamp by which to divide. - * @return {Timestamp} this Timestamp divided by the given one. - * @api public - */ -Timestamp.prototype.div = function(other) { - if (other.isZero()) { - throw Error('division by zero'); - } else if (this.isZero()) { - return Timestamp.ZERO; - } - - if (this.equals(Timestamp.MIN_VALUE)) { - if (other.equals(Timestamp.ONE) || - other.equals(Timestamp.NEG_ONE)) { - return Timestamp.MIN_VALUE; // recall that -MIN_VALUE == MIN_VALUE - } else if (other.equals(Timestamp.MIN_VALUE)) { - return Timestamp.ONE; - } else { - // At this point, we have |other| >= 2, so |this/other| < |MIN_VALUE|. - var halfThis = this.shiftRight(1); - var approx = halfThis.div(other).shiftLeft(1); - if (approx.equals(Timestamp.ZERO)) { - return other.isNegative() ? Timestamp.ONE : Timestamp.NEG_ONE; - } else { - var rem = this.subtract(other.multiply(approx)); - var result = approx.add(rem.div(other)); - return result; - } - } - } else if (other.equals(Timestamp.MIN_VALUE)) { - return Timestamp.ZERO; - } - - if (this.isNegative()) { - if (other.isNegative()) { - return this.negate().div(other.negate()); - } else { - return this.negate().div(other).negate(); - } - } else if (other.isNegative()) { - return this.div(other.negate()).negate(); - } - - // Repeat the following until the remainder is less than other: find a - // floating-point that approximates remainder / other *from below*, add this - // into the result, and subtract it from the remainder. It is critical that - // the approximate value is less than or equal to the real value so that the - // remainder never becomes negative. - var res = Timestamp.ZERO; - var rem = this; - while (rem.greaterThanOrEqual(other)) { - // Approximate the result of division. This may be a little greater or - // smaller than the actual value. - var approx = Math.max(1, Math.floor(rem.toNumber() / other.toNumber())); - - // We will tweak the approximate result by changing it in the 48-th digit or - // the smallest non-fractional digit, whichever is larger. - var log2 = Math.ceil(Math.log(approx) / Math.LN2); - var delta = (log2 <= 48) ? 1 : Math.pow(2, log2 - 48); - - // Decrease the approximation until it is smaller than the remainder. Note - // that if it is too large, the product overflows and is negative. - var approxRes = Timestamp.fromNumber(approx); - var approxRem = approxRes.multiply(other); - while (approxRem.isNegative() || approxRem.greaterThan(rem)) { - approx -= delta; - approxRes = Timestamp.fromNumber(approx); - approxRem = approxRes.multiply(other); - } - - // We know the answer can't be zero... and actually, zero would cause - // infinite recursion since we would make no progress. - if (approxRes.isZero()) { - approxRes = Timestamp.ONE; - } - - res = res.add(approxRes); - rem = rem.subtract(approxRem); - } - return res; -}; - -/** - * Returns this Timestamp modulo the given one. - * - * @param {Timestamp} other Timestamp by which to mod. - * @return {Timestamp} this Timestamp modulo the given one. - * @api public - */ -Timestamp.prototype.modulo = function(other) { - return this.subtract(this.div(other).multiply(other)); -}; - -/** - * The bitwise-NOT of this value. - * - * @return {Timestamp} the bitwise-NOT of this value. - * @api public - */ -Timestamp.prototype.not = function() { - return Timestamp.fromBits(~this.low_, ~this.high_); -}; - -/** - * Returns the bitwise-AND of this Timestamp and the given one. - * - * @param {Timestamp} other the Timestamp with which to AND. - * @return {Timestamp} the bitwise-AND of this and the other. - * @api public - */ -Timestamp.prototype.and = function(other) { - return Timestamp.fromBits(this.low_ & other.low_, this.high_ & other.high_); -}; - -/** - * Returns the bitwise-OR of this Timestamp and the given one. - * - * @param {Timestamp} other the Timestamp with which to OR. - * @return {Timestamp} the bitwise-OR of this and the other. - * @api public - */ -Timestamp.prototype.or = function(other) { - return Timestamp.fromBits(this.low_ | other.low_, this.high_ | other.high_); -}; - -/** - * Returns the bitwise-XOR of this Timestamp and the given one. - * - * @param {Timestamp} other the Timestamp with which to XOR. - * @return {Timestamp} the bitwise-XOR of this and the other. - * @api public - */ -Timestamp.prototype.xor = function(other) { - return Timestamp.fromBits(this.low_ ^ other.low_, this.high_ ^ other.high_); -}; - -/** - * Returns this Timestamp with bits shifted to the left by the given amount. - * - * @param {Number} numBits the number of bits by which to shift. - * @return {Timestamp} this shifted to the left by the given amount. - * @api public - */ -Timestamp.prototype.shiftLeft = function(numBits) { - numBits &= 63; - if (numBits == 0) { - return this; - } else { - var low = this.low_; - if (numBits < 32) { - var high = this.high_; - return Timestamp.fromBits( - low << numBits, - (high << numBits) | (low >>> (32 - numBits))); - } else { - return Timestamp.fromBits(0, low << (numBits - 32)); - } - } -}; - -/** - * Returns this Timestamp with bits shifted to the right by the given amount. - * - * @param {Number} numBits the number of bits by which to shift. - * @return {Timestamp} this shifted to the right by the given amount. - * @api public - */ -Timestamp.prototype.shiftRight = function(numBits) { - numBits &= 63; - if (numBits == 0) { - return this; - } else { - var high = this.high_; - if (numBits < 32) { - var low = this.low_; - return Timestamp.fromBits( - (low >>> numBits) | (high << (32 - numBits)), - high >> numBits); - } else { - return Timestamp.fromBits( - high >> (numBits - 32), - high >= 0 ? 0 : -1); - } - } -}; - -/** - * Returns this Timestamp with bits shifted to the right by the given amount, with the new top bits matching the current sign bit. - * - * @param {Number} numBits the number of bits by which to shift. - * @return {Timestamp} this shifted to the right by the given amount, with zeros placed into the new leading bits. - * @api public - */ -Timestamp.prototype.shiftRightUnsigned = function(numBits) { - numBits &= 63; - if (numBits == 0) { - return this; - } else { - var high = this.high_; - if (numBits < 32) { - var low = this.low_; - return Timestamp.fromBits( - (low >>> numBits) | (high << (32 - numBits)), - high >>> numBits); - } else if (numBits == 32) { - return Timestamp.fromBits(high, 0); - } else { - return Timestamp.fromBits(high >>> (numBits - 32), 0); - } - } -}; - -/** - * Returns a Timestamp representing the given (32-bit) integer value. - * - * @param {Number} value the 32-bit integer in question. - * @return {Timestamp} the corresponding Timestamp value. - * @api public - */ -Timestamp.fromInt = function(value) { - if (-128 <= value && value < 128) { - var cachedObj = Timestamp.INT_CACHE_[value]; - if (cachedObj) { - return cachedObj; - } - } - - var obj = new Timestamp(value | 0, value < 0 ? -1 : 0); - if (-128 <= value && value < 128) { - Timestamp.INT_CACHE_[value] = obj; - } - return obj; -}; - -/** - * Returns a Timestamp representing the given value, provided that it is a finite number. Otherwise, zero is returned. - * - * @param {Number} value the number in question. - * @return {Timestamp} the corresponding Timestamp value. - * @api public - */ -Timestamp.fromNumber = function(value) { - if (isNaN(value) || !isFinite(value)) { - return Timestamp.ZERO; - } else if (value <= -Timestamp.TWO_PWR_63_DBL_) { - return Timestamp.MIN_VALUE; - } else if (value + 1 >= Timestamp.TWO_PWR_63_DBL_) { - return Timestamp.MAX_VALUE; - } else if (value < 0) { - return Timestamp.fromNumber(-value).negate(); - } else { - return new Timestamp( - (value % Timestamp.TWO_PWR_32_DBL_) | 0, - (value / Timestamp.TWO_PWR_32_DBL_) | 0); - } -}; - -/** - * Returns a Timestamp representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits. - * - * @param {Number} lowBits the low 32-bits. - * @param {Number} highBits the high 32-bits. - * @return {Timestamp} the corresponding Timestamp value. - * @api public - */ -Timestamp.fromBits = function(lowBits, highBits) { - return new Timestamp(lowBits, highBits); -}; - -/** - * Returns a Timestamp representation of the given string, written using the given radix. - * - * @param {String} str the textual representation of the Timestamp. - * @param {Number} opt_radix the radix in which the text is written. - * @return {Timestamp} the corresponding Timestamp value. - * @api public - */ -Timestamp.fromString = function(str, opt_radix) { - if (str.length == 0) { - throw Error('number format error: empty string'); - } - - var radix = opt_radix || 10; - if (radix < 2 || 36 < radix) { - throw Error('radix out of range: ' + radix); - } - - if (str.charAt(0) == '-') { - return Timestamp.fromString(str.substring(1), radix).negate(); - } else if (str.indexOf('-') >= 0) { - throw Error('number format error: interior "-" character: ' + str); - } - - // Do several (8) digits each time through the loop, so as to - // minimize the calls to the very expensive emulated div. - var radixToPower = Timestamp.fromNumber(Math.pow(radix, 8)); - - var result = Timestamp.ZERO; - for (var i = 0; i < str.length; i += 8) { - var size = Math.min(8, str.length - i); - var value = parseInt(str.substring(i, i + size), radix); - if (size < 8) { - var power = Timestamp.fromNumber(Math.pow(radix, size)); - result = result.multiply(power).add(Timestamp.fromNumber(value)); - } else { - result = result.multiply(radixToPower); - result = result.add(Timestamp.fromNumber(value)); - } - } - return result; -}; - -// NOTE: Common constant values ZERO, ONE, NEG_ONE, etc. are defined below the -// from* methods on which they depend. - - -/** - * A cache of the Timestamp representations of small integer values. - * @type {Object} - * @api private - */ -Timestamp.INT_CACHE_ = {}; - -// NOTE: the compiler should inline these constant values below and then remove -// these variables, so there should be no runtime penalty for these. - -/** - * Number used repeated below in calculations. This must appear before the - * first call to any from* function below. - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_16_DBL_ = 1 << 16; - -/** - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_24_DBL_ = 1 << 24; - -/** - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_32_DBL_ = Timestamp.TWO_PWR_16_DBL_ * Timestamp.TWO_PWR_16_DBL_; - -/** - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_31_DBL_ = Timestamp.TWO_PWR_32_DBL_ / 2; - -/** - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_48_DBL_ = Timestamp.TWO_PWR_32_DBL_ * Timestamp.TWO_PWR_16_DBL_; - -/** - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_64_DBL_ = Timestamp.TWO_PWR_32_DBL_ * Timestamp.TWO_PWR_32_DBL_; - -/** - * @type {number} - * @api private - */ -Timestamp.TWO_PWR_63_DBL_ = Timestamp.TWO_PWR_64_DBL_ / 2; - -/** @type {Timestamp} */ -Timestamp.ZERO = Timestamp.fromInt(0); - -/** @type {Timestamp} */ -Timestamp.ONE = Timestamp.fromInt(1); - -/** @type {Timestamp} */ -Timestamp.NEG_ONE = Timestamp.fromInt(-1); - -/** @type {Timestamp} */ -Timestamp.MAX_VALUE = - Timestamp.fromBits(0xFFFFFFFF | 0, 0x7FFFFFFF | 0); - -/** @type {Timestamp} */ -Timestamp.MIN_VALUE = Timestamp.fromBits(0, 0x80000000 | 0); - -/** - * @type {Timestamp} - * @api private - */ -Timestamp.TWO_PWR_24_ = Timestamp.fromInt(1 << 24); - -/** - * Expose. - */ -exports.Timestamp = Timestamp; \ No newline at end of file diff --git a/lib/mongodb/collection.js b/lib/mongodb/collection.js deleted file mode 100644 index f875bd3d1e4..00000000000 --- a/lib/mongodb/collection.js +++ /dev/null @@ -1,1432 +0,0 @@ -/** - * Module dependencies. - * @ignore - */ -var InsertCommand = require('./commands/insert_command').InsertCommand - , QueryCommand = require('./commands/query_command').QueryCommand - , DeleteCommand = require('./commands/delete_command').DeleteCommand - , UpdateCommand = require('./commands/update_command').UpdateCommand - , DbCommand = require('./commands/db_command').DbCommand - , BinaryParser = require('./bson/binary_parser').BinaryParser - , ObjectID = require('./bson/objectid').ObjectID - , Code = require('./bson/code').Code - , Cursor = require('./cursor').Cursor - , debug = require('util').debug - , inspect = require('util').inspect - , utils = require('./utils'); - -/** - * Precompiled regexes - * @ignore -**/ -const eErrorMessages = /No matching object found/; - -/** - * toString helper. - * @ignore - */ -var toString = Object.prototype.toString; - -/** - * Create a new Collection instance - * - * Options - * - **slaveOk** {Boolean, default:false}, Allow reads from secondaries. - * - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. - * - **raw** {Boolean, default:false}, perform all operations using raw bson objects. - * - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. - * - * @class Represents a Collection - * @param {Object} db db instance. - * @param {String} collectionName collection name. - * @param {Object} [pkFactory] alternative primary key factory. - * @param {Object} [options] additional options for the collection. - * @return {Object} a collection instance. - */ -function Collection (db, collectionName, pkFactory, options) { - checkCollectionName(collectionName); - - this.db = db; - this.collectionName = collectionName; - this.internalHint; - this.opts = options != null && ('object' === typeof options) ? options : {}; - this.slaveOk = options == null || options.slaveOk == null ? db.slaveOk : options.slaveOk; - this.serializeFunctions = options == null || options.serializeFunctions == null ? db.serializeFunctions : options.serializeFunctions; - this.raw = options == null || options.raw == null ? db.raw : options.raw; - this.pkFactory = pkFactory == null - ? ObjectID - : pkFactory; - - var self = this - Object.defineProperty(this, "hint", { - enumerable: true - , get: function () { - return this.internalHint; - } - , set: function (v) { - this.internalHint = normalizeHintField(v); - } - }); -}; - -/** - * Inserts a single document or a an array of documents into MongoDB. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - **keepGoing** {Boolean, default:false}, keep inserting documents even if one document has an error, *mongodb 1.9.1 >*. - * - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. - * - * @param {Array|Object} docs - * @param {Object} [options] optional options for insert command - * @param {Function} [callback] optional callback for the function, must be provided when using `safe` or `strict` mode - * @return {null} - * @api public - */ -Collection.prototype.insert = function insert (docs, options, callback) { - if ('function' === typeof options) callback = options, options = {}; - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - var self = this; - insertAll(self, Array.isArray(docs) ? docs : [docs], options, callback); - return this; -}; - -/** - * @ignore - */ -var checkCollectionName = function checkCollectionName (collectionName) { - if ('string' !== typeof collectionName) { - throw Error("collection name must be a String"); - } - - if (!collectionName || collectionName.indexOf('..') != -1) { - throw Error("collection names cannot be empty"); - } - - if (collectionName.indexOf('$') != -1 && - collectionName.match(/((^\$cmd)|(oplog\.\$main))/) == null) { - throw Error("collection names must not contain '$'"); - } - - if (collectionName.match(/^\.|\.$/) != null) { - throw Error("collection names must not start or end with '.'"); - } -}; - -/** - * Removes documents specified by `selector` from the db. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {Object} [selector] optional select, no selector is equivalent to removing all documents. - * @param {Object} [options] additional options during remove. - * @param {Function} [callback] must be provided if you performing a safe remove - * @return {null} - * @api public - */ -Collection.prototype.remove = function remove(selector, options, callback) { - if ('function' === typeof selector) { - callback = selector; - selector = options = {}; - } else if ('function' === typeof options) { - callback = options; - options = {}; - } - - // Ensure options - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - // Ensure we have at least an empty selector - selector = selector == null ? {} : selector; - - var deleteCommand = new DeleteCommand( - this.db - , this.db.databaseName + "." + this.collectionName - , selector); - - var self = this; - var errorOptions = options.safe != null ? options.safe : null; - errorOptions = errorOptions == null && this.opts.safe != null ? this.opts.safe : errorOptions; - errorOptions = errorOptions == null && this.db.strict != null ? this.db.strict : errorOptions; - - // Execute the command, do not add a callback as it's async - if (options && options.safe || this.opts.safe != null || this.db.strict) { - // Insert options - var commandOptions = {read:false}; - // If we have safe set set async to false - if(errorOptions == null) commandOptions['async'] = true; - // Set safe option - commandOptions['safe'] = true; - // If we have an error option - if(typeof errorOptions == 'object') { - var keys = Object.keys(errorOptions); - for(var i = 0; i < keys.length; i++) { - commandOptions[keys[i]] = errorOptions[keys[i]]; - } - } - - // Execute command with safe options (rolls up both command and safe command into one and executes them on the same connection) - this.db._executeRemoveCommand(deleteCommand, commandOptions, function (err, error) { - error = error && error.documents; - if(!callback) return; - - if (err) { - callback(err); - } else if (error[0].err) { - callback(self.db.wrap(error[0])); - } else { - callback(null, error[0].n); - } - }); - } else { - var result = this.db._executeRemoveCommand(deleteCommand); - // If no callback just return - if (!callback) return; - // If error return error - if (result instanceof Error) { - return callback(result); - } - // Otherwise just return - return callback(); - } -}; - -/** - * Renames the collection. - * - * @param {String} newName the new name of the collection. - * @param {Function} callback the callback accepting the result - * @return {null} - * @api public - */ -Collection.prototype.rename = function rename (newName, callback) { - var self = this; - // Ensure the new name is valid - checkCollectionName(newName); - // Execute the command, return the new renamed collection if successful - self.db._executeQueryCommand(DbCommand.createRenameCollectionCommand(self.db, self.collectionName, newName), function(err, result) { - if(err == null && result.documents[0].ok == 1) { - if(callback != null) { - // Set current object to point to the new name - self.collectionName = newName; - // Return the current collection - callback(null, self); - } - } else if(result.documents[0].errmsg != null) { - if(callback != null) { - err != null ? callback(err, null) : callback(self.db.wrap(result.documents[0]), null); - } - } - }); -}; - -/** - * @ignore - */ -var insertAll = function insertAll (self, docs, options, callback) { - if('function' === typeof options) callback = options, options = {}; - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - - // Insert options (flags for insert) - var insertFlags = {}; - // If we have a mongodb version >= 1.9.1 support keepGoing attribute - if(options['keepGoing'] != null) { - insertFlags['keepGoing'] = options['keepGoing']; - } - - // Either use override on the function, or go back to default on either the collection - // level or db - if(options['serializeFunctions'] != null) { - insertFlags['serializeFunctions'] = options['serializeFunctions']; - } else { - insertFlags['serializeFunctions'] = self.serializeFunctions; - } - - // Pass in options - var insertCommand = new InsertCommand( - self.db - , self.db.databaseName + "." + self.collectionName, true, insertFlags); - - // Add the documents and decorate them with id's if they have none - for (var index = 0, len = docs.length; index < len; ++index) { - var doc = docs[index]; - - // Add id to each document if it's not already defined - if (!(doc instanceof Buffer) && !doc['_id'] && self.db.forceServerObjectId != true) { - doc['_id'] = self.pkFactory.createPk(); - } - - insertCommand.add(doc); - } - - // Collect errorOptions - var errorOptions = options.safe != null ? options.safe : null; - errorOptions = errorOptions == null && self.opts.safe != null ? self.opts.safe : errorOptions; - errorOptions = errorOptions == null && self.db.strict != null ? self.db.strict : errorOptions; - - // Default command options - var commandOptions = {}; - // If safe is defined check for error message - // if(options != null && (options.safe == true || this.db.strict == true || this.opts.safe == true)) { - if(errorOptions && errorOptions != false) { - // Insert options - commandOptions['read'] = false; - // If we have safe set set async to false - if(errorOptions == null) commandOptions['async'] = true; - - // Set safe option - commandOptions['safe'] = errorOptions; - // If we have an error option - if(typeof errorOptions == 'object') { - var keys = Object.keys(errorOptions); - for(var i = 0; i < keys.length; i++) { - commandOptions[keys[i]] = errorOptions[keys[i]]; - } - } - - // Execute command with safe options (rolls up both command and safe command into one and executes them on the same connection) - self.db._executeInsertCommand(insertCommand, commandOptions, function (err, error) { - error = error && error.documents; - if(!callback) return; - - if (err) { - callback(err); - } else if (error[0].err) { - callback(self.db.wrap(error[0])); - } else { - callback(null, docs); - } - }); - } else { - var result = self.db._executeInsertCommand(insertCommand, commandOptions); - // If no callback just return - if(!callback) return; - // If error return error - if(result instanceof Error) { - return callback(result); - } - // Otherwise just return - return callback(null, docs); - } -}; - -/** - * Save a document. Simple full document replacement function. Not recommended for efficiency, use atomic - * operators and update instead for more efficient operations. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {Object} [doc] the document to save - * @param {Object} [options] additional options during remove. - * @param {Function} [callback] must be provided if you performing a safe save - * @return {null} - * @api public - */ -Collection.prototype.save = function save(doc, options, callback) { - if('function' === typeof options) callback = options, options = null; - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - - var errorOptions = options.safe != null ? options.safe : false; - errorOptions = errorOptions == null && this.opts.safe != null ? this.opts.safe : errorOptions; - // Extract the id, if we have one we need to do a update command - var id = doc['_id']; - - if(id) { - this.update({ _id: id }, doc, { upsert: true, safe: errorOptions }, callback); - } else { - this.insert(doc, { safe: errorOptions }, callback && function (err, docs) { - if (err) return callback(err, null); - - if (Array.isArray(docs)) { - callback(err, docs[0]); - } else { - callback(err, docs); - } - }); - } -}; - -/** - * Updates documents. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - **upsert** {Boolean, default:false}, perform an upsert operation. - * - **multi** {Boolean, default:false}, update all documents matching the selector. - * - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. - * - * @param {Object} selector the query to select the document/documents to be updated - * @param {Object} document the fields/vals to be updated, or in the case of an upsert operation, inserted. - * @param {Object} [options] additional options during update. - * @param {Function} [callback] must be provided if you performing a safe update - * @return {null} - * @api public - */ -Collection.prototype.update = function update(selector, document, options, callback) { - if('function' === typeof options) callback = options, options = null; - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - - // Either use override on the function, or go back to default on either the collection - // level or db - if(options['serializeFunctions'] != null) { - options['serializeFunctions'] = options['serializeFunctions']; - } else { - options['serializeFunctions'] = this.serializeFunctions; - } - - var updateCommand = new UpdateCommand( - this.db - , this.db.databaseName + "." + this.collectionName - , selector - , document - , options); - - var self = this; - // Unpack the error options if any - var errorOptions = (options && options.safe != null) ? options.safe : null; - errorOptions = errorOptions == null && this.opts.safe != null ? this.opts.safe : errorOptions; - errorOptions = errorOptions == null && this.db.strict != null ? this.db.strict : errorOptions; - - // If we are executing in strict mode or safe both the update and the safe command must happen on the same line - if(errorOptions && errorOptions != false) { - // Insert options - var commandOptions = {read:false}; - // If we have safe set set async to false - if(errorOptions == null) commandOptions['async'] = true; - // Set safe option - commandOptions['safe'] = true; - // If we have an error option - if(typeof errorOptions == 'object') { - var keys = Object.keys(errorOptions); - for(var i = 0; i < keys.length; i++) { - commandOptions[keys[i]] = errorOptions[keys[i]]; - } - } - - // Execute command with safe options (rolls up both command and safe command into one and executes them on the same connection) - this.db._executeUpdateCommand(updateCommand, commandOptions, function (err, error) { - error = error && error.documents; - if(!callback) return; - - if (err) { - callback(err); - } else if (error[0].err) { - callback(self.db.wrap(error[0])); - } else { - callback(null, error[0].n); - } - }); - } else { - // Execute update - var result = this.db._executeUpdateCommand(updateCommand); - // If no callback just return - if (!callback) return; - // If error return error - if (result instanceof Error) { - return callback(result); - } - // Otherwise just return - return callback(); - } -}; - -/** - * The distinct command returns returns a list of distinct values for the given key across a collection. - * - * @param {String} key key to run distinct against. - * @param {Object} [query] option query to narrow the returned objects. - * @param {Function} callback must be provided. - * @return {null} - * @api public - */ -Collection.prototype.distinct = function distinct(key, query, callback) { - if ('function' === typeof query) callback = query, query = {}; - - var mapCommandHash = { - distinct: this.collectionName - , query: query - , key: key - }; - - var cmd = DbCommand.createDbSlaveOkCommand(this.db, mapCommandHash); - - this.db._executeQueryCommand(cmd, {read:true}, function (err, result) { - if (err) { - return callback(err); - } - - if (result.documents[0].ok != 1) { - return callback(new Error(result.documents[0].errmsg)); - } - - callback(null, result.documents[0].values); - }); -}; - -/** - * Count number of matching documents in the db to a query. - * - * @param {Object} [query] query to filter by before performing count. - * @param {Function} callback must be provided. - * @return {null} - * @api public - */ -Collection.prototype.count = function count (query, callback) { - if ('function' === typeof query) callback = query, query = {}; - - var final_query = { - count: this.collectionName - , query: query - , fields: null - }; - - var queryOptions = QueryCommand.OPTS_NO_CURSOR_TIMEOUT; - if (this.slaveOk || this.db.slaveOk) { - queryOptions |= QueryCommand.OPTS_SLAVE; - } - - var queryCommand = new QueryCommand( - this.db - , this.db.databaseName + ".$cmd" - , queryOptions - , 0 - , -1 - , final_query - , null - ); - - var self = this; - this.db._executeQueryCommand(queryCommand, {read:true}, function (err, result) { - result = result && result.documents; - if(!callback) return; - - if (err) { - callback(err); - } else if (result[0].ok != 1) { - callback(self.db.wrap(result[0])); - } else { - callback(null, result[0].n); - } - }); -}; - - -/** - * Drop the collection - * - * @param {Function} [callback] provide a callback to be notified when command finished executing - * @return {null} - * @api public - */ -Collection.prototype.drop = function drop(callback) { - this.db.dropCollection(this.collectionName, callback); -}; - -/** - * Find and update a document. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - **remove** {Boolean, default:false}, set to true to remove the object before returning. - * - **upsert** {Boolean, default:false}, perform an upsert operation. - * - **new** {Boolean, default:false}, set to true if you want to return the modified object rather than the original. Ignored for remove. - * - * @param {Object} query query object to locate the object to modify - * @param {Array} sort - if multiple docs match, choose the first one in the specified sort order as the object to manipulate - * @param {Object} doc - the fields/vals to be updated - * @param {Object} [options] additional options during update. - * @param {Function} [callback] returns results. - * @return {null} - * @api public - */ -Collection.prototype.findAndModify = function findAndModify (query, sort, doc, options, callback) { - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - sort = args.length ? args.shift() : []; - doc = args.length ? args.shift() : null; - options = args.length ? args.shift() : {}; - var self = this; - - var queryObject = { - 'findandmodify': this.collectionName - , 'query': query - , 'sort': utils.formattedOrderClause(sort) - }; - - queryObject.new = options.new ? 1 : 0; - queryObject.remove = options.remove ? 1 : 0; - queryObject.upsert = options.upsert ? 1 : 0; - - if (options.fields) { - queryObject.fields = options.fields; - } - - if (doc && !options.remove) { - queryObject.update = doc; - } - - // Either use override on the function, or go back to default on either the collection - // level or db - if(options['serializeFunctions'] != null) { - options['serializeFunctions'] = options['serializeFunctions']; - } else { - options['serializeFunctions'] = this.serializeFunctions; - } - - // Unpack the error options if any - var errorOptions = (options && options.safe != null) ? options.safe : null; - errorOptions = errorOptions == null && this.opts.safe != null ? this.opts.safe : errorOptions; - errorOptions = errorOptions == null && this.db.strict != null ? this.db.strict : errorOptions; - - // Commands to send - var commands = []; - // Add the find and modify command - commands.push(DbCommand.createDbSlaveOkCommand(this.db, queryObject, options)); - // If we have safe defined we need to return both call results - var chainedCommands = errorOptions != null ? true : false; - // Add error command if we have one - if(chainedCommands) { - commands.push(DbCommand.createGetLastErrorCommand(errorOptions, this.db)); - } - - // Fire commands and - this.db._executeQueryCommand(commands, function(err, result) { - result = result && result.documents; - - if(err != null) { - callback(err); - } else if(result[0].err != null) { - callback(self.db.wrap(result[0]), null); - } else if(result[0].errmsg != null && !result[0].errmsg.match(eErrorMessages)) { - // Workaround due to 1.8.X returning an error on no matching object - // while 2.0.X does not not, making 2.0.X behaviour standard - callback(self.db.wrap(result[0]), null); - } else { - return callback(null, result[0].value); - } - }); -} - -/** - * Find and remove a document - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {Object} query query object to locate the object to modify - * @param {Array} sort - if multiple docs match, choose the first one in the specified sort order as the object to manipulate - * @param {Object} [options] additional options during update. - * @param {Function} [callback] returns results. - * @return {null} - * @api public - */ -Collection.prototype.findAndRemove = function(query, sort, options, callback) { - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - sort = args.length ? args.shift() : []; - options = args.length ? args.shift() : {}; - // Add the remove option - options['remove'] = true; - // Execute the callback - this.findAndModify(query, sort, null, options, callback); -} - -var testForFields = {'limit' : 1, 'sort' : 1, 'fields' : 1, 'skip' : 1, 'hint' : 1, 'explain' : 1, 'snapshot' : 1 - , 'timeout' : 1, 'tailable' : 1, 'batchSize' : 1, 'raw' : 1, 'read' : 1 - , 'returnKey' : 1, 'maxScan' : 1, 'min' : 1, 'max' : 1, 'showDiskLoc' : 1, 'comment' : 1}; - -/** - * Creates a cursor for a query that can be used to iterate over results from MongoDB - * - * Various argument possibilities - * - callback? - * - selector, callback?, - * - selector, fields, callback? - * - selector, options, callback? - * - selector, fields, options, callback? - * - selector, fields, skip, limit, callback? - * - selector, fields, skip, limit, timeout, callback? - * - * Options - * - **limit** {Number, default:0}, sets the limit of documents returned in the query. - * - **sort** {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc. - * - **fields** {Object}, the fields to return in the query. Object of fields to include or exclude (not both), {'a':1} - * - **skip** {Number, default:0}, set to skip N documents ahead in your query (useful for pagination). - * - **hint** {Object}, tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1} - * - **explain** {Boolean, default:false}, explain the query instead of returning the data. - * - **snapshot** {Boolean, default:false}, snapshot query. - * - **timeout** {Boolean, default:false}, specify if the cursor can timeout. - * - **tailable** {Boolean, default:false}, specify if the cursor is tailable. - * - **batchSize** {Number, default:0}, set the batchSize for the getMoreCommand when iterating over the query results. - * - **returnKey** {Boolean, default:false}, only return the index key. - * - **maxScan** {Number}, Limit the number of items to scan. - * - **min** {Number}, Set index bounds. - * - **max** {Number}, Set index bounds. - * - **showDiskLoc** {Boolean, default:false}, Show disk location of results. - * - **comment** {String}, You can put a $comment field on a query to make looking in the profiler logs simpler. - * - **raw** {Boolean, default:false}, Return all BSON documents as Raw Buffer documents. - * - **read** {Boolean, default:false}, Tell the query to read from a secondary server. - * - * @param {Object} query query object to locate the object to modify - * @param {Object} [options] additional options during update. - * @param {Function} [callback] optional callback for cursor. - * @return {Cursor} returns a cursor to the query - * @api public - */ -Collection.prototype.find = function find () { - var options - , args = Array.prototype.slice.call(arguments, 0) - , has_callback = typeof args[args.length - 1] === 'function' - , has_weird_callback = typeof args[0] === 'function' - , callback = has_callback ? args.pop() : (has_weird_callback ? args.shift() : null) - , len = args.length - , selector = len >= 1 ? args[0] : {} - , fields = len >= 2 ? args[1] : undefined; - - if(len === 1 && has_weird_callback) { - // backwards compat for callback?, options case - selector = {}; - options = args[0]; - } - - if(len === 2 && !Array.isArray(fields)) { - var fieldKeys = Object.getOwnPropertyNames(fields); - var is_option = false; - - for(var i = 0; i < fieldKeys.length; i++) { - if(testForFields[fieldKeys[i]] != null) { - is_option = true; - break; - } - } - - if(is_option) { - options = fields; - fields = undefined; - } else { - options = {}; - } - } else if(len === 2 && Array.isArray(fields) && !Array.isArray(fields[0])) { - var newFields = {}; - // Rewrite the array - for(var i = 0; i < fields.length; i++) { - newFields[fields[i]] = 1; - } - // Set the fields - fields = newFields; - } - - if(3 === len) { - options = args[2]; - } - - // Ensure selector is not null - selector = selector == null ? {} : selector; - // Validate correctness off the selector - var object = selector; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("query selector raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - // Validate correctness of the field selector - var object = fields; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("query fields raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - // Check special case where we are using an objectId - if(selector instanceof ObjectID) { - selector = {_id:selector}; - } - - // If it's a serialized fields field we need to just let it through - // user be warned it better be good - if(options && options.fields && !(options.fields instanceof Buffer)) { - fields = {}; - - if(Array.isArray(options.fields)) { - if(!options.fields.length) { - fields['_id'] = 1; - } else { - for (var i = 0, l = options.fields.length; i < l; i++) { - fields[options.fields[i]] = 1; - } - } - } else { - fields = options.fields; - } - } - - if (!options) options = {}; - options.skip = len > 3 ? args[2] : options.skip ? options.skip : 0; - options.limit = len > 3 ? args[3] : options.limit ? options.limit : 0; - options.raw = options.raw != null && typeof options.raw === 'boolean' ? options.raw : this.raw; - options.hint = options.hint != null ? normalizeHintField(options.hint) : this.internalHint; - options.timeout = len == 5 ? args[4] : typeof options.timeout === 'undefined' ? undefined : options.timeout; - // If we have overridden slaveOk otherwise use the default db setting - options.slaveOk = options.slaveOk != null ? options.slaveOk : this.db.slaveOk; - var o = options; - - // callback for backward compatibility - if(callback) { - // TODO refactor Cursor args - callback(null, new Cursor(this.db, this, selector, fields, o.skip, o.limit - , o.sort, o.hint, o.explain, o.snapshot, o.timeout, o.tailable, o.batchSize - , o.slaveOk, o.raw, o.read, o.returnKey, o.maxScan, o.min, o.max, o.showDiskLoc, o.comment)); - } else { - return new Cursor(this.db, this, selector, fields, o.skip, o.limit - , o.sort, o.hint, o.explain, o.snapshot, o.timeout, o.tailable, o.batchSize - , o.slaveOk, o.raw, o.read, o.returnKey, o.maxScan, o.min, o.max, o.showDiskLoc, o.comment); - } -}; - -/** - * Normalizes a `hint` argument. - * - * @param {String|Object|Array} hint - * @return {Object} - * @api private - */ -var normalizeHintField = function normalizeHintField(hint) { - var finalHint = null; - - if (null != hint) { - switch (hint.constructor) { - case String: - finalHint = {}; - finalHint[hint] = 1; - break; - case Object: - finalHint = {}; - for (var name in hint) { - finalHint[name] = hint[name]; - } - break; - case Array: - finalHint = {}; - hint.forEach(function(param) { - finalHint[param] = 1; - }); - break; - } - } - - return finalHint; -}; - -/** - * Finds a single document based on the query - * - * Various argument possibilities - * - callback? - * - selector, callback?, - * - selector, fields, callback? - * - selector, options, callback? - * - selector, fields, options, callback? - * - selector, fields, skip, limit, callback? - * - selector, fields, skip, limit, timeout, callback? - * - * Options - * - **limit** {Number, default:0}, sets the limit of documents returned in the query. - * - **sort** {Array | Object}, set to sort the documents coming back from the query. Array of indexes, [['a', 1]] etc. - * - **fields** {Object}, the fields to return in the query. Object of fields to include or exclude (not both), {'a':1} - * - **skip** {Number, default:0}, set to skip N documents ahead in your query (useful for pagination). - * - **hint** {Object}, tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1} - * - **explain** {Boolean, default:false}, explain the query instead of returning the data. - * - **snapshot** {Boolean, default:false}, snapshot query. - * - **timeout** {Boolean, default:false}, specify if the cursor can timeout. - * - **tailable** {Boolean, default:false}, specify if the cursor is tailable. - * - **batchSize** {Number, default:0}, set the batchSize for the getMoreCommand when iterating over the query results. - * - **returnKey** {Boolean, default:false}, only return the index key. - * - **maxScan** {Number}, Limit the number of items to scan. - * - **min** {Number}, Set index bounds. - * - **max** {Number}, Set index bounds. - * - **showDiskLoc** {Boolean, default:false}, Show disk location of results. - * - **comment** {String}, You can put a $comment field on a query to make looking in the profiler logs simpler. - * - **raw** {Boolean, default:false}, Return all BSON documents as Raw Buffer documents. - * - **read** {Boolean, default:false}, Tell the query to read from a secondary server. - * - * @param {Object} query query object to locate the object to modify - * @param {Object} [options] additional options during update. - * @param {Function} [callback] optional callback for cursor. - * @return {Cursor} returns a cursor to the query - * @api public - */ -Collection.prototype.findOne = function findOne () { - var self = this; - var args = Array.prototype.slice.call(arguments, 0); - var callback = args.pop(); - var cursor = this.find.apply(this, args).limit(1).batchSize(1); - // Return the item - cursor.toArray(function(err, items) { - if(err != null) return callback(err instanceof Error ? err : self.db.wrap(new Error(err)), null); - if(items.length == 1) return callback(null, items[0]); - callback(null, null); - }); -}; - -/** - * Creates an index on the collection. - * - * Options - * - **unique** {Boolean, default:false}, creates an unique index. - * - **sparse** {Boolean, default:false}, creates a sparse index. - * - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. - * - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value - * - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. - * - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. - * - * @param {Object} fieldOrSpec fieldOrSpec that defines the index. - * @param {Object} [options] additional options during update. - * @param {Function} callback for results. - * @return {null} - * @api public - */ -Collection.prototype.createIndex = function createIndex (fieldOrSpec, options, callback) { - // Clean up call - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - // Execute create index - this.db.createIndex(this.collectionName, fieldOrSpec, options, callback); -}; - -/** - * Ensures that an index exists, if it does not it creates it - * - * Options - * - **unique** {Boolean, default:false}, creates an unique index. - * - **sparse** {Boolean, default:false}, creates a sparse index. - * - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. - * - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value - * - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. - * - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. - * - **v** {Number}, specify the format version of the indexes. - * - * @param {Object} fieldOrSpec fieldOrSpec that defines the index. - * @param {Object} [options] additional options during update. - * @param {Function} callback for results. - * @return {null} - * @api public - */ -Collection.prototype.ensureIndex = function ensureIndex (fieldOrSpec, options, callback) { - // Clean up call - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - // Execute create index - this.db.ensureIndex(this.collectionName, fieldOrSpec, options, callback); -}; - -/** - * Retrieves this collections index info. - * - * Options - * - **full** {Boolean, default:false}, returns the full raw index information. - * - * @param {Object} [options] additional options during update. - * @param {Function} callback returns the index information. - * @return {null} - * @api public - */ -Collection.prototype.indexInformation = function indexInformation (options, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - options = args.length ? args.shift() : {}; - // Call the index information - this.db.indexInformation(this.collectionName, options, callback); -}; - -/** - * Drops an index from this collection. - * - * @param {String} name - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Collection.prototype.dropIndex = function dropIndex (name, callback) { - this.db.dropIndex(this.collectionName, name, callback); -}; - -/** - * Drops all indexes from this collection. - * - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Collection.prototype.dropAllIndexes = function dropIndexes (callback) { - this.db.dropIndex(this.collectionName, '*', function (err, result) { - if(err != null) { - callback(err, false); - } else if(result.documents[0].errmsg == null) { - callback(null, true); - } else { - callback(new Error(result.documents[0].errmsg), false); - } - }); -}; - -/** - * Drops all indexes from this collection. - * - * @deprecated - * @param {Function} callback returns the results. - * @return {null} - * @api private - */ -Collection.prototype.dropIndexes = Collection.prototype.dropAllIndexes; - -/** - * Reindex all indexes on the collection - * Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections. - * - * @param {Function} callback returns the results. - * @return {null} - * @api public -**/ -Collection.prototype.reIndex = function(callback) { - this.db.reIndex(this.collectionName, callback); -} - -/** - * Run Map Reduce across a collection. - * - * Options - * - **out** {Object, default:*{inline:1}*}, sets the output target for the map reduce job. *{inline:1} | {replace:'collectionName'} | {merge:'collectionName'} | {reduce:'collectionName'}* - * - **query** {Object}, query filter object. - * - **sort** {Object}, sorts the input objects using this key. Useful for optimization, like sorting by the emit key for fewer reduces. - * - **limit** {Number}, number of objects to return from collection. - * - **keeptemp** {Boolean, default:false}, keep temporary data. - * - **finalize** {Function | String}, finalize function. - * - **scope** {Object}, can pass in variables that can be access from map/reduce/finalize. - * - **jsMode** {Boolean, default:false}, it is possible to make the execution stay in JS. Provided in MongoDB > 2.0.X. - * - **verbose** {Boolean, default:false}, provide statistics on job execution time. - * - * @param {Function|String} map the mapping function. - * @param {Function|String} reduce the reduce function. - * @param {Objects} [options] options for the map reduce job. - * @param {Function} callback returns the result of the map reduce job. - * @return {null} - * @api public - */ -Collection.prototype.mapReduce = function mapReduce (map, reduce, options, callback) { - if ('function' === typeof options) callback = options, options = {}; - // Out must allways be defined (make sure we don't break weirdly on pre 1.8+ servers) - if(null == options.out) { - throw new Error("the out option parameter must be defined, see mongodb docs for possible values"); - } - - if ('function' === typeof map) { - map = map.toString(); - } - - if ('function' === typeof reduce) { - reduce = reduce.toString(); - } - - if ('function' === typeof options.finalize) { - options.finalize = options.finalize.toString(); - } - - var mapCommandHash = { - mapreduce: this.collectionName - , map: map - , reduce: reduce - }; - - // Add any other options passed in - for (var name in options) { - mapCommandHash[name] = options[name]; - } - - var self = this; - var cmd = DbCommand.createDbSlaveOkCommand(this.db, mapCommandHash); - - this.db._executeQueryCommand(cmd, {read:true}, function (err, result) { - if (err) { - return callback(err); - } - - if (1 != result.documents[0].ok) { - return callback(result.documents[0]); - } - - // invoked with inline? - if (result.documents[0].results) { - return callback(null, result.documents[0].results); - } - - // Create a collection object that wraps the result collection - self.db.collection(result.documents[0].result, function (err, collection) { - if (!options.include_statistics) { - return callback(err, collection); - } - - var stats = { - processtime: result.documents[0].timeMillis - , counts: result.documents[0].counts - }; - - callback(err, collection, stats); - }); - }); -}; - -/** - * Group function helper - * @ignore - */ -var groupFunction = function () { - var c = db[ns].find(condition); - var map = new Map(); - var reduce_function = reduce; - - while (c.hasNext()) { - var obj = c.next(); - var key = {}; - - for (var i = 0, len = keys.length; i < len; ++i) { - var k = keys[i]; - key[k] = obj[k]; - } - - var aggObj = map.get(key); - - if (aggObj == null) { - var newObj = Object.extend({}, key); - aggObj = Object.extend(newObj, initial); - map.put(key, aggObj); - } - - reduce_function(obj, aggObj); - } - - return { "result": map.values() }; -}.toString(); - -/** - * Run a group command across a collection - * - * @param {Object|Array|Function|Code} keys an object, array or function expressing the keys to group by. - * @param {Object} condition an optional condition that must be true for a row to be considered. - * @param {Object} initial initial value of the aggregation counter object. - * @param {Function|Code} reduce the reduce function aggregates (reduces) the objects iterated - * @param {Function|Code} finalize an optional function to be run on each item in the result set just before the item is returned. - * @param {Boolean} command specify if you wish to run using the internal group command or using eval, default is true. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Collection.prototype.group = function group(keys, condition, initial, reduce, finalize, command, callback) { - var args = Array.prototype.slice.call(arguments, 3); - callback = args.pop(); - // Fetch all commands - reduce = args.length ? args.shift() : null; - finalize = args.length ? args.shift() : null; - command = args.length ? args.shift() : null; - - // Make sure we are backward compatible - if(!(typeof finalize == 'function')) { - command = finalize; - finalize = null; - } - - if (!Array.isArray(keys) && keys instanceof Object && typeof(keys) !== 'function') { - keys = Object.keys(keys); - } - - if(reduce instanceof Function) { - reduce = reduce.toString(); - } - - if(finalize instanceof Function) { - finalize = finalize.toString(); - } - - // Set up the command as default - command = command == null ? true : command; - - // Execute using the command - if(command) { - var reduceFunction = reduce instanceof Code - ? reduce - : new Code(reduce); - - var selector = { - group: { - 'ns': this.collectionName - , '$reduce': reduceFunction - , 'cond': condition - , 'initial': initial - , 'out': "inline" - } - }; - - // if finalize is defined - if(finalize != null) selector.group['finalize'] = finalize; - // Set up group selector - if ('function' === typeof keys) { - selector.group.$keyf = keys instanceof Code - ? keys - : new Code(keys); - } else { - var hash = {}; - keys.forEach(function (key) { - hash[key] = 1; - }); - selector.group.key = hash; - } - - var cmd = DbCommand.createDbSlaveOkCommand(this.db, selector); - - this.db._executeQueryCommand(cmd, {read:true}, function (err, result) { - if(err != null) return callback(err); - - var document = result.documents[0]; - if (null == document.retval) { - return callback(new Error("group command failed: " + document.errmsg)); - } - - callback(null, document.retval); - }); - - } else { - // Create execution scope - var scope = reduce != null && reduce instanceof Code - ? reduce.scope - : {}; - - scope.ns = this.collectionName; - scope.keys = keys; - scope.condition = condition; - scope.initial = initial; - - // Pass in the function text to execute within mongodb. - var groupfn = groupFunction.replace(/ reduce;/, reduce.toString() + ';'); - - this.db.eval(new Code(groupfn, scope), function (err, results) { - if (err) return callback(err, null); - callback(null, results.result || results); - }); - } -}; - -/** - * Returns the options of the collection. - * - * @param {Function} callback returns option results. - * @return {null} - * @api public - */ -Collection.prototype.options = function options(callback) { - this.db.collectionsInfo(this.collectionName, function (err, cursor) { - if (err) return callback(err); - cursor.nextObject(function (err, document) { - callback(err, document && document.options || null); - }); - }); -}; - -/** - * Returns if the collection is a capped collection - * - * @param {Function} callback returns if collection is capped. - * @return {null} - * @api public - */ -Collection.prototype.isCapped = function isCapped(callback) { - this.options(function(err, document) { - if(err != null) { - callback(err); - } else { - callback(null, document.capped); - } - }); -}; - -/** - * Checks if one or more indexes exist on the collection - * - * @param {String|Array} indexNames check if one or more indexes exist on the collection. - * @param {Function} callback returns if the indexes exist. - * @return {null} - * @api public - */ -Collection.prototype.indexExists = function indexExists(indexes, callback) { - this.indexInformation(function(err, indexInformation) { - // If we have an error return - if(err != null) return callback(err, null); - // Let's check for the index names - if(Array.isArray(indexes)) { - for(var i = 0; i < indexes.length; i++) { - if(indexInformation[indexes[i]] == null) { - return callback(null, false); - } - } - - // All keys found return true - return callback(null, true); - } else { - return callback(null, indexInformation[indexes] != null); - } - }); -} - -/** - * Execute the geoNear command to search for items in the collection - * - * Options - * - **num** {Number}, max number of results to return. - * - **maxDistance** {Number}, include results up to maxDistance from the point. - * - **distanceMultiplier** {Number}, include a value to multiply the distances with allowing for range conversions. - * - **query** {Object}, filter the results by a query. - * - **spherical** {Boolean, default:false}, perform query using a spherical model. - * - **uniqueDocs** {Boolean, default:false}, the closest location in a document to the center of the search region will always be returned MongoDB > 2.X. - * - **includeLocs** {Boolean, default:false}, include the location data fields in the top level of the results MongoDB > 2.X. - * - * @param {Number} x point to search on the x axis, ensure the indexes are ordered in the same order. - * @param {Number} y point to search on the y axis, ensure the indexes are ordered in the same order. - * @param {Objects} [options] options for the map reduce job. - * @param {Function} callback returns matching documents. - * @return {null} - * @api public - */ -Collection.prototype.geoNear = function geoNear(x, y, options, callback) { - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - // Fetch all commands - options = args.length ? args.shift() : {}; - - // Build command object - var commandObject = { - geoNear:this.collectionName, - near: [x, y] - } - - // Decorate object if any with known properties - if(options['num'] != null) commandObject['num'] = options['num']; - if(options['maxDistance'] != null) commandObject['maxDistance'] = options['maxDistance']; - if(options['distanceMultiplier'] != null) commandObject['distanceMultiplier'] = options['distanceMultiplier']; - if(options['query'] != null) commandObject['query'] = options['query']; - if(options['spherical'] != null) commandObject['spherical'] = options['spherical']; - if(options['uniqueDocs'] != null) commandObject['uniqueDocs'] = options['uniqueDocs']; - if(options['includeLocs'] != null) commandObject['includeLocs'] = options['includeLocs']; - - // Execute the command - this.db.command(commandObject, callback); -} - -/** - * Execute a geo search using a geo haystack index on a collection. - * - * Options - * - **maxDistance** {Number}, include results up to maxDistance from the point. - * - **search** {Object}, filter the results by a query. - * - **limit** {Number}, max number of results to return. - * - * @param {Number} x point to search on the x axis, ensure the indexes are ordered in the same order. - * @param {Number} y point to search on the y axis, ensure the indexes are ordered in the same order. - * @param {Objects} [options] options for the map reduce job. - * @param {Function} callback returns matching documents. - * @return {null} - * @api public - */ -Collection.prototype.geoHaystackSearch = function geoHaystackSearch(x, y, options, callback) { - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - // Fetch all commands - options = args.length ? args.shift() : {}; - - // Build command object - var commandObject = { - geoSearch:this.collectionName, - near: [x, y] - } - - // Decorate object if any with known properties - if(options['maxDistance'] != null) commandObject['maxDistance'] = options['maxDistance']; - if(options['query'] != null) commandObject['search'] = options['query']; - if(options['search'] != null) commandObject['search'] = options['search']; - if(options['limit'] != null) commandObject['limit'] = options['limit']; - - // Execute the command - this.db.command(commandObject, callback); -} - -/** - * Retrieve all the indexes on the collection. - * - * @param {Function} callback returns index information. - * @return {null} - * @api public - */ -Collection.prototype.indexes = function indexes(callback) { - // Return all the index information - this.db.indexInformation(this.collectionName, {full:true}, callback); -} - -/** - * Get all the collection statistics. - * - * Options - * - **scale** {Number}, divide the returned sizes by scale value. - * - * @param {Objects} [options] options for the map reduce job. - * @param {Function} callback returns statistical information for the collection. - * @return {null} - * @api public - */ -Collection.prototype.stats = function stats(options, callback) { - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - // Fetch all commands - options = args.length ? args.shift() : {}; - - // Build command object - var commandObject = { - collStats:this.collectionName, - } - - // Check if we have the scale value - if(options['scale'] != null) commandObject['scale'] = options['scale']; - - // Execute the command - this.db.command(commandObject, callback); -} - -/** - * Expose. - */ -exports.Collection = Collection; - - - - - - - - - - - - - diff --git a/lib/mongodb/commands/base_command.js b/lib/mongodb/commands/base_command.js deleted file mode 100644 index 0142671b954..00000000000 --- a/lib/mongodb/commands/base_command.js +++ /dev/null @@ -1,31 +0,0 @@ -var BinaryParser = require('../bson/binary_parser').BinaryParser, - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Base object used for common functionality -**/ -var BaseCommand = exports.BaseCommand = function() { -}; - -var id = 1; -BaseCommand.prototype.getRequestId = function() { - if (!this.requestId) this.requestId = id++; - return this.requestId; -}; - -BaseCommand.prototype.updateRequestId = function() { - this.requestId = id++; - return this.requestId; -}; - -// OpCodes -BaseCommand.OP_REPLY = 1; -BaseCommand.OP_MSG = 1000; -BaseCommand.OP_UPDATE = 2001; -BaseCommand.OP_INSERT = 2002; -BaseCommand.OP_GET_BY_OID = 2003; -BaseCommand.OP_QUERY = 2004; -BaseCommand.OP_GET_MORE = 2005; -BaseCommand.OP_DELETE = 2006; -BaseCommand.OP_KILL_CURSORS = 2007; \ No newline at end of file diff --git a/lib/mongodb/commands/db_command.js b/lib/mongodb/commands/db_command.js deleted file mode 100644 index ce50e97bc40..00000000000 --- a/lib/mongodb/commands/db_command.js +++ /dev/null @@ -1,207 +0,0 @@ -var QueryCommand = require('./query_command').QueryCommand, - InsertCommand = require('./insert_command').InsertCommand, - inherits = require('util').inherits, - debug = require('util').debug, - crypto = require('crypto'), - inspect = require('util').inspect; - -/** - Db Command -**/ -var DbCommand = exports.DbCommand = function(dbInstance, collectionName, queryOptions, numberToSkip, numberToReturn, query, returnFieldSelector, options) { - QueryCommand.call(this); - this.collectionName = collectionName; - this.queryOptions = queryOptions; - this.numberToSkip = numberToSkip; - this.numberToReturn = numberToReturn; - this.query = query; - this.returnFieldSelector = returnFieldSelector; - this.db = dbInstance; - - // Make sure we don't get a null exception - options = options == null ? {} : options; - // Let us defined on a command basis if we want functions to be serialized or not - if(options['serializeFunctions'] != null && options['serializeFunctions']) { - this.serializeFunctions = true; - } -}; - -inherits(DbCommand, QueryCommand); - -// Constants -DbCommand.SYSTEM_NAMESPACE_COLLECTION = "system.namespaces"; -DbCommand.SYSTEM_INDEX_COLLECTION = "system.indexes"; -DbCommand.SYSTEM_PROFILE_COLLECTION = "system.profile"; -DbCommand.SYSTEM_USER_COLLECTION = "system.users"; -DbCommand.SYSTEM_COMMAND_COLLECTION = "$cmd"; - -// New commands -DbCommand.NcreateIsMasterCommand = function(db, databaseName) { - return new DbCommand(db, databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'ismaster':1}, null); -}; - -// Provide constructors for different db commands -DbCommand.createIsMasterCommand = function(db) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'ismaster':1}, null); -}; - -DbCommand.createCollectionInfoCommand = function(db, selector) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_NAMESPACE_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, 0, selector, null); -}; - -DbCommand.createGetNonceCommand = function(db) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'getnonce':1}, null); -}; - -DbCommand.createAuthenticationCommand = function(db, username, password, nonce) { - // Use node md5 generator - var md5 = crypto.createHash('md5'); - // Generate keys used for authentication - md5.update(username + ":mongo:" + password); - var hash_password = md5.digest('hex'); - // Final key - md5 = crypto.createHash('md5'); - md5.update(nonce + username + hash_password); - var key = md5.digest('hex'); - // Creat selector - var selector = {'authenticate':1, 'user':username, 'nonce':nonce, 'key':key}; - // Create db command - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NONE, 0, -1, selector, null); -}; - -DbCommand.createLogoutCommand = function(db) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'logout':1}, null); -}; - -DbCommand.createCreateCollectionCommand = function(db, collectionName, options) { - var selector = {'create':collectionName}; - // Modify the options to ensure correct behaviour - for(var name in options) { - if(options[name] != null && options[name].constructor != Function) selector[name] = options[name]; - } - // Execute the command - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, selector, null); -}; - -DbCommand.createDropCollectionCommand = function(db, collectionName) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'drop':collectionName}, null); -}; - -DbCommand.createRenameCollectionCommand = function(db, fromCollectionName, toCollectionName) { - var renameCollection = db.databaseName + "." + fromCollectionName; - var toCollection = db.databaseName + "." + toCollectionName; - return new DbCommand(db, "admin." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'renameCollection':renameCollection, 'to':toCollection}, null); -}; - -DbCommand.createGetLastErrorCommand = function(options, db) { - var args = Array.prototype.slice.call(arguments, 0); - db = args.pop(); - options = args.length ? args.shift() : {}; - // Final command - var command = {'getlasterror':1}; - // If we have an options Object let's merge in the fields (fsync/wtimeout/w) - if('object' === typeof options) { - for(var name in options) { - command[name] = options[name] - } - } - - // Execute command - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, command, null); -}; - -DbCommand.createGetLastStatusCommand = DbCommand.createGetLastErrorCommand; - -DbCommand.createGetPreviousErrorsCommand = function(db) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'getpreverror':1}, null); -}; - -DbCommand.createResetErrorHistoryCommand = function(db) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'reseterror':1}, null); -}; - -DbCommand.createCreateIndexCommand = function(db, collectionName, fieldOrSpec, options) { - var fieldHash = {}; - var indexes = []; - var keys; - - // Get all the fields accordingly - if (fieldOrSpec.constructor === String) { // 'type' - indexes.push(fieldOrSpec + '_' + 1); - fieldHash[fieldOrSpec] = 1; - } else if (fieldOrSpec.constructor === Array) { // [{location:'2d'}, ...] - fieldOrSpec.forEach(function(f) { - if (f.constructor === String) { // [{location:'2d'}, 'type'] - indexes.push(f + '_' + 1); - fieldHash[f] = 1; - } else if (f.constructor === Array) { // [['location', '2d'],['type', 1]] - indexes.push(f[0] + '_' + (f[1] || 1)); - fieldHash[f[0]] = f[1] || 1; - } else if (f.constructor === Object) { // [{location:'2d'}, {type:1}] - keys = Object.keys(f); - keys.forEach(function(k) { - indexes.push(k + '_' + f[k]); - fieldHash[k] = f[k]; - }); - } else { - // undefined - } - }); - } else if (fieldOrSpec.constructor === Object) { // {location:'2d', type:1} - keys = Object.keys(fieldOrSpec); - keys.forEach(function(key) { - indexes.push(key + '_' + fieldOrSpec[key]); - fieldHash[key] = fieldOrSpec[key]; - }); - } - - // Generate the index name - var indexName = indexes.join("_"); - // Build the selector - var selector = {'ns':(db.databaseName + "." + collectionName), 'key':fieldHash, 'name':indexName}; - - // Ensure we have a correct finalUnique - var finalUnique = options == null || 'object' === typeof options ? false : options; - // Set up options - options = options == null || typeof options == 'boolean' ? {} : options; - - // Add all the options - var keys = Object.keys(options); - // Add all the fields to the selector - for(var i = 0; i < keys.length; i++) { - selector[keys[i]] = options[keys[i]]; - } - - // If we don't have the unique property set on the selector - if(selector['unique'] == null) selector['unique'] = finalUnique; - // Create the insert command for the index and return the document - return new InsertCommand(db, db.databaseName + "." + DbCommand.SYSTEM_INDEX_COLLECTION, false).add(selector); -}; - -DbCommand.logoutCommand = function(db, command_hash) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, command_hash, null); -} - -DbCommand.createDropIndexCommand = function(db, collectionName, indexName) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'deleteIndexes':collectionName, 'index':indexName}, null); -}; - -DbCommand.createReIndexCommand = function(db, collectionName) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'reIndex':collectionName}, null); -}; - -DbCommand.createDropDatabaseCommand = function(db) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, {'dropDatabase':1}, null); -}; - -DbCommand.createDbCommand = function(db, command_hash, options) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, command_hash, null, options); -}; - -DbCommand.createAdminDbCommand = function(db, command_hash) { - return new DbCommand(db, "admin." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT, 0, -1, command_hash, null); -}; - -DbCommand.createDbSlaveOkCommand = function(db, command_hash, options) { - return new DbCommand(db, db.databaseName + "." + DbCommand.SYSTEM_COMMAND_COLLECTION, QueryCommand.OPTS_NO_CURSOR_TIMEOUT | QueryCommand.OPTS_SLAVE, 0, -1, command_hash, null, options); -}; diff --git a/lib/mongodb/commands/delete_command.js b/lib/mongodb/commands/delete_command.js deleted file mode 100644 index c4b7a70ecbb..00000000000 --- a/lib/mongodb/commands/delete_command.js +++ /dev/null @@ -1,113 +0,0 @@ -var BaseCommand = require('./base_command').BaseCommand, - inherits = require('util').inherits, - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Insert Document Command -**/ -var DeleteCommand = exports.DeleteCommand = function(db, collectionName, selector) { - BaseCommand.call(this); - - // Validate correctness off the selector - var object = selector; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("delete raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - this.collectionName = collectionName; - this.selector = selector; - this.db = db; -}; - -inherits(DeleteCommand, BaseCommand); - -DeleteCommand.OP_DELETE = 2006; - -/* -struct { - MsgHeader header; // standard message header - int32 ZERO; // 0 - reserved for future use - cstring fullCollectionName; // "dbname.collectionname" - int32 ZERO; // 0 - reserved for future use - mongo.BSON selector; // query object. See below for details. -} -*/ -DeleteCommand.prototype.toBinary = function() { - // Calculate total length of the document - var totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + 4 + this.db.bson.calculateObjectSize(this.selector) + (4 * 4); - // Let's build the single pass buffer command - var _index = 0; - var _command = new Buffer(totalLengthOfCommand); - // Write the header information to the buffer - _command[_index + 3] = (totalLengthOfCommand >> 24) & 0xff; - _command[_index + 2] = (totalLengthOfCommand >> 16) & 0xff; - _command[_index + 1] = (totalLengthOfCommand >> 8) & 0xff; - _command[_index] = totalLengthOfCommand & 0xff; - // Adjust index - _index = _index + 4; - // Write the request ID - _command[_index + 3] = (this.requestId >> 24) & 0xff; - _command[_index + 2] = (this.requestId >> 16) & 0xff; - _command[_index + 1] = (this.requestId >> 8) & 0xff; - _command[_index] = this.requestId & 0xff; - // Adjust index - _index = _index + 4; - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - // Write the op_code for the command - _command[_index + 3] = (DeleteCommand.OP_DELETE >> 24) & 0xff; - _command[_index + 2] = (DeleteCommand.OP_DELETE >> 16) & 0xff; - _command[_index + 1] = (DeleteCommand.OP_DELETE >> 8) & 0xff; - _command[_index] = DeleteCommand.OP_DELETE & 0xff; - // Adjust index - _index = _index + 4; - - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - - // Write the collection name to the command - _index = _index + _command.write(this.collectionName, _index, 'utf8') + 1; - _command[_index - 1] = 0; - - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - - // Document binary length - var documentLength = 0 - - // Serialize the selector - // If we are passing a raw buffer, do minimal validation - if(this.selector instanceof Buffer) { - documentLength = this.selector.length; - // Copy the data into the current buffer - this.selector.copy(_command, _index); - } else { - documentLength = this.db.bson.serializeWithBufferAndIndex(this.selector, this.checkKeys, _command, _index) - _index + 1; - } - - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - return _command; -}; \ No newline at end of file diff --git a/lib/mongodb/commands/get_more_command.js b/lib/mongodb/commands/get_more_command.js deleted file mode 100644 index 03856308f37..00000000000 --- a/lib/mongodb/commands/get_more_command.js +++ /dev/null @@ -1,85 +0,0 @@ -var BaseCommand = require('./base_command').BaseCommand, - inherits = require('util').inherits, - debug = require('util').debug, - inspect = require('util').inspect, - binaryutils = require('../bson/binary_utils'); - -/** - Get More Document Command -**/ -var GetMoreCommand = exports.GetMoreCommand = function(db, collectionName, numberToReturn, cursorId) { - BaseCommand.call(this); - - this.collectionName = collectionName; - this.numberToReturn = numberToReturn; - this.cursorId = cursorId; - this.db = db; -}; - -inherits(GetMoreCommand, BaseCommand); - -GetMoreCommand.OP_GET_MORE = 2005; - -GetMoreCommand.prototype.toBinary = function() { - // Calculate total length of the document - var totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + 4 + 8 + (4 * 4); - // Let's build the single pass buffer command - var _index = 0; - var _command = new Buffer(totalLengthOfCommand); - // Write the header information to the buffer - _command[_index++] = totalLengthOfCommand & 0xff; - _command[_index++] = (totalLengthOfCommand >> 8) & 0xff; - _command[_index++] = (totalLengthOfCommand >> 16) & 0xff; - _command[_index++] = (totalLengthOfCommand >> 24) & 0xff; - - // Write the request ID - _command[_index++] = this.requestId & 0xff; - _command[_index++] = (this.requestId >> 8) & 0xff; - _command[_index++] = (this.requestId >> 16) & 0xff; - _command[_index++] = (this.requestId >> 24) & 0xff; - - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - - // Write the op_code for the command - _command[_index++] = GetMoreCommand.OP_GET_MORE & 0xff; - _command[_index++] = (GetMoreCommand.OP_GET_MORE >> 8) & 0xff; - _command[_index++] = (GetMoreCommand.OP_GET_MORE >> 16) & 0xff; - _command[_index++] = (GetMoreCommand.OP_GET_MORE >> 24) & 0xff; - - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - - // Write the collection name to the command - _index = _index + _command.write(this.collectionName, _index, 'utf8') + 1; - _command[_index - 1] = 0; - - // Number of documents to return - _command[_index++] = this.numberToReturn & 0xff; - _command[_index++] = (this.numberToReturn >> 8) & 0xff; - _command[_index++] = (this.numberToReturn >> 16) & 0xff; - _command[_index++] = (this.numberToReturn >> 24) & 0xff; - - // Encode the cursor id - var low_bits = this.cursorId.getLowBits(); - // Encode low bits - _command[_index++] = low_bits & 0xff; - _command[_index++] = (low_bits >> 8) & 0xff; - _command[_index++] = (low_bits >> 16) & 0xff; - _command[_index++] = (low_bits >> 24) & 0xff; - - var high_bits = this.cursorId.getHighBits(); - // Encode high bits - _command[_index++] = high_bits & 0xff; - _command[_index++] = (high_bits >> 8) & 0xff; - _command[_index++] = (high_bits >> 16) & 0xff; - _command[_index++] = (high_bits >> 24) & 0xff; - // Return command - return _command; -}; \ No newline at end of file diff --git a/lib/mongodb/commands/insert_command.js b/lib/mongodb/commands/insert_command.js deleted file mode 100644 index b32ca888437..00000000000 --- a/lib/mongodb/commands/insert_command.js +++ /dev/null @@ -1,143 +0,0 @@ -var BaseCommand = require('./base_command').BaseCommand, - inherits = require('util').inherits, - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Insert Document Command -**/ -var InsertCommand = exports.InsertCommand = function(db, collectionName, checkKeys, options) { - BaseCommand.call(this); - - this.collectionName = collectionName; - this.documents = []; - this.checkKeys = checkKeys == null ? true : checkKeys; - this.db = db; - this.flags = 0; - this.serializeFunctions = false; - - // Ensure valid options hash - options = options == null ? {} : options; - - // Check if we have keepGoing set -> set flag if it's the case - if(options['keepGoing'] != null && options['keepGoing']) { - // This will finish inserting all non-index violating documents even if it returns an error - this.flags = 1; - } - - // Let us defined on a command basis if we want functions to be serialized or not - if(options['serializeFunctions'] != null && options['serializeFunctions']) { - this.serializeFunctions = true; - } -}; - -inherits(InsertCommand, BaseCommand); - -// OpCodes -InsertCommand.OP_INSERT = 2002; - -InsertCommand.prototype.add = function(document) { - if(document instanceof Buffer) { - var object_size = document[0] | document[1] << 8 | document[2] << 16 | document[3] << 24; - if(object_size != document.length) { - var error = new Error("insert raw message size does not match message header size [" + document.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - this.documents.push(document); - return this; -}; - -/* -struct { - MsgHeader header; // standard message header - int32 ZERO; // 0 - reserved for future use - cstring fullCollectionName; // "dbname.collectionname" - BSON[] documents; // one or more documents to insert into the collection -} -*/ -InsertCommand.prototype.toBinary = function() { - // Calculate total length of the document - var totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + (4 * 4); - // var docLength = 0 - for(var i = 0; i < this.documents.length; i++) { - if(this.documents[i] instanceof Buffer) { - totalLengthOfCommand += this.documents[i].length; - } else { - // Calculate size of document - totalLengthOfCommand += this.db.bson.calculateObjectSize(this.documents[i], this.serializeFunctions); - } - } - - // Let's build the single pass buffer command - var _index = 0; - var _command = new Buffer(totalLengthOfCommand); - // Write the header information to the buffer - _command[_index + 3] = (totalLengthOfCommand >> 24) & 0xff; - _command[_index + 2] = (totalLengthOfCommand >> 16) & 0xff; - _command[_index + 1] = (totalLengthOfCommand >> 8) & 0xff; - _command[_index] = totalLengthOfCommand & 0xff; - // Adjust index - _index = _index + 4; - // Write the request ID - _command[_index + 3] = (this.requestId >> 24) & 0xff; - _command[_index + 2] = (this.requestId >> 16) & 0xff; - _command[_index + 1] = (this.requestId >> 8) & 0xff; - _command[_index] = this.requestId & 0xff; - // Adjust index - _index = _index + 4; - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - // Write the op_code for the command - _command[_index + 3] = (InsertCommand.OP_INSERT >> 24) & 0xff; - _command[_index + 2] = (InsertCommand.OP_INSERT >> 16) & 0xff; - _command[_index + 1] = (InsertCommand.OP_INSERT >> 8) & 0xff; - _command[_index] = InsertCommand.OP_INSERT & 0xff; - // Adjust index - _index = _index + 4; - // Write flags if any - _command[_index + 3] = (this.flags >> 24) & 0xff; - _command[_index + 2] = (this.flags >> 16) & 0xff; - _command[_index + 1] = (this.flags >> 8) & 0xff; - _command[_index] = this.flags & 0xff; - // Adjust index - _index = _index + 4; - // Write the collection name to the command - _index = _index + _command.write(this.collectionName, _index, 'utf8') + 1; - _command[_index - 1] = 0; - - // Write all the bson documents to the buffer at the index offset - for(var i = 0; i < this.documents.length; i++) { - // Document binary length - var documentLength = 0 - var object = this.documents[i]; - - // Serialize the selector - // If we are passing a raw buffer, do minimal validation - if(object instanceof Buffer) { - documentLength = object.length; - // Copy the data into the current buffer - object.copy(_command, _index); - } else { - // Serialize the document straight to the buffer - documentLength = this.db.bson.serializeWithBufferAndIndex(object, this.checkKeys, _command, _index, this.serializeFunctions) - _index + 1; - } - - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - } - - return _command; -}; diff --git a/lib/mongodb/commands/kill_cursor_command.js b/lib/mongodb/commands/kill_cursor_command.js deleted file mode 100644 index 9778848a279..00000000000 --- a/lib/mongodb/commands/kill_cursor_command.js +++ /dev/null @@ -1,100 +0,0 @@ -var BaseCommand = require('./base_command').BaseCommand, - inherits = require('util').inherits, - binaryutils = require('../bson/binary_utils'), - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Insert Document Command -**/ -var KillCursorCommand = exports.KillCursorCommand = function(db, cursorIds) { - BaseCommand.call(this); - - this.cursorIds = cursorIds; - this.db = db; -}; - -inherits(KillCursorCommand, BaseCommand); - -KillCursorCommand.OP_KILL_CURSORS = 2007; - -/* -struct { - MsgHeader header; // standard message header - int32 ZERO; // 0 - reserved for future use - int32 numberOfCursorIDs; // number of cursorIDs in message - int64[] cursorIDs; // array of cursorIDs to close -} -*/ -KillCursorCommand.prototype.toBinary = function() { - // Calculate total length of the document - var totalLengthOfCommand = 4 + 4 + (4 * 4) + (this.cursorIds.length * 8); - // Let's build the single pass buffer command - var _index = 0; - var _command = new Buffer(totalLengthOfCommand); - // Write the header information to the buffer - _command[_index + 3] = (totalLengthOfCommand >> 24) & 0xff; - _command[_index + 2] = (totalLengthOfCommand >> 16) & 0xff; - _command[_index + 1] = (totalLengthOfCommand >> 8) & 0xff; - _command[_index] = totalLengthOfCommand & 0xff; - // Adjust index - _index = _index + 4; - // Write the request ID - _command[_index + 3] = (this.requestId >> 24) & 0xff; - _command[_index + 2] = (this.requestId >> 16) & 0xff; - _command[_index + 1] = (this.requestId >> 8) & 0xff; - _command[_index] = this.requestId & 0xff; - // Adjust index - _index = _index + 4; - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - // Write the op_code for the command - _command[_index + 3] = (KillCursorCommand.OP_KILL_CURSORS >> 24) & 0xff; - _command[_index + 2] = (KillCursorCommand.OP_KILL_CURSORS >> 16) & 0xff; - _command[_index + 1] = (KillCursorCommand.OP_KILL_CURSORS >> 8) & 0xff; - _command[_index] = KillCursorCommand.OP_KILL_CURSORS & 0xff; - // Adjust index - _index = _index + 4; - - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - - // Number of cursors to kill - var numberOfCursors = this.cursorIds.length; - _command[_index + 3] = (numberOfCursors >> 24) & 0xff; - _command[_index + 2] = (numberOfCursors >> 16) & 0xff; - _command[_index + 1] = (numberOfCursors >> 8) & 0xff; - _command[_index] = numberOfCursors & 0xff; - // Adjust index - _index = _index + 4; - - // Encode all the cursors - for(var i = 0; i < this.cursorIds.length; i++) { - // Encode the cursor id - var low_bits = this.cursorIds[i].getLowBits(); - // Encode low bits - _command[_index + 3] = (low_bits >> 24) & 0xff; - _command[_index + 2] = (low_bits >> 16) & 0xff; - _command[_index + 1] = (low_bits >> 8) & 0xff; - _command[_index] = low_bits & 0xff; - // Adjust index - _index = _index + 4; - - var high_bits = this.cursorIds[i].getHighBits(); - // Encode high bits - _command[_index + 3] = (high_bits >> 24) & 0xff; - _command[_index + 2] = (high_bits >> 16) & 0xff; - _command[_index + 1] = (high_bits >> 8) & 0xff; - _command[_index] = high_bits & 0xff; - // Adjust index - _index = _index + 4; - } - - return _command; -}; \ No newline at end of file diff --git a/lib/mongodb/commands/query_command.js b/lib/mongodb/commands/query_command.js deleted file mode 100644 index a44d8a2430a..00000000000 --- a/lib/mongodb/commands/query_command.js +++ /dev/null @@ -1,212 +0,0 @@ -var BaseCommand = require('./base_command').BaseCommand, - BinaryParser = require('../bson/binary_parser').BinaryParser, - inherits = require('util').inherits, - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Insert Document Command -**/ -var QueryCommand = exports.QueryCommand = function(db, collectionName, queryOptions, numberToSkip, numberToReturn, query, returnFieldSelector, options) { - BaseCommand.call(this); - - // Validate correctness off the selector - var object = query; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("query selector raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - var object = returnFieldSelector; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("query fields raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - // Make sure we don't get a null exception - options = options == null ? {} : options; - // Set up options - this.collectionName = collectionName; - this.queryOptions = queryOptions; - this.numberToSkip = numberToSkip; - this.numberToReturn = numberToReturn; - this.query = query; - this.returnFieldSelector = returnFieldSelector; - this.db = db; - - // Let us defined on a command basis if we want functions to be serialized or not - if(options['serializeFunctions'] != null && options['serializeFunctions']) { - this.serializeFunctions = true; - } -}; - -inherits(QueryCommand, BaseCommand); - -QueryCommand.OP_QUERY = 2004; - -/* -struct { - MsgHeader header; // standard message header - int32 opts; // query options. See below for details. - cstring fullCollectionName; // "dbname.collectionname" - int32 numberToSkip; // number of documents to skip when returning results - int32 numberToReturn; // number of documents to return in the first OP_REPLY - BSON query ; // query object. See below for details. - [ BSON returnFieldSelector; ] // OPTIONAL : selector indicating the fields to return. See below for details. -} -*/ -QueryCommand.prototype.toBinary = function() { - var totalLengthOfCommand = 0; - // Calculate total length of the document - if(this.query instanceof Buffer) { - totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + 4 + 4 + this.query.length + (4 * 4); - } else { - totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + 4 + 4 + this.db.bson.calculateObjectSize(this.query, this.serializeFunctions) + (4 * 4); - } - - // Calculate extra fields size - if(this.returnFieldSelector != null && !(this.returnFieldSelector instanceof Buffer)) { - if(Object.keys(this.returnFieldSelector).length > 0) { - totalLengthOfCommand += this.db.bson.calculateObjectSize(this.returnFieldSelector, this.serializeFunctions); - } - } else if(this.returnFieldSelector instanceof Buffer) { - totalLengthOfCommand += this.returnFieldSelector.length; - } - - // Let's build the single pass buffer command - var _index = 0; - var _command = new Buffer(totalLengthOfCommand); - // Write the header information to the buffer - _command[_index + 3] = (totalLengthOfCommand >> 24) & 0xff; - _command[_index + 2] = (totalLengthOfCommand >> 16) & 0xff; - _command[_index + 1] = (totalLengthOfCommand >> 8) & 0xff; - _command[_index] = totalLengthOfCommand & 0xff; - // Adjust index - _index = _index + 4; - // Write the request ID - _command[_index + 3] = (this.requestId >> 24) & 0xff; - _command[_index + 2] = (this.requestId >> 16) & 0xff; - _command[_index + 1] = (this.requestId >> 8) & 0xff; - _command[_index] = this.requestId & 0xff; - // Adjust index - _index = _index + 4; - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - // Write the op_code for the command - _command[_index + 3] = (QueryCommand.OP_QUERY >> 24) & 0xff; - _command[_index + 2] = (QueryCommand.OP_QUERY >> 16) & 0xff; - _command[_index + 1] = (QueryCommand.OP_QUERY >> 8) & 0xff; - _command[_index] = QueryCommand.OP_QUERY & 0xff; - // Adjust index - _index = _index + 4; - - // Write the query options - _command[_index + 3] = (this.queryOptions >> 24) & 0xff; - _command[_index + 2] = (this.queryOptions >> 16) & 0xff; - _command[_index + 1] = (this.queryOptions >> 8) & 0xff; - _command[_index] = this.queryOptions & 0xff; - // Adjust index - _index = _index + 4; - - // Write the collection name to the command - _index = _index + _command.write(this.collectionName, _index, 'utf8') + 1; - _command[_index - 1] = 0; - - // Write the number of documents to skip - _command[_index + 3] = (this.numberToSkip >> 24) & 0xff; - _command[_index + 2] = (this.numberToSkip >> 16) & 0xff; - _command[_index + 1] = (this.numberToSkip >> 8) & 0xff; - _command[_index] = this.numberToSkip & 0xff; - // Adjust index - _index = _index + 4; - - // Write the number of documents to return - _command[_index + 3] = (this.numberToReturn >> 24) & 0xff; - _command[_index + 2] = (this.numberToReturn >> 16) & 0xff; - _command[_index + 1] = (this.numberToReturn >> 8) & 0xff; - _command[_index] = this.numberToReturn & 0xff; - // Adjust index - _index = _index + 4; - - // Document binary length - var documentLength = 0 - var object = this.query; - - // Serialize the selector - if(object instanceof Buffer) { - documentLength = object.length; - // Copy the data into the current buffer - object.copy(_command, _index); - } else { - // Serialize the document straight to the buffer - documentLength = this.db.bson.serializeWithBufferAndIndex(object, this.checkKeys, _command, _index, this.serializeFunctions) - _index + 1; - } - - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - - // Push field selector if available - if(this.returnFieldSelector != null && !(this.returnFieldSelector instanceof Buffer)) { - if(Object.keys(this.returnFieldSelector).length > 0) { - var documentLength = this.db.bson.serializeWithBufferAndIndex(this.returnFieldSelector, this.checkKeys, _command, _index, this.serializeFunctions) - _index + 1; - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - } - } if(this.returnFieldSelector != null && this.returnFieldSelector instanceof Buffer) { - // Document binary length - var documentLength = 0 - var object = this.returnFieldSelector; - - // Serialize the selector - documentLength = object.length; - // Copy the data into the current buffer - object.copy(_command, _index); - - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - } - - // Return finished command - return _command; -}; - -// Constants -QueryCommand.OPTS_NONE = 0; -QueryCommand.OPTS_TAILABLE_CURSOR = 2; -QueryCommand.OPTS_SLAVE = 4; -QueryCommand.OPTS_OPLOG_REPLY = 8; -QueryCommand.OPTS_NO_CURSOR_TIMEOUT = 16; -QueryCommand.OPTS_AWAIT_DATA = 32; -QueryCommand.OPTS_EXHAUST = 64; \ No newline at end of file diff --git a/lib/mongodb/commands/update_command.js b/lib/mongodb/commands/update_command.js deleted file mode 100644 index 83684d9e858..00000000000 --- a/lib/mongodb/commands/update_command.js +++ /dev/null @@ -1,176 +0,0 @@ -var BaseCommand = require('./base_command').BaseCommand, - inherits = require('util').inherits, - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Update Document Command -**/ -var UpdateCommand = exports.UpdateCommand = function(db, collectionName, spec, document, options) { - BaseCommand.call(this); - - var object = spec; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("update spec raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - var object = document; - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) { - var error = new Error("update document raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - error.name = 'MongoError'; - throw error; - } - } - - this.collectionName = collectionName; - this.spec = spec; - this.document = document; - this.db = db; - this.serializeFunctions = false; - - // Generate correct flags - var db_upsert = 0; - var db_multi_update = 0; - db_upsert = options != null && options['upsert'] != null ? (options['upsert'] == true ? 1 : 0) : db_upsert; - db_multi_update = options != null && options['multi'] != null ? (options['multi'] == true ? 1 : 0) : db_multi_update; - - // Flags - this.flags = parseInt(db_multi_update.toString() + db_upsert.toString(), 2); - // Let us defined on a command basis if we want functions to be serialized or not - if(options['serializeFunctions'] != null && options['serializeFunctions']) { - this.serializeFunctions = true; - } -}; - -inherits(UpdateCommand, BaseCommand); - -UpdateCommand.OP_UPDATE = 2001; - -/* -struct { - MsgHeader header; // standard message header - int32 ZERO; // 0 - reserved for future use - cstring fullCollectionName; // "dbname.collectionname" - int32 flags; // bit vector. see below - BSON spec; // the query to select the document - BSON document; // the document data to update with or insert -} -*/ -UpdateCommand.prototype.toBinary = function() { - // Calculate total length of the document - var totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + 4 + this.db.bson.calculateObjectSize(this.spec, false) + - this.db.bson.calculateObjectSize(this.document, this.serializeFunctions) + (4 * 4); - - // Let's build the single pass buffer command - var _index = 0; - var _command = new Buffer(totalLengthOfCommand); - // Write the header information to the buffer - _command[_index + 3] = (totalLengthOfCommand >> 24) & 0xff; - _command[_index + 2] = (totalLengthOfCommand >> 16) & 0xff; - _command[_index + 1] = (totalLengthOfCommand >> 8) & 0xff; - _command[_index] = totalLengthOfCommand & 0xff; - // Adjust index - _index = _index + 4; - // Write the request ID - _command[_index + 3] = (this.requestId >> 24) & 0xff; - _command[_index + 2] = (this.requestId >> 16) & 0xff; - _command[_index + 1] = (this.requestId >> 8) & 0xff; - _command[_index] = this.requestId & 0xff; - // Adjust index - _index = _index + 4; - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - // Write the op_code for the command - _command[_index + 3] = (UpdateCommand.OP_UPDATE >> 24) & 0xff; - _command[_index + 2] = (UpdateCommand.OP_UPDATE >> 16) & 0xff; - _command[_index + 1] = (UpdateCommand.OP_UPDATE >> 8) & 0xff; - _command[_index] = UpdateCommand.OP_UPDATE & 0xff; - // Adjust index - _index = _index + 4; - - // Write zero - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - _command[_index++] = 0; - - // Write the collection name to the command - _index = _index + _command.write(this.collectionName, _index, 'utf8') + 1; - _command[_index - 1] = 0; - - // Write the update flags - _command[_index + 3] = (this.flags >> 24) & 0xff; - _command[_index + 2] = (this.flags >> 16) & 0xff; - _command[_index + 1] = (this.flags >> 8) & 0xff; - _command[_index] = this.flags & 0xff; - // Adjust index - _index = _index + 4; - - // Document binary length - var documentLength = 0 - var object = this.spec; - - // Serialize the selector - // If we are passing a raw buffer, do minimal validation - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) throw new Error("raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - documentLength = object.length; - // Copy the data into the current buffer - object.copy(_command, _index); - } else { - documentLength = this.db.bson.serializeWithBufferAndIndex(object, this.checkKeys, _command, _index, false) - _index + 1; - } - - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - - // Document binary length - var documentLength = 0 - var object = this.document; - - // Serialize the document - // If we are passing a raw buffer, do minimal validation - if(object instanceof Buffer) { - var object_size = object[0] | object[1] << 8 | object[2] << 16 | object[3] << 24; - if(object_size != object.length) throw new Error("raw message size does not match message header size [" + object.length + "] != [" + object_size + "]"); - documentLength = object.length; - // Copy the data into the current buffer - object.copy(_command, _index); - } else { - documentLength = this.db.bson.serializeWithBufferAndIndex(object, this.checkKeys, _command, _index, this.serializeFunctions) - _index + 1; - } - - // Write the length to the document - _command[_index + 3] = (documentLength >> 24) & 0xff; - _command[_index + 2] = (documentLength >> 16) & 0xff; - _command[_index + 1] = (documentLength >> 8) & 0xff; - _command[_index] = documentLength & 0xff; - // Update index in buffer - _index = _index + documentLength; - // Add terminating 0 for the object - _command[_index - 1] = 0; - - return _command; -}; - -// Constants -UpdateCommand.DB_UPSERT = 0; -UpdateCommand.DB_MULTI_UPDATE = 1; \ No newline at end of file diff --git a/lib/mongodb/connection/connection.js b/lib/mongodb/connection/connection.js deleted file mode 100644 index 0c549c2b329..00000000000 --- a/lib/mongodb/connection/connection.js +++ /dev/null @@ -1,417 +0,0 @@ -var utils = require('./connection_utils'), - inherits = require('util').inherits, - net = require('net'), - debug = require('util').debug, - inspect = require('util').inspect, - EventEmitter = require('events').EventEmitter, - inherits = require('util').inherits, - binaryutils = require('../bson/binary_utils'), - tls = require('tls'); - -var Connection = exports.Connection = function(id, socketOptions) { - // Set up event emitter - EventEmitter.call(this); - // Store all socket options - this.socketOptions = socketOptions ? socketOptions : {host:'localhost', port:27017}; - // Id for the connection - this.id = id; - // State of the connection - this.connected = false; - - // - // Connection parsing state - // - this.maxBsonSize = socketOptions.maxBsonSize ? socketOptions.maxBsonSize : Connection.DEFAULT_MAX_BSON_SIZE; - // Contains the current message bytes - this.buffer = null; - // Contains the current message size - this.sizeOfMessage = 0; - // Contains the readIndex for the messaage - this.bytesRead = 0; - // Contains spill over bytes from additional messages - this.stubBuffer = 0; - - // Just keeps list of events we allow - this.eventHandlers = {error:[], parseError:[], poolReady:[], message:[], close:[], timeout:[], end:[]}; - - // Just keeps list of events we allow - resetHandlers(this, false); -} - -// Set max bson size -Connection.DEFAULT_MAX_BSON_SIZE = 4 * 1024 * 1024 * 4 * 3; - -// Inherit event emitter so we can emit stuff wohoo -// inherits(Connection, SimpleEmitter); -inherits(Connection, EventEmitter); - -Connection.prototype.start = function() { - // If we have a normal connection - if(this.socketOptions.ssl) { - // Create a new stream - this.connection = new net.Socket(); - // Set options on the socket - this.connection.setTimeout(this.socketOptions.timeout); - // Work around for 0.4.X - if(process.version.indexOf("v0.4") == -1) this.connection.setNoDelay(this.socketOptions.noDelay); - // Set keep alive if defined - if(process.version.indexOf("v0.4") == -1) { - if(this.socketOptions.keepAlive > 0) { - this.connection.setKeepAlive(true, this.socketOptions.keepAlive); - } else { - this.connection.setKeepAlive(false); - } - } - - // Set up pair for tls with server, accept self-signed certificates as well - var pair = this.pair = tls.createSecurePair(false); - // Set up encrypted streams - this.pair.encrypted.pipe(this.connection); - this.connection.pipe(this.pair.encrypted); - - // Setup clearText stream - this.writeSteam = this.pair.cleartext; - // Add all handlers to the socket to manage it - this.pair.on("secure", connectHandler(this)); - this.pair.cleartext.on("data", createDataHandler(this)); - // Add handlers - this.connection.on("error", errorHandler(this)); - // this.connection.on("connect", connectHandler(this)); - this.connection.on("end", endHandler(this)); - this.connection.on("timeout", timeoutHandler(this)); - this.connection.on("drain", drainHandler(this)); - this.writeSteam.on("close", closeHandler(this)); - // Start socket - this.connection.connect(this.socketOptions.port, this.socketOptions.host); - } else { - // // Create a new stream - // this.connection = new net.Stream(); - // // Create new connection instance - // this.connection = new net.Socket(); - this.connection = net.createConnection(this.socketOptions.port, this.socketOptions.host); - // Set options on the socket - this.connection.setTimeout(this.socketOptions.timeout); - // Work around for 0.4.X - if(process.version.indexOf("v0.4") == -1) this.connection.setNoDelay(this.socketOptions.noDelay); - // Set keep alive if defined - if(process.version.indexOf("v0.4") == -1) { - if(this.socketOptions.keepAlive > 0) { - this.connection.setKeepAlive(true, this.socketOptions.keepAlive); - } else { - this.connection.setKeepAlive(false); - } - } - - // Set up write stream - this.writeSteam = this.connection; - // Add handlers - this.connection.on("error", errorHandler(this)); - // Add all handlers to the socket to manage it - this.connection.on("connect", connectHandler(this)); - // this.connection.on("end", endHandler(this)); - this.connection.on("data", createDataHandler(this)); - this.connection.on("timeout", timeoutHandler(this)); - this.connection.on("drain", drainHandler(this)); - this.connection.on("close", closeHandler(this)); - // // Start socket - // this.connection.connect(this.socketOptions.port, this.socketOptions.host); - } -} - -// Check if the sockets are live -Connection.prototype.isConnected = function() { - return this.connected && !this.connection.destroyed && this.connection.writable && this.connection.readable; -} - -// Write the data out to the socket -Connection.prototype.write = function(command, callback) { - try { - // If we have a list off commands to be executed on the same socket - if(Array.isArray(command)) { - for(var i = 0; i < command.length; i++) { - var binaryCommand = command[i].toBinary() - if(this.logger != null && this.logger.doDebug) this.logger.debug("writing command to mongodb", binaryCommand); - var r = this.writeSteam.write(binaryCommand); - } - } else { - var binaryCommand = command.toBinary() - if(this.logger != null && this.logger.doDebug) this.logger.debug("writing command to mongodb", binaryCommand); - var r = this.writeSteam.write(binaryCommand); - } - } catch (err) { - if(typeof callback === 'function') callback(err); - } -} - -// Force the closure of the connection -Connection.prototype.close = function() { - // clear out all the listeners - resetHandlers(this, true); - // Add a dummy error listener to catch any weird last moment errors (and ignore them) - this.connection.on("error", function() {}) - // destroy connection - this.connection.destroy(); -} - -// Reset all handlers -var resetHandlers = function(self, clearListeners) { - self.eventHandlers = {error:[], connect:[], close:[], end:[], timeout:[], parseError:[], message:[]}; - - // If we want to clear all the listeners - if(clearListeners && self.connection != null) { - var keys = Object.keys(self.eventHandlers); - // Remove all listeners - for(var i = 0; i < keys.length; i++) { - self.connection.removeAllListeners(keys[i]); - } - } -} - -// -// Handlers -// - -// Connect handler -var connectHandler = function(self) { - return function() { - // Set connected - self.connected = true; - // Emit the connect event with no error - self.emit("connect", null, self); - } -} - -var createDataHandler = exports.Connection.createDataHandler = function(self) { - // We need to handle the parsing of the data - // and emit the messages when there is a complete one - return function(data) { - // Parse until we are done with the data - while(data.length > 0) { - // If we still have bytes to read on the current message - if(self.bytesRead > 0 && self.sizeOfMessage > 0) { - // Calculate the amount of remaining bytes - var remainingBytesToRead = self.sizeOfMessage - self.bytesRead; - // Check if the current chunk contains the rest of the message - if(remainingBytesToRead > data.length) { - // Copy the new data into the exiting buffer (should have been allocated when we know the message size) - data.copy(self.buffer, self.bytesRead); - // Adjust the number of bytes read so it point to the correct index in the buffer - self.bytesRead = self.bytesRead + data.length; - - // Reset state of buffer - data = new Buffer(0); - } else { - // Copy the missing part of the data into our current buffer - data.copy(self.buffer, self.bytesRead, 0, remainingBytesToRead); - // Slice the overflow into a new buffer that we will then re-parse - data = data.slice(remainingBytesToRead); - - // Emit current complete message - try { - self.emit("message", self.buffer, self); - - } catch(err) { - var errorObject = {err:"socketHandler", trace:err, bin:buffer, parseState:{ - sizeOfMessage:self.sizeOfMessage, - bytesRead:self.bytesRead, - stubBuffer:self.stubBuffer}}; - if(self.logger != null && self.logger.doError) self.logger.error("parseError", errorObject); - // We got a parse Error fire it off then keep going - self.emit("parseError", errorObject, self); - } - - // Reset state of buffer - self.buffer = null; - self.sizeOfMessage = 0; - self.bytesRead = 0; - self.stubBuffer = null; - } - } else { - // Stub buffer is kept in case we don't get enough bytes to determine the - // size of the message (< 4 bytes) - if(self.stubBuffer != null && self.stubBuffer.length > 0) { - - // If we have enough bytes to determine the message size let's do it - if(self.stubBuffer.length + data.length > 4) { - // Prepad the data - var newData = new Buffer(self.stubBuffer.length + data.length); - self.stubBuffer.copy(newData, 0); - data.copy(newData, self.stubBuffer.length); - // Reassign for parsing - data = newData; - - // Reset state of buffer - self.buffer = null; - self.sizeOfMessage = 0; - self.bytesRead = 0; - self.stubBuffer = null; - - } else { - - // Add the the bytes to the stub buffer - var newStubBuffer = new Buffer(self.stubBuffer.length + data.length); - // Copy existing stub buffer - self.stubBuffer.copy(newStubBuffer, 0); - // Copy missing part of the data - data.copy(newStubBuffer, self.stubBuffer.length); - // Exit parsing loop - data = new Buffer(0); - } - } else { - if(data.length > 4) { - // Retrieve the message size - var sizeOfMessage = binaryutils.decodeUInt32(data, 0); - // If we have a negative sizeOfMessage emit error and return - if(sizeOfMessage < 0 || sizeOfMessage > self.maxBsonSize) { - var errorObject = {err:"socketHandler", trace:'', bin:self.buffer, parseState:{ - sizeOfMessage:sizeOfMessage, - bytesRead:self.bytesRead, - stubBuffer:self.stubBuffer}}; - if(self.logger != null && self.logger.doError) self.logger.error("parseError", errorObject); - // We got a parse Error fire it off then keep going - self.emit("parseError", errorObject, self); - return; - } - - // Ensure that the size of message is larger than 0 and less than the max allowed - if(sizeOfMessage > 4 && sizeOfMessage < self.maxBsonSize && sizeOfMessage > data.length) { - self.buffer = new Buffer(sizeOfMessage); - // Copy all the data into the buffer - data.copy(self.buffer, 0); - // Update bytes read - self.bytesRead = data.length; - // Update sizeOfMessage - self.sizeOfMessage = sizeOfMessage; - // Ensure stub buffer is null - self.stubBuffer = null; - // Exit parsing loop - data = new Buffer(0); - - } else if(sizeOfMessage > 4 && sizeOfMessage < self.maxBsonSize && sizeOfMessage == data.length) { - try { - self.emit("message", data, self); - // Reset state of buffer - self.buffer = null; - self.sizeOfMessage = 0; - self.bytesRead = 0; - self.stubBuffer = null; - // Exit parsing loop - data = new Buffer(0); - - } catch (err) { - var errorObject = {err:"socketHandler", trace:err, bin:self.buffer, parseState:{ - sizeOfMessage:self.sizeOfMessage, - bytesRead:self.bytesRead, - stubBuffer:self.stubBuffer}}; - if(self.logger != null && self.logger.doError) self.logger.error("parseError", errorObject); - // We got a parse Error fire it off then keep going - self.emit("parseError", errorObject, self); - } - } else if(sizeOfMessage <= 4 || sizeOfMessage > self.maxBsonSize) { - var errorObject = {err:"socketHandler", trace:null, bin:data, parseState:{ - sizeOfMessage:sizeOfMessage, - bytesRead:0, - buffer:null, - stubBuffer:null}}; - if(self.logger != null && self.logger.doError) self.logger.error("parseError", errorObject); - // We got a parse Error fire it off then keep going - self.emit("parseError", errorObject, self); - - // Clear out the state of the parser - self.buffer = null; - self.sizeOfMessage = 0; - self.bytesRead = 0; - self.stubBuffer = null; - // Exit parsing loop - data = new Buffer(0); - - } else { - try { - self.emit("message", data.slice(0, sizeOfMessage), self); - // Reset state of buffer - self.buffer = null; - self.sizeOfMessage = 0; - self.bytesRead = 0; - self.stubBuffer = null; - // Copy rest of message - data = data.slice(sizeOfMessage); - } catch (err) { - var errorObject = {err:"socketHandler", trace:err, bin:self.buffer, parseState:{ - sizeOfMessage:sizeOfMessage, - bytesRead:self.bytesRead, - stubBuffer:self.stubBuffer}}; - if(self.logger != null && self.logger.doError) self.logger.error("parseError", errorObject); - // We got a parse Error fire it off then keep going - self.emit("parseError", errorObject, self); - } - - } - } else { - // Create a buffer that contains the space for the non-complete message - self.stubBuffer = new Buffer(data.length) - // Copy the data to the stub buffer - data.copy(self.stubBuffer, 0); - // Exit parsing loop - data = new Buffer(0); - } - } - } - } - } -} - -var endHandler = function(self) { - return function() { - // Set connected to false - self.connected = false; - // Emit end event - self.emit("end", {err: 'connection received Fin packet from [' + self.socketOptions.host + ':' + self.socketOptions.port + ']'}, self); - } -} - -var timeoutHandler = function(self) { - return function() { - self.emit("timeout", {err: 'connection to [' + self.socketOptions.host + ':' + self.socketOptions.port + '] timed out'}, self); - } -} - -var drainHandler = function(self) { - return function() { - } -} - -var errorHandler = function(self) { - return function(err) { - // Set connected to false - self.connected = false; - // Emit error - self.emit("error", {err: 'failed to connect to [' + self.socketOptions.host + ':' + self.socketOptions.port + ']'}, self); - } -} - -var closeHandler = function(self) { - return function(hadError) { - // If we have an error during the connection phase - if(hadError && !self.connected) { - // Set disconnected - self.connected = false; - // Emit error - self.emit("error", {err: 'failed to connect to [' + self.socketOptions.host + ':' + self.socketOptions.port + ']'}, self); - } else { - // Set disconnected - self.connected = false; - // Emit close - self.emit("close", {err: 'connection closed to [' + self.socketOptions.host + ':' + self.socketOptions.port + ']'}, self); - } - } -} - -// Some basic defaults -Connection.DEFAULT_PORT = 27017; - - - - - - - diff --git a/lib/mongodb/connection/connection_pool.js b/lib/mongodb/connection/connection_pool.js deleted file mode 100644 index 421d1bd9557..00000000000 --- a/lib/mongodb/connection/connection_pool.js +++ /dev/null @@ -1,259 +0,0 @@ -var utils = require('./connection_utils'), - inherits = require('util').inherits, - net = require('net'), - EventEmitter = require('events').EventEmitter, - inherits = require('util').inherits, - MongoReply = require("../responses/mongo_reply").MongoReply, - Connection = require("./connection").Connection; - -var ConnectionPool = exports.ConnectionPool = function(host, port, poolSize, bson, socketOptions) { - if(typeof host !== 'string' || typeof port !== 'number') throw "host and port must be specified [" + host + ":" + port + "]"; - // Set up event emitter - EventEmitter.call(this); - // Keep all options for the socket in a specific collection allowing the user to specify the - // Wished upon socket connection parameters - this.socketOptions = typeof socketOptions === 'object' ? socketOptions : {}; - this.socketOptions.host = host; - this.socketOptions.port = port; - this.bson = bson; - // PoolSize is always + 1 for special reserved "measurment" socket (like ping, stats etc) - this.poolSize = poolSize; - - // Set default settings for the socket options - utils.setIntegerParameter(this.socketOptions, 'timeout', 0); - // Delay before writing out the data to the server - utils.setBooleanParameter(this.socketOptions, 'noDelay', true); - // Delay before writing out the data to the server - utils.setIntegerParameter(this.socketOptions, 'keepAlive', 0); - // Set the encoding of the data read, default is binary == null - utils.setStringParameter(this.socketOptions, 'encoding', null); - // Allows you to set a throttling bufferSize if you need to stop overflows - utils.setIntegerParameter(this.socketOptions, 'bufferSize', 0); - - // Internal structures - this.openConnections = []; - this.connections = []; - - // Assign connection id's - this.connectionId = 0; - - // Current index for selection of pool connection - this.currentConnectionIndex = 0; - // The pool state - this._poolState = 'disconnected'; - // timeout control - this._timeout = false; -} - -inherits(ConnectionPool, EventEmitter); - -ConnectionPool.prototype.setMaxBsonSize = function(maxBsonSize) { - if(maxBsonSize == null){ - maxBsonSize = Connection.DEFAULT_MAX_BSON_SIZE; - } - - for(var i = 0; i < this.openConnections.length; i++) { - this.openConnections[i].maxBsonSize = maxBsonSize; - } -} - -// Start a function -var _connect = function(_self) { - return new function() { - var connectionStatus = _self._poolState; - // Create a new connection instance - var connection = new Connection(_self.connectionId++, _self.socketOptions); - // Set logger on pool - connection.logger = _self.logger; - // Connect handler - connection.on("connect", function(err, connection) { - // Add connection to list of open connections - _self.openConnections.push(connection); - _self.connections.push(connection) - - // If the number of open connections is equal to the poolSize signal ready pool - if(_self.connections.length === _self.poolSize && _self._poolState !== 'disconnected') { - // Set connected - _self._poolState = 'connected'; - // Emit pool ready - _self.emit("poolReady"); - } else if(_self.connections.length < _self.poolSize) { - // We need to open another connection, make sure it's in the next - // tick so we don't get a cascade of errors - process.nextTick(function() { - _connect(_self); - }); - } - }); - - var numberOfErrors = 0 - - // Error handler - connection.on("error", function(err, connection) { - numberOfErrors++; - // If we are already disconnected ignore the event - if(connectionStatus != 'disconnected' && _self.listeners("error").length > 0) { - _self.emit("error", err); - } - - // Set disconnected - connectionStatus = 'disconnected'; - // Set disconnected - _self._poolState = 'disconnected'; - // Clean up - _self.openConnections = []; - _self.connections = []; - }); - - // Close handler - connection.on("close", function() { - // If we are already disconnected ignore the event - if(connectionStatus !== 'disconnected' && _self.listeners("close").length > 0) { - _self.emit("close"); - } - - // Set disconnected - connectionStatus = 'disconnected'; - // Set disconnected - _self._poolState = 'disconnected'; - // Clean up - _self.openConnections = []; - _self.connections = []; - }); - - // Timeout handler - connection.on("timeout", function(err, connection) { - // If we are already disconnected ignore the event - if(connectionStatus !== 'disconnected' && _self.listeners("timeout").length > 0) { - _self.emit("timeout", err); - } - - // Set disconnected - connectionStatus = 'disconnected'; - // Set disconnected - _self._poolState = 'disconnected'; - // Clean up - _self.openConnections = []; - _self.connections = []; - }); - - // Parse error, needs a complete shutdown of the pool - connection.on("parseError", function() { - // If we are already disconnected ignore the event - if(connectionStatus !== 'disconnected' && _self.listeners("parseError").length > 0) { - // if(connectionStatus == 'connected') { - _self.emit("parseError", new Error("parseError occured")); - } - - // Set disconnected - connectionStatus = 'disconnected'; - _self.stop(); - }); - - connection.on("message", function(message) { - _self.emit("message", message); - }); - - // Start connection in the next tick - connection.start(); - }(); -} - - -// Start method, will throw error if no listeners are available -// Pass in an instance of the listener that contains the api for -// finding callbacks for a given message etc. -ConnectionPool.prototype.start = function() { - var markerDate = new Date().getTime(); - var self = this; - - if(this.listeners("poolReady").length == 0) { - throw "pool must have at least one listener ready that responds to the [poolReady] event"; - } - - // Set pool state to connecting - this._poolState = 'connecting'; - this._timeout = false; - - _connect(self); -} - -// Restart a connection pool (on a close the pool might be in a wrong state) -ConnectionPool.prototype.restart = function() { - // Close all connections - this.stop(false); - // Now restart the pool - this.start(); -} - -// Stop the connections in the pool -ConnectionPool.prototype.stop = function(removeListeners) { - removeListeners = removeListeners == null ? true : removeListeners; - // Set disconnected - this._poolState = 'disconnected'; - - // Clear all listeners if specified - if(removeListeners) { - this.removeAllEventListeners(); - } - - // Close all connections - for(var i = 0; i < this.connections.length; i++) { - this.connections[i].close(); - } - - // Clean up - // this.connectionsWithErrors = []; - this.openConnections = []; - this.connections = []; -} - -// Check the status of the connection -ConnectionPool.prototype.isConnected = function() { - return this._poolState === 'connected'; -} - -// Checkout a connection from the pool for usage, or grab a specific pool instance -ConnectionPool.prototype.checkoutConnection = function(id) { - var index = (this.currentConnectionIndex++ % (this.openConnections.length)); - var connection = this.openConnections[index]; - return connection; -} - -ConnectionPool.prototype.getAllConnections = function() { - return this.connections; -} - -// Remove all non-needed event listeners -ConnectionPool.prototype.removeAllEventListeners = function() { - this.removeAllListeners("close"); - this.removeAllListeners("error"); - this.removeAllListeners("timeout"); - this.removeAllListeners("connect"); - this.removeAllListeners("end"); - this.removeAllListeners("parseError"); - this.removeAllListeners("message"); - this.removeAllListeners("poolReady"); -} - - - - - - - - - - - - - - - - - - - - - - diff --git a/lib/mongodb/connection/connection_utils.js b/lib/mongodb/connection/connection_utils.js deleted file mode 100644 index 591092495a8..00000000000 --- a/lib/mongodb/connection/connection_utils.js +++ /dev/null @@ -1,23 +0,0 @@ -exports.setIntegerParameter = function(object, field, defaultValue) { - if(object[field] == null) { - object[field] = defaultValue; - } else if(typeof object[field] !== "number" && object[field] !== parseInt(object[field], 10)) { - throw "object field [" + field + "] must be a numeric integer value, attempted to set to [" + object[field] + "] type of [" + typeof object[field] + "]"; - } -} - -exports.setBooleanParameter = function(object, field, defaultValue) { - if(object[field] == null) { - object[field] = defaultValue; - } else if(typeof object[field] !== "boolean") { - throw "object field [" + field + "] must be a boolean value, attempted to set to [" + object[field] + "] type of [" + typeof object[field] + "]"; - } -} - -exports.setStringParameter = function(object, field, defaultValue) { - if(object[field] == null) { - object[field] = defaultValue; - } else if(typeof object[field] !== "string") { - throw "object field [" + field + "] must be a string value, attempted to set to [" + object[field] + "] type of [" + typeof object[field] + "]"; - } -} \ No newline at end of file diff --git a/lib/mongodb/connection/repl_set_servers.js b/lib/mongodb/connection/repl_set_servers.js deleted file mode 100644 index 28662821e94..00000000000 --- a/lib/mongodb/connection/repl_set_servers.js +++ /dev/null @@ -1,968 +0,0 @@ -var Connection = require('./connection').Connection, - DbCommand = require('../commands/db_command').DbCommand, - MongoReply = require('../responses/mongo_reply').MongoReply, - debug = require('util').debug, - SimpleEmitter = require('./simple_emitter').SimpleEmitter, - inherits = require('util').inherits, - inspect = require('util').inspect, - Server = require('./server').Server, - format = require('util').format, - PingStrategy = require('./strategies/ping_strategy').PingStrategy, - StatisticsStrategy = require('./strategies/statistics_strategy').StatisticsStrategy; - -const STATE_STARTING_PHASE_1 = 0; -const STATE_PRIMARY = 1; -const STATE_SECONDARY = 2; -const STATE_RECOVERING = 3; -const STATE_FATAL_ERROR = 4; -const STATE_STARTING_PHASE_2 = 5; -const STATE_UNKNOWN = 6; -const STATE_ARBITER = 7; -const STATE_DOWN = 8; -const STATE_ROLLBACK = 9; - -/** -* ReplSetServers constructor provides master-slave functionality -* -* @param serverArr{Array of type Server} -* @return constructor of ServerCluster -* -*/ -var ReplSetServers = exports.ReplSetServers = function(servers, options) { - var self = this; - // Contains the master server entry - this.options = options == null ? {} : options; - this.reconnectWait = this.options["reconnectWait"] != null ? this.options["reconnectWait"] : 1000; - this.retries = this.options["retries"] != null ? this.options["retries"] : 30; - this.replicaSet = this.options["rs_name"]; - - // Are we allowing reads from secondaries ? - this.readSecondary = this.options["read_secondary"]; - this.slaveOk = true; - this.closedConnectionCount = 0; - this._used = false; - - // Default poolSize for new server instances - this.poolSize = this.options.poolSize == null ? 1 : this.options.poolSize; - - // Set up ssl connections - this.ssl = this.options.ssl == null ? false : this.options.ssl; - - // Just keeps list of events we allow - this.eventHandlers = {error:[], parseError:[], poolReady:[], message:[], close:[], timeout:[]}; - // Internal state of server connection - this._serverState = 'disconnected'; - // Read preference - this._readPreference = null; - // Do we record server stats or not - this.recordQueryStats = false; - - // Get the readPreference - var readPreference = this.options['readPreference']; - // Read preference setting - if(readPreference != null) { - if(readPreference != Server.READ_PRIMARY && readPreference != Server.READ_SECONDARY_ONLY - && readPreference != Server.READ_SECONDARY) { - throw new Error("Illegal readPreference mode specified, " + readPreference); - } - - // Set read Preference - this._readPreference = readPreference; - } else { - this._readPreference = null; - } - - // Strategy for picking a secondary - this.strategy = this.options['strategy'] == null ? 'statistical' : this.options['strategy']; - // Make sure strategy is one of the two allowed - if(this.strategy != null && (this.strategy != 'ping' && this.strategy != 'statistical')) throw new Error("Only ping or statistical strategies allowed"); - // Let's set up our strategy object for picking secodaries - if(this.strategy == 'ping') { - // Create a new instance - this.strategyInstance = new PingStrategy(this); - } else if(this.strategy == 'statistical') { - // Set strategy as statistical - this.strategyInstance = new StatisticsStrategy(this); - // Add enable query information - this.enableRecordQueryStats(true); - } - - // Set default connection pool options - this.socketOptions = this.options.socketOptions != null ? this.options.socketOptions : {}; - - // Set up logger if any set - this.logger = this.options.logger != null - && (typeof this.options.logger.debug == 'function') - && (typeof this.options.logger.error == 'function') - && (typeof this.options.logger.debug == 'function') - ? this.options.logger : {error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}}; - - // Ensure all the instances are of type server and auto_reconnect is false - if(!Array.isArray(servers) || servers.length == 0) { - throw Error("The parameter must be an array of servers and contain at least one server"); - } else if(Array.isArray(servers) || servers.length > 0) { - var count = 0; - servers.forEach(function(server) { - if(server instanceof Server) count = count + 1; - // Ensure no server has reconnect on - server.options.auto_reconnect = false; - }); - - if(count < servers.length) { - throw Error("All server entries must be of type Server"); - } else { - this.servers = servers; - } - } - - // Auto Reconnect property - Object.defineProperty(this, "autoReconnect", { enumerable: true - , get: function () { - return true; - } - }); - - // Get Read Preference method - Object.defineProperty(this, "readPreference", { enumerable: true - , get: function () { - if(this._readPreference == null && this.readSecondary) { - return Server.READ_SECONDARY; - } else if(this._readPreference == null && !this.readSecondary) { - return Server.READ_PRIMARY; - } else { - return this._readPreference; - } - } - }); - - // Db Instances - Object.defineProperty(this, "dbInstances", {enumerable:true - , get: function() { - var servers = this.allServerInstances(); - return servers[0].dbInstances; - } - }) - - // Auto Reconnect property - Object.defineProperty(this, "host", { enumerable: true - , get: function () { - if (this.primary != null) return this.primary.host; - } - }); - - Object.defineProperty(this, "port", { enumerable: true - , get: function () { - if (this.primary != null) return this.primary.port; - } - }); - - Object.defineProperty(this, "read", { enumerable: true - , get: function () { - return this.secondaries.length > 0 ? this.secondaries[0] : null; - } - }); - - // Get list of secondaries - Object.defineProperty(this, "secondaries", {enumerable: true - , get: function() { - var keys = Object.keys(this._state.secondaries); - var array = new Array(keys.length); - // Convert secondaries to array - for(var i = 0; i < keys.length; i++) { - array[i] = this._state.secondaries[keys[i]]; - } - return array; - } - }); - - // Get list of all secondaries including passives - Object.defineProperty(this, "allSecondaries", {enumerable: true - , get: function() { - return this.secondaries.concat(this.passives); - } - }); - - // Get list of arbiters - Object.defineProperty(this, "arbiters", {enumerable: true - , get: function() { - var keys = Object.keys(this._state.arbiters); - var array = new Array(keys.length); - // Convert arbiters to array - for(var i = 0; i < keys.length; i++) { - array[i] = this._state.arbiters[keys[i]]; - } - return array; - } - }); - - // Get list of passives - Object.defineProperty(this, "passives", {enumerable: true - , get: function() { - var keys = Object.keys(this._state.passives); - var array = new Array(keys.length); - // Convert arbiters to array - for(var i = 0; i < keys.length; i++) { - array[i] = this._state.passives[keys[i]]; - } - return array; - } - }); - - // Master connection property - Object.defineProperty(this, "primary", { enumerable: true - , get: function () { - return this._state != null ? this._state.master : null; - } - }); -}; - -inherits(ReplSetServers, SimpleEmitter); - -// Allow setting the read preference at the replicaset level -ReplSetServers.prototype.setReadPreference = function(preference) { - // Set read preference - this._readPreference = preference; - // Ensure slaveOk is correct for secodnaries read preference and tags - if((this._readPreference == Server.READ_SECONDARY || this._readPreference == Server.READ_SECONDARY_ONLY) - || (this._readPreference != null && typeof this._readPreference == 'object')) { - this.slaveOk = true; - } -} - -// Return the used state -ReplSetServers.prototype._isUsed = function() { - return this._used; -} - -ReplSetServers.prototype.setTarget = function(target) { - this.target = target; -}; - -ReplSetServers.prototype.isConnected = function() { - // Return the state of the replicaset server - return this.primary != null && this._state.master != null && this._state.master.isConnected(); -} - -Server.prototype.isSetMember = function() { - return false; -} - -ReplSetServers.prototype.isPrimary = function(config) { - return this.readSecondary && this.secondaries.length > 0 ? false : true; -} - -ReplSetServers.prototype.isReadPrimary = ReplSetServers.prototype.isPrimary; - -// Clean up dead connections -var cleanupConnections = ReplSetServers.cleanupConnections = function(connections, addresses, byTags) { - // Ensure we don't have entries in our set with dead connections - var keys = Object.keys(connections); - for(var i = 0; i < keys.length; i++) { - var server = connections[keys[i]]; - // If it's not connected remove it from the list - if(!server.isConnected()) { - // Remove from connections and addresses - delete connections[keys[i]]; - delete addresses[keys[i]]; - // Clean up tags if needed - if(server.tags != null && typeof server.tags === 'object') { - cleanupTags(server, byTags); - } - } - } -} - -var cleanupTags = ReplSetServers._cleanupTags = function(server, byTags) { - var serverTagKeys = Object.keys(server.tags); - // Iterate over all server tags and remove any instances for that tag that matches the current - // server - for(var i = 0; i < serverTagKeys.length; i++) { - // Fetch the value for the tag key - var value = server.tags[serverTagKeys[i]]; - - // If we got an instance of the server - if(byTags[serverTagKeys[i]] != null - && byTags[serverTagKeys[i]][value] != null - && Array.isArray(byTags[serverTagKeys[i]][value])) { - // List of clean servers - var cleanInstances = []; - // We got instances for the particular tag set - var instances = byTags[serverTagKeys[i]][value]; - for(var j = 0; j < instances.length; j++) { - var serverInstance = instances[j]; - // If we did not find an instance add it to the clean instances - if((serverInstance.host + ":" + serverInstance.port) !== (server.host + ":" + server.port)) { - cleanInstances.push(serverInstance); - } - } - - // Update the byTags list - byTags[serverTagKeys[i]][value] = cleanInstances; - } - } -} - -ReplSetServers.prototype.allServerInstances = function() { - var self = this; - // Close all the servers (concatenate entire list of servers first for ease) - var allServers = self._state.master != null ? [self._state.master] : []; - - // Secondary keys - var keys = Object.keys(self._state.secondaries); - // Add all secondaries - for(var i = 0; i < keys.length; i++) { - allServers.push(self._state.secondaries[keys[i]]); - } - - // Arbiter keys - var keys = Object.keys(self._state.arbiters); - // Add all arbiters - for(var i = 0; i < keys.length; i++) { - allServers.push(self._state.arbiters[keys[i]]); - } - - // Passive keys - var keys = Object.keys(self._state.passives); - // Add all arbiters - for(var i = 0; i < keys.length; i++) { - allServers.push(self._state.passives[keys[i]]); - } - - // Return complete list of all servers - return allServers; -} - -// Ensure no callback is left hanging when we have an error -var __executeAllCallbacksWithError = function(dbInstance, error) { - var keys = Object.keys(dbInstance._callBackStore._notReplied); - // Iterate over all callbacks - for(var i = 0; i < keys.length; i++) { - // Delete info object - delete dbInstance._callBackStore._notReplied[keys[i]]; - // Emit the error - dbInstance._callBackStore.emit(keys[i], error); - } -} - -ReplSetServers.prototype.connect = function(parent, options, callback) { - var self = this; - var dateStamp = new Date().getTime(); - if('function' === typeof options) callback = options, options = {}; - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - - // Keep reference to parent - this.db = parent; - // Set server state to connecting - this._serverState = 'connecting'; - // Reference to the instance - var replSetSelf = this; - var serverConnections = this.servers; - // Ensure parent can do a slave query if it's set - parent.slaveOk = this.slaveOk ? this.slaveOk : parent.slaveOk; - // Number of total servers that need to initialized (known servers) - var numberOfServersLeftToInitialize = serverConnections.length; - - // Clean up state - replSetSelf._state = {'master':null, 'secondaries':{}, 'arbiters':{}, 'passives':{}, 'errors':{}, 'addresses':{}, 'byTags':{}, 'setName':null, 'errorMessages':[], 'members':[]}; - - // Create a connection handler - var connectionHandler = function(instanceServer) { - return function(err, result) { - // Don't attempt to connect if we are done - // if(replSetSelf._serverState === 'disconnected') return; - // Remove a server from the list of intialized servers we need to perform - numberOfServersLeftToInitialize = numberOfServersLeftToInitialize - 1; - // Add enable query information - instanceServer.enableRecordQueryStats(replSetSelf.recordQueryStats); - - if(err == null && result.documents[0].hosts != null) { - // Fetch the isMaster command result - var document = result.documents[0]; - // Break out the results - var setName = document.setName; - var isMaster = document.ismaster; - var secondary = document.secondary; - var passive = document.passive; - var arbiterOnly = document.arbiterOnly; - var hosts = Array.isArray(document.hosts) ? document.hosts : []; - var arbiters = Array.isArray(document.arbiters) ? document.arbiters : []; - var passives = Array.isArray(document.passives) ? document.passives : []; - var tags = document.tags ? document.tags : {}; - var primary = document.primary; - var me = document.me; - - // Only add server to our internal list if it's a master, secondary or arbiter - if(isMaster == true || secondary == true || arbiterOnly == true) { - // Handle a closed connection - var closeHandler = function(err, server) { - var closeServers = function() { - // Set the state to disconnected - parent._state = 'disconnected'; - // Shut down the replicaset for now and Fire off all the callbacks sitting with no reply - if(replSetSelf._serverState == 'connected') { - // Close the replicaset - replSetSelf.close(function() { - __executeAllCallbacksWithError(parent, err); - // Ensure single callback only - if(callback != null) { - // Single callback only - var internalCallback = callback; - callback = null; - // Return the error - internalCallback(err, null); - } else { - // If the parent has listeners trigger an event - if(parent.listeners("close").length > 0) { - parent.emit("close", err); - } - } - }); - } - } - - // Check if this is the primary server, then disconnect otherwise keep going - if(replSetSelf._state.master != null) { - var primaryAddress = format("%s:%s", replSetSelf._state.master.host, replSetSelf._state.master.port); - var errorServerAddress = format("%s:%s", server.host, server.port); - - // Only shut down the set if we have a primary server error - if(primaryAddress == errorServerAddress) { - closeServers(); - } else { - // Remove from the list of servers - delete replSetSelf._state.addresses[errorServerAddress]; - // Locate one of the lists and remove - if(replSetSelf._state.secondaries[errorServerAddress] != null) { - delete replSetSelf._state.secondaries[errorServerAddress]; - } else if(replSetSelf._state.arbiters[errorServerAddress] != null) { - delete replSetSelf._state.arbiters[errorServerAddress]; - } else if(replSetSelf._state.passives[errorServerAddress] != null) { - delete replSetSelf._state.passives[errorServerAddress]; - } - - // Check if we are reading from Secondary only - if(replSetSelf._readPreference == Server.READ_SECONDARY_ONLY && Object.keys(replSetSelf._state.secondaries).length == 0) { - closeServers(); - } - } - } else { - closeServers(); - } - } - - // Handle a connection timeout - var timeoutHandler = function(err, server) { - var closeServers = function() { - // Set the state to disconnected - parent._state = 'disconnected'; - // Shut down the replicaset for now and Fire off all the callbacks sitting with no reply - if(replSetSelf._serverState == 'connected') { - // Close the replicaset - replSetSelf.close(function() { - __executeAllCallbacksWithError(parent, err); - // Ensure single callback only - if(callback != null) { - // Single callback only - var internalCallback = callback; - callback = null; - // Return the error - internalCallback(new Error("connection timed out"), null); - } else { - // If the parent has listeners trigger an event - if(parent.listeners("error").length > 0) { - parent.emit("timeout", new Error("connection timed out")); - } - } - }); - } - } - - // Check if this is the primary server, then disconnect otherwise keep going - if(replSetSelf._state.master != null) { - var primaryAddress = format("%s:%s", replSetSelf._state.master.host, replSetSelf._state.master.port); - var errorServerAddress = format("%s:%s", server.host, server.port); - - // Only shut down the set if we have a primary server error - if(primaryAddress == errorServerAddress) { - closeServers(); - } else { - // Remove from the list of servers - delete replSetSelf._state.addresses[errorServerAddress]; - // Locate one of the lists and remove - if(replSetSelf._state.secondaries[errorServerAddress] != null) { - delete replSetSelf._state.secondaries[errorServerAddress]; - } else if(replSetSelf._state.arbiters[errorServerAddress] != null) { - delete replSetSelf._state.arbiters[errorServerAddress]; - } else if(replSetSelf._state.passives[errorServerAddress] != null) { - delete replSetSelf._state.passives[errorServerAddress]; - } - - // Check if we are reading from Secondary only - if(replSetSelf._readPreference == Server.READ_SECONDARY_ONLY && Object.keys(replSetSelf._state.secondaries).length == 0) { - closeServers(); - } - } - } else { - closeServers(); - } - } - - // Handle an error - var errorHandler = function(err, server) { - var closeServers = function() { - // Set the state to disconnected - parent._state = 'disconnected'; - // Shut down the replicaset for now and Fire off all the callbacks sitting with no reply - if(replSetSelf._serverState == 'connected') { - // Close the replicaset - replSetSelf.close(function() { - __executeAllCallbacksWithError(parent, err); - // Ensure single callback only - if(callback != null) { - // Single callback only - var internalCallback = callback; - callback = null; - // Return the error - internalCallback(err, null); - } else { - // If the parent has listeners trigger an event - if(parent.listeners("error").length > 0) { - parent.emit("error", err); - } - } - }); - } - } - - // Check if this is the primary server, then disconnect otherwise keep going - if(replSetSelf._state.master != null) { - var primaryAddress = format("%s:%s", replSetSelf._state.master.host, replSetSelf._state.master.port); - var errorServerAddress = format("%s:%s", server.host, server.port); - - // Only shut down the set if we have a primary server error - if(primaryAddress == errorServerAddress) { - closeServers(); - } else { - // Remove from the list of servers - delete replSetSelf._state.addresses[errorServerAddress]; - // Locate one of the lists and remove - if(replSetSelf._state.secondaries[errorServerAddress] != null) { - delete replSetSelf._state.secondaries[errorServerAddress]; - } else if(replSetSelf._state.arbiters[errorServerAddress] != null) { - delete replSetSelf._state.arbiters[errorServerAddress]; - } else if(replSetSelf._state.passives[errorServerAddress] != null) { - delete replSetSelf._state.passives[errorServerAddress]; - } - - // Check if we are reading from Secondary only - if(replSetSelf._readPreference == Server.READ_SECONDARY_ONLY && Object.keys(replSetSelf._state.secondaries).length == 0) { - closeServers(); - } - } - } else { - closeServers(); - } - } - - // Ensure we don't have duplicate handlers - instanceServer.removeAllListeners("close"); - instanceServer.removeAllListeners("error"); - instanceServer.removeAllListeners("timeout"); - - // Add error handler to the instance of the server - instanceServer.on("close", closeHandler); - // Add error handler to the instance of the server - instanceServer.on("error", errorHandler); - // instanceServer.on("timeout", errorHandler); - instanceServer.on("timeout", timeoutHandler); - // Add tag info - instanceServer.tags = tags; - - // For each tag in tags let's add the instance Server to the list for that tag - if(tags != null && typeof tags === 'object') { - var tagKeys = Object.keys(tags); - // For each tag file in the server add it to byTags - for(var i = 0; i < tagKeys.length; i++) { - var value = tags[tagKeys[i]]; - // Check if we have a top level tag object - if(replSetSelf._state.byTags[tagKeys[i]] == null) replSetSelf._state.byTags[tagKeys[i]] = {}; - // For the value check if we have an array of server instances - if(!Array.isArray(replSetSelf._state.byTags[tagKeys[i]][value])) replSetSelf._state.byTags[tagKeys[i]][value] = []; - // Check that the instance is not already registered there - var valueArray = replSetSelf._state.byTags[tagKeys[i]][value]; - var found = false; - - // Iterate over all values - for(var j = 0; j < valueArray.length; j++) { - if(valueArray[j].host == instanceServer.host && valueArray[j].port == instanceServer.port) { - found = true; - break; - } - } - - // If it was not found push the instance server to the list - if(!found) valueArray.push(instanceServer); - } - } - - // Remove from error list - delete replSetSelf._state.errors[me]; - - // Add our server to the list of finished servers - replSetSelf._state.addresses[me] = instanceServer; - - // Assign the set name - if(replSetSelf.replicaSet == null) { - replSetSelf._state.setName = setName; - } else if(replSetSelf.replicaSet != setName && replSetSelf._serverState != 'disconnected') { - replSetSelf._state.errorMessages.push(new Error("configured mongodb replicaset does not match provided replicaset [" + setName + "] != [" + replSetSelf.replicaSet + "]")); - // Set done - replSetSelf._serverState = 'disconnected'; - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Return error message ignoring rest of calls - return internalCallback(replSetSelf._state.errorMessages[0], parent); - } - - // Let's add the server to our list of server types - if(secondary == true && (passive == false || passive == null)) { - replSetSelf._state.secondaries[me] = instanceServer; - } else if(arbiterOnly == true) { - replSetSelf._state.arbiters[me] = instanceServer; - } else if(secondary == true && passive == true) { - replSetSelf._state.passives[me] = instanceServer; - } else if(isMaster == true) { - replSetSelf._state.master = instanceServer; - } else if(isMaster == false && primary != null && replSetSelf._state.addresses[primary]) { - replSetSelf._state.master = replSetSelf._state.addresses[primary]; - } - - // Let's go throught all the "possible" servers in the replicaset - var candidateServers = hosts.concat(arbiters).concat(passives); - - // If we have new servers let's add them - for(var i = 0; i < candidateServers.length; i++) { - // Fetch the server string - var candidateServerString = candidateServers[i]; - // Add the server if it's not defined - if(replSetSelf._state.addresses[candidateServerString] == null) { - // Split the server string - var parts = candidateServerString.split(/:/); - if(parts.length == 1) { - parts = [parts[0], Connection.DEFAULT_PORT]; - } - - // Default empty socket options object - var socketOptions = {}; - // If a socket option object exists clone it - if(replSetSelf.socketOptions != null) { - var keys = Object.keys(replSetSelf.socketOptions); - for(var i = 0; i < keys.length;i++) socketOptions[keys[i]] = replSetSelf.socketOptions[keys[i]]; - } - - // Add host information to socket options - socketOptions['host'] = parts[0]; - socketOptions['port'] = parseInt(parts[1]); - - // Create a new server instance - var newServer = new Server(parts[0], parseInt(parts[1]), {auto_reconnect:false, 'socketOptions':socketOptions - , logger:replSetSelf.logger, ssl:replSetSelf.ssl, poolSize:replSetSelf.poolSize}); - // Set the replicaset instance - newServer.replicasetInstance = replSetSelf; - - // Add handlers - newServer.on("close", closeHandler); - newServer.on("timeout", timeoutHandler); - newServer.on("error", errorHandler); - - // Add server to list, ensuring we don't get a cascade of request to the same server - replSetSelf._state.addresses[candidateServerString] = newServer; - - // Add a new server to the total number of servers that need to initialized before we are done - numberOfServersLeftToInitialize = numberOfServersLeftToInitialize + 1; - - // Let's set up a new server instance - newServer.connect(parent, {returnIsMasterResults: true, eventReceiver:newServer}, connectionHandler(newServer)); - } - } - } else { - // Remove the instance from out list of servers - delete replSetSelf._state.addresses[me]; - } - } - - // If done finish up - if((numberOfServersLeftToInitialize == 0) && replSetSelf._serverState === 'connecting' && replSetSelf._state.errorMessages.length == 0) { - // Set db as connected - replSetSelf._serverState = 'connected'; - // If we don't expect a master let's call back, otherwise we need a master before - // the connection is successful - if(replSetSelf.masterNotNeeded || replSetSelf._state.master != null) { - // If we have a read strategy boot it - if(replSetSelf.strategyInstance != null) { - // Ensure we have a proper replicaset defined - replSetSelf.strategyInstance.replicaset = replSetSelf; - // Start strategy - replSetSelf.strategyInstance.start(function(err) { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(null, parent); - }) - } else { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(null, parent); - } - } else if(replSetSelf.readSecondary == true && Object.keys(replSetSelf._state.secondaries).length > 0) { - // If we have a read strategy boot it - if(replSetSelf.strategyInstance != null) { - // Ensure we have a proper replicaset defined - replSetSelf.strategyInstance.replicaset = replSetSelf; - // Start strategy - replSetSelf.strategyInstance.start(function(err) { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(null, parent); - }) - } else { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(null, parent); - } - } else if(replSetSelf.readSecondary == true && Object.keys(replSetSelf._state.secondaries).length == 0) { - replSetSelf._serverState = 'disconnected'; - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Force close all server instances - replSetSelf.close(); - // Perform callback - internalCallback(new Error("no secondary server found"), null); - } else if(typeof callback === 'function'){ - replSetSelf._serverState = 'disconnected'; - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Force close all server instances - replSetSelf.close(); - // Perform callback - internalCallback(new Error("no primary server found"), null); - } - } else if((numberOfServersLeftToInitialize == 0) && replSetSelf._state.errorMessages.length > 0 && replSetSelf._serverState != 'disconnected') { - // Set done - replSetSelf._serverState = 'disconnected'; - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Force close all server instances - replSetSelf.close(); - // Callback to signal we are done - internalCallback(replSetSelf._state.errorMessages[0], null); - } - } - } - - // Ensure we have all registered servers in our set - for(var i = 0; i < serverConnections.length; i++) { - replSetSelf._state.addresses[serverConnections[i].host + ':' + serverConnections[i].port] = serverConnections[i]; - } - - // Initialize all the connections - for(var i = 0; i < serverConnections.length; i++) { - // Set up the logger for the server connection - serverConnections[i].logger = replSetSelf.logger; - // Default empty socket options object - var socketOptions = {}; - // If a socket option object exists clone it - if(this.socketOptions != null && typeof this.socketOptions === 'object') { - var keys = Object.keys(this.socketOptions); - for(var j = 0; j < keys.length;j++) socketOptions[keys[j]] = this.socketOptions[keys[j]]; - } - - // If ssl is specified - if(replSetSelf.ssl) serverConnections[i].ssl = true; - - // Add host information to socket options - socketOptions['host'] = serverConnections[i].host; - socketOptions['port'] = serverConnections[i].port; - - // Set the socket options - serverConnections[i].socketOptions = socketOptions; - // Set the replicaset instance - serverConnections[i].replicasetInstance = replSetSelf; - // Connect to server - serverConnections[i].connect(parent, {returnIsMasterResults: true, eventReceiver:serverConnections[i]}, connectionHandler(serverConnections[i])); - } - - // Check if we have an error in the inital set of servers and callback with error - if(replSetSelf._state.errorMessages.length > 0 && typeof callback === 'function') { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(replSetSelf._state.errorMessages[0], null); - } -} - -ReplSetServers.prototype.checkoutWriter = function() { - // Establish connection - var connection = this._state.master != null ? this._state.master.checkoutWriter() : null; - // Return the connection - return connection; -} - -ReplSetServers.prototype.checkoutReader = function() { - var connection = null; - // If we have specified to read from a secondary server grab a random one and read - // from it, otherwise just pass the primary connection - if((this.readSecondary == true || this._readPreference == Server.READ_SECONDARY || this._readPreference == Server.READ_SECONDARY_ONLY) && Object.keys(this._state.secondaries).length > 0) { - // Checkout a secondary server from the passed in set of servers - if(this.strategyInstance != null) { - connection = this.strategyInstance.checkoutSecondary(); - } else { - // Pick a random key - var keys = Object.keys(this._state.secondaries); - var key = keys[Math.floor(Math.random() * keys.length)]; - connection = this._state.secondaries[key].checkoutReader(); - } - } else if(this._readPreference == Server.READ_SECONDARY_ONLY && Object.keys(this._state.secondaries).length == 0) { - connection = null; - } else if(this._readPreference != null && typeof this._readPreference === 'object') { - // Get all tag keys (used to try to find a server that is valid) - var keys = Object.keys(this._readPreference); - // final instance server - var instanceServer = null; - // for each key look for an avilable instance - for(var i = 0; i < keys.length; i++) { - // Grab subkey value - var value = this._readPreference[keys[i]]; - - // Check if we have any servers for the tag, if we do pick a random one - if(this._state.byTags[keys[i]] != null - && this._state.byTags[keys[i]][value] != null - && Array.isArray(this._state.byTags[keys[i]][value]) - && this._state.byTags[keys[i]][value].length > 0) { - // Let's grab an available server from the list using a random pick - var serverInstances = this._state.byTags[keys[i]][value]; - // Set instance to return - instanceServer = serverInstances[Math.floor(Math.random() * serverInstances.length)]; - break; - } - } - - // Return the instance of the server - connection = instanceServer != null ? instanceServer.checkoutReader() : this.checkoutWriter(); - } else { - connection = this.checkoutWriter(); - } - // Return the connection - return connection; -} - -ReplSetServers.prototype.allRawConnections = function() { - // Neeed to build a complete list of all raw connections, start with master server - var allConnections = []; - // Get connection object - var allMasterConnections = this._state.master.connectionPool.getAllConnections(); - // Add all connections to list - allConnections = allConnections.concat(allMasterConnections); - - // If we have read secondary let's add all secondary servers - if(this.readSecondary && Object.keys(this._state.secondaries).length > 0) { - // Get all the keys - var keys = Object.keys(this._state.secondaries); - // For each of the secondaries grab the connections - for(var i = 0; i < keys.length; i++) { - // Get connection object - var secondaryPoolConnections = this._state.secondaries[keys[i]].connectionPool.getAllConnections(); - // Add all connections to list - allConnections = allConnections.concat(secondaryPoolConnections); - } - } - - // Return all the conections - return allConnections; -} - -ReplSetServers.prototype.enableRecordQueryStats = function(enable) { - // Set the global enable record query stats - this.recordQueryStats = enable; - // Ensure all existing servers already have the flag set, even if the - // connections are up already or we have not connected yet - if(this._state != null && this._state.addresses != null) { - var keys = Object.keys(this._state.addresses); - // Iterate over all server instances and set the enableRecordQueryStats flag - for(var i = 0; i < keys.length; i++) { - this._state.addresses[keys[i]].enableRecordQueryStats(enable); - } - } else if(Array.isArray(this.servers)) { - for(var i = 0; i < this.servers.length; i++) { - this.servers[i].enableRecordQueryStats(enable); - } - } -} - -ReplSetServers.prototype.disconnect = function(callback) { - this.close(callback); -} - -ReplSetServers.prototype.close = function(callback) { - var self = this; - // Set server status as disconnected - this._serverState = 'disconnected'; - // Get all the server instances and close them - var allServers = []; - // Make sure we have servers - if(this._state['addresses'] != null) { - var keys = Object.keys(this._state.addresses); - for(var i = 0; i < keys.length; i++) { - allServers.push(this._state.addresses[keys[i]]); - } - } - - // Let's process all the closing - var numberOfServersToClose = allServers.length; - - // Remove all the listeners - self.removeAllListeners(); - - // Special case where there are no servers - if(allServers.length == 0 && typeof callback === 'function') return callback(null, null); - - // Close the servers - for(var i = 0; i < allServers.length; i++) { - var server = allServers[i]; - if(server.isConnected()) { - // Close each server - server.close(function() { - numberOfServersToClose = numberOfServersToClose - 1; - // Clear out state if we are done - if(numberOfServersToClose == 0) { - // Clear out state - self._state = {'master':null, 'secondaries':{}, 'arbiters':{}, 'passives':{}, 'errors':{}, 'addresses':{}, 'byTags':{}, 'setName':null, 'errorMessages':[], 'members':[]}; - } - - // If we are finished perform the call back - if(numberOfServersToClose == 0 && typeof callback === 'function') { - callback(null); - } - }) - } else { - numberOfServersToClose = numberOfServersToClose - 1; - // If we have no more servers perform the callback - if(numberOfServersToClose == 0 && typeof callback === 'function') { - callback(null); - } - } - } -} \ No newline at end of file diff --git a/lib/mongodb/connection/server.js b/lib/mongodb/connection/server.js deleted file mode 100644 index fa4222b6d5f..00000000000 --- a/lib/mongodb/connection/server.js +++ /dev/null @@ -1,622 +0,0 @@ -var Connection = require('./connection').Connection, - DbCommand = require('../commands/db_command').DbCommand, - MongoReply = require('../responses/mongo_reply').MongoReply, - ConnectionPool = require('./connection_pool').ConnectionPool, - SimpleEmitter = require('./simple_emitter').SimpleEmitter, - MongoReply = require("../responses/mongo_reply").MongoReply, - inherits = require('util').inherits; - -var Server = exports.Server = function(host, port, options) { - var self = this; - this.host = host; - this.port = port; - this.options = options == null ? {} : options; - this.internalConnection; - this.internalMaster = false; - this.connected = false; - this.poolSize = this.options.poolSize == null ? 1 : this.options.poolSize; - this.ssl = this.options.ssl == null ? false : this.options.ssl; - this.slaveOk = this.options["slave_ok"]; - this._used = false; - - // Get the readPreference - var readPreference = this.options['readPreference']; - // Read preference setting - if(readPreference != null) { - if(readPreference != Server.READ_PRIMARY && readPreference != Server.READ_SECONDARY_ONLY - && readPreference != Server.READ_SECONDARY) { - throw new Error("Illegal readPreference mode specified, " + readPreference); - } - - // Set read Preference - this._readPreference = readPreference; - } else { - this._readPreference = null; - } - - // Contains the isMaster information returned from the server - this.isMasterDoc; - - // Set default connection pool options - this.socketOptions = this.options.socketOptions != null ? this.options.socketOptions : {}; - // Set ssl up if it's defined - if(this.ssl) { - this.socketOptions.ssl = true; - } - - // Set up logger if any set - this.logger = this.options.logger != null - && (typeof this.options.logger.debug == 'function') - && (typeof this.options.logger.error == 'function') - && (typeof this.options.logger.debug == 'function') - ? this.options.logger : {error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}}; - - // Just keeps list of events we allow - this.eventHandlers = {error:[], parseError:[], poolReady:[], message:[], close:[], timeout:[]}; - // Internal state of server connection - this._serverState = 'disconnected'; - // this._timeout = false; - // Contains state information about server connection - this._state = {'runtimeStats': {'queryStats':new RunningStats()}}; - // Do we record server stats or not - this.recordQueryStats = false; - - // Setters and getters - Object.defineProperty(this, "autoReconnect", { enumerable: true - , get: function () { - return this.options['auto_reconnect'] == null ? false : this.options['auto_reconnect']; - } - }); - - Object.defineProperty(this, "connection", { enumerable: true - , get: function () { - return this.internalConnection; - } - , set: function(connection) { - this.internalConnection = connection; - } - }); - - Object.defineProperty(this, "master", { enumerable: true - , get: function () { - return this.internalMaster; - } - , set: function(value) { - this.internalMaster = value; - } - }); - - Object.defineProperty(this, "primary", { enumerable: true - , get: function () { - return this; - } - }); - - // Getter for query Stats - Object.defineProperty(this, "queryStats", { enumerable: true - , get: function () { - return this._state.runtimeStats.queryStats; - } - }); - - Object.defineProperty(this, "runtimeStats", { enumerable: true - , get: function () { - return this._state.runtimeStats; - } - }); - - // Get Read Preference method - Object.defineProperty(this, "readPreference", { enumerable: true - , get: function () { - if(this._readPreference == null && this.readSecondary) { - return Server.READ_SECONDARY; - } else if(this._readPreference == null && !this.readSecondary) { - return Server.READ_PRIMARY; - } else { - return this._readPreference; - } - } - }); -}; - -// Inherit simple event emitter -inherits(Server, SimpleEmitter); -// Read Preferences -Server.READ_PRIMARY = 'primary'; -Server.READ_SECONDARY = 'secondary'; -Server.READ_SECONDARY_ONLY = 'secondaryOnly'; - -// Always ourselves -Server.prototype.setReadPreference = function() {} - -// Return the used state -Server.prototype._isUsed = function() { - return this._used; -} - -// Server close function -Server.prototype.close = function(callback) { - // Remove all local listeners - this.removeAllListeners(); - - if(this.connectionPool != null) { - // Remove all the listeners on the pool so it does not fire messages all over the place - this.connectionPool.removeAllEventListeners(); - // Close the connection if it's open - this.connectionPool.stop(); - } - - // Set server status as disconnected - this._serverState = 'disconnected'; - // Peform callback if present - if(typeof callback === 'function') callback(); -}; - -Server.prototype.isConnected = function() { - return this.connectionPool != null && this.connectionPool.isConnected(); -} - -Server.prototype.allServerInstances = function() { - return [this]; -} - -Server.prototype.isSetMember = function() { - return this['replicasetInstance'] != null; -} - -Server.prototype.connect = function(dbInstance, options, callback) { - if('function' === typeof options) callback = options, options = {}; - if(options == null) options = {}; - if(!('function' === typeof callback)) callback = null; - - // Currently needed to work around problems with multiple connections in a pool with ssl - // TODO fix if possible - if(this.ssl == true) { - // Set up socket options for ssl - this.socketOptions.ssl = true; - } - - // Let's connect - var server = this; - // Let's us override the main receiver of events - var eventReceiver = options.eventReceiver != null ? options.eventReceiver : this; - // Creating dbInstance - this.dbInstance = dbInstance; - // Save reference to dbInstance - this.dbInstances = [dbInstance]; - - // Set server state to connecting - this._serverState = 'connecting'; - // Ensure dbInstance can do a slave query if it's set - dbInstance.slaveOk = this.slaveOk ? this.slaveOk : dbInstance.slaveOk; - // Create connection Pool instance with the current BSON serializer - var connectionPool = new ConnectionPool(this.host, this.port, this.poolSize, dbInstance.bson, this.socketOptions); - // Set logger on pool - connectionPool.logger = this.logger; - - // Set up a new pool using default settings - server.connectionPool = connectionPool; - - // Set basic parameters passed in - var returnIsMasterResults = options.returnIsMasterResults == null ? false : options.returnIsMasterResults; - - // Create a default connect handler, overriden when using replicasets - var connectCallback = function(err, reply) { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Internal callback - if(err != null) return internalCallback(err, null); - server.master = reply.documents[0].ismaster == 1 ? true : false; - server.connectionPool.setMaxBsonSize(reply.documents[0].maxBsonObjectSize); - // Set server as connected - server.connected = true; - // Save document returned so we can query it - server.isMasterDoc = reply.documents[0]; - - // If we have it set to returnIsMasterResults - if(returnIsMasterResults) { - internalCallback(null, reply); - } else { - internalCallback(null, dbInstance); - } - }; - - // Let's us override the main connect callback - var connectHandler = options.connectHandler == null ? connectCallback : options.connectHandler; - - // Set up on connect method - connectionPool.on("poolReady", function() { - // Create db command and Add the callback to the list of callbacks by the request id (mapping outgoing messages to correct callbacks) - var db_command = DbCommand.NcreateIsMasterCommand(dbInstance, dbInstance.databaseName); - // Check out a reader from the pool - var connection = connectionPool.checkoutConnection(); - // Set server state to connected - server._serverState = 'connected'; - - // Register handler for messages - dbInstance._registerHandler(db_command, false, connection, connectHandler); - - // Write the command out - connection.write(db_command); - }) - - // Set up item connection - connectionPool.on("message", function(message) { - // Attempt to parse the message - try { - // Create a new mongo reply - var mongoReply = new MongoReply() - // Parse the header - mongoReply.parseHeader(message, connectionPool.bson) - // If message size is not the same as the buffer size - // something went terribly wrong somewhere - if(mongoReply.messageLength != message.length) { - // Emit the error - eventReceiver.emit("error", new Error("bson length is different from message length"), server); - // Remove all listeners - server.removeAllListeners(); - } else { - var startDate = new Date().getTime(); - - // Attempt to locate a callback instance - for(var i = 0; i < server.dbInstances.length; i++) { - var dbInstanceObject = server.dbInstances[i]; - // Locate the callback info - var callbackInfo = dbInstanceObject._findHandler(mongoReply.responseTo.toString()); - - // Only execute callback if we have a caller - if(callbackInfo.callback && Array.isArray(callbackInfo.info.chained)) { - // Check if callback has already been fired (missing chain command) - var chained = callbackInfo.info.chained; - var numberOfFoundCallbacks = 0; - for(var i = 0; i < chained.length; i++) { - if(dbInstanceObject._hasHandler(chained[i])) numberOfFoundCallbacks++; - } - - // If we have already fired then clean up rest of chain and move on - if(numberOfFoundCallbacks != chained.length) { - for(var i = 0; i < chained.length; i++) { - dbInstanceObject._removeHandler(chained[i]); - } - - // Just return from function - return; - } - - // Parse the body - mongoReply.parseBody(message, connectionPool.bson, callbackInfo.info.raw, function(err) { - var callbackInfo = dbInstanceObject._findHandler(mongoReply.responseTo.toString()); - // If we have an error let's execute the callback and clean up all other - // chained commands - var firstResult = mongoReply && mongoReply.documents; - // Check for an error, if we have one let's trigger the callback and clean up - // The chained callbacks - if(firstResult[0].err != null || firstResult[0].errmsg != null) { - // Trigger the callback for the error - dbInstanceObject._callHandler(mongoReply.responseTo, mongoReply, null); - } else { - var chainedIds = callbackInfo.info.chained; - - if(chainedIds.length > 0 && chainedIds[chainedIds.length - 1] == mongoReply.responseTo) { - // Cleanup all other chained calls - chainedIds.pop(); - // Remove listeners - for(var i = 0; i < chainedIds.length; i++) dbInstanceObject._removeHandler(chainedIds[i]); - // Call the handler - dbInstanceObject._callHandler(mongoReply.responseTo, callbackInfo.info.results.shift(), null); - } else{ - // Add the results to all the results - for(var i = 0; i < chainedIds.length; i++) { - var handler = dbInstanceObject._findHandler(chainedIds[i]); - // Check if we have an object, if it's the case take the current object commands and - // and add this one - if(handler.info != null) { - handler.info.results = Array.isArray(callbackInfo.info.results) ? callbackInfo.info.results : []; - handler.info.results.push(mongoReply); - } - } - } - } - }); - } else if(callbackInfo.callback) { - // Parse the body - mongoReply.parseBody(message, connectionPool.bson, callbackInfo.info.raw, function(err) { - // Let's record the stats info if it's enabled - if(server.recordQueryStats == true && server._state['runtimeStats'] != null - && server._state.runtimeStats['queryStats'] instanceof RunningStats) { - // Add data point to the running statistics object - server._state.runtimeStats.queryStats.push(new Date().getTime() - callbackInfo.info.start); - } - - // Trigger the callback - dbInstanceObject._callHandler(mongoReply.responseTo, mongoReply, null); - }); - } - } - } - } catch (err) { - // Throw error in next tick - process.nextTick(function() { - throw err; - }) - } - }); - - // Handle timeout - connectionPool.on("timeout", function(err) { - // If pool connection is already closed - if(server._serverState === 'disconnected') return; - // Set server state to disconnected - server._serverState = 'disconnected'; - // Close the pool - connectionPool.stop(); - // If we have a callback return the error - if(typeof callback === 'function') { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(err, null); - } else if(server.isSetMember()) { - server.emit("timeout", err, server); - } else { - eventReceiver.emit("timeout", err, server); - } - - // If we are a single server connection fire errors correctly - if(!server.isSetMember()) { - // Fire all callback errors - _fireCallbackErrors(server, err); - // Emit error - _emitAcrossAllDbInstances(server, eventReceiver, "timeout", err, server); - } - }); - - // Handle errors - connectionPool.on("error", function(message) { - // If pool connection is already closed - if(server._serverState === 'disconnected') return; - // Set server state to disconnected - server._serverState = 'disconnected'; - // Close the pool - connectionPool.stop(); - // If we have a callback return the error - if(typeof callback === 'function') {// && !server.isSetMember()) { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(new Error(message && message.err ? message.err : message), null); - } else if(server.isSetMember()) { - server.emit("error", new Error(message && message.err ? message.err : message), server); - } else { - eventReceiver.emit("error", new Error(message && message.err ? message.err : message), server); - } - - // If we are a single server connection fire errors correctly - if(!server.isSetMember()) { - // Fire all callback errors - _fireCallbackErrors(server, new Error(message && message.err ? message.err : message)); - // Emit error - _emitAcrossAllDbInstances(server, eventReceiver, "error", new Error(message && message.err ? message.err : message), server); - } - }); - - // Handle close events - connectionPool.on("close", function() { - // If pool connection is already closed - if(server._serverState === 'disconnected') return; - // Set server state to disconnected - server._serverState = 'disconnected'; - // Close the pool - connectionPool.stop(true); - // If we have a callback return the error - if(typeof callback === 'function') { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(new Error("connection closed"), null); - } else if(server.isSetMember()) { - server.emit("close", new Error("connection closed"), server); - } else { - eventReceiver.emit("close", new Error("connection closed"), server); - } - - // If we are a single server connection fire errors correctly - if(!server.isSetMember()) { - // Fire all callback errors - _fireCallbackErrors(server, new Error("connection closed")); - // Emit error - _emitAcrossAllDbInstances(server, eventReceiver, "close", server); - } - }); - - // If we have a parser error we are in an unknown state, close everything and emit - // error - connectionPool.on("parseError", function(message) { - // If pool connection is already closed - if(server._serverState === 'disconnected') return; - // Set server state to disconnected - server._serverState = 'disconnected'; - // Close the pool - connectionPool.stop(); - // If we have a callback return the error - if(typeof callback === 'function') { - // ensure no callbacks get called twice - var internalCallback = callback; - callback = null; - // Perform callback - internalCallback(new Error("connection closed due to parseError"), null); - } else if(server.isSetMember()) { - server.emit("parseError", new Error("connection closed due to parseError"), server); - } else { - eventReceiver.emit("parseError", new Error("connection closed due to parseError"), server); - } - - // If we are a single server connection fire errors correctly - if(!server.isSetMember()) { - // Fire all callback errors - _fireCallbackErrors(server, new Error("connection closed due to parseError")); - // Emit error - _emitAcrossAllDbInstances(server, eventReceiver, "parseError", server); - } - }); - - // Boot up connection poole, pass in a locator of callbacks - connectionPool.start(); -} - -// Fire all the errors -var _fireCallbackErrors = function(server, err) { - // Locate all the possible callbacks that need to return - for(var i = 0; i < server.dbInstances.length; i++) { - // Fetch the db Instance - var dbInstance = server.dbInstances[i]; - // Check all callbacks - var keys = Object.keys(dbInstance._callBackStore._notReplied); - // For each key check if it's a callback that needs to be returned - for(var j = 0; j < keys.length; j++) { - var info = dbInstance._callBackStore._notReplied[keys[j]]; - if(info.connection.socketOptions.host === server.host && info.connection.socketOptions.port === server.port) { - dbInstance._callBackStore.emit(keys[j], err, null); - } - } - } -} - -var _emitAcrossAllDbInstances = function(server, filterDb, event, message, object) { - // Emit close event across all db instances sharing the sockets - var allServerInstances = server.allServerInstances(); - // Fetch the first server instance - var serverInstance = allServerInstances[0]; - // For all db instances signal all db instances - if(Array.isArray(serverInstance.dbInstances) && serverInstance.dbInstances.length > 1) { - for(var i = 0; i < serverInstance.dbInstances.length; i++) { - var dbInstance = serverInstance.dbInstances[i]; - // Check if it's our current db instance and skip if it is - if(filterDb == null || filterDb.databaseName !== dbInstance.databaseName || filterDb.tag !== dbInstance.tag) { - dbInstance.emit(event, message, object); - } - } - } -} - -Server.prototype.allRawConnections = function() { - return this.connectionPool.getAllConnections(); -} - -// Check if a writer can be provided -var canCheckoutWriter = function(self, read) { - // We cannot write to an arbiter or secondary server - if(self.isMasterDoc['arbiterOnly'] == true) { - return new Error("Cannot write to an arbiter"); - } if(self.isMasterDoc['secondary'] == true) { - return new Error("Cannot write to a secondary"); - } else if(read == true && self._readPreference == Server.READ_SECONDARY_ONLY && self.isMasterDoc['ismaster'] == true) { - return new Error("Cannot read from primary when secondary only specified"); - } - - // Return no error - return null; -} - -Server.prototype.checkoutWriter = function(read) { - if(read == true) return this.connectionPool.checkoutConnection(); - // Check if are allowed to do a checkout (if we try to use an arbiter f.ex) - var result = canCheckoutWriter(this, read); - // If the result is null check out a writer - if(result == null) { - return this.connectionPool.checkoutConnection(); - } else { - return result; - } -} - -// Check if a reader can be provided -var canCheckoutReader = function(self) { - // We cannot write to an arbiter or secondary server - if(self.isMasterDoc['arbiterOnly'] == true) { - return new Error("Cannot write to an arbiter"); - } else if(self._readPreference != null) { - // If the read preference is Primary and the instance is not a master return an error - if(self._readPreference == Server.READ_PRIMARY && self.isMasterDoc['ismaster'] != true) { - return new Error("Read preference is " + Server.READ_PRIMARY + " and server is not master"); - } else if(self._readPreference == Server.READ_SECONDARY_ONLY && self.isMasterDoc['ismaster'] == true) { - return new Error("Cannot read from primary when secondary only specified"); - } - } - - // Return no error - return null; -} - -Server.prototype.checkoutReader = function() { - // Check if are allowed to do a checkout (if we try to use an arbiter f.ex) - var result = canCheckoutReader(this); - // If the result is null check out a writer - if(result == null) { - return this.connectionPool.checkoutConnection(); - } else { - return result; - } -} - -Server.prototype.enableRecordQueryStats = function(enable) { - this.recordQueryStats = enable; -} - -// -// Internal statistics object used for calculating average and standard devitation on -// running queries -var RunningStats = function() { - var self = this; - this.m_n = 0; - this.m_oldM = 0.0; - this.m_oldS = 0.0; - this.m_newM = 0.0; - this.m_newS = 0.0; - - // Define getters - Object.defineProperty(this, "numDataValues", { enumerable: true - , get: function () { return this.m_n; } - }); - - Object.defineProperty(this, "mean", { enumerable: true - , get: function () { return (this.m_n > 0) ? this.m_newM : 0.0; } - }); - - Object.defineProperty(this, "variance", { enumerable: true - , get: function () { return ((this.m_n > 1) ? this.m_newS/(this.m_n - 1) : 0.0); } - }); - - Object.defineProperty(this, "standardDeviation", { enumerable: true - , get: function () { return Math.sqrt(this.variance); } - }); - - Object.defineProperty(this, "sScore", { enumerable: true - , get: function () { - var bottom = this.mean + this.standardDeviation; - if(bottom == 0) return 0; - return ((2 * this.mean * this.standardDeviation)/(bottom)); - } - }); -} - -RunningStats.prototype.push = function(x) { - // Update the number of samples - this.m_n = this.m_n + 1; - // See Knuth TAOCP vol 2, 3rd edition, page 232 - if(this.m_n == 1) { - this.m_oldM = this.m_newM = x; - this.m_oldS = 0.0; - } else { - this.m_newM = this.m_oldM + (x - this.m_oldM) / this.m_n; - this.m_newS = this.m_oldS + (x - this.m_oldM) * (x - this.m_newM); - - // set up for next iteration - this.m_oldM = this.m_newM; - this.m_oldS = this.m_newS; - } -} diff --git a/lib/mongodb/connection/simple_emitter.js b/lib/mongodb/connection/simple_emitter.js deleted file mode 100644 index 6782cbc30bc..00000000000 --- a/lib/mongodb/connection/simple_emitter.js +++ /dev/null @@ -1,48 +0,0 @@ -var SimpleEmitter = exports.SimpleEmitter = function() {} -// -// My own simple synchronous emit support, We don't need the overhead of the built in flexible node.js -// event emitter as we are looking for as low latency as possible. -// -SimpleEmitter.prototype.on = function(event, callback) { - if(this.eventHandlers[event] == null) throw "Event handler only accepts values of " + Object.keys(this.eventHandlers); - // Just add callback to our event handler (avoiding the cost of the node.js event handler) - this.eventHandlers[event].push(callback); -} - -SimpleEmitter.prototype.emit = function(event, err, object) { - if(this.eventHandlers[event] == null) throw "Event handler only accepts values of " + Object.keys(this.eventHandlers); - // Fire off all the callbacks - var callbacks = this.eventHandlers[event]; - // Attemp to emit - try { - // Perform a callback on all the registered callback handlers - for(var i = 0; i < callbacks.length; i++) { - callbacks[i](err, object); - } - } catch (err) { - this.emit("error", err); - } -} - -SimpleEmitter.prototype.listeners = function(event) { - return this.eventHandlers[event]; -} - -SimpleEmitter.prototype.overrideListeners = function(event, listeners) { - this.eventHandlers[event] = listeners; -} - -SimpleEmitter.prototype.removeListeners = function(event) { - if(this.eventHandlers[event] == null) throw "Event handler only accepts values of " + Object.keys(this.eventHandlers); - // Throw away all handlers - this.eventHandlers[event] = []; -} - -SimpleEmitter.prototype.removeAllListeners = function() { - // Fetch all the keys of handlers - var keys = Object.keys(this.eventHandlers); - // Remove all handlers - for(var i = 0; i < keys.length; i++) { - this.eventHandlers[keys[i]] = []; - } -} diff --git a/lib/mongodb/connection/strategies/ping_strategy.js b/lib/mongodb/connection/strategies/ping_strategy.js deleted file mode 100644 index 6bb36cff276..00000000000 --- a/lib/mongodb/connection/strategies/ping_strategy.js +++ /dev/null @@ -1,125 +0,0 @@ -var Server = require("../server").Server; - -// The ping strategy uses pings each server and records the -// elapsed time for the server so it can pick a server based on lowest -// return time for the db command {ping:true} -var PingStrategy = exports.PingStrategy = function(replicaset) { - this.replicaset = replicaset; - this.state = 'disconnected'; - // Class instance - this.Db = require("../../db").Db; -} - -// Starts any needed code -PingStrategy.prototype.start = function(callback) { - this.state = 'connected'; - // Start ping server - this._pingServer(callback); -} - -// Stops and kills any processes running -PingStrategy.prototype.stop = function(callback) { - // Stop the ping process - this.state = 'disconnected'; - // Call the callback - callback(null, null); -} - -PingStrategy.prototype.checkoutSecondary = function() { - // Get all secondary server keys - var keys = Object.keys(this.replicaset._state.secondaries); - // Contains the picked instance - var minimumPingMs = null; - var selectedInstance = null; - // Pick server key by the lowest ping time - for(var i = 0; i < keys.length; i++) { - // Fetch a server - var server = this.replicaset._state.secondaries[keys[i]]; - // If we don't have a ping time use it - if(server.runtimeStats['pingMs'] == null) { - // Set to 0 ms for the start - server.runtimeStats['pingMs'] = 0; - // Pick server - selectedInstance = server; - break; - } else { - // If the next server's ping time is less than the current one choose than one - if(minimumPingMs == null || server.runtimeStats['pingMs'] < minimumPingMs) { - minimumPingMs = server.runtimeStats['pingMs']; - selectedInstance = server; - } - } - } - - // Return the selected instance - return selectedInstance != null ? selectedInstance.checkoutReader() : null; -} - -PingStrategy.prototype._pingServer = function(callback) { - var self = this; - - // Ping server function - var pingFunction = function() { - if(self.state == 'disconnected') return; - var addresses = self.replicaset._state != null && self.replicaset._state.addresses != null ? self.replicaset._state.addresses : null; - // Grab all servers - var serverKeys = Object.keys(addresses); - // Number of server entries - var numberOfEntries = serverKeys.length; - // We got keys - for(var i = 0; i < serverKeys.length; i++) { - // We got a server instance - var server = addresses[serverKeys[i]]; - // Create a new server object, avoid using internal connections as they might - // be in an illegal state - new function(serverInstance) { - var server = new Server(serverInstance.host, serverInstance.port, {poolSize:1, timeout:500}); - var db = new self.Db(self.replicaset.db.databaseName, server); - // Add error listener - db.on("error", function(err) { - // Adjust the number of checks - numberOfEntries = numberOfEntries - 1; - // Close connection - db.close(); - // If we are done with all results coming back trigger ping again - if(numberOfEntries == 0 && self.state == 'connected') { - setTimeout(pingFunction, 1000); - } - }) - - // Open the db instance - db.open(function(err, p_db) { - if(err != null) { - db.close(); - } else { - // Startup time of the command - var startTime = new Date().getTime(); - // Execute ping on this connection - p_db.executeDbCommand({ping:1}, function(err, result) { - // Adjust the number of checks - numberOfEntries = numberOfEntries - 1; - // Get end time of the command - var endTime = new Date().getTime(); - // Store the ping time in the server instance state variable, if there is one - if(serverInstance != null && serverInstance.runtimeStats != null && serverInstance.isConnected()) { - serverInstance.runtimeStats['pingMs'] = (endTime - startTime); - } - - // Close server - p_db.close(); - // If we are done with all results coming back trigger ping again - if(numberOfEntries == 0 && self.state == 'connected') { - setTimeout(pingFunction, 1000); - } - }) - } - }) - }(server); - } - } - - // Start pingFunction - setTimeout(pingFunction, 1000); - // Do the callback - callback(null); -} diff --git a/lib/mongodb/connection/strategies/statistics_strategy.js b/lib/mongodb/connection/strategies/statistics_strategy.js deleted file mode 100644 index 0c8b1c0832f..00000000000 --- a/lib/mongodb/connection/strategies/statistics_strategy.js +++ /dev/null @@ -1,40 +0,0 @@ -// The Statistics strategy uses the measure of each end-start time for each -// query executed against the db to calculate the mean, variance and standard deviation -// and pick the server which the lowest mean and deviation -var StatisticsStrategy = exports.StatisticsStrategy = function(replicaset) { - this.replicaset = replicaset; -} - -// Starts any needed code -StatisticsStrategy.prototype.start = function(callback) { - callback(null, null); -} - -StatisticsStrategy.prototype.stop = function(callback) { - // Remove reference to replicaset - this.replicaset = null; - // Perform callback - callback(null, null); -} - -StatisticsStrategy.prototype.checkoutSecondary = function() { - // Get all secondary server keys - var keys = Object.keys(this.replicaset._state.secondaries); - // Contains the picked instance - var minimumSscore = null; - var selectedInstance = null; - - // Pick server key by the lowest ping time - for(var i = 0; i < keys.length; i++) { - // Fetch a server - var server = this.replicaset._state.secondaries[keys[i]]; - // Pick server by lowest Sscore - if(minimumSscore == null || (server.queryStats.sScore < minimumSscore)) { - minimumSscore = server.queryStats.sScore; - selectedInstance = server; - } - } - - // Return the selected instance - return selectedInstance != null ? selectedInstance.checkoutReader() : null; -} diff --git a/lib/mongodb/cursor.js b/lib/mongodb/cursor.js deleted file mode 100644 index 1674fdb2e4e..00000000000 --- a/lib/mongodb/cursor.js +++ /dev/null @@ -1,704 +0,0 @@ -var QueryCommand = require('./commands/query_command').QueryCommand, - GetMoreCommand = require('./commands/get_more_command').GetMoreCommand, - KillCursorCommand = require('./commands/kill_cursor_command').KillCursorCommand, - Long = require('./bson/long').Long, - CursorStream = require('./cursorstream'), - debug = require('util').debug, - inspect = require('util').inspect, - utils = require('./utils'); - -/** - * Constructor for a cursor object that handles all the operations on query result - * using find. This cursor object is unidirectional and cannot traverse backwards. Clients should not be creating a cursor directly, - * but use find to acquire a cursor. - * - * @class Represents a Cursor. - * @param {Db} db the database object to work with. - * @param {Collection} collection the collection to query. - * @param {Object} selector the query selector. - * @param {Object} fields an object containing what fields to include or exclude from objects returned. - * @param {Number} skip number of documents to skip. - * @param {Number} limit the number of results to return. -1 has a special meaning and is used by Db.eval. A value of 1 will also be treated as if it were -1. - * @param {String|Array|Object} sort the required sorting for the query. - * @param {Object} hint force the query to use a specific index. - * @param {Boolean} explain return the explaination of the query. - * @param {Boolean} snapshot Snapshot mode assures no duplicates are returned. - * @param {Boolean} timeout allow the query to timeout. - * @param {Boolean} tailable allow the cursor to be tailable. - * @param {Number} batchSize the number of the subset of results to request the database to return for every request. This should initially be greater than 1 otherwise the database will automatically close the cursor. The batch size can be set to 1 with cursorInstance.batchSize after performing the initial query to the database. - * @param {Boolean} raw return all query documents as raw buffers (default false). - * @param {Boolean} read specify override of read from source (primary/secondary). - * @param {Boolean} returnKey only return the index key. - * @param {Number} maxScan limit the number of items to scan. - * @param {Number} min set index bounds. - * @param {Number} max set index bounds. - * @param {Boolean} showDiskLoc show disk location of results. - * @param {String} comment you can put a $comment field on a query to make looking in the profiler logs simpler. - */ -function Cursor(db, collection, selector, fields, skip, limit - , sort, hint, explain, snapshot, timeout, tailable, batchSize, slaveOk, raw, read - , returnKey, maxScan, min, max, showDiskLoc, comment) { - this.db = db; - this.collection = collection; - this.selector = selector; - this.fields = fields; - this.skipValue = skip == null ? 0 : skip; - this.limitValue = limit == null ? 0 : limit; - this.sortValue = sort; - this.hint = hint; - this.explainValue = explain; - this.snapshot = snapshot; - this.timeout = timeout == null ? true : timeout; - this.tailable = tailable; - this.batchSizeValue = batchSize == null ? 0 : batchSize; - this.slaveOk = slaveOk == null ? collection.slaveOk : slaveOk; - this.raw = raw == null ? false : raw; - this.read = read == null ? true : read; - this.returnKey = returnKey; - this.maxScan = maxScan; - this.min = min; - this.max = max; - this.showDiskLoc = showDiskLoc; - this.comment = comment; - - this.totalNumberOfRecords = 0; - this.items = []; - this.cursorId = Long.fromInt(0); - - // State variables for the cursor - this.state = Cursor.INIT; - // Keep track of the current query run - this.queryRun = false; - this.getMoreTimer = false; - this.collectionName = (this.db.databaseName ? this.db.databaseName + "." : '') + this.collection.collectionName; -}; - -/** - * Resets this cursor to its initial state. All settings like the query string, - * tailable, batchSizeValue, skipValue and limits are preserved. - * - * @return {Cursor} returns itself with rewind applied. - * @api public - */ -Cursor.prototype.rewind = function() { - var self = this; - - if (self.state != Cursor.INIT) { - if (self.state != Cursor.CLOSED) { - self.close(function() {}); - } - - self.numberOfReturned = 0; - self.totalNumberOfRecords = 0; - self.items = []; - self.cursorId = Long.fromInt(0); - self.state = Cursor.INIT; - self.queryRun = false; - } - - return self; -}; - - -/** - * Returns an array of documents. The caller is responsible for making sure that there - * is enough memory to store the results. Note that the array only contain partial - * results when this cursor had been previouly accessed. In that case, - * cursor.rewind() can be used to reset the cursor. - * - * @param {Function} callback This will be called after executing this method successfully. The first paramter will contain the Error object if an error occured, or null otherwise. The second paramter will contain an array of BSON deserialized objects as a result of the query. - * @return {null} - * @api public - */ -Cursor.prototype.toArray = function(callback) { - var self = this; - - if(!callback) { - throw new Error('callback is mandatory'); - } - - if(this.tailable) { - callback(new Error("Tailable cursor cannot be converted to array"), null); - } else if(this.state != Cursor.CLOSED) { - var items = []; - - this.each(function(err, item) { - if(err != null) return callback(err, null); - - if (item != null) { - items.push(item); - } else { - callback(err, items); - items = null; - self.items = []; - } - }); - } else { - callback(new Error("Cursor is closed"), null); - } -}; - -/** - * Iterates over all the documents for this cursor. As with **{cursor.toArray}**, - * not all of the elements will be iterated if this cursor had been previouly accessed. - * In that case, **{cursor.rewind}** can be used to reset the cursor. However, unlike - * **{cursor.toArray}**, the cursor will only hold a maximum of batch size elements - * at any given time if batch size is specified. Otherwise, the caller is responsible - * for making sure that the entire result can fit the memory. - * - * @param {Function} callback this will be called for while iterating every document of the query result. The first paramter will contain the Error object if an error occured, or null otherwise. While the second paramter will contain the document. - * @return {null} - * @api public - */ -Cursor.prototype.each = function(callback) { - var self = this; - - if (!callback) { - throw new Error('callback is mandatory'); - } - - if(this.state != Cursor.CLOSED) { - //FIX: stack overflow (on deep callback) (cred: https://github.com/limp/node-mongodb-native/commit/27da7e4b2af02035847f262b29837a94bbbf6ce2) - process.nextTick(function(){ - // Fetch the next object until there is no more objects - self.nextObject(function(err, item) { - if(err != null) return callback(err, null); - - if(item != null) { - callback(null, item); - self.each(callback); - } else { - // Close the cursor if done - self.state = Cursor.CLOSED; - callback(err, null); - } - - item = null; - }); - }); - } else { - callback(new Error("Cursor is closed"), null); - } -}; - -/** - * Determines how many result the query for this cursor will return - * - * @param {Function} callback this will be after executing this method. The first paramter will contain the Error object if an error occured, or null otherwise. While the second paramter will contain the number of results or null if an error occured. - * @return {null} - * @api public - */ -Cursor.prototype.count = function(callback) { - this.collection.count(this.selector, callback); -}; - -/** - * Sets the sort parameter of this cursor to the given value. - * - * This method has the following method signatures: - * (keyOrList, callback) - * (keyOrList, direction, callback) - * - * @param {String|Array|Object} keyOrList This can be a string or an array. If passed as a string, the string will be the field to sort. If passed an array, each element will represent a field to be sorted and should be an array that contains the format [string, direction]. - * @param {String|Number} direction this determines how the results are sorted. "asc", "ascending" or 1 for asceding order while "desc", "desceding or -1 for descending order. Note that the strings are case insensitive. - * @param {Function} callback this will be called after executing this method. The first parameter will contain an error object when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. - * @return {Cursor} an instance of this object. - * @api public - */ -Cursor.prototype.sort = function(keyOrList, direction, callback) { - callback = callback || function(){}; - if(typeof direction === "function") { callback = direction; direction = null; } - - if(this.tailable) { - callback(new Error("Tailable cursor doesn't support sorting"), null); - } else if(this.queryRun == true || this.state == Cursor.CLOSED) { - callback(new Error("Cursor is closed"), null); - } else { - var order = keyOrList; - - if(direction != null) { - order = [[keyOrList, direction]]; - } - - this.sortValue = order; - callback(null, this); - } - return this; -}; - -/** - * Sets the limit parameter of this cursor to the given value. - * - * @param {Number} limit the new limit. - * @param {Function} callback this will be called after executing this method. The first parameter will contain an error object when the limit given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. - * @return {Cursor} an instance of this object. - * @api public - */ -Cursor.prototype.limit = function(limit, callback) { - callback = callback || function(){}; - - if(this.tailable) { - callback(new Error("Tailable cursor doesn't support limit"), null); - } else if(this.queryRun == true || this.state == Cursor.CLOSED) { - callback(new Error("Cursor is closed"), null); - } else { - if(limit != null && limit.constructor != Number) { - callback(new Error("limit requires an integer"), null); - } else { - this.limitValue = limit; - callback(null, this); - } - } - - return this; -}; - -/** - * Sets the skip parameter of this cursor to the given value. - * - * @param {Number} skip the new skip value. - * @param {Function} callback this will be called after executing this method. The first parameter will contain an error object when the skip value given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. - * @return {Cursor} an instance of this object. - * @api public - */ -Cursor.prototype.skip = function(skip, callback) { - callback = callback || function(){}; - - if(this.tailable) { - callback(new Error("Tailable cursor doesn't support skip"), null); - } else if(this.queryRun == true || this.state == Cursor.CLOSED) { - callback(new Error("Cursor is closed"), null); - } else { - if(skip != null && skip.constructor != Number) { - callback(new Error("skip requires an integer"), null); - } else { - this.skipValue = skip; - callback(null, this); - } - } - - return this; -}; - -/** - * Sets the batch size parameter of this cursor to the given value. - * - * @param {Number} batchSize the new batch size. - * @param {Function} callback this will be called after executing this method. The first parameter will contain an error object when the batchSize given is not a valid number or when the cursor is already closed while the second parameter will contain a reference to this object upon successful execution. - * @return {Cursor} an instance of this object. - * @api public - */ -Cursor.prototype.batchSize = function(batchSize, callback) { - if(this.state == Cursor.CLOSED) { - if(callback != null) { - return callback(new Error("Cursor is closed"), null); - } else { - throw new Error("Cursor is closed"); - } - } else if(batchSize != null && batchSize.constructor != Number) { - if(callback != null) { - return callback(new Error("batchSize requires an integer"), null); - } else { - throw new Error("batchSize requires an integer"); - } - } else { - this.batchSizeValue = batchSize; - if(callback != null) return callback(null, this); - } - - return this; -}; - -/** - * The limit used for the getMore command - * - * @return {Number} The number of records to request per batch. - * @ignore - * @api private - */ -var limitRequest = function(self) { - var requestedLimit = self.limitValue; - - if(self.limitValue > 0) { - if (self.batchSizeValue > 0) { - requestedLimit = self.limitValue < self.batchSizeValue ? - self.limitValue : self.batchSizeValue; - } - } else { - requestedLimit = self.batchSizeValue; - } - - return requestedLimit; -}; - - -/** - * Generates a QueryCommand object using the parameters of this cursor. - * - * @return {QueryCommand} The command object - * @ignore - * @api private - */ -var generateQueryCommand = function(self) { - // Unpack the options - var queryOptions = QueryCommand.OPTS_NONE; - if(!self.timeout) { - queryOptions |= QueryCommand.OPTS_NO_CURSOR_TIMEOUT; - } - - if(self.tailable != null) { - queryOptions |= QueryCommand.OPTS_TAILABLE_CURSOR; - self.skipValue = self.limitValue = 0; - } - - if(self.slaveOk) { - queryOptions |= QueryCommand.OPTS_SLAVE; - } - - // limitValue of -1 is a special case used by Db#eval - var numberToReturn = self.limitValue == -1 ? -1 : limitRequest(self); - - // Check if we need a special selector - if(self.sortValue != null || self.explainValue != null || self.hint != null || self.snapshot != null - || self.returnKey != null || self.maxScan != null || self.min != null || self.max != null - || self.showDiskLoc != null || self.comment != null) { - - // Build special selector - var specialSelector = {'query':self.selector}; - if(self.sortValue != null) specialSelector['orderby'] = utils.formattedOrderClause(self.sortValue); - if(self.hint != null && self.hint.constructor == Object) specialSelector['$hint'] = self.hint; - if(self.explainValue != null) specialSelector['$explain'] = true; - if(self.snapshot != null) specialSelector['$snapshot'] = true; - if(self.returnKey != null) specialSelector['$returnKey'] = self.returnKey; - if(self.maxScan != null) specialSelector['$maxScan'] = self.maxScan; - if(self.min != null) specialSelector['$min'] = self.min; - if(self.max != null) specialSelector['$max'] = self.max; - if(self.showDiskLoc != null) specialSelector['$showDiskLoc'] = self.showDiskLoc; - if(self.comment != null) specialSelector['$comment'] = self.comment; - - // Return the query - return new QueryCommand(self.db, self.collectionName, queryOptions, self.skipValue, numberToReturn, specialSelector, self.fields); - } else { - return new QueryCommand(self.db, self.collectionName, queryOptions, self.skipValue, numberToReturn, self.selector, self.fields); - } -}; - -/** - * @return {Object} Returns an object containing the sort value of this cursor with - * the proper formatting that can be used internally in this cursor. - * @ignore - * @api private - */ -Cursor.prototype.formattedOrderClause = function() { - return utils.formattedOrderClause(this.sortValue); -}; - -/** - * Converts the value of the sort direction into its equivalent numerical value. - * - * @param sortDirection {String|number} Range of acceptable values: - * 'ascending', 'descending', 'asc', 'desc', 1, -1 - * - * @return {number} The equivalent numerical value - * @throws Error if the given sortDirection is invalid - * @ignore - * @api private - */ -Cursor.prototype.formatSortValue = function(sortDirection) { - return utils.formatSortValue(sortDirection); -}; - -/** - * Gets the next document from the cursor. - * - * @param {Function} callback this will be called after executing this method. The first parameter will contain an error object on error while the second parameter will contain a document from the returned result or null if there are no more results. - * @api public - */ -Cursor.prototype.nextObject = function(callback) { - var self = this; - - if(self.state == Cursor.INIT) { - var cmd; - try { - cmd = generateQueryCommand(self); - } catch (err) { - return callback(err, null); - } - - var commandHandler = function(err, result) { - if(err != null && result == null) return callback(err, null); - - if(!err && result.documents[0] && result.documents[0]['$err']) { - return self.close(function() {callback(result.documents[0]['$err'], null);}); - } - - self.queryRun = true; - self.state = Cursor.OPEN; // Adjust the state of the cursor - self.cursorId = result.cursorId; - self.totalNumberOfRecords = result.numberReturned; - - // Add the new documents to the list of items - self.items = self.items.concat(result.documents); - self.nextObject(callback); - result = null; - }; - - self.db._executeQueryCommand(cmd, {read:self.read, raw:self.raw}, commandHandler); - commandHandler = null; - } else if(self.items.length) { - callback(null, self.items.shift()); - } else if(self.cursorId.greaterThan(Long.fromInt(0))) { - getMore(self, callback); - } else { - // Force cursor to stay open - return self.close(function() {callback(null, null);}); - } -} - -/** - * Gets more results from the database if any. - * - * @param {Function} callback this will be called after executing this method. The first parameter will contain an error object on error while the second parameter will contain a document from the returned result or null if there are no more results. - * @ignore - * @api private - */ -var getMore = function(self, callback) { - var limit = 0; - - if (!self.tailable && self.limitValue > 0) { - limit = self.limitValue - self.totalNumberOfRecords; - if (limit < 1) { - self.close(function() {callback(null, null);}); - return; - } - } - try { - var getMoreCommand = new GetMoreCommand(self.db, self.collectionName, limitRequest(self), self.cursorId); - // Execute the command - self.db._executeQueryCommand(getMoreCommand, {read:self.read, raw:self.raw}, function(err, result) { - try { - if(err != null) callback(err, null); - - self.cursorId = result.cursorId; - self.totalNumberOfRecords += result.numberReturned; - // Determine if there's more documents to fetch - if(result.numberReturned > 0) { - if (self.limitValue > 0) { - var excessResult = self.totalNumberOfRecords - self.limitValue; - - if (excessResult > 0) { - result.documents.splice(-1 * excessResult, excessResult); - } - } - - self.items = self.items.concat(result.documents); - callback(null, self.items.shift()); - } else if(self.tailable) { - self.getMoreTimer = setTimeout(function() {getMore(self, callback);}, 500); - } else { - self.close(function() {callback(null, null);}); - } - - result = null; - } catch(err) { - callback(err, null); - } - }); - - getMoreCommand = null; - } catch(err) { - var handleClose = function() { - callback(err, null); - }; - - self.close(handleClose); - handleClose = null; - } -} - -/** - * Gets a detailed information about how the query is performed on this cursor and how - * long it took the database to process it. - * - * @param {Function} callback this will be called after executing this method. The first parameter will always be null while the second parameter will be an object containing the details. - * @api public - */ -Cursor.prototype.explain = function(callback) { - var limit = (-1)*Math.abs(this.limitValue); - // Create a new cursor and fetch the plan - var cursor = new Cursor(this.db, this.collection, this.selector, this.fields, this.skipValue, limit, - this.sortValue, this.hint, true, this.snapshot, this.timeout, this.tailable, this.batchSizeValue); - // Fetch the explaination document - cursor.nextObject(function(err, item) { - if(err != null) return callback(err, null); - // close the cursor - cursor.close(function(err, result) { - if(err != null) return callback(err, null); - callback(null, item); - }); - }); -}; - -/** - * Returns a stream object that can be used to listen to and stream records - * (**Use the CursorStream object instead as this is deprected**) - * - * Options - * - **fetchSize** {Number} the number of records to fetch in each batch (steam specific batchSize). - * - * Events - * - **data** {function(item) {}} the data event triggers when a document is ready. - * - **error** {function(err) {}} the error event triggers if an error happens. - * - **end** {function() {}} the end event triggers when there is no more documents available. - * - * @param {Object} [options] additional options for streamRecords. - * @return {EventEmitter} returns a stream object. - * @api public - */ -Cursor.prototype.streamRecords = function(options) { - var args = Array.prototype.slice.call(arguments, 0); - options = args.length ? args.shift() : {}; - - var - self = this, - stream = new process.EventEmitter(), - recordLimitValue = this.limitValue || 0, - emittedRecordCount = 0, - queryCommand = generateQueryCommand(self); - - // see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol - queryCommand.numberToReturn = options.fetchSize ? options.fetchSize : 500; - // Execute the query - execute(queryCommand); - - function execute(command) { - self.db._executeQueryCommand(command, {read:self.read, raw:self.raw}, function(err,result) { - if(err) { - stream.emit('error', err); - self.close(function(){}); - return; - } - - if (!self.queryRun && result) { - self.queryRun = true; - self.cursorId = result.cursorId; - self.state = Cursor.OPEN; - self.getMoreCommand = new GetMoreCommand(self.db, self.collectionName, queryCommand.numberToReturn, result.cursorId); - } - - var resflagsMap = { - CursorNotFound:1<<0, - QueryFailure:1<<1, - ShardConfigStale:1<<2, - AwaitCapable:1<<3 - }; - - if(result.documents && result.documents.length && !(result.responseFlag & resflagsMap.QueryFailure)) { - try { - result.documents.forEach(function(doc){ - if(recordLimitValue && emittedRecordCount>=recordLimitValue) { - throw("done"); - } - emittedRecordCount++; - stream.emit('data', doc); - }); - } catch(err) { - if (err != "done") { throw err; } - else { - self.close(function(){ - stream.emit('end', recordLimitValue); - }); - self.close(function(){}); - return; - } - } - // rinse & repeat - execute(self.getMoreCommand); - } else { - self.close(function(){ - stream.emit('end', recordLimitValue); - }); - } - }); - } - - return stream; -}; - -/** - * Returns a Node ReadStream interface for this cursor. - * - * @return {CursorStream} returns a stream object. - * @api public - */ -Cursor.prototype.stream = function stream () { - return new CursorStream(this); -} - -/** - * Close the cursor. - * - * @param {Function} callback this will be called after executing this method. The first parameter will always contain null while the second parameter will contain a reference to this cursor. - * @return {null} - * @api public - */ -Cursor.prototype.close = function(callback) { - var self = this - this.getMoreTimer && clearTimeout(this.getMoreTimer); - // Close the cursor if not needed - if(this.cursorId instanceof Long && this.cursorId.greaterThan(Long.fromInt(0))) { - try { - var command = new KillCursorCommand(this.db, [this.cursorId]); - this.db._executeQueryCommand(command, {read:self.read, raw:self.raw}, null); - } catch(err) {} - } - - // Reset cursor id - this.cursorId = Long.fromInt(0); - // Set to closed status - this.state = Cursor.CLOSED; - - if(callback) { - callback(null, self); - self.items = []; - } - - return this; -}; - -/** - * Check if the cursor is closed or open. - * - * @return {Boolean} returns the state of the cursor. - * @api public - */ -Cursor.prototype.isClosed = function() { - return this.state == Cursor.CLOSED ? true : false; -}; - -/** - * Init state - * - * @classconstant INIT - **/ -Cursor.INIT = 0; - -/** - * Cursor open - * - * @classconstant OPEN - **/ -Cursor.OPEN = 1; - -/** - * Cursor closed - * - * @classconstant CLOSED - **/ -Cursor.CLOSED = 2; - -/** - * @ignore - * @api private - */ -exports.Cursor = Cursor; diff --git a/lib/mongodb/cursorstream.js b/lib/mongodb/cursorstream.js deleted file mode 100644 index cb3d2ff60d7..00000000000 --- a/lib/mongodb/cursorstream.js +++ /dev/null @@ -1,139 +0,0 @@ -/** - * Module dependecies. - */ -var Stream = require('stream').Stream; - -/** - * CursorStream - * - * Returns a stream interface for the **cursor**. - * - * Events - * - **data** {function(item) {}} the data event triggers when a document is ready. - * - **error** {function(err) {}} the error event triggers if an error happens. - * - **end** {function() {}} the end event triggers when there is no more documents available. - * - * @class Represents a CursorStream. - * @param {Cursor} cursor a cursor object that the stream wraps. - * @return {Stream} - */ -function CursorStream(cursor) { - Stream.call(this); - - this.readable = true; - this.paused = false; - this._cursor = cursor; - this._destroyed = null; - - // give time to hook up events - var self = this; - process.nextTick(function () { - self._init(); - }); -} - -/** - * Inherit from Stream - * @ignore - * @api private - */ -CursorStream.prototype.__proto__ = Stream.prototype; - -/** - * Flag stating whether or not this stream is readable. - */ -CursorStream.prototype.readable; - -/** - * Flag stating whether or not this stream is paused. - */ -CursorStream.prototype.paused; - -/** - * Initialize the cursor. - * @ignore - * @api private - */ -CursorStream.prototype._init = function () { - if (this._destroyed) return; - this._next(); -} - -/** - * Pull the next document from the cursor. - * @ignore - * @api private - */ -CursorStream.prototype._next = function () { - if (this.paused || this._destroyed) return; - - var self = this; - - // nextTick is necessary to avoid stack overflows when - // dealing with large result sets. - process.nextTick(function () { - self._cursor.nextObject(function (err, doc) { - self._onNextObject(err, doc); - }); - }); -} - -/** - * Handle each document as its returned from the cursor. - * @ignore - * @api private - */ -CursorStream.prototype._onNextObject = function (err, doc) { - if (err) return this.destroy(err); - - // when doc is null we hit the end of the cursor - if (!doc) return this.destroy(); - - this.emit('data', doc); - this._next(); -} - -/** - * Pauses the stream. - * - * @api public - */ -CursorStream.prototype.pause = function () { - this.paused = true; -} - -/** - * Resumes the stream. - * - * @api public - */ -CursorStream.prototype.resume = function () { - this.paused = false; - this._next(); -} - -/** - * Destroys the stream, closing the underlying - * cursor. No more events will be emitted. - * - * @api public - */ -CursorStream.prototype.destroy = function (err) { - if (this._destroyed) return; - this._destroyed = true; - this.readable = false; - - this._cursor.close(); - - if (err) { - this.emit('error', err); - } - - this.emit('close'); -} - -// TODO - maybe implement the raw option to pass binary? -//CursorStream.prototype.setEncoding = function () { -//} - -module.exports = exports = CursorStream; diff --git a/lib/mongodb/db.js b/lib/mongodb/db.js deleted file mode 100644 index ec6a5d82f22..00000000000 --- a/lib/mongodb/db.js +++ /dev/null @@ -1,1694 +0,0 @@ -/** - * Module dependencies. - * @ignore - */ -var QueryCommand = require('./commands/query_command').QueryCommand, - DbCommand = require('./commands/db_command').DbCommand, - BinaryParser = require('./bson/binary_parser').BinaryParser, - MongoReply = require('./responses/mongo_reply').MongoReply, - Admin = require('./admin').Admin, - Collection = require('./collection').Collection, - Server = require('./connection/server').Server, - ReplSetServers = require('./connection/repl_set_servers').ReplSetServers, - Cursor = require('./cursor').Cursor, - EventEmitter = require('events').EventEmitter, - inherits = require('util').inherits, - crypto = require('crypto'), - debug = require('util').debug, - inspect = require('util').inspect, - b = require('./bson/bson'); - -/** - * Internal class for callback storage - * @ignore - */ -var CallbackStore = function() { - // Make class an event emitter - EventEmitter.call(this); - // Add a info about call variable - this._notReplied = {}; -} - -/** - * @ignore - */ -inherits(CallbackStore, EventEmitter); - -/** - * Create a new Db instance. - * - * Options - * - **strict** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, execute insert with a getLastError command returning the result of the insert command. - * - **native_parser** {Boolean, default:false}, use c++ bson parser. - * - **forceServerObjectId** {Boolean, default:false}, force server to create _id fields instead of client. - * - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. - * - **slaveOk** {Boolean, default:false}, allow reads from secondaries. - * - **serializeFunctions** {Boolean, default:false}, serialize functions. - * - **raw** {Boolean, default:false}, peform operations using raw bson buffers. - * - **recordQueryStats** {Boolean, default:false}, record query statistics during execution. - * - **reaper** {Boolean, default:false}, enables the reaper, timing out calls that never return. - * - **reaperInterval** {Number, default:10000}, number of miliseconds between reaper wakups. - * - **reaperTimeout** {Number, default:30000}, the amount of time before a callback times out. - * - **retryMiliSeconds** {Number, default:5000}, number of miliseconds between retries. - * - **numberOfRetries** {Number, default:5}, number of retries off connection. - * - * @class Represents a Collection - * @param {String} databaseName name of the database. - * @param {Object} serverConfig server config object. - * @param {Object} [options] additional options for the collection. - */ -function Db(databaseName, serverConfig, options) { - EventEmitter.call(this); - this.databaseName = databaseName; - this.serverConfig = serverConfig; - this.options = options == null ? {} : options; - // State to check against if the user force closed db - this._applicationClosed = false; - // Fetch the override flag if any - var overrideUsedFlag = this.options['override_used_flag'] == null ? false : this.options['override_used_flag']; - // Verify that nobody is using this config - if(!overrideUsedFlag && typeof this.serverConfig == 'object' && this.serverConfig._isUsed()) { - throw new Error("A Server or ReplSetServers instance cannot be shared across multiple Db instances"); - } else if(!overrideUsedFlag && typeof this.serverConfig == 'object'){ - // Set being used - this.serverConfig._used = true; - } - - // Ensure we have a valid db name - validateDatabaseName(databaseName); - - // Contains all the connections for the db - try { - this.native_parser = this.options.native_parser; - // The bson lib - var bsonLib = this.options.native_parser ? require('../../external-libs/bson') : new require('./bson/bson'); - // Fetch the serializer object - var BSON = bsonLib.BSON; - // Create a new instance - this.bson = new BSON([b.Long, b.ObjectID, b.Binary, b.Code, b.DBRef, b.Symbol, b.Double, b.Timestamp, b.MaxKey, b.MinKey]); - // Backward compatibility to access types - this.bson_deserializer = bsonLib; - this.bson_serializer = bsonLib; - } catch (err) { - // If we tried to instantiate the native driver - throw "Native bson parser not compiled, please compile or avoid using native_parser=true"; - } - - // Internal state of the server - this._state = 'disconnected'; - - this.pkFactory = this.options.pk == null ? b.ObjectID : this.options.pk; - this.forceServerObjectId = this.options.forceServerObjectId != null ? this.options.forceServerObjectId : false; - // Added strict - this.strict = this.options.strict == null ? false : this.options.strict; - this.notReplied ={}; - this.isInitializing = true; - this.auths = []; - - // Command queue, keeps a list of incoming commands that need to be executed once the connection is up - this.commands = []; - - // Contains all the callbacks - this._callBackStore = new CallbackStore(); - - // Set up logger - this.logger = this.options.logger != null - && (typeof this.options.logger.debug == 'function') - && (typeof this.options.logger.error == 'function') - && (typeof this.options.logger.log == 'function') - ? this.options.logger : {error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}}; - // Allow slaveOk - this.slaveOk = this.options["slave_ok"] == null ? false : this.options["slave_ok"]; - - var self = this; - // Associate the logger with the server config - this.serverConfig.logger = this.logger; - this.tag = new Date().getTime(); - // Just keeps list of events we allow - this.eventHandlers = {error:[], parseError:[], poolReady:[], message:[], close:[]}; - - // Controls serialization options - this.serializeFunctions = this.options.serializeFunctions != null ? this.options.serializeFunctions : false; - - // Raw mode - this.raw = this.options.raw != null ? this.options.raw : false; - - // Record query stats - this.recordQueryStats = this.options.recordQueryStats != null ? this.options.recordQueryStats : false; - - // If we have server stats let's make sure the driver objects have it enabled - if(this.recordQueryStats == true) { - this.serverConfig.enableRecordQueryStats(true); - } - - // Reaper enable setting - this.reaperEnabled = this.options.reaper != null ? this.options.reaper : false; - this._lastReaperTimestamp = new Date().getTime(); - - // Retry information - this.retryMiliSeconds = this.options.retryMiliSeconds != null ? this.options.retryMiliSeconds : 5000; - this.numberOfRetries = this.options.numberOfRetries != null ? this.options.numberOfRetries : 5; - - // Reaper information - this.reaperInterval = this.options.reaperInterval != null ? this.options.reaperInterval : 10000; - this.reaperTimeout = this.options.reaperTimeout != null ? this.options.reaperTimeout : 30000; - - // get self - var self = this; - // State of the db connection - Object.defineProperty(this, "state", { enumerable: true - , get: function () { - return this.serverConfig._serverState; - } - }); -}; - -/** - * The reaper cleans up any callbacks that have not returned inside the space set by - * the parameter reaperTimeout, it will only attempt to reap if the time since last reap - * is bigger or equal to the reaperInterval value - * @ignore - */ -var reaper = function(dbInstance, reaperInterval, reaperTimeout) { - // Get current time, compare to reaper interval - var currentTime = new Date().getTime(); - // Now calculate current time difference to check if it's time to reap - if((currentTime - dbInstance._lastReaperTimestamp) >= reaperInterval) { - // Save current timestamp for next reaper iteration - dbInstance._lastReaperTimestamp = currentTime; - // Get all non-replied to messages - var keys = Object.keys(dbInstance._callBackStore._notReplied); - // Iterate over all callbacks - for(var i = 0; i < keys.length; i++) { - // Fetch the current key - var key = keys[i]; - // Get info element - var info = dbInstance._callBackStore._notReplied[key]; - // If it's timed out let's remove the callback and return an error - if((currentTime - info.start) > reaperTimeout) { - // Cleanup - delete dbInstance._callBackStore._notReplied[key]; - // Perform callback in next Tick - process.nextTick(function() { - dbInstance._callBackStore.emit(key, new Error("operation timed out"), null); - }); - } - } - // Return reaping was done - return true; - } else { - // No reaping done - return false; - } -} - -/** - * @ignore - */ -function validateDatabaseName(databaseName) { - if(typeof databaseName !== 'string') throw new Error("database name must be a string"); - if(databaseName.length === 0) throw new Error("database name cannot be the empty string"); - - var invalidChars = [" ", ".", "$", "/", "\\"]; - for(var i = 0; i < invalidChars.length; i++) { - if(databaseName.indexOf(invalidChars[i]) != -1) throw new Error("database names cannot contain the character '" + invalidChars[i] + "'"); - } -} - -/** - * @ignore - */ -inherits(Db, EventEmitter); - -/** - * Initialize the database connection. - * - * @param {Function} callback returns index information. - * @return {null} - * @api public - */ -Db.prototype.open = function(callback) { - var self = this; - - // Set the status of the server - self._state = 'connecting'; - // Set up connections - if(self.serverConfig instanceof Server || self.serverConfig instanceof ReplSetServers) { - self.serverConfig.connect(self, {firstCall: true}, function(err, result) { - if(err != null) { - // Return error from connection - return callback(err, null); - } - // Set the status of the server - self._state = 'connected'; - // Callback - return callback(null, self); - }); - } else { - return callback(Error("Server parameter must be of type Server or ReplSetServers"), null); - } -}; - -/** - * Create a new Db instance sharing the current socket connections. - * - * @param {String} dbName the name of the database we want to use. - * @return {Db} a db instance using the new database. - * @api public - */ -Db.prototype.db = function(dbName) { - // Copy the options and add out internal override of the not shared flag - var options = {}; - for(var key in this.options) { - options[key] = this.options[key]; - } - // Add override flag - options['override_used_flag'] = true; - // Create a new db instance - var newDbInstance = new Db(dbName, this.serverConfig, options); - // Add the instance to the list of approved db instances - var allServerInstances = this.serverConfig.allServerInstances(); - // Add ourselves to all server callback instances - for(var i = 0; i < allServerInstances.length; i++) { - var server = allServerInstances[i]; - server.dbInstances.push(newDbInstance); - } - // Return new db object - return newDbInstance; -} - -/** - * Close the current db connection, including all the child db instances. Emits close event if no callback is provided. - * - * @param {Boolean} [forceClose] connection can never be reused. - * @param {Function} [callback] returns the results. - * @return {null} - * @api public - */ -Db.prototype.close = function(forceClose, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - // Ensure we force close all connections - this._applicationClosed = args.length ? args.shift() : false; - // Remove all listeners and close the connection - this.serverConfig.close(callback); - // Emit the close event - if(typeof callback !== 'function') this.emit("close"); - - // Emit close event across all db instances sharing the sockets - var allServerInstances = this.serverConfig.allServerInstances(); - // Fetch the first server instance - if(Array.isArray(allServerInstances) && allServerInstances.length > 0) { - var server = allServerInstances[0]; - // For all db instances signal all db instances - if(Array.isArray(server.dbInstances) && server.dbInstances.length > 1) { - for(var i = 0; i < server.dbInstances.length; i++) { - var dbInstance = server.dbInstances[i]; - // Check if it's our current db instance and skip if it is - if(dbInstance.databaseName !== this.databaseName && dbInstance.tag !== this.tag) { - server.dbInstances[i].emit("close"); - } - } - } - } - - // Remove all listeners - this.removeAllEventListeners(); -}; - -/** - * Access the Admin database - * - * @param {Function} [callback] returns the results. - * @return {Admin} the admin db object. - * @api public - */ -Db.prototype.admin = function(callback) { - if(callback == null) return new Admin(this); - callback(null, new Admin(this)); -}; - -/** - * Returns a cursor to all the collection information. - * - * @param {String} [collectionName] the collection name we wish to retrieve the information from. - * @param {Function} callback returns option results. - * @return {null} - * @api public - */ -Db.prototype.collectionsInfo = function(collectionName, callback) { - if(callback == null && typeof collectionName == 'function') { callback = collectionName; collectionName = null; } - // Create selector - var selector = {}; - // If we are limiting the access to a specific collection name - if(collectionName != null) selector.name = this.databaseName + "." + collectionName; - - // Return Cursor - // callback for backward compatibility - if(callback) { - callback(null, new Cursor(this, new Collection(this, DbCommand.SYSTEM_NAMESPACE_COLLECTION), selector)); - } else { - return new Cursor(this, new Collection(this, DbCommand.SYSTEM_NAMESPACE_COLLECTION), selector); - } -}; - -/** - * Get the list of all collection names for the specified db - * - * @param {String} [collectionName] the collection name we wish to filter by. - * @param {Function} callback returns option results. - * @return {null} - * @api public - */ -Db.prototype.collectionNames = function(collectionName, callback) { - if(callback == null && typeof collectionName == 'function') { callback = collectionName; collectionName = null; } - var self = this; - // Let's make our own callback to reuse the existing collections info method - self.collectionsInfo(collectionName, function(err, cursor) { - if(err != null) return callback(err, null); - - cursor.toArray(function(err, documents) { - if(err != null) return callback(err, null); - - // List of result documents that have been filtered - var filtered_documents = []; - // Remove any collections that are not part of the db or a system db signed with $ - documents.forEach(function(document) { - if(!(document.name.indexOf(self.databaseName) == -1 || document.name.indexOf('$') != -1)) - filtered_documents.push(document); - }); - // Return filtered items - callback(null, filtered_documents); - }); - }); -}; - -/** - * Fetch a specific collection (containing the actual collection information) - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - **slaveOk** {Boolean, default:false}, Allow reads from secondaries. - * - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. - * - **raw** {Boolean, default:false}, perform all operations using raw bson objects. - * - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. - * - * @param {String} collectionName the collection name we wish to access. - * @param {Object} [options] returns option results. - * @param {Function} [callback] returns the results. - * @return {null} - * @api public - */ -Db.prototype.collection = function(collectionName, options, callback) { - var self = this; - if(typeof options === "function") { callback = options; options = {}; } - // Execute safe - if(options && options.safe || this.strict) { - self.collectionNames(collectionName, function(err, collections) { - if(err != null) return callback(err, null); - - if(collections.length == 0) { - return callback(new Error("Collection " + collectionName + " does not exist. Currently in strict mode."), null); - } else { - try { - var collection = new Collection(self, collectionName, self.pkFactory, options); - } catch(err) { - return callback(err, null); - } - return callback(null, collection); - } - }); - } else { - try { - var collection = new Collection(self, collectionName, self.pkFactory, options); - } catch(err) { - if(callback == null) { - throw err; - } else { - return callback(err, null); - } - } - - // If we have no callback return collection object - return callback == null ? collection : callback(null, collection); - } -}; - -/** - * Fetch all collections for the current db. - * - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.collections = function(callback) { - var self = this; - // Let's get the collection names - self.collectionNames(function(err, documents) { - if(err != null) return callback(err, null); - var collections = []; - documents.forEach(function(document) { - collections.push(new Collection(self, document.name.replace(self.databaseName + ".", ''), self.pkFactory)); - }); - // Return the collection objects - callback(null, collections); - }); -}; - -/** - * Evaluate javascript on the server - * - * Options - * - **nolock** {Boolean, default:false}, Tell MongoDB not to block on the evaulation of the javascript. - * - * @param {Code} code javascript to execute on server. - * @param {Object|Array} [parameters] the parameters for the call. - * @param {Object} [options] the options - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.eval = function(code, parameters, options, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - parameters = args.length ? args.shift() : parameters; - options = args.length ? args.shift() : {}; - - var finalCode = code; - var finalParameters = []; - // If not a code object translate to one - if(!(finalCode instanceof b.Code)) { - finalCode = new b.Code(finalCode); - } - - // Ensure the parameters are correct - if(parameters != null && parameters.constructor != Array && typeof parameters !== 'function') { - finalParameters = [parameters]; - } else if(parameters != null && parameters.constructor == Array && typeof parameters !== 'function') { - finalParameters = parameters; - } - // Create execution selector - var selector = {'$eval':finalCode, 'args':finalParameters}; - // Check if the nolock parameter is passed in - if(options['nolock']) { - selector['nolock'] = options['nolock']; - } - - // Iterate through all the fields of the index - new Cursor(this, new Collection(this, DbCommand.SYSTEM_COMMAND_COLLECTION), selector, options, 0, -1).nextObject(function(err, result) { - if(err != null) return callback(err, null); - - if(result.ok == 1) { - callback(null, result.retval); - } else { - callback(new Error("eval failed: " + result.errmsg), null); return; - } - }); -}; - -/** - * Dereference a dbref, against a db - * - * @param {DBRef} dbRef db reference object we wish to resolve. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.dereference = function(dbRef, callback) { - var db = this; - // If we have a db reference then let's get the db first - if(dbRef.db != null) db = this.db(dbRef.db); - // Fetch the collection and find the reference - db.collection(dbRef.namespace, function(err, collection) { - if(err != null) return callback(err, null); - - collection.findOne({'_id':dbRef.oid}, function(err, result) { - callback(err, result); - }); - }); -}; - -/** - * Logout user from server, fire off on all connections and remove all auth info - * - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.logout = function(callback) { - var self = this; - // Let's generate the logout command object - var logoutCommand = DbCommand.logoutCommand(self, {logout:1}); - self._executeQueryCommand(logoutCommand, {onAll:true}, function(err, result) { - // Reset auth - self.auths = []; - // Handle any errors - if(err == null && result.documents[0].ok == 1) { - callback(null, true); - } else { - err != null ? callback(err, false) : callback(new Error(result.documents[0].errmsg), false); - } - }); -} - -/** - * Authenticate a user against the server. - * - * @param {String} username username. - * @param {String} password password. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.authenticate = function(username, password, callback) { - var self = this; - - // Push the new auth if we have no previous record - self.auths = [{'username':username, 'password':password}]; - // Get the amount of connections in the pool to ensure we have authenticated all comments - var numberOfConnections = this.serverConfig.allRawConnections().length; - var errorObject = null; - - // Execute all four - this._executeQueryCommand(DbCommand.createGetNonceCommand(self), {onAll:true}, function(err, result, connection) { - // Execute on all the connections - if(err == null) { - // Nonce used to make authentication request with md5 hash - var nonce = result.documents[0].nonce; - // Execute command - self._executeQueryCommand(DbCommand.createAuthenticationCommand(self, username, password, nonce), {connection:connection}, function(err, result) { - // Ensure we save any error - if(err) { - errorObject = err; - } else if(result.documents[0].err != null || result.documents[0].errmsg != null){ - errorObject = self.wrap(result.documents[0]); - } - - // Count down - numberOfConnections = numberOfConnections - 1; - - // If we are done with the callbacks return - if(numberOfConnections <= 0) { - if(errorObject == null && result.documents[0].ok == 1) { - callback(errorObject, true); - } else { - callback(errorObject, false); - } - } - }); - } - }); -}; - -/** - * Add a user to the database. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {String} username username. - * @param {String} password password. - * @param {Object} [options] additional options during update. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.addUser = function(username, password, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Figure out the safe mode settings - var safe = self.strict != null && self.strict == false ? true : self.strict; - // Override with options passed in if applicable - safe = options != null && options['safe'] != null ? options['safe'] : safe; - // Ensure it's at least set to safe - safe = safe == null ? true : safe; - - // Use node md5 generator - var md5 = crypto.createHash('md5'); - // Generate keys used for authentication - md5.update(username + ":mongo:" + password); - var userPassword = md5.digest('hex'); - // Fetch a user collection - this.collection(DbCommand.SYSTEM_USER_COLLECTION, function(err, collection) { - collection.find({user: username}).toArray(function(err, documents) { - // We got an error (f.ex not authorized) - if(err != null) return callback(err, null); - // We have a user, let's update the password - if(documents.length > 0) { - collection.update({user: username},{user: username, pwd: userPassword}, {safe:safe}, function(err, results) { - callback(err, documents); - }); - } else { - collection.insert({user: username, pwd: userPassword}, {safe:safe}, function(err, documents) { - callback(err, documents); - }); - } - }); - }); -}; - -/** - * Remove a user from a database - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - * @param {String} username username. - * @param {Object} [options] additional options during update. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.removeUser = function(username, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Figure out the safe mode settings - var safe = self.strict != null && self.strict == false ? true : self.strict; - // Override with options passed in if applicable - safe = options != null && options['safe'] != null ? options['safe'] : safe; - // Ensure it's at least set to safe - safe = safe == null ? true : safe; - - // Fetch a user collection - this.collection(DbCommand.SYSTEM_USER_COLLECTION, function(err, collection) { - collection.findOne({user: username}, function(err, user) { - if(user != null) { - collection.remove({user: username}, {safe:safe}, function(err, result) { - callback(err, true); - }); - } else { - callback(err, false); - } - }); - }); -}; - -/** - * Creates a collection on a server pre-allocating space, need to create f.ex capped collections. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - **slaveOk** {Boolean, default:false}, Allow reads from secondaries. - * - **serializeFunctions** {Boolean, default:false}, serialize functions on the document. - * - **raw** {Boolean, default:false}, perform all operations using raw bson objects. - * - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation. - * - **capped** {Boolean, default:false}, create a capped collection. - * - **size** {Number}, the size of the capped collection in bytes. - * - **max** {Number}, the maximum number of documents in the capped collection. - * - **autoIndexId** {Boolean, default:false}, create an index on the _id field of the document, not created automatically on capped collections. - * - * @param {String} collectionName the collection name we wish to access. - * @param {Object} [options] returns option results. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.createCollection = function(collectionName, options, callback) { - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : null; - var self = this; - - // Figure out the safe mode settings - var safe = self.strict != null && self.strict == false ? true : self.strict; - // Override with options passed in if applicable - safe = options != null && options['safe'] != null ? options['safe'] : safe; - // Ensure it's at least set to safe - safe = safe == null ? true : safe; - - // Check if we have the name - this.collectionNames(collectionName, function(err, collections) { - if(err != null) return callback(err, null); - - var found = false; - collections.forEach(function(collection) { - if(collection.name == self.databaseName + "." + collectionName) found = true; - }); - - // If the collection exists either throw an exception (if db in strict mode) or return the existing collection - if(found && ((options && options.safe) || self.strict)) { - return callback(new Error("Collection " + collectionName + " already exists. Currently in strict mode."), null); - } else if(found){ - try { - var collection = new Collection(self, collectionName, self.pkFactory, options); - } catch(err) { - return callback(err, null); - } - return callback(null, collection); - } - - // Create a new collection and return it - self._executeQueryCommand(DbCommand.createCreateCollectionCommand(self, collectionName, options), {read:false, safe:safe}, function(err, result) { - var document = result.documents[0]; - // If we have no error let's return the collection - if(err == null && document.ok == 1) { - try { - var collection = new Collection(self, collectionName, self.pkFactory, options); - } catch(err) { - return callback(err, null); - } - return callback(null, collection); - } else { - err != null ? callback(err, null) : callback(self.wrap(document), null); - } - }); - }); -}; - -/** - * Execute a command hash against MongoDB. This lets you acess any commands not available through the api on the server. - * - * @param {Object} selector the command hash to send to the server, ex: {ping:1}. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.command = function(selector, callback) { - var cursor = new Cursor(this, new Collection(this, DbCommand.SYSTEM_COMMAND_COLLECTION), selector, {}, 0, -1, null, null, null, null, QueryCommand.OPTS_NO_CURSOR_TIMEOUT); - cursor.nextObject(callback); -}; - -/** - * Drop a collection from the database, removing it permanently. New accesses will create a new collection. - * - * @param {String} collectionName the name of the collection we wish to drop. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.dropCollection = function(collectionName, callback) { - var self = this; - - // Drop the collection - this._executeQueryCommand(DbCommand.createDropCollectionCommand(this, collectionName), function(err, result) { - if(err == null && result.documents[0].ok == 1) { - if(callback != null) return callback(null, true); - } else { - if(callback != null) err != null ? callback(err, null) : callback(self.wrap(result.documents[0]), null); - } - }); -}; - -/** - * Rename a collection. - * - * @param {String} fromCollection the name of the current collection we wish to rename. - * @param {String} toCollection the new name of the collection. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.renameCollection = function(fromCollection, toCollection, callback) { - var self = this; - - // Execute the command, return the new renamed collection if successful - this._executeQueryCommand(DbCommand.createRenameCollectionCommand(this, fromCollection, toCollection), function(err, result) { - if(err == null && result.documents[0].ok == 1) { - if(callback != null) return callback(null, new Collection(self, toCollection, self.pkFactory)); - } else { - if(callback != null) err != null ? callback(err, null) : callback(self.wrap(result.documents[0]), null); - } - }); -}; - -/** - * Return last error message for the given connection, note options can be combined. - * - * Options - * - **fsync** {Boolean, default:false}, option forces the database to fsync all files before returning. - * - **j** {Boolean, default:false}, awaits the journal commit before returning, > MongoDB 2.0. - * - **w** {Number}, until a write operation has been replicated to N servers. - * - **wtimeout** {Number}, number of miliseconds to wait before timing out. - * - * Connection Options - * - **connection** {Connection}, fire the getLastError down a specific connection. - * - * @param {Object} [options] returns option results. - * @param {Object} [connectionOptions] returns option results. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.lastError = function(options, connectionOptions, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - options = args.length ? args.shift() : {}; - connectionOptions = args.length ? args.shift() : {}; - - this._executeQueryCommand(DbCommand.createGetLastErrorCommand(options, this), connectionOptions, function(err, error) { - callback(err, error && error.documents); - }); -}; - -/** - * Legacy method calls. - * - * @ignore - * @api private - */ -Db.prototype.error = Db.prototype.lastError; -Db.prototype.lastStatus = Db.prototype.lastError; - -/** - * Return all errors up to the last time db reset_error_history was called. - * - * Options - * - **connection** {Connection}, fire the getLastError down a specific connection. - * - * @param {Object} [options] returns option results. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.previousErrors = function(options, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - this._executeQueryCommand(DbCommand.createGetPreviousErrorsCommand(this), options, function(err, error) { - callback(err, error.documents); - }); -}; - -/** - * Runs a command on the database. - * @ignore - * @api private - */ -Db.prototype.executeDbCommand = function(command_hash, options, callback) { - if(callback == null) { callback = options; options = {}; } - this._executeQueryCommand(DbCommand.createDbSlaveOkCommand(this, command_hash, options), options, callback); -}; - -/** - * Runs a command on the database as admin. - * @ignore - * @api private - */ -Db.prototype.executeDbAdminCommand = function(command_hash, options, callback) { - if(callback == null) { callback = options; options = {}; } - this._executeQueryCommand(DbCommand.createAdminDbCommand(this, command_hash, options), callback); -}; - -/** - * Resets the error history of the mongo instance. - * - * Options - * - **connection** {Connection}, fire the getLastError down a specific connection. - * - * @param {Object} [options] returns option results. - * @param {Function} callback returns the results. - * @return {null} - * @api public - */ -Db.prototype.resetErrorHistory = function(options, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - this._executeQueryCommand(DbCommand.createResetErrorHistoryCommand(this), options, function(err, error) { - callback(err, error.documents); - }); -}; - -/** - * Creates an index on the collection. - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB. - * - **unique** {Boolean, default:false}, creates an unique index. - * - **sparse** {Boolean, default:false}, creates a sparse index. - * - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. - * - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value - * - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. - * - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. - * - * @param {String} collectionName name of the collection to create the index on. - * @param {Object} fieldOrSpec fieldOrSpec that defines the index. - * @param {Object} [options] additional options during update. - * @param {Function} callback for results. - * @return {null} - * @api public - */ -Db.prototype.createIndex = function(collectionName, fieldOrSpec, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Figure out the safe mode settings - var safe = self.strict != null && self.strict == false ? true : self.strict; - // Override with options passed in if applicable - safe = options != null && options['safe'] != null ? options['safe'] : safe; - // Ensure it's at least set to safe - safe = safe == null ? true : safe; - - // Create command - var command = DbCommand.createCreateIndexCommand(this, collectionName, fieldOrSpec, options); - // Execute insert command - this._executeInsertCommand(command, {read:false, safe:safe}, function(err, result) { - if(err != null) return callback(err, null); - - result = result && result.documents; - if (result[0].err) { - callback(self.wrap(result[0])); - } else { - callback(null, command.documents[0].name); - } - }); -}; - -/** - * Ensures that an index exists, if it does not it creates it - * - * Options - * - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a - * - **unique** {Boolean, default:false}, creates an unique index. - * - **sparse** {Boolean, default:false}, creates a sparse index. - * - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible. - * - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value - * - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates. - * - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates. - * - **v** {Number}, specify the format version of the indexes. - * - * @param {String} collectionName name of the collection to create the index on. - * @param {Object} fieldOrSpec fieldOrSpec that defines the index. - * @param {Object} [options] additional options during update. - * @param {Function} callback for results. - * @return {null} - * @api public - */ -Db.prototype.ensureIndex = function(collectionName, fieldOrSpec, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Figure out the safe mode settings - var safe = self.strict != null && self.strict == false ? true : self.strict; - // Override with options passed in if applicable - safe = options != null && options['safe'] != null ? options['safe'] : safe; - // Ensure it's at least set to safe - safe = safe == null ? true : safe; - - // Create command - var command = DbCommand.createCreateIndexCommand(this, collectionName, fieldOrSpec, options); - var index_name = command.documents[0].name; - var self = this; - // Check if the index allready exists - this.indexInformation(collectionName, function(err, collectionInfo) { - if(err != null) return callback(err, null); - - if(!collectionInfo[index_name]) { - self._executeInsertCommand(command, {read:false, safe:safe}, function(err, result) { - // Only callback if we have one specified - if(typeof callback === 'function') { - if(err != null) return callback(err, null); - - result = result && result.documents; - if (result[0].err) { - callback(self.wrap(result[0])); - } else { - callback(null, command.documents[0].name); - } - } - }); - } else { - if(typeof callback === 'function') return callback(null, index_name); - } - }); -}; - -/** - * Returns the information available on allocated cursors. - * - * @param {Function} callback for results. - * @return {null} - * @api public - */ -Db.prototype.cursorInfo = function(callback) { - this._executeQueryCommand(DbCommand.createDbSlaveOkCommand(this, {'cursorInfo':1}), function(err, result) { - callback(err, result.documents[0]); - }); -}; - -/** - * Drop an index on a collection. - * - * @param {String} collectionName the name of the collection where the command will drop an index. - * @param {String} indexName name of the index to drop. - * @param {Function} callback for results. - * @return {null} - * @api public - */ -Db.prototype.dropIndex = function(collectionName, indexName, callback) { - this._executeQueryCommand(DbCommand.createDropIndexCommand(this, collectionName, indexName), callback); -}; - -/** - * Reindex all indexes on the collection - * Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections. - * - * @param {String} collectionName the name of the collection. - * @param {Function} callback returns the results. - * @api public -**/ -Db.prototype.reIndex = function(collectionName, callback) { - this._executeQueryCommand(DbCommand.createReIndexCommand(this, collectionName), function(err, result) { - if(err != null) { - callback(err, false); - } else if(result.documents[0].errmsg == null) { - callback(null, true); - } else { - callback(new Error(result.documents[0].errmsg), false); - } - }); -}; - -/** - * Retrieves this collections index info. - * - * Options - * - **full** {Boolean, default:false}, returns the full raw index information. - * - * @param {String} collectionName the name of the collection. - * @param {Object} [options] additional options during update. - * @param {Function} callback returns the index information. - * @return {null} - * @api public - */ -Db.prototype.indexInformation = function(collectionName, options, callback) { - // Unpack calls - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - collectionName = args.length ? args.shift() : null; - options = args.length ? args.shift() : {}; - - // If we specified full information - var full = options['full'] == null ? false : options['full']; - // Build selector for the indexes - var selector = collectionName != null ? {ns: (this.databaseName + "." + collectionName)} : {}; - // Iterate through all the fields of the index - new Cursor(this, new Collection(this, DbCommand.SYSTEM_INDEX_COLLECTION), selector).toArray(function(err, indexes) { - if(err != null) return callback(err, null); - // Contains all the information - var info = {}; - - // if full defined just return all the indexes directly - if(full) return callback(null, indexes); - - // Process all the indexes - for(var i = 0; i < indexes.length; i++) { - var index = indexes[i]; - // Let's unpack the object - info[index.name] = []; - for(var name in index.key) { - info[index.name].push([name, index.key[name]]); - } - } - - // Return all the indexes - callback(null, info); - }); -}; - -/** - * Drop a database. - * - * @param {Function} callback returns the index information. - * @return {null} - * @api public - */ -Db.prototype.dropDatabase = function(callback) { - this._executeQueryCommand(DbCommand.createDropDatabaseCommand(this), function(err, result) { - callback(err, result); - }); -}; - -/** - * Register a handler - * @ignore - * @api private - */ -Db.prototype._registerHandler = function(db_command, raw, connection, callback) { - // If we have an array of commands, chain them - var chained = Array.isArray(db_command); - - // If they are chained we need to add a special handler situation - if(chained) { - // List off chained id's - var chainedIds = []; - // Add all id's - for(var i = 0; i < db_command.length; i++) chainedIds.push(db_command[i].getRequestId().toString()); - - // Register all the commands together - for(var i = 0; i < db_command.length; i++) { - var command = db_command[i]; - // Add the callback to the store - this._callBackStore.once(command.getRequestId(), callback); - // Add the information about the reply - this._callBackStore._notReplied[command.getRequestId().toString()] = {start: new Date().getTime(), 'raw': raw, chained:chainedIds, connection:connection}; - } - } else { - // Add the callback to the list of handlers - this._callBackStore.once(db_command.getRequestId(), callback); - // Add the information about the reply - this._callBackStore._notReplied[db_command.getRequestId().toString()] = {start: new Date().getTime(), 'raw': raw, connection:connection}; - } -} - -/** - * - * @ignore - * @api private - */ -Db.prototype._callHandler = function(id, document, err) { - // If there is a callback peform it - if(this._callBackStore.listeners(id).length >= 1) { - // Get info object - var info = this._callBackStore._notReplied[id]; - // Delete the current object - delete this._callBackStore._notReplied[id]; - // Emit to the callback of the object - this._callBackStore.emit(id, err, document, info.connection); - } -} - -/** - * - * @ignore - * @api private - */ -Db.prototype._hasHandler = function(id) { - // If there is a callback peform it - return this._callBackStore.listeners(id).length >= 1; -} - -/** - * - * @ignore - * @api private - */ -Db.prototype._removeHandler = function(id) { - // Remove the information - if(this._callBackStore._notReplied[id] != null) delete this._callBackStore._notReplied[id]; - // Remove the callback if it's registered - this._callBackStore.removeAllListeners(id); - // Force cleanup _events, node.js seems to set it as a null value - if(this._callBackStore._events != null) delete this._callBackStore._events[id]; -} - -/** - * - * @ignore - * @api private - */ -Db.prototype._findHandler = function(id) { - var info = this._callBackStore._notReplied[id]; - // Return the callback - return {info:info, callback:(this._callBackStore.listeners(id).length >= 1)} -} - -/** - * @ignore - */ -var __executeQueryCommand = function(self, db_command, options, callback) { - // Options unpacking - var read = options['read'] != null ? options['read'] : false; - var raw = options['raw'] != null ? options['raw'] : self.raw; - var onAll = options['onAll'] != null ? options['onAll'] : false; - var specifiedConnection = options['connection'] != null ? options['connection'] : null; - - // If we got a callback object - if(callback instanceof Function && !onAll) { - // Fetch either a reader or writer dependent on the specified read option - var connection = read == true || read === 'secondary' ? self.serverConfig.checkoutReader() : self.serverConfig.checkoutWriter(true); - // Override connection if needed - connection = specifiedConnection != null ? specifiedConnection : connection; - // Ensure we have a valid connection - if(connection == null) { - return callback(new Error("no open connections")); - } else if(connection instanceof Error) { - return callback(connection); - } - - // Perform reaping of any dead connection - if(self.reaperEnabled) reaper(self, self.reaperInterval, self.reaperTimeout); - - // Register the handler in the data structure - self._registerHandler(db_command, raw, connection, callback); - - // Write the message out and handle any errors if there are any - connection.write(db_command, function(err) { - if(err != null) { - // Call the handler with an error - self._callHandler(db_command.getRequestId(), null, err); - } - }); - } else if(callback instanceof Function && onAll) { - var connections = self.serverConfig.allRawConnections(); - var numberOfEntries = connections.length; - // Go through all the connections - for(var i = 0; i < connections.length; i++) { - // Fetch a connection - var connection = connections[i]; - // Override connection if needed - connection = specifiedConnection != null ? specifiedConnection : connection; - // Ensure we have a valid connection - if(connection == null) { - return callback(new Error("no open connections")); - } else if(connection instanceof Error) { - return callback(connection); - } - - // Register the handler in the data structure - self._registerHandler(db_command, raw, connection, callback); - - // Write the message out - connection.write(db_command, function(err) { - // Adjust the number of entries we need to process - numberOfEntries = numberOfEntries - 1; - // Remove listener - if(err != null) { - // Clean up listener and return error - self._removeHandler(db_command.getRequestId()); - } - - // No more entries to process callback with the error - if(numberOfEntries <= 0) { - callback(err); - } - }); - - // Update the db_command request id - db_command.updateRequestId(); - } - } else { - // Fetch either a reader or writer dependent on the specified read option - var connection = read == true || read === 'secondary' ? self.serverConfig.checkoutReader() : self.serverConfig.checkoutWriter(); - // Override connection if needed - connection = specifiedConnection != null ? specifiedConnection : connection; - // Ensure we have a valid connection - if(connection == null || connection instanceof Error) return null; - // Write the message out - connection.write(db_command, function(err) { - if(err != null) { - // Emit the error - self.emit("error", err); - } - }); - } -} - -/** - * @ignore - */ -var __retryCommandOnFailure = function(self, retryInMilliseconds, numberOfTimes, command, db_command, options, callback) { - if(this._state == 'connected' || this._state == 'disconnected') this._state = 'connecting'; - // Number of retries done - var numberOfRetriesDone = numberOfTimes; - // Retry function, execute once - var retryFunction = function(_self, _numberOfRetriesDone, _retryInMilliseconds, _numberOfTimes, _command, _db_command, _options, _callback) { - _self.serverConfig.connect(_self, {}, function(err, result) { - // Adjust the number of retries left - _numberOfRetriesDone = _numberOfRetriesDone - 1; - // Definitively restart - if(err != null && _numberOfRetriesDone > 0) { - _self._state = 'connecting'; - // Force close the current connections - _self.serverConfig.close(function(err) { - // Retry the connect - setTimeout(function() { - retryFunction(_self, _numberOfRetriesDone, _retryInMilliseconds, _numberOfTimes, _command, _db_command, _options, _callback); - }, _retryInMilliseconds); - }); - } else if(err != null && _numberOfRetriesDone <= 0) { - _self._state = 'disconnected'; - // Force close the current connections - _self.serverConfig.close(function(_err) { - // Force close the current connections - _callback(err, null); - }); - } else if(err == null && _self.serverConfig.isConnected() == true && Array.isArray(_self.auths) && _self.auths.length > 0) { - _self._state = 'connected'; - // Get number of auths we need to execute - var numberOfAuths = _self.auths.length; - // Apply all auths - for(var i = 0; i < _self.auths.length; i++) { - _self.authenticate(_self.auths[i].username, _self.auths[i].password, function(err, authenticated) { - numberOfAuths = numberOfAuths - 1; - - // If we have no more authentications to replay - if(numberOfAuths == 0) { - if(err != null || !authenticated) { - return _callback(err, null); - } else { - // Execute command - command(_self, _db_command, _options, function(err, result) { - // Peform the command callback - _callback(err, result); - // Execute any backed up commands - while(_self.commands.length > 0) { - // Fetch the command - var command = _self.commands.shift(); - // Execute based on type - if(command['type'] == 'query') { - __executeQueryCommand(_self, command['db_command'], command['options'], command['callback']); - } else if(command['type'] == 'insert') { - __executeInsertCommand(_self, command['db_command'], command['options'], command['callback']); - } - } - }); - } - } - }); - } - } else if(err == null && _self.serverConfig.isConnected() == true) { - _self._state = 'connected'; - // Execute command - command(_self, _db_command, _options, function(err, result) { - // Peform the command callback - _callback(err, result); - // Execute any backed up commands - while(_self.commands.length > 0) { - // Fetch the command - var command = _self.commands.shift(); - // Execute based on type - if(command['type'] == 'query') { - __executeQueryCommand(_self, command['db_command'], command['options'], command['callback']); - } else if(command['type'] == 'insert') { - __executeInsertCommand(_self, command['db_command'], command['options'], command['callback']); - } - } - }); - } else { - _self._state = 'connecting'; - // Force close the current connections - _self.serverConfig.close(function(err) { - // Retry the connect - setTimeout(function() { - retryFunction(_self, _numberOfRetriesDone, _retryInMilliseconds, _numberOfTimes, _command, _db_command, _options, _callback); - }, _retryInMilliseconds); - }); - } - }); - }; - - // Execute function first time - retryFunction(self, numberOfRetriesDone, retryInMilliseconds, numberOfTimes, command, db_command, options, callback); -} - -/** - * Execute db query command (not safe) - * @ignore - * @api private - */ -Db.prototype._executeQueryCommand = function(db_command, options, callback) { - var self = this; - // Unpack the parameters - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Check if the user force closed the command - if(this._applicationClosed) { - if(typeof callback == 'function') { - return callback(new Error("db closed by application"), null); - } else { - throw new Error("db closed by application"); - } - } - - // If the pool is not connected, attemp to reconnect to send the message - if(this._state == 'connecting' && this.serverConfig.autoReconnect) { - process.nextTick(function() { - self.commands.push({type:'insert', 'db_command':db_command, 'options':options, 'callback':callback}); - }) - } else if(!this.serverConfig.isConnected() && this.serverConfig.autoReconnect) { - this._state = 'connecting'; - // Retry command - __retryCommandOnFailure(this, this.retryMiliSeconds, this.numberOfRetries, __executeQueryCommand, db_command, options, callback); - } else { - __executeQueryCommand(self, db_command, options, callback) - } -}; - -/** - * @ignore - */ -var __executeInsertCommand = function(self, db_command, options, callback) { - // Always checkout a writer for this kind of operations - var connection = self.serverConfig.checkoutWriter(); - // Get strict mode - var safe = options['safe'] != null ? options['safe'] : false; - var raw = options['raw'] != null ? options['raw'] : self.raw; - var specifiedConnection = options['connection'] != null ? options['connection'] : null; - // Override connection if needed - connection = specifiedConnection != null ? specifiedConnection : connection; - - // Ensure we have a valid connection - if(callback instanceof Function) { - // Ensure we have a valid connection - if(connection == null) { - return callback(new Error("no open connections")); - } else if(connection instanceof Error) { - return callback(connection); - } - - // We are expecting a check right after the actual operation - if(safe != null && safe != false) { - // db command is now an array of commands (original command + lastError) - db_command = [db_command, DbCommand.createGetLastErrorCommand(safe, self)]; - - // Register the handler in the data structure - self._registerHandler(db_command[1], raw, connection, callback); - } - } - - // If we have no callback and there is no connection - if(connection == null) return null; - if(connection instanceof Error && typeof callback == 'function') return callback(connection, null); - if(connection instanceof Error) return null; - if(connection == null && typeof callback == 'function') return callback(new Error("no primary server found"), null); - - // Write the message out - connection.write(db_command, function(err) { - // Return the callback if it's not a safe operation and the callback is defined - if(callback instanceof Function && (safe == null || safe == false)) { - // Perform reaping - if(self.reaperEnabled) reaper(self, self.reaperInterval, self.reaperTimeout); - // Perform the callback - callback(err, null); - } else if(callback instanceof Function){ - // Call the handler with an error - self._callHandler(db_command[1].getRequestId(), null, err); - } else { - self.emit("error", err); - } - }); -} - -/** - * Execute an insert Command - * @ignore - * @api private - */ -Db.prototype._executeInsertCommand = function(db_command, options, callback) { - var self = this; - // Unpack the parameters - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - - // Check if the user force closed the command - if(this._applicationClosed) { - if(typeof callback == 'function') { - return callback(new Error("db closed by application"), null); - } else { - throw new Error("db closed by application"); - } - } - - // If the pool is not connected, attemp to reconnect to send the message - if(self._state == 'connecting' && this.serverConfig.autoReconnect) { - process.nextTick(function() { - self.commands.push({type:'insert', 'db_command':db_command, 'options':options, 'callback':callback}); - }) - } else if(!this.serverConfig.isConnected() && this.serverConfig.autoReconnect) { - this._state = 'connecting'; - // Retry command - __retryCommandOnFailure(this, this.retryMiliSeconds, this.numberOfRetries, __executeInsertCommand, db_command, options, callback); - } else { - __executeInsertCommand(self, db_command, options, callback) - } -} - -/** - * Update command is the same - * @ignore - * @api private - */ -Db.prototype._executeUpdateCommand = Db.prototype._executeInsertCommand; -/** - * Remove command is the same - * @ignore - * @api private - */ -Db.prototype._executeRemoveCommand = Db.prototype._executeInsertCommand; - -/** - * Wrap a Mongo error document into an Error instance - * @ignore - * @api private - */ -Db.prototype.wrap = function(error) { - var e = new Error(error.err != null ? error.err : error.errmsg); - e.name = 'MongoError'; - - // Get all object keys - var keys = Object.keys(error); - // Populate error object with properties - for(var i = 0; i < keys.length; i++) { - e[keys[i]] = error[keys[i]]; - } - - return e; -} - -/** - * Default URL - * - * @classconstant DEFAULT_URL - **/ -Db.DEFAULT_URL = 'mongodb://localhost:27017/default'; - -/** - * Connect to MongoDB using a url as documented at - * - * www.mongodb.org/display/DOCS/Connections - * - * @param {String} url connection url for MongoDB. - * @param {Object} options additional options not covered by the url. - * @param {Function} callback callback returns the initialized db. - * @return {null} - * @api public - */ -Db.connect = function(url, options, callback) { - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : null; - options = options || {}; - var serverOptions = options.server || {}; - var replSetServersOptions = options.replSetServers || {}; - var dbOptions = options.db || {}; - - var urlRE = new RegExp('^mongo(?:db)?://(?:|([^@/]*)@)([^@/]*)(?:|/([^?]*)(?:|\\?([^?]*)))$'); - var match = (url || Db.DEFAULT_URL).match(urlRE); - if (!match) - throw Error("URL must be in the format mongodb://user:pass@host:port/dbname"); - - var authPart = match[1] || ''; - var auth = authPart.split(':', 2); - var hostPart = match[2]; - var dbname = match[3] || 'default'; - var urlOptions = (match[4] || '').split(/[&;]/); - - // Ugh, we have to figure out which options go to which constructor manually. - urlOptions.forEach(function(opt) { - if (!opt) return; - var splitOpt = opt.split('='), name = splitOpt[0], value = splitOpt[1]; - - // Server options: - if (name == 'slaveOk' || name == 'slave_ok') - serverOptions.slave_ok = (value == 'true'); - if (name == 'poolSize') - serverOptions.poolSize = Number(value); - if (name == 'autoReconnect' || name == 'auto_reconnect') - serverOptions.auto_reconnect = (value == 'true'); - if (name == 'ssl' || name == 'ssl') - serverOptions.ssl = (value == 'true'); - - // ReplSetServers options: - if (name == 'replicaSet' || name == 'rs_name') - replSetServersOptions.rs_name = value; - if (name == 'reconnectWait') - replSetServersOptions.reconnectWait = Number(value); - if (name == 'retries') - replSetServersOptions.retries = Number(value); - if (name == 'readSecondary' || name == 'read_secondary') - replSetServersOptions.read_secondary = (value == 'true'); - - // DB options: - if (name == 'safe') - dbOptions.safe = (value == 'true'); - // Not supported by Db: safe, w, wtimeoutMS, fsync, journal, connectTimeoutMS, socketTimeoutMS - if (name == 'nativeParser' || name == 'native_parser') - dbOptions.native_parser = (value == 'true'); - if (name == 'strict') - dbOptions.strict = (value == 'true'); - }); - - var servers = hostPart.split(',').map(function(h) { - var hostPort = h.split(':', 2); - return new Server(hostPort[0] || 'localhost', hostPort[1] != null ? parseInt(hostPort[1]) : 27017, serverOptions); - }); - - var server; - if (servers.length == 1) { - server = servers[0]; - } else { - server = new ReplSetServers(servers, replSetServersOptions); - } - - var db = new Db(dbname, server, dbOptions); - if (options.noOpen) - return db; - - db.open(function(err, db){ - if(err == null && authPart){ - db.authenticate(auth[0], auth[1], function(err, success){ - if(success){ - callback(null, db); - } else { - callback(err ? err : new Error('Could not authenticate user ' + auth[0]), db); - } - }); - } else { - callback(err, db); - } - }); -} - -/** - * Legacy support - * - * @ignore - * @api private - */ -exports.connect = Db.connect; -exports.Db = Db; - -/** - * Remove all listeners to the db instance. - * @ignore - * @api private - */ -Db.prototype.removeAllEventListeners = function() { - this.removeAllListeners("close"); - this.removeAllListeners("error"); - this.removeAllListeners("timeout"); - this.removeAllListeners("parseError"); - this.removeAllListeners("poolReady"); - this.removeAllListeners("message"); -} diff --git a/lib/mongodb/gridfs/chunk.js b/lib/mongodb/gridfs/chunk.js deleted file mode 100644 index 92c50180015..00000000000 --- a/lib/mongodb/gridfs/chunk.js +++ /dev/null @@ -1,210 +0,0 @@ -var BinaryParser = require('../bson/binary_parser').BinaryParser, - Binary = require('../bson/binary').Binary, - ObjectID = require('../bson/objectid').ObjectID, - sys = require('util'), - debug = require('util').debug, - inspect = require('util').inspect; - -/** - * Class for representing a single chunk in GridFS. - * - * @class - * - * @param file {GridStore} The {@link GridStore} object holding this chunk. - * @param mongoObject {object} The mongo object representation of this chunk. - * - * @throws Error when the type of data field for {@link mongoObject} is not - * supported. Currently supported types for data field are instances of - * {@link String}, {@link Array}, {@link Binary} and {@link Binary} - * from the bson module - * - * @see Chunk#buildMongoObject - */ -var Chunk = exports.Chunk = function(file, mongoObject) { - this.file = file; - var self = this; - var mongoObjectFinal = mongoObject == null ? {} : mongoObject; - - this.objectId = mongoObjectFinal._id == null ? new ObjectID() : mongoObjectFinal._id; - this.chunkNumber = mongoObjectFinal.n == null ? 0 : mongoObjectFinal.n; - this.data = new Binary(); - - if(mongoObjectFinal.data == null) { - } else if(mongoObjectFinal.data.constructor == String) { - var buffer = new Buffer(mongoObjectFinal.data.length); - buffer.write(mongoObjectFinal.data, 'binary', 0); - this.data = new Binary(buffer); - } else if(mongoObjectFinal.data.constructor == Array) { - var buffer = new Buffer(mongoObjectFinal.data.length); - buffer.write(mongoObjectFinal.data.join(''), 'binary', 0); - this.data = new Binary(buffer); - } else if(mongoObjectFinal.data instanceof Binary || Object.prototype.toString.call(mongoObjectFinal.data) == "[object Binary]") { - this.data = mongoObjectFinal.data; - } else if(mongoObjectFinal.data instanceof Buffer) { - } else { - throw Error("Illegal chunk format"); - } - // Update position - this.internalPosition = 0; - - /** - * The position of the read/write head - * @name position - * @lends Chunk# - * @field - */ - Object.defineProperty(this, "position", { enumerable: true - , get: function () { - return this.internalPosition; - } - , set: function(value) { - this.internalPosition = value; - } - }); -}; - -/** - * Writes a data to this object and advance the read/write head. - * - * @param data {string} the data to write - * @param callback {function(*, GridStore)} This will be called after executing - * this method. The first parameter will contain null and the second one - * will contain a reference to this object. - */ -Chunk.prototype.write = function(data, callback) { - this.data.write(data, this.internalPosition); - this.internalPosition = this.data.length(); - callback(null, this); -}; - -/** - * Reads data and advances the read/write head. - * - * @param length {number} The length of data to read. - * - * @return {string} The data read if the given length will not exceed the end of - * the chunk. Returns an empty String otherwise. - */ -Chunk.prototype.read = function(length) { - // Default to full read if no index defined - length = length == null || length == 0 ? this.length() : length; - - if(this.length() - this.internalPosition + 1 >= length) { - var data = this.data.read(this.internalPosition, length); - this.internalPosition = this.internalPosition + length; - return data; - } else { - return ''; - } -}; - -Chunk.prototype.readSlice = function(length) { - if ((this.length() - this.internalPosition + 1) >= length) { - var data = null; - if (this.data.buffer != null) { //Pure BSON - data = this.data.buffer.slice(this.internalPosition, this.internalPosition + length); - } else { //Native BSON - data = new Buffer(length); - length = this.data.readInto(data, this.internalPosition); - } - this.internalPosition = this.internalPosition + length; - return data; - } else { - return null; - } -}; - -/** - * Checks if the read/write head is at the end. - * - * @return {boolean} Whether the read/write head has reached the end of this - * chunk. - */ -Chunk.prototype.eof = function() { - return this.internalPosition == this.length() ? true : false; -}; - -/** - * Reads one character from the data of this chunk and advances the read/write - * head. - * - * @return {string} a single character data read if the the read/write head is - * not at the end of the chunk. Returns an empty String otherwise. - */ -Chunk.prototype.getc = function() { - return this.read(1); -}; - -/** - * Clears the contents of the data in this chunk and resets the read/write head - * to the initial position. - */ -Chunk.prototype.rewind = function() { - this.internalPosition = 0; - this.data = new Binary(); -}; - -/** - * Saves this chunk to the database. Also overwrites existing entries having the - * same id as this chunk. - * - * @param callback {function(*, GridStore)} This will be called after executing - * this method. The first parameter will contain null and the second one - * will contain a reference to this object. - */ -Chunk.prototype.save = function(callback) { - var self = this; - - self.file.chunkCollection(function(err, collection) { - collection.remove({'_id':self.objectId}, {safe:true}, function(err, result) { - if(self.data.length() > 0) { - self.buildMongoObject(function(mongoObject) { - collection.insert(mongoObject, {safe:true}, function(err, collection) { - callback(null, self); - }); - }); - } else { - callback(null, self); - } - }); - }); -}; - -/** - * Creates a mongoDB object representation of this chunk. - * - * @param callback {function(Object)} This will be called after executing this - * method. The object will be passed to the first parameter and will have - * the structure: - * - * 
        
- *        {
- *          '_id' : , // {number} id for this chunk
- *          'files_id' : , // {number} foreign key to the file collection
- *          'n' : , // {number} chunk number
- *          'data' : , // {bson#Binary} the chunk data itself
- *        }
- *
        - * - * @see MongoDB GridFS Chunk Object Structure - */ -Chunk.prototype.buildMongoObject = function(callback) { - var mongoObject = {'_id': this.objectId, - 'files_id': this.file.fileId, - 'n': this.chunkNumber, - 'data': this.data}; - callback(mongoObject); -}; - -/** - * @return {number} the length of the data - */ -Chunk.prototype.length = function() { - return this.data.length(); -}; - -/** - * The default chunk size - * @constant - */ -Chunk.DEFAULT_CHUNK_SIZE = 1024 * 256; diff --git a/lib/mongodb/gridfs/grid.js b/lib/mongodb/gridfs/grid.js deleted file mode 100644 index 114aa6e5c17..00000000000 --- a/lib/mongodb/gridfs/grid.js +++ /dev/null @@ -1,95 +0,0 @@ -var GridStore = require('./gridstore').GridStore, - ObjectID = require('../bson/objectid').ObjectID; - -/** - * A class representation of a simple Grid interface. - * - * @class Represents the Grid. - * @param {Db} db A database instance to interact with. - * @param {String} [fsName] optional different root collection for GridFS. - * @return {Grid} - */ -function Grid(db, fsName) { - this.db = db; - this.fsName = fsName == null ? GridStore.DEFAULT_ROOT_COLLECTION : fsName; -} - -/** - * Puts binary data to the grid - * - * @param {Buffer} data buffer with Binary Data. - * @param {Object} [options] the options for the files. - * @callback {Function} this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. - * @return {null} - * @api public - */ -Grid.prototype.put = function(data, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - options = args.length ? args.shift() : {}; - // If root is not defined add our default one - options['root'] = options['root'] == null ? this.fsName : options['root']; - - // Return if we don't have a buffer object as data - if(!(data instanceof Buffer)) return callback(new Error("Data object must be a buffer object"), null); - // Get filename if we are using it - var filename = options['filename']; - // Create gridstore - var gridStore = new GridStore(this.db, filename, "w", options); - gridStore.open(function(err, gridStore) { - if(err) return callback(err, null); - - gridStore.write(data, function(err, result) { - if(err) return callback(err, null); - - gridStore.close(function(err, result) { - if(err) return callback(err, null); - callback(null, result); - }) - }) - }) -} - -/** - * Get binary data to the grid - * - * @param {ObjectID} id ObjectID for file. - * @callback {Function} this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. - * @return {null} - * @api public - */ -Grid.prototype.get = function(id, callback) { - // Validate that we have a valid ObjectId - if(!(id instanceof ObjectID)) return callback(new Error("Not a valid ObjectID", null)); - // Create gridstore - var gridStore = new GridStore(this.db, id, "r", {root:this.fsName}); - gridStore.open(function(err, gridStore) { - if(err) return callback(err, null); - - // Return the data - gridStore.read(function(err, data) { - return callback(err, data) - }); - }) -} - -/** - * Delete file from grid - * - * @param {ObjectID} id ObjectID for file. - * @callback {Function} this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. - * @return {null} - * @api public - */ -Grid.prototype.delete = function(id, callback) { - // Validate that we have a valid ObjectId - if(!(id instanceof ObjectID)) return callback(new Error("Not a valid ObjectID", null)); - // Create gridstore - GridStore.unlink(this.db, id, {root:this.fsName}, function(err, result) { - if(err) return callback(err, false); - return callback(null, true); - }); -} - -exports.Grid = Grid; diff --git a/lib/mongodb/gridfs/gridstore.js b/lib/mongodb/gridfs/gridstore.js deleted file mode 100644 index 6a83e79a072..00000000000 --- a/lib/mongodb/gridfs/gridstore.js +++ /dev/null @@ -1,1094 +0,0 @@ -/** - * @fileOverview GridFS is a tool for MongoDB to store files to the database. - * Because of the restrictions of the object size the database can hold, a - * facility to split a file into several chunks is needed. The {@link GridStore} - * class offers a simplified api to interact with files while managing the - * chunks of split files behind the scenes. More information about GridFS can be - * found here. - */ -var BinaryParser = require('../bson/binary_parser').BinaryParser, - Chunk = require('./chunk').Chunk, - DbCommand = require('../commands/db_command').DbCommand, - ObjectID = require('../bson/objectid').ObjectID, - Buffer = require('buffer').Buffer, - fs = require('fs'), - util = require('util'), - debug = require('util').debug, - inspect = require('util').inspect, - ReadStream = require('./readstream').ReadStream; - -var REFERENCE_BY_FILENAME = 0, - REFERENCE_BY_ID = 1; - -/** - * A class representation of a file stored in GridFS. - * - * Modes - * - **"r"** - read only. This is the default mode. - * - **"w"** - write in truncate mode. Existing data will be overwriten. - * - **w+"** - write in edit mode. - * - * Options - * - **root** {String}, root collection to use. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. - * - **chunk_type** {String}, mime type of the file. Defaults to **{GridStore.DEFAULT_CONTENT_TYPE}**. - * - **chunk_size** {Number}, size for the chunk. Defaults to **{Chunk.DEFAULT_CHUNK_SIZE}**. - * - **metadata** {Object}, arbitrary data the user wants to store. - * - * @class Represents the GridStore. - * @param {Db} db A database instance to interact with. - * @param {String|ObjectID} fileIdObject ObjectID or the name for the file. - * @param {String} mode set the mode for this file. - * @param {Object} options optional properties to specify. Recognized keys: - * @return {GridStore} - */ -function GridStore(db, fileIdObject, mode, options) { - var self = this; - this.db = db; - - // set grid referencetype - this.referenceBy = typeof fileIdObject == 'string' ? 0 : 1; - this.filename = fileIdObject; - this.fileId = fileIdObject; - - // Set up the rest - this.mode = mode == null ? "r" : mode; - this.options = options == null ? {} : options; - this.root = this.options['root'] == null ? exports.GridStore.DEFAULT_ROOT_COLLECTION : this.options['root']; - this.position = 0; - // Set default chunk size - this.internalChunkSize = this.options['chunkSize'] == null ? Chunk.DEFAULT_CHUNK_SIZE : this.options['chunkSize']; - - /** - * Returns the current chunksize of the file. - * - * @field chunkSize - * @type {Number} - * @getter - * @setter - * @property return number of bytes in the current chunkSize. - */ - Object.defineProperty(this, "chunkSize", { enumerable: true - , get: function () { - return this.internalChunkSize; - } - , set: function(value) { - if(!(this.mode[0] == "w" && this.position == 0 && this.uploadDate == null)) { - this.internalChunkSize = this.internalChunkSize; - } else { - this.internalChunkSize = value; - } - } - }); - - /** - * The md5 checksum for this file. - * - * @field md5 - * @type {Number} - * @getter - * @setter - * @property return this files md5 checksum. - */ - Object.defineProperty(this, "md5", { enumerable: true - , get: function () { - return this.internalMd5; - } - }); -}; - -/** - * Opens the file from the database and initialize this object. Also creates a - * new one if file does not exist. - * - * @param {Function} callback this will be called after executing this method. The first parameter will contain an **{Error}** object and the second parameter will be null if an error occured. Otherwise, the first parameter will be null and the second will contain the reference to this object. - * @return {null} - * @api public - */ -GridStore.prototype.open = function(callback) { - if( this.mode != "w" && this.mode != "w+" && this.mode != "r"){ - callback(new Error("Illegal mode " + this.mode), null); - return; - } - - var self = this; - - if((self.mode == "w" || self.mode == "w+") && self.db.serverConfig.primary != null) { - // Get files collection - self.collection(function(err, collection) { - // Ensure index on files Collection - collection.ensureIndex([['filename', 1], ['uploadDate', -1]], function(err, index) { - - // Get chunk collection - self.chunkCollection(function(err, chunkCollection) { - // Ensure index on chunk collection - chunkCollection.ensureIndex([['files_id', 1], ['n', 1]], function(err, index) { - _open(self, callback); - }); - }); - }); - }); - } else { - _open(self, callback); - } -} - -/** - * Hidding the _open function - * @ignore - * @api private - */ -var _open = function(self, callback) { - self.collection(function(err, collection) { - if(err!==null) { - callback(new Error("at collection: "+err), null); - return; - } - - // Create the query - var query = self.referenceBy == REFERENCE_BY_ID ? {_id:self.fileId} : {filename:self.filename}; - query = self.fileId == null && this.filename == null ? null : query; - - // Fetch the chunks - if(query != null) { - collection.find(query, function(err, cursor) { - // Fetch the file - cursor.nextObject(function(err, doc) { - // Chek if the collection for the files exists otherwise prepare the new one - if(doc != null) { - self.fileId = doc._id; - self.contentType = doc.contentType; - self.internalChunkSize = doc.chunkSize; - self.uploadDate = doc.uploadDate; - self.aliases = doc.aliases; - self.length = doc.length; - self.metadata = doc.metadata; - self.internalMd5 = doc.md5; - } else { - self.fileId = self.fileId instanceof ObjectID ? self.fileId : new ObjectID(); - self.contentType = exports.GridStore.DEFAULT_CONTENT_TYPE; - self.internalChunkSize = self.internalChunkSize == null ? Chunk.DEFAULT_CHUNK_SIZE : self.internalChunkSize; - self.length = 0; - } - - // Process the mode of the object - if(self.mode == "r") { - nthChunk(self, 0, function(err, chunk) { - self.currentChunk = chunk; - self.position = 0; - callback(null, self); - }); - } else if(self.mode == "w") { - // Delete any existing chunks - deleteChunks(self, function(err, result) { - self.currentChunk = new Chunk(self, {'n':0}); - self.contentType = self.options['content_type'] == null ? self.contentType : self.options['content_type']; - self.internalChunkSize = self.options['chunk_size'] == null ? self.internalChunkSize : self.options['chunk_size']; - self.metadata = self.options['metadata'] == null ? self.metadata : self.options['metadata']; - self.position = 0; - callback(null, self); - }); - } else if(self.mode == "w+") { - nthChunk(self, lastChunkNumber(self), function(err, chunk) { - // Set the current chunk - self.currentChunk = chunk == null ? new Chunk(self, {'n':0}) : chunk; - self.currentChunk.position = self.currentChunk.data.length(); - self.metadata = self.options['metadata'] == null ? self.metadata : self.options['metadata']; - self.position = self.length; - callback(null, self); - }); - } - }); - }); - } else { - // Write only mode - self.fileId = new ObjectID(); - self.contentType = exports.GridStore.DEFAULT_CONTENT_TYPE; - self.internalChunkSize = self.internalChunkSize == null ? Chunk.DEFAULT_CHUNK_SIZE : self.internalChunkSize; - self.length = 0; - - self.chunkCollection(function(err, collection2) { - // No file exists set up write mode - if(self.mode == "w") { - // Delete any existing chunks - deleteChunks(self, function(err, result) { - self.currentChunk = new Chunk(self, {'n':0}); - self.contentType = self.options['content_type'] == null ? self.contentType : self.options['content_type']; - self.internalChunkSize = self.options['chunk_size'] == null ? self.internalChunkSize : self.options['chunk_size']; - self.metadata = self.options['metadata'] == null ? self.metadata : self.options['metadata']; - self.position = 0; - callback(null, self); - }); - } else if(self.mode == "w+") { - nthChunk(self, lastChunkNumber(self), function(err, chunk) { - // Set the current chunk - self.currentChunk = chunk == null ? new Chunk(self, {'n':0}) : chunk; - self.currentChunk.position = self.currentChunk.data.length(); - self.metadata = self.options['metadata'] == null ? self.metadata : self.options['metadata']; - self.position = self.length; - callback(null, self); - }); - } - }); - }; - }); -}; - -/** - * Stores a file from the file system to the GridFS database. - * - * @param {String|Buffer|FileHandle} file the file to store. - * @param {Function} callback this will be called after this method is executed. The first parameter will be null and the the second will contain the reference to this object. - * @return {null} - * @api public - */ -GridStore.prototype.writeFile = function (file, callback) { - var self = this; - if (typeof file === 'string') { - fs.open(file, 'r', 0666, function (err, fd) { - // TODO Handle err - self.writeFile(fd, callback); - }); - return; - } - - self.open(function (err, self) { - fs.fstat(file, function (err, stats) { - var offset = 0; - var index = 0; - var numberOfChunksLeft = Math.min(stats.size / self.chunkSize); - - // Write a chunk - var writeChunk = function() { - fs.read(file, self.chunkSize, offset, 'binary', function(err, data, bytesRead) { - offset = offset + bytesRead; - // Create a new chunk for the data - var chunk = new Chunk(self, {n:index++}); - chunk.write(data, function(err, chunk) { - chunk.save(function(err, result) { - // Point to current chunk - self.currentChunk = chunk; - - if(offset >= stats.size) { - fs.close(file); - self.close(function(err, result) { - return callback(null, result); - }) - } else { - return process.nextTick(writeChunk); - } - }); - }); - }); - } - - // Process the first write - process.nextTick(writeChunk); - }); - }); -}; - -/** - * Writes some data. This method will work properly only if initialized with mode "w" or "w+". - * - * @param {String|Buffer} data the data to write. - * @param {Boolean} [close] closes this file after writing if set to true. - * @param {Function} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. - * @return {null} - * @api public - */ -GridStore.prototype.write = function(data, close, callback) { - // If we have a buffer write it using the writeBuffer method - if(Buffer.isBuffer(data)) return writeBuffer(this, data, close, callback); - // Otherwise check for the callback - if(typeof close === "function") { callback = close; close = null; } - var self = this; - var finalClose = close == null ? false : close; - // Otherwise let's write the data - if(self.mode[0] != "w") { - callback(new Error((self.referenceBy == REFERENCE_BY_ID ? self.toHexString() : self.filename) + " not opened for writing"), null); - } else { - if((self.currentChunk.position + data.length) > self.chunkSize) { - var previousChunkNumber = self.currentChunk.chunkNumber; - var leftOverDataSize = self.chunkSize - self.currentChunk.position; - var previousChunkData = data.substr(0, leftOverDataSize); - var leftOverData = data.substr(leftOverDataSize, (data.length - leftOverDataSize)); - // Save out current Chunk as another variable and assign a new Chunk for overflow data - var saveChunk = self.currentChunk; - // Create a new chunk at once (avoid wrong writing of chunks) - self.currentChunk = new Chunk(self, {'n': (previousChunkNumber + 1)}); - - // Let's finish the current chunk and then call write again for the remaining data - saveChunk.write(previousChunkData, function(err, chunk) { - chunk.save(function(err, result) { - self.position = self.position + leftOverDataSize; - // Write the remaining data - self.write(leftOverData, function(err, gridStore) { - if(finalClose) { - self.close(function(err, result) { - callback(null, gridStore); - }); - } else { - callback(null, gridStore); - } - }); - }); - }); - } else { - self.currentChunk.write(data, function(err, chunk) { - self.position = self.position + data.length; - if(finalClose) { - self.close(function(err, result) { - callback(null, self); - }); - } else { - callback(null, self); - } - }); - } - } -}; - -/** - * Writes some data. This method will work properly only if initialized with mode - * "w" or "w+". - * - * @param string {string} The data to write. - * @param close {boolean=false} opt_argument Closes this file after writing if - * true. - * @param callback {function(*, GridStore)} This will be called after executing - * this method. The first parameter will contain null and the second one - * will contain a reference to this object. - * - * @ignore - * @api private - */ -var writeBuffer = function(self, buffer, close, callback) { - if(typeof close === "function") { callback = close; close = null; } - var finalClose = (close == null) ? false : close; - - if(self.mode[0] != "w") { - callback(new Error((self.referenceBy == REFERENCE_BY_ID ? self.toHexString() : self.filename) + " not opened for writing"), null); - } else { - if((self.currentChunk.position + buffer.length) > self.chunkSize) { - // Data exceeds current chunk remaining free size; fill up current chunk and write the rest - // to a new chunk (recursively) - var previousChunkNumber = self.currentChunk.chunkNumber; - var leftOverDataSize = self.chunkSize - self.currentChunk.position; - var firstChunkData = buffer.slice(0, leftOverDataSize); - var leftOverData = buffer.slice(leftOverDataSize); - // Save out current Chunk as another variable and assign a new Chunk for overflow data - var saveChunk = self.currentChunk; - // Create a new chunk at once (avoid wrong writing of chunks) - self.currentChunk = new Chunk(self, {'n': (previousChunkNumber + 1)}); - - // Let's finish the current chunk and then call write again for the remaining data - saveChunk.write(firstChunkData, function(err, chunk) { - chunk.save(function(err, result) { - self.position = self.position + leftOverDataSize; - - // Write the remaining data - writeBuffer(self, leftOverData, function(err, gridStore) { - if(finalClose) { - self.close(function(err, result) { - callback(null, gridStore); - }); - } - else { - callback(null, gridStore); - } - }); - }); - }); - } - else { - // Write buffer to chunk all at once - self.currentChunk.write(buffer, function(err, chunk) { - self.position = self.position + buffer.length; - if(finalClose) { - self.close(function(err, result) { - callback(null, self); - }); - } - else { - callback(null, self); - } - }); - } - } -}; - -/** - * Creates a mongoDB object representation of this object. - * - * @param callback {function(object)} This will be called after executing this - * method. The object will be passed to the first parameter and will have - * the structure: - * - * 
        
- *        {
- *          '_id' : , // {number} id for this file
- *          'filename' : , // {string} name for this file
- *          'contentType' : , // {string} mime type for this file
- *          'length' : , // {number} size of this file?
- *          'chunksize' : , // {number} chunk size used by this file
- *          'uploadDate' : , // {Date}
- *          'aliases' : , // {array of string}
- *          'metadata' : , // {string}
- *        }
- *
        - * - * @ignore - * @api private - */ -var buildMongoObject = function(self, callback) { - var length = self.currentChunk != null ? (self.currentChunk.chunkNumber * self.chunkSize + self.currentChunk.position) : 0; - var mongoObject = { - '_id': self.fileId, - 'filename': self.filename, - 'contentType': self.contentType, - 'length': length < 0 ? 0 : length, - 'chunkSize': self.chunkSize, - 'uploadDate': self.uploadDate, - 'aliases': self.aliases, - 'metadata': self.metadata - }; - - var md5Command = {filemd5:self.fileId, root:self.root}; - self.db.command(md5Command, function(err, results) { - mongoObject.md5 = results.md5; - callback(mongoObject); - }); -}; - -/** - * Saves this file to the database. This will overwrite the old entry if it - * already exists. This will work properly only if mode was initialized to - * "w" or "w+". - * - * @param {Function} callback this will be called after executing this method. Passes an **{Error}** object to the first parameter and null to the second if an error occured. Otherwise, passes null to the first and a reference to this object to the second. - * @return {null} - * @api public - */ -GridStore.prototype.close = function(callback) { - var self = this; - - if(self.mode[0] == "w") { - if(self.currentChunk != null && self.currentChunk.position > 0) { - self.currentChunk.save(function(err, chuck) { - self.collection(function(err, files) { - // Build the mongo object - if(self.uploadDate != null) { - files.remove({'_id':self.fileId}, {safe:true}, function(err, collection) { - buildMongoObject(self, function(mongoObject) { - files.save(mongoObject, {safe:true}, function(err, doc) { - callback(err, mongoObject); - }); - }); - }); - } else { - self.uploadDate = new Date(); - buildMongoObject(self, function(mongoObject) { - files.save(mongoObject, {safe:true}, function(err, doc) { - callback(err, mongoObject); - }); - }); - } - }); - }); - } else { - self.collection(function(err, files) { - self.uploadDate = new Date(); - buildMongoObject(self, function(mongoObject) { - files.save(mongoObject, {safe:true}, function(err, doc) { - callback(err, mongoObject); - }); - }); - }); - } - } else if(self.mode[0] == "r") { - callback(null, null); - } else { - callback(new Error("Illegal mode " + self.mode), null); - } -}; - -/** - * Gets the nth chunk of this file. - * - * @param chunkNumber {number} The nth chunk to retrieve. - * @param callback {function(*, Chunk|object)} This will be called after - * executing this method. null will be passed to the first parameter while - * a new {@link Chunk} instance will be passed to the second parameter if - * the chunk was found or an empty object {} if not. - * - * @ignore - * @api private - */ -var nthChunk = function(self, chunkNumber, callback) { - self.chunkCollection(function(err, collection) { - collection.find({'files_id':self.fileId, 'n':chunkNumber}, function(err, cursor) { - cursor.nextObject(function(err, chunk) { - var finalChunk = chunk == null ? {} : chunk; - callback(null, new Chunk(self, finalChunk)); - }); - }); - }); -}; - -/** - * - * @ignore - * @api private - */ -GridStore.prototype._nthChunk = function(chunkNumber, callback) { - nthChunk(this, chunkNumber, callback); -} - -/** - * @return {Number} The last chunk number of this file. - * - * @ignore - * @api private - */ -var lastChunkNumber = function(self) { - return Math.floor(self.length/self.chunkSize); -}; - -/** - * Retrieve this file's chunks collection. - * - * @param {Function} callback this will be called after executing this method. An exception object will be passed to the first parameter when an error occured or null otherwise. A new **{Collection}** object will be passed to the second parameter if no error occured. - * @return {null} - * @api public - */ -GridStore.prototype.chunkCollection = function(callback) { - this.db.collection((this.root + ".chunks"), callback); -}; - -/** - * Deletes all the chunks of this file in the database. - * - * @param callback {function(*, boolean)} This will be called after this method - * executes. Passes null to the first and true to the second argument. - * - * @ignore - * @api private - */ -var deleteChunks = function(self, callback) { - if(self.fileId != null) { - self.chunkCollection(function(err, collection) { - if(err!==null) { - callback(err, false); - } - collection.remove({'files_id':self.fileId}, {safe:true}, function(err, result) { - callback(null, true); - }); - }); - } else { - callback(null, true); - } -}; - -/** - * Deletes all the chunks of this file in the database. - * - * @param {Function} callback this will be called after this method executes. Passes null to the first and true to the second argument. - * @return {null} - * @api public - */ -GridStore.prototype.unlink = function(callback) { - var self = this; - deleteChunks(this, function(err) { - if(err!==null) { - callback("at deleteChunks: "+err); - return; - } - - self.collection(function(err, collection) { - if(err!==null) { - callback("at collection: "+err); - return; - } - - collection.remove({'_id':self.fileId}, {safe:true}, function(err, collection) { - callback(err, self); - }); - }); - }); -}; - -/** - * Retrieves the file collection associated with this object. - * - * @param {Function} callback this will be called after executing this method. An exception object will be passed to the first parameter when an error occured or null otherwise. A new **{Collection}** object will be passed to the second parameter if no error occured. - * @return {null} - * @api public - */ -GridStore.prototype.collection = function(callback) { - this.db.collection(this.root + ".files", function(err, collection) { - callback(err, collection); - }); -}; - -/** - * Reads the data of this file. - * - * @param {String} [separator] the character to be recognized as the newline separator. - * @param {Function} callback This will be called after this method is executed. The first parameter will be null and the second parameter will contain an array of strings representing the entire data, each element representing a line including the separator character. - * @return {null} - * @api public - */ -GridStore.prototype.readlines = function(separator, callback) { - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - separator = args.length ? args.shift() : "\n"; - - this.read(function(err, data) { - var items = data.toString().split(separator); - items = items.length > 0 ? items.splice(0, items.length - 1) : []; - for(var i = 0; i < items.length; i++) { - items[i] = items[i] + separator; - } - - callback(null, items); - }); -}; - -/** - * Deletes all the chunks of this file in the database if mode was set to "w" or - * "w+" and resets the read/write head to the initial position. - * - * @param {Function} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. - * @return {null} - * @api public - */ -GridStore.prototype.rewind = function(callback) { - var self = this; - - if(this.currentChunk.chunkNumber != 0) { - if(this.mode[0] == "w") { - deleteChunks(self, function(err, gridStore) { - self.currentChunk = new Chunk(self, {'n': 0}); - self.position = 0; - callback(null, self); - }); - } else { - self.currentChunk(0, function(err, chunk) { - self.currentChunk = chunk; - self.currentChunk.rewind(); - self.position = 0; - callback(null, self); - }); - } - } else { - self.currentChunk.rewind(); - self.position = 0; - callback(null, self); - } -}; - -/** - * Retrieves the contents of this file and advances the read/write head. Works with Buffers only. - * - * There are 3 signatures for this method: - * - * (callback) - * (length, callback) - * (length, buffer, callback) - * - * @param {Number} [length] the number of characters to read. Reads all the characters from the read/write head to the EOF if not specified. - * @param {String|Buffer} [buffer] a string to hold temporary data. This is used for storing the string data read so far when recursively calling this method. - * @param {Function} callback this will be called after this method is executed. null will be passed to the first parameter and a string containing the contents of the buffer concatenated with the contents read from this file will be passed to the second. - * @return {null} - * @api public - */ -GridStore.prototype.read = function(length, buffer, callback) { - var self = this; - - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - length = args.length ? args.shift() : null; - buffer = args.length ? args.shift() : null; - - // The data is a c-terminated string and thus the length - 1 - var finalLength = length == null ? self.length - self.position : length; - var finalBuffer = buffer == null ? new Buffer(finalLength) : buffer; - // Add a index to buffer to keep track of writing position or apply current index - finalBuffer._index = buffer != null && buffer._index != null ? buffer._index : 0; - - if((self.currentChunk.length() - self.currentChunk.position + 1 + finalBuffer._index) >= finalLength) { - var slice = self.currentChunk.readSlice(finalLength - finalBuffer._index); - // Copy content to final buffer - slice.copy(finalBuffer, finalBuffer._index); - // Update internal position - self.position = finalBuffer.length; - // Check if we don't have a file at all - if(finalLength == 0 && finalBuffer.length == 0) return callback(new Error("File does not exist"), null); - // Else return data - callback(null, finalBuffer); - } else { - var slice = self.currentChunk.readSlice(self.currentChunk.length()); - // Copy content to final buffer - slice.copy(finalBuffer, finalBuffer._index); - // Update index position - finalBuffer._index += slice.length; - - // Load next chunk and read more - nthChunk(self, self.currentChunk.chunkNumber + 1, function(err, chunk) { - if(chunk.length() > 0) { - self.currentChunk = chunk; - self.read(length, finalBuffer, callback); - } else { - finalBuffer._index > 0 ? callback(null, finalBuffer) : callback(new Error("no chunks found for file, possibly corrupt"), null); - } - }); - } -} - -/** - * Retrieves the position of the read/write head of this file. - * - * @param {Function} callback This gets called after this method terminates. null is passed to the first parameter and the position is passed to the second. - * @return {null} - * @api public - */ -GridStore.prototype.tell = function(callback) { - callback(null, this.position); -}; - -/** - * Moves the read/write head to a new location. - * - * There are 3 signatures for this method - * - * Seek Location Modes - * - **GridStore.IO_SEEK_SET**, **(default)** set the position from the start of the file. - * - **GridStore.IO_SEEK_CUR**, set the position from the current position in the file. - * - **GridStore.IO_SEEK_END**, set the position from the end of the file. - * - * @param {Number} [position] the position to seek to - * @param {Number} [seekLocation] seek mode. Use one of the Seek Location modes. - * @param {Function} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. - * @return {null} - * @api public - */ -GridStore.prototype.seek = function(position, seekLocation, callback) { - var self = this; - - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - seekLocation = args.length ? args.shift() : null; - - var seekLocationFinal = seekLocation == null ? exports.GridStore.IO_SEEK_SET : seekLocation; - var finalPosition = position; - var targetPosition = 0; - if(seekLocationFinal == exports.GridStore.IO_SEEK_CUR) { - targetPosition = self.position + finalPosition; - } else if(seekLocationFinal == exports.GridStore.IO_SEEK_END) { - targetPosition = self.length + finalPosition; - } else { - targetPosition = finalPosition; - } - - var newChunkNumber = Math.floor(targetPosition/self.chunkSize); - if(newChunkNumber != self.currentChunk.chunkNumber) { - if(self.mode[0] == 'w') { - self.currentChunk.save(function(err, chunk) { - nthChunk(self, newChunkNumber, function(err, chunk) { - self.currentChunk = chunk; - self.position = targetPosition; - self.currentChunk.position = (self.position % self.chunkSize); - callback(null, self); - }); - }); - } - } else { - self.position = targetPosition; - self.currentChunk.position = (self.position % self.chunkSize); - callback(null, self); - } -}; - -/** - * Verify if the file is at EOF. - * - * @return {Boolean} true if the read/write head is at the end of this file. - * @api public - */ -GridStore.prototype.eof = function() { - return this.position == this.length ? true : false; -}; - -/** - * Retrieves a single character from this file. - * - * @param {Function} callback this gets called after this method is executed. Passes null to the first parameter and the character read to the second or null to the second if the read/write head is at the end of the file. - * @return {null} - * @api public - */ -GridStore.prototype.getc = function(callback) { - var self = this; - - if(self.eof()) { - callback(null, null); - } else if(self.currentChunk.eof()) { - nthChunk(self, self.currentChunk.chunkNumber + 1, function(err, chunk) { - self.currentChunk = chunk; - self.position = self.position + 1; - callback(null, self.currentChunk.getc()); - }); - } else { - self.position = self.position + 1; - callback(null, self.currentChunk.getc()); - } -}; - -/** - * Writes a string to the file with a newline character appended at the end if - * the given string does not have one. - * - * @param {String} string the string to write. - * @param {Function} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object. - * @return {null} - * @api public - */ -GridStore.prototype.puts = function(string, callback) { - var finalString = string.match(/\n$/) == null ? string + "\n" : string; - this.write(finalString, callback); -}; - -/** - * Returns read stream based on this GridStore file - * - * Events - * - **data** {function(item) {}} the data event triggers when a document is ready. - * - **end** {function() {}} the end event triggers when there is no more documents available. - * - **close** {function() {}} the close event triggers when the stream is closed. - * - **error** {function(err) {}} the error event triggers if an error happens. - * - * @param {Boolean} autoclose if true current GridStore will be closed when EOF and 'close' event will be fired - * @return {null} - * @api public - */ -GridStore.prototype.stream = function(autoclose) { - return new ReadStream(autoclose, this); -}; - -/** -* The collection to be used for holding the files and chunks collection. -* -* @classconstant DEFAULT_ROOT_COLLECTION -**/ -GridStore.DEFAULT_ROOT_COLLECTION = 'fs'; - -/** -* Default file mime type -* -* @classconstant DEFAULT_CONTENT_TYPE -**/ -GridStore.DEFAULT_CONTENT_TYPE = 'binary/octet-stream'; - -/** -* Seek mode where the given length is absolute. -* -* @classconstant IO_SEEK_SET -**/ -GridStore.IO_SEEK_SET = 0; - -/** -* Seek mode where the given length is an offset to the current read/write head. -* -* @classconstant IO_SEEK_CUR -**/ -GridStore.IO_SEEK_CUR = 1; - -/** -* Seek mode where the given length is an offset to the end of the file. -* -* @classconstant IO_SEEK_END -**/ -GridStore.IO_SEEK_END = 2; - -/** - * Checks if a file exists in the database. - * - * @param {Db} db the database to query. - * @param {String} name the name of the file to look for. - * @param {String} [rootCollection] the root collection that holds the files and chunks collection. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. - * @param {Function} callback this will be called after this method executes. Passes null to the first and passes true to the second if the file exists and false otherwise. - * @return {null} - * @api public - */ -GridStore.exist = function(db, fileIdObject, rootCollection, callback) { - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - rootCollection = args.length ? args.shift() : null; - - // Fetch collection - var rootCollectionFinal = rootCollection != null ? rootCollection : GridStore.DEFAULT_ROOT_COLLECTION; - db.collection(rootCollectionFinal + ".files", function(err, collection) { - // Build query - var query = (typeof fileIdObject == 'string' || Object.prototype.toString.call(fileIdObject) == '[object RegExp]' ) - ? {'filename':fileIdObject} : {'_id':fileIdObject}; // Attempt to locate file - collection.find(query, function(err, cursor) { - cursor.nextObject(function(err, item) { - callback(null, item == null ? false : true); - }); - }); - }); -}; - -/** - * Gets the list of files stored in the GridFS. - * - * @param {Db} db the database to query. - * @param {String} [rootCollection] the root collection that holds the files and chunks collection. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**. - * @param {Function} callback this will be called after this method executes. Passes null to the first and passes an array of strings containing the names of the files. - * @return {null} - * @api public - */ -GridStore.list = function(db, rootCollection, options, callback) { - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - rootCollection = args.length ? args.shift() : null; - options = args.length ? args.shift() : {}; - - // Ensure we have correct values - if(rootCollection != null && typeof rootCollection == 'object') { - options = rootCollection; - rootCollection = null; - } - - // Check if we are returning by id not filename - var byId = options['id'] != null ? options['id'] : false; - // Fetch item - var rootCollectionFinal = rootCollection != null ? rootCollection : GridStore.DEFAULT_ROOT_COLLECTION; - var items = []; - db.collection((rootCollectionFinal + ".files"), function(err, collection) { - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - items.push(byId ? item._id : item.filename); - } else { - callback(null, items); - } - }); - }); - }); -}; - -/** - * Reads the contents of a file. - * - * This method has the following signatures - * - * (db, name, callback) - * (db, name, length, callback) - * (db, name, length, offset, callback) - * (db, name, length, offset, options, callback) - * - * @param {Db} db the database to query. - * @param {String} name the name of the file. - * @param {Number} [length] the size of data to read. - * @param {Number} [offset] the offset from the head of the file of which to start reading from. - * @param {Object} [options] the options for the file. - * @param {Function} callback this will be called after this method executes. A string with an error message will be passed to the first parameter when the length and offset combination exceeds the length of the file while an Error object will be passed if other forms of error occured, otherwise, a string is passed. The second parameter will contain the data read if successful or null if an error occured. - * @return {null} - * @api public - */ -GridStore.read = function(db, name, length, offset, options, callback) { - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - length = args.length ? args.shift() : null; - offset = args.length ? args.shift() : null; - options = args.length ? args.shift() : null; - - new GridStore(db, name, "r", options).open(function(err, gridStore) { - // Make sure we are not reading out of bounds - if(offset && offset >= gridStore.length) return callback("offset larger than size of file", null); - if(length && length > gridStore.length) return callback("length is larger than the size of the file", null); - if(offset && length && (offset + length) > gridStore.length) return callback("offset and length is larger than the size of the file", null); - - if(offset != null) { - gridStore.seek(offset, function(err, gridStore) { - gridStore.read(length, function(err, data) { - callback(err, data); - }); - }); - } else { - gridStore.read(length, function(err, data) { - callback(err, data); - }); - } - }); -}; - -/** - * Reads the data of this file. - * - * @param {Db} db the database to query. - * @param {String} name the name of the file. - * @param {String} [separator] the character to be recognized as the newline separator. - * @param {Object} [options] file options. - * @param {Function} callback this will be called after this method is executed. The first parameter will be null and the second parameter will contain an array of strings representing the entire data, each element representing a line including the separator character. - * @return {null} - * @api public - */ -GridStore.readlines = function(db, name, separator, options, callback) { - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - separator = args.length ? args.shift() : null; - options = args.length ? args.shift() : null; - - var finalSeperator = separator == null ? "\n" : separator; - new GridStore(db, name, "r", options).open(function(err, gridStore) { - gridStore.readlines(finalSeperator, function(err, lines) { - callback(err, lines); - }); - }); -}; - -/** - * Deletes the chunks and metadata information of a file from GridFS. - * - * @param {Db} db the database to interact with. - * @param {String|Array} names the name/names of the files to delete. - * @param {Object} [options] the options for the files. - * @callback {Function} this will be called after this method is executed. The first parameter will contain an Error object if an error occured or null otherwise. The second parameter will contain a reference to this object. - * @return {null} - * @api public - */ -GridStore.unlink = function(db, names, options, callback) { - var self = this; - var args = Array.prototype.slice.call(arguments, 2); - callback = args.pop(); - options = args.length ? args.shift() : null; - - if(names.constructor == Array) { - var tc = 0; - for(var i = 0; i < names.length; i++) { - ++tc; - self.unlink(db, names[i], function(result) { - if(--tc == 0) { - callback(null, self); - } - }); - } - } else { - new GridStore(db, names, "w", options).open(function(err, gridStore) { - deleteChunks(gridStore, function(err, result) { - gridStore.collection(function(err, collection) { - collection.remove({'_id':gridStore.fileId}, {safe:true}, function(err, collection) { - callback(err, self); - }); - }); - }); - }); - } -}; - -/** - * @ignore - * @api private - */ -exports.GridStore = GridStore; diff --git a/lib/mongodb/gridfs/readstream.js b/lib/mongodb/gridfs/readstream.js deleted file mode 100644 index 427cb4df407..00000000000 --- a/lib/mongodb/gridfs/readstream.js +++ /dev/null @@ -1,167 +0,0 @@ -var Stream = require('stream').Stream, - util = require('util'); - -/** - * ReadStream - * - * Returns a stream interface for the **file**. - * - * Events - * - **data** {function(item) {}} the data event triggers when a document is ready. - * - **end** {function() {}} the end event triggers when there is no more documents available. - * - **close** {function() {}} the close event triggers when the stream is closed. - * - **error** {function(err) {}} the error event triggers if an error happens. - * - * @class Represents a GridFS File Stream. - * @param {Boolean} autoclose automatically close file when the stream reaches the end. - * @param {GridStore} cursor a cursor object that the stream wraps. - * @return {ReadStream} - */ -function ReadStream(autoclose, gstore) { - if (!(this instanceof ReadStream)) return new ReadStream(autoclose, gstore); - Stream.call(this); - - this.autoclose = !!autoclose; - this.gstore = gstore; - - this.finalLength = gstore.length - gstore.position; - this.completedLength = 0; - - this.paused = false; - this.readable = true; - this.pendingChunk = null; - - var self = this; - process.nextTick(function() { - self._execute(); - }); -}; - -/** - * Inherit from Stream - * @ignore - * @api private - */ -ReadStream.prototype.__proto__ = Stream.prototype; - -/** - * Flag stating whether or not this stream is readable. - */ -ReadStream.prototype.readable; - -/** - * Flag stating whether or not this stream is paused. - */ -ReadStream.prototype.paused; - -/** - * @ignore - * @api private - */ -ReadStream.prototype._execute = function() { - if(this.paused === true || this.readable === false) { - return; - } - - var gstore = this.gstore; - var self = this; - - var last = false; - var toRead = 0; - - if ((gstore.currentChunk.length() - gstore.currentChunk.position + 1 + self.completedLength) >= self.finalLength) { - toRead = self.finalLength - self.completedLength; - last = true; - } else { - toRead = gstore.currentChunk.length(); - } - - var data = gstore.currentChunk.readSlice(toRead); - - if (data != null) { - self.completedLength += data.length; - self.pendingChunk = null; - self.emit("data", data); - } - - if (last === true) { - self.readable = false; - self.emit("end"); - if (self.autoclose === true) { - if (gstore.mode[0] == "w") { - gstore.close(function(err, doc) { - if (err) { - self.emit("error", err); - return; - } - self.readable = false; - self.emit("close", doc); - }); - } else { - self.readable = false; - self.emit("close"); - } - } - } else { - gstore._nthChunk(gstore.currentChunk.chunkNumber + 1, function(err, chunk) { - if (err) { - self.readable = false; - self.emit("error", err); - return; - } - self.pendingChunk = chunk; - if (self.paused === true) { - return; - } - gstore.currentChunk = self.pendingChunk; - self._execute(); - }); - } -}; - -/** - * Pauses this stream, then no farther events will be fired. - * - * @ignore - * @api public - */ -ReadStream.prototype.pause = function() { - this.paused = true; -}; - -/** - * Destroys the stream, then no farther events will be fired. - * - * @ignore - * @api public - */ -ReadStream.prototype.destroy = function() { - this.readable = false; - // Emit close event - this.emit("close"); -}; - -/** - * Resumes this stream. - * - * @ignore - * @api public - */ -ReadStream.prototype.resume = function() { - if (this.paused === false) { - return; - } - this.paused = false; - var self = this; - if(self.pendingChunk != null) { - self.currentChunk = self.pendingChunk; - process.nextTick(function() { - self._execute(); - }); - } else { - self.readable = false; - self.emit("close"); - } -}; - -exports.ReadStream = ReadStream; diff --git a/lib/mongodb/index.js b/lib/mongodb/index.js deleted file mode 100644 index 2ebf7c1401d..00000000000 --- a/lib/mongodb/index.js +++ /dev/null @@ -1,131 +0,0 @@ - -try { - exports.BSONPure = require('./bson/bson'); - exports.BSONNative = require('../../external-libs/bson'); -} catch(err) { - // do nothing -} - -[ 'bson/binary_parser' - , 'bson/binary' - , 'bson/code' - , 'bson/db_ref' - , 'bson/double' - , 'bson/max_key' - , 'bson/min_key' - , 'bson/objectid' - , 'bson/symbol' - , 'bson/timestamp' - , 'bson/long' - , 'commands/base_command' - , 'commands/db_command' - , 'commands/delete_command' - , 'commands/get_more_command' - , 'commands/insert_command' - , 'commands/kill_cursor_command' - , 'commands/query_command' - , 'commands/update_command' - , 'responses/mongo_reply' - , 'admin' - , 'collection' - , 'connection/connection' - , 'connection/server' - , 'connection/repl_set_servers' - , 'cursor' - , 'db' - , 'gridfs/grid' - , 'gridfs/chunk' - , 'gridfs/gridstore'].forEach(function (path) { - var module = require('./' + path); - for (var i in module) { - exports[i] = module[i]; - } -}); - -// Exports all the classes for the NATIVE JS BSON Parser -exports.native = function() { - var classes = {}; - // Map all the classes - [ 'bson/binary_parser' - , 'bson/binary' - , 'bson/code' - , 'bson/db_ref' - , 'bson/double' - , 'bson/max_key' - , 'bson/min_key' - , 'bson/objectid' - , 'bson/symbol' - , 'bson/timestamp' - , 'bson/long' - , '../../external-libs/bson/bson' - , 'commands/base_command' - , 'commands/db_command' - , 'commands/delete_command' - , 'commands/get_more_command' - , 'commands/insert_command' - , 'commands/kill_cursor_command' - , 'commands/query_command' - , 'commands/update_command' - , 'responses/mongo_reply' - , 'admin' - , 'collection' - , 'connection/connection' - , 'connection/server' - , 'connection/repl_set_servers' - , 'cursor' - , 'db' - , 'gridfs/grid' - , 'gridfs/chunk' - , 'gridfs/gridstore'].forEach(function (path) { - var module = require('./' + path); - for (var i in module) { - classes[i] = module[i]; - } - }); - // Return classes list - return classes; -} - -// Exports all the classes for the PURE JS BSON Parser -exports.pure = function() { - var classes = {}; - // Map all the classes - [ 'bson/binary_parser' - , 'bson/binary' - , 'bson/code' - , 'bson/db_ref' - , 'bson/double' - , 'bson/max_key' - , 'bson/min_key' - , 'bson/objectid' - , 'bson/symbol' - , 'bson/timestamp' - , 'bson/long' - , './bson/bson' - , 'commands/base_command' - , 'commands/db_command' - , 'commands/delete_command' - , 'commands/get_more_command' - , 'commands/insert_command' - , 'commands/kill_cursor_command' - , 'commands/query_command' - , 'commands/update_command' - , 'responses/mongo_reply' - , 'admin' - , 'collection' - , 'connection/connection' - , 'connection/server' - , 'connection/repl_set_servers' - , 'cursor' - , 'db' - , 'gridfs/grid' - , 'gridfs/chunk' - , 'gridfs/gridstore'].forEach(function (path) { - var module = require('./' + path); - for (var i in module) { - classes[i] = module[i]; - } - }); - // Return classes list - return classes; -} diff --git a/lib/mongodb/responses/mongo_reply.js b/lib/mongodb/responses/mongo_reply.js deleted file mode 100644 index b25bbbb6d3a..00000000000 --- a/lib/mongodb/responses/mongo_reply.js +++ /dev/null @@ -1,133 +0,0 @@ -var Long = require('../bson/long').Long, - debug = require('util').debug, - inspect = require('util').inspect; - -/** - Reply message from mongo db -**/ -var MongoReply = exports.MongoReply = function() { - this.documents = []; - this.index = 0; -}; - -MongoReply.prototype.parseHeader = function(binary_reply, bson) { - // Unpack the standard header first - this.messageLength = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; - // Fetch the request id for this reply - this.requestId = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; - // Fetch the id of the request that triggered the response - this.responseTo = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - // Skip op-code field - this.index = this.index + 4 + 4; - // Unpack the reply message - this.responseFlag = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; - // Unpack the cursor id (a 64 bit long integer) - var low_bits = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; - var high_bits = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; - this.cursorId = new Long(low_bits, high_bits); - // Unpack the starting from - this.startingFrom = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; - // Unpack the number of objects returned - this.numberReturned = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - this.index = this.index + 4; -} - -MongoReply.prototype.parseBody = function(binary_reply, bson, raw, callback) { - raw = raw == null ? false : raw; - // Just set a doc limit for deserializing - var docLimitSize = 1024*20; - - // If our message length is very long, let's switch to process.nextTick for messages - if(this.messageLength > docLimitSize) { - var batchSize = this.numberReturned; - this.documents = new Array(this.numberReturned); - - // Just walk down until we get a positive number >= 1 - for(var i = 50; i > 0; i--) { - if((this.numberReturned/i) >= 1) { - batchSize = i; - break; - } - } - - // Actual main creator of the processFunction setting internal state to control the flow - var parseFunction = function(_self, _binary_reply, _batchSize, _numberReturned) { - var object_index = 0; - // Internal loop process that will use nextTick to ensure we yield some time - var processFunction = function() { - // Adjust batchSize if we have less results left than batchsize - if((_numberReturned - object_index) < _batchSize) { - _batchSize = _numberReturned - object_index; - } - - // If raw just process the entries - if(raw) { - // Iterate over the batch - for(var i = 0; i < _batchSize; i++) { - // Are we done ? - if(object_index <= _numberReturned) { - // Read the size of the bson object - var bsonObjectSize = _binary_reply[_self.index] | _binary_reply[_self.index + 1] << 8 | _binary_reply[_self.index + 2] << 16 | _binary_reply[_self.index + 3] << 24; - // If we are storing the raw responses to pipe straight through - _self.documents[object_index] = binary_reply.slice(_self.index, _self.index + bsonObjectSize); - // Adjust binary index to point to next block of binary bson data - _self.index = _self.index + bsonObjectSize; - // Update number of docs parsed - object_index = object_index + 1; - } - } - } else { - // Parse documents - _self.index = bson.deserializeStream(binary_reply, _self.index, _batchSize, _self.documents, object_index); - // Adjust index - object_index = object_index + _batchSize; - } - - // If we hav more documents process NextTick - if(object_index < _numberReturned) { - process.nextTick(processFunction); - } else { - callback(null); - } - } - - // Return the process function - return processFunction; - }(this, binary_reply, batchSize, this.numberReturned)(); - } else { - // Let's unpack all the bson documents, deserialize them and store them - for(var object_index = 0; object_index < this.numberReturned; object_index++) { - // Read the size of the bson object - var bsonObjectSize = binary_reply[this.index] | binary_reply[this.index + 1] << 8 | binary_reply[this.index + 2] << 16 | binary_reply[this.index + 3] << 24; - // If we are storing the raw responses to pipe straight through - if(raw) { - // Deserialize the object and add to the documents array - this.documents.push(binary_reply.slice(this.index, this.index + bsonObjectSize)); - } else { - // Deserialize the object and add to the documents array - this.documents.push(bson.deserialize(binary_reply.slice(this.index, this.index + bsonObjectSize))); - } - // Adjust binary index to point to next block of binary bson data - this.index = this.index + bsonObjectSize; - } - - callback(null); - } -} - -MongoReply.prototype.is_error = function(){ - if(this.documents.length == 1) { - return this.documents[0].ok == 1 ? false : true; - } - return false; -}; - -MongoReply.prototype.error_message = function() { - return this.documents.length == 1 && this.documents[0].ok == 1 ? '' : this.documents[0].errmsg; -}; \ No newline at end of file diff --git a/lib/mongodb/utils.js b/lib/mongodb/utils.js deleted file mode 100644 index 302a944252a..00000000000 --- a/lib/mongodb/utils.js +++ /dev/null @@ -1,44 +0,0 @@ -/** - * Sort functions, Normalize and prepare sort parameters - */ -var formatSortValue = exports.formatSortValue = function(sortDirection) { - var value = ("" + sortDirection).toLowerCase(); - - switch (value) { - case 'ascending': - case 'asc': - case '1': - return 1; - case 'descending': - case 'desc': - case '-1': - return -1; - default: - throw new Error("Illegal sort clause, must be of the form " - + "[['field1', '(ascending|descending)'], " - + "['field2', '(ascending|descending)']]"); - } -}; - -var formattedOrderClause = exports.formattedOrderClause = function(sortValue) { - var orderBy = {}; - - if (Array.isArray(sortValue)) { - for(var i = 0; i < sortValue.length; i++) { - if(sortValue[i].constructor == String) { - orderBy[sortValue[i]] = 1; - } else { - orderBy[sortValue[i][0]] = formatSortValue(sortValue[i][1]); - } - } - } else if(Object.prototype.toString.call(sortValue) === '[object Object]') { - orderBy = sortValue; - } else if (sortValue.constructor == String) { - orderBy[sortValue] = 1; - } else { - throw new Error("Illegal sort clause, must be of the form " + - "[['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]"); - } - - return orderBy; -}; \ No newline at end of file diff --git a/markdown-docs/collections.html b/markdown-docs/collections.html new file mode 100644 index 00000000000..d25394efecf --- /dev/null +++ b/markdown-docs/collections.html @@ -0,0 +1,429 @@ + + + + + + + + + + Collections — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Collections

        +
        +

        See also:

        +
        +
        +
        +
        +

        Collection objects

        +
        +

        Collection object is a pointer to a specific collection in the database . If you want to insert new records or +query existing ones then you need to have a valid collection object.

        +

        NB Collection names can’t start or end with a period nor contain a dollar sign! ( .tes$t is not allowed)

        +
        +
        +
        +

        Creating collections

        +
        +

        Collections can be created with createCollection

        +
        +
        db.createCollection([[name[, options]], callback)
+
        +
        +
        +

        where name is the name of the collection, options a set of configuration parameters and callback is a callback function. db is the database object.

        +

        The first parameter for the callback is the error object (null if no error) and the second one is the pointer to the newly created collection. If strict mode is on and the table exists, the operation yields in error. With strict mode off (default) the function simple returns the pointer to the existing collection and does not truncate it.

        +
        +
        db.createCollection("test", function(err, collection){
+    collection.insert({"test":"value"});
+});
+
        +
        +
        +
        +
        +
        +

        Creating collections options

        +
        +

        Several options can be passed to the createCollection function with options parameter.

        +
        +
        * `raw` - driver returns documents as bson binary Buffer objects, `default:false`
        +
        +
          +
        • collectionName is the name of the collection (not including the database name as a prefix)
          • +
        • db is the pointer to the corresponding database object
          • +
        +
        +

        Example of usage:

        +
        +
        console.log("Collection name: "+collection.collectionName)
+
        +
        +
        +
        +
        +
        +

        List existing collections

        +
        +

        Collections can be listed with collectionNames

        +
        +
        db.collectionNames(callback);
+
        +
        +
        +

        callback gets two parameters - an error object (if error occured) and an array of collection names as strings.

        +

        Collection names also include database name, so a collection named posts in a database blog will be listed as blog.posts .

        +

        Additionally there’s system collections which should not be altered without knowing exactly what you are doing, these sollections can be identified with system prefix. For example posts.system.indexes .

        +

        Example:

        +
        +
        var mongodb = require("mongodb"),
+    mongoserver = new mongodb.Server("localhost"),
+    db_connector = new mongodb.Db("blog", mongoserver);
+
+db_connector.open(function(err, db){
+    db.collectionNames(function(err, collections){
+        console.log(collections); // ["blog.posts", "blog.system.indexes"]
+    });
+});
+
        +
        +
        +
        +
        +
        +

        List collections

        +
        +

        Collection objects can be listed with database method collections

        +
        +
        db.collections(callback)
+
        +
        +
        +

        Where callback gets two parameters - an error object (if an error occured) and an array of collection objects.

        +
        +
        +
        +

        Selecting collections

        +
        +

        Existing collections can be opened with collection

        +
        +
        db.collection([[name[, options]], callback);
+
        +
        +
        +

        If strict mode is off, then a new collection is created if not already present.

        +
        +
        +
        +

        Selecting collections options

        +
        +

        Several options can be passed to the collection function with options parameter.

        +
        +
        * `raw` - driver returns documents as bson binary Buffer objects, `default:false`
        +
        +
        +
        +
        +
        +

        Renaming collections

        +
        +

        A collection can be renamed with collection method rename

        +
        +
        collection.rename(new_name, callback);
+
        +
        +
        +

        Passing the optional dropTarget boolean as the thrid parameter will allow overwritting of existing collections

        +
        +
        collection.rename(new_name, {dropTarget:true}, callback);
+
        +
        +
        +
        +
        +
        +

        Removing records from collections

        +
        +

        Records can be erased from a collection with remove

        +
        +
        collection.remove([[query[, options]], callback]);
+
        +
        +
        +

        Where

        +
        +
          +
        • query is the query that records to be removed need to match. If not set all records will be removed
          • +
        • options indicate advanced options. For example use {safe: true} when using callbacks
          • +
        • callback callback function that gets two parameters - an error object (if an error occured) and the count of removed records
          • +
        +
        +
        +
        +
        +

        Removing collections

        +
        +

        A collection can be dropped with drop

        +
        +
        collection.drop(callback);
+
        +
        +
        +

        or with dropCollection

        +
        +
        db.dropCollection(collection_name, callback)
+
        +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/database.html b/markdown-docs/database.html new file mode 100644 index 00000000000..f79a63c6c90 --- /dev/null +++ b/markdown-docs/database.html @@ -0,0 +1,449 @@ + + + + + + + + + + Database — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Database

        +
        +

        The first thing to do in order to make queries to the database is to open one. This can be done with the Db constructor.

        +
        +
        var mongodb = require("mongodb"),
+    mongoserver = new mongodb.Server(host, port, server_options),
+    db_connector = new mongodb.Db(name, mongoserver, db_options);
+
+db_connector.open(callback);
+
        +
        +
          +
        • host is a server hostname or IP
          • +
        • port is a MongoDB port, use mongodb.Connection.DEFAULT_PORT for default (27017)
          • +
        • server_options see Server options
          • +
        • name is the databse name that needs to be opened, database will be created automatically if it doesn’t yet exist
          • +
        • db_options see DB options
          • +
        +
        +
        +
        +

        Server options

        +
        +

        Several options can be passed to the Server constructor with options parameter.

        +
        +
          +
        • auto_reconnect - to reconnect automatically, default:false
          • +
        • poolSize - specify the number of connections in the pool default:5
          • +
        • socketOptions - a collection of pr socket settings
          • +
        +
        +
        +
        +
        +

        Socket options

        +
        +

        Several options can be set for the socketOptions .

        +
        +
          +
        • timeout = set seconds before connection times out default:0
          • +
        • noDelay = Disables the Nagle algorithm default:true
          • +
        • keepAlive = Set if keepAlive is used default:0 , which means no keepAlive, set higher than 0 for keepAlive
          • +
        • encoding = ‘ascii’|’utf8’|’base64’ default:null
          • +
        +
        +
        +
        +
        +

        DB options

        +
        +

        Several options can be passed to the Db constructor with options parameter.

        +
        +
          +
        • native_parser - if true, use native BSON parser
          • +
        • strict - sets strict mode , if true then existing collections can’t be “recreated” etc.
          • +
        • pk - custom primary key factory to generate _id values (see Custom primary keys).
          • +
        • forceServerObjectId - generation of objectid is delegated to the mongodb server instead of the driver. default is false
          • +
        • retryMiliSeconds - specify the number of milliseconds between connection attempts default:5000
          • +
        • numberOfRetries - specify the number of retries for connection attempts default:3
          • +
        • reaper - enable/disable reaper (true/false) default:false
          • +
        • reaperInterval - specify the number of milliseconds between each reaper attempt default:10000
          • +
        • reaperTimeout - specify the number of milliseconds for timing out callbacks that don’t return default:30000
          • +
        • raw - driver expects Buffer raw bson document, default:false
          • +
        • logger - object specifying error(), debug() and log() functions
          • +
        +
        +
        +
        +
        +

        Opening a database

        +
        +

        Database can be opened with Db method open .

        +
        +
        db_connector.open(callback);
+
        +
        +
        +

        callback is a callback function which gets 2 parameters - an error object (or null, if no errors occured) and a database object.

        +

        Resulting database object can be used for creating and selecting collections .

        +
        +
        db_connector.open(function(err, db){
+    db.collection(...);
+});
+
        +
        +
          +
        • databaseName is the name of the database
          • +
        • serverConfig includes information about the server ( serverConfig.host , serverConfig.port etc.)
          • +
        • state indicates if the database is connected or not
          • +
        • strict indicates if strict mode is on (true) or off (false, default)
          • +
        • version indicates the version of the MongoDB database
          • +
        • close to indicate that the connection to the database was closed
          • +
        +
        +

        For example

        +
        +
        db.on("close", function(error){
+    console.log("Connection to the database was closed!");
+});
+
        +
        +
        +

        NB! If auto_reconnect was set to true when creating the server, then the connection will be automatically reopened on next database operation. Nevertheless the close event will be fired.

        +
        +
        +
        +

        Sharing the connections over multiple dbs

        +
        +

        To share the connection pool across multiple databases you database instance has method db

        +
        +
        db_connector.db(name)
+
        +
        +
        +

        this returns a new db instance that shares the connections off the previous instance but will send all commands to the database name . This allows for better control of resource usage in a multiple database scenario.

        +
        +
        +
        +

        Deleting a database

        +
        +

        To delete a database you need a pointer to it first. Deletion can be done with method dropDatabase .

        +
        +
        db_connector.open(function(err, db){
+    if (err) { throw err; }
+    db.dropDatabase(function(err) {
+            if (err) { throw err; }
+            console.log("database has been dropped!");
+    });
+});
+
        +
        +
        +
        +
        +
        +

        Custom primary keys

        +
        +

        Every record in the database has an unique primary key called _id . Default primary keys are 12 byte hashes but a custom key generator can be used for something else. If you set _id “by hand” when inserting records then you can use whatever you want, primary key factory generates _id values only for records without ones.

        +

        Example 1: No need to generate primary key, as its already defined:

        +
        +
        collection.insert({name:"Daniel", _id:"12345"});
+
        +
        +
        +

        Example 2: No primary key, so it needs to be generated before save:

        +
        +
        collectionn.insert({name:"Daniel"});
+
        +
        +
        +

        Custom primary key factory is actually an object with method createPK which returns a primary key. The context (value for this ) for createPK is left untouched.

        +
        +
        var CustomPKFactory = {
+    counter:0,
+    createPk: function() {
+        return ++this.counter;
+    }
+}
+
+db_connector = new mongodb.Db(name, mongoserver, {pk: CustomPKFactory});
+
        +
        +
        +
        +
        +
        +

        debug commands

        +
        +

        In order to debug the commands sent to the database you can add a logger object to the DB options . Make sure also the property doDebug is set.

        +

        Example

        +
        +
        options = {}
+options.logger = {};
+options.logger.doDebug = true;
+options.logger.debug = function (message, object) {
+    // print the mongo command:
+    // "writing command to mongodb"
+    console.log(message);
+
+    // print the collection name
+    console.log(object.json.collectionName)
+
+    // print the json query sent to MongoDB
+    console.log(object.json.query)
+
+    // print the binary object
+    console.log(object.binary)
+}
+
+var db = new Db('some_database', new Server(...), options);
+
        +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/gridfs.html b/markdown-docs/gridfs.html new file mode 100644 index 00000000000..c53e65ff2ae --- /dev/null +++ b/markdown-docs/gridfs.html @@ -0,0 +1,445 @@ + + + + + + + + + + GridStore — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        GridStore

        +
        +

        GridFS is a scalable MongoDB filesystem for storing and retrieving large files. The default limit for a MongoDB record is 16MB, so to store data that is larger than this limit, GridFS can be used. GridFS shards the data into smaller chunks automatically. See MongoDB documentation for details.

        +

        GridStore is a single file inside GridFS that can be managed by the script.

        +
        +
        +

        Open GridStore

        +
        +

        Opening a GridStore (a single file in GridFS) is a bit similar to opening a database. At first you need to create a GridStore object and then open it.

        +
        +
        var gs = new mongodb.GridStore(db, filename, mode[, options])
+
        +
        +
        +

        Where

        +
        +
          +
        • db is the database object
          • +
        • filename is the name of the file in GridFS that needs to be accessed/created
          • +
        • mode indicated the operation, can be one of: * “r” (Read): Looks for the file information in fs.files collection, or creates a new id for this object. * “w” (Write): Erases all chunks if the file already exist. * “w+” (Append): Finds the last chunk, and keeps writing after it.
          • +
        • options can be used to specify some metadata for the file, for example content_type , metadata and chunk_size
          • +
        +
        +

        Example:

        +
        +
        var gs = new mongodb.GridStore(db, "test.png", "w", {
+    "content_type": "image/png",
+    "metadata":{
+        "author": "Daniel"
+    },
+    "chunk_size": 1024*4
+});
+
        +
        +
        +

        When GridStore object is created, it needs to be opened.

        +
        +
        gs.open(callback);
+
        +
        +
        +

        callback gets two parameters - and error object (if error occured) and the GridStore object.

        +

        Opened GridStore object has a set of useful properties

        +
        +
          +
        • gs.length - length of the file in bytes
          • +
        • gs.contentType - the content type for the file
          • +
        • gs.uploadDate - when the file was uploaded
          • +
        • gs.metadata - metadata that was saved with the file
          • +
        • gs.chunkSize - chunk size
          • +
        +
        +

        Example

        +
        +
        gs.open(function(err, gs){
+    console.log("this file was uploaded at "+gs.uploadDate);
+});
+
        +
        +
        +
        +
        +
        +

        Writing to GridStore

        +
        +

        Writing can be done with write

        +
        +
        gs.write(data, callback)
+
        +
        +
        +

        where data is a Buffer or a string, callback gets two parameters - an error object (if error occured) and result value which indicates if the write was successful or not.

        +

        While the GridStore is not closed, every write is appended to the opened GridStore.

        +
        +
        +
        +

        Writing a file to GridStore

        +
        +

        This function opens the GridStore, streams the contents of the file into GridStore, and closes the GridStore.

        +
        +
        gs.writeFile( file, callback )
+
        +
        +
        +

        where

        +
        +
          +
        • file is a file descriptor, or a string file path
          • +
        • callback is a function with two parameters - error object (if error occured) and the GridStore object.
          • +
        +
        +
        +
        +
        +

        Reading from GridStore

        +
        +

        Reading from GridStore can be done with read

        +
        +
        gs.read([size], callback)
+
        +
        +
        +

        where

        +
        +
          +
        • size is the length of the data to be read
          • +
        • callback is a callback function with two parameters - error object (if an error occured) and data (binary string)
          • +
        +
        +
        +
        +
        +

        Streaming from GridStore

        +
        +

        You can stream data as it comes from the database using stream

        +
        +
        gs.stream([autoclose=false])
+
        +
        +
        +

        where

        +
        +
          +
        • autoclose If true current GridStore will be closed when EOF and ‘close’ event will be fired
          • +
        +
        +

        The function returns read stream based on this GridStore file. It supports the events ‘read’, ‘error’, ‘close’ and ‘end’.

        +
        +
        +
        +

        Delete a GridStore

        +
        +

        GridStore files can be unlinked with unlink

        +
        +
        mongodb.GridStore.unlink(db, name, callback)
+
        +
        +
        +

        Where

        +
        +
          +
        • db is the database object
          • +
        • name is either the name of a GridStore object or an array of GridStore object names
          • +
        • callback is the callback function
          • +
        +
        +
        +
        +
        +

        Closing the GridStore

        +
        +

        GridStore needs to be closed after usage. This can be done with close

        +
        +
        gs.close(callback)
+
        +
        +
        +
        +
        +
        +

        Check the existance of a GridStore file

        +
        +

        Checking if a file exists in GridFS can be done with exist

        +
        +
        mongodb.GridStore.exist(db, filename, callback)
+
        +
        +
        +

        Where

        +
        +
          +
        • db is the database object
          • +
        • filename is the name of the file to be checked or a regular expression
          • +
        • callback is a callback function with two parameters - an error object (if an error occured) and a boolean value indicating if the file exists or not
          • +
        +
        +
        +
        +
        +

        Seeking in a GridStore

        +
        +

        Seeking can be done with seek

        +
        +
        gs.seek(position);
+
        +
        +
        +

        This function moves the internal pointer to the specified position.

        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/index.html b/markdown-docs/index.html new file mode 100644 index 00000000000..ab612142731 --- /dev/null +++ b/markdown-docs/index.html @@ -0,0 +1,252 @@ + + + + + + + + + + <no title> — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        + +
        + + +
        +
        +
        +
        +
        +

        Contents

        +
          +
        + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/indexes.html b/markdown-docs/indexes.html new file mode 100644 index 00000000000..8cbb9a34846 --- /dev/null +++ b/markdown-docs/indexes.html @@ -0,0 +1,355 @@ + + + + + + + + + + Indexes — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Indexes

        +
        +

        Indexes are needed to make queries faster. For example if you need to find records by a field named username and the field has a related index set, then the query will be a lot faster compared to if the index was not present.

        +

        See MongoDB documentation for details.

        +
        +
        +

        Create indexes with createIndex()

        +
        +

        createIndex adds a new index to a collection. For checking if the index was already set, use ensureIndex instead.

        +
        +
        collection.createIndex(index[, options], callback)
+
        +
        +
        +

        or

        +
        +
        db.createIndex(collectionname, index[, options], callback)
+
        +
        +
        +

        where

        +
        +
          +
        • index is the field or fields to be indexed. See index field
          • +
        • options are options, for example {sparse: true} to include only records that have indexed field set or {unique: true} for unique indexes. If the options is a boolean value, then it indicates if it’s an unique index or not.
          • +
        • callback gets two parameters - an error object (if an error occured) and the name for the newly created index
          • +
        +
        +
        +
        +
        +

        Ensure indexes with ensureIndex()

        +
        +
        Same as createIndex with the difference that the index is checked for existence before adding to avoid duplicate indexes.
        +
        +
        +

        Index field

        +
        +

        Index field can be a simple string like "username" to index certain field (in this case, a field named as username ).

        +
        +
        collection.ensureIndex("username",callback)
+
        +
        +
        +

        It is possible to index fields inside nested objects, for example "user.firstname" to index field named firstname inside a document named user .

        +
        +
        collection.ensureIndex("user.firstname",callback)
+
        +
        +
        +

        It is also possible to create mixed indexes to include several fields at once.

        +
        +
        collection.ensureIndex({firstname:1, lastname:1}, callback)
+
        +
        +
        +

        or with tuples

        +
        +
        collection.ensureIndex([["firstname", 1], ["lastname", 1]], callback)
+
        +
        +
        +

        The number value indicates direction - if it’s 1, then it is an ascending value, if it’s -1 then it’s descending. For example if you have documents with a field date and you want to sort these records in descending order then you might want to add corresponding index

        +
        +
        collection.ensureIndex({date:-1}, callback)
+
        +
        +
        +
        +
        +
        +

        Remove indexes with dropIndex()

        +
        +

        All indexes can be dropped at once with dropIndexes

        +
        +
        collection.dropIndexes(callback)
+
        +
        +
        +

        callback gets two parameters - an error object (if an error occured) and a boolean value true if operation succeeded.

        +
        +
        +
        +

        Get index information with indexInformation()

        +
        +

        indexInformation can be used to fetch some useful information about collection indexes.

        +
        +
        collection.indexInformation(callback)
+
        +
        +
        +

        Where callback gets two parameters - an error object (if an error occured) and an index information object.

        +

        The keys in the index object are the index names and the values are tuples of included fields.

        +

        For example if a collection has two indexes - as a default an ascending index for the _id field and an additonal descending index for "username" field, then the index information object would look like the following

        +
        +
        {
+    "_id":[["_id", 1]],
+    "username_-1":[["username", -1]]
+}
+
        +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/insert.html b/markdown-docs/insert.html new file mode 100644 index 00000000000..616edf8ea75 --- /dev/null +++ b/markdown-docs/insert.html @@ -0,0 +1,404 @@ + + + + + + + + + + Inserting and updating — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Inserting and updating

        +
        +

        See also:

        +
        +
        +
        +
        +

        Insert

        +
        +

        Records can be inserted to a collection with insert

        +
        +
        collection.insert(docs[, options, callback])
+
        +
        +
        +

        Where

        +
        +
          +
        • docs is a single document object or an array of documents
          • +
        • options is an object of parameters, if you use a callback, set safe to true - this way the callback is executed after the record is saved to the database, if safe is false (default) callback is fired immediately and thus doesn’t make much sense.
          • +
        • callback - callback function to run after the record is inserted. Set safe to true in options when using callback. First parameter for callback is the error object (if an error occured) and the second is an array of records inserted.
          • +
        +
        +

        For example

        +
        +
        var document = {name:"David", title:"About MongoDB"};
+collection.insert(document, {safe: true}, function(err, records){
+    console.log("Record added as "+records[0]._id);
+});
+
        +
        +
        +

        If trying to insert a record with an existing _id value, then the operation yields in error.

        +
        +
        collection.insert({_id:1}, {safe:true}, function(err, doc){
+    // no error, inserted new document, with _id=1
+    collection.insert({_id:1}, {safe:true}, function(err, doc){
+        // error occured since _id=1 already existed
+    });
+});
+
        +
        +
        +
        +
        +
        +

        Save

        +
        +

        Shorthand for insert/update is save - if _id value set, the record is updated if it exists or inserted if it does not; if the _id value is not set, then the record is inserted as a new one.

        +
        +
        collection.save({_id:"abc", user:"David"},{safe:true}, callback)
+
        +
        +
        +

        callback gets two parameters - an error object (if an error occured) and the record if it was inserted or 1 if the record was updated.

        +
        +
        +
        +

        Update

        +
        +

        Updates can be done with update

        +
        +
        collection.update(criteria, update[, options[, callback]]);
+
        +
        +
        +

        Where

        +
        +
          +
        • criteria is a query object to find records that need to be updated (see Queries
          • +
        • update is the replacement object
          • +
        • options is an options object (see below)
          • +
        • callback is the callback to be run after the records are updated. Has two parameters, the first is an error object (if error occured), the second is the count of records that were modified.
          • +
        +
        +

        There are several option values that can be used with an update

        +
        +
          +
        • safe - run callback only after the update is done, defaults to false
          • +
        • multi - update all records that match the query object, default is false (only the first one found is updated)
          • +
        • upsert - if true and no records match the query, insert update as a new record
          • +
        • raw - driver returns updated document as bson binary Buffer, default:false
          • +
        +
        +

        If the replacement object is a document, the matching documents will be replaced (except the _id values if no _id is set).

        +
        +
        collection.update({_id:"123"}, {author:"Jessica", title:"Mongo facts"});
+
        +
        +
        +

        The example above will replace the document contents of id=123 with the replacement object.

        +

        To update only selected fields, $set operator needs to be used. Following replacement object replaces author value but leaves everything else intact.

        +
        +
        collection.update({_id:"123"}, {$set: {author:"Jessica"}});
+
        +
        +
        +

        See MongoDB documentation for all possible operators.

        +
        +
        +
        +

        Find and Modify

        +
        +

        To update and retrieve the contents for one single record you can use findAndModify .

        +
        +
        collection.findAndModify(criteria, sort, update[, options, callback])
+
        +
        +
        +

        Where

        +
        +
          +
        • criteria is the query object to find the record
          • +
        • sort indicates the order of the matches if there’s more than one matching record. The first record on the result set will be used. See Queries->find->options->sort for the format.
          • +
        • update is the replacement object
          • +
        • options define the behavior of the function
          • +
        • callback is the function to run after the update is done. Has two parameters - error object (if error occured) and the record that was updated.
          • +
        +
        +

        Options object can be used for the following options:

        +
        +
          +
        • remove - if set to true (default is false), removes the record from the collection. Callback function still gets the object but it doesn’t exist in the collection any more.
          • +
        • new - if set to true, callback function returns the modified record. Default is false (original record is returned)
          • +
        • upsert - if set to true and no record matched to the query, replacement object is inserted as a new record
          • +
        +
        var mongodb = require('mongodb'),
+    server = new mongodb.Server("127.0.0.1", 27017, {});
+
+new mongodb.Db('test', server, {}).open(function (error, client) {
+    if (error) throw error;
+    var collection = new mongodb.Collection(client, 'test_collection');
+    collection.findAndModify(
+        {hello: 'world'}, // query
+        [['_id','asc']],  // sort order
+        {$set: {hi: 'there'}}, // replacement, replaces only the field "hi"
+        {}, // options
+        function(err, object) {
+            if (err){
+                console.warn(err.message);  // returns error if no matching object found
+            }else{
+                console.dir(object);
+            }
+        });
+    });
+
        +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/queries.html b/markdown-docs/queries.html new file mode 100644 index 00000000000..6787ec34017 --- /dev/null +++ b/markdown-docs/queries.html @@ -0,0 +1,572 @@ + + + + + + + + + + Queries — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Queries

        +
        +

        See also:

        +
        +
        +
        +
        +

        Making queries with find()

        +
        +

        Collections can be queried with find .

        +
        +
        collection.find(query[[[, fields], options], callback]);
+
        +
        +
        +

        Where

        +
        +
          +
        • query - is a query object, defining the conditions the documents need to apply
          • +
        • fields - indicates which fields should be included in the response (default is all)
          • +
        • options - defines extra logic (sorting options, paging etc.)
          • +
        • raw - driver returns documents as bson binary Buffer objects, default:false
          • +
        +
        +

        The result for the query is actually a cursor object. This can be used directly or converted to an array.

        +
        +
        var cursor = collection.find({});
+cursor.each(...);
+
        +
        +
        +

        To indicate which fields must or must no be returned fields value can be used. For example the following fields value

        +
        +
        {
+    "name": true,
+    "title": true
+}
+
        +
        +
        +

        retrieves fields name and title (and as a default also _id ) but not any others.

        +
        +
        +
        +

        Find first occurence with findOne()

        +
        +

        findOne is a convinence method finding and returning the first match of a query while regular find returns a cursor object instead. Use it when you expect only one record, for example when querying with _id or another unique property.

        +
        +
        collection.findOne([query], callback)
+
        +
        +
        +

        Where

        +
        +
          +
        • query is a query object or an _id value
          • +
        • callback has two parameters - an error object (if an error occured) and the document object.
          • +
        +
        +

        Example:

        +
        +
        collection.findOne({_id: doc_id}, function(err, document) {
+    console.log(document.name);
+});
+
        +
        +
        +
        +
        +
        +

        _id values

        +
        +

        Default _id values are 12 byte binary hashes. You can alter the format with custom Primary Key factories (see Custom Primarky Keys in Database .

        +

        In order to treat these binary _id values as strings it would be wise to convert binary values to hex strings. This can be done with toHexString property.

        +
        +
        var idHex = document._id.toHexString();
+
        +
        +
        +

        Hex strings can be reverted back to binary (for example to perform queries) with ObjectID.createFromHexString

        +
        +
        {_id: ObjectID.createFromHexString(idHex)}
+
        +
        +
        +

        When inserting new records it is possible to use custom _id values as well which do not need to be binary hashes, for example strings.

        +
        +
        collection.insert({_id: "abc", ...});
+collection.findOne({_id: "abc"},...);
+
        +
        +
        +

        This way it is not necessary to convert _id values to hex strings and back.

        +
        +
        +
        +

        Query object

        +
        +

        The simplest query object is an empty one {} which matches every record in the database.

        +

        To make a simple query where one field must match to a defined value, one can do it as simply as

        +
        +
        {fieldname: "fieldvalue"}
+
        +
        +
        +

        This query matches all the records that a) have fields called fieldname and b) its value is “fieldvalue” .

        +

        For example if we have a collection of blog posts where the structure of the records is {title, author, contents} and we want to retrieve all the posts for a specific author then we can do it like this:

        +
        +
        posts = pointer_to_collection;
+posts.find({author:"Daniel"}).toArray(function(err, results){
+    console.log(results); // output all records
+});
+
        +
        +
        +

        If the queried field is inside an object then that can be queried also. For example if we have a record with the following structure:

        +
        +
        {
+    user: {
+        name: "Daniel"
+    }
+}
+
        +
        +
        +

        Then we can query the “name” field like this: {"user.name":"Daniel"}

        +

        If more than one fieldname is specified, then it’s an AND query

        +
        +
        {
+    key1: "value1",
+    name2: "value2"
+}
+
        +
        +
        +

        Whis query matches all records where key1 is “value1” and key2 is “value2”

        +

        OR queries are a bit trickier but doable with the $or operator. Query operator takes an array which includes a set of query objects and at least one of these must match a document before it is retrieved

        +
        +
        {
+    $or:[
+        {author:"Daniel"},
+        {author:"Jessica"}
+    ]
+}
+
        +
        +
        +

        This query match all the documents where author is Daniel or Jessica.

        +

        To mix AND and OR queries, you just need to use $or as one of regular query fields.

        +
        +
        {
+    title:"MongoDB",
+    $or:[
+        {author:"Daniel"},
+        {author:"Jessica"}
+    ]
+}
+
        +
        +
        +

        Conditional operators < , <= , > , >= and != can’t be used directly, as the query object format doesn’t support it but the same can be achieved with their aliases $lt , $lte , $gt , $gte and $ne . When a field value needs to match a conditional, the value must be wrapped into a separate object.

        +
        +
        {"fieldname":{$gte:100}}
+
        +
        +
        +

        This query defines that fieldname must be greater than or equal to 100 .

        +

        Conditionals can also be mixed to create ranges.

        +
        +
        {"fieldname": {$lte:10, $gte:100}}
+
        +
        +
        +

        Queried field values can also be matched with regular expressions

        +
        +
        {author:/^Daniel/}
+
        +
        +
        +

        In addition to OR and conditional there’s some more operators:

        +
        +
          +
        • $in - specifies an array of possible matches, {"name":{$in:[1,2,3]}}
          • +
        • $nin - specifies an array of unwanted matches
          • +
        • $all - array value must match to the condition {"name":{$all:[1,2,3]}}
          • +
        • $exists - checks for existence of a field {"name":{$exists:true}}
          • +
        • $mod - check for a modulo {"name":{$mod:{3,2}} is the same as "name" % 3 == 2
          • +
        • $size - checks the size of an array value {"name": {$size:2}} matches arrays name with 2 elements
          • +
        +
        +
        +
        +
        +

        Queries inside objects and arrays

        +
        +

        If you have a document with nested objects/arrays then the keys inside these nested objects can still be used for queries.

        +

        For example with the following document

        +
        +
        {
+    "_id": idvalue,
+    "author":{
+        "firstname":"Daniel",
+        "lastname": "Defoe"
+    },
+    "books":[
+        {
+            "title":"Robinson Crusoe"
+            "year": 1714
+        }
+    ]
+}
+
        +
        +
        +

        not only the _id field can be used as a query field - also the firstname and even title can be used. This can be done when using nested field names as strings, concated with periods.

        +
        +
        collection.find({"author.firstname":"Daniel})
        +
        +
        +

        Works even inside arrays

        +
        +
        collection.find({"books.year":1714})
+
        +
        +
        +
        +
        +
        +

        Query options

        +
        +

        Query options define the behavior of the query.

        +
        +
        var options = {
+    "limit": 20,
+    "skip": 10,
+    "sort": title
+}
+
+collection.find({}, options).toArray(...);
+
        +
        +
        +

        Paging can be achieved with option parameters limit and skip

        +
        +
        {
+    "limit": 20,
+    "skip" 10
+}
+
        +
        +
        +

        retrieves 10 elements starting from 20

        +

        Sorting can be acieved with option parameter sort which takes an array of sort preferences

        +
        +
        {
+    "sort": [['field1','asc'], ['field2','desc']]
+}
+
        +
        +
        +

        With single ascending field the array can be replaced with the name of the field.

        +
        +
        {
+    "sort": "name"
+}
+
        +
        +
        +

        Option parameter explain turns the query into an explain query.

        +
        +
        +
        +

        Cursors

        +
        +

        Cursor objects are the results for queries and can be used to fetch individual fields from the database.

        +

        cursor.nextObject(function(err, doc){}) retrieves the next record from database. If doc is null, then there weren’t any more records.

        +

        cursor.each(function(err, doc){}) retrieves all matching records one by one.

        +

        cursor.toArray(function(err, docs){}) converts the cursor object into an array of all the matching records. Probably the most convenient way to retrieve results but be careful with large datasets as every record is loaded into memory.

        +
        +
        collection.find().toArray(function(err, docs){
+    console.log("retrieved records:");
+    console.log(docs);
+});
+
        +
        +
        +

        cursor.rewind() resets the internal pointer in the cursor to the beginning.

        +
        +
        +
        +

        Counting matches

        +
        +

        Counting total number of found matches can be done against cursors with method count .

        +
        +
        cursor.count(callback)
+
        +
        +
        +

        Where

        +
        +
          +
        • callback is the callback function with two parameters - an error object (if an error occured) and the number on matches as an integer.
          • +
        +
        +

        Example

        +
        +
        cursor.count(function(err, count){
+    console.log("Total matches: "+count);
+});
+
        +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/markdown-docs/replicaset.html b/markdown-docs/replicaset.html new file mode 100644 index 00000000000..16316dd4bed --- /dev/null +++ b/markdown-docs/replicaset.html @@ -0,0 +1,327 @@ + + + + + + + + + + Replicasets — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +
        +

        Replicasets

        +
        +

        Introduction

        +
        +

        Replica sets is the asynchronous master/slave replication added to Mongodb that takes care off all the failover and recovery for the member nodes. According to the mongodb documentation a replicaset is

        +
        +
          +
        • Two or more nodes that are copies of each other
          • +
        • Automatic assignment of a primary(master) node if none is available
          • +
        • Drivers that automatically detect the new master and send writes to it
          • +
        +
        +

        More information at Replicasets

        +
        +
        +
        +

        Driver usage

        +
        +

        To create a new replicaset follow the instructions on the mongodb site to setup the config and the replicaset instances. Then using the driver.

        +
        +
        var replSet = new ReplSetServers( [
+    new Server( 127.0.0.1, 30000),
+    new Server( 127.0.0.1, 30001),
+    new Server( 127.0.0.1, 30002)
+  ],
+  {rs_name:RS.name}
+);
+
+var db = new Db('integration_test_', replSet);
+db.open(function(err, p_db) {
+  // Do you app stuff :)
+})
+
        +
        +
        +

        The ReplSetSrvers object has the following parameters

        +
        +
        var replSet = new ReplSetSrvers(servers, options)
+
        +
        +
        +

        Where

        +
        +
          +
        • servers is an array of Server objects
          • +
        • options can contain the following options
          • +
        +
        +
        +
        +
        +

        Replicaset options

        +
        +

        Several options can be passed to the Replicaset constructor with options parameter.

        +
        +
          +
        • rs_name is the name of the replicaset you configured when you started the server, you can have multiple replicasets running on your servers.
          • +
        • read_secondary set’s the driver to read from secondary servers (slaves) instead of only from the primary(master) server.
          • +
        • socketOptions - a collection of pr socket settings
          • +
        +
        +
        +
        +
        +

        Socket options

        +
        +

        Several options can be set for the socketOptions .

        +
        +
          +
        • timeout = set seconds before connection times out default:0
          • +
        • noDelay = Disables the Nagle algorithm default:true
          • +
        • keepAlive = Set if keepAlive is used default:0 , which means no keepAlive, set higher than 0 for keepAlive
          • +
        • encoding = ‘ascii’|’utf8’|’base64’ default:null
          • +
        +
        +
        +
        +
        + + +
        +
        +
        +
        +
        +

        Contents

        + + + + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 00000000000..b8da663e2e7 Binary files /dev/null and b/objects.inv differ diff --git a/package.json b/package.json deleted file mode 100755 index 6011cb9f393..00000000000 --- a/package.json +++ /dev/null @@ -1,80 +0,0 @@ -{ "name" : "mongodb" -, "description" : "A node.js driver for MongoDB" -, "keywords" : ["mongodb", "mongo", "driver", "db"] -, "version" : "0.9.9-1" -, "author" : "Christian Amor Kvalheim " -, "contributors" : [ "Aaron Heckmann", - "Christoph Pojer", - "Pau Ramon Revilla", - "Nathan White", - "Emmerman", - "Seth LaForge", - "Boris Filipov", - "Stefan Schärmeli", - "Tedde Lundgren", - "renctan", - "Sergey Ukustov", - "Ciaran Jessup", - "kuno", - "srimonti", - "Erik Abele", - "Pratik Daga", - "Slobodan Utvic", - "Kristina Chodorow", - "Yonathan Randolph", - "Brian Noguchi", - "Sam Epstein", - "James Harrison Fisher", - "Vladimir Dronnikov", - "Ben Hockey", - "Henrik Johansson", - "Simon Weare", - "Alex Gorbatchev", - "Shimon Doodkin", - "Kyle Mueller", - "Eran Hammer-Lahav", - "Marcin Ciszak", - "François de Metz", - "Vinay Pulim", - "nstielau", - "Adam Wiggins", - "entrinzikyl", - "Jeremy Selier", - "Ian Millington", - "Public Keating", - "andrewjstone", - "Christopher Stott", - "Corey Jewett", - "brettkiefer", - "Rob Holland", - "Senmiao Liu", - "heroic", - "gitfy", - "Andrew Stone", - "John Le Drew"] - -, "repository" : { "type" : "git" - , "url" : "http://github.com/christkv/node-mongodb-native.git" } -, "bugs" : { "mail" : "node-mongodb-native@googlegroups.com" - , "url" : "http://github.com/christkv/node-mongodb-native/issues" } -, "os" : [ "linux" - , "darwin" - , "freebsd" ] -, "devDependencies": { - "dox": "0.1.3" - , "uglify-js": "1.2.5" - , "ejs": "0.6.1" - , "nodeunit": "0.7.3" - , "github3": ">=0.3.0" - , "markdown": "0.3.1" - , "gleak": "0.2.3" - , "step": "0.0.5" - } -, "config": { "native" : false } -, "main": "./lib/mongodb/index" -, "directories" : { "lib" : "./lib/mongodb" } -, "engines" : { "node" : ">=0.4.0" } -, "scripts": { "install" : "node install.js" } -, "licenses" : [ { "type" : "Apache License, Version 2.0" - , "url" : "http://www.apache.org/licenses/LICENSE-2.0" } ] -} diff --git a/search.html b/search.html new file mode 100644 index 00000000000..6b8b939d332 --- /dev/null +++ b/search.html @@ -0,0 +1,251 @@ + + + + + + + + + + Search — MongoDB Node.JS Driver 1.2.14 documentation + + + + + + + + + + + + + + + + +
        +

        Navigation

        + + +
        + +
        +
        +
        +
        + +

        Search

        +
        + +

        + Please activate JavaScript to enable the search + functionality. +

        +
        +

        + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

        +
        + + + +
        + +
        + +
        + +
        +
        +
        +
        +
        + +
          +
        +

        Manual

        + + + + +

        MongoDB Wiki

        + + +
        +
        +
        +
        + +
        + +
        +

        Navigation

        + + +
        +
        + © Copyright 2013, MongoDB Node.JS Team + Created using Sphinx 1.1.3. + +

        The MongoDB Documentation Project uses GitHub. Fork the repository and submit pull requests to contribute.

        +

        If you find any issues with the documentation feel free to open a Jira Case and we'll work to resolve it promptly.

        + +
        + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 00000000000..83041c4babb --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({objects:{"":{DBRef:[21,0,1,""],"_enableHA":[40,1,1,""],removeUser:[11,1,1,""],profilingInfo:[26,1,1,""],getNumBitsAbs:[38,1,1,""],batchSize:[22,1,1,""],"chunkSize number [Getter|Setter]":[5,2,1,""],MinKey:[6,0,1,""],shiftRight:[38,1,1,""],writeFile:[5,1,1,""],getTimestamp:[23,1,1,""],Grid:[33,0,1,""],replSetGetStatus:[26,1,1,""],indexInformation:[11,1,1,""],previousErrors:[11,1,1,""],CursorStream:[41,0,1,""],findAndModify:[18,1,1,""],renameCollection:[11,1,1,""],inheritReplSetOptionsFrom:[27,1,1,""],toHexString:[23,1,1,""],indexExists:[18,1,1,""],getLowBits:[38,1,1,""],ObjectID:[23,0,1,""],isNegative:[38,1,1,""],lessThan:[38,1,1,""],isCapped:[18,1,1,""],dropAllIndexes:[18,1,1,""],lastError:[11,1,1,""],"md5 number [Getter|Setter]":[5,2,1,""],Long:[15,0,1,""],validateCollection:[26,1,1,""],findAndRemove:[18,1,1,""],cursorInfo:[11,1,1,""],geoNear:[18,1,1,""],toString:[38,1,1,""],listDatabases:[26,1,1,""],isOdd:[38,1,1,""],calculateObjectSize:[2,1,1,""],dropDatabase:[11,1,1,""],Server:[27,0,1,""],Cursor:[22,0,1,""],MaxKey:[12,0,1,""],setReadPreference:[27,1,1,""],toArray:[22,1,1,""],reIndex:[11,1,1,""],collectionsInfo:[11,1,1,""],greaterThanOrEqual:[38,1,1,""],Binary:[34,0,1,""],"_handleOnFullSetup":[40,1,1,""],valueOf:[37,1,1,""],dropIndex:[11,1,1,""],serializeWithBufferAndIndex:[2,1,1,""],resetErrorHistory:[11,1,1,""],Timestamp:[38,0,1,""],Symbol:[37,0,1,""],dropCollection:[11,1,1,""],Collection:[18,0,1,""],toNumber:[38,1,1,""],isZero:[38,1,1,""],getHighBits:[38,1,1,""],ReadPreference:[25,0,1,""],shiftLeft:[38,1,1,""],createCollection:[11,1,1,""],greaterThan:[38,1,1,""],Mongos:[9,0,1,""],getLowBitsUnsigned:[38,1,1,""],Code:[4,0,1,""],ReplSet:[40,0,1,""],geoHaystackSearch:[18,1,1,""],mapReduce:[18,1,1,""],lessThanOrEqual:[38,1,1,""],MongoClient:[32,0,1,""],notEquals:[38,1,1,""],GridStore:[5,0,1,""],findOne:[18,1,1,""],ensureIndex:[11,1,1,""],chunkCollection:[5,1,1,""],nextObject:[22,1,1,""],toJSON:[38,1,1,""],Db:[11,0,1,""],"_disableHA":[40,1,1,""],serverStatus:[26,1,1,""],profilingLevel:[26,1,1,""],collectionNames:[11,1,1,""],ReadStream:[8,0,1,""],setProfilingLevel:[26,1,1,""],Admin:[26,0,1,""],Double:[17,0,1,""],shiftRightUnsigned:[38,1,1,""],isClosed:[22,1,1,""],BSON:[2,0,1,""],assignReplicaSet:[27,1,1,""],addUser:[11,1,1,""],toInt:[38,1,1,""],deserializeStream:[2,1,1,""],createIndex:[11,1,1,""],buildInfo:[26,1,1,""]},GridStore:{read:[5,1,1,""],exist:[5,1,1,""],readlines:[5,1,1,""],unlink:[5,1,1,""],list:[5,1,1,""]},ObjectID:{createFromTime:[23,1,1,""],createFromHexString:[23,1,1,""]},ReplSet:{State:[40,1,1,""]},Timestamp:{fromBits:[38,1,1,""],fromString:[38,1,1,""],fromInt:[38,1,1,""],fromNumber:[38,1,1,""]},Db:{connect:[11,1,1,""]},Long:{fromBits:[15,1,1,""],fromNumber:[15,1,1,""],fromInt:[15,1,1,""],fromString:[15,1,1,""]},BSON:{serializeWithBufferAndIndex:[2,1,1,""],serialize:[2,1,1,""],deserializeStream:[2,1,1,""],calculateObjectSize:[2,1,1,""],deserialize:[2,1,1,""]},MongoClient:{connect:[32,1,1,""]}},terms:{nwt:[],returnkei:[20,22,18],maxscan:[20,22,18],readfilesync:[5,36],prefix:[35,20,42],crete:18,createindex:[11,18,20,7,29,10],world_safe2:18,world_safe1:18,pedro:13,test_map_reduce_functions_inlin:18,concret:[],under:20,jamuhl:[],everi:[0,22,16,24],downstream:20,test_gs_seek_with_buff:5,affect:36,disabledriverbsonsizecheck:[35,20,27],simple_next_object_collect:22,upload:24,correct:[11,43,20,5,23],math:23,gotik:19,simple_rename_collect:11,"10k":20,throught:36,seper:[5,36],direct:[7,22,43,35],second:[26,22,14,3,20,23,5,16,42,18,33,44,32,11],street:[],aggreg:[13,1,36,18,20,29,10],even:[0,39,18],attemp:[20,11,18],neg:[20,15,38],weren:0,newdbinst:18,"new":[0,1,2,3,20,5,7,8,11,13,14,15,32,18,42,22,23,24,26,16,36,35,33,38,41,44],databank:[],metadata:[24,44,5,33],test_correctly_access_collections2:11,rootcollect:5,never:[35,20,11],here:[43,44,8,5],comparedata:36,epce4qkoh5:39,path:[24,20,5],integration_tests_to_drop:11,anymor:20,robin:[35,20,43],getlowbit:[28,15,38,10],counter2:[],findandmodifi:[20,18,29,10,14],expireaftersecond:[11,18],vincentcr:20,pvorb:[],schemaless:43,unix:35,replicatset:36,m_tddbw6qnuu4iuxlyo:39,middlewar:39,sarah:18,describ:39,would:[0,11,18,20,15,35,7,44,38],init:22,deviat:20,overhead:[43,20],typo:20,recommend:[43,20,39,11,18],type:[2,4,5,6,12,13,26,17,20,21,22,18,24,25,36,34,33,37,39,41,43,44,45],tell:[11,18,5,29,43,44,10],relax:20,relat:[7,20],notic:[35,44,36,43,18],warn:[35,18,11,14],exce:5,rip:11,hold:[43,5,22],must:[35,36,0,38,15,18],join:39,err:[0,26,8,33,22,14,3,24,20,18,5,16,41,42,36,35,43,44,32,11],aheckmann:20,setup:[3,20,44,11,36],work:[0,11,35,20,39,5,36,43,30,44,22],test_gs_tel:5,rework:20,root:[44,5,33],overrid:[13,1,11,18,20,35,36,32,22],give:39,autodetect:20,simple_geo_haystack_command:18,indic:[0,14,13,42,7,24,43,16],unavail:[25,36],want:[0,11,18,20,5,27,16,7,42,17,40,33,35,43,44,32,36],keep:[24,20,11,43,18],unsign:[38,15],port2:35,end:[35,8,18,24,20,39,5,41,43,44,42],replicaset:[13,1,11,35,3,20,26,40,31,9,32,36],quot:[20,22],playerid:39,how:[13,1,39,11,18,26,5,35,45,36,43,30,44,22],"_id_":[11,18],recoveri:3,env:11,rewind:[0,22,20,5,29,10],verifi:[35,11,18,26,5,23],chase:20,config:[3,20,32,11],updat:[34,13,1,26,11,14,20,18,35,39,29,43,44,31,32,10],maxdist:18,recogn:5,outsid:36,after:[35,26,8,22,14,24,20,18,5,39,41,2,33,43,44,32,11],listdatabas:[29,20,26,11,10],befor:[0,22,18,3,20,5,16,7,41,40,36,35,43,44,32,11],wrong:20,simple_document_insert_with_function_saf:18,beauti:[13,39],parallel:43,demonstr:39,attempt:[35,11,20,26,5,40,43,9,16,36],third:5,credenti:11,zzdhidden:[],exclud:[22,18],perform:[0,26,22,18,20,15,35,36,38,11],maintain:39,errorobject:20,order:[0,22,14,18,35,7,16],origin:[18,5,14],cursorinfo:[29,11,10],over:[36,18,20,39,11,16,22],failur:[43,20],becaus:[35,38,15],readbuff:[20,44],flexibl:[],vari:20,digest:[20,44],uuid:[34,2],fit:[43,22],fix:[20,44],mongolia:[],better:[35,1,36,13,20,43,16],complex:[43,36,11,18],loggerinst:20,persist:[43,19,18],mydb:35,split:[38,15,5],them:43,thei:[35,36,38,15,43,44,20],authdb:[],safe:[14,11,18,20,26,42,32,36],"break":35,update_a_simple_docu:18,test_gs_weird_bug_stream:5,yourself:39,bread:[],"instanceof":[20,26,11,18],choic:20,guileen:[],changelog:[13,20],overflow:[20,15,38],bonu:43,timeout:[35,11,18,3,20,16,36,32,22],each:[0,8,22,40,18,3,20,15,5,35,38,41,29,36,44,9,16,10,11],debug:[35,11,20,27,16,40],went:[],a_simple_collect:11,mean:[35,36,3,20,39,43,44,16,22],resum:[8,20,5,41,29,10],customobject:36,nin:0,eventstor:[],extract:20,network:35,goe:20,newli:[7,42,26],content:[34,0,8,36,14,24,39,5,43,44,10,33],daniel:[0,16,24],reader:[20,36],got:[43,11,18],unrecogn:35,more_index_information_test:[11,18],validatecollect:[20,26,29,10],navig:44,worthwhil:44,rail:[],findandremov:[20,29,10,18],situat:20,standard:[35,20],sharded_test_db:32,md5:[34,20,2,5],flush:[44,8,5],filter:[39,11,18],mvc:[],pagin:18,regress:20,onto:20,getmongopackag:[],rang:[35,0,20,40,18],instruct:3,alreadi:[35,11,14,24,42,5,7,43,16,22],messag:[14,11,18,20,26,5,27,35,40,16],unlin:5,getnumbitsab:[28,15,38,10],mojo:[],hexstr:23,rewritten:[20,36],top:[38,15,18],keyf:[20,18],startindex:2,ton:[43,44],tom:39,recent:39,kamikazepanda:19,listen:20,consol:[0,36,14,24,42,43,44,16],namespac:[11,21],eventlisten:20,took:22,sync:[35,18,32,11],incur:43,gyp:20,removeus:[29,20,26,11,10],silli:43,target:[44,11,18],provid:[35,11,18,20,15,5,40,38,43,44,9,32,36],zero:[20,15,38,23],project:[13,30,39,36,18],matter:[35,43],iron:43,myexperience620186085001:39,thu:[35,14],websocket:43,behavior:[35,0,14,20,15,43,38],modern:[],mind:43,raw:[0,11,14,20,18,16,42,36,35,44,32,22],seed:35,manner:[20,44],increment:[43,39],seem:35,incompat:35,seek:[24,20,5,29,44,10],dbref:[13,11,20,28,43,21],ensureindex:[11,18,20,7,29,10],deref:[],simple_limit_collect:22,data2:5,simplifi:[35,20,44],evangelist:39,insur:20,plenti:44,usernam:[7,26,11,35],object:[0,2,3,4,5,7,8,9,11,13,14,26,32,18,20,22,23,24,25,27,16,33,34,35,36,45,39,40,41,42,43,44],what:[13,22,42,39,43,44,36],regular:[0,20,24],tradit:43,simplic:[35,44],don:[35,36,18,20,16,11],doc:[0,26,22,14,20,18,5,35,41,36,43,32,11],flow:20,doe:[14,39,11,18,20,15,5,35,42,43,44,38,36],declar:20,bson_data_d:2,radix:[38,15],random:[25,5,36],speedup:20,syntax:[35,20],test_stream_funct:22,identifi:[35,42,44,36,43],erhangundogan:[],involv:20,absolut:[38,15,44,5],acquir:22,field2:0,explain:[0,22,18,20,29,10,11],field1:0,secondarypref:[35,36],theme:43,busi:43,rich:43,ppf_qxbkwm4g:39,io_seek_cur:5,cachefunct:2,sslpass:[40,27],test_cursorstream_destroi:41,stop:20,collectionsinfo:[29,11,10],bson_data_numb:2,report:[43,20],youtub:[30,39,19],bar:5,emb:[30,39,19],patch:20,bad:[36,18],previouli:22,fieldnam:0,fair:44,indexnam:[11,18],num:18,structur:[0,44,43],previouserror:[29,11,10],respons:[0,39,22,36],fail:[35,36,18,20,26,33,43,11],christian:39,writestream:20,awar:18,said:[44,36],databas:[0,33,26,22,14,13,20,18,5,16,45,42,24,35,43,44,31,32,11],test_gs_empty_file_eof:5,discoveri:[20,39],gridstor:[13,26,8,33,22,23,24,20,18,5,45,41,29,36,44,31,32,10,11],simplest:[0,44],awai:44,lotsofdoc:43,accord:3,newnam:18,getlasterror:[35,11,18,20,26,32],howev:22,against:[0,26,22,40,23,20,15,5,27,35,18,36,38,11],logic:[0,20],login:35,browser:[],com:[13,20,39,19,43,30],col:[],con:39,assur:22,asced:22,simple_explain_collect:22,height:[30,39,19],getmorecommand:[22,18],io_seek_set:5,toerror:20,guid:13,assum:[38,15],duplic:[7,20,18,22,11],three:[43,44,5],been:[11,36,20,44,16,22],much:[35,1,39,36,13,20,14,43,44],basic:[35,11,13,18,43,44,32,45],arbit:[35,20,40],regul:22,nodeeventstor:[],isodd:[28,15,38,10],ani:[0,36,22,14,5,35,33,43,44,11],child:[32,11],"catch":[20,18],laurie71:20,simple_rename_collection3:11,another_root:5,mapreduce_integration_test:18,dissect:44,properti:[0,24,20,5,29,16,10],calcul:[2,36],marriag:[13,39],"typeof":[20,5],aid:36,maxbsons:20,mycollect:11,succes:18,toolkit:[],sever:[14,3,42,7,43,16],grown:43,usessl:[],test_is_close_function_on_cursor:22,receiv:[35,44,8],make:[0,22,14,20,18,35,7,43,44,16,36],format:[0,1,22,14,13,20,18,35,36,11],meetup:[13,39],filestream:[5,36],drawback:44,descend:[7,22],isneg:[28,15,38,10],complet:[35,20,18],reset_error_histori:11,pick:[35,11,20,43,44,40,36],hang:20,hand:16,fairli:[20,36],rais:35,tune:44,scenario:16,geohaystack:18,test_close_function_on_cursor:22,client:[35,11,14,20,26,36,43,32,22],thi:[0,8,20,5,7,11,14,15,26,32,18,40,22,23,24,25,27,30,16,36,34,35,33,38,39,43,44],everyth:14,settimeout:[8,36,18,20,41,11],left:[35,36,18,38,15,16,11],protocol:[43,20,22],just:[35,36,0,18,43,44],laptop:20,ordin:[11,18],farther:8,sslca:[40,27],yet:16,languag:[43,39],previous:[35,20,11,18],doc1:43,wmode:39,easi:36,collectionn:16,had:22,board:39,hap:36,els:[18,26,16,14],ffffff:39,save:[8,11,14,24,20,18,5,29,16,10],dynamicstream:39,applic:[13,22,18,20,39,25,35,19,36,43,44,11],milli:26,preserv:22,background:[11,18],test_ev:11,apart:[43,44],measur:20,specif:[0,39,22,13,20,23,5,35,18,36,43,42,11],arbitrari:[20,5,33],manual:[13,32,10,11],callbackstor:20,collection2:[11,18],collection1:18,underli:41,www:[13,11,35,39,19,30],right:[39,38,15,44,43],old:[34,5],creek:39,deal:43,negat:[28,15,38,10],interv:[20,40],deserializestream:[28,2,10],dead:20,intern:[0,22,18,24,38,15],sockettimeoutm:[35,36,20,27,9,40],indirect:35,successfulli:22,insensit:22,nwtj:[],readpreferencetag:35,timestampd:23,multipli:[28,15,38,10,18],fog:39,christkv:[43,20],condit:[0,20,18],foo:[36,18],localhost:[35,36,20,42,43,44,32,11],a_simple_create_drop_collect:11,collection_stats_test:18,statsync:5,promot:43,repositori:[43,20],post:[0,36,18,38,15,42],ryanke:[],plug:43,obj:18,bson_deseri:20,slightli:43,simul:[38,15,44],commit:11,produc:[25,36],simple_previous_error_col:11,pingstrategi:20,bson_data_symbol:2,"float":[43,38,15],simple_skip_collect:22,bound:[36,18,22,11],down:[35,20,9,11,36],getyear:18,gridstorewrit:5,wrap:[0,8,37,20,41,17],storag:[43,44],git:20,rrusso2007:20,wai:[0,1,11,14,13,20,15,35,18,43,44,38],hotfix:20,support:[0,1,11,13,24,20,27,35,43,44,40,36],transform:[41,22],happi:[13,39],avail:[13,1,8,11,18,3,41,20,26,25,5,35,39,43,44,9,40,36],width:[30,39,19],test_rename_collection3:18,call:[0,33,11,18,20,26,5,16,36,44,32,22],constantli:43,bulqmxg0vdc:39,fork:[],head:[44,5],medium:26,form:[20,39,5],forc:[35,11,18,20,26,27,32,22],"true":[0,8,3,20,5,7,9,11,14,26,32,42,22,18,24,16,36,35,33,39,40,41,44],reset:[11,0,20,5,22],absent:35,awaidata:[22,18],new_nam:42,bugfix:20,geospati:[11,18],maximum:[35,20,22,43,11],until:[43,26,11,36],fundament:43,dropallindex:[29,10,18],emit:[11,22,18,20,41,43,32,36],shouldcorrectlyfailonretryduetoappcloseofdb:11,featur:[13,1,44,20,36],"abstract":[],fromstr:[38,20,15,28,10],exist:[0,26,11,14,24,20,18,5,16,7,42,29,35,43,44,32,10],videoplay:39,check:[0,26,8,22,18,24,20,15,5,35,41,7,2,40,36,43,9,38,11],test_collection_opt:18,bson_binary_subtype_md5:[34,2],test_to_a_after_each:22,floor:23,tip:13,refactor:20,simple_limit_skip_find_one_queri:18,test:[35,26,8,22,14,24,20,18,5,41,19,42,36,43,44,33,11],forceclos:11,miliscecond:[41,8],node:[13,22,35,3,20,39,19,43,30,10,36],consid:[35,18],sql:43,cachefunctionscrc32:2,errormessag:20,teixeira:13,faster:[7,1,36,20,13],ignor:[35,2,43,18],time:[13,39,22,23,3,20,18,35,45,40,36,43,9,16,11],push:[43,20,41,22,11],backward:[20,22],daili:39,concept:[43,20],skip:[0,22,18,20,29,10],global:20,gettimestamp:[20,28,10,23],read_secondary_onli:22,row:18,millisecond:[35,16],decid:20,middl:18,depend:20,readabl:36,"_disableha":[40,29],originalhex:23,dropindex:[29,7,11,10,18],sourc:[39,19,22],string:[0,2,4,5,7,11,15,26,18,20,21,22,23,24,25,27,32,34,35,33,37,38,40,42,43,44],alinsilvian:20,feasibl:44,word:35,wvalu:35,cool:[36,18],logmeup:[],contenttyp:24,level:[13,1,11,18,20,26,5,35,36],did:[20,11],dig:43,eventemitt:20,iter:[20,22,18],item:[8,11,18,20,26,5,41,36,43,22],unsupport:35,team:39,quick:[43,44,39],div:[39,28,15,38,10],round:[35,20,43],databasenam:[11,16],wtimeout:[35,11,18,20,26,32],prevent:20,addtoset:[43,36,18],sign:[38,15,42],slow_onli:26,cost:20,port:[43,20,11,27,16],comparis:5,checkoutwrit:11,repli:[43,26,18],muq2w2u5x9m:30,current:[35,26,11,24,20,15,5,38,39,36,43,44,32,21],subtype_uuid:34,boost:[],deriv:[38,15],autogener:[11,18],gener:[13,11,18,20,23,16,35,44,32],explicitli:35,address:35,wait:[35,36,22,18,40,32,11],box:43,bson_data_regexp:2,shift:[20,15,38],step:[20,44],queue:43,thesmart:20,behav:20,examp:[],numberofretri:[35,11,18,20,32,16,22],extrem:20,weird:20,werehamst:[],ourselv:[9,27],regardless:36,checkkei:2,extra:[0,36],tweak:35,modul:20,prefer:[0,1,22,13,20,18,25,27,35,40,36,43,32,11],playerkei:39,toarrai:[0,22,18,20,26,29,36,43,10,11],bxhflrwemeg:19,instal:[43,20],includeloc:18,aaaaipotmrk:39,perf:20,swatinem:20,memori:[0,22,13,20,45,43,44],sake:35,shtylman:20,serverstatu:[20,26,29,10],connector:[13,39],live:[43,20,44],handler:44,value2:0,value1:0,criteria:14,msg:20,scope:[2,11,18,4,43,20],prev:18,maxkei:[12,13,2,20,28,10],multiplecoll1:11,peopl:[20,36],finit:[38,15],visual:[],prototyp:35,examin:43,content_typ:[24,44,5,33],fly:[],cap:[43,20,11,18],uniqu:[0,11,18,5,7,16,33],primer:[13,44,39,45],test_correctly_access_collect:11,whatev:16,bson_binary_subtype_funct:[34,2],nearest:[35,11,18,20,25,27,40,32,36],connecttimeoutm:[35,36,20,27,9,40],mongo:[13,1,22,14,20,39,16,45,29,36,35,43,44,9,32,11],stream:[13,1,8,22,24,20,41,5,2,29,43,44,10,36],predict:20,uri_decode_auth:[32,11],bson_data_long:2,createcollect:[22,18,20,41,29,36,43,42,10,11],topic:[13,39],nocr:[],authsourc:[35,20,11],kaflr8pi5nk:30,occur:[0,26,22,14,24,20,18,5,16,7,42,33,32,11],alwai:[26,22,18,20,15,27,43,9,38,11],multipl:[35,36,18,3,20,15,5,38,16],m4tty:20,ping:[35,11,20,26,29,40,10,36],fieldvalu:0,write:[34,35,2,11,18,3,24,20,5,16,28,8,29,33,43,44,32,10,36],foreach:[5,18],pure:[26,8,22,23,20,18,5,41,33,32,11],nyc:[13,39],map:[43,20,36,18],product:[39,38,15],max:[20,18,22,11],dive:[43,44],date:[2,22,18,20,23,26,7,43,36],docstartindex:2,data:[34,13,33,8,22,18,24,20,39,5,41,45,2,19,36,43,44,11],grow:43,sbrekken:20,inform:[35,11,18,3,24,26,5,7,43,16,22],"switch":20,reaper:[20,16],combin:[35,36,18,39,25,5,32,11],anoth:[35,0,23,5,43,32],shouldtriggermassiveamountofgetmor:[],filedata:[5,36],talk:39,increas:20,still:[35,0,20,14],pointer:[0,42,5,16,24],dynam:39,test_map_reduce_funct:18,group:[13,36,18,20,39,29,30,44,10],gte:0,indexexist:[20,29,10,18],secondaryacceptablelatencym:[35,36,40],jim:18,nodelai:[35,3,20,27,40,9,16],mongocli:[13,1,8,33,22,23,20,18,26,5,35,41,29,36,43,44,32,10,11],platform:43,window:20,requir:[35,26,8,33,22,14,20,23,5,16,42,41,18,36,43,44,32,11],main:[13,44,39,43,35],non:[20,18],"6pjmp23z0lw":30,thrid:42,encod:[3,43,20,16],col2:11,col3:11,initi:[35,8,11,18,20,5,43,44,32,22],col1:11,milisecond:[11,18,20,32,40,22],now:[43,20,44,11,36],discuss:[13,39],nor:42,introduct:[13,45,3,39,35,43],mapreduc:[20,29,10,18],name:[0,2,3,20,5,7,11,14,26,32,42,21,22,18,24,16,34,35,36,39,40,44],readfil:5,drop:[11,18,20,42,7,29,16,10],revert:0,crypto:20,separ:[0,20,5,35],mongoerror:20,jprichardson:[],compil:20,failov:[3,20,9,36],domain:[35,20],replai:20,dialect:[],replac:[0,18,20,14,5,43],individu:[0,20,36],a_1_b_1:[11,18],ensur:[35,36,18,20,5,7,43,44,11],poolreadi:20,serverclust:20,urlpars:20,happen:[41,20,8,5],shown:[43,44,36],accomplish:44,"3rd":20,space:[35,2,11],streetsaheadllc:[],profil:[26,22,18],tohexstr:[0,20,28,10,23],factori:[0,16,18],variant:43,million:39,orm:39,mime:[5,33],sethml:20,replacethiscollect:18,org:[35,13,32,11],"byte":[34,0,2,11,18,24,20,23,43,44,16],care:[3,0,11,43,35],question:[39,38,15],bradberri:39,synchron:43,thing:[43,44,16],place:[13,38,15],year2013:20,frequent:[38,15],first:[0,26,22,40,14,24,20,23,5,16,42,39,18,33,43,44,32,11],oper:[0,26,22,14,24,20,15,25,42,16,38,7,18,36,35,43,44,32,11],bson_binary_:20,directli:[0,20,22,43,35],onc:[36,18,20,7,43,11,22],arrai:[34,0,26,2,22,14,3,24,20,18,5,27,42,36,43,9,40,11],fullsetup:[20,11,40,36],"0x7f":2,reopen:[5,16],"long":[13,2,22,23,20,15,35,28,43,10],serverinfo:18,open:[8,3,20,5,10,11,14,26,32,42,22,18,24,27,29,16,36,35,33,39,41,43,44],predefin:2,size:[0,33,2,22,18,24,20,15,5,36,44,38,11],given:[34,35,11,18,20,15,5,44,38,22],breviti:[43,44],workaround:20,tonumb:[28,15,38,10],collectionnam:[11,18,42,26,7,29,44,16,10],secondary_pref:[35,11,18,20,25,27,40,32,36],sslkei:[40,27],conveni:[0,38,15],subtype_md5:34,especi:43,copi:3,circumst:20,specifi:[34,0,11,18,24,20,5,35,43,44,16,22],test_rename_collection2:18,test_arrai:22,keepgo:[20,18],than:[0,22,14,3,24,20,15,38,18,36,44,16,11],png:[24,5],serv:39,"_id":[0,11,14,20,18,5,16,7,33,35,44,32,36],tedeh:20,were:[22,14],posit:[34,24,38,15,5,44],seri:[],pre:[26,2,11,18],lowest:[35,20,40],sai:44,sam:[36,18],pro:39,argument:[8,4,5,2,9,11,15,26,17,18,40,21,22,23,25,27,32,34,33,37,38,41,20,44],subroutin:20,simple_rename_collection_2:11,test_gs_read_stream_pip:5,deliv:39,bitwis:[43,38,15],squar:[],alias:0,destroi:[41,8,29,10],note:[35,38,15,22,11],continueonerror:18,take:[0,2,35,3,20,39,27,43,44],createfromhexstr:[0,20,28,10,23],maxpools:35,begin:[0,5,35],sure:[44,22,16],normal:[20,22],buffer:[34,0,2,22,14,24,20,18,5,27,16,42,40,33,35,44,32,11],connectarbit:[35,20,40],clearer:20,pair:35,homepag:[],deepequ:[36,22,18,5,11,33],renam:[11,18,20,29,43,42,10],byte_valu:34,later:[44,11,18],mongoclient_test:32,indexbound:[11,18],test_gs_read_stream:5,runtim:20,parseint:18,axi:18,wtimeoutm:35,show:[35,8,11,18,23,5,41,33,43,22],enumer:35,simple_count_exampl:18,objectid3:23,objectid2:23,concurr:20,limitrequest:20,corner:20,onli:[0,26,22,14,3,20,18,25,5,35,7,36,43,44,16,11],slow:[20,26,11,18],dice:43,fenc:[35,40],setprofilinginfo:26,activ:[20,36],state:[22,20,16,29,43,40],admin3:26,admin2:26,admin5:26,admin4:26,admin7:26,admin6:26,admin9:26,admin8:26,analyt:[13,39,43],offici:35,overwritten:44,min_valu:[38,15],variou:[26,18],get:[8,20,5,7,10,11,13,14,26,32,18,42,22,23,24,29,16,33,45,39,41,43,44],secondari:[35,11,18,3,20,25,27,40,36,32,22],ssl:[35,20,40,27],cannot:[22,18,20,15,25,36,43,38,11],shiftrightunsign:[28,15,38,10],geo:18,gen:39,nolock:[20,11],doabl:0,test_n:11,seldom:20,intermitt:[20,36],yield:[20,18,11,42,14],isarrai:2,caboos:[],nettl:[],where:[34,0,2,11,14,3,24,20,18,25,5,35,7,42,43,44,32,36],tnew:[],desced:22,wiki:43,khwang:[],jbrumwel:20,testcas:20,fireandforget:35,concern:[35,20,18,32,11],infinit:[20,15,38],detect:[3,20],heckmann:20,fs_chunk:44,integration_tests_2:11,wayt:18,enough:22,between:[35,11,18,20,39,16,40,36,43,9,32,22],"import":[43,44,36],across:[35,36,18,20,16,11],elbert3:20,spars:[7,11,18],simple_queri:18,august:[13,39],parent:40,tut:13,test_group:18,maxmessagesizebyt:20,let:[35,8,11,18,20,5,36,43,44,22],come:[24,38,15,22,18],simple_find_and_modify_operations_:18,region:18,gwt:[38,15],tour:35,tutori:[13,30,44],mani:[43,22,36],fromnumb:[28,15,38,10],among:[25,36],reindex:[29,20,11,10,18],iscap:[20,29,10,18],period:[0,42],dispatch:43,createcreateindexcommand:20,fs_file:44,lessthan:[28,15,38,10],colon:35,constant:[34,2,11,5,28,29,10,22],reaperinterv:[20,16],cursor_information_collect:11,cursorinst:22,coupl:[43,18],aciev:0,rebuilt:[11,18],addit:[0,2,22,18,38,15,26,40,44,9,32,11],derefer:[29,20,11,10],sslcert:[40,27],emphas:36,lowbit:[38,15],thousand:35,"1mb":44,those:[38,15],"case":[22,18,38,15,7,43,44,20],myself:43,bson_seri:20,tostr:[8,33,18,38,15,5,28,23,44,10],trick:[13,44],invok:44,isconnect:20,firstext:26,simple_sort_collect:22,trello:[13,39],advantag:43,eras:[24,42],dynamicgui:[],ascii:[3,20,16],acess:11,develop:[13,39,36,43,35],test_streaming_function_with_limit_for_fetching_3:[],author:[0,18,36,24,14],media:[],same:[0,8,22,23,20,15,5,35,7,18,38,11],binari:[0,8,20,5,2,10,11,13,14,26,32,18,42,22,23,24,28,16,36,34,33,41,43],html:13,document:[0,2,3,20,5,7,8,11,13,14,26,32,42,22,18,24,16,36,39,41,43,44],howtonod:13,createpk:16,exhaust:[20,22,18],ifram:[30,39,19],finish:[35,11,18,5,44,32],closest:[38,15,18],utf8:[8,3,20,5,43,16],nest:[0,7],oid:21,driver:[0,1,36,14,3,13,20,39,42,35,29,40,43,44,16,10,45],my_f:5,capabl:39,newobjectid:23,improv:[13,1,20,36],extern:[13,20],defo:0,bson_data_boolean:2,sslvalid:[40,27],appropri:39,moder:39,distancemultipli:18,brightcov:39,jbottigliero:20,without:[35,36,20,15,38,42,16,11],model:[39,18],dereferenc:11,upsert:[35,18,32,14],ourexamplefiletowrit:5,execut:[35,33,26,11,14,20,18,5,36,43,32,22],when:[0,39,2,22,14,3,24,20,18,5,35,41,42,8,40,43,44,16,36],fengmk2:20,rest:[20,18,23],speed:20,hint:[22,18],db_connector:[42,16],except:[35,36,14,20,25,5,43],littl:43,desktop:13,identif:20,framebord:[30,39,19],bigger:36,default_chunk_s:[5,33],haystack:18,found2:5,around:[13,20,43],read:[1,8,3,20,5,10,11,13,40,22,18,24,25,27,28,29,32,34,35,36,43,44],grid:[34,13,33,20,29,44,10],pop:43,world:[8,33,18,14,5,44,11],lasterror:[29,20,11,10],reap:20,mod:[0,38,15],saniti:20,poolsiz:[35,18,20,27,43,16],realtim:[13,39],integ:[0,2,23,38,15,43,20],server:[1,8,3,20,5,9,11,13,14,26,32,18,40,22,23,27,29,16,36,35,33,39,41,42,43],either:[35,36,24,20,27,44,40],output:[0,18],greaterthanorequ:[28,15,38,10],manag:[24,20,43],kvalheim:39,trampolin:20,bson_binary_subtype_byte_arrai:[34,2],eventloop:44,ascend:[0,22,7],intact:14,setnodelai:20,slice:43,writedata:44,node_ev:20,confirm:43,definit:13,legal:18,shouldstreamdocumentswithpauseandresumeforfetch:[],evolv:43,profilinginfo:[26,29,10],bson_data_binari:2,power:[39,36],broken:20,aquir:11,bson_binary_subtype_default:[34,20,2],regexp:[43,20,2],"throw":[36,14,20,25,43,44,16,11],comparison:23,deflat:36,pointer_to_collect:0,firstnam:[0,7],nocooki:[30,39,19],side:11,bson_data_code_w_scop:2,gump:18,act:44,luck:44,other:[0,1,39,36,13,3,20,15,25,5,35,18,43,44,38,45],readstream:[13,8,22,20,29,10],addus:[29,20,26,11,10],test_collections_info:11,strip:35,your:[35,36,18,3,39,5,43,44],loc:18,log:[0,26,11,18,24,20,14,42,27,35,40,36,43,44,16,22],hex:[0,23],overwrit:[42,26,5,27],dropdup:[20,11,18],strict:[20,11,42,16],interfac:[35,8,22,20,41,43,33],low:[43,38,15,44],lot:[13,22,18,20,7,41,43,44],isvid:39,tupl:7,shamelessli:43,replsetsrv:3,longer:[20,5],pull:[43,20,26],dirti:43,possibl:[0,11,14,20,18,35,7,43],"default":[0,1,2,3,20,5,7,9,11,13,14,18,32,40,22,23,24,25,26,27,16,33,34,35,36,42,43,44],remove_subset_of_documents_saf:18,dropdatabas:[29,20,11,10,16],auto_reconnect:[35,43,11,27,16],connect:[1,8,3,20,5,9,10,11,13,26,32,40,22,18,27,29,30,16,36,35,33,45,41,43,44],gone:[33,18,5,11],creat:[0,2,3,20,5,7,8,11,26,32,18,42,22,23,24,16,36,35,33,39,41,43,44],certain:[7,20,43],watcher:[],intro:43,file:[8,36,24,20,5,33,44,11],bob:[36,18],russel:39,calculateobjects:[28,2,10],again:[20,36,5,22],kaba:[],compel:39,event:[8,11,24,20,5,16,41,40,43,44,32,36],field:[0,39,22,14,20,18,5,35,7,36,43,32,11],valid:[2,11,18,20,23,26,27,42,40,22],longlib:15,you:[0,2,22,14,3,24,20,18,42,27,35,7,39,40,36,43,44,16,11],geonear:[20,29,10,18],scttnlsn:[],pefrom:18,sequenc:20,symbol:[13,2,37,20,28,43,10],briefli:39,opt_radix:[38,15],pool:[35,36,20,27,16,11],reduc:[35,36,18,38,15,20],lessthanorequ:[28,15,38,10],coreh:[],directori:20,descript:[34,11,2,5,22],tricki:43,potenti:20,alright:43,cpu:[20,44],unset:43,represent:[12,34,39,33,23,4,15,25,5,6,35,17,37,38,21],all:[0,26,2,22,13,3,24,20,14,25,5,16,7,42,18,36,35,43,44,32,11],forget:43,numberupd:18,dollar:42,month:39,suno:20,cceac:[],follow:[0,22,14,3,5,7,36,43,44,11],disk:[35,8,36,18,5,44,22],nodej:[39,19],rewrot:20,subtype_default:34,nextobject:[0,22,20,29,10,11],aaron:20,introduc:[35,20,39],namesonli:11,setprofilinglevel:[26,29,10],evaul:11,util:[20,36],candid:[25,36],test_rename_collect:18,fall:35,veri:[13,36,35,20,43,44],base698:[],list:[35,11,18,20,26,5,42,29,43,44,9,40,10],resav:18,adjust:[13,1,44,20,35],"__executequerycommand":20,default_port:16,small:[35,20,44,30],retun:[],locahost:[8,11,18,26,5,41,33,22],integration_tests2:32,cursorstream:[29,13,41,22,10],design:[13,39],pass:[35,2,22,23,3,20,18,5,42,43,44,16,11],simialar:20,further:35,excit:39,deleg:16,abc:[0,5,14],xor:[28,15,38,10],sub:[34,39,18],sum:[38,15],abl:[20,36],brief:30,delet:[11,18,24,20,5,29,43,44,16,10,33],version:[35,11,18,20,16,44,32],cruso:0,method:[0,1,26,33,22,13,20,23,5,16,45,42,18,36,35,43,44,32,11],contrast:35,full:[20,11,18],themselv:20,variat:43,behaviour:[],shouldn:20,foobar2:5,foobar3:5,strong:30,modifi:[43,20,18,14],valu:[0,2,20,5,7,10,11,14,15,26,17,18,42,22,23,24,28,16,34,35,36,37,38,39,43,44],search:[13,43,18],ahead:[43,44,18],showdiskloc:[20,22,18],reason:[35,5,27],subtype_uuid_old:34,replicaset_mongo_client_collect:[35,32],amount:[43,38,15],base:[18,24,20,23,5,43,44],noopen:20,action:13,mongoos:[13,30,39],narrow:18,evalfunct:2,via:43,shorthand:14,lazybum:[],c_1:18,deprec:[20,18,32,11],href:11,default_root_collect:[5,33],establish:[33,8,11,18,20,26,5,41,36,22],select:[35,36,18,20,14,25,40,42,16],test_collection_is_cap:18,distinct:[20,29,10,18],regist:5,two:[0,15,11,23,3,13,38,14,5,7,39,24,43,44,42,36],coverag:20,bson_binary_subtype_user_defin:[34,2],taken:43,minor:[13,1,20,36],more:[0,8,22,14,3,41,20,15,5,35,39,18,36,43,44,38,11],flag:[22,18],stick:43,particular:43,cach:2,none:[3,35,20,39,40],outlin:[35,44,36,43],dev:[],histori:11,remain:[44,5],learn:[13,39],scan:[22,18],dodebug:16,share:[20,39,32,16,11],shard:[35,36,18,24,32,22],accept:[20,18],simple_document_insert_collection_no_saf:18,default_url:11,doc_end:[],learnboost:39,robinson:0,cours:43,newlin:5,divid:[35,38,15,11,18],rather:18,keepgoingexampl:18,hugh:39,simpl:[0,33,8,22,13,20,18,5,35,7,45,41,42,36,43,44,32,11],perman:11,griddata:36,resourc:16,resultset:43,reflect:20,test_streaming_function_with_limit_for_fetching_2:[],unlink:[29,24,44,5,10],associ:[44,5],keyorlist:22,"_handleonfullsetup":[40,29],github:[43,20,19],defineproperti:20,save_a_simple_document_modify_it_and_resave_it:18,caus:[43,20],callback:[0,26,22,14,24,20,18,5,16,7,42,33,43,44,32,11],spheric:18,doc_id:0,help:20,bson_data_oid:2,trade:44,through:[36,20,39,5,43,11],reconnect:[35,20,27,40,43,9,16],paramet:[0,26,22,14,3,24,20,18,5,16,7,42,33,43,44,32,11],style:[43,20,39],mongorepli:20,world_no_saf:18,batchsizevalu:22,asbuff:2,relev:[35,43],stylu:19,rapidli:43,bypass:43,outcollect:18,simple_limit_skip_queri:18,test_cursorstream_resum:41,might:[35,11,7,43,44,36],alter:[0,42],port1:35,good:[13,44,36,43,18],"return":[0,8,4,5,6,2,11,12,14,15,26,32,17,18,20,21,22,23,24,25,16,33,34,35,36,37,38,41,42,43,44],timestamp:[13,2,18,20,23,28,38,10],more_complex_index_test:[11,18],framework:[13,1,36,18],compound:[11,18],karaco:[],readlen:5,portn:35,emerleit:[],uploadd:24,unlik:[25,22,36],authent:[35,11,20,26,29,32,10,36],easili:[20,15,38],achiev:0,skipvalu:22,portx:35,found:[0,11,18,20,14,5,35],front:35,truncat:[20,44,5,42],bad_field_select:[],hard:43,realli:43,expect:[0,16],http:[13,11,35,20,39,19,43,30],orient:13,doc_start:[],primari:[0,11,18,3,20,25,27,16,40,36,35,43,32,22],b4ajeu13u6u:30,health:20,print:16,read_primari:[20,22],pullal:43,foreground:[11,18],core2duo:20,proxi:[35,20,9,11,36],advanc:[13,45,42,5,43,44],get_mor:22,differ:[13,11,23,20,15,5,35,7,18,33,43,44,38,36],asc:[0,22,14],"_enableha":[40,29],croucher:39,connectionopt:11,put:[34,22,18,20,5,28,29,44,10,33],gotend:5,seconddb:11,gethighbit:[28,15,38,10],test_streaming_function_with_limit_for_fetch:[],tailabl:[20,22,18],omit:[43,20,44,21],dir:[43,44,36,14],assign:[3,20,27],shard_test:11,major:[35,18,32,11],notifi:[43,44],articl:[13,44,45],lastnam:[0,7],number:[0,2,20,5,7,9,11,15,26,32,17,18,40,22,23,27,16,36,34,35,33,38,43,44],asiletto:20,done:[0,8,36,18,24,20,14,35,41,43,44,16],construct:[38,15],autoclos:[24,44,8,5],create_and_drop_an_index:[11,18],miss:[35,20],pageview:[36,18],script:[24,20,39],interact:[43,44,5,33],least:[0,36,18],custompkfactori:16,contra:20,statement:[43,44,11],illeg:[33,20,26,11,18],master:[3,20],store:[35,2,11,24,20,5,33,43,44,22],schema:[13,39],otherid:23,option:[0,1,2,3,4,5,7,9,10,11,13,14,26,32,20,21,22,18,24,27,29,16,34,35,33,40,41,42,43,44],reseterrorhistori:[29,11,10],similarli:43,native_pars:[35,32,16,11],part:[35,23,20,26,43,30],pars:[20,2,18],fileid2:5,literarili:43,std:20,kind:44,bson_data_nul:2,whenev:[11,18],createwritestream:[5,36],remov:[26,11,14,20,18,5,7,29,43,42,10],onal:20,reus:[20,2,11],str:[38,15],consumpt:44,toward:39,cleaner:[],comput:13,luckili:[43,44],packag:[],expir:[11,18],"null":[0,2,22,18,3,20,26,5,27,16,42,41,40,33,35,9,32,11],built:43,equival:[43,18],valueof:[28,17,10,37],fromcollect:11,also:[0,22,14,13,20,5,35,7,42,43,44,16,36],build:[26,11,20,39,43,44],shouldstream10kdocu:[],tool:39,pipelin:[36,18],distribut:36,lubow:39,blackboard:[13,19],filesystem:24,reach:[44,8],most:[0,44,39,36,43],plai:39,plan:44,selector:[20,18,22,11],"16mb":24,clear:20,getter:5,clean:[20,11],frombit:[28,15,38,10],ridicul:[],brightcoveexperi:39,session:39,find:[0,8,22,14,24,20,18,26,35,7,41,29,36,43,10,11],firewal:20,nosql:13,pretti:[35,43],jacobbubu:20,manipul:18,test_gs_weird_bug:5,numberofdocu:2,queu:[],batch_document_insert_collection_saf:18,hit:[11,18],unus:20,express:[0,36,13,18,24,19,43],fieldtoupd:43,barrier:20,nativ:[43,20,16],ferret:[],restart:[41,8],assignreplicaset:[29,27],singapor:[20,36],statist:[35,11,18,20,26,40,32],wrote:43,certif:[20,40,27],set:[0,2,3,20,5,7,11,14,26,32,42,22,18,24,27,16,35,36,39,40,43,44],jade:19,getmor:[20,22,18],see:[0,11,14,24,38,15,16,7,42,43,44,32,36],arg:20,close:[35,33,8,22,18,24,20,26,5,16,41,29,36,43,44,32,10,11],andrewjston:20,lee:20,misalign:20,jenkin:11,someth:[5,16],particip:40,some_databas:16,mismatch:20,altern:[11,18],signatur:[5,22],primary_pref:[35,36,18,25,27,40,32,11],numer:35,complement:[38,15],javascript:[2,11,18,38,15,39,43,20],salzman:20,succeed:7,both:[20,25,36,18],last:[24,11,43,35],create_and_drop_all_index:11,beginn:13,context:[20,39,16],pdf:36,corrupt:[20,26],whole:[36,18,26,5,43,11],createdat:22,load:[0,20],simpli:[0,36],jsmode:18,point:[22,18,38,15,43,44,20],instanti:[43,20],param:39,shutdown:20,suppli:[20,44],averag:36,backend:43,blog:[0,42,13],faithfulli:[38,15],user_id:18,due:[35,20,11,43,33],empti:[35,22,0,20,18,5],otherwis:[33,26,2,22,18,20,15,25,5,38,36,43,44,32,11],bgcolor:39,txt:5,strategi:[35,20,36,43,40],wish:[34,2,11,18,20,26,5,27,43,44,40],fire:[8,11,14,24,5,43,44,16],admindb:[26,11],imag:[24,44],understand:43,func:18,convers:[43,18],look:[22,18,24,20,39,5,7,43,44],mdoq:[],straight:[43,44],batch:[43,20,22,18],"while":[0,11,18,24,20,26,5,36,32,22],getownpropertynam:20,abov:[35,44,36,43,14],error:[0,8,20,5,7,11,14,26,32,42,22,18,24,25,27,16,36,35,33,40,41,43],fun:[44,36,18],fixtur:[],loos:43,loop:20,real:[13,39],test_gs_unlink:5,readi:[41,8,5,43,36],key2:0,key1:0,"_state":11,jpg:5,itself:[13,22,35],test_deref_exampl:11,inheritreplsetoptionsfrom:[29,27],rid:20,simple_key_based_distinct_sub_query_filt:18,createexperi:39,decor:20,gs2:5,minim:35,geohaystacksearch:[20,29,10,18],coffeescript:[13,30],decod:[32,11],p_db:[3,11],conflict:35,higher:[11,18,3,20,27,40,44,16,36],"10gen":[13,35],optim:[20,18],simple_key_based_distinct:18,more_complex_ensure_index_test:[11,18],piec:[43,38,15,44],temporari:[5,18],user:[34,0,2,11,14,13,20,26,5,35,7,39,33,32,36],hello2:18,stack:20,recreat:16,travers:22,task:36,entri:[44,18,5,11],joyent:39,readprefer:[13,11,18,20,25,27,35,29,40,32,36],explan:[11,18],getlowbitsunsign:[28,15,38,10],a_1:18,nagl:[3,20,16],collabor:39,shape:20,tempcollect:18,update_a_simple_document_multi:18,move:[24,20,5,43,36],password:[35,11,20,26,27,40,32],cur:44,colladow:[],tdegrunt:[],keeptemp:18,appli:[35,22,0,20,18,43,11],sessionstorag:[],input:[38,15,18],subsequ:[11,18],bin:[],transpar:39,big:[35,20,44,27,43],checksum:5,intuit:35,shiftright:[28,15,38,10],rs_name:[3,35,20,40],simonenko:[],replsetserv:[26,8,22,23,3,20,18,5,41,33,32,11],like:[0,39,11,18,38,15,35,7,44,22],fsync:[35,11,18,20,26,32],resolv:11,collect:[0,3,20,5,7,10,11,13,14,26,32,42,21,22,18,24,29,31,16,36,35,33,45,39,41,43,44],bson_data_cod:2,popular:[13,39,43],bamboo:20,brett:39,serverpair:20,often:[38,15],acknowledg:[35,18,32,11],creation:[26,11,18,20,39,43],some:[0,33,8,22,13,24,20,18,5,35,7,39,36,43,44,11],back:[0,8,22,23,20,15,5,35,18,36,43,38,26],understood:43,sampl:43,somecollect:36,scale:[13,11,18,39,43,44],slaveok:[35,20,22,18],chunksiz:[24,20,44,5],per:36,bson_data_min_kei:2,retri:[35,11,18,20,32,40,43,16,22],larg:[0,36,18,24,20,43,44,11],recogniz:35,intial:[36,18],previou:[35,20,44,16],run:[13,26,11,18,3,20,14,45,43,44,36],lublow:39,simple_reset_error_history_col:11,simpleemitt:20,simple_explain_queri:18,subtract:[28,15,38,10],k1mnspb8wvq:30,allowfullscreen:[30,39,19],recordquerystat:[35,32,11],block:[44,11,18],cygwin:20,within:[38,15],simple_index_test:18,contributor:39,chang:[13,1,36,18,20,15,35,43,44,38],test_collection_index_exist:18,sock:20,fast:[],custom:[0,36,18,20,44,16],plain:[20,18],includ:[13,39,22,0,20,18,25,5,16,7,42,36,35,43,9,32,11],suit:20,forward:5,files:[20,5],properli:[20,5],isbuff:20,uniquedoc:18,"_bsontyp":20,hainterv:[35,9,36,40],link:[13,44,45,43],translat:[],atom:[43,20,18],line:[44,5],info:[20,26,44,11,18],concaten:[38,15,5],consist:[20,36],caller:22,forceserverobjectid:[35,20,32,16,11],gridf:[13,1,36,45,24,20,5,44,33],readlin:[29,5,10],similar:[24,32,35],hash:[0,1,11,13,20,16,35,43,44,32],multiplecoll2:11,parser:[13,1,2,11,35,20,16,32,36],doesn:[0,16,14],repres:[35,11,23,38,15,5,27,17,43,37,40,22],idhex:0,unifi:[35,20],titl:[0,18,36,31,14],masylum:[],unidirect:22,nice:[43,39],deseri:[2,22,20,28,43,10,36],bcoe:[],jannehietamaki:20,mongodb:[0,8,3,20,5,7,10,11,13,14,26,32,19,18,42,22,23,24,27,30,16,33,35,36,39,41,43,44],eval:[22,18,20,29,10,11],profilinglevel:[26,29,10],sokra:20,algorithm:[3,38,20,15,16],cursorinform:11,evenli:36,tradeoff:44,awesom:[13,30,19,36],filebodi:8,far:5,hello:[8,33,18,14,5,43,44,11],code:[8,4,5,2,10,11,13,26,18,40,22,23,27,28,32,36,35,33,41,20,43,44],partial:[22,18],worldbuff:5,queri:[0,26,22,14,13,20,18,5,16,7,45,39,42,36,35,43,31,32,11],overlap:35,idvalu:0,mongoskin:[],octet:5,privat:[40,27],replicasetcheckinterv:20,base64:[3,33,20,5,16],update_a_simple_document_upsert:18,send:[35,22,18,3,20,43,16,11],lower:[11,18],io_seek_end:5,"256k":44,sens:14,reapertimeout:[20,16],sent:16,passiv:20,tailableretryinterv:[20,22,18],shouldcorrectlyforcereindexoncollect:18,result2:33,writebuff:20,untouch:16,dbname:[11,20,22,32],tri:35,magic:[],gettim:[22,23],roll:[13,20],fieldorspec:[11,18],fewer:18,"try":[43,20,18,44,14],race:20,marri:39,refer:[11,22,20,5,33,43,32,21],rack:[35,36],impli:35,smaller:[24,36],fortun:43,natur:[35,39,43],jump:[43,20,39,44],tobson:[13,1,20,36],video:[13,44],odm:[13,30],download:43,odd:[38,15],append:[24,5,43],compat:20,index:[13,2,22,18,20,7,29,36,31,42,10,11],compar:[36,23,38,15,5,7,28,10],descriptor:[24,44],highbit:[38,15],access:[35,11,18,24,26,5,37,17,22],experiment:20,can:[0,15,22,23,3,24,20,14,42,35,38,7,18,36,43,44,16,11],chose:39,primarypref:35,bson_data_int:2,simplereach:39,cursor_count_collect:22,calipso:[],logout:[29,26,11,10],filedescriptor:44,becom:43,sinc:[43,38,15,44,14],subtype_byte_arrai:34,nexttick:[20,41],convert:[0,43,23],reconnectwait:[35,40],larger:[24,20,44,11,18],technolog:39,typic:35,honor:20,configur:[35,11,18,3,20,42],read_secondari:[3,20,22],app:[3,13,20,39,35],mattinsl:[],api:[13,11,35,20,39,28,29,44,36],redi:39,cloud:13,chrisgibson:[],from:[0,2,3,20,5,11,13,14,15,26,18,42,22,23,24,25,27,32,36,34,35,33,38,39,43,44],shouldreturninstanceoferrorwithbadfieldselect:[],batchsiz:[29,18,22,10,11],doubl:[13,20,28,17,43,10],upgrad:20,next:[0,2,22,39,44,16],websit:39,chr:5,latenc:[35,36,40],simpler:[43,20,22,18],sort:[0,22,14,20,23,29,7,18,10],acknowleg:[18,32,11],src:[30,39,19],detail:[35,7,22,24],repl_set:20,benchmark:20,name2:0,actual:[0,44,11,43,16],socketopt:[35,3,20,27,40,9,16],doc_lin:[],sollect:42,account:18,retriev:[0,26,11,14,24,20,18,5,43,44,22],scalabl:24,multiple_db_inst:11,annot:44,tag:[35,36,18,20,25,32,11],thin:[],fetch:[0,11,22,18,7,43,33],queryfailur:20,control:[43,20,44,16,36],objectid:[0,26,8,22,23,13,20,18,5,16,41,28,2,44,33,35,43,11,32,10,21],process:[13,36,35,20,15,41,11,38,22],lock:[20,44,11],username_:7,high:[13,1,11,18,20,15,35,40,43,9,38,36],unopen:20,serial:[35,2,11,18,20,28,32,10,36],numbit:[38,15],readprefr:35,pingresult:26,integration_test_:[3,35,32,11],instead:[0,11,18,3,20,16,7,35,44,32],nasti:20,npm:[43,20],pois:39,overridden:35,await:11,formattedorderclaus:20,awaitdata:[20,22,18],test_map_reduce_functions_scop:18,alloc:[20,2,11],bind:[],remove_all_documents_no_saf:18,correspond:[7,38,15,42],element:[0,5,43,22],"_db":[],chief:39,writ:5,allow:[35,11,18,20,26,5,41,42,36,43,44,16,22],subtyp:34,fallback:[35,20],deoptim:20,doc2:43,doc3:43,opencal:20,applyskiplimit:[20,22],alexeypetrushin:[],doc4:43,spank:20,own:[20,5,27],comma:35,server_opt:16,createreadstream:36,effici:[43,44,18],numberoftest:11,bunch:[20,11,18],perfect:43,chosen:36,total:[0,36,18],crash:20,greater:[0,38,15,22],handl:[39,36,18,20,15,5,40,43,44,38,22],auto:[43,20],databs:16,dai:[13,39],auth:[20,11],renamecollect:[29,20,11,10],precess:43,numberofremoveddoc:18,writefil:[36,24,5,29,44,10],convin:0,anyth:20,edit:[44,5],npmj:[],slide:[13,39],deserializeddoc:[],exampledb:[43,44,36],subset:[22,18],unwind:[36,18],opensync:5,chunk:[33,24,20,5,44,36],bson_binary_subtype_uuid:[34,2],default_content_typ:[5,33],pushal:[43,20],our:[35,22,39,5,27,43,44],special:[35,22,38,15,43,44],out:[13,11,23,3,20,18,5,35,45,43,44,16,36],variabl:[43,20,18],calip:[],trickier:[0,43],categori:44,suitabl:44,merg:[20,18],ref:20,clone:[],test_stream_writ:36,common:20,jessica:[0,14],insid:[0,44,24,7],dropcollect:[29,42,11,10],unpars:20,releas:20,droptarget:[20,11,42,18],likelihood:35,princess:18,replsetgetstatu:[20,26,29,10],unwant:0,could:[43,20],shiftleft:[28,15,38,10],david:14,length:[34,26,11,18,24,23,5,28,44,10,22],lte:0,transfer:11,minkei:[13,20,2,28,6],evanp:[],debugmessag:20,echo:11,iszero:[28,15,38,10],should_correctly_rewind_and_restart_cursor:22,gridstore3:5,gridstore2:5,gridstore7:5,gridstore6:5,gridstore5:5,totalopen:11,prioriti:20,"_event":20,start:[34,0,2,22,13,3,20,18,5,43,44,42,36],system:[35,11,22,18,20,5,44,42,36],wrapper:20,createfromtim:[20,28,10,23],bson_data_max_kei:2,termin:5,"final":[43,20,39,18],idottv:[],deconstruct:44,test_gs_getc_fil:5,exactli:42,gridstorew:5,bson_data_object:2,replset:[13,1,11,35,3,20,27,40,29,32,36],pgebheim:20,bother:39,mongoserv:[42,16],tocollect:11,charact:[34,20,18,5,23],test_gs_puts_and_readlin:5,seriou:20,result:[0,26,8,33,22,14,15,20,23,5,16,38,18,24,35,43,44,36,32,11],"function":[0,1,2,3,4,5,8,11,13,14,15,26,32,18,20,22,23,24,27,16,33,34,35,36,38,40,41,42,43,44],counter:[16,18],terribl:20,easymongo:[],peform:[8,11,18,41,32,22],have:[0,8,22,18,3,20,39,5,27,35,7,42,36,43,44,40,11],tabl:[43,30,42],need:[0,11,14,24,20,15,42,27,35,38,7,18,40,43,44,16,36],turn:[0,11,35,20,26,9,40,36],border:30,buildinfo:[26,29,10],issu:[43,20,18],min:[20,18,22,11],rout:[],shankar0306:20,mix:[0,7],best:35,which:[0,39,3,24,20,15,5,38,42,44,16],test_other_drop:18,orgiin:5,singl:[34,0,39,11,14,24,20,18,5,27,35,32],fileid:[44,8,5],unless:20,deploy:36,who:[20,36],whi:0,discov:[20,36],serverconfig:[20,32,16,11],test_gs_working_field_read:36,why:[43,39],overwriten:5,url:[13,1,36,35,20,43,32,11],timestamplib:38,request:[20,39,22],uri:[35,32,43,11],face:43,pipe:[5,36],test_collect:14,snapshot:[22,18],"400m":39,determin:[43,22],constrain:5,streamrecord:20,fact:[43,14],medikoo:20,nailgun:20,text:[15,36,18,38,39,5,44],serializefunct:[35,2,11,18,20,32],verbos:18,subtype_user_defin:34,filebuff:8,shouldcorrectlyexecutesimpleaggregationpipelineusingargu:18,anywai:[11,18],setter:5,textual:[38,15],locat:[36,22,18,5,43,11],figur:35,should:[0,26,11,40,23,20,15,42,35,18,33,44,38,22],noid:[],test_cursorstream_paus:41,local:[11,32,21],devnul:[],cube:[],ritch:20,kiefer:39,db1:35,db2:32,donewithwrit:44,enabl:[20,16,40,36],organ:39,simple_batch_size_collect:22,stuff:[3,13,44,45,43],integr:[43,44],contain:[34,35,2,22,18,3,42,26,5,27,40,33,43,44,9,32,11],grab:[11,26,5,22],mon4mongo:[],view:[],legaci:[35,27],modulo:[0,28,15,38,10],packet:[20,22,18],meritt:[],writeconcern:18,statu:[35,36,20,26,43,9,40],wire:[43,20,22],correctli:[43,20,18],pattern:13,boundari:20,written:[34,18,38,15,5,44],crude:43,progress:20,world2:18,kei:[0,2,22,18,20,27,16,7,40,35,43,44,32,11],buckets:18,jsbon:20,isol:20,job:18,entir:[44,5,22],joe:[36,18],db_option:16,crc32:2,monitor:[],mongod:[35,20,36,27,40],plugin:39,admin:[13,39,11,18,20,26,35,29,10],mongoj:13,equal:[0,26,8,22,23,38,15,5,35,28,41,18,33,43,32,10,11],etc:[0,22,16,18],instanc:[35,26,2,33,22,23,3,20,18,5,16,36,43,44,32,11],greaterthan:[28,15,38,10],mongoq:[],uncaught:20,subtype_funct:34,comment:[20,36,22,18],toint:[28,15,38,10],walk:39,removealllisten:20,save_a_simple_docu:18,attende:39,addition:[42,36],mbostock:20,compon:20,json:[13,39,38,15,28,43,16],setimmedi:20,treat:[0,20,22],pkfactori:[35,18,32,11],immedi:14,bit:[0,2,24,38,15,43,44,20],protect:20,assert:[26,8,11,23,18,5,41,33,32,22],ador:[],present:[35,13,20,39,27,7,42,40],replic:[3,11],multi:[20,18,14],vimeo:13,align:20,cursor:[0,8,22,13,20,18,41,29,43,10,11],defin:[34,0,2,11,14,20,15,5,35,38,18,43,16],setreadprefer:[22,20,27,29,36,9,10,11],bson_data_arrai:2,observ:[],layer:[43,39,36],helper:[13,1,20,36],site:3,lightweight:[],tojson:[38,20,15,28,10],nodetut:13,getc:[29,5,10],cross:20,member:[3,35,20,36],python:13,speaker:39,inc:[43,20],gett:[],difficult:[44,36],incorrect:20,slave:[3,35],hostnam:[35,16],keepal:[35,3,20,27,40,9,16],upon:22,proxlet:39,retriv:26,student:30,test_stream_write_2:36,serializewithbufferandindex:[28,2,10],php:[13,20],chunk_siz:[24,8,5,33],off:[35,11,3,20,26,5,16,42,43,32,22],center:[36,18],nevertheless:16,builder:39,well:[0,20,44,36,43],exampl:[0,8,42,5,7,11,13,14,26,32,18,22,23,24,16,36,35,33,45,41,43,44],command:[35,11,18,20,26,5,27,16,29,43,32,10,22],simple_geo_near_command:18,choos:[35,43,36,40,18],undefin:20,latest:43,distanc:18,paus:[29,41,8,5,10],less:[43,38,15],"boolean":[35,8,22,18,24,38,15,5,27,40,7,2,42,36,44,9,32,11],additon:7,tcp:43,mojodna:20,indexinform:[22,18,20,7,29,10,11],admin14:26,admin11:26,admin10:26,admin13:26,admin12:26,episod:13,web:[13,43],rapid:[13,39],seekloc:[44,5],add:[35,26,11,18,20,15,38,7,28,43,16,10],originaldata:[33,5,36],tjanczuk:[],host2:35,host1:35,logger:[35,11,20,27,16,40],match:[0,26,36,18,14,38,15,35,43,42],branch:20,agnost:20,crud:[13,45,43],iya_logo_final_bw:5,know:42,bson_data_timestamp:2,recurs:[15,38,2,5],isclos:[29,22,10],desc:[0,22],bson_data_str:2,insert:[0,26,2,22,13,20,14,5,27,16,29,42,41,18,36,43,31,32,10,11],resid:43,backbon:39,success:[24,5,22],hostn:35,isui:39,chunkcollect:[29,5,10],necessari:[0,36],"0xff":2,async:[43,20],page:[0,39,43,13],read_preference_replicaset_test_0:11,milewis:[],linux:20,contin:[],"export":[],streameddata:5,proper:20,findon:[0,11,18,20,29,43,10],fileinfo:44,newhex:23,librari:[13,20,39,44],dc1:36,tmp:[20,5,36],leaf:[],lead:[20,15,38],aaronasachimp:20,leak:20,avoid:[7,20,43],fromint:[28,15,38,10],thank:[20,36],repliaset:20,leav:[20,14],kcbanner:[],speak:[35,39],mode:[11,18,24,20,25,5,42,36,44,16,22],encourag:35,slight:43,journal:[35,20,18,32,11],"enum":35,usag:[13,11,23,3,24,20,5,42,43,44,16,33],collection_nam:42,host:[35,16,27,43],file_id:[20,36],although:44,offset:[34,20,44,5],java:[38,15],cliftonc:[],panel:[13,39],about:[13,11,14,20,39,35,7,43,44,16,22],rare:20,socket:[13,11,35,3,20,39,27,16,19,40,43,9,32],dbinstanc:44,notequ:[28,15,38,10],constructor:[2,3,4,5,6,8,9,10,11,12,15,26,16,17,18,20,21,22,23,25,27,28,29,32,34,35,33,37,38,40,41],fals:[0,26,8,22,14,24,20,18,5,27,16,41,42,2,40,35,44,32,11],qard:[],disabl:[3,20,16,40,36],autoindexid:11,automat:[8,22,3,24,20,43,44,16],dataset:[0,43],bson:[0,1,2,4,5,6,8,10,11,12,13,14,26,16,17,18,20,21,22,23,27,28,32,33,34,35,36,37,41,42],leverag:[43,39],val:18,pictur:44,primarki:0,mykei:43,trigger:[8,11,18,20,5,41,22],concat:0,"var":[0,26,8,22,23,3,24,33,14,5,16,42,41,18,36,35,43,44,32,11],fsname:33,deliveri:39,shouldcorrectlyexecutesimpleaggregationpipelineusingarrai:18,brand:20,continu:35,waitforconnect:20,gain:20,eas:[],inlin:[20,18],bug:[20,44],count:[0,22,14,20,18,5,29,42,10,11],made:[20,39,44],wise:0,cleanup:[20,44],temp:36,whether:[38,35,20,15,36],ecosystem:39,displai:[35,39,11],asynchron:[3,43,20],record:[0,11,14,24,20,18,5,16,7,42,35,43,32],below:[13,36,35,14,38,15,43,11],lucasfilm:[20,36],limit:[0,22,18,24,20,29,43,10],"static":[],problem:20,quickli:39,myexperience1123429378001:39,evalu:[2,11],"int":[35,38,15],dure:[35,11,18,20,26,43,32],year:0,filenam:[24,20,44,5],replica:[35,11,3,20,27,43],implement:[35,36,38,15,43,20],ing:[13,39],eric:39,retrymilisecond:[35,20,32,16,11],probabl:0,tick:20,arrj:[],bartt:[],book:[0,13],bool:23,futur:[35,20,11,43],karait:[],stat:[29,20,11,10,18],rayno:20,"class":[8,4,5,6,2,9,11,12,15,26,17,18,20,21,22,23,25,27,32,33,34,35,36,37,38,39,40,41,43,44],geck:[],stai:18,experienc:39,eof:[29,24,44,5,10],rule:36,integration_test:[35,32],kaij:20,"0_gnhwzhc":30},objtypes:{"0":"js:class","1":"js:function","2":"js:attribute"},titles:["Queries","Updates","BSON()","Replicasets","Code()","GridStore()","MinKey()","Indexes","ReadStream()","Mongos()","Node.JS MongoDB Driver Manual Contents","Db()","MaxKey()","The Node.JS MongoDB Driver Manual","Inserting and updating","Long()","Database","Double()","Collection()","Awesome Node.js + MongoDB Applications","Changelog","DBRef()","Cursor()","ObjectID()","GridStore","ReadPreference()","Admin()","Server()","Binary JSON API","Driver API","Tutorials using Node.JS and MongoDB","<no title>","MongoClient()","Grid()","Binary()","MongoClient or how to connect in a new and better way","Mongo Driver and Mongo DB 2.2 Features","Symbol()","Timestamp()","Node.JS Specific Presentations","ReplSet","CursorStream()","Collections","A Basic introduction to Mongo DB","A primer for GridFS using the Mongo DB driver","Articles"],objnames:{"0":["js","class","JavaScript class"],"1":["js","function","JavaScript function"],"2":["js","attribute","JavaScript attribute"]},filenames:["markdown-docs/queries","driver-articles/index","api-bson-generated/bson","markdown-docs/replicaset","api-bson-generated/code","api-generated/gridstore","api-bson-generated/minkey","markdown-docs/indexes","api-generated/readstream","api-generated/mongos","contents","api-generated/db","api-bson-generated/maxkey","index","markdown-docs/insert","api-bson-generated/long","markdown-docs/database","api-bson-generated/double","api-generated/collection","content/awesomeappsvideo","changelog/changelog","api-bson-generated/db_ref","api-generated/cursor","api-bson-generated/objectid","markdown-docs/gridfs","api-generated/readpreference","api-generated/admin","api-generated/server","api-bson-generated/index","api-generated/index","content/tutorials","markdown-docs/index","api-generated/mongoclient","api-generated/grid","api-bson-generated/binary","driver-articles/mongoclient","driver-articles/anintroductionto1_1and2_2","api-bson-generated/symbol","api-bson-generated/timestamp","content/nodejsvideo","api-generated/replset","api-generated/cursorstream","markdown-docs/collections","api-articles/nodekoarticle1","api-articles/nodekoarticle2","api-articles/index"]}) \ No newline at end of file diff --git a/test/admin_test.js b/test/admin_test.js deleted file mode 100644 index b02387f26a7..00000000000 --- a/test/admin_test.js +++ /dev/null @@ -1,698 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); - -/*! - * Module dependencies. - */ -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.shouldCorrectlyCallValidateCollection = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - fs_client.dropDatabase(function(err, done) { - fs_client.collection('test', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, doc) { - fs_client.admin(function(err, adminDb) { - adminDb.addUser('admin', 'admin', function(err, result) { - adminDb.authenticate('admin', 'admin', function(err, replies) { - adminDb.validateCollection('test', function(err, doc) { - // Pre 1.9.1 servers - if(doc.result != null) { - test.ok(doc.result != null); - test.ok(doc.result.match(/firstExtent/) != null); - } else { - test.ok(doc.firstExtent != null); - } - - fs_client.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * Authenticate against MongoDB Admin user - * - * @_class admin - * @_function authenticate - * @ignore - */ -exports.shouldCorrectlyAuthenticate = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Grab a collection object - db.collection('test', function(err, collection) { - - // Force the creation of the collection by inserting a document - // Collections are not created until the first document is inserted - collection.insert({'a':1}, {safe:true}, function(err, doc) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * Example showing how to access the Admin database for admin level operations. - * - * @_class db - * @_function admin - * @ignore - */ -exports.shouldCorrectlyAuthenticate = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); -} - -/** - * Retrieve the buildInfo for the current MongoDB instance - * - * @_class admin - * @_function buildInfo - * @ignore - */ -exports.shouldCorrectlyAuthenticate = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - // Retrive the build information for the MongoDB instance - adminDb.buildInfo(function(err, info) { - test.ok(err == null); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the buildInfo using the command function - * - * @_class admin - * @_function command - * @ignore - */ -exports.shouldCorrectlyAuthenticate = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - // Retrive the build information using the admin command - adminDb.command({buildInfo:1}, function(err, info) { - test.ok(err == null); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the current profiling level set for the MongoDB instance - * - * @_class admin - * @_function profilingLevel - * @ignore - */ -exports.shouldCorrectlySetDefaultProfilingLevel = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Grab a collection object - db.collection('test', function(err, collection) { - - // Force the creation of the collection by inserting a document - // Collections are not created until the first document is inserted - collection.insert({'a':1}, {safe:true}, function(err, doc) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, replies) { - - // Retrive the profiling level - adminDb.profilingLevel(function(err, level) { - test.equal("off", level); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * An example of how to use the setProfilingInfo - * Use this command to set the Profiling level on the MongoDB server - * - * @_class admin - * @_function setProfilingLevel - */ -exports.shouldCorrectlyChangeProfilingLevel = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Grab a collection object - db.collection('test', function(err, collection) { - - // Force the creation of the collection by inserting a document - // Collections are not created until the first document is inserted - collection.insert({'a':1}, {safe:true}, function(err, doc) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, replies) { - - // Set the profiling level to only profile slow queries - adminDb.setProfilingLevel('slow_only', function(err, level) { - - // Retrive the profiling level and verify that it's set to slow_only - adminDb.profilingLevel(function(err, level) { - test.equal('slow_only', level); - - // Turn profiling off - adminDb.setProfilingLevel('off', function(err, level) { - - // Retrive the profiling level and verify that it's set to off - adminDb.profilingLevel(function(err, level) { - test.equal('off', level); - - // Set the profiling level to log all queries - adminDb.setProfilingLevel('all', function(err, level) { - - // Retrive the profiling level and verify that it's set to all - adminDb.profilingLevel(function(err, level) { - test.equal('all', level); - - // Attempt to set an illegal profiling level - adminDb.setProfilingLevel('medium', function(err, level) { - test.ok(err instanceof Error); - test.equal("Error: illegal profiling level value medium", err.message); - - db.close(); - test.done(); - }); - }) - }); - }) - }); - }) - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * An example of how to use the profilingInfo - * Use this command to pull back the profiling information currently set for Mongodb - * - * @_class admin - * @_function profilingInfo - */ -exports.shouldCorrectlySetAndExtractProfilingInfo = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Grab a collection object - db.collection('test', function(err, collection) { - - // Force the creation of the collection by inserting a document - // Collections are not created until the first document is inserted - collection.insert({'a':1}, {safe:true}, function(doc) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, replies) { - - // Set the profiling level to all - adminDb.setProfilingLevel('all', function(err, level) { - - // Execute a query command - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - - // Turn off profiling - adminDb.setProfilingLevel('off', function(err, level) { - - // Retrive the profiling information - adminDb.profilingInfo(function(err, infos) { - test.ok(infos.constructor == Array); - test.ok(infos.length >= 1); - test.ok(infos[0].ts.constructor == Date); - test.ok(infos[0].millis.constructor == Number); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * An example of how to use the validateCollection command - * Use this command to check that a collection is valid (not corrupt) and to get various statistics. - * - * @_class admin - * @_function validateCollection - */ -exports.shouldCorrectlyCallValidateCollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Grab a collection object - db.collection('test', function(err, collection) { - - // Force the creation of the collection by inserting a document - // Collections are not created until the first document is inserted - collection.insert({'a':1}, {safe:true}, function(err, doc) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, replies) { - - // Validate the 'test' collection - adminDb.validateCollection('test', function(err, doc) { - - // Pre 1.9.1 servers - if(doc.result != null) { - test.ok(doc.result != null); - test.ok(doc.result.match(/firstExtent/) != null); - } else { - test.ok(doc.firstExtent != null); - } - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * An example of how to add a user to the admin database - * - * @_class admin - * @_function ping - */ -exports.shouldCorrectlyPingTheMongoDbInstance = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - // Ping the server - adminDb.ping(function(err, pingResult) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * An example of how add a user, authenticate and logout - * - * @_class admin - * @_function logout - */ -exports.shouldCorrectlyUseLogoutFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - // Logout the user - adminDb.logout(function(err, result) { - test.equal(true, result); - - db.close(); - test.done(); - }) - }); - }); - }); - }); - }); -} - - -/** - * An example of how to add a user to the admin database - * - * @_class admin - * @_function addUser - */ -exports.shouldCorrectlyAddAUserToAdminDb = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * An example of how to remove a user from the admin database - * - * @_class admin - * @_function removeUser - */ -exports.shouldCorrectlyAddAUserAndRemoveItFromAdminDb = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Drop the current database if it exists to avoid problems - db.dropDatabase(function(err, done) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // Add the new user to the admin database - adminDb.addUser('admin', 'admin', function(err, result) { - - // Authenticate using the newly added user - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(result); - - // Remove the user - adminDb.removeUser('admin', function(err, result) { - - // Authenticate using the removed user should fail - adminDb.authenticate('admin', 'admin', function(err, result) { - test.ok(err != null); - test.ok(!result); - - db.close(); - test.done(); - }); - }) - }); - }); - }); - }); - }); -} - -/** - * An example of listing all available databases. - * - * @_class admin - * @_function listDatabases - */ -exports.shouldCorrectlyListAllAvailableDatabases = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Use the admin database for the operation - db.admin(function(err, adminDb) { - - // List all the available databases - adminDb.listDatabases(function(err, dbs) { - test.equal(null, err); - test.ok(dbs.databases.length > 0); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/authentication_test.js b/test/authentication_test.js deleted file mode 100644 index 9605dcd257c..00000000000 --- a/test/authentication_test.js +++ /dev/null @@ -1,171 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * Test the authentication method for the user - * - * @ignore - */ -exports.shouldCorrectlyAuthenticate = function(test) { - var user_name = 'spongebob'; - var password = 'squarepants'; - - client.authenticate('admin', 'admin', function(err, replies) { - test.ok(err instanceof Error); - test.ok(!replies); - - // Add a user - client.addUser(user_name, password, function(err, result) { - client.authenticate(user_name, password, function(err, replies) { - test.ok(!(err instanceof Error)); - test.ok(replies); - test.done(); - }); - }); - }); -} - -/** - * Test the authentication method for the user - * - * @ignore - */ -exports.shouldCorrectlyReAuthorizeReconnectedConnections = function(test) { - var user_name = 'spongebob2'; - var password = 'password'; - - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize:3, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, automatic_connect_client) { - p_client.authenticate('admin', 'admin', function(err, replies) { - test.ok(err instanceof Error); - // Add a user - p_client.addUser(user_name, password, function(err, result) { - // Execute authentication - p_client.authenticate(user_name, password, function(err, replies) { - test.ok(err == null); - - // Kill a connection to force a reconnect - p_client.serverConfig.close(); - - p_client.createCollection('shouldCorrectlyReAuthorizeReconnectedConnections', function(err, collection) { - collection.insert({a:1}, {safe:true}, function(err, r) { - collection.insert({a:2}, {safe:true}, function(err, r) { - collection.insert({a:3}, {safe:true}, function(err, r) { - collection.count(function(err, count) { - test.equal(3, count); - p_client.close(); - test.done(); - }) - }) - }) - }) - }); - }); - }); - }); - }); -} - -exports.shouldCorrectlyAddAndRemoveUser = function(test) { - var user_name = 'spongebob2'; - var password = 'password'; - - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, automatic_connect_client) { - p_client.authenticate('admin', 'admin', function(err, replies) { - test.ok(err instanceof Error); - - // Add a user - p_client.addUser(user_name, password, function(err, result) { - p_client.authenticate(user_name, password, function(err, replies) { - test.ok(replies); - - // Remove the user and try to authenticate again - p_client.removeUser(user_name, function(err, result) { - p_client.authenticate(user_name, password, function(err, replies) { - test.ok(err instanceof Error); - - test.done(); - p_client.close(); - }); - }); - }); - }); - }); - }); -} - -// run this last -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/auxilliary/authentication_test.js b/test/auxilliary/authentication_test.js deleted file mode 100644 index 3d0c6a978d7..00000000000 --- a/test/auxilliary/authentication_test.js +++ /dev/null @@ -1,216 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server, - ServerManager = require('../../test/tools/server_manager').ServerManager, - Step = require("step"); - -var MONGODB = 'integration_tests'; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 1}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var serverManager = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - serverManager.killAll(function(err, result) { - callback(); - }); -} - -exports.shouldCorrectlyAuthenticate = function(test) { - var db1 = new Db('mongo-ruby-test-auth1', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - var db2 = new Db('mongo-ruby-test-auth2', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - var admin = new Db('admin', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - - Step( - function bootTheServerWithNoAuth() { - serverManager = new ServerManager({auth:false, purgedirectories:true}) - serverManager.start(true, this); - }, - - function openDbs() { - db1.open(this.parallel()); - db2.open(this.parallel()); - admin.open(this.parallel()); - }, - - function addAdminUserToDatabase(err, db1, db2, admin) { - test.equal(null, err); - admin.addUser('admin', 'admin', this); - }, - - function restartServerInAuthMode(err, result) { - test.equal(null, err); - test.equal('7c67ef13bbd4cae106d959320af3f704', result.shift().pwd); - - db1.close(); - db2.close(); - admin.close(); - - serverManager = new ServerManager({auth:true, purgedirectories:false}) - serverManager.start(true, this); - }, - - function openDbs() { - db1.open(this.parallel()); - db2.open(this.parallel()); - admin.open(this.parallel()); - }, - - function authenticateAdminUser(err) { - test.equal(null, err); - - admin.authenticate('admin', 'admin', this.parallel()); - db1.admin().authenticate('admin', 'admin', this.parallel()); - db2.admin().authenticate('admin', 'admin', this.parallel()); - }, - - function addDbUsersForAuthentication(err, result1, result2, result3) { - test.equal(null, err); - test.ok(result1); - test.ok(result2); - test.ok(result3); - - db1.addUser('user1', 'secret', this.parallel()); - db2.addUser('user2', 'secret', this.parallel()); - }, - - function closeAdminConnection(err, result1, result2) { - test.ok(err == null); - test.ok(result1 != null); - test.ok(result2 != null); - admin.logout(this.parallel()); - db1.admin().logout(this.parallel()); - db2.admin().logout(this.parallel()); - }, - - function failAuthenticationWithDbs(err, result) { - var self = this; - - db1.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - - db2.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - }, - - function authenticateAgainstDbs(err, result) { - test.ok(err != null); - - db1.authenticate('user1', 'secret', this.parallel()); - db2.authenticate('user2', 'secret', this.parallel()); - }, - - function correctlyInsertRowToDbs(err, result1, result2) { - var self = this; - test.ok(err == null); - test.ok(result1); - test.ok(result2); - - db1.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - - db2.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - }, - - function validateCorrectInsertsAndBounceServer(err, result1, result2) { - test.ok(err == null); - test.ok(result1 != null); - test.ok(result2 != null); - - serverManager = new ServerManager({auth:true, purgedirectories:false}) - serverManager.start(true, this); - }, - - function reconnectAndVerifyThatAuthIsAutomaticallyApplied() { - var self = this; - db1.collection('stuff', function(err, collection) { - - collection.find({}).toArray(function(err, items) { - test.ok(err == null); - test.equal(1, items.length); - - db1.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - - db2.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - }) - }); - }, - - function logoutDb1(err, result1, result2) { - test.ok(err == null); - test.ok(result1 != null); - test.ok(result2 != null); - - db1.logout(this); - }, - - function insertShouldFail(err, result) { - var self = this; - db1.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, self.parallel()); - }); - }, - - function logoutDb2(err, result) { - test.ok(err != null); - db2.logout(this); - }, - - function insertShouldFail(err, result) { - var self = this; - db2.collection('stuff', function(err, collection) { - collection.insert({a:2}, {safe:true}, function(err, result) { - test.ok(err != null); - test.done(); - // Close all connections - db1.close(); - db2.close(); - admin.close(); - }); - }); - } - ) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/auxilliary/repl_set_ssl_test.js b/test/auxilliary/repl_set_ssl_test.js deleted file mode 100644 index f8bae8d824c..00000000000 --- a/test/auxilliary/repl_set_ssl_test.js +++ /dev/null @@ -1,80 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server, - ReplSetServers = mongodb.ReplSetServers, - ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager, - Step = require("step"); - -var MONGODB = 'integration_tests'; -var serverManager = null; -var RS = RS == null ? null : RS; -var ssl = true; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - RS = new ReplicaSetManager({retries:120, - ssl:ssl, - arbiter_count:1, - secondary_count:1, - passive_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - RS.restartKilledNodes(function(err, result) { - callback(); - }); -} - -exports.shouldCorrectlyConncetToSSLBasedReplicaset = function(test) { - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - ], - {rs_name:RS.name, ssl:ssl} - ); - - // Connect to the replicaset - var slaveDb = null; - var db = new Db('foo', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - test.equal(null, err); - test.done(); - p_db.close(); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/auxilliary/replicaset_auth_test.js b/test/auxilliary/replicaset_auth_test.js deleted file mode 100644 index e15f5d14b7d..00000000000 --- a/test/auxilliary/replicaset_auth_test.js +++ /dev/null @@ -1,242 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server, - ReplSetServers = mongodb.ReplSetServers, - ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager, - Step = require("step"); - -var MONGODB = 'integration_tests'; -var serverManager = null; -var RS = RS == null ? null : RS; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - RS = new ReplicaSetManager({retries:120, - auth:true, - arbiter_count:0, - secondary_count:1, - passive_count:0}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -exports.shouldCorrectlyAuthenticateWithMultipleLoginsAndLogouts = function(test) { - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - ], - {rs_name:RS.name} - ); - - // Connect to the replicaset - var slaveDb = null; - var db = new Db('foo', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - Step( - function addUser() { - db.admin().addUser("me", "secret", this); - }, - - function ensureFailingInsert(err, result) { - // return - var self = this; - test.equal(null, err); - test.ok(result != null); - - db.collection("stuff", function(err, collection) { - collection.insert({a:2}, {safe: {w: 3}}, self); - }); - }, - - function authenticate(err, result) { - test.ok(err != null); - - db.admin().authenticate("me", "secret", this); - }, - - function changePassword(err, result) { - var self = this; - test.equal(null, err); - test.ok(result); - - db.admin().addUser("me", "secret2", this); - }, - - function authenticate(err, result) { - db.admin().authenticate("me", "secret2", this); - }, - - function insertShouldSuccedNow(err, result) { - var self = this; - test.equal(null, err); - test.ok(result); - - db.collection("stuff", function(err, collection) { - collection.insert({a:3}, {safe: true}, self); - }); - }, - - function queryShouldExecuteCorrectly(err, result) { - var self = this; - test.equal(null, err); - - db.collection("stuff", function(err, collection) { - collection.findOne(self); - }); - }, - - function logout(err, item) { - test.ok(err == null); - test.equal(3, item.a); - - db.admin().logout(this); - }, - - function findShouldFailDueToLoggedOut(err, result) { - var self = this; - test.equal(null, err); - - db.collection("stuff", function(err, collection) { - collection.findOne(self); - }); - }, - - function sameShouldApplyToRandomSecondaryServer(err, result) { - var self = this; - test.ok(err != null); - - slaveDb = new Db('foo', new Server(db.serverConfig.secondaries[0].host - , db.serverConfig.secondaries[0].port, {auto_reconnect: true, poolSize: 1}), {native_parser: (process.env['TEST_NATIVE'] != null), slave_ok:true}); - slaveDb.open(function(err, slaveDb) { - slaveDb.collection('stuff', function(err, collection) { - collection.findOne(self) - }) - }); - }, - - function shouldCorrectlyAuthenticateAgainstSecondary(err, result) { - test.ok(err != null) - slaveDb.admin().authenticate('me', 'secret2', this); - }, - - function shouldCorrectlyInsertItem(err, result) { - var self = this; - test.equal(null, err); - test.ok(result); - - slaveDb.collection('stuff', function(err, collection) { - collection.findOne(self) - }) - }, - - function finishUp(err, item) { - test.ok(err == null); - test.equal(3, item.a); - - test.done(); - p_db.close(); - slaveDb.close(); - } - ) - }); -} - -exports.shouldCorrectlyAuthenticate = function(test) { - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Connect to the replicaset - var slaveDb = null; - var db = new Db('foo', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - Step( - function addUser() { - db.admin().addUser("me", "secret", this); - }, - - function ensureFailingInsert(err, result) { - var self = this; - test.equal(null, err); - test.ok(result != null); - - db.collection("stuff", function(err, collection) { - collection.insert({a:2}, {safe: {w: 2, wtimeout: 10000}}, self); - }); - }, - - function authenticate(err, result) { - test.ok(err != null); - - db.admin().authenticate("me", "secret", this); - }, - - function insertShouldSuccedNow(err, result) { - var self = this; - test.equal(null, err); - test.ok(result); - - db.collection("stuff", function(err, collection) { - collection.insert({a:2}, {safe: {w: 2, wtimeout: 10000}}, self); - }); - }, - - function queryShouldExecuteCorrectly(err, result) { - var self = this; - test.equal(null, err); - - db.collection("stuff", function(err, collection) { - collection.findOne(self); - }); - }, - - function finishUp(err, item) { - test.ok(err == null); - test.equal(2, item.a); - test.done(); - p_db.close(); - } - ) - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/auxilliary/single_server_kill_reconnect.js b/test/auxilliary/single_server_kill_reconnect.js deleted file mode 100644 index 85e7fab241d..00000000000 --- a/test/auxilliary/single_server_kill_reconnect.js +++ /dev/null @@ -1,159 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server, - ServerManager = require('../../test/tools/server_manager').ServerManager, - Step = require("step"); - -var MONGODB = 'integration_tests'; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 1}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var serverManager = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -exports.shouldCorrectlyKeepInsertingDocumentsWhenServerDiesAndComesUp = function(test) { - var db1 = new Db('mongo-ruby-test-single-server', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - // All inserted docs - var docs = []; - var errs = []; - var insertDocs = []; - // Start server - serverManager = new ServerManager({auth:false, purgedirectories:true, journal:true}) - serverManager.start(true, function() { - db1.open(function(err, db) { - // Startup the insert of documents - var intervalId = setInterval(function() { - db.collection('inserts', function(err, collection) { - var doc = {timestamp:new Date().getTime()}; - insertDocs.push(doc); - // Insert document - collection.insert(doc, {safe:{fsync:true}}, function(err, result) { - // Save errors - if(err != null) errs.push(err); - if(err == null) { - docs.push(result[0]); - } - }) - }); - }, 500); - - // Wait for a second and then kill the server - setTimeout(function() { - // Kill server instance - serverManager.stop(9, function(err, result) { - // Server down for 1 second - setTimeout(function() { - // Restart server - serverManager = new ServerManager({auth:false, purgedirectories:false, journal:true}); - serverManager.start(true, function() { - // Wait for it - setTimeout(function() { - // Drop db - db.dropDatabase(function(err, result) { - clearInterval(intervalId); - // Close db - db.close(); - // Check that we got at least one error - test.ok(docs.length > 0); - test.ok(insertDocs.length > 0); - // Finish up - test.done(); - }); - }, 5000) - }) - }, 1000); - }); - }, 3000); - }) - }); -} - -exports.shouldCorrectlyInsertKillServerFailThenRestartServerAndSucceed = function(test) { - var db = new Db('test-single-server-recovery', new Server("127.0.0.1", 27017, {auto_reconnect: true}), {numberOfRetries:3, retryMiliSeconds:500, native_parser: (process.env['TEST_NATIVE'] != null)}); - // All inserted docs - var docs = []; - var errs = []; - var insertDocs = []; - - // Start server - serverManager = new ServerManager({auth:false, purgedirectories:true, journal:true}) - serverManager.start(true, function() { - db.open(function(err, db) { - // Add an error handler - db.on("error", function(err) { - console.log("----------------------------------------------- received error") - console.dir(err) - errs.push(err); - }); - - db.collection('inserts', function(err, collection) { - var doc = {timestamp:new Date().getTime(), a:1}; - collection.insert(doc, {safe:true}, function(err, result) { - test.equal(null, err); - - // Kill server instance - serverManager.stop(9, function(err, result) { - // Attemp insert (should timeout) - var doc = {timestamp:new Date().getTime(), b:1}; - collection.insert(doc, {safe:true}, function(err, result) { - test.ok(err != null); - test.equal(null, result); - - // Restart server - serverManager = new ServerManager({auth:false, purgedirectories:false, journal:true}); - serverManager.start(true, function() { - // Attemp insert again - collection.insert(doc, {safe:true}, function(err, result) { - // Fetch the documents - collection.find({b:1}).toArray(function(err, items) { - test.equal(null, err); - test.equal(1, items[0].b); - db.close(); - test.done(); - }); - }); - }); - }); - }); - }) - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/auxilliary/ssl_test.js b/test/auxilliary/ssl_test.js deleted file mode 100644 index 9511fd2c9c1..00000000000 --- a/test/auxilliary/ssl_test.js +++ /dev/null @@ -1,78 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server, - ServerManager = require('../../test/tools/server_manager').ServerManager, - Step = require("step"); - -var MONGODB = 'integration_tests'; -var serverManager = null; -var ssl = true; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -exports.shouldCorrectlyCommunicateUsingSSLSocket = function(test) { - var db1 = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, poolSize:4, ssl:ssl}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - // All inserted docs - var docs = []; - var errs = []; - var insertDocs = []; - - // Start server - serverManager = new ServerManager({auth:false, purgedirectories:true, journal:true, ssl:ssl}) - serverManager.start(true, function() { - db1.open(function(err, db) { - // Create a collection - db.createCollection('shouldCorrectlyCommunicateUsingSSLSocket', function(err, collection) { - collection.insert([{a:1}, {b:2}, {c:'hello world'}]); - collection.insert([{a:1}, {b:2}, {c:'hello world'}]); - collection.insert([{a:1}, {b:2}, {c:'hello world'}]); - collection.insert([{a:1}, {b:2}, {c:'hello world'}]); - collection.insert([{a:1}, {b:2}, {c:'hello world'}], {safe:true}, function(err, result) { - collection.find({}).toArray(function(err, items) { - // test.equal(3, items.length); - db.close(); - test.done(); - }) - }); - }); - }) - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/bson/bson_test.js b/test/bson/bson_test.js deleted file mode 100644 index c3461019c59..00000000000 --- a/test/bson/bson_test.js +++ /dev/null @@ -1,1606 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - mongoO = require('../../lib/mongodb').pure(), - debug = require('util').debug, - inspect = require('util').inspect, - Buffer = require('buffer').Buffer, - gleak = require('../../dev/tools/gleak'), - fs = require('fs'), - BSON = mongoO.BSON, - Code = mongoO.Code, - Binary = mongoO.Binary, - Timestamp = mongoO.Timestamp, - Long = mongoO.Long, - MongoReply = mongoO.MongoReply, - ObjectID = mongoO.ObjectID, - Symbol = mongoO.Symbol, - DBRef = mongoO.DBRef, - Double = mongoO.Double, - MinKey = mongoO.MinKey, - MaxKey = mongoO.MaxKey, - BinaryParser = mongoO.BinaryParser; - -var BSONSE = mongodb, - BSONDE = mongodb; - -// for tests -BSONDE.BSON_BINARY_SUBTYPE_DEFAULT = 0; -BSONDE.BSON_BINARY_SUBTYPE_FUNCTION = 1; -BSONDE.BSON_BINARY_SUBTYPE_BYTE_ARRAY = 2; -BSONDE.BSON_BINARY_SUBTYPE_UUID = 3; -BSONDE.BSON_BINARY_SUBTYPE_MD5 = 4; -BSONDE.BSON_BINARY_SUBTYPE_USER_DEFINED = 128; - -BSONSE.BSON_BINARY_SUBTYPE_DEFAULT = 0; -BSONSE.BSON_BINARY_SUBTYPE_FUNCTION = 1; -BSONSE.BSON_BINARY_SUBTYPE_BYTE_ARRAY = 2; -BSONSE.BSON_BINARY_SUBTYPE_UUID = 3; -BSONSE.BSON_BINARY_SUBTYPE_MD5 = 4; -BSONSE.BSON_BINARY_SUBTYPE_USER_DEFINED = 128; - -var hexStringToBinary = function(string) { - var numberofValues = string.length / 2; - var array = ""; - - for(var i = 0; i < numberofValues; i++) { - array += String.fromCharCode(parseInt(string[i*2] + string[i*2 + 1], 16)); - } - return array; -} - -var assertBuffersEqual = function(test, buffer1, buffer2) { - if(buffer1.length != buffer2.length) test.fail("Buffers do not have the same length", buffer1, buffer2); - - for(var i = 0; i < buffer1.length; i++) { - test.equal(buffer1[i], buffer2[i]); - } -} - -/** - * Module for parsing an ISO 8601 formatted string into a Date object. - */ -var ISODate = function (string) { - var match; - - if (typeof string.getTime === "function") - return string; - else if (match = string.match(/^(\d{4})(-(\d{2})(-(\d{2})(T(\d{2}):(\d{2})(:(\d{2})(\.(\d+))?)?(Z|((\+|-)(\d{2}):(\d{2}))))?)?)?$/)) { - var date = new Date(); - date.setUTCFullYear(Number(match[1])); - date.setUTCMonth(Number(match[3]) - 1 || 0); - date.setUTCDate(Number(match[5]) || 0); - date.setUTCHours(Number(match[7]) || 0); - date.setUTCMinutes(Number(match[8]) || 0); - date.setUTCSeconds(Number(match[10]) || 0); - date.setUTCMilliseconds(Number("." + match[12]) * 1000 || 0); - - if (match[13] && match[13] !== "Z") { - var h = Number(match[16]) || 0, - m = Number(match[17]) || 0; - - h *= 3600000; - m *= 60000; - - var offset = h + m; - if (match[15] == "+") - offset = -offset; - - date = new Date(date.valueOf() + offset); - } - - return date; - } else - throw new Error("Invalid ISO 8601 date given.", __filename); -}; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -/** - * @ignore - */ -exports['Should Correctly get BSON types from require'] = function(test) { - var _mongodb = require('../../lib/mongodb'); - test.ok(_mongodb.ObjectID === ObjectID); - test.ok(_mongodb.Binary === Binary); - test.ok(_mongodb.Long === Long); - test.ok(_mongodb.Timestamp === Timestamp); - test.ok(_mongodb.Code === Code); - test.ok(_mongodb.DBRef === DBRef); - test.ok(_mongodb.Symbol === Symbol); - test.ok(_mongodb.MinKey === MinKey); - test.ok(_mongodb.MaxKey === MaxKey); - test.ok(_mongodb.Double === Double); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Deserialize object'] = function(test) { - var bytes = [95,0,0,0,2,110,115,0,42,0,0,0,105,110,116,101,103,114,97,116,105,111,110,95,116,101,115,116,115,95,46,116,101,115,116,95,105,110,100,101,120,95,105,110,102,111,114,109,97,116,105,111,110,0,8,117,110,105,113,117,101,0,0,3,107,101,121,0,12,0,0,0,16,97,0,1,0,0,0,0,2,110,97,109,101,0,4,0,0,0,97,95,49,0,0]; - var serialized_data = ''; - // Convert to chars - for(var i = 0; i < bytes.length; i++) { - serialized_data = serialized_data + BinaryParser.fromByte(bytes[i]); - } - - var object = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(new Buffer(serialized_data, 'binary')); - test.equal("a_1", object.name); - test.equal(false, object.unique); - test.equal(1, object.key.a); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Deserialize object with all types'] = function(test) { - var bytes = [26,1,0,0,7,95,105,100,0,161,190,98,75,118,169,3,0,0,3,0,0,4,97,114,114,97,121,0,26,0,0,0,16,48,0,1,0,0,0,16,49,0,2,0,0,0,16,50,0,3,0,0,0,0,2,115,116,114,105,110,103,0,6,0,0,0,104,101,108,108,111,0,3,104,97,115,104,0,19,0,0,0,16,97,0,1,0,0,0,16,98,0,2,0,0,0,0,9,100,97,116,101,0,161,190,98,75,0,0,0,0,7,111,105,100,0,161,190,98,75,90,217,18,0,0,1,0,0,5,98,105,110,97,114,121,0,7,0,0,0,2,3,0,0,0,49,50,51,16,105,110,116,0,42,0,0,0,1,102,108,111,97,116,0,223,224,11,147,169,170,64,64,11,114,101,103,101,120,112,0,102,111,111,98,97,114,0,105,0,8,98,111,111,108,101,97,110,0,1,15,119,104,101,114,101,0,25,0,0,0,12,0,0,0,116,104,105,115,46,120,32,61,61,32,51,0,5,0,0,0,0,3,100,98,114,101,102,0,37,0,0,0,2,36,114,101,102,0,5,0,0,0,116,101,115,116,0,7,36,105,100,0,161,190,98,75,2,180,1,0,0,2,0,0,0,10,110,117,108,108,0,0]; - var serialized_data = ''; - // Convert to chars - for(var i = 0; i < bytes.length; i++) { - serialized_data = serialized_data + BinaryParser.fromByte(bytes[i]); - } - - var object = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(new Buffer(serialized_data, 'binary'));//, false, true); - // Perform tests - test.equal("hello", object.string); - test.deepEqual([1,2,3], object.array); - test.equal(1, object.hash.a); - test.equal(2, object.hash.b); - test.ok(object.date != null); - test.ok(object.oid != null); - test.ok(object.binary != null); - test.equal(42, object.int); - test.equal(33.3333, object.float); - test.ok(object.regexp != null); - test.equal(true, object.boolean); - test.ok(object.where != null); - test.ok(object.dbref != null); - test.ok(object[null] == null); - test.done(); -} - -/** - * @ignore - */ -exports['Should Serialize and Deserialize String'] = function(test) { - var test_string = {hello: 'world'}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_string, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_string)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_string, false, serialized_data2, 0); - - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_string, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Serialize and Deserialize Empty String'] = function(test) { - var test_string = {hello: ''}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_string, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_string)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_string, false, serialized_data2, 0); - - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_string, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Integer'] = function(test) { - var test_number = {doc: 5}; - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_number, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_number)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_number, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_number, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data)); - test.deepEqual(test_number, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data2)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize null value'] = function(test) { - var test_null = {doc:null}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_null, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_null)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_null, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var object = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.equal(null, object.doc); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Number'] = function(test) { - var test_number = {doc: 5.5}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_number, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_number)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_number, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.deepEqual(test_number, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Integer'] = function(test) { - var test_int = {doc: 42}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_int, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_int)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_int, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_int.doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc); - - test_int = {doc: -5600}; - serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_int, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_int)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_int, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_int.doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc); - - test_int = {doc: 2147483647}; - serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_int, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_int)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_int, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_int.doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc); - - test_int = {doc: -2147483648}; - serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_int, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_int)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_int, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - test.deepEqual(test_int.doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Object'] = function(test) { - var doc = {doc: {age: 42, name: 'Spongebob', shoe_size: 9.5}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.deepEqual(doc.doc.age, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc.age); - test.deepEqual(doc.doc.name, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc.name); - test.deepEqual(doc.doc.shoe_size, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc.shoe_size); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Array'] = function(test) { - var doc = {doc: [1, 2, 'a', 'b']}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.equal(doc.doc[0], deserialized.doc[0]) - test.equal(doc.doc[1], deserialized.doc[1]) - test.equal(doc.doc[2], deserialized.doc[2]) - test.equal(doc.doc[3], deserialized.doc[3]) - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Array with added on functions'] = function(test) { - Array.prototype.toXml = function() {}; - var doc = {doc: [1, 2, 'a', 'b']}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.equal(doc.doc[0], deserialized.doc[0]) - test.equal(doc.doc[1], deserialized.doc[1]) - test.equal(doc.doc[2], deserialized.doc[2]) - test.equal(doc.doc[3], deserialized.doc[3]) - test.done(); -} - -/** - * @ignore - */ -exports['Should correctly deserialize a nested object'] = function(test) { - var doc = {doc: {doc:1}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.deepEqual(doc.doc.doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc.doc); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize A Boolean'] = function(test) { - var doc = {doc: true}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.equal(doc.doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize a Date'] = function(test) { - var date = new Date(); - //(2009, 11, 12, 12, 00, 30) - date.setUTCDate(12); - date.setUTCFullYear(2009); - date.setUTCMonth(11 - 1); - date.setUTCHours(12); - date.setUTCMinutes(0); - date.setUTCSeconds(30); - var doc = {doc: date}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.equal(doc.date, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc.date); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize nested doc'] = function(test) { - var doc = { - string: "Strings are great", - decimal: 3.14159265, - bool: true, - integer: 5, - - subObject: { - moreText: "Bacon ipsum dolor.", - longKeylongKeylongKeylongKeylongKeylongKey: "Pork belly." - }, - - subArray: [1,2,3,4,5,6,7,8,9,10], - anotherString: "another string" - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Oid'] = function(test) { - var doc = {doc: new ObjectID()}; - var doc2 = {doc: ObjectID.createFromHexString(doc.doc.toHexString())}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - delete doc.doc.__id; - test.deepEqual(doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly encode Empty Hash'] = function(test) { - var doc = {}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - test.deepEqual(doc, new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Ordered Hash'] = function(test) { - var doc = {doc: {b:1, a:2, c:3, d:4}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var decoded_hash = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data).doc; - var keys = []; - - for(var name in decoded_hash) keys.push(name); - test.deepEqual(['b', 'a', 'c', 'd'], keys); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Regular Expression'] = function(test) { - // Serialize the regular expression - var doc = {doc: /foobar/mi}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(doc.doc.toString(), doc2.doc.toString()); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize a Binary object'] = function(test) { - var bin = new Binary(); - var string = 'binstring'; - for(var index = 0; index < string.length; index++) { - bin.put(string.charAt(index)); - } - - var doc = {doc: bin}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(doc.doc.value(), deserialized_data.doc.value()); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize a big Binary object'] = function(test) { - var data = fs.readFileSync("test/gridstore/test_gs_weird_bug.png", 'binary'); - var bin = new Binary(); - bin.write(data); - var doc = {doc: bin}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc.value(), deserialized_data.doc.value()); - test.done(); -} - -/** - * @ignore - */ -exports["Should Correctly Serialize and Deserialize DBRef"] = function(test) { - var oid = new ObjectID(); - var doc = {dbref: new DBRef('namespace', oid, null)}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.equal("namespace", doc2.dbref.namespace); - test.deepEqual(doc2.dbref.oid.toHexString(), oid.toHexString()); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize partial DBRef'] = function(test) { - var id = new ObjectID(); - var doc = {'name':'something', 'user':{'$ref':'username', '$id': id}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.equal('something', doc2.name); - test.equal('username', doc2.user.namespace); - test.equal(id.toString(), doc2.user.oid.toString()); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize simple Int'] = function(test) { - var doc = {doc:2147483648}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc, doc2.doc) - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Long Integer'] = function(test) { - var doc = {doc: Long.fromNumber(9223372036854775807)}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc, deserialized_data.doc); - - doc = {doc: Long.fromNumber(-9223372036854775)}; - serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc, deserialized_data.doc); - - doc = {doc: Long.fromNumber(-9223372036854775809)}; - serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc, deserialized_data.doc); - test.done(); -} - -/** - * @ignore - */ -exports['Should Deserialize Large Integers as Number not Long'] = function(test) { - function roundTrip(val) { - var doc = {doc: val}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc, deserialized_data.doc); - }; - - roundTrip(Math.pow(2,52)); - roundTrip(Math.pow(2,53) - 1); - roundTrip(Math.pow(2,53)); - roundTrip(-Math.pow(2,52)); - roundTrip(-Math.pow(2,53) + 1); - roundTrip(-Math.pow(2,53)); - roundTrip(Math.pow(2,65)); // Too big for Long. - roundTrip(-Math.pow(2,65)); - roundTrip(9223372036854775807); - roundTrip(1234567890123456800); // Bigger than 2^53, stays a double. - roundTrip(-1234567890123456800); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Long Integer and Timestamp as different types'] = function(test) { - var long = Long.fromNumber(9223372036854775807); - var timestamp = Timestamp.fromNumber(9223372036854775807); - test.ok(long instanceof Long); - test.ok(!(long instanceof Timestamp)); - test.ok(timestamp instanceof Timestamp); - test.ok(!(timestamp instanceof Long)); - - var test_int = {doc: long, doc2: timestamp}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(test_int, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(test_int)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(test_int, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(test_int.doc, deserialized_data.doc); - test.done(); -} - -/** - * @ignore - */ -exports['Should Always put the id as the first item in a hash'] = function(test) { - var hash = {doc: {not_id:1, '_id':2}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(hash, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(hash)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(hash, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - var keys = []; - - for(var name in deserialized_data.doc) { - keys.push(name); - } - - test.deepEqual(['not_id', '_id'], keys); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize a User defined Binary object'] = function(test) { - var bin = new Binary(); - bin.sub_type = BSON.BSON_BINARY_SUBTYPE_USER_DEFINED; - var string = 'binstring'; - for(var index = 0; index < string.length; index++) { - bin.put(string.charAt(index)); - } - - var doc = {doc: bin}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(deserialized_data.doc.sub_type, BSON.BSON_BINARY_SUBTYPE_USER_DEFINED); - test.deepEqual(doc.doc.value(), deserialized_data.doc.value()); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correclty Serialize and Deserialize a Code object'] = function(test) { - var doc = {'doc': {'doc2': new Code('this.a > i', {i:1})}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.doc.doc2.code, deserialized_data.doc.doc2.code); - test.deepEqual(doc.doc.doc2.scope.i, deserialized_data.doc.doc2.scope.i); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly serialize and deserialize and embedded array'] = function(test) { - var doc = {'a':0, - 'b':['tmp1', 'tmp2', 'tmp3', 'tmp4', 'tmp5', 'tmp6', 'tmp7', 'tmp8', 'tmp9', 'tmp10', 'tmp11', 'tmp12', 'tmp13', 'tmp14', 'tmp15', 'tmp16'] - }; - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.a, deserialized_data.a); - test.deepEqual(doc.b, deserialized_data.b); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize UTF8'] = function(test) { - // Serialize utf8 - var doc = { "name" : "本荘由利地域に洪水警報", "name1" : "öüóőúéáűíÖÜÓŐÚÉÁŰÍ", "name2" : "abcdedede"}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc, deserialized_data); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize query object'] = function(test) { - var doc = { count: 'remove_with_no_callback_bug_test', query: {}, fields: null}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc, deserialized_data); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize empty query object'] = function(test) { - var doc = {}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc, deserialized_data); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize array based doc'] = function(test) { - var doc = { b: [ 1, 2, 3 ], _id: new ObjectID() }; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.b, deserialized_data.b) - test.deepEqual(doc, deserialized_data); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize and Deserialize Symbol'] = function(test) { - if(Symbol != null) { - var doc = { b: [ new Symbol('test') ]}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc.b, deserialized_data.b) - test.deepEqual(doc, deserialized_data); - test.ok(deserialized_data.b[0] instanceof Symbol); - } - - test.done(); -} - -/** - * @ignore - */ -exports['Should handle Deeply nested document'] = function(test) { - var doc = {a:{b:{c:{d:2}}}}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var deserialized_data = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc, deserialized_data); - test.done(); -} - -/** - * @ignore - */ -exports['Should handle complicated all typed object'] = function(test) { - // First doc - var date = new Date(); - var oid = new ObjectID(); - var string = 'binstring' - var bin = new Binary() - for(var index = 0; index < string.length; index++) { - bin.put(string.charAt(index)) - } - - var doc = { - 'string': 'hello', - 'array': [1,2,3], - 'hash': {'a':1, 'b':2}, - 'date': date, - 'oid': oid, - 'binary': bin, - 'int': 42, - 'float': 33.3333, - 'regexp': /regexp/, - 'boolean': true, - 'long': date.getTime(), - 'where': new Code('this.a > i', {i:1}), - 'dbref': new DBRef('namespace', oid, 'integration_tests_') - } - - // Second doc - var oid = new ObjectID.createFromHexString(oid.toHexString()); - var string = 'binstring' - var bin = new Binary() - for(var index = 0; index < string.length; index++) { - bin.put(string.charAt(index)) - } - - var doc2 = { - 'string': 'hello', - 'array': [1,2,3], - 'hash': {'a':1, 'b':2}, - 'date': date, - 'oid': oid, - 'binary': bin, - 'int': 42, - 'float': 33.3333, - 'regexp': /regexp/, - 'boolean': true, - 'long': date.getTime(), - 'where': new Code('this.a > i', {i:1}), - 'dbref': new DBRef('namespace', oid, 'integration_tests_') - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var serialized_data2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc2, false, true); - - for(var i = 0; i < serialized_data2.length; i++) { - require('assert').equal(serialized_data2[i], serialized_data[i]) - } - - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize Complex Nested Object'] = function(test) { - var doc = { email: 'email@email.com', - encrypted_password: 'password', - friends: [ '4db96b973d01205364000006', - '4dc77b24c5ba38be14000002' ], - location: [ 72.4930088, 23.0431957 ], - name: 'Amit Kumar', - password_salt: 'salty', - profile_fields: [], - username: 'amit', - _id: new ObjectID() } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = doc; - doc2._id = ObjectID.createFromHexString(doc2._id.toHexString()); - var serialized_data2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc2, false, true); - - for(var i = 0; i < serialized_data2.length; i++) { - require('assert').equal(serialized_data2[i], serialized_data[i]) - } - - test.done(); -} - -/** - * @ignore - */ -exports['Should correctly massive doc'] = function(test) { - var oid1 = new ObjectID(); - var oid2 = new ObjectID(); - - // JS doc - var doc = { dbref2: new DBRef('namespace', oid1, 'integration_tests_'), - _id: oid2 }; - - var doc2 = { dbref2: new DBRef('namespace', ObjectID.createFromHexString(oid1.toHexString()), 'integration_tests_'), - _id: new ObjectID.createFromHexString(oid2.toHexString()) }; - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var serialized_data2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc2, false, true); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize/Deserialize regexp object'] = function(test) { - var doc = {'b':/foobaré/}; - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var serialized_data2 = new BSONDE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - for(var i = 0; i < serialized_data2.length; i++) { - require('assert').equal(serialized_data2[i], serialized_data[i]) - } - - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize/Deserialize complicated object'] = function(test) { - var doc = {a:{b:{c:[new ObjectID(), new ObjectID()]}}, d:{f:1332.3323}}; - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(doc, doc2) - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize/Deserialize nested object'] = function(test) { - var doc = { "_id" : { "date" : new Date(), "gid" : "6f35f74d2bea814e21000000" }, - "value" : { - "b" : { "countries" : { "--" : 386 }, "total" : 1599 }, - "bc" : { "countries" : { "--" : 3 }, "total" : 10 }, - "gp" : { "countries" : { "--" : 2 }, "total" : 13 }, - "mgc" : { "countries" : { "--" : 2 }, "total" : 14 } - } - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(doc, doc2) - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize/Deserialize nested object with even more nesting'] = function(test) { - var doc = { "_id" : { "date" : {a:1, b:2, c:new Date()}, "gid" : "6f35f74d2bea814e21000000" }, - "value" : { - "b" : { "countries" : { "--" : 386 }, "total" : 1599 }, - "bc" : { "countries" : { "--" : 3 }, "total" : 10 }, - "gp" : { "countries" : { "--" : 2 }, "total" : 13 }, - "mgc" : { "countries" : { "--" : 2 }, "total" : 14 } - } - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual(doc, doc2) - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly Serialize empty name object'] = function(test) { - var doc = {'':'test', - 'bbbb':1}; - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.equal(doc2[''], 'test'); - test.equal(doc2['bbbb'], 1); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly handle Forced Doubles to ensure we allocate enough space for cap collections'] = function(test) { - if(Double != null) { - var doubleValue = new Double(100); - var doc = {value:doubleValue}; - - // Serialize - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - test.deepEqual({value:100}, doc2); - } - - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly deserialize a message'] = function(test) { - var data = "24000000be00de4428000000010000000800000000000000000000000000000000000000"; - var parent = {bson_deserializer:{"Long":Long, "BSON":BSONSE.BSON}} - var binaryData = new Buffer(hexStringToBinary(data)); - - var doc2 = new MongoReply(parent, binaryData); - test.deepEqual([], doc2.documents); - test.done(); -} - -/** - * @ignore - */ -exports['Should deserialize correctly'] = function(test) { - var doc = { - "_id" : new ObjectID("4e886e687ff7ef5e00000162"), - "str" : "foreign", - "type" : 2, - "timestamp" : ISODate("2011-10-02T14:00:08.383Z"), - "links" : [ - "http://www.reddit.com/r/worldnews/comments/kybm0/uk_home_secretary_calls_for_the_scrapping_of_the/" - ] - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(doc, doc2) - test.done(); -} - -/** - * @ignore - */ -exports['Should correctly serialize and deserialize MinKey and MaxKey values'] = function(test) { - var doc = { - _id : new ObjectID("4e886e687ff7ef5e00000162"), - minKey : new MinKey(), - maxKey : new MaxKey() - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.deepEqual(doc, doc2) - test.ok(doc2.minKey instanceof MinKey); - test.ok(doc2.maxKey instanceof MaxKey); - test.done(); -} - -/** - * @ignore - */ -exports['Should correctly serialize Double value'] = function(test) { - var doc = { - value : new Double(34343.2222) - } - - var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); - var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); - new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); - assertBuffersEqual(test, serialized_data, serialized_data2, 0); - var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data); - - test.ok(doc.value.valueOf(), doc2.value); - test.ok(doc.value.value, doc2.value); - test.done(); -} - -/** - * @ignore - */ -exports['ObjectID should correctly create objects'] = function(test) { - try { - var object1 = ObjectID.createFromHexString('000000000000000000000001') - var object2 = ObjectID.createFromHexString('00000000000000000000001') - test.ok(false); - } catch(err) { - test.ok(err != null); - } - - test.done(); -} - -/** - * @ignore - */ -exports['ObjectID should correctly retrieve timestamp'] = function(test) { - var testDate = new Date(); - var object1 = new ObjectID(); - test.equal(Math.floor(testDate.getTime()/1000), Math.floor(object1.getTimestamp().getTime()/1000)); - test.done(); -} - -/** - * @ignore - */ -exports['Should Correctly throw error on bsonparser errors'] = function(test) { - var data = new Buffer(3); - var parser = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]); - - // Catch to small buffer error - try { - parser.deserialize(data); - test.ok(false); - } catch(err) {} - - data = new Buffer(5); - data[0] = 0xff; - data[1] = 0xff; - // Catch illegal size - try { - parser.deserialize(data); - test.ok(false); - } catch(err) {} - - // Finish up - test.done(); -} - -/** - * A simple example showing the usage of BSON.calculateObjectSize function returning the number of BSON bytes a javascript object needs. - * - * @_class bson - * @_function BSON.calculateObjectSize - * @ignore - */ -exports['Should correctly calculate the size of a given javascript object'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){}} - // Calculate the size of the object without serializing the function - var size = BSON.calculateObjectSize(doc, false); - test.equal(12, size); - // Calculate the size of the object serializing the function - size = BSON.calculateObjectSize(doc, true); - // Validate the correctness - test.equal(36, size); - test.done(); -} - -/** - * A simple example showing the usage of BSON.calculateObjectSize function returning the number of BSON bytes a javascript object needs. - * - * @_class bson - * @_function calculateObjectSize - * @ignore - */ -exports['Should correctly calculate the size of a given javascript object using instance method'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){}} - // Create a BSON parser instance - var bson = new BSON(); - // Calculate the size of the object without serializing the function - var size = bson.calculateObjectSize(doc, false); - test.equal(12, size); - // Calculate the size of the object serializing the function - size = bson.calculateObjectSize(doc, true); - // Validate the correctness - test.equal(36, size); - test.done(); -} - -/** - * A simple example showing the usage of BSON.serializeWithBufferAndIndex function. - * - * @_class bson - * @_function BSON.serializeWithBufferAndIndex - * @ignore - */ -exports['Should correctly serializeWithBufferAndIndex a given javascript object'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){}} - // Calculate the size of the document, no function serialization - var size = BSON.calculateObjectSize(doc, false); - // Allocate a buffer - var buffer = new Buffer(size); - // Serialize the object to the buffer, checking keys and not serializing functions - var index = BSON.serializeWithBufferAndIndex(doc, true, buffer, 0, false); - // Validate the correctness - test.equal(12, size); - test.equal(11, index); - - // Serialize with functions - // Calculate the size of the document, no function serialization - var size = BSON.calculateObjectSize(doc, true); - // Allocate a buffer - var buffer = new Buffer(size); - // Serialize the object to the buffer, checking keys and not serializing functions - var index = BSON.serializeWithBufferAndIndex(doc, true, buffer, 0, true); - // Validate the correctness - test.equal(36, size); - test.equal(35, index); - test.done(); -} - -/** - * A simple example showing the usage of BSON.serializeWithBufferAndIndex function. - * - * @_class bson - * @_function serializeWithBufferAndIndex - * @ignore - */ -exports['Should correctly serializeWithBufferAndIndex a given javascript object using a BSON instance'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){}} - // Create a BSON parser instance - var bson = new BSON(); - // Calculate the size of the document, no function serialization - var size = bson.calculateObjectSize(doc, false); - // Allocate a buffer - var buffer = new Buffer(size); - // Serialize the object to the buffer, checking keys and not serializing functions - var index = bson.serializeWithBufferAndIndex(doc, true, buffer, 0, false); - // Validate the correctness - test.equal(12, size); - test.equal(11, index); - - // Serialize with functions - // Calculate the size of the document, no function serialization - var size = bson.calculateObjectSize(doc, true); - // Allocate a buffer - var buffer = new Buffer(size); - // Serialize the object to the buffer, checking keys and not serializing functions - var index = bson.serializeWithBufferAndIndex(doc, true, buffer, 0, true); - // Validate the correctness - test.equal(36, size); - test.equal(35, index); - test.done(); -} - -/** - * A simple example showing the usage of BSON.serialize function returning serialized BSON Buffer object. - * - * @_class bson - * @_function BSON.serialize - * @ignore - */ -exports['Should correctly serialize a given javascript object'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){}} - // Serialize the object to a buffer, checking keys and not serializing functions - var buffer = BSON.serialize(doc, true, true, false); - // Validate the correctness - test.equal(12, buffer.length); - - // Serialize the object to a buffer, checking keys and serializing functions - var buffer = BSON.serialize(doc, true, true, true); - // Validate the correctness - test.equal(36, buffer.length); - test.done(); -} - -/** - * A simple example showing the usage of BSON.serialize function returning serialized BSON Buffer object. - * - * @_class bson - * @_function serialize - * @ignore - */ -exports['Should correctly serialize a given javascript object using a bson instance'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){}} - // Create a BSON parser instance - var bson = new BSON(); - // Serialize the object to a buffer, checking keys and not serializing functions - var buffer = bson.serialize(doc, true, true, false); - // Validate the correctness - test.equal(12, buffer.length); - - // Serialize the object to a buffer, checking keys and serializing functions - var buffer = bson.serialize(doc, true, true, true); - // Validate the correctness - test.equal(36, buffer.length); - test.done(); -} - -/** - * A simple example showing the usage of BSON.deserialize function returning a deserialized Javascript function. - * - * @_class bson - * @_function BSON.deserialize - * @ignore - */ - exports['Should correctly deserialize a buffer using the BSON class level parser'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){ console.log('hello world'); }} - // Serialize the object to a buffer, checking keys and serializing functions - var buffer = BSON.serialize(doc, true, true, true); - // Validate the correctness - test.equal(65, buffer.length); - - // Deserialize the object with no eval for the functions - var deserializedDoc = BSON.deserialize(buffer); - // Validate the correctness - test.equal('object', typeof deserializedDoc.func); - test.equal(1, deserializedDoc.a); - - // Deserialize the object with eval for the functions caching the functions - deserializedDoc = BSON.deserialize(buffer, {evalFunctions:true, cacheFunctions:true}); - // Validate the correctness - test.equal('function', typeof deserializedDoc.func); - test.equal(1, deserializedDoc.a); - test.done(); -} - -/** - * A simple example showing the usage of BSON instance deserialize function returning a deserialized Javascript function. - * - * @_class bson - * @_function deserialize - * @ignore - */ -exports['Should correctly deserialize a buffer using the BSON instance parser'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){ console.log('hello world'); }} - // Create a BSON parser instance - var bson = new BSON(); - // Serialize the object to a buffer, checking keys and serializing functions - var buffer = bson.serialize(doc, true, true, true); - // Validate the correctness - test.equal(65, buffer.length); - - // Deserialize the object with no eval for the functions - var deserializedDoc = bson.deserialize(buffer); - // Validate the correctness - test.equal('object', typeof deserializedDoc.func); - test.equal(1, deserializedDoc.a); - - // Deserialize the object with eval for the functions caching the functions - deserializedDoc = bson.deserialize(buffer, {evalFunctions:true, cacheFunctions:true}); - // Validate the correctness - test.equal('function', typeof deserializedDoc.func); - test.equal(1, deserializedDoc.a); - test.done(); -} - -/** - * A simple example showing the usage of BSON.deserializeStream function returning deserialized Javascript objects. - * - * @_class bson - * @_function BSON.deserializeStream - * @ignore - */ -exports['Should correctly deserializeStream a buffer object'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){ console.log('hello world'); }} - // Serialize the object to a buffer, checking keys and serializing functions - var buffer = BSON.serialize(doc, true, true, true); - // Validate the correctness - test.equal(65, buffer.length); - - // The array holding the number of retuned documents - var documents = new Array(1); - // Deserialize the object with no eval for the functions - var index = BSON.deserializeStream(buffer, 0, 1, documents, 0); - // Validate the correctness - test.equal(65, index); - test.equal(1, documents.length); - test.equal(1, documents[0].a); - test.equal('object', typeof documents[0].func); - - // Deserialize the object with eval for the functions caching the functions - // The array holding the number of retuned documents - var documents = new Array(1); - // Deserialize the object with no eval for the functions - var index = BSON.deserializeStream(buffer, 0, 1, documents, 0, {evalFunctions:true, cacheFunctions:true}); - // Validate the correctness - test.equal(65, index); - test.equal(1, documents.length); - test.equal(1, documents[0].a); - test.equal('function', typeof documents[0].func); - test.done(); -} - -/** - * A simple example showing the usage of BSON instance deserializeStream function returning deserialized Javascript objects. - * - * @_class bson - * @_function deserializeStream - * @ignore - */ -exports['Should correctly deserializeStream a buffer object'] = function(test) { - // Create a simple object - var doc = {a: 1, func:function(){ console.log('hello world'); }} - // Create a BSON parser instance - var bson = new BSON(); - // Serialize the object to a buffer, checking keys and serializing functions - var buffer = bson.serialize(doc, true, true, true); - // Validate the correctness - test.equal(65, buffer.length); - - // The array holding the number of retuned documents - var documents = new Array(1); - // Deserialize the object with no eval for the functions - var index = bson.deserializeStream(buffer, 0, 1, documents, 0); - // Validate the correctness - test.equal(65, index); - test.equal(1, documents.length); - test.equal(1, documents[0].a); - test.equal('object', typeof documents[0].func); - - // Deserialize the object with eval for the functions caching the functions - // The array holding the number of retuned documents - var documents = new Array(1); - // Deserialize the object with no eval for the functions - var index = bson.deserializeStream(buffer, 0, 1, documents, 0, {evalFunctions:true, cacheFunctions:true}); - // Validate the correctness - test.equal(65, index); - test.equal(1, documents.length); - test.equal(1, documents[0].a); - test.equal('function', typeof documents[0].func); - test.done(); -} - -/** - * @ignore - */ -// 'Should Correctly Function' = function(test) { -// var doc = {b:1, func:function() { -// this.b = 2; -// }}; -// -// var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc, false, true); -// -// debug("----------------------------------------------------------------------") -// debug(inspect(serialized_data)) -// -// // var serialized_data2 = new Buffer(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).calculateObjectSize(doc)); -// // new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serializeWithBufferAndIndex(doc, false, serialized_data2, 0); -// // assertBuffersEqual(test, serialized_data, serialized_data2, 0); -// var COUNT = 100000; -// -// // var b = null; -// // eval("b = function(x) { return x+x; }"); -// // var b = new Function("x", "return x+x;"); -// -// console.log(COUNT + "x (objectBSON = BSON.serialize(object))") -// start = new Date -// -// for (i=COUNT; --i>=0; ) { -// var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data, {evalFunctions: true, cacheFunctions:true}); -// } -// -// end = new Date -// console.log("time = ", end - start, "ms -", COUNT * 1000 / (end - start), " ops/sec") -// -// // debug(inspect(new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).functionCache)) -// // -// // var doc2 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data, {evalFunctions: true, cacheFunctions:true}); -// // // test.deepEqual(doc, doc2) -// // // -// // debug(inspect(doc2)) -// // doc2.func() -// // debug(inspect(doc2)) -// // -// // var serialized_data = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).serialize(doc2, false, true); -// // var doc3 = new BSONSE.BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey]).deserialize(serialized_data, {evalFunctions: true, cacheFunctions:true}); -// // -// // debug("-----------------------------------------------") -// // debug(inspect(doc3)) -// -// // var key = "0" -// // for(var i = 1; i < 10000; i++) { -// // key = key + " " + i -// // } -// -// test.done(); -// -// -// // var car = { -// // model : "Volvo", -// // country : "Sweden", -// // -// // isSwedish : function() { -// // return this.country == "Sweden"; -// // } -// // } -// -// }, - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/bson/commands_test.js b/test/bson/commands_test.js deleted file mode 100644 index e0d80cc6388..00000000000 --- a/test/bson/commands_test.js +++ /dev/null @@ -1,129 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - mongoO = require('../../lib/mongodb').pure(), - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - fs = require('fs'), - BSON = mongodb.BSON, - Code = mongoO.Code, - Binary = mongoO.Binary, - Symbol = mongoO.Symbol, - DBRef = mongoO.DBRef, - Double = mongoO.Double, - MinKey = mongoO.MinKey, - MaxKey = mongoO.MaxKey, - Timestamp = mongoO.Timestamp, - Long = mongoO.Long, - ObjectID = mongoO.ObjectID, - DBRef = mongoO.DBRef, - BaseCommand = mongoO.BaseCommand, - InsertCommand = mongoO.InsertCommand, - UpdateCommand = mongoO.UpdateCommand, - DeleteCommand = mongoO.DeleteCommand, - GetMoreCommand = mongoO.GetMoreCommand, - KillCursorCommand = mongoO.KillCursorCommand, - QueryCommand = mongoO.QueryCommand, - MongoReply = mongoO.MongoReply, - BinaryParser = mongoO.BinaryParser; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -exports['Should Correctly Generate an Insert Command'] = function(test) { - var full_collection_name = "db.users"; - var insert_command = new InsertCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, full_collection_name); - insert_command.add({name: 'peter pan'}); - insert_command.add({name: 'monkey king'}); - // assert the length of the binary - test.equal(81, insert_command.toBinary().length); - test.done(); -} - -exports['Should Correctly Generate an Update Command'] = function(test) { - var full_collection_name = "db.users"; - var flags = UpdateCommand.DB_UPSERT; - var selector = {name: 'peter pan'}; - var document = {name: 'peter pan junior'}; - // Create the command - var update_command = new UpdateCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, full_collection_name, selector, document, flags); - // assert the length of the binary - test.equal(90, update_command.toBinary().length); - test.done(); -} - -exports['Should Correctly Generate a Delete Command'] = function(test) { - var full_collection_name = "db.users"; - var selector = {name: 'peter pan'}; - // Create the command - var delete_command = new DeleteCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, full_collection_name, selector); - // assert the length of the binary - test.equal(58, delete_command.toBinary().length); - test.done(); -} - -exports['Should Correctly Generate a Get More Command'] = function(test) { - var full_collection_name = "db.users"; - var numberToReturn = 100; - var cursorId = Long.fromNumber(10000222); - // Create the command - var get_more_command = new GetMoreCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, full_collection_name, numberToReturn, cursorId); - // assert the length of the binary - test.equal(41, get_more_command.toBinary().length); - test.done(); -} - -exports['Should Correctly Generate a Kill Cursors Command'] = function(test) { - Array.prototype.toXml = function() {} - var cursorIds = [Long.fromNumber(1), Long.fromNumber(10000222)]; - // Create the command - var kill_cursor_command = new KillCursorCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, cursorIds); - // assert the length of the binary - test.equal(40, kill_cursor_command.toBinary().length); - test.done(); -} - -exports['Should Correctly Generate a Query Command'] = function(test) { - var full_collection_name = "db.users"; - var options = QueryCommand.OPTS_SLAVE; - var numberToSkip = 100; - var numberToReturn = 200; - var query = {name:'peter pan'}; - var query_command = new QueryCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, full_collection_name, options, numberToSkip, numberToReturn, query, null); - // assert the length of the binary - test.equal(62, query_command.toBinary().length); - // Generate command with return field filter - query_command = new QueryCommand({bson: new BSON([Long, ObjectID, Binary, Code, DBRef, Symbol, Double, Timestamp, MaxKey, MinKey])}, full_collection_name, options, numberToSkip, numberToReturn, query, { a : 1, b : 1, c : 1}); - test.equal(88, query_command.toBinary().length); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/bson_types_test.js b/test/bson_types_test.js deleted file mode 100644 index 5b8574065e1..00000000000 --- a/test/bson_types_test.js +++ /dev/null @@ -1,215 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - Buffer = require('buffer').Buffer, - gleak = require('../dev/tools/gleak'), - fs = require('fs'), - BSON = mongodb.BSON, - Code = mongodb.Code, - Binary = mongodb.Binary, - Timestamp = mongodb.Timestamp, - Long = mongodb.Long, - MongoReply = mongodb.MongoReply, - ObjectID = mongodb.ObjectID, - Symbol = mongodb.Symbol, - DBRef = mongodb.DBRef, - Double = mongodb.Double, - MinKey = mongodb.MinKey, - MaxKey = mongodb.MaxKey, - BinaryParser = mongodb.BinaryParser; - -var BSONSE = mongodb, - BSONDE = mongodb; - -// for tests -BSONDE.BSON_BINARY_SUBTYPE_DEFAULT = 0; -BSONDE.BSON_BINARY_SUBTYPE_FUNCTION = 1; -BSONDE.BSON_BINARY_SUBTYPE_BYTE_ARRAY = 2; -BSONDE.BSON_BINARY_SUBTYPE_UUID = 3; -BSONDE.BSON_BINARY_SUBTYPE_MD5 = 4; -BSONDE.BSON_BINARY_SUBTYPE_USER_DEFINED = 128; - -BSONSE.BSON_BINARY_SUBTYPE_DEFAULT = 0; -BSONSE.BSON_BINARY_SUBTYPE_FUNCTION = 1; -BSONSE.BSON_BINARY_SUBTYPE_BYTE_ARRAY = 2; -BSONSE.BSON_BINARY_SUBTYPE_UUID = 3; -BSONSE.BSON_BINARY_SUBTYPE_MD5 = 4; -BSONSE.BSON_BINARY_SUBTYPE_USER_DEFINED = 128; - -var hexStringToBinary = function(string) { - var numberofValues = string.length / 2; - var array = ""; - - for(var i = 0; i < numberofValues; i++) { - array += String.fromCharCode(parseInt(string[i*2] + string[i*2 + 1], 16)); - } - return array; -} - -var assertBuffersEqual = function(test, buffer1, buffer2) { - if(buffer1.length != buffer2.length) test.fail("Buffers do not have the same length", buffer1, buffer2); - - for(var i = 0; i < buffer1.length; i++) { - test.equal(buffer1[i], buffer2[i]); - } -} - -/** - * Module for parsing an ISO 8601 formatted string into a Date object. - */ -var ISODate = function (string) { - var match; - - if (typeof string.getTime === "function") - return string; - else if (match = string.match(/^(\d{4})(-(\d{2})(-(\d{2})(T(\d{2}):(\d{2})(:(\d{2})(\.(\d+))?)?(Z|((\+|-)(\d{2}):(\d{2}))))?)?)?$/)) { - var date = new Date(); - date.setUTCFullYear(Number(match[1])); - date.setUTCMonth(Number(match[3]) - 1 || 0); - date.setUTCDate(Number(match[5]) || 0); - date.setUTCHours(Number(match[7]) || 0); - date.setUTCMinutes(Number(match[8]) || 0); - date.setUTCSeconds(Number(match[10]) || 0); - date.setUTCMilliseconds(Number("." + match[12]) * 1000 || 0); - - if (match[13] && match[13] !== "Z") { - var h = Number(match[16]) || 0, - m = Number(match[17]) || 0; - - h *= 3600000; - m *= 60000; - - var offset = h + m; - if (match[15] == "+") - offset = -offset; - - date = new Date(date.valueOf() + offset); - } - - return date; - } else - throw new Error("Invalid ISO 8601 date given.", __filename); -}; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -/** - * A simple example showing the usage of the binary put method. - * - * @_class binary - * @_function put - * @ignore - */ -exports.shouldCorrectUsePutForBinaryType = function(test) { - // Create an empty Binary object - var binary = new Binary(new Buffer(''), BSON.BSON_BINARY_SUBTYPE_DEFAULT); - // Write some character to the Binary value - binary.put('h'); - binary.put('e'); - binary.put('l'); - binary.put('l'); - binary.put('o'); - // Validate the content of the binary - test.equal('hello', binary.toString('ascii')); - test.done(); -} - -/** - * A simple example showing the usage of the binary write method. - * - * @_class binary - * @_function write - * @ignore - */ -exports.shouldCorrectUseWriteForBinaryType = function(test) { - // Create an empty Binary object - var binary = new Binary(new Buffer(''), BSON.BSON_BINARY_SUBTYPE_DEFAULT); - // Write some data to the binary - binary.write('hello', 0); - // Validate the content of the binary - test.equal('hello', binary.toString('ascii')); - test.done(); -} - -/** - * A simple example showing the usage of the binary read method. - * - * @_class binary - * @_function read - * @ignore - */ -exports.shouldCorrectUseReadForBinaryType = function(test) { - // Create an empty Binary object - var binary = new Binary(new Buffer(''), BSON.BSON_BINARY_SUBTYPE_DEFAULT); - // Write some data to the binary - binary.write('hello', 0); - // Read a couple of characters from the binary - var data = binary.read(1, 2); - // Validate the content of the binary - test.equal('el', data.toString('ascii')); - test.done(); -} - -/** - * A simple example showing the usage of the binary value method. - * - * @_class binary - * @_function value - * @ignore - */ -exports.shouldCorrectUseValueForBinaryType = function(test) { - // Create an empty Binary object - var binary = new Binary(new Buffer(''), BSON.BSON_BINARY_SUBTYPE_DEFAULT); - // Write some data to the binary - binary.write('hello', 0); - // Validate the content of the binary - test.equal('hello', binary.value()); - test.done(); -} - -/** - * A simple example showing the usage of the binary length method. - * - * @_class binary - * @_function length - * @ignore - */ -exports.shouldCorrectUseLengthForBinaryType = function(test) { - // Create an empty Binary object - var binary = new Binary(new Buffer(''), BSON.BSON_BINARY_SUBTYPE_DEFAULT); - // Write some data to the binary - binary.write('hello'); - // Validate the content of the binary - test.equal(5, binary.length()); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/certificates/mycert.pem b/test/certificates/mycert.pem deleted file mode 100644 index 954627cccd8..00000000000 --- a/test/certificates/mycert.pem +++ /dev/null @@ -1,36 +0,0 @@ ------BEGIN RSA PRIVATE KEY----- -Proc-Type: 4,ENCRYPTED -DEK-Info: DES-EDE3-CBC,5BC1D8935109F6C8 - -cbr7PTUV8ySzjBsvtCLng+0m7aez0D/Q76JnsW265oLxwqqID9mgS3rIZUgbu2SQ -+rfTTG+xcrONJs41Pbao1D1BNcUrmLF+8pl6055xFOPWrE1cxHQRShlhgG/pLVE3 -JqLFLV4Pd8Tf+o3FwbZ3zqgqwMPVZN/TLfzw94qcrXiidNvWuWf3oyU4w+CzD4Vt -f9HYNOeZWCUtaGGM5koUU/qu/RYQdKXZTRPz9wCHTjSsrznE4BpAJgtBbaOpr850 -c3WP48aveK9NZ9aoR1c+BW6MN+HPN2HhwA9rQUBSwfwlVVxxY1Ir2ArbP7fStlvK -TRtuE7Ro0ZEOUiHB5c9X7p6clKgshP7K19ZG6O0ns1P9d9z7l35f1WG/XQxA66tg -h8haN8nOtPJfrAyn5NcmOS2kTA0kL6Lk2TWwqoVErvpCRgdyhQ94GxjMiHLvkfxx -z5fVQqoXuYV8O6ozfdx+58qJnRTLC1cHf8iwWc9sDE/IP9OTpxwMUBKX4EYOL8MQ -4pjv0qnD/PQN4B5CbQ0RViBLykl22SScxqS3Zq14/sItEjM44ctjgAfmoPZSElTz -n9zhc8VQzgyjuNRt02xAi+tx2RD5I44ylm7QTYnXdWVgftnSgY+Ir4npTK5bnxIB -b9CLPljXbj8k5utoTyFkZa+bRES3a3+MEq5dNFRb0neQ3nJXqB83hMEDE35XWbU0 -gJwG7KsVS6Vr3SfBi47fsoIH1Ii92hZxWrtbTlzjy884zSps+mTWGA6TuU8jb6jn -b2JyNJDhVqDk19DPP+TtMv+GgXuoj7EXenQbwRXO/NVyaWpyBU7dHA== ------END RSA PRIVATE KEY----- ------BEGIN CERTIFICATE----- -MIIC4TCCAkqgAwIBAgIJAM0r5teNISyyMA0GCSqGSIb3DQEBBQUAMFUxCzAJBgNV -BAYTAkVTMRIwEAYDVQQIEwlCYXJjZWxvbmExEjAQBgNVBAcTCUJhcmNlbG9uYTEO -MAwGA1UEChMFMTBnZW4xDjAMBgNVBAMTBTEwZ2VuMB4XDTExMTIwMjEwMTcwM1oX -DTEyMTIwMTEwMTcwM1owVTELMAkGA1UEBhMCRVMxEjAQBgNVBAgTCUJhcmNlbG9u -YTESMBAGA1UEBxMJQmFyY2Vsb25hMQ4wDAYDVQQKEwUxMGdlbjEOMAwGA1UEAxMF -MTBnZW4wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAPBY5u20gJQAXw/m3hiY -kC1zqDt4lahjUauPUDeshceAuBIgQLePZwckR3caPqS1a1uPsKMQIKN1E/z781MY -iAdgRPwpQfKt1MRZRZdUVzOsGQdDtF1XEnIbQgdiahbXVqVeULLLuypWnw1ceAys -ESu8kWqPAm1eu+utqJOENXWpAgMBAAGjgbgwgbUwHQYDVR0OBBYEFN1iayQf9puR -3OZxEy/FtFv6YSRoMIGFBgNVHSMEfjB8gBTdYmskH/abkdzmcRMvxbRb+mEkaKFZ -pFcwVTELMAkGA1UEBhMCRVMxEjAQBgNVBAgTCUJhcmNlbG9uYTESMBAGA1UEBxMJ -QmFyY2Vsb25hMQ4wDAYDVQQKEwUxMGdlbjEOMAwGA1UEAxMFMTBnZW6CCQDNK+bX -jSEssjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GBAOvATDKZ95epzVjV -qGnaHgu4u6NJuvZlGmBl2Mq/EA2ymw2LL+Pt38BqyQWvO/5TlxF1EFhH3kl6RENw -9U7C+w8tqhQL3hQsTASdX9gTczaYgHwHsKLc2JFcC7J2ffXM0aW5wUCKUwvvtf/h -7rUWJPi+evtVGTxRhCQGJcoI9lEK ------END CERTIFICATE----- diff --git a/test/collection_test.js b/test/collection_test.js deleted file mode 100644 index 15aa32fcccb..00000000000 --- a/test/collection_test.js +++ /dev/null @@ -1,1189 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Long = require('../lib/mongodb/bson/long').Long, - Step = require("step"), - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * Example of a simple document save with safe set to false - * - * @_class collection - * @_function save - * @ignore - */ -exports.shouldCorrectlySaveASimpleDocument = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch the collection - db.collection("save_a_simple_document", function(err, collection) { - - // Save a document with no safe option - collection.save({hello:'world'}); - - // Wait for a second - setTimeout(function() { - - // Find the saved document - collection.findOne({hello:'world'}, function(err, item) { - test.equal(null, err); - test.equal('world', item.hello); - db.close(); - test.done(); - }); - }, 1000); - }); - }); -} - -/** - * Example of a simple document save and then resave with safe set to true - * - * @_class collection - * @_function save - * @ignore - */ -exports.shouldCorrectlySaveASimpleDocumentModifyItAndResaveIt = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch the collection - db.collection("save_a_simple_document_modify_it_and_resave_it", function(err, collection) { - - // Save a document with no safe option - collection.save({hello:'world'}, {safe:true}, function(err, result) { - - // Find the saved document - collection.findOne({hello:'world'}, function(err, item) { - test.equal(null, err); - test.equal('world', item.hello); - - // Update the document - item['hello2'] = 'world2'; - - // Save the item with the additional field - collection.save(item, {safe:true}, function(err, result) { - - // Find the changed document - collection.findOne({hello:'world'}, function(err, item) { - test.equal(null, err); - test.equal('world', item.hello); - test.equal('world2', item.hello2); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectExecuteBasicCollectionMethods = function(test) { - client.createCollection('test_collection_methods', function(err, collection) { - // Verify that all the result are correct coming back (should contain the value ok) - test.equal('test_collection_methods', collection.collectionName); - // Let's check that the collection was created correctly - client.collectionNames(function(err, documents) { - var found = false; - documents.forEach(function(document) { - if(document.name == "integration_tests_.test_collection_methods") found = true; - }); - test.ok(true, found); - // Rename the collection and check that it's gone - client.renameCollection("test_collection_methods", "test_collection_methods2", function(err, reply) { - test.equal(null, err); - // Drop the collection and check that it's gone - client.dropCollection("test_collection_methods2", function(err, result) { - test.equal(true, result); - test.done(); - }) - }); - }); - }) -} - -/** - * @ignore - */ -exports.shouldAccessToCollections = function(test) { - // Create two collections - client.createCollection('test.spiderman', function(r) { - client.createCollection('test.mario', function(r) { - // Insert test documents (creates collections) - client.collection('test.spiderman', function(err, spiderman_collection) { - spiderman_collection.insert({foo:5}, {safe:true}, function(err, r) { - - client.collection('test.mario', function(err, mario_collection) { - mario_collection.insert({bar:0}, {safe:true}, function(err, r) { - // Assert collections - client.collections(function(err, collections) { - var found_spiderman = false; - var found_mario = false; - var found_does_not_exist = false; - - collections.forEach(function(collection) { - if(collection.collectionName == "test.spiderman") found_spiderman = true; - if(collection.collectionName == "test.mario") found_mario = true; - if(collection.collectionName == "does_not_exist") found_does_not_exist = true; - }); - - test.ok(found_spiderman); - test.ok(found_mario); - test.ok(!found_does_not_exist); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyDropCollection = function(test) { - client.createCollection('test_drop_collection2', function(err, r) { - client.dropCollection('test_drop_collection', function(err, r) { - test.ok(err instanceof Error); - test.equal("ns not found", err.message); - var found = false; - // Ensure we don't have the collection in the set of names - client.collectionNames(function(err, replies) { - replies.forEach(function(err, document) { - if(document.name == "test_drop_collection") { - found = true; - return; - } - }); - // If we have an instance of the index throw and error - if(found) throw new Error("should not fail"); - // Let's close the db - test.done(); - }); - }); - }); -} - -/** - * Example of a simple document save and then resave with safe set to true - * - * @_class collection - * @_function drop - * @ignore - */ -exports.shouldCorrectlyDropCollectionWithDropFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('test_other_drop', function(err, collection) { - test.equal(null, err); - - // Drop the collection - collection.drop(function(err, reply) { - - // Ensure we don't have the collection in the set of names - db.collectionNames(function(err, replies) { - - var found = false; - // For each collection in the list of collection names in this db look for the - // dropped collection - replies.forEach(function(document) { - if(document.name == "test_other_drop") { - found = true; - return; - } - }); - - // Ensure the collection is not found - test.equal(false, found); - - // Let's close the db - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyRetriveCollectionNames = function(test) { - client.createCollection('test_collection_names', function(err, r) { - client.collectionNames(function(err, documents) { - var found = false; - var found2 = false; - documents.forEach(function(document) { - if(document.name == MONGODB + '.test_collection_names') found = true; - }); - test.ok(found); - // Insert a document in an non-existing collection should create the collection - client.collection('test_collection_names2', function(err, collection) { - collection.insert({a:1}, {safe:true}, function(err, r) { - client.collectionNames(function(err, documents) { - documents.forEach(function(document) { - if(document.name == MONGODB + '.test_collection_names2') found = true; - if(document.name == MONGODB + '.test_collection_names') found2 = true; - }); - - test.ok(found); - test.ok(found2); - // Let's close the db - test.done(); - }); - }) - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyRetrieveCollectionInfo = function(test) { - client.createCollection('test_collections_info', function(err, r) { - client.collectionsInfo(function(err, cursor) { - test.ok((cursor instanceof Cursor)); - // Fetch all the collection info - cursor.toArray(function(err, documents) { - test.ok(documents.length > 1); - - var found = false; - documents.forEach(function(document) { - if(document.name == MONGODB + '.test_collections_info') found = true; - }); - test.ok(found); - // Let's close the db - test.done(); - }); - }); - }); -} - -/** - * An example returning the options for a collection. - * - * @_class collection - * @_function options - */ -exports.shouldCorrectlyRetriveCollectionOptions = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a test collection that we are getting the options back from - db.createCollection('test_collection_options', {'capped':true, 'size':1024}, function(err, collection) { - test.ok(collection instanceof Collection); - test.equal('test_collection_options', collection.collectionName); - - // Let's fetch the collection options - collection.options(function(err, options) { - test.equal(true, options.capped); - test.equal(1024, options.size); - test.equal("test_collection_options", options.create); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * An example showing how to establish if it's a capped collection - * - * @_class collection - * @_function isCapped - */ -exports.shouldCorrectlyExecuteIsCapped = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a test collection that we are getting the options back from - db.createCollection('test_collection_is_capped', {'capped':true, 'size':1024}, function(err, collection) { - test.ok(collection instanceof Collection); - test.equal('test_collection_is_capped', collection.collectionName); - - // Let's fetch the collection options - collection.isCapped(function(err, capped) { - test.equal(true, capped); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * An example showing the use of the indexExists function for a single index name and a list of index names. - * - * @_class collection - * @_function indexExists - */ -exports.shouldCorrectlyExecuteIndexExists = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a test collection that we are getting the options back from - db.createCollection('test_collection_index_exists', function(err, collection) { - test.equal(null, err); - - // Create an index on the collection - collection.createIndex('a', function(err, indexName) { - - // Let's test to check if a single index exists - collection.indexExists("a_1", function(err, result) { - test.equal(true, result); - - // Let's test to check if multiple indexes are available - collection.indexExists(["a_1", "_id_"], function(err, result) { - test.equal(true, result); - - // Check if a non existing index exists - collection.indexExists("c_1", function(err, result) { - test.equal(false, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldEnsureStrictAccessCollection = function(test) { - var error_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, ssl:useSSL}), {strict:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - test.equal(true, error_client.strict); - - error_client.open(function(err, error_client) { - error_client.collection('does-not-exist', function(err, collection) { - test.ok(err instanceof Error); - test.equal("Collection does-not-exist does not exist. Currently in strict mode.", err.message); - }); - - error_client.createCollection('test_strict_access_collection', function(err, collection) { - error_client.collection('test_strict_access_collection', function(err, collection) { - test.ok(collection instanceof Collection); - // Let's close the db - error_client.close(); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldPerformStrictCreateCollection = function(test) { - var error_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, ssl:useSSL}), {strict:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - test.equal(true, error_client.strict); - - error_client.open(function(err, error_client) { - error_client.createCollection('test_strict_create_collection', function(err, collection) { - test.ok(collection instanceof Collection); - - // Creating an existing collection should fail - error_client.createCollection('test_strict_create_collection', function(err, collection) { - test.ok(err instanceof Error); - test.equal("Collection test_strict_create_collection already exists. Currently in strict mode.", err.message); - - // Switch out of strict mode and try to re-create collection - error_client.strict = false; - error_client.createCollection('test_strict_create_collection', function(err, collection) { - test.ok(collection instanceof Collection); - - // Let's close the db - error_client.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldFailToInsertDueToIllegalKeys = function(test) { - client.createCollection('test_invalid_key_names', function(err, collection) { - // Legal inserts - collection.insert([{'hello':'world'}, {'hello':{'hello':'world'}}], {safe:true}, function(err, r) { - // Illegal insert for key - collection.insert({'$hello':'world'}, {safe:true}, function(err, doc) { - test.ok(err instanceof Error); - test.equal("key $hello must not start with '$'", err.message); - - collection.insert({'hello':{'$hello':'world'}}, {safe:true}, function(err, doc) { - test.ok(err instanceof Error); - test.equal("key $hello must not start with '$'", err.message); - - collection.insert({'he$llo':'world'}, {safe:true}, function(err, docs) { - test.ok(docs[0].constructor == Object); - - collection.insert({'hello':{'hell$o':'world'}}, {safe:true}, function(err, docs) { - test.ok(err == null); - - collection.insert({'.hello':'world'}, {safe:true}, function(err, doc) { - test.ok(err instanceof Error); - test.equal("key .hello must not contain '.'", err.message); - - collection.insert({'hello':{'.hello':'world'}}, {safe:true}, function(err, doc) { - test.ok(err instanceof Error); - test.equal("key .hello must not contain '.'", err.message); - - collection.insert({'hello.':'world'}, {safe:true}, function(err, doc) { - test.ok(err instanceof Error); - test.equal("key hello. must not contain '.'", err.message); - - collection.insert({'hello':{'hello.':'world'}}, {safe:true}, function(err, doc) { - test.ok(err instanceof Error); - test.equal("key hello. must not contain '.'", err.message); - // Let's close the db - test.done(); - }); - }); - }); - }); - }) - }) - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldFailDueToIllegalCollectionNames = function(test) { - client.collection(5, function(err, collection) { - test.equal("collection name must be a String", err.message); - }); - - client.collection("", function(err, collection) { - test.equal("collection names cannot be empty", err.message); - }); - - client.collection("te$t", function(err, collection) { - test.equal("collection names must not contain '$'", err.message); - }); - - client.collection(".test", function(err, collection) { - test.equal("collection names must not start or end with '.'", err.message); - }); - - client.collection("test.", function(err, collection) { - test.equal("collection names must not start or end with '.'", err.message); - }); - - client.collection("test..t", function(err, collection) { - test.equal("collection names cannot be empty", err.message); - test.done(); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyCountOnNonExistingCollection = function(test) { - client.collection('test_multiple_insert_2', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - // Let's close the db - test.done(); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteSave = function(test) { - client.createCollection('test_save', function(err, collection) { - var doc = {'hello':'world'}; - collection.save(doc, {safe:true}, function(err, docs) { - test.ok(docs._id instanceof ObjectID || Object.prototype.toString.call(docs._id) === '[object ObjectID]'); - - collection.count(function(err, count) { - test.equal(1, count); - doc = docs; - - collection.save(doc, {safe:true}, function(err, doc2) { - - collection.count(function(err, count) { - test.equal(1, count); - - collection.findOne(function(err, doc3) { - test.equal('world', doc3.hello); - - doc3.hello = 'mike'; - - collection.save(doc3, {safe:true}, function(err, doc4) { - collection.count(function(err, count) { - test.equal(1, count); - - collection.findOne(function(err, doc5) { - test.equal('mike', doc5.hello); - - // Save another document - collection.save({hello:'world'}, {safe:true}, function(err, doc) { - collection.count(function(err, count) { - test.equal(2, count); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveDocumentWithLongValue = function(test) { - client.createCollection('test_save_long', function(err, collection) { - collection.insert({'x':Long.fromNumber(9223372036854775807)}, {safe:true}, function(err, r) { - collection.findOne(function(err, doc) { - test.ok(Long.fromNumber(9223372036854775807).equals(doc.x)); - // Let's close the db - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldSaveObjectThatHasIdButDoesNotExistInCollection = function(test) { - client.createCollection('test_save_with_object_that_has_id_but_does_not_actually_exist_in_collection', function(err, collection) { - var a = {'_id':'1', 'hello':'world'}; - collection.save(a, {safe:true}, function(err, docs) { - collection.count(function(err, count) { - test.equal(1, count); - - collection.findOne(function(err, doc) { - test.equal('world', doc.hello); - - doc.hello = 'mike'; - collection.save(doc, {safe:true}, function(err, doc) { - collection.count(function(err, count) { - test.equal(1, count); - }); - - collection.findOne(function(err, doc) { - test.equal('mike', doc.hello); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformUpsert = function(test) { - client.createCollection('test_should_correctly_do_upsert', function(err, collection) { - var id = new ObjectID(null) - var doc = {_id:id, a:1}; - - Step( - function test1() { - var self = this; - - collection.update({"_id":id}, doc, {upsert:true, safe:true}, function(err, result) { - test.equal(null, err); - test.equal(1, result); - - collection.findOne({"_id":id}, self); - }); - }, - - function test2(err, doc) { - var self = this; - test.equal(1, doc.a); - - id = new ObjectID(null) - doc = {_id:id, a:2}; - - collection.update({"_id":id}, doc, {safe:true, upsert:true}, function(err, result) { - test.equal(null, err); - test.equal(1, result); - - collection.findOne({"_id":id}, self); - }); - }, - - function test3(err, doc2) { - var self = this; - test.equal(2, doc2.a); - - collection.update({"_id":id}, doc2, {safe:true, upsert:true}, function(err, result) { - test.equal(null, err); - test.equal(1, result); - - collection.findOne({"_id":id}, function(err, doc) { - test.equal(2, doc.a); - test.done(); - }); - }); - } - ); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyUpdateWithNoDocs = function(test) { - client.createCollection('test_should_correctly_do_update_with_no_docs', function(err, collection) { - var id = new ObjectID(null) - var doc = {_id:id, a:1}; - collection.update({"_id":id}, doc, {safe:true}, function(err, numberofupdateddocs) { - test.equal(null, err); - test.equal(0, numberofupdateddocs); - - test.done(); - }); - }); -} - -/** - * Example of a simple document update with safe set to false on an existing document - * - * @_class collection - * @_function update - */ -exports.shouldCorrectlyUpdateASimpleDocument = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Get a collection - db.collection('update_a_simple_document', function(err, collection) { - - // Insert a document, then update it - collection.insert({a:1}, {safe:true}, function(err, doc) { - - // Update the document with an atomic operator - collection.update({a:1}, {$set:{b:2}}); - - // Wait for a second then fetch the document - setTimeout(function() { - - // Fetch the document that we modified - collection.findOne({a:1}, function(err, item) { - test.equal(null, err); - test.equal(1, item.a); - test.equal(2, item.b); - db.close(); - test.done(); - }); - }, 1000); - }) - }); - }); -} - -/** - * Example of a simple document update using upsert (the document will be inserted if it does not exist) - * - * @_class collection - * @_function update - * @ignore - */ -exports.shouldCorrectlyUpsertASimpleDocument = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Get a collection - db.collection('update_a_simple_document_upsert', function(err, collection) { - - // Update the document using an upsert operation, ensuring creation if it does not exist - collection.update({a:1}, {b:2, a:1}, {upsert:true, safe:true}, function(err, result) { - test.equal(null, err); - test.equal(1, result); - - // Fetch the document that we modified and check if it got inserted correctly - collection.findOne({a:1}, function(err, item) { - test.equal(null, err); - test.equal(1, item.a); - test.equal(2, item.b); - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * Example of an update across multiple documents using the multi option. - * - * @_class collection - * @_function update - * @ignore - */ -exports.shouldCorrectlyUpdateMultipleDocuments = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Get a collection - db.collection('update_a_simple_document_multi', function(err, collection) { - - // Insert a couple of documentations - collection.insert([{a:1, b:1}, {a:1, b:2}], {safe:true}, function(err, result) { - - // Update multiple documents using the multi option - collection.update({a:1}, {$set:{b:0}}, {safe:true, multi:true}, function(err, numberUpdated) { - test.equal(null, err); - test.equal(2, numberUpdated); - - // Fetch all the documents and verify that we have changed the b value - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(1, items[0].a); - test.equal(0, items[0].b); - test.equal(1, items[1].a); - test.equal(0, items[1].b); - - db.close(); - test.done(); - }); - }) - }); - }); - }); -} - -/** - * Example of running the distinct command against a collection - * - * @_class collection - * @_function distinct - * @ignore - */ -exports.shouldCorrectlyHandleDistinctIndexes = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Crete the collection for the distinct example - db.createCollection('simple_key_based_distinct', function(err, collection) { - - // Insert documents to perform distinct against - collection.insert([{a:0, b:{c:'a'}}, {a:1, b:{c:'b'}}, {a:1, b:{c:'c'}}, - {a:2, b:{c:'a'}}, {a:3}, {a:3}], {safe:true}, function(err, ids) { - - // Peform a distinct query against the a field - collection.distinct('a', function(err, docs) { - test.deepEqual([0, 1, 2, 3], docs.sort()); - - // Perform a distinct query against the sub-field b.c - collection.distinct('b.c', function(err, docs) { - test.deepEqual(['a', 'b', 'c'], docs.sort()); - - db.close(); - test.done(); - }); - }); - }) - }); - }); -} - -/** - * Example of running the distinct command against a collection with a filter query - * - * @_class collection - * @_function distinct - * @ignore - */ -exports.shouldCorrectlyHandleDistinctIndexesWithSubQueryFilter = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Crete the collection for the distinct example - db.createCollection('simple_key_based_distinct_sub_query_filter', function(err, collection) { - - // Insert documents to perform distinct against - collection.insert([{a:0, b:{c:'a'}}, {a:1, b:{c:'b'}}, {a:1, b:{c:'c'}}, - {a:2, b:{c:'a'}}, {a:3}, {a:3}, {a:5, c:1}], {safe:true}, function(err, ids) { - - // Peform a distinct query with a filter against the documents - collection.distinct('a', {c:1}, function(err, docs) { - test.deepEqual([5], docs.sort()); - - db.close(); - test.done(); - }); - }) - }); - }); -} - -/** - * Example of running simple count commands against a collection. - * - * @_class collection - * @_function count - * @ignore - */ -exports.shouldCorrectlyDoSimpleCountExamples = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Crete the collection for the distinct example - db.createCollection('simple_count_example', function(err, collection) { - - // Insert documents to perform distinct against - collection.insert([{a:1}, {a:2}, {a:3}, {a:4, b:1}], {safe:true}, function(err, ids) { - - // Perform a total count command - collection.count(function(err, count) { - test.equal(null, err); - test.equal(4, count); - - // Peform a partial account where b=1 - collection.count({b:1}, function(err, count) { - test.equal(null, err); - test.equal(1, count); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteInsertUpdateDeleteSafeMode = function(test) { - client.createCollection('test_should_execute_insert_update_delete_safe_mode', function(err, collection) { - test.ok(collection instanceof Collection); - test.equal('test_should_execute_insert_update_delete_safe_mode', collection.collectionName); - - collection.insert({i:1}, {safe:true}, function(err, ids) { - test.equal(1, ids.length); - test.ok(ids[0]._id.toHexString().length == 24); - - // Update the record - collection.update({i:1}, {"$set":{i:2}}, {safe:true}, function(err, result) { - test.equal(null, err); - test.equal(1, result); - - // Remove safely - collection.remove({}, {safe:true}, function(err, result) { - test.equal(null, err); - - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldPerformMultipleSaves = function(test) { - client.createCollection("multiple_save_test", function(err, collection) { - var doc = { - name: 'amit', - text: 'some text' - }; - - //insert new user - collection.save(doc, {safe:true}, function(err, r) { - collection.find({}, {name: 1}).limit(1).toArray(function(err, users){ - var user = users[0] - - if(err) { - throw new Error(err) - } else if(user) { - user.pants = 'worn' - - collection.save(user, {safe:true}, function(err, result){ - test.equal(null, err); - test.equal(1, result); - - test.done(); - }) - } - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveDocumentWithNestedArray = function(test) { - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, db) { - db.createCollection("save_error_on_save_test", function(err, collection) { - // Create unique index for username - collection.createIndex([['username', 1]], true, function(err, result) { - var doc = { - email: 'email@email.com', - encrypted_password: 'password', - friends: - [ '4db96b973d01205364000006', - '4db94a1948a683a176000001', - '4dc77b24c5ba38be14000002' ], - location: [ 72.4930088, 23.0431957 ], - name: 'Amit Kumar', - password_salt: 'salty', - profile_fields: [], - username: 'amit' }; - //insert new user - collection.save(doc, {safe:true}, function(err, doc) { - - collection.find({}).limit(1).toArray(function(err, users) { - test.equal(null, err); - var user = users[0] - user.friends.splice(1,1) - - collection.save(user, function(err, doc) { - test.equal(null, err); - - // Update again - collection.update({_id:new ObjectID(user._id.toString())}, {friends:user.friends}, {upsert:true, safe:true}, function(err, result) { - test.equal(null, err); - test.equal(1, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldPeformCollectionRemoveWithNoCallback = function(test) { - client.collection("remove_with_no_callback_bug_test", function(err, collection) { - collection.save({a:1}, {safe:true}, function(){ - collection.save({b:1}, {safe:true}, function(){ - collection.save({c:1}, {safe:true}, function(){ - collection.remove({a:1}, {safe:true}, function() { - // Let's perform a count - collection.count(function(err, count) { - test.equal(null, err); - test.equal(2, count); - test.done(); - }); - }) - }); - }); - }); - }); -}, - -/** - * Example of retrieving a collections indexes - * - * @_class collection - * @_function indexes - * @ignore - */ -exports.shouldCorrectlyRetriveACollectionsIndexes = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Crete the collection for the distinct example - db.createCollection('simple_key_based_distinct', function(err, collection) { - - // Create a geo 2d index - collection.ensureIndex({loc:"2d"}, function(err, result) { - test.equal(null, err); - - // Create a simple single field index - collection.ensureIndex({a:1}, function(err, result) { - test.equal(null, err); - - // List all of the indexes on the collection - collection.indexes(function(err, indexes) { - test.equal(3, indexes.length); - - db.close(); - test.done(); - }); - }) - }) - }); - }); -} - -/** - * Example of retrieving a collections stats - * - * @_class collection - * @_function stats - * @ignore - */ -exports.shouldCorrectlyReturnACollectionsStats = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Crete the collection for the distinct example - db.createCollection('collection_stats_test', function(err, collection) { - - // Insert some documents - collection.insert([{a:1}, {hello:'world'}], {safe:true}, function(err, result) { - - // Retrieve the statistics for the collection - collection.stats(function(err, stats) { - test.equal(2, stats.count); - - db.close(); - test.done(); - }); - }); - }); - }); -} - - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/connect_test.js b/test/connect_test.js deleted file mode 100644 index 564c6fea66a..00000000000 --- a/test/connect_test.js +++ /dev/null @@ -1,147 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - connect = mongodb.connect, - gleak = require('../dev/tools/gleak'), - Script = require('vm'), - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var clientUrl = 'mongo://localhost:27017/' + MONGODB + (useSSL == true ? '?ssl=true' : ''); - -/** - * @ignore - */ -function connectionTester(test, testName) { - return function(err, db) { - test.equal(err, null); - db.collection(testName, function(err, collection) { - test.equal(err, null); - var doc = {foo:123}; - collection.insert({foo:123}, {safe:true}, function(err, docs) { - test.equal(err, null); - db.dropDatabase(function(err, done) { - db.close(); - test.equal(err, null); - test.ok(done); - test.done(); - }); - }); - }); - }; -}; - -/** - * @ignore - */ -exports.testConnectNoOptions = function(test) { - connect(clientUrl, connectionTester(test, 'testConnectNoOptions')); -}; - -/** - * @ignore - */ -exports.testConnectDbOptions = function(test) { - connect(clientUrl, - { db: {native_parser: (process.env['TEST_NATIVE'] != null)} }, - connectionTester(test, 'testConnectDbOptions')); -}; - -/** - * @ignore - */ -exports.testConnectServerOptions = function(test) { - connect(clientUrl, - { server: {auto_reconnect: true, poolSize: 4} }, - connectionTester(test, 'testConnectServerOptions')); -}; - -/** - * @ignore - */ -exports.testConnectAllOptions = function(test) { - connect(clientUrl, - { server: {auto_reconnect: true, poolSize: 4}, - db: {native_parser: (process.env['TEST_NATIVE'] != null)} }, - connectionTester(test, 'testConnectAllOptions')); -}; - -/** - * @ignore - */ -exports.testConnectGoodAuth = function(test) { - var user = 'testConnectGoodAuth', password = 'password'; - // First add a user. - connect(clientUrl, function(err, db) { - test.equal(err, null); - db.addUser(user, password, function(err, result) { - test.equal(err, null); - db.close(); - restOfTest(); - }); - }); - - function restOfTest() { - var url = 'mongo://' + user + ':' + password + '@localhost:27017/' + MONGODB + (useSSL == true ? '?ssl=true' : ''); - connect(url, connectionTester(test, 'testConnectGoodAuth')); - } -}; - -/** - * @ignore - */ -exports.testConnectBadAuth = function(test) { - var url = 'mongo://slithy:toves@localhost:27017/' + MONGODB + (useSSL == true ? '?ssl=true' : ''); - connect(url, function(err, db) { - test.ok(err); - test.ok(db); - db.close(); - test.done(); - }); -}; - -/** - * @ignore - */ -exports.testConnectBadUrl = function(test) { - test.throws(function() { - connect('mango://localhost:27017/' + MONGODB, function(err, db) { - test.ok(false, 'Bad URL!'); - }); - }); - test.done(); -}; - -/** - * Example of a simple url connection string. - * - * @_class db - * @_function Db.connect - * @ignore - */ -exports.shouldCorrectlyDoSimpleCountExamples = function(test) { - // Connect to the server - Db.connect('mongodb://localhost:27017/integration_tests' + (useSSL == true ? '?ssl=true' : ''), function(err, db) { - test.equal(null, err); - - db.close(); - test.done(); - }); -} - - -/** - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} diff --git a/test/connection/connection_pool_test.js b/test/connection/connection_pool_test.js deleted file mode 100644 index a3d6abe7474..00000000000 --- a/test/connection/connection_pool_test.js +++ /dev/null @@ -1,102 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - Buffer = require('buffer').Buffer, - gleak = require('../../dev/tools/gleak'), - fs = require('fs'), - ConnectionPool = require('../../lib/mongodb/connection/connection_pool').ConnectionPool; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -exports['Should Correctly create a pool instance with the expected values'] = function(test) { - var connectionPool = new ConnectionPool('localhost', 2000, 1, null, {timeout:100, noDelay:true}); - test.equal(100, connectionPool.socketOptions.timeout); - test.equal(true, connectionPool.socketOptions.noDelay); - test.equal(null, connectionPool.socketOptions.encoding); - test.equal(0, connectionPool.socketOptions.bufferSize); - test.done(); -} - -exports['Should correctly fail due to no server'] = function(test) { - var connectionPool = new ConnectionPool('localhost', 2000, 4, null, {timeout:100, noDelay:true}); - - // // Add event handler that will fire once the pool is ready - connectionPool.on("poolReady", function(err, result) { - }) - - // Add event handler that will fire when it fails - connectionPool.on("error", function(err, connection) { - test.equal(0, connectionPool.connections.length) - test.equal(0, connectionPool.openConnections.length) - test.done(); - }); - - // Start the pool - connectionPool.start(); -} - -exports['Should Correctly create a pool of connections and receive an ok when all connections are active'] = function(test) { - var connectionPool = new ConnectionPool('localhost', 27017, 4, {timeout:100, noDelay:true}); - - // Add event handler that will fire once the pool is ready - connectionPool.on("poolReady", function() { - connectionPool.stop(); - test.done(); - }) - - // Start the pool - connectionPool.start(); -} - -exports['Should Correctly connect and then force a restart creating new connections'] = function(test) { - var connectionPool = new ConnectionPool('localhost', 27017, 4, {timeout:100, noDelay:true}); - var done = false; - - // Add event handler that will fire once the pool is ready - connectionPool.on("poolReady", function() { - // Restart - if(done) { - connectionPool.stop(); - test.done(); - } else { - // Trigger stop - connectionPool.restart(); - done = true; - } - }) - - // Start the pool - connectionPool.start(); -}, - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/connection/message_parser_test.js b/test/connection/message_parser_test.js deleted file mode 100644 index 1052dcae89f..00000000000 --- a/test/connection/message_parser_test.js +++ /dev/null @@ -1,436 +0,0 @@ -// var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - Buffer = require('buffer').Buffer, - gleak = require('../../dev/tools/gleak'), - Connection = require('../../lib/mongodb/connection/connection').Connection; - -var assertBuffersEqual = function(test, buffer1, buffer2) { - if(buffer1.length != buffer2.length) test.fail("Buffers do not have the same length", buffer1, buffer2); - - for(var i = 0; i < buffer1.length; i++) { - test.equal(buffer1[i], buffer2[i]); - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - callback(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - callback(); -} - -exports['Should correctly parse perfectly aligned message from socket'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(10); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer, data); - test.done(); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer); -}, - -exports['Should correctly parse perfectly aligned double message from socket'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(20); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Adjust the index - index = index + 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - buffer[index+4] = 0xa; - - // var result index - var resultIndex = 0; - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer.slice(resultIndex, resultIndex + 10), data); - resultIndex = resultIndex + 10; - - if(resultIndex === buffer.length) { - test.done(); - } - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - // Execute parsing of message - dataHandler(buffer); -} - -exports['Should correctly parse message + in two packets from socket'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(10); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer, data); - test.done(); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6)); -}, - -exports['Should correctly parse message + in two packets from socket and partial third one'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(20); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Adjust the index - index = index + 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - buffer[index + 4] = 0xff; - buffer[index + 5] = 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer.slice(0, 10), data); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 15)); - - // Check status of the parser - test.equal(5, self.bytesRead); - test.equal(10, self.sizeOfMessage); - assertBuffersEqual(test, buffer.slice(10, 15), self.buffer.slice(0, 5)); - test.equal(null, self.stubBuffer); - // Finish test - test.done(); -} - -exports['Should correctly parse message + in two packets from socket and smaller than 4 bytes additional one'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(20); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Adjust the index - index = index + 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer.slice(0, 10), data); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 13)); - - // Check status of the parser - test.equal(0, self.bytesRead); - test.equal(0, self.sizeOfMessage); - test.equal(null, self.buffer); - assertBuffersEqual(test, buffer.slice(10, 13), self.stubBuffer); - test.done(); -} - -exports['Should correctly parse message + in two packets from socket and smaller than 4 bytes additional one then rest of the message'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(20); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Adjust the index - index = index + 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - buffer[index + 4] = 0xff; - buffer[index + 5] = 0xff; - buffer[index + 6] = 0xff; - buffer[index + 7] = 0xff; - buffer[index + 8] = 0xfd; - buffer[index + 9] = 0xfe; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer.slice(0, 10), data); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 13)); - dataHandler(buffer.slice(13, 19)); - - // Check status of the parser - test.equal(9, self.bytesRead); - test.equal(10, self.sizeOfMessage); - test.equal(null, self.stubBuffer); - assertBuffersEqual(test, buffer.slice(10, 19), self.buffer.slice(0, 9)); - // Test done - test.done(); -} - -exports['Should correctly parse message + in two packets from socket and smaller than 4 bytes additional one then partial message'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(20); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Adjust the index - index = index + 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - // Add data to check - buffer[index + 4] = 0xff; - buffer[index + 5] = 0xff; - buffer[index + 6] = 0xff; - buffer[index + 7] = 0xff; - buffer[index + 8] = 0xfd; - buffer[index + 9] = 0xfe; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer.slice(0, 10), data); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 13)); - dataHandler(buffer.slice(13, 15)); - - // Check status of the parser - test.equal(5, self.bytesRead); - test.equal(10, self.sizeOfMessage); - test.equal(null, self.stubBuffer); - assertBuffersEqual(test, buffer.slice(10, 15), self.buffer.slice(0, 5)); - // Test done - test.done(); -} - -exports['Should correctly parse message + in two packets from socket and smaller than 4 bytes additional one then partial message'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(40); - var value = 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - var value = 20; - // Adjust the index - index = index + 10; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - var value = 15; - // Adjust the index - index = index + 20; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - assertBuffersEqual(test, buffer.slice(0, 10), data); - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 15)); - dataHandler(buffer.slice(15, 27)); - - // Check status of the parser - test.equal(17, self.bytesRead); - test.equal(20, self.sizeOfMessage); - test.equal(null, self.stubBuffer); - assertBuffersEqual(test, buffer.slice(10, 27), self.buffer.slice(0, 17)); - // Test done - test.done(); -} - -exports['Corrupt the message baby'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(40); - var value = -40; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - test.equal('parseError', message) - // test.equal('socketHandler', data.err) - }}; - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 15)); - dataHandler(buffer.slice(15, 27)); - test.done(); -} - -exports['Corrupt the message baby but catch the log error'] = function(test) { - // Data object - var index = 0; - var buffer = new Buffer(40); - for(var i = 0; i < buffer.length; i++) buffer[i] = 0; - var value = -40; - // Encode length at start according to wire protocol - buffer[index + 3] = (value >> 24) & 0xff; - buffer[index + 2] = (value >> 16) & 0xff; - buffer[index + 1] = (value >> 8) & 0xff; - buffer[index] = value & 0xff; - - // Dummy object for receiving message - var self = {maxBsonSize: (4 * 1024 * 1024 * 4 * 3), emit:function(message, data) { - test.equal('parseError', message) - }}; - - // Count the number of errors - var totalCountOfErrors = 0; - - // Add a logger object - self.logger = { - doDebug:true, - doError:true, - doLog:true, - - error:function(message, object) { - totalCountOfErrors = totalCountOfErrors + 1; - if(totalCountOfErrors == 3) { - test.done(); - } - }, - - log:function(message, object) { - }, - - debug:function(message, object) { - } - } - - // Create a connection object - var dataHandler = Connection.createDataHandler(self); - - // Execute parsing of message - dataHandler(buffer.slice(0, 6)); - dataHandler(buffer.slice(6, 15)); - dataHandler(buffer.slice(15, 27)); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} \ No newline at end of file diff --git a/test/connection_test.js b/test/connection_test.js deleted file mode 100644 index 54abf61df14..00000000000 --- a/test/connection_test.js +++ /dev/null @@ -1,170 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - connect = mongodb.connect, - Script = require('vm'), - Collection = mongodb.Collection, - Server = mongodb.Server, - ServerManager = require('../test/tools/server_manager').ServerManager, - mongodb = require('../lib/mongodb'); - -// Test db -var MONGODB = 'integration_tests'; -var client = null; - -function connectionTester(test, testName, callback) { - return function(err, db) { - test.equal(err, null); - db.collection(testName, function(err, collection) { - test.equal(err, null); - var doc = {foo:123}; - collection.insert({foo:123}, {safe:true}, function(err, docs) { - test.equal(err, null); - db.dropDatabase(function(err, done) { - test.equal(err, null); - test.ok(done); - callback(); - }); - }); - }); - }; -}; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldThrowErrorDueToSharedConnectionUsage = function(test) { - var server = new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}); - - try { - var db = new Db(MONGODB, server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - var db1 = new Db(MONGODB, server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - } catch(err) { - test.done(); - } -} - -exports.testCloseNoCallback = function(test) { - var db = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(connectionTester(test, 'testCloseNoCallback', function() { - var dbCloseCount = 0, connectionCloseCount = 0, poolCloseCount = 0; - // Ensure no close events are fired as we are closing the connection specifically - db.on('close', function() { dbCloseCount++; }); - - var connectionPool = db.serverConfig.connectionPool; - var connections = connectionPool.getAllConnections(); - - // Force the connection close, should not trigger close command - db.serverConfig.connectionPool.stop(); - // Test done - test.equal(0, dbCloseCount); - test.done(); - })); -} - -exports.testCloseWithCallback = function(test) { - var db = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}),{native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(connectionTester(test, 'testCloseWithCallback', function() { - var dbCloseCount = 0, connectionCloseCount = 0, poolCloseCount = 0; - // Ensure no close events are fired as we are closing the connection specifically - db.on('close', function() { dbCloseCount++; }); - - var connectionPool = db.serverConfig.connectionPool; - var connections = connectionPool.getAllConnections(); - - // Ensure no close events are fired as we are closing the connection specifically - for(var i = 0; i < connections.length; i++) { - connections[i].on("close", function() { test.ok(false); }); - } - - db.close(function() { - // Test done - test.equal(0, dbCloseCount); - test.done(); - }); - })); -} - -exports.testShouldCorrectlyCloseOnUnopedConnection = function(test) { - var db = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}),{native_parser: (process.env['TEST_NATIVE'] != null)}); - db.close(); - test.done(); -} - -exports.testConnectUsingDefaultHostAndPort = function(test) { - var db = new Db(MONGODB, new Server("127.0.0.1", mongodb.Connection.DEFAULT_PORT, {auto_reconnect: true, poolSize: 4, ssl:useSSL}),{native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, db) { - test.equal(null, err); - test.done(); - db.close(); - }) -} - -exports.testConnectUsingSocketOptions = function(test) { - var db = new Db(MONGODB, new Server("127.0.0.1", mongodb.Connection.DEFAULT_PORT, {auto_reconnect: true, poolSize: 4, socketOptions:{keepAlive:100}, ssl:useSSL}),{native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, db) { - test.equal(null, err); - test.equal(100, db.serverConfig.checkoutWriter().socketOptions.keepAlive) - test.done(); - db.close(); - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/cursor_test.js b/test/cursor_test.js deleted file mode 100644 index 89b4d594c63..00000000000 --- a/test/cursor_test.js +++ /dev/null @@ -1,1965 +0,0 @@ -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = require('../lib/mongodb').Db, - Cursor = require('../lib/mongodb').Cursor, - Collection = require('../lib/mongodb').Collection, - Step = require('step'), - fs = require('fs'), - Server = require('../lib/mongodb').Server; - -var MONGODB = 'integration_tests'; -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * An example showing the information returned by indexInformation - * - * @_class cursor - * @_function toArray - */ -exports.shouldCorrectlyExecuteToArray = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection to hold our documents - db.createCollection('test_array', function(err, collection) { - - // Insert a test document - collection.insert({'b':[1, 2, 3]}, {safe:true}, function(err, ids) { - - // Retrieve all the documents in the collection - collection.find().toArray(function(err, documents) { - test.equal(1, documents.length); - test.deepEqual([1, 2, 3], documents[0].b); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyExecuteToArrayAndFailOnFurtherCursorAccess = function(test) { - client.createCollection('test_to_a', function(err, collection) { - test.ok(collection instanceof Collection); - collection.insert({'a':1}, {safe:true}, function(err, ids) { - collection.find({}, function(err, cursor) { - cursor.toArray(function(err, items) { - // Should fail if called again (cursor should be closed) - cursor.toArray(function(err, items) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - - // Should fail if called again (cursor should be closed) - cursor.each(function(err, item) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example iterating over a query using the each function of the cursor. - * - * @_class cursor - * @_function each - * @ignore - */ -exports.shouldCorrectlyFailToArrayDueToFinishedEachOperation = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('test_to_a_after_each', function(err, collection) { - test.equal(null, err); - test.ok(collection instanceof Collection); - - // Insert a document in the collection - collection.insert({'a':1}, {safe:true}, function(err, ids) { - - // Grab a cursor - collection.find(function(err, cursor) { - - // Execute the each command, triggers for each document - cursor.each(function(err, item) { - - // If the item is null then the cursor is exhausted/empty and closed - if(item == null) { - - // Show that the cursor is closed - cursor.toArray(function(err, items) { - test.ok(err != null); - - // Let's close the db - test.done(); - db.close(); - }); - }; - }); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyExecuteCursorExplain = function(test) { - client.createCollection('test_explain', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, r) { - collection.find({'a':1}, function(err, cursor) { - cursor.explain(function(err, explaination) { - test.ok(explaination.cursor != null); - test.ok(explaination.n.constructor == Number); - test.ok(explaination.millis.constructor == Number); - test.ok(explaination.nscanned.constructor == Number); - - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyExecuteCursorCount = function(test) { - client.createCollection('test_count', function(err, collection) { - collection.find(function(err, cursor) { - cursor.count(function(err, count) { - test.equal(0, count); - - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 10; i++) { - collection.insert({'x':i}, {safe:true}, group()); - } - }, - - function finished() { - collection.find().count(function(err, count) { - test.equal(10, count); - test.ok(count.constructor == Number); - }); - - collection.find({}, {'limit':5}).count(function(err, count) { - test.equal(10, count); - }); - - collection.find({}, {'skip':5}).count(function(err, count) { - test.equal(10, count); - }); - - collection.find(function(err, cursor) { - cursor.count(function(err, count) { - test.equal(10, count); - - cursor.each(function(err, item) { - if(item == null) { - cursor.count(function(err, count2) { - test.equal(10, count2); - test.equal(count, count2); - // Let's close the db - test.done(); - }); - } - }); - }); - }); - - client.collection('acollectionthatdoesn', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - }); - }) - } - ) - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyExecuteSortOnCursor = function(test) { - client.createCollection('test_sort', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 5; i++) { - collection.insert({'a':i}, {safe:true}, group()); - } - }, - - function finished() { - collection.find(function(err, cursor) { - cursor.sort(['a', 1], function(err, cursor) { - test.ok(cursor instanceof Cursor); - test.deepEqual(['a', 1], cursor.sortValue); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort('a', 1, function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.equal(0, doc.a); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort('a', -1, function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.equal(4, doc.a); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort('a', "asc", function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.equal(0, doc.a); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort([['a', -1], ['b', 1]], function(err, cursor) { - test.ok(cursor instanceof Cursor); - test.deepEqual([['a', -1], ['b', 1]], cursor.sortValue); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort('a', 1, function(err, cursor) { - cursor.sort('a', -1, function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.equal(4, doc.a); - }); - }) - }); - }); - - collection.find(function(err, cursor) { - cursor.sort('a', -1, function(err, cursor) { - cursor.sort('a', 1, function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.equal(0, doc.a); - }); - }) - }); - }); - - collection.find(function(err, cursor) { - cursor.nextObject(function(err, doc) { - cursor.sort(['a'], function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort('a', 25, function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.ok(err instanceof Error); - test.equal("Illegal sort clause, must be of the form [['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]", err.message); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.sort(25, function(err, cursor) { - cursor.nextObject(function(err, doc) { - test.ok(err instanceof Error); - test.equal("Illegal sort clause, must be of the form [['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]", err.message); - // Let's close the db - test.done(); - }); - }); - }); - } - ); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyThrowErrorOnToArrayWhenMissingCallback = function(test) { - client.createCollection('test_to_array', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 2; i++) { - collection.save({'x':1}, {safe:true}, group()); - } - }, - - function finished() { - collection.find(function(err, cursor) { - test.throws(function () { - cursor.toArray(); - }); - test.done(); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldThrowErrorOnEachWhenMissingCallback = function(test) { - client.createCollection('test_each', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 2; i++) { - collection.save({'x':1}, {safe:true}, group()); - } - }, - - function finished() { - collection.find(function(err, cursor) { - test.throws(function () { - cursor.each(); - }); - test.done(); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyHandleLimitOnCursor = function(test) { - client.createCollection('test_cursor_limit', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 10; i++) { - collection.save({'x':1}, {safe:true}, group()); - } - }, - - function finished() { - collection.find().count(function(err, count) { - test.equal(10, count); - }); - - collection.find(function(err, cursor) { - cursor.limit(5, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(5, items.length); - // Let's close the db - test.done(); - }); - }); - }); - } - ); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyReturnErrorsOnIllegalLimitValues = function(test) { - client.createCollection('test_limit_exceptions', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, docs) {}); - collection.find(function(err, cursor) { - cursor.limit('not-an-integer', function(err, cursor) { - test.ok(err instanceof Error); - test.equal("limit requires an integer", err.message); - }); - }); - - collection.find(function(err, cursor) { - cursor.nextObject(function(err, doc) { - cursor.limit(1, function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.close(function(err, cursor) { - cursor.limit(1, function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlySkipRecordsOnCursor = function(test) { - client.createCollection('test_skip', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 10; i++) { - collection.insert({'x':i}, {safe:true}, group()); - } - }, - - function finished() { - collection.find(function(err, cursor) { - cursor.count(function(err, count) { - test.equal(10, count); - }); - }); - - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(10, items.length); - - collection.find(function(err, cursor) { - cursor.skip(2, function(err, cursor) { - cursor.toArray(function(err, items2) { - test.equal(8, items2.length); - - // Check that we have the same elements - var numberEqual = 0; - var sliced = items.slice(2, 10); - - for(var i = 0; i < sliced.length; i++) { - if(sliced[i].x == items2[i].x) numberEqual = numberEqual + 1; - } - test.equal(8, numberEqual); - - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyReturnErrorsOnIllegalSkipValues = function(test) { - client.createCollection('test_skip_exceptions', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, docs) {}); - collection.find(function(err, cursor) { - cursor.skip('not-an-integer', function(err, cursor) { - test.ok(err instanceof Error); - test.equal("skip requires an integer", err.message); - }); - }); - - collection.find(function(err, cursor) { - cursor.nextObject(function(err, doc) { - cursor.skip(1, function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.close(function(err, cursor) { - cursor.skip(1, function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldReturnErrorsOnIllegalBatchSizes = function(test) { - client.createCollection('test_batchSize_exceptions', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, docs) {}); - collection.find(function(err, cursor) { - cursor.batchSize('not-an-integer', function(err, cursor) { - test.ok(err instanceof Error); - test.equal("batchSize requires an integer", err.message); - }); - }); - - collection.find(function(err, cursor) { - cursor.nextObject(function(err, doc) { - cursor.nextObject(function(err, doc) { - cursor.batchSize(1, function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - }); - }); - }); - }); - - collection.find(function(err, cursor) { - cursor.close(function(err, cursor) { - cursor.batchSize(1, function(err, cursor) { - test.ok(err instanceof Error); - test.equal("Cursor is closed", err.message); - - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyHandleChangesInBatchSizes = function(test) { - client.createCollection('test_not_multiple_batch_size', function(err, collection) { - var records = 6; - var batchSize = 2; - var docs = []; - for(var i = 0; i < records; i++) { - docs.push({'a':i}); - } - - collection.insert(docs, {safe:true}, function() { - collection.find({}, {batchSize : batchSize}, function(err, cursor) { - //1st - cursor.nextObject(function(err, items) { - //cursor.items should contain 1 since nextObject already popped one - test.equal(1, cursor.items.length); - test.ok(items != null); - - //2nd - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - test.ok(items != null); - - //test batch size modification on the fly - batchSize = 3; - cursor.batchSize(batchSize); - - //3rd - cursor.nextObject(function(err, items) { - test.equal(2, cursor.items.length); - test.ok(items != null); - - //4th - cursor.nextObject(function(err, items) { - test.equal(1, cursor.items.length); - test.ok(items != null); - - //5th - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - test.ok(items != null); - - //6th - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - test.ok(items != null); - - //No more - cursor.nextObject(function(err, items) { - test.ok(items == null); - test.ok(cursor.isClosed()); - - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyHandleBatchSize = function(test) { - client.createCollection('test_multiple_batch_size', function(err, collection) { - //test with the last batch that is a multiple of batchSize - var records = 4; - var batchSize = 2; - var docs = []; - for(var i = 0; i < records; i++) { - docs.push({'a':i}); - } - - collection.insert(docs, {safe:true}, function() { - collection.find({}, {batchSize : batchSize}, function(err, cursor) { - //1st - cursor.nextObject(function(err, items) { - test.equal(1, cursor.items.length); - test.ok(items != null); - - //2nd - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - test.ok(items != null); - - //3rd - cursor.nextObject(function(err, items) { - test.equal(1, cursor.items.length); - test.ok(items != null); - - //4th - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - test.ok(items != null); - - //No more - cursor.nextObject(function(err, items) { - test.ok(items == null); - test.ok(cursor.isClosed()); - - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldHandleWhenLimitBiggerThanBatchSize = function(test) { - client.createCollection('test_limit_greater_than_batch_size', function(err, collection) { - var limit = 4; - var records = 10; - var batchSize = 3; - var docs = []; - for(var i = 0; i < records; i++) { - docs.push({'a':i}); - } - - collection.insert(docs, {safe:true}, function() { - collection.find({}, {batchSize : batchSize, limit : limit}, function(err, cursor) { - //1st - cursor.nextObject(function(err, items) { - test.equal(2, cursor.items.length); - - //2nd - cursor.nextObject(function(err, items) { - test.equal(1, cursor.items.length); - - //3rd - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - - //4th - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - - //No more - cursor.nextObject(function(err, items) { - test.ok(items == null); - test.ok(cursor.isClosed()); - - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldHandleLimitLessThanBatchSize = function(test) { - client.createCollection('test_limit_less_than_batch_size', function(err, collection) { - var limit = 2; - var records = 10; - var batchSize = 4; - var docs = []; - for(var i = 0; i < records; i++) { - docs.push({'a':i}); - } - - collection.insert(docs, {safe:true}, function() { - collection.find({}, {batchSize : batchSize, limit : limit}, function(err, cursor) { - //1st - cursor.nextObject(function(err, items) { - test.equal(1, cursor.items.length); - - //2nd - cursor.nextObject(function(err, items) { - test.equal(0, cursor.items.length); - - //No more - cursor.nextObject(function(err, items) { - test.ok(items == null); - test.ok(cursor.isClosed()); - - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldHandleSkipLimitChaining = function(test) { - client.createCollection('test_limit_skip_chaining', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 10; i++) { - collection.insert({'x':1}, {safe:true}, group()); - } - }, - - function finished() { - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(10, items.length); - - collection.find(function(err, cursor) { - cursor.limit(5, function(err, cursor) { - cursor.skip(3, function(err, cursor) { - cursor.toArray(function(err, items2) { - test.equal(5, items2.length); - - // Check that we have the same elements - var numberEqual = 0; - var sliced = items.slice(3, 8); - - for(var i = 0; i < sliced.length; i++) { - if(sliced[i].x == items2[i].x) numberEqual = numberEqual + 1; - } - test.equal(5, numberEqual); - - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyHandleLimitSkipChainingInline = function(test) { - client.createCollection('test_limit_skip_chaining_inline', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 10; i++) { - collection.insert({'x':1}, {safe:true}, group()); - } - }, - - function finished() { - collection.find(function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(10, items.length); - - collection.find(function(err, cursor) { - cursor.limit(5).skip(3).toArray(function(err, items2) { - test.equal(5, items2.length); - - // Check that we have the same elements - var numberEqual = 0; - var sliced = items.slice(3, 8); - - for(var i = 0; i < sliced.length; i++) { - if(sliced[i].x == items2[i].x) numberEqual = numberEqual + 1; - } - test.equal(5, numberEqual); - - // Let's close the db - test.done(); - }); - }); - }); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCloseCursorNoQuerySent = function(test) { - client.createCollection('test_close_no_query_sent', function(err, collection) { - collection.find(function(err, cursor) { - cursor.close(function(err, cursor) { - test.equal(true, cursor.isClosed()); - // Let's close the db - test.done(); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyRefillViaGetMoreCommand = function(test) { - var COUNT = 1000; - - client.createCollection('test_refill_via_get_more', function(err, collection) { - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < COUNT; i++) { - collection.save({'a': i}, {safe:true}, group()); - } - }, - - function finished() { - collection.count(function(err, count) { - test.equal(COUNT, count); - }); - - var total = 0; - var i = 0; - collection.find({}, {}, function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - total = total + item.a; - } else { - test.equal(499500, total); - - collection.count(function(err, count) { - test.equal(COUNT, count); - }); - - collection.count(function(err, count) { - test.equal(COUNT, count); - - var total2 = 0; - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - total2 = total2 + item.a; - } else { - test.equal(499500, total2); - collection.count(function(err, count) { - test.equal(COUNT, count); - test.equal(total, total2); - // Let's close the db - test.done(); - }); - } - }); - }); - }); - } - }); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyRefillViaGetMoreAlternativeCollection = function(test) { - client.createCollection('test_refill_via_get_more_alt_coll', function(err, collection) { - - Step( - function insert() { - var group = this.group(); - - for(var i = 0; i < 1000; i++) { - collection.save({'a': i}, {safe:true}, group()); - } - }, - - function finished() { - collection.count(function(err, count) { - test.equal(1000, count); - }); - - var total = 0; - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - total = total + item.a; - } else { - test.equal(499500, total); - - collection.count(function(err, count) { - test.equal(1000, count); - }); - - collection.count(function(err, count) { - test.equal(1000, count); - - var total2 = 0; - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - total2 = total2 + item.a; - } else { - test.equal(499500, total2); - collection.count(function(err, count) { - test.equal(1000, count); - test.equal(total, total2); - // Let's close the db - test.done(); - }); - } - }); - }); - }); - } - }); - }); - } - ) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCloseCursorAfterQueryHasBeenSent = function(test) { - client.createCollection('test_close_after_query_sent', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, r) { - collection.find({'a':1}, function(err, cursor) { - cursor.nextObject(function(err, item) { - cursor.close(function(err, cursor) { - test.equal(true, cursor.isClosed()); - // Let's close the db - test.done(); - }) - }); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyExecuteCursorCountWithFields = function(test) { - client.createCollection('test_count_with_fields', function(err, collection) { - collection.save({'x':1, 'a':2}, {safe:true}, function(err, doc) { - collection.find({}, {'fields':['a']}).toArray(function(err, items) { - test.equal(1, items.length); - test.equal(2, items[0].a); - test.equal(null, items[0].x); - }); - - collection.findOne({}, {'fields':['a']}, function(err, item) { - test.equal(2, item.a); - test.equal(null, item.x); - test.done(); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyCountWithFieldsUsingExclude = function(test) { - client.createCollection('test_count_with_fields_using_exclude', function(err, collection) { - collection.save({'x':1, 'a':2}, {safe:true}, function(err, doc) { - collection.find({}, {'fields':{'x':0}}).toArray(function(err, items) { - test.equal(1, items.length); - test.equal(2, items[0].a); - test.equal(null, items[0].x); - test.done(); - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyExecuteEnsureIndexWithNoCallback = function(test) { - var docs = []; - - for(var i = 0; i < 1; i++) { - var d = new Date().getTime() + i*1000; - docs[i] = {createdAt:new Date(d)}; - } - - // Create collection - client.createCollection('shouldCorrectlyExecuteEnsureIndexWithNoCallback', function(err, collection) { - // ensure index of createdAt index - collection.ensureIndex({createdAt:1}) - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - // Find with sort - collection.find().sort(['createdAt', 'asc']).toArray(function(err, items) { - if (err) logger.error("error in collection_info.find: " + err); - test.equal(1, items.length); - test.done(); - }) - }) - }); -} - -/** - * @ignore - * @api private - */ -exports.shouldCorrectlyInsert5000RecordsWithDateAndSortCorrectlyWithIndex = function(test) { - var docs = []; - - for(var i = 0; i < 5000; i++) { - var d = new Date().getTime() + i*1000; - docs[i] = {createdAt:new Date(d)}; - } - - // Create collection - client.createCollection('shouldCorrectlyInsert5000RecordsWithDateAndSortCorrectlyWithIndex', function(err, collection) { - // ensure index of createdAt index - collection.ensureIndex({createdAt:1}, function(err, indexName) { - test.equal(null, err); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - // Find with sort - collection.find().sort(['createdAt', 'asc']).toArray(function(err, items) { - if (err) logger.error("error in collection_info.find: " + err); - test.equal(5000, items.length); - test.done(); - }) - }) - }); - }); -} - -/** - * An example showing the information returned by indexInformation - * - * @_class cursor - * @_function rewind - */ -exports['Should correctly rewind and restart cursor'] = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - var docs = []; - - // Insert 100 documents with some data - for(var i = 0; i < 100; i++) { - var d = new Date().getTime() + i*1000; - docs[i] = {'a':i, createdAt:new Date(d)}; - } - - // Create collection - db.createCollection('Should_correctly_rewind_and_restart_cursor', function(err, collection) { - test.equal(null, err); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - // Grab a cursor using the find - var cursor = collection.find({}); - // Fetch the first object off the cursor - cursor.nextObject(function(err, item) { - test.equal(0, item.a) - // Rewind the cursor, resetting it to point to the start of the query - cursor.rewind(); - - // Grab the first object again - cursor.nextObject(function(err, item) { - test.equal(0, item.a) - - db.close(); - test.done(); - }) - }) - }) - }); - }); -} - -/** - * @ignore - * @api private - */ -exports['Should correctly execute count on cursor'] = function(test) { - var docs = []; - - for(var i = 0; i < 1000; i++) { - var d = new Date().getTime() + i*1000; - docs[i] = {'a':i, createdAt:new Date(d)}; - } - - // Create collection - client.createCollection('Should_correctly_execute_count_on_cursor', function(err, collection) { - test.equal(null, err); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - var total = 0; - // Create a cursor for the content - var cursor = collection.find({}); - cursor.count(function(err, c) { - // Ensure each returns all documents - cursor.each(function(err, item) { - if(item != null) { - total++; - } else { - cursor.count(function(err, c) { - test.equal(1000, c); - test.equal(1000, total); - test.done(); - }) - } - }); - }) - }) - }); -} - -/** - * @ignore - * @api private - */ -exports['should be able to stream documents'] = function(test) { - var docs = []; - - for (var i = 0; i < 1000; i++) { - docs[i] = { a: i+1 }; - } - - // Create collection - client.createCollection('Should_be_able_to_stream_documents', function(err, collection) { - test.equal(null, err); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - var paused = 0 - , closed = 0 - , resumed = 0 - , i = 0 - , err - - var stream = collection.find().stream(); - - stream.on('data', function (doc) { - test.equal(true, !! doc); - test.equal(true, !! doc.a); - - if (paused > 0 && 0 === resumed) { - err = new Error('data emitted during pause'); - return done(); - } - - if (++i === 3) { - test.equal(false, stream.paused); - stream.pause(); - test.equal(true, stream.paused); - paused++; - - setTimeout(function () { - test.equal(true, stream.paused); - stream.resume(); - test.equal(false, stream.paused); - resumed++; - }, 20); - } - }); - - stream.on('error', function (er) { - err = er; - done(); - }); - - stream.on('close', function () { - closed++; - done(); - }); - - function done () { - test.equal(undefined, err); - test.equal(i, docs.length); - test.equal(1, closed); - test.equal(1, paused); - test.equal(1, resumed); - test.strictEqual(stream._cursor.isClosed(), true); - test.done(); - } - }) - }) -} - -/** - * @ignore - * @api private - */ -exports['immediately destroying a stream prevents the query from executing'] = function(test) { - var i = 0 - , docs = [{ b: 2 }, { b: 3 }] - , doneCalled = 0 - - client.createCollection('immediately_destroying_a_stream_prevents_the_query_from_executing', function(err, collection) { - test.equal(null, err); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - var stream = collection.find().stream(); - - stream.on('data', function () { - i++; - }) - stream.on('close', done); - stream.on('error', done); - - stream.destroy(); - - function done (err) { - test.equal(++doneCalled, 1); - test.equal(undefined, err); - test.strictEqual(0, i); - test.strictEqual(true, stream._destroyed); - test.done(); - } - }); - }); -} - -/** - * @ignore - * @api private - */ -exports['destroying a stream stops it'] = function(test) { - client.createCollection('destroying_a_stream_stops_it', function(err, collection) { - test.equal(null, err); - - var docs = []; - for (var ii = 0; ii < 10; ++ii) docs.push({ b: ii+1 }); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - var finished = 0 - , i = 0 - - var stream = collection.find().stream(); - - test.strictEqual(null, stream._destroyed); - test.strictEqual(true, stream.readable); - - stream.on('data', function (doc) { - if (++i === 5) { - stream.destroy(); - test.strictEqual(false, stream.readable); - } - }); - - stream.on('close', done); - stream.on('error', done); - - function done (err) { - ++finished; - setTimeout(function () { - test.strictEqual(undefined, err); - test.strictEqual(5, i); - test.strictEqual(1, finished); - test.strictEqual(true, stream._destroyed); - test.strictEqual(false, stream.readable); - test.strictEqual(true, stream._cursor.isClosed()); - test.done(); - }, 150) - } - }); - }); -} - -/** - * @ignore - * @api private - */ -exports['cursor stream errors']= function(test) { - var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - test.equal(null, err); - - client.createCollection('cursor_stream_errors', function(err, collection) { - test.equal(null, err); - - var docs = []; - for (var ii = 0; ii < 10; ++ii) docs.push({ b: ii+1 }); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - var finished = 0 - , closed = 0 - , i = 0 - - var stream = collection.find({}, { batchSize: 5 }).stream(); - - stream.on('data', function (doc) { - if (++i === 5) { - client.close(); - } - }); - - stream.on('close', function () { - closed++; - }); - - stream.on('error', done); - - function done (err) { - ++finished; - setTimeout(function () { - test.equal('no open connections', err.message); - test.equal(5, i); - test.equal(1, closed); - test.equal(1, finished); - test.equal(true, stream._destroyed); - test.equal(false, stream.readable); - test.equal(true, stream._cursor.isClosed()); - test.done(); - }, 150) - } - }); - }); - }); -} - -/** - * @ignore - * @api private - */ -exports['cursor stream pipe']= function(test) { - client.createCollection('cursor_stream_pipe', function(err, collection) { - test.equal(null, err); - - var docs = []; - ;('Aaden Aaron Adrian Aditya Bob Joe').split(' ').forEach(function (name) { - docs.push({ name: name }); - }); - - // insert all docs - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - var filename = '/tmp/_nodemongodbnative_stream_out.txt' - , out = fs.createWriteStream(filename) - - // hack so we don't need to create a stream filter just to - // stringify the objects (otherwise the created file would - // just contain a bunch of [object Object]) - var toString = Object.prototype.toString; - Object.prototype.toString = function () { - return JSON.stringify(this); - } - - var stream = collection.find().stream(); - stream.pipe(out); - - stream.on('error', done); - stream.on('close', done); - - function done (err) { - Object.prototype.toString = toString; - test.strictEqual(undefined, err); - var contents = fs.readFileSync(filename, 'utf8'); - test.ok(/Aaden/.test(contents)); - test.ok(/Aaron/.test(contents)); - test.ok(/Adrian/.test(contents)); - test.ok(/Aditya/.test(contents)); - test.ok(/Bob/.test(contents)); - test.ok(/Joe/.test(contents)); - fs.unlink(filename); - test.done(); - } - }); - }); -} - -/** - * A simple example showing the count function of the cursor. - * - * @_class cursor - * @_function count - * @ignore - */ -exports.shouldCorrectlyUseCursorCountFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Creat collection - db.createCollection('cursor_count_collection', function(err, collection) { - test.equal(null, err); - - // Insert some docs - collection.insert([{a:1}, {a:2}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Do a find and get the cursor count - collection.find().count(function(err, count) { - test.equal(null, err); - test.equal(2, count); - - db.close(); - test.done(); - }) - }); - }); - }); -} - -/** - * A simple example showing the use of sort on the cursor. - * - * @_class cursor - * @_function sort - * @ignore - */ -exports.shouldCorrectlyPeformSimpleSorts = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('simple_sort_collection', function(err, collection) { - test.equal(null, err); - - // Insert some documents we can sort on - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Do normal ascending sort - collection.find().sort([['a', 1]]).nextObject(function(err, item) { - test.equal(null, err); - test.equal(1, item.a); - - // Do normal descending sort - collection.find().sort([['a', -1]]).nextObject(function(err, item) { - test.equal(null, err); - test.equal(3, item.a); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of limit on the cursor - * - * @_class cursor - * @_function limit - * @ignore - */ -exports.shouldCorrectlyPeformLimitOnCursor = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('simple_limit_collection', function(err, collection) { - test.equal(null, err); - - // Insert some documents we can sort on - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Limit to only one document returned - collection.find().limit(1).toArray(function(err, items) { - test.equal(null, err); - test.equal(1, items.length); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of skip on the cursor - * - * @_class cursor - * @_function skip - * @ignore - */ -exports.shouldCorrectlyPeformSkipOnCursor = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('simple_skip_collection', function(err, collection) { - test.equal(null, err); - - // Insert some documents we can sort on - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Skip one document - collection.find().skip(1).nextObject(function(err, item) { - test.equal(null, err); - test.equal(2, item.a); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of batchSize on the cursor, batchSize only regulates how many - * documents are returned for each batch using the getMoreCommand against the MongoDB server - * - * @_class cursor - * @_function batchSize - * @ignore - */ -exports.shouldCorrectlyPeformBatchSizeOnCursor = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('simple_batch_size_collection', function(err, collection) { - test.equal(null, err); - - // Insert some documents we can sort on - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Do normal ascending sort - collection.find().batchSize(1).nextObject(function(err, item) { - test.equal(null, err); - test.equal(1, item.a); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of nextObject. - * - * @_class cursor - * @_function nextObject - * @ignore - */ -exports.shouldCorrectlyPeformNextObjectOnCursor = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('simple_next_object_collection', function(err, collection) { - test.equal(null, err); - - // Insert some documents we can sort on - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Do normal ascending sort - collection.find().nextObject(function(err, item) { - test.equal(null, err); - test.equal(1, item.a); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursor explain function. - * - * @_class cursor - * @_function explain - * @ignore - */ -exports.shouldCorrectlyPeformSimpleExplainCursor = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('simple_explain_collection', function(err, collection) { - test.equal(null, err); - - // Insert some documents we can sort on - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) { - test.equal(null, err); - - // Do normal ascending sort - collection.find().explain(function(err, explaination) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursor streamRecords function. - * - * @_class cursor - * @_function streamRecords - * @ignore - */ -exports.shouldStreamDocumentsUsingTheStreamRecords = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 100; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_streamingRecords_function', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var stream = collection.find().streamRecords({fetchSize:1000}); - - // Execute find on all the documents - stream.on('end', function() { - db.close(); - test.done(); - }); - - stream.on('data', function(data) { - test.ok(data != null); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursor stream function. - * - * @_class cursor - * @_function stream - * @ignore - */ -exports.shouldStreamDocumentsUsingTheStreamFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 100; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_stream_function', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var stream = collection.find().stream(); - - // Execute find on all the documents - stream.on('close', function() { - db.close(); - test.done(); - }); - - stream.on('data', function(data) { - test.ok(data != null); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursor close function. - * - * @_class cursor - * @_function close - * @ignore - */ -exports.shouldStreamDocumentsUsingTheCloseFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 100; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_close_function_on_cursor', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var cursor = collection.find(); - - // Fetch the first object - cursor.nextObject(function(err, object) { - test.equal(null, err); - - // Close the cursor, this is the same as reseting the query - cursor.close(function(err, result) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursor close function. - * - * @_class cursor - * @_function isClosed - * @ignore - */ -exports.shouldStreamDocumentsUsingTheIsCloseFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 100; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_is_close_function_on_cursor', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var cursor = collection.find(); - - // Fetch the first object - cursor.nextObject(function(err, object) { - test.equal(null, err); - - // Close the cursor, this is the same as reseting the query - cursor.close(function(err, result) { - test.equal(null, err); - test.equal(true, cursor.isClosed()); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/cursorstream_test.js b/test/cursorstream_test.js deleted file mode 100644 index 037b71b1f3a..00000000000 --- a/test/cursorstream_test.js +++ /dev/null @@ -1,230 +0,0 @@ -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = require('../lib/mongodb').Db, - Cursor = require('../lib/mongodb').Cursor, - Collection = require('../lib/mongodb').Collection, - fs = require('fs'), - Server = require('../lib/mongodb').Server; - -var MONGODB = 'integration_tests'; -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A simple example showing the use of the cursorstream pause function. - * - * @_class cursorstream - * @_function pause - * @ignore - */ -exports.shouldStreamDocumentsUsingTheCursorStreamPauseFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 1; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_cursorstream_pause', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var stream = collection.find().stream(); - - // For each data item - stream.on("data", function(item) { - // Check if cursor is paused - test.equal(false, stream.paused); - // Pause stream - stream.pause(); - // Check if cursor is paused - test.equal(true, stream.paused); - - // Restart the stream after 1 miliscecond - setTimeout(function() { - stream.resume(); - // Check if cursor is paused - test.equal(false, stream.paused); - }, 1); - }); - - // When the stream is done - stream.on("close", function() { - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursorstream resume function. - * - * @_class cursorstream - * @_function resume - * @ignore - */ -exports.shouldStreamDocumentsUsingTheCursorStreamResumeFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 1; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_cursorstream_resume', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var stream = collection.find().stream(); - - // For each data item - stream.on("data", function(item) { - // Check if cursor is paused - test.equal(false, stream.paused); - // Pause stream - stream.pause(); - // Check if cursor is paused - test.equal(true, stream.paused); - - // Restart the stream after 1 miliscecond - setTimeout(function() { - - // Resume the stream - stream.resume(); - - // Check if cursor is paused - test.equal(false, stream.paused); - }, 1); - }); - - // When the stream is done - stream.on("close", function() { - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the cursorstream resume function. - * - * @_class cursorstream - * @_function destroy - * @ignore - */ -exports.shouldStreamDocumentsUsingTheCursorStreamDestroyFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a lot of documents to insert - var docs = [] - for(var i = 0; i < 1; i++) { - docs.push({'a':i}) - } - - // Create a collection - db.createCollection('test_cursorstream_destroy', function(err, collection) { - test.equal(null, err); - - // Insert documents into collection - collection.insert(docs, {safe:true}, function(err, ids) { - // Peform a find to get a cursor - var stream = collection.find().stream(); - - // For each data item - stream.on("data", function(item) { - // Destroy stream - stream.destroy(); - }); - - // When the stream is done - stream.on("close", function() { - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/custom_pk_test.js b/test/custom_pk_test.js deleted file mode 100644 index 5cf9c61e34d..00000000000 --- a/test/custom_pk_test.js +++ /dev/null @@ -1,107 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCreateRecordsWithCustomPKFactory = function(test) { - // Custom factory (need to provide a 12 byte array); - var CustomPKFactory = function() {} - CustomPKFactory.prototype = new Object(); - CustomPKFactory.createPk = function() { - return new ObjectID("aaaaaaaaaaaa"); - } - - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {ssl:useSSL}), {'pk':CustomPKFactory, native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, p_client) { - p_client.dropDatabase(function(err, done) { - p_client.createCollection('test_custom_key', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, doc) { - collection.find({'_id':new ObjectID("aaaaaaaaaaaa")}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(1, items.length); - - p_client.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -exports.testConnectBadUrl = function(test) { - test.throws(function() { - connect('mango://localhost:27017/' + MONGODB, function(err, db) { - test.ok(false, 'Bad URL!'); - }); - }); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/db_test.js b/test/db_test.js deleted file mode 100644 index 44d6e36872a..00000000000 --- a/test/db_test.js +++ /dev/null @@ -1,1441 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - DBRef = require('../lib/mongodb/bson/db_ref').DBRef, - Code = require('../lib/mongodb/bson/code').Code, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleIllegalDbNames = function(test) { - // Assert rename - try { - new Db(5); - } catch(err) { - test.ok(err instanceof Error); - test.equal("database name must be a string", err.message); - } - - try { - new Db(""); - } catch(err) { - test.ok(err instanceof Error); - test.equal("database name cannot be the empty string", err.message); - } - - try { - new Db("te$t", function(err, collection) {}); - } catch(err) { - test.equal("database names cannot contain the character '$'", err.message); - } - - try { - new Db(".test", function(err, collection) {}); - } catch(err) { - test.equal("database names cannot contain the character '.'", err.message); - } - - try { - new Db("\\test", function(err, collection) {}); - } catch(err) { - test.equal("database names cannot contain the character '\\'", err.message); - } - - try { - new Db("\\test", function(err, collection) {}); - } catch(err) { - test.equal("database names cannot contain the character '\\'", err.message); - } - - try { - new Db("test test", function(err, collection) {}); - } catch(err) { - test.equal("database names cannot contain the character ' '", err.message); - } - - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformAutomaticConnect = function(test) { - var automatic_connect_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null), retryMiliSeconds:50}); - automatic_connect_client.open(function(err, automatic_connect_client) { - // Listener for closing event - var closeListener = function(has_error) { - // Let's insert a document - automatic_connect_client.collection('test_object_id_generation.data2', function(err, collection) { - // Insert another test document and collect using ObjectId - collection.insert({"name":"Patty", "age":34}, {safe:true}, function(err, ids) { - test.equal(1, ids.length); - test.ok(ids[0]._id.toHexString().length == 24); - - collection.findOne({"name":"Patty"}, function(err, document) { - test.equal(ids[0]._id.toHexString(), document._id.toHexString()); - // Let's close the db - automatic_connect_client.close(); - test.done(); - }); - }); - }); - }; - - // Add listener to close event - automatic_connect_client.on("close", closeListener); - automatic_connect_client.close(); - }); -} - -/** - * An example that shows how to force close a db connection so it cannot be reused. - * - * @_class db - * @_function close - * @ignore - */ -exports.shouldCorrectlyFailOnRetryDueToAppCloseOfDb = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch a collection - db.collection('shouldCorrectlyFailOnRetryDueToAppCloseOfDb', function(err, collection) { - - // Insert a document - collection.insert({a:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - // Force close the connection - db.close(true, function(err, result) { - - // Attemp to insert should fail now with correct message 'db closed by application' - collection.insert({a:2}, {safe:true}, function(err, result) { - test.equal('db closed by application', err.message); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A whole bunch of examples on how to use eval on the server. - * - * @_class db - * @_function eval - * @ignore - */ -exports.shouldCorrectlyExecuteEvalFunctions = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Evaluate a function on the server with the parameter 3 passed in - db.eval('function (x) {return x;}', [3], function(err, result) { - test.equal(3, result); - }); - - // Evaluate a function on the server with the parameter 3 passed in no lock aquired for eval - // on server - db.eval('function (x) {return x;}', [3], {nolock:true}, function(err, result) { - test.equal(3, result); - }); - - // Evaluate a function on the server that writes to a server collection - db.eval('function (x) {db.test_eval.save({y:x});}', [5], function(err, result) { - // Locate the entry - client.collection('test_eval', function(err, collection) { - collection.findOne(function(err, item) { - test.equal(5, item.y); - }); - }); - }); - - // Evaluate a function with 2 parameters passed in - db.eval('function (x, y) {return x + y;}', [2, 3], function(err, result) { - test.equal(5, result); - }); - - // Evaluate a function with no parameters passed in - db.eval('function () {return 5;}', function(err, result) { - test.equal(5, result); - }); - - // Evaluate a statement - db.eval('2 + 3;', function(err, result) { - test.equal(5, result); - }); - - // Evaluate a statement using the code object - db.eval(new Code("2 + 3;"), function(err, result) { - test.equal(5, result); - }); - - // Evaluate a statement using the code object including a scope - db.eval(new Code("return i;", {'i':2}), function(err, result) { - test.equal(2, result); - }); - - // Evaluate a statement using the code object including a scope - db.eval(new Code("i + 3;", {'i':2}), function(err, result) { - test.equal(5, result); - test.done(); - }); - - // Evaluate an illegal statement - db.eval("5 ++ 5;", function(err, result) { - test.ok(err instanceof Error); - test.ok(err.message != null); - // Let's close the db - test.done(); - }); - - db.close(); - test.done(); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyDereferenceDbRef = function(test) { - client.createCollection('test_deref', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, ids) { - collection.remove({}, {safe:true}, function(err, result) { - collection.count(function(err, count) { - test.equal(0, count); - - // Execute deref a db reference - client.dereference(new DBRef("test_deref", new ObjectID()), function(err, result) { - collection.insert({'x':'hello'}, {safe:true}, function(err, ids) { - collection.findOne(function(err, document) { - test.equal('hello', document.x); - - client.dereference(new DBRef("test_deref", document._id), function(err, result) { - test.equal('hello', document.x); - - client.dereference(new DBRef("test_deref", 4), function(err, result) { - var obj = {'_id':4}; - - collection.insert(obj, {safe:true}, function(err, ids) { - client.dereference(new DBRef("test_deref", 4), function(err, document) { - - test.equal(obj['_id'], document._id); - collection.remove({}, {safe:true}, function(err, result) { - collection.insert({'x':'hello'}, {safe:true}, function(err, ids) { - client.dereference(new DBRef("test_deref", null), function(err, result) { - test.equal(null, result); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }) - }) - }) - }); -} - -/** - * An example of illegal and legal renaming of a collection - * - * @_class collection - * @_function rename - * @ignore - */ -exports.shouldCorrectlyRenameCollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Open a couple of collections - db.createCollection('test_rename_collection', function(err, collection1) { - db.createCollection('test_rename_collection2', function(err, collection2) { - - // Attemp to rename a collection to a number - try { - collection1.rename(5, function(err, collection) {}); - } catch(err) { - test.ok(err instanceof Error); - test.equal("collection name must be a String", err.message); - } - - // Attemp to rename a collection to an empty string - try { - collection1.rename("", function(err, collection) {}); - } catch(err) { - test.ok(err instanceof Error); - test.equal("collection names cannot be empty", err.message); - } - - // Attemp to rename a collection to an illegal name including the character $ - try { - collection1.rename("te$t", function(err, collection) {}); - } catch(err) { - test.ok(err instanceof Error); - test.equal("collection names must not contain '$'", err.message); - } - - // Attemp to rename a collection to an illegal name starting with the character . - try { - collection1.rename(".test", function(err, collection) {}); - } catch(err) { - test.ok(err instanceof Error); - test.equal("collection names must not start or end with '.'", err.message); - } - - // Attemp to rename a collection to an illegal name ending with the character . - try { - collection1.rename("test.", function(err, collection) {}); - } catch(err) { - test.ok(err instanceof Error); - test.equal("collection names must not start or end with '.'", err.message); - } - - // Attemp to rename a collection to an illegal name with an empty middle name - try { - collection1.rename("tes..t", function(err, collection) {}); - } catch(err) { - test.equal("collection names cannot be empty", err.message); - } - - // Insert a couple of documents - collection1.insert([{'x':1}, {'x':2}], {safe:true}, function(err, docs) { - - // Attemp to rename the first collection to the second one, this will fail - collection1.rename('test_rename_collection2', function(err, collection) { - test.ok(err instanceof Error); - test.ok(err.message.length > 0); - - // Attemp to rename the first collection to a name that does not exist - // this will be succesful - collection1.rename('test_rename_collection3', function(err, collection) { - test.equal("test_rename_collection3", collection.collectionName); - - // Ensure that the collection is pointing to the new one - collection1.count(function(err, count) { - test.equal(2, count); - db.close(); - test.done(); - }); - }); - }); - }) - }); - }); - }); -} - -/** - * An example of a simple single server db connection - * - * @_class db - * @_function open - * @ignore - */ -exports.shouldCorrectlyOpenASimpleDbSingleServerConnection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - db.close(); - test.done(); - }); -} - -/** - * An example of a simple single server db connection and close function - * - * @_class db - * @_function close - * @ignore - */ -exports.shouldCorrectlyOpenASimpleDbSingleServerConnection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Close the connection with a callback that is optional - db.close(function(err, result) { - test.equal(null, err); - - test.done(); - }); - }); -} - -/** - * An example of retrieveing the information of all the collections. - * - * @_class db - * @_function collectionsInfo - * @ignore - */ -exports.shouldCorrectlyRetrieveCollectionInfo = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a collection - db.createCollection('test_collections_info', function(err, r) { - test.equal(null, err); - - // Return the information of a single collection name - db.collectionsInfo("test_collections_info").toArray(function(err, items) { - test.equal(1, items.length); - - // Return the information of a all collections, using the callback format - db.collectionsInfo(function(err, cursor) { - - // Turn the cursor into an array of results - cursor.toArray(function(err, items) { - test.ok(items.length > 0); - - db.close(); - test.done(); - }); - }) - }); - }); - }); -} - -/** - * An example of retrieveing the collection names for a database. - * - * @_class db - * @_function collectionNames - * @ignore - */ -exports.shouldCorrectlyRetrieveCollectionInfo = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a collection - db.createCollection('test_collections_info', function(err, r) { - test.equal(null, err); - - // Return the information of a single collection name - db.collectionNames("test_collections_info", function(err, items) { - test.equal(1, items.length); - - // Return the information of a all collections, using the callback format - db.collectionNames(function(err, items) { - test.ok(items.length > 0); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * An example of retrieving a collection from a db using the collection function. - * - * @_class db - * @_function collection - * @ignore - */ -exports.shouldCorrectlyAccessACollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Grab a collection without a callback no safe mode - var col1 = db.collection('test_correctly_access_collections'); - - // Grab a collection with a callback but no safe operation - db.collection('test_correctly_access_collections', function(err, col2) { - test.equal(null, err); - - // Grab a collection with a callback in safe mode, ensuring it exists (should fail as it's not created) - db.collection('test_correctly_access_collections', {safe:true}, function(err, col3) { - test.ok(err != null); - - // Create the collection - db.createCollection('test_correctly_access_collections', function(err, result) { - - // Retry to get the collection, should work as it's now created - db.collection('test_correctly_access_collections', {safe:true}, function(err, col3) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * An example of retrieving all collections for a db as Collection objects - * - * @_class db - * @_function collections - * @ignore - */ -exports.shouldCorrectlyRetrieveAllCollections = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create the collection - db.createCollection('test_correctly_access_collections', function(err, result) { - - // Retry to get the collection, should work as it's now created - db.collections(function(err, collections) { - test.equal(null, err); - test.ok(collections.length > 0); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleFailedConnection = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 25117, {auto_reconnect: false, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - test.ok(err != null) - test.done(); - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyResaveDBRef = function(test) { - client.dropCollection('test_resave_dbref', function() { - client.createCollection('test_resave_dbref', function(err, collection) { - test.ifError(err); - - collection.insert({'name': 'parent'}, {safe : true}, function(err, objs) { - test.ok(objs && objs.length == 1 && objs[0]._id != null); - var parent = objs[0]; - var child = {'name' : 'child', 'parent' : new DBRef("test_resave_dbref", parent._id)}; - - collection.insert(child, {safe : true}, function(err, objs) { - test.ifError(err); - - collection.findOne({'name' : 'child'}, function(err, child) { //Child deserialized - test.ifError(err); - test.ok(child != null); - - collection.save(child, {save : true}, function(err) { - test.ifError(err); //Child node with dbref resaved! - - collection.findOne({'parent' : new DBRef("test_resave_dbref", parent._id)}, - function(err, child) { - test.ifError(err); - test.ok(child != null);//!!!! Main test point! - test.done(); - }) - }); - }); - }); - }); - }); - }); -}, - -/** - * An example of dereferencing values. - * - * @_class db - * @_function dereference - * @ignore - */ -exports.shouldCorrectlyDereferenceDbRefExamples = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Get a second db - var secondDb = db.db('integration_tests_2'); - - // Create a dereference example - secondDb.createCollection('test_deref_examples', function(err, collection) { - - // Insert a document in the collection - collection.insert({'a':1}, {safe:true}, function(err, ids) { - - // Let's build a db reference and resolve it - var dbRef = new DBRef('test_deref_examples', ids[0]._id, 'integration_tests_2'); - - // Resolve it including a db resolve - db.dereference(dbRef, function(err, item) { - test.equal(1, item.a); - - // Let's build a db reference and resolve it - var dbRef = new DBRef('test_deref_examples', ids[0]._id); - - // Simple local resolve - secondDb.dereference(dbRef, function(err, item) { - test.equal(1, item.a); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * An example of using the logout command for the database. - * - * @_class db - * @_function logout - * @ignore - */ -exports.shouldCorrectlyLogoutFromTheDatabase = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Add a user to the database - db.addUser('user', 'name', function(err, result) { - test.equal(null, err); - - // Authenticate - db.authenticate('user', 'name', function(err, result) { - test.equal(true, result); - - // Logout the db - db.logout(function(err, result) { - test.equal(true, result); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * An example of using the authenticate command. - * - * @_class db - * @_function authenticate - * @ignore - */ -exports.shouldCorrectlyAuthenticateAgainstTheDatabase = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Add a user to the database - db.addUser('user', 'name', function(err, result) { - test.equal(null, err); - - // Authenticate - db.authenticate('user', 'name', function(err, result) { - test.equal(true, result); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * An example of adding a user to the database. - * - * @_class db - * @_function addUser - * @ignore - */ -exports.shouldCorrectlyAuthenticateAgainstTheDatabase = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Add a user to the database - db.addUser('user', 'name', function(err, result) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); -} - -/** - * An example of dereferencing values. - * - * @_class db - * @_function removeUser - * @ignore - */ -exports.shouldCorrectlyAddAndRemoveUser = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Add a user to the database - db.addUser('user', 'name', function(err, result) { - test.equal(null, err); - - // Authenticate - db.authenticate('user', 'name', function(err, result) { - test.equal(true, result); - - // Logout the db - db.logout(function(err, result) { - test.equal(true, result); - - // Remove the user from the db - db.removeUser('user', function(err, result) { - - // Authenticate - db.authenticate('user', 'name', function(err, result) { - test.equal(false, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the creation of a collection. - * - * @_class db - * @_function createCollection - * @ignore - */ -exports.shouldCorrectlyCreateACollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a capped collection with a maximum of 1000 documents - db.createCollection("a_simple_collection", {capped:true, size:10000, max:1000, safe:true}, function(err, collection) { - test.equal(null, err); - - // Insert a document in the capped collection - collection.insert({a:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * A simple example executing a command against the server. - * - * @_class db - * @_function dropCollection - * @ignore - */ -exports.shouldCorrectlyExecuteACommandAgainstTheServer = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Execute ping against the server - db.command({ping:1}, function(err, result) { - test.equal(null, err); - - // Create a capped collection with a maximum of 1000 documents - db.createCollection("a_simple_create_drop_collection", {capped:true, size:10000, max:1000, safe:true}, function(err, collection) { - test.equal(null, err); - - // Insert a document in the capped collection - collection.insert({a:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - // Drop the collection from this world - db.dropCollection("a_simple_create_drop_collection", function(err, result) { - test.equal(null, err); - - // Verify that the collection is gone - db.collectionNames("a_simple_create_drop_collection", function(err, names) { - test.equal(0, names.length); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example creating, dropping a collection and then verifying that the collection is gone. - * - * @_class db - * @_function command - * @ignore - */ -exports.shouldCorrectlyCreateDropAndVerifyThatCollectionIsGone = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Execute ping against the server - db.command({ping:1}, function(err, result) { - test.equal(null, err); - - db.close(); - test.done(); - }); - }); -} - -/** - * A simple example creating, dropping a collection and then verifying that the collection is gone. - * - * @_class db - * @_function renameCollection - * @ignore - */ -exports.shouldCorrectlyRenameACollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a collection - db.createCollection("simple_rename_collection", {safe:true}, function(err, collection) { - test.equal(null, err); - - // Insert a document in the collection - collection.insert({a:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - // Rename the collection - db.renameCollection("simple_rename_collection", "simple_rename_collection_2", function(err, collection2) { - test.equal(null, err); - - // Retrieve the number of documents from the collection - collection2.count(function(err, count) { - test.equal(1, count); - - // Verify that the collection is gone - db.collectionNames("simple_rename_collection", function(err, names) { - test.equal(0, names.length); - - // Verify that the new collection exists - db.collectionNames("simple_rename_collection_2", function(err, names) { - test.equal(1, names.length); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example using lastError on a single connection with a pool of 1. - * - * @_class db - * @_function lastError - * @ignore - */ -exports.shouldCorrectlyUseLastError = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a collection - db.createCollection("simple_rename_collection", {safe:true}, function(err, collection) { - test.equal(null, err); - - // Insert a document in the collection - collection.insert({a:1}, function(err, result) { - test.equal(null, err); - - // Execute lastError - db.lastError(function(err, result) { - test.equal(null, err); - test.equal(null, result[0].err); - - // Pick a specific connection and execute lastError against it - var connection = db.serverConfig.checkoutWriter(); - // Execute lastError - db.lastError({}, {connection:connection}, function(err, result) { - test.equal(null, err); - test.equal(null, result[0].err); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple example using previousError to return the list of all errors, might be deprecated in the future. - * - * @_class db - * @_function previousErrors - * @ignore - */ -exports.shouldCorrectlyUsePreviousError = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a collection - db.createCollection("simple_previous_error_coll", {safe:true}, function(err, collection) { - test.equal(null, err); - - // Force a unique index - collection.ensureIndex({a:1}, {unique:true}, function(err, result) { - test.equal(null, err); - - // Force some errors - collection.insert([{a:1}, {a:1}, {a:1}, {a:2}], function(err, result) { - - // Pick a specific connection and execute lastError against it - var connection = db.serverConfig.checkoutWriter(); - - // Execute previousErrors - db.previousErrors({connection:connection}, function(err, result) { - test.equal(null, err); - test.equal(1, result.length); - test.ok(result[0].err != null); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple example using resetErrorHistory to clean up the history of errors. - * - * @_class db - * @_function resetErrorHistory - * @ignore - */ -exports.shouldCorrectlyUseResetErrorHistory = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Create a collection - db.createCollection("simple_reset_error_history_coll", {safe:true}, function(err, collection) { - test.equal(null, err); - - // Force a unique index - collection.ensureIndex({a:1}, {unique:true}, function(err, result) { - test.equal(null, err); - - // Force some errors - collection.insert([{a:1}, {a:1}, {a:1}, {a:2}], function(err, result) { - // Pick a specific connection and execute lastError against it - var connection = db.serverConfig.checkoutWriter(); - - // Reset the error history - db.resetErrorHistory({connection:connection}, function(err, result) { - - // Execute previousErrors and validate that there are no errors left - db.previousErrors({connection:connection}, function(err, result) { - test.equal(null, err); - test.equal(1, result.length); - test.equal(null, result[0].err); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A more complex createIndex using a compound unique index in the background and dropping duplicated documents - * - * @_class db - * @_function createIndex - */ -exports.shouldCreateComplexIndexOnTwoFields = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('more_complex_index_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - db.createIndex('more_complex_index_test', {a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Show that duplicate records got dropped - collection.find({}).toArray(function(err, items) { - test.equal(null, err); - test.equal(4, items.length); - - // Peform a query, with explain to show we hit the query - collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { - test.equal(null, err); - test.ok(explanation[0].indexBounds.a != null); - test.ok(explanation[0].indexBounds.b != null); - - db.close(); - test.done(); - }); - }) - }); - }); - }); - }); -} - -/** - * A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents. - * - * @_class db - * @_function ensureIndex - */ -exports.shouldCreateComplexEnsureIndex = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('more_complex_ensure_index_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - db.ensureIndex('more_complex_ensure_index_test', {a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Show that duplicate records got dropped - collection.find({}).toArray(function(err, items) { - test.equal(null, err); - test.equal(4, items.length); - - // Peform a query, with explain to show we hit the query - collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { - test.equal(null, err); - test.ok(explanation[0].indexBounds.a != null); - test.ok(explanation[0].indexBounds.b != null); - - db.close(); - test.done(); - }); - }) - }); - }); - }); - }); -} - -/** - * A Simple example of returning current cursor information in MongoDB - * - * @_class db - * @_function cursorInfo - */ -exports.shouldCorrectlyReturnCursorInformation = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('cursor_information_collection', function(err, collection) { - test.equal(null, err); - - // Create a bunch of documents so we can force the creation of a cursor - var docs = []; - for(var i = 0; i < 1000; i++) { - docs.push({a:'hello world hello world hello world hello world hello world hello world hello world hello world'}); - } - - // Insert a bunch of documents for the index - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - // Let's set a cursor - var cursor = collection.find({}, {batchSize:10}); - cursor.nextObject(function(err, item) { - test.equal(null, err); - - // Let's grab the information about the cursors on the database - db.cursorInfo(function(err, cursorInformation) { - test.ok(cursorInformation.totalOpen > 0); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * An examples showing the creation and dropping of an index - * - * @_class db - * @_function dropIndex - */ -exports.shouldCorrectlyCreateAndDropIndex = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('create_and_drop_an_index', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Drop the index - db.dropIndex("create_and_drop_an_index", "a_1_b_1", function(err, result) { - test.equal(null, err); - - // Verify that the index is gone - collection.indexInformation(function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.equal(null, indexInformation.a_1_b_1); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * An example showing how to force a reindex of a collection. - * - * @_class db - * @_function reIndex - */ -exports.shouldCorrectlyForceReindexOnCollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('create_and_drop_all_indexes', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Force a reindex of the collection - db.reIndex('create_and_drop_all_indexes', function(err, result) { - test.equal(null, err); - test.equal(true, result); - - // Verify that the index is gone - collection.indexInformation(function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * An example showing the information returned by indexInformation - * - * @_class db - * @_function indexInformation - */ -exports.shouldCorrectlyShowTheResultsFromIndexInformation = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('more_index_information_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Fetch basic indexInformation for collection - db.indexInformation('more_index_information_test', function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); - - // Fetch full index information - collection.indexInformation({full:true}, function(err, indexInformation) { - test.deepEqual({ _id: 1 }, indexInformation[0].key); - test.deepEqual({ a: 1, b: 1 }, indexInformation[1].key); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * An examples showing the dropping of a database - * - * @_class db - * @_function dropDatabase - */ -exports.shouldCorrectlyShowTheResultsFromIndexInformation = function(test) { - var db = new Db('integration_tests_to_drop', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection - db.createCollection('more_index_information_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Let's drop the database - db.dropDatabase(function(err, result) { - test.equal(null, err); - - // Get the admin database - db.admin().listDatabases(function(err, dbs) { - // Grab the databases - dbs = dbs.databases; - // Did we find the db - var found = false; - - // Check if we have the db in the list - for(var i = 0; i < dbs.length; i++) { - if(dbs[i].name == 'integration_tests_to_drop') found = true; - } - - // We should not find the databases - test.equal(false, found); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/error_test.js b/test/error_test.js deleted file mode 100644 index 9f22a4d14cd..00000000000 --- a/test/error_test.js +++ /dev/null @@ -1,311 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -// Test the error reporting functionality -exports.shouldCorrectlyRetrieveErrorMessagesFromServer = function(test) { - // Just run with one connection in the pool - var error_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, poolSize:1, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Open the db - error_client.open(function(err, error_client) { - error_client.resetErrorHistory(function() { - error_client.error(function(err, documents) { - test.equal(true, documents[0].ok); - test.equal(0, documents[0].n); - - // Force error on server - error_client.executeDbCommand({forceerror: 1}, function(err, r) { - test.equal(0, r.documents[0].ok); - test.ok(r.documents[0].errmsg.length > 0); - // Check for previous errors - error_client.previousErrors(function(err, documents) { - test.equal(true, documents[0].ok); - test.equal(1, documents[0].nPrev); - test.equal("forced error", documents[0].err); - - // Check for the last error - error_client.error(function(err, documents) { - test.equal("forced error", documents[0].err); - // Force another error - error_client.collection('test_error_collection', function(err, collection) { - collection.findOne({name:"Fred"}, function(err, document) { - // Check that we have two previous errors - error_client.previousErrors(function(err, documents) { - test.equal(true, documents[0].ok); - test.equal(2, documents[0].nPrev); - test.equal("forced error", documents[0].err); - - error_client.resetErrorHistory(function() { - error_client.previousErrors(function(err, documents) { - test.equal(true, documents[0].ok); - test.equal(-1, documents[0].nPrev); - - error_client.error(function(err, documents) { - test.equal(true, documents[0].ok); - test.equal(0, documents[0].n); - - // Let's close the db - error_client.close(); - - error_client.error(function(err, documents) { - test.ok(err instanceof Error); - test.equal('no open connections', err.message); - test.done(); - }); - }); - }) - }); - }); - }); - }); - }) - }); - }); - }); - }); - }); -} - -// Test the last status functionality of the driver -exports.shouldCorrectlyExecuteLastStatus = function(test) { - // Just run with one connection in the pool - var error_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, poolSize:1, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Open the db - error_client.open(function(err, client) { - client.createCollection('test_last_status', function(err, collection) { - test.ok(collection instanceof Collection); - test.equal('test_last_status', collection.collectionName); - - // Get the collection - client.collection('test_last_status', function(err, collection) { - // Remove all the elements of the collection - collection.remove(function(err, result) { - // Check update of a document - collection.insert({i:1}, function(err, ids) { - test.equal(1, ids.length); - test.ok(ids[0]._id.toHexString().length == 24); - - // Update the record - collection.update({i:1}, {"$set":{i:2}}, function(err, result) { - // Check for the last message from the server - client.lastStatus(function(err, status) { - test.equal(true, status[0].ok); - test.equal(true, status[0].updatedExisting); - // Check for failed update of document - collection.update({i:1}, {"$set":{i:500}}, function(err, result) { - client.lastStatus(function(err, status) { - test.equal(true, status[0].ok); - test.equal(false, status[0].updatedExisting); - - // Check safe update of a document - collection.insert({x:1}, function(err, ids) { - collection.update({x:1}, {"$set":{x:2}}, {'safe':true}, function(err, document) { - }); - - collection.update({x:1}, {"$set":{x:2}}, {'safe':true}); - - collection.update({y:1}, {"$set":{y:2}}, {'safe':true}, function(err, result) { - test.equal(0, result); - - // Let's close the db - error_client.close(); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -exports.shouldFailInsertDueToUniqueIndex = function(test) { - client.createCollection('test_failing_insert_due_to_unique_index', function(err, r) { - client.collection('test_failing_insert_due_to_unique_index', function(err, collection) { - collection.ensureIndex([['a', 1 ]], true, function(err, indexName) { - collection.insert({a:2}, {safe: true}, function(err, r) { - test.ok(err == null); - collection.insert({a:2}, {safe: true}, function(err, r) { - test.ok(err != null); - test.done(); - }) - }) - }) - }) - }) -} - -// Test the error reporting functionality -exports.shouldFailInsertDueToUniqueIndexStrict = function(test) { - var error_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - error_client.open(function(err, error_client) { - error_client.dropCollection('test_failing_insert_due_to_unique_index_strict', function(err, r) { - error_client.createCollection('test_failing_insert_due_to_unique_index_strict', function(err, r) { - error_client.collection('test_failing_insert_due_to_unique_index_strict', function(err, collection) { - collection.ensureIndex([['a', 1 ]], true, function(err, indexName) { - collection.insert({a:2}, {safe:true}, function(err, r) { - test.ok(err == null); - collection.insert({a:2}, {safe:true}, function(err, r) { - test.ok(err != null); - error_client.close(); - test.done(); - }) - }) - }) - }) - }) - }); - }); -} - -exports['safe mode should pass the disconnected error to the callback'] = function (test) { - var error_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - var name = 'test_safe_mode_when_disconnected'; - error_client.open(function(err, error_client) { - test.ok(err == null); - error_client.resetErrorHistory(function() { - error_client.dropCollection(name, function() { - error_client.createCollection(name, function(err, collection) { - test.ok(err == null); - collection.insert({ inserted: true }, { safe: true }, function (err) { - test.ok(err == null); - error_client.close(); - - collection.insert({ works: true }, { safe: true }, function (err) { - test.ok(err instanceof Error); - test.equal('no open connections', err.message); - - collection.update({ inserted: true }, { inserted: true, x: 1 }, { safe: true }, function (err) { - test.ok(err instanceof Error); - test.equal('no open connections', err.message); - - collection.remove({ inserted: true }, { safe: true }, function (err) { - test.ok(err instanceof Error); - test.equal('no open connections', err.message); - - collection.findOne({ works: true }, function (err) { - test.ok(err instanceof Error); - test.equal('no open connections', err.message); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -exports.shouldHandleAssertionError = function(test) { - client.createCollection('test_handle_assertion_error', function(err, r) { - client.collection('test_handle_assertion_error', function(err, collection) { - collection.insert({a:{lat:50, lng:10}}, {safe: true}, function(err, docs) { - test.ok(err == null); - - var query = {a:{$within:{$box:[[1,-10],[80,120]]}}}; - - // We don't have a geospatial index at this point - collection.findOne(query, function(err, docs) { - test.ok(err instanceof Error); - - collection.ensureIndex([['a', '2d' ]], true, function(err, indexName) { - test.ok(err == null); - - collection.findOne(query, function(err, doc) { - test.ok(err == null); - - var invalidQuery = {a:{$within:{$box:[[-10,-180],[10,180]]}}}; - - client.admin().serverInfo(function(err, result){ - collection.findOne(invalidQuery, function(err, doc) { - if(parseInt((result.version.replace(/\./g, ''))) < 200) { - test.ok(err instanceof Error); - } else { - test.equal(null, err); - test.equal(null, doc); - } - - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/exception_handling_test.js b/test/exception_handling_test.js deleted file mode 100644 index 1ba34b352c8..00000000000 --- a/test/exception_handling_test.js +++ /dev/null @@ -1,101 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCorrectlyHandleThrownError = function(test) { - client.createCollection('shouldCorrectlyHandleThrownError', function(err, r) { - try { - client.collection('shouldCorrectlyHandleThrownError', function(err, collection) { - debug(someUndefinedVariable); - }); - } catch (err) { - test.ok(err != null); - test.done(); - } - }); -} - -exports.shouldCorrectlyHandleThrownErrorInRename = function(test) { - // Catch unhandled exception - process.on("uncaughtException", function(err) { - // Remove listener - process.removeAllListeners("uncaughtException"); - test.done() - }) - - // Execute code - client.createCollection('shouldCorrectlyHandleThrownErrorInRename', function(err, r) { - client.collection('shouldCorrectlyHandleThrownError', function(err, collection) { - collection.rename("shouldCorrectlyHandleThrownErrorInRename2", function(err, result) { - debug(someUndefinedVariable); - }) - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/find_test.js b/test/find_test.js deleted file mode 100644 index 40ba87c4773..00000000000 --- a/test/find_test.js +++ /dev/null @@ -1,1647 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Code = require('../lib/mongodb/bson/code').Code, - Long = require('../lib/mongodb/bson/long').Long, - Step = require('step'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var POOL_SIZE = 4; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * Test a simple find - * @ignore - */ -exports.shouldCorrectlyPerformSimpleFind = function(test) { - client.createCollection('test_find_simple', function(err, r) { - var collection = client.collection('test_find_simple', function(err, collection) { - var doc1 = null; - var doc2 = null; - - // Insert some test documents - collection.insert([{a:2}, {b:3}], {safe:true}, function(err, docs) { - doc1 = docs[0]; - doc2 = docs[1] - - // Ensure correct insertion testing via the cursor and the count function - collection.find(function(err, cursor) { - cursor.toArray(function(err, documents) { - test.equal(2, documents.length); - - collection.count(function(err, count) { - test.equal(2, count); - - // Fetch values by selection - collection.find({'a': doc1.a}, function(err, cursor) { - cursor.toArray(function(err, documents) { - test.equal(1, documents.length); - test.equal(doc1.a, documents[0].a); - // Let's close the db - test.done(); - }); - }); - }); - }) - }); - }); - }); - }); -} - -/** - * Test a simple find chained - * @ignore - */ -exports.shouldCorrectlyPeformSimpleChainedFind = function(test) { - client.createCollection('test_find_simple_chained', function(err, r) { - var collection = client.collection('test_find_simple_chained', function(err, collection) { - var doc1 = null; - var doc2 = null; - - // Insert some test documents - collection.insert([{a:2}, {b:3}], {safe:true}, function(err, docs) { - doc1 = docs[0]; - doc2 = docs[1] - - // Ensure correct insertion testing via the cursor and the count function - collection.find().toArray(function(err, documents) { - test.equal(2, documents.length); - - collection.count(function(err, count) { - test.equal(2, count); - - // Fetch values by selection - collection.find({'a': doc1.a}).toArray(function(err, documents) { - test.equal(1, documents.length); - test.equal(doc1.a, documents[0].a); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * Test advanced find - * @ignore - */ -exports.shouldCorrectlyPeformAdvancedFinds = function(test) { - client.createCollection('test_find_advanced', function(err, r) { - var collection = client.collection('test_find_advanced', function(err, collection) { - var doc1 = null, doc2 = null, doc3 = null; - - // Insert some test documents - collection.insert([{a:1}, {a:2}, {b:3}], {safe:true}, function(err, docs) { - var doc1 = docs[0], doc2 = docs[1], doc3 = docs[2]; - - // Locate by less than - collection.find({'a':{'$lt':10}}).toArray(function(err, documents) { - test.equal(2, documents.length); - // Check that the correct documents are returned - var results = []; - // Check that we have all the results we want - documents.forEach(function(doc) { - if(doc.a == 1 || doc.a == 2) results.push(1); - }); - test.equal(2, results.length); - }); - - // Locate by greater than - collection.find({'a':{'$gt':1}}).toArray(function(err, documents) { - test.equal(1, documents.length); - test.equal(2, documents[0].a); - }); - - // Locate by less than or equal to - collection.find({'a':{'$lte':1}}).toArray(function(err, documents) { - test.equal(1, documents.length); - test.equal(1, documents[0].a); - }); - - // Locate by greater than or equal to - collection.find({'a':{'$gte':1}}).toArray(function(err, documents) { - test.equal(2, documents.length); - // Check that the correct documents are returned - var results = []; - // Check that we have all the results we want - documents.forEach(function(doc) { - if(doc.a == 1 || doc.a == 2) results.push(1); - }); - test.equal(2, results.length); - }); - - // Locate by between - collection.find({'a':{'$gt':1, '$lt':3}}).toArray(function(err, documents) { - test.equal(1, documents.length); - test.equal(2, documents[0].a); - }); - - // Locate in clause - collection.find({'a':{'$in':[1,2]}}).toArray(function(err, documents) { - test.equal(2, documents.length); - // Check that the correct documents are returned - var results = []; - // Check that we have all the results we want - documents.forEach(function(doc) { - if(doc.a == 1 || doc.a == 2) results.push(1); - }); - test.equal(2, results.length); - }); - - // Locate in _id clause - collection.find({'_id':{'$in':[doc1['_id'], doc2['_id']]}}).toArray(function(err, documents) { - test.equal(2, documents.length); - // Check that the correct documents are returned - var results = []; - // Check that we have all the results we want - documents.forEach(function(doc) { - if(doc.a == 1 || doc.a == 2) results.push(1); - }); - test.equal(2, results.length); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * Test sorting of results - * @ignore - */ -exports.shouldCorrectlyPerformFindWithSort = function(test) { - client.createCollection('test_find_sorting', function(err, r) { - client.collection('test_find_sorting', function(err, collection) { - var doc1 = null, doc2 = null, doc3 = null, doc4 = null; - // Insert some test documents - collection.insert([{a:1, b:2}, - {a:2, b:1}, - {a:3, b:2}, - {a:4, b:1} - ], {safe:true}, function(err, docs) { - doc1 = docs[0]; - doc2 = docs[1]; - doc3 = docs[2]; - doc4 = docs[3] - - // Test sorting (ascending) - collection.find({'a': {'$lt':10}}, {'sort': [['a', 1]]}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(1, documents[0].a); - test.equal(2, documents[1].a); - test.equal(3, documents[2].a); - test.equal(4, documents[3].a); - - // Test sorting (descending) - collection.find({'a': {'$lt':10}}, {'sort': [['a', -1]]}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(4, documents[0].a); - test.equal(3, documents[1].a); - test.equal(2, documents[2].a); - test.equal(1, documents[3].a); - - // Test sorting (descending), sort is hash - collection.find({'a': {'$lt':10}}, {sort: {a: -1}}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(4, documents[0].a); - test.equal(3, documents[1].a); - test.equal(2, documents[2].a); - test.equal(1, documents[3].a); - - // Sorting using array of names, assumes ascending order - collection.find({'a': {'$lt':10}}, {'sort': ['a']}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(1, documents[0].a); - test.equal(2, documents[1].a); - test.equal(3, documents[2].a); - test.equal(4, documents[3].a); - - // Sorting using single name, assumes ascending order - collection.find({'a': {'$lt':10}}, {'sort': 'a'}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(1, documents[0].a); - test.equal(2, documents[1].a); - test.equal(3, documents[2].a); - test.equal(4, documents[3].a); - - // Sorting using single name, assumes ascending order, sort is hash - collection.find({'a': {'$lt':10}}, {sort: {'a':1}}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(1, documents[0].a); - test.equal(2, documents[1].a); - test.equal(3, documents[2].a); - test.equal(4, documents[3].a); - - collection.find({'a': {'$lt':10}}, {'sort': ['b', 'a']}).toArray(function(err, documents) { - test.equal(4, documents.length); - test.equal(2, documents[0].a); - test.equal(4, documents[1].a); - test.equal(1, documents[2].a); - test.equal(3, documents[3].a); - - // Sorting using empty array, no order guarantee should not blow up - collection.find({'a': {'$lt':10}}, {'sort': []}).toArray(function(err, documents) { - test.equal(4, documents.length); - - /* NONACTUAL */ - // Sorting using ordered hash - collection.find({'a': {'$lt':10}}, {'sort': {a:-1}}).toArray(function(err, documents) { - // Fail test if not an error - test.equal(4, documents.length); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * Test the limit function of the db - * @ignore - */ -exports.shouldCorrectlyPerformFindWithLimit = function(test) { - client.createCollection('test_find_limits', function(err, r) { - client.collection('test_find_limits', function(err, collection) { - var doc1 = null, doc2 = null, doc3 = null, doc4 = null; - - // Insert some test documents - collection.insert([{a:1}, - {b:2}, - {c:3}, - {d:4} - ], {safe:true}, function(err, docs) { - doc1 = docs[0]; - doc2 = docs[1]; - doc3 = docs[2]; - doc4 = docs[3] - - // Test limits - collection.find({}, {'limit': 1}).toArray(function(err, documents) { - test.equal(1, documents.length); - }); - - collection.find({}, {'limit': 2}).toArray(function(err, documents) { - test.equal(2, documents.length); - }); - - collection.find({}, {'limit': 3}).toArray(function(err, documents) { - test.equal(3, documents.length); - }); - - collection.find({}, {'limit': 4}).toArray(function(err, documents) { - test.equal(4, documents.length); - }); - - collection.find({}, {}).toArray(function(err, documents) { - test.equal(4, documents.length); - }); - - collection.find({}, {'limit':99}).toArray(function(err, documents) { - test.equal(4, documents.length); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * Test find by non-quoted values (issue #128) - * @ignore - */ -exports.shouldCorrectlyFindWithNonQuotedValues = function(test) { - client.createCollection('test_find_non_quoted_values', function(err, r) { - client.collection('test_find_non_quoted_values', function(err, collection) { - // insert test document - collection.insert([{ a: 19, b: 'teststring', c: 59920303 }, - { a: "19", b: 'teststring', c: 3984929 }], {safe:true} , function(err, r) { - - collection.find({ a: 19 }).toArray(function(err, documents) { - test.equal(1, documents.length); - test.done(); - }); - }); - }); - }); -} - -/** - * Test for querying embedded document using dot-notation (issue #126) - * @ignore - */ -exports.shouldCorrectlyFindEmbeddedDocument = function(test) { - client.createCollection('test_find_embedded_document', function(err, r) { - client.collection('test_find_embedded_document', function(err, collection) { - // insert test document - collection.insert([{ a: { id: 10, value: 'foo' }, b: 'bar', c: { id: 20, value: 'foobar' }}, - { a: { id: 11, value: 'foo' }, b: 'bar2', c: { id: 20, value: 'foobar' }}], {safe:true}, function(err, r) { - - // test using integer value - collection.find({ 'a.id': 10 }).toArray(function(err, documents) { - test.equal(1, documents.length); - test.equal('bar', documents[0].b); - }); - - // test using string value - collection.find({ 'a.value': 'foo' }).toArray(function(err, documents) { - // should yield 2 documents - test.equal(2, documents.length); - test.equal('bar', documents[0].b); - test.equal('bar2', documents[1].b); - test.done(); - }); - }); - }); - }); -} - -/** - * Find no records - * @ignore - */ -exports.shouldCorrectlyFindNoRecords = function(test) { - client.createCollection('test_find_one_no_records', function(err, r) { - client.collection('test_find_one_no_records', function(err, collection) { - collection.find({'a':1}, {}).toArray(function(err, documents) { - test.equal(0, documents.length); - // Let's close the db - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformFindByWhere = function(test) { - client.createCollection('test_where', function(err, collection) { - test.ok(collection instanceof Collection); - collection.insert([{'a':1}, {'a':2}, {'a':3}], {safe:true}, function(err, ids) { - collection.count(function(err, count) { - test.equal(3, count); - - // Let's test usage of the $where statement - collection.find({'$where':new Code('this.a > 2')}).count(function(err, count) { - test.equal(1, count); - }); - - collection.find({'$where':new Code('this.a > i', {i:1})}).count(function(err, count) { - test.equal(2, count); - - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformFindsWithHintTurnedOn = function(test) { - client.createCollection('test_hint', function(err, collection) { - collection.insert({'a':1}, {safe:true}, function(err, ids) { - client.createIndex(collection.collectionName, "a", function(err, indexName) { - collection.find({'a':1}, {'hint':'a'}).toArray(function(err, items) { - test.equal(1, items.length); - }); - - collection.find({'a':1}, {'hint':['a']}).toArray(function(err, items) { - test.equal(1, items.length); - }); - - collection.find({'a':1}, {'hint':{'a':1}}).toArray(function(err, items) { - test.equal(1, items.length); - }); - - // Modify hints - collection.hint = 'a'; - test.equal(1, collection.hint['a']); - collection.find({'a':1}).toArray(function(err, items) { - test.equal(1, items.length); - }); - - collection.hint = ['a']; - test.equal(1, collection.hint['a']); - collection.find({'a':1}).toArray(function(err, items) { - test.equal(1, items.length); - }); - - collection.hint = {'a':1}; - test.equal(1, collection.hint['a']); - collection.find({'a':1}).toArray(function(err, items) { - test.equal(1, items.length); - }); - - collection.hint = null; - test.ok(collection.hint == null); - collection.find({'a':1}).toArray(function(err, items) { - test.equal(1, items.length); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformFindByObjectID = function(test) { - client.createCollection('test_find_by_oid', function(err, collection) { - collection.save({'hello':'mike'}, {safe:true}, function(err, docs) { - test.ok(docs._id instanceof ObjectID || Object.prototype.toString.call(docs._id) === '[object ObjectID]'); - - collection.findOne({'_id':docs._id}, function(err, doc) { - test.equal('mike', doc.hello); - - var id = doc._id.toString(); - collection.findOne({'_id':new ObjectID(id)}, function(err, doc) { - test.equal('mike', doc.hello); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReturnDocumentWithOriginalStructure= function(test) { - client.createCollection('test_find_by_oid_with_subdocs', function(err, collection) { - var c1 = { _id: new ObjectID, comments: [], title: 'number 1' }; - var c2 = { _id: new ObjectID, comments: [], title: 'number 2' }; - var doc = { - numbers: [] - , owners: [] - , comments: [c1, c2] - , _id: new ObjectID - }; - - collection.insert(doc, {safe:true}, function(err, docs) { - collection.findOne({'_id':doc._id}, {safe:true,fields: undefined}, function(err, doc) { - if (err) console.error('error', err); - test.equal(2, doc.comments.length); - test.equal('number 1', doc.comments[0].title); - test.equal('number 2', doc.comments[1].title); - - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyRetrieveSingleRecord = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, p_client) { - client.createCollection('test_should_correctly_retrieve_one_record', function(err, collection) { - collection.insert({'a':0}, {safe:true}, function(err, r) { - p_client.collection('test_should_correctly_retrieve_one_record', function(err, usercollection) { - usercollection.findOne({'a': 0}, function(err, result) { - p_client.close(); - - test.done(); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleError = function(test) { - client.createCollection('test_find_one_error_handling', function(err, collection) { - // Try to fetch an object using a totally invalid and wrong hex string... what we're interested in here - // is the error handling of the findOne Method - try { - collection.findOne({"_id":ObjectID.createFromHexString('5e9bd59248305adf18ebc15703a1')}, function(err, result) {}); - } catch (err) { - test.done(); - } - }); -} - -/** - * Test field select with options - * @ignore - */ -exports.shouldCorrectlyPerformFindWithOptions = function(test) { - client.createCollection('test_field_select_with_options', function(err, r) { - var collection = client.collection('test_field_select_with_options', function(err, collection) { - var docCount = 25, docs = []; - - // Insert some test documents - while(docCount--) docs.push({a:docCount, b:docCount}); - collection.insert(docs, {safe:true}, function(err,retDocs) { - docs = retDocs; - - collection.find({},{ 'a' : 1},{ limit : 3, sort : [['a',-1]] }).toArray(function(err,documents){ - test.equal(3,documents.length); - documents.forEach(function(doc,idx){ - test.equal(undefined,doc.b); // making sure field select works - test.equal((24-idx),doc.a); // checking limit sort object with field select - }); - }); - - collection.find({},{},10,3).toArray(function(err,documents){ - test.equal(3,documents.length); - documents.forEach(function(doc,idx){ - test.equal(doc.a,doc.b); // making sure empty field select returns properly - test.equal((14-idx),doc.a); // checking skip and limit in args - }); - - test.done(); - }); - }); - }); - }); -} - -/** - * Test findAndModify a document - * @ignore - */ -exports.shouldCorrectlyFindAndModifyDocument = function(test) { - client.createCollection('test_find_and_modify_a_document', function(err, collection) { - // Test return new document on change - collection.insert({'a':1, 'b':2}, {safe:true}, function(err, doc) { - // Let's modify the document in place - collection.findAndModify({'a':1}, [['a', 1]], {'$set':{'b':3}}, {'new':true}, function(err, updated_doc) { - test.equal(1, updated_doc.a); - test.equal(3, updated_doc.b); - - // Test return old document on change - collection.insert({'a':2, 'b':2}, {safe:true}, function(err, doc) { - // Let's modify the document in place - collection.findAndModify({'a':2}, [['a', 1]], {'$set':{'b':3}}, {safe:true}, function(err, result) { - test.equal(2, result.a); - test.equal(2, result.b); - - // Test remove object on change - collection.insert({'a':3, 'b':2}, {safe:true}, function(err, doc) { - // Let's modify the document in place - collection.findAndModify({'a':3}, [], {'$set':{'b':3}}, {'new': true, remove: true}, function(err, updated_doc) { - test.equal(3, updated_doc.a); - test.equal(2, updated_doc.b); - - // Let's upsert! - collection.findAndModify({'a':4}, [], {'$set':{'b':3}}, {'new': true, upsert: true}, function(err, updated_doc) { - test.equal(4, updated_doc.a); - test.equal(3, updated_doc.b); - - // Test selecting a subset of fields - collection.insert({a: 100, b: 101}, {safe:true}, function (err, ids) { - collection.findAndModify({'a': 100}, [], {'$set': {'b': 5}}, {'new': true, fields: {b: 1}}, function (err, updated_doc) { - test.equal(2, Object.keys(updated_doc).length); - test.equal(ids[0]['_id'].toHexString(), updated_doc._id.toHexString()); - test.equal(5, updated_doc.b); - test.equal("undefined", typeof updated_doc.a); - test.done(); - }); - }); - }); - }) - }); - }) - }); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteFindOneWithAnInSearchTag = function(test) { - client.createCollection('shouldCorrectlyExecuteFindOneWithAnInSearchTag', function(err, collection) { - // Test return new document on change - collection.insert({'tags':[]}, {safe:true}, function(err, docs) { - // Fetch the id - var id = docs[0]._id - - Step( - function findFirst() { - var self = this; - - collection.findOne({_id:id}, function(err, doc) { - test.equal(null, err) - test.ok(doc != null); - - // Perform atomic push operation - collection.update({_id:id}, {'$push':{comments:{title:'1'}}}, {safe:true}, self); - }) - }, - - function findSecond(err, result) { - var self = this; - test.equal(1, result); - test.equal(null, err); - - collection.findOne({_id:id}, function(err, doc) { - test.equal(null, err) - test.ok(doc != null); - test.deepEqual(1, doc.comments.length); - - // Perform atomic push operation - collection.update({_id:id}, {'$push':{comments:{title:'2'}}}, {safe:true}, self); - }) - }, - - function findThird(err, result) { - var self = this; - test.equal(1, result); - test.equal(null, err); - - collection.findOne({_id:id}, function(err, doc) { - test.equal(null, err) - test.ok(doc != null); - test.deepEqual(2, doc.comments.length); - - // Perform atomic push operation - collection.update({_id:id}, {'$push':{comments:{title:'3'}}}, {safe:true}, self); - }) - }, - - function findFourth(err, result) { - var self = this; - test.equal(1, result); - test.equal(null, err); - - collection.findOne({_id:id}, function(err, doc) { - test.equal(null, err) - test.ok(doc != null); - test.deepEqual(3, doc.comments.length); - // Perform atomic push operation - collection.update({_id:id}, {'$pushAll':{comments:[{title:'4'}, {title:'5'}]}}, {safe:true}, self); - }) - }, - - function findFourth(err, result) { - var self = this; - test.equal(1, result); - test.equal(null, err); - - collection.findOne({_id:id}, function(err, doc) { - test.equal(null, err) - test.ok(doc != null); - test.deepEqual(5, doc.comments.length); - test.done(); - }) - } - ) - }) - }); -} - -/** - * @ignore - */ -exports['ShouldCorrectlyLocatePostAndIncValues'] = function(test) { - client.createCollection('shouldCorrectlyExecuteFindOneWithAnInSearchTag', function(err, collection) { - // Test return new document on change - collection.insert({title:'Tobi', - author:'Brian', - newTitle:'Woot', meta:{visitors:0}}, {safe:true}, function(err, docs) { - // Fetch the id - var id = docs[0]._id - - collection.update({_id:id}, {$inc:{ 'meta.visitors': 1 }}, {safe:true}, function(err, result) { - test.equal(1, result); - test.equal(null, err); - - collection.findOne({_id:id}, function(err, item) { - test.equal(1, item.meta.visitors); - test.done() - }) - }); - }); - }); -} - -/** - * Test findAndModify a document - * @ignore - */ -exports['Should Correctly Handle FindAndModify Duplicate Key Error'] = function(test) { - client.createCollection('FindAndModifyDuplicateKeyError', function(err, collection) { - collection.ensureIndex(['name', 1], {unique:true}, function(err, index) { - // Test return new document on change - collection.insert([{name:'test1'}, {name:'test2'}], {safe:true}, function(err, doc) { - // Let's modify the document in place - collection.findAndModify({name: 'test1'}, [], {$set: {name: 'test2'}}, {}, function(err, updated_doc) { - test.equal(null, updated_doc); - test.ok(err != null); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly return null when attempting to modify a non-existing document'] = function(test) { - client.createCollection('AttemptToFindAndModifyNonExistingDocument', function(err, collection) { - // Let's modify the document in place - collection.findAndModify({name: 'test1'}, [], {$set: {name: 'test2'}}, {}, function(err, updated_doc) { - test.equal(null, updated_doc); - test.ok(err == null || err.errmsg.match("No matching object found")) - test.done(); - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly handle chained skip and limit on find with toArray'] = function(test) { - client.createCollection('skipAndLimitOnFindWithToArray', function(err, collection) { - collection.insert([{a:1}, {b:2}, {c:3}], {safe:true}, function(err, result) { - - collection.find().skip(1).limit(1).toArray(function(err, items) { - test.equal(null, err); - test.equal(1, items.length); - test.equal(2, items[0].b) - test.done(); - }) - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly pass timeout options to cursor'] = function(test) { - client.createCollection('timeoutFalse', function(err, collection) { - collection.find({},{timeout:false},function(err, cursor) { - test.equal(false, cursor.timeout); - }); - collection.find({},{timeout:true},function(err, cursor) { - test.equal(true, cursor.timeout); - }); - collection.find({},{},function(err, cursor) { - test.equal(true, cursor.timeout); - }); - - test.done(); - }); -} - -/** - * Test findAndModify a document with strict mode enabled - * @ignore - */ -exports.shouldCorrectlyFindAndModifyDocumentWithDBStrict = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {strict:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, p_client) { - p_client.createCollection('shouldCorrectlyFindAndModifyDocumentWithDBStrict', function(err, collection) { - // Test return old document on change - collection.insert({'a':2, 'b':2}, {safe:true}, function(err, doc) { - // Let's modify the document in place - collection.findAndModify({'a':2}, [['a', 1]], {'$set':{'b':3}}, {new:true}, function(err, result) { - test.equal(2, result.a) - test.equal(3, result.b) - p_client.close(); - test.done(); - }) - }); - }); - }); -} - -/** - * Test findAndModify a document that fails in first step before safe - * @ignore - */ -exports.shouldCorrectlyFindAndModifyDocumentThatFailsInFirstStep = function(test) { - client.createCollection('shouldCorrectlyFindAndModifyDocumentThatFailsInFirstStep', function(err, collection) { - // Set up an index to force duplicate index erro - collection.ensureIndex([['failIndex', 1]], {unique:true}, function(err, index) { - // Setup a new document - collection.insert({'a':2, 'b':2, 'failIndex':1}, function(err, doc) { - - // Let's attempt to upsert with a duplicate key error - collection.findAndModify({'c':2}, [['a', 1]], {'a':10, 'b':10, 'failIndex':1}, {safe:true, upsert:true}, function(err, result) { - test.equal(null, result); - test.ok(err.errmsg.match("duplicate key error index")); - test.done(); - }) - }); - }); - }); -} - -/** - * Test findAndModify a document that fails in first step before safe - * @ignore - */ -exports.shouldCorrectlyFindAndModifyDocumentThatFailsInSecondStepWithNoMatchingDocuments = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {strict:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, p_client) { - p_client.createCollection('shouldCorrectlyFindAndModifyDocumentThatFailsInSecondStepWithNoMatchingDocuments', function(err, collection) { - // Test return old document on change - collection.insert({'a':2, 'b':2}, function(err, doc) { - - // Let's modify the document in place - collection.findAndModify({'a':2}, [['a', 1]], {'$set':{'b':3}}, {safe:{w:200, wtimeout:1000}}, function(err, result) { - test.equal(null, result); - test.ok(err != null); - p_client.close(); - test.done(); - }) - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly return new modified document'] = function(test) { - client.createCollection('Should_correctly_return_new_modified_document', function(err, collection) { - var id = new ObjectID(); - var doc = {_id:id, a:1, b:1, c:{a:1, b:1}}; - - collection.insert(doc, {safe:true}, function(err, result) { - test.ok(err == null); - - // Find and modify returning the new object - collection.findAndModify({_id:id}, [], {$set : {'c.c': 100}}, {new:true}, function(err, item) { - test.equal(doc._id.toString(), item._id.toString()); - test.equal(doc.a, item.a); - test.equal(doc.b, item.b); - test.equal(doc.c.a, item.c.a); - test.equal(doc.c.b, item.c.b); - test.equal(100, item.c.c); - test.done(); - }) - }); - }); -} - -/** - * Should correctly execute findAndModify that is breaking in prod - * @ignore - */ -exports.shouldCorrectlyExecuteFindAndModify = function(test) { - client.createCollection('shouldCorrectlyExecuteFindAndModify', function(err, collection) { - var self = {_id : new ObjectID()} - var _uuid = 'sddffdss' - - collection.findAndModify( - {_id: self._id, 'plays.uuid': _uuid}, - [], - {$set : {'plays.$.active': true}}, - {new: true, fields: {plays: 0, results: 0}, safe: true}, - function(err, contest) { - test.done(); - }) - }); -} - -/** - * @ignore - */ -exports['Should correctly return record with 64-bit id'] = function(test) { - client.createCollection('should_correctly_return_record_with_64bit_id', function(err, collection) { - var _lowerId = new ObjectID(); - var _higherId = new ObjectID(); - var lowerId = new Long.fromString('133118461172916224', 10); - var higherId = new Long.fromString('133118461172916225', 10); - - var lowerDoc = {_id:_lowerId, id: lowerId}; - var higherDoc = {_id:_higherId, id: higherId}; - - collection.insert([lowerDoc, higherDoc], {safe:true}, function(err, result) { - test.ok(err == null); - - // Select record with id of 133118461172916225 using $gt directive - collection.find({id: {$gt: lowerId}}, {}, function(err, cur) { - test.ok(err == null); - - cur.toArray(function(err, arr) { - test.ok(err == null); - test.equal(arr.length, 1, 'Selecting record via $gt directive on 64-bit integer should return a record with higher Id') - test.equal(arr[0].id.toString(), '133118461172916225', 'Returned Id should be equal to 133118461172916225') - test.done() - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should Correctly find a Document using findOne excluding _id field'] = function(test) { - client.createCollection('Should_Correctly_find_a_Document_using_findOne_excluding__id_field', function(err, collection) { - var doc = {_id : new ObjectID(), a:1, c:2} - // insert doc - collection.insert(doc, {safe:true}, function(err, result) { - // Get one document, excluding the _id field - collection.findOne({a:1}, {fields:{'_id': 0}}, function(err, item) { - test.equal(null, item._id); - test.equal(1, item.a); - test.equal(2, item.c); - - collection.find({a:1}, {fields:{'_id':0}}).toArray(function(err, items) { - var item = items[0] - test.equal(null, item._id); - test.equal(1, item.a); - test.equal(2, item.c); - test.done(); - }) - }) - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly execute find and findOne queries in the same way'] = function(test) { - client.createCollection('Should_correctly_execute_find_and_findOne_queries_in_the_same_way', function(err, collection) { - var doc = {_id : new ObjectID(), a:1, c:2, comments:[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}; - // insert doc - collection.insert(doc, {safe:true}, function(err, result) { - - collection.find({_id: doc._id}, {comments: {$slice: -5}}).toArray(function(err, docs) { - test.equal(5, docs[0].comments.length) - - collection.findOne({_id: doc._id}, {comments: {$slice: -5}}, function(err, item) { - test.equal(5, item.comments.length) - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly execute find and findOne queries with selector set to null'] = function(test) { - client.createCollection('Should_correctly_execute_find_and_findOne_queries_in_the_same_way', function(err, collection) { - var doc = {_id : new ObjectID(), a:1, c:2, comments:[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}; - // insert doc - collection.insert(doc, {safe:true}, function(err, result) { - - collection.find(null, {comments: {$slice: -5}}).toArray(function(err, docs) { - test.equal(5, docs[0].comments.length) - - collection.findOne(null, {comments: {$slice: -5}}, function(err, item) { - test.equal(5, item.comments.length) - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandlerErrorForFindAndModifyWhenNoRecordExists = function(test) { - client.createCollection('shouldCorrectlyHandlerErrorForFindAndModifyWhenNoRecordExists', function(err, collection) { - collection.findAndModify({'a':1}, [], {'$set':{'b':3}}, {'new': true}, function(err, updated_doc) { - test.equal(null, err); - test.equal(null, updated_doc); - test.done(); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteFindAndModifyShouldGenerateCorrectBSON = function(test) { - var transaction = {}; - transaction.document = {}; - transaction.document.type = "documentType"; - transaction.document.id = new ObjectID(); - transaction.transactionId = new ObjectID(); - transaction.amount = 12.3333 - - var transactions = []; - transactions.push(transaction); - // Wrapping object - var wrapingObject = { - funds : { - remaining : 100.5 - }, - - transactions:transactions - } - - client.createCollection('shouldCorrectlyExecuteFindAndModify', function(err, collection) { - collection.insert(wrapingObject, {safe:true}, function(err, doc) { - test.equal(null, err); - - collection.findOne({_id:doc[0]._id, 'funds.remaining': {$gte: 3.0}, 'transactions.id': {$ne: transaction.transactionId}}, function(err, item) { - test.ok(item != null) - - collection.findAndModify({_id:doc[0]._id, 'funds.remaining': {$gte: 3.0}, 'transactions.id': {$ne: transaction.transactionId}}, [], {$push: {transactions: transaction}}, {new: true, safe: true}, function(err, result) { - test.done(); - }); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteMultipleFindsInParallel = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize:10, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, p_client) { - p_client.createCollection('tasks', function(err, collection) { - var numberOfOperations = 0; - - // Test return old document on change - collection.insert({'a':2, 'b':2}, {safe:true}, function(err, doc) { - collection.find({"user_id":"4e9fc8d55883d90100000003","lc_status":{"$ne":"deleted"},"owner_rating":{"$exists":false}}, - {"skip":0,"limit":10,"sort":{"updated":-1}}, function(err, cursor) { - cursor.count(function(err, count) { - numberOfOperations = numberOfOperations + 1; - if(numberOfOperations == 2) { - test.done(); - p_client.close(); - } - }) - }); - - collection.find({"user_id":"4e9fc8d55883d90100000003","lc_status":{"$ne":"deleted"},"owner_rating":{"$exists":false}}, - {"skip":0,"limit":10,"sort":{"updated":-1}}, function(err, cursor) { - cursor.count(function(err, count) { - numberOfOperations = numberOfOperations + 1; - if(numberOfOperations == 2) { - test.done(); - p_client.close(); - } - }) - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReturnErrorFromMongodbOnFindAndModifyForcedError = function(test) { - client.createCollection('shouldCorrectlyReturnErrorFromMongodbOnFindAndModifyForcedError', function(err, collection) { - var q = { x: 1 }; - var set = { y:2, _id: new ObjectID() }; - var opts = { new: true, upsert: true }; - // Original doc - var doc = {_id: new ObjectID(), x:1}; - - // Insert original doc - collection.insert(doc, {safe:true}, function(err, result) { - collection.findAndModify(q, [], set, opts, function (err, res) { - test.ok(err != null); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteFindAndModifyUnderConcurrentLoad = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize:10, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - var running = true; - - p_client.open(function(err, p_client) { - // Create a collection - p_client.collection("collection1", function(err, collection) { - // Wait a bit and then execute something that will throw a duplicate error - setTimeout(function() { - var id = new ObjectID(); - - collection.insert({_id:id, a:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - collection.insert({_id:id, a:1}, {safe:true}, function(err, result) { - running = false; - test.done(); - p_client.close(); - }); - }); - }, 200); - }); - - p_client.collection("collection2", function(err, collection) { - // Keep hammering in inserts - var insert = function() { - process.nextTick(function() { - collection.insert({a:1}); - if(running) process.nextTick(insert); - }); - } - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyIterateOverCollection = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize:1, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - var numberOfSteps = 0; - - // Open db connection - p_client.open(function(err, p_client) { - // Create a collection - p_client.createCollection('shouldCorrectlyIterateOverCollection', function(err, collection) { - for(var i = 0; i < 1000; i++) { - collection.insert({a:1, b:2, c:{d:3, f:'sfdsffffffffffffffffffffffffffffff'}}); - } - - collection.find({}, {}, function(err,cursor) { - cursor.count(function(err,count) { - cursor.each(function(err, obj) { - if (obj == null) { - p_client.close(); - test.equal(1000, numberOfSteps); - test.done(); - } else { - numberOfSteps = numberOfSteps + 1; - } - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyErrorOutFindAndModifyOnDuplicateRecord = function(test) { - var p_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {strict:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - p_client.open(function(err, p_client) { - p_client.createCollection('shouldCorrectlyErrorOutFindAndModifyOnDuplicateRecord', function(err, collection) { - // Test return old document on change - collection.insert([{'login':'user1'}, {'login':'user2'}], {safe:true}, function(err, docs) { - var id = docs[1]._id; - // Set an index - collection.ensureIndex('login', {unique:true}, function(err, result) { - // Attemp to modify document - collection.findAndModify({_id: id}, [], { $set: {login: 'user1'} }, {}, function(err, user){ - test.ok(err != null); - p_client.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * An example of using find with a very large in parameter - * - * @ignore - */ -exports.shouldPerformSimpleFindInArray = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_find_in_array', function(err, collection) { - test.equal(null, err); - - var docs = []; - for(var i = 0; i < 100; i++) docs.push({a:i}); - - // Insert some test documentations - collection.insert(docs, {safe:true}, function(err, result) { - test.equal(null, err); - - // Find all the variables in a specific array - var inArray = []; - for(var i = 0; i < 100; i++) docs.push(i); - - // Fin all in - collection.find({a:{$in:docs}}).toArray(function(err, items) { - test.equal(null, err); - test.equal(100, items.length); - - db.close(); - test.done(); - }); - }); - }); - }); -} - - -/** - * A whole set of different ways to use the findAndModify command. - * - * The first findAndModify command modifies a document and returns the modified document back. - * The second findAndModify command removes the document. - * The second findAndModify command upserts a document and returns the new document. - * @_class collection - * @_function findAndModify - */ -exports.shouldPerformSimpleFindAndModifyOperations = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_find_and_modify_operations_', function(err, collection) { - test.equal(null, err); - - // Insert some test documentations - collection.insert([{a:1}, {b:1}, {c:1}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Simple findAndModify command returning the new document - collection.findAndModify({a:1}, [['a', 1]], {$set:{b1:1}}, {new:true}, function(err, doc) { - test.equal(null, err); - test.equal(1, doc.a); - test.equal(1, doc.b1); - - // Simple findAndModify command returning the new document and - // removing it at the same time - collection.findAndModify({b:1}, [['b', 1]], - {$set:{b:2}}, {remove:true}, function(err, doc) { - - // Verify that the document is gone - collection.findOne({b:1}, function(err, item) { - test.equal(null, err); - test.equal(null, item); - - // Simple findAndModify command performing an upsert and returning the new document - // executing the command safely - collection.findAndModify({d:1}, [['b', 1]], - {d:1, f:1}, {new:true, upsert:true, safe:true}, function(err, doc) { - test.equal(null, err); - test.equal(1, doc.d); - test.equal(1, doc.f); - - db.close(); - test.done(); - }) - }); - }); - }); - }); - }); - }); -} - -/** - * An example of using findAndRemove - * - * @_class collection - * @_function findAndRemove - */ -exports.shouldPerformSimpleFindAndModifyOperations = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_find_and_modify_operations_', function(err, collection) { - test.equal(null, err); - - // Insert some test documentations - collection.insert([{a:1}, {b:1}, {c:1}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Simple findAndModify command returning the new document and - // removing it at the same time - collection.findAndRemove({b:1}, [['b', 1]], function(err, doc) { - test.equal(null, err); - test.equal(1, doc.b); - - // Verify that the document is gone - collection.findOne({b:1}, function(err, item) { - test.equal(null, err); - test.equal(null, item); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple query using the find method on the collection. - * - * @_class collection - * @_function find - */ -exports.shouldPeformASimpleQuery = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_query', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the testing - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Peform a simple find and return all the documents - collection.find().toArray(function(err, docs) { - test.equal(null, err); - test.equal(3, docs.length); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple query showing the explain for a query - * - * @_class collection - * @_function find - */ -exports.shouldPeformASimpleExplainQuery = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_explain_query', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the testing - collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Peform a simple find and return all the documents - collection.find({}, {explain:true}).toArray(function(err, docs) { - test.equal(null, err); - test.equal(1, docs.length); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple query showing skip and limit - * - * @_class collection - * @_function find - */ -exports.shouldPeformASimpleLimitSkipQuery = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_limit_skip_query', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the testing - collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Peform a simple find and return all the documents - collection.find({}, {skip:1, limit:1, fields:{b:1}}).toArray(function(err, docs) { - test.equal(null, err); - test.equal(1, docs.length); - test.equal(null, docs[0].a); - test.equal(2, docs[0].b); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple query using findOne - * - * @_class collection - * @_function findOne - */ -exports.shouldPeformASimpleLimitSkipFindOneQuery = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_limit_skip_find_one_query', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the testing - collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Peform a simple find and return all the documents - collection.findOne({a:2}, {fields:{b:1}}, function(err, doc) { - test.equal(null, err); - test.equal(null, doc.a); - test.equal(2, doc.b); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple query using find and fields - */ -exports.shouldPeformASimpleLimitSkipFindWithFields = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_find_with_fields', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the testing - collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Peform a simple find and return all the documents - collection.find({a:2}, ['b']).toArray(function(err, docs) { - test.equal(null, err); - test.equal(1, docs.length); - test.equal(null, docs[0].a); - test.equal(2, docs[0].b); - - // Peform a simple find and return all the documents - collection.find({a:2}, {b:1}).toArray(function(err, docs) { - test.equal(null, err); - test.equal(1, docs.length); - test.equal(null, docs[0].a); - test.equal(2, docs[0].b); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple query using find and fields - */ -exports.shouldPeformASimpleLimitSkipFindWithFields2 = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_find_with_fields_2', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the testing - collection.insert([{a:1, b:1}, {a:2, b:2}, {a:3, b:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Peform a simple find and return all the documents - collection.find({a:2}, {fields: ['b']}).toArray(function(err, docs) { - test.equal(null, err); - test.equal(1, docs.length); - test.equal(null, docs[0].a); - test.equal(2, docs[0].b); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/geo_search_test.js b/test/geo_search_test.js deleted file mode 100644 index fa8ba83036f..00000000000 --- a/test/geo_search_test.js +++ /dev/null @@ -1,145 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Long = require('../lib/mongodb/bson/long').Long, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * Example of a simple geoNear query across some documents - * - * @_class collection - * @_function geoNear - * @ignore - */ -exports.shouldCorrectlyPerformSimpleGeoNearCommand = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch the collection - db.collection("simple_geo_near_command", function(err, collection) { - - // Add a location based index - collection.ensureIndex({loc:"2d"}, function(err, result) { - - // Save a new location tagged document - collection.insert([{a:1, loc:[50, 30]}, {a:1, loc:[30, 50]}], {safe:true}, function(err, result) { - - // Use geoNear command to find document - collection.geoNear(50, 50, {query:{a:1}, num:1}, function(err, docs) { - test.equal(1, docs.results.length); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * Example of a simple geoHaystackSearch query across some documents - * - * @_class collection - * @_function geoHaystackSearch - * @ignore - */ -exports.shouldCorrectlyPerformSimpleGeoHaystackSearchCommand = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch the collection - db.collection("simple_geo_haystack_command", function(err, collection) { - - // Add a location based index - collection.ensureIndex({loc: "geoHaystack", type: 1}, {bucketSize: 1}, function(err, result) { - - // Save a new location tagged document - collection.insert([{a:1, loc:[50, 30]}, {a:1, loc:[30, 50]}], {safe:true}, function(err, result) { - - // Use geoNear command to find document - collection.geoHaystackSearch(50, 50, {search:{a:1}, limit:1, maxDistance:100}, function(err, docs) { - test.equal(1, docs.results.length); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/gridstore/grid_store_file_test.js b/test/gridstore/grid_store_file_test.js deleted file mode 100644 index 7ff564c7de1..00000000000 --- a/test/gridstore/grid_store_file_test.js +++ /dev/null @@ -1,947 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - ObjectID = require('../../lib/mongodb/bson/objectid').ObjectID, - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - GridStore = mongodb.GridStore, - Chunk = mongodb.Chunk, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyFailDueToMissingChunks = function(test) { - var FILE = "empty.test.file"; - client.collection('fs.files', function(err, collection) { - collection.insert({filename: FILE, - "contentType" : "application/json; charset=UTF-8", - "length" : 91, - "chunkSize" : 262144, - "aliases" : null, - "metadata" : {}, - "md5" : "4e638392b289870da9291a242e474930"}, - {safe:true}, function(err, result) { - new mongodb.GridStore(client, FILE, "r").open(function (err, gs) { - gs.read(function(err, data) { - test.ok(err != null); - gs.close(function (){}); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyWriteASmallPayload = function(test) { - var gridStore = new GridStore(client, "test_gs_small_write", "w"); - gridStore.open(function(err, gridStore) { - - gridStore.write("hello world!", function(err, gridStore) { - - gridStore.close(function(err, result) { - - client.collection('fs.files', function(err, collection) { - - collection.find({'filename':'test_gs_small_write'}, function(err, cursor) { - - cursor.toArray(function(err, items) { - test.equal(1, items.length); - var item = items[0]; - test.ok(item._id instanceof ObjectID || Object.prototype.toString.call(item._id) === '[object ObjectID]'); - - client.collection('fs.chunks', function(err, collection) { - var id = ObjectID.createFromHexString(item._id.toHexString()); - - collection.find({'files_id':id}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(1, items.length); - test.done(); - }) - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyWriteSmallFileUsingABuffer = function(test) { - var gridStore = new GridStore(client, "test_gs_small_write_with_buffer", "w"); - gridStore.open(function(err, gridStore) { - var data = new Buffer("hello world", "utf8"); - - gridStore.write(data, function(err, gridStore) { - gridStore.close(function(err, result) { - client.collection('fs.files', function(err, collection) { - collection.find({'filename':'test_gs_small_write_with_buffer'}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(1, items.length); - var item = items[0]; - test.ok(item._id instanceof ObjectID || Object.prototype.toString.call(item._id) === '[object ObjectID]'); - - client.collection('fs.chunks', function(err, collection) { - collection.find({'files_id':item._id}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(1, items.length); - test.done(); - }) - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldSaveSmallFileToGridStore = function(test) { - var gridStore = new GridStore(client, "test_gs_small_file", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello world!", function(err, gridStore) { - gridStore.close(function(err, result) { - client.collection('fs.files', function(err, collection) { - - collection.find({'filename':'test_gs_small_file'}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(1, items.length); - - // Read test of the file - GridStore.read(client, 'test_gs_small_file', function(err, data) { - test.equal('hello world!', data); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyOverwriteFile = function(test) { - var gridStore = new GridStore(client, "test_gs_overwrite", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello world!", function(err, gridStore) { - gridStore.close(function(err, result) { - var gridStore2 = new GridStore(client, "test_gs_overwrite", "w"); - gridStore2.open(function(err, gridStore) { - gridStore2.write("overwrite", function(err, gridStore) { - gridStore2.close(function(err, result) { - - // Assert that we have overwriten the data - GridStore.read(client, 'test_gs_overwrite', function(err, data) { - test.equal('overwrite', data); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the seek method. - * - * @_class gridstore - * @_function seek - * @ignore - */ -exports.shouldCorrectlySeekWithBuffer = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a file and open it - var gridStore = new GridStore(db, "test_gs_seek_with_buffer", "w"); - gridStore.open(function(err, gridStore) { - // Write some content to the file - gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) { - // Flush the file to GridFS - gridStore.close(function(result) { - - // Open the file in read mode - var gridStore2 = new GridStore(db, "test_gs_seek_with_buffer", "r"); - gridStore2.open(function(err, gridStore) { - // Seek to start - gridStore.seek(0, function(err, gridStore) { - // Read first character and verify - gridStore.getc(function(err, chr) { - test.equal('h', chr); - }); - }); - }); - - // Open the file in read mode - var gridStore3 = new GridStore(db, "test_gs_seek_with_buffer", "r"); - gridStore3.open(function(err, gridStore) { - // Seek to 7 characters from the beginning off the file and verify - gridStore.seek(7, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - }); - }); - }); - - // Open the file in read mode - var gridStore5 = new GridStore(db, "test_gs_seek_with_buffer", "r"); - gridStore5.open(function(err, gridStore) { - // Seek to -1 characters from the end off the file and verify - gridStore.seek(-1, GridStore.IO_SEEK_END, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('!', chr); - }); - }); - }); - - // Open the file in read mode - var gridStore6 = new GridStore(db, "test_gs_seek_with_buffer", "r"); - gridStore6.open(function(err, gridStore) { - // Seek to -6 characters from the end off the file and verify - gridStore.seek(-6, GridStore.IO_SEEK_END, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - }); - }); - }); - - // Open the file in read mode - var gridStore7 = new GridStore(db, "test_gs_seek_with_buffer", "r"); - gridStore7.open(function(err, gridStore) { - - // Seek forward 7 characters from the current read position and verify - gridStore.seek(7, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - - // Seek forward -1 characters from the current read position and verify - gridStore.seek(-1, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - - // Seek forward -4 characters from the current read position and verify - gridStore.seek(-4, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('o', chr); - - // Seek forward 3 characters from the current read position and verify - gridStore.seek(3, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('o', chr); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySeekWithString = function(test) { - var gridStore = new GridStore(client, "test_gs_seek", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.close(function(result) { - var gridStore2 = new GridStore(client, "test_gs_seek", "r"); - gridStore2.open(function(err, gridStore) { - gridStore.seek(0, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('h', chr); - }); - }); - }); - - var gridStore3 = new GridStore(client, "test_gs_seek", "r"); - gridStore3.open(function(err, gridStore) { - gridStore.seek(7, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - }); - }); - }); - - var gridStore4 = new GridStore(client, "test_gs_seek", "r"); - gridStore4.open(function(err, gridStore) { - gridStore.seek(4, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('o', chr); - }); - }); - }); - - var gridStore5 = new GridStore(client, "test_gs_seek", "r"); - gridStore5.open(function(err, gridStore) { - gridStore.seek(-1, GridStore.IO_SEEK_END, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('!', chr); - }); - }); - }); - - var gridStore6 = new GridStore(client, "test_gs_seek", "r"); - gridStore6.open(function(err, gridStore) { - gridStore.seek(-6, GridStore.IO_SEEK_END, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - }); - }); - }); - - var gridStore7 = new GridStore(client, "test_gs_seek", "r"); - gridStore7.open(function(err, gridStore) { - gridStore.seek(7, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - - gridStore.seek(-1, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('w', chr); - - gridStore.seek(-4, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('o', chr); - - gridStore.seek(3, GridStore.IO_SEEK_CUR, function(err, gridStore) { - gridStore.getc(function(err, chr) { - test.equal('o', chr); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyAppendToFile = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - fs_client.dropDatabase(function(err, done) { - var gridStore = new GridStore(fs_client, "test_gs_append", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.close(function(err, result) { - - var gridStore2 = new GridStore(fs_client, "test_gs_append", "w+"); - gridStore2.open(function(err, gridStore) { - gridStore.write(" how are you?", function(err, gridStore) { - gridStore.close(function(err, result) { - - fs_client.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - - GridStore.read(fs_client, 'test_gs_append', function(err, data) { - test.equal("hello, world! how are you?", data); - - fs_client.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing how to rewind and overwrite the file. - * - * @_class gridstore - * @_function rewind - * @ignore - */ -exports.shouldCorrectlyRewingAndTruncateOnWrite = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Create a new file - var gridStore = new GridStore(db, fileId, "w"); - // Open the file - gridStore.open(function(err, gridStore) { - // Write to the file - gridStore.write("hello, world!", function(err, gridStore) { - // Flush the file to disk - gridStore.close(function(err, result) { - - // Reopen the file - gridStore = new GridStore(db, fileId, "w"); - gridStore.open(function(err, gridStore) { - // Write some more text to the file - gridStore.write('some text is inserted here', function(err, gridStore) { - - // Let's rewind to truncate the file - gridStore.rewind(function(err, gridStore) { - - // Write something from the start - gridStore.write('abc', function(err, gridStore) { - - // Flush the data to mongodb - gridStore.close(function(err, result) { - - // Verify that the new data was written - GridStore.read(db, fileId, function(err, data) { - test.equal("abc", data); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveEmptyFile = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - fs_client.dropDatabase(function(err, done) { - var gridStore = new GridStore(fs_client, "test_gs_save_empty_file", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("", function(err, gridStore) { - gridStore.close(function(err, result) { - fs_client.collection('fs.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - }); - }); - - fs_client.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - - fs_client.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the eof method. - * - * @_class gridstore - * @_function eof - * @ignore - */ -exports.shouldCorrectlyDetectEOF = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Open the file in write mode - var gridStore = new GridStore(db, 'test_gs_empty_file_eof', "w"); - gridStore.open(function(err, gridStore) { - // Flush the empty file to GridFS - gridStore.close(function(err, gridStore) { - - // Open the file in read mode - var gridStore2 = new GridStore(db, 'test_gs_empty_file_eof', "r"); - gridStore2.open(function(err, gridStore) { - // Verify that we are at the end of the file - test.equal(true, gridStore.eof()); - - db.close(); - test.done(); - }) - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldEnsureThatChunkSizeCannotBeChangedDuringRead = function(test) { - var gridStore = new GridStore(client, "test_gs_cannot_change_chunk_size_on_read", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.close(function(err, result) { - - var gridStore2 = new GridStore(client, "test_gs_cannot_change_chunk_size_on_read", "r"); - gridStore2.open(function(err, gridStore) { - gridStore.chunkSize = 42; - test.equal(Chunk.DEFAULT_CHUNK_SIZE, gridStore.chunkSize); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldEnsureChunkSizeCannotChangeAfterDataHasBeenWritten = function(test) { - var gridStore = new GridStore(client, "test_gs_cannot_change_chunk_size_after_data_written", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.chunkSize = 42; - test.equal(Chunk.DEFAULT_CHUNK_SIZE, gridStore.chunkSize); - test.done(); - }); - }); -} - -/** - * checks if 8 bit values will be preserved in gridstore - * - * @ignore - */ -exports.shouldCorrectlyStore8bitValues = function(test) { - var gridStore = new GridStore(client, "test_gs_check_high_bits", "w"); - var data = new Buffer(255); - for(var i=0; i<255; i++){ - data[i] = i; - } - - gridStore.open(function(err, gridStore) { - gridStore.write(data, function(err, gridStore) { - gridStore.close(function(err, result) { - // Assert that we have overwriten the data - GridStore.read(client, 'test_gs_check_high_bits', function(err, fileData) { - // change testvalue into a string like "0,1,2,...,255" - test.equal(Array.prototype.join.call(data), - Array.prototype.join.call(new Buffer(fileData, "binary"))); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldAllowChangingChunkSize = function(test) { - var gridStore = new GridStore(client, "test_change_chunk_size", "w"); - gridStore.open(function(err, gridStore) { - gridStore.chunkSize = 42 - - gridStore.write('foo', function(err, gridStore) { - gridStore.close(function(err, result) { - var gridStore2 = new GridStore(client, "test_change_chunk_size", "r"); - gridStore2.open(function(err, gridStore) { - test.equal(42, gridStore.chunkSize); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldAllowChangingChunkSizeAtCreationOfGridStore = function(test) { - var gridStore = new GridStore(client, "test_change_chunk_size", "w", {'chunk_size':42}); - gridStore.open(function(err, gridStore) { - gridStore.write('foo', function(err, gridStore) { - gridStore.close(function(err, result) { - var gridStore2 = new GridStore(client, "test_change_chunk_size", "r"); - gridStore2.open(function(err, gridStore) { - test.equal(42, gridStore.chunkSize); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyCalculateMD5 = function(test) { - var gridStore = new GridStore(client, "new-file", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write('hello world\n', function(err, gridStore) { - gridStore.close(function(err, result) { - var gridStore2 = new GridStore(client, "new-file", "r"); - gridStore2.open(function(err, gridStore) { - test.equal("6f5902ac237024bdd0c176cb93063dc4", gridStore.md5); - gridStore.md5 = "can't do this"; - test.equal("6f5902ac237024bdd0c176cb93063dc4", gridStore.md5); - - var gridStore2 = new GridStore(client, "new-file", "w"); - gridStore2.open(function(err, gridStore) { - gridStore.close(function(err, result) { - var gridStore3 = new GridStore(client, "new-file", "r"); - gridStore3.open(function(err, gridStore) { - test.equal("d41d8cd98f00b204e9800998ecf8427e", gridStore.md5); - test.done(); - }); - }) - }) - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyUpdateUploadDate = function(test) { - var now = new Date(); - var originalFileUploadDate = null; - - var gridStore = new GridStore(client, "test_gs_upload_date", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write('hello world\n', function(err, gridStore) { - gridStore.close(function(err, result) { - - var gridStore2 = new GridStore(client, "test_gs_upload_date", "r"); - gridStore2.open(function(err, gridStore) { - test.ok(gridStore.uploadDate != null); - originalFileUploadDate = gridStore.uploadDate; - - gridStore2.close(function(err, result) { - var gridStore3 = new GridStore(client, "test_gs_upload_date", "w"); - gridStore3.open(function(err, gridStore) { - gridStore3.write('new data', function(err, gridStore) { - gridStore3.close(function(err, result) { - var fileUploadDate = null; - - var gridStore4 = new GridStore(client, "test_gs_upload_date", "r"); - gridStore4.open(function(err, gridStore) { - test.equal(originalFileUploadDate.getTime(), gridStore.uploadDate.getTime()); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveContentType = function(test) { - var ct = null; - - var gridStore = new GridStore(client, "test_gs_content_type", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write('hello world\n', function(err, gridStore) { - gridStore.close(function(err, result) { - - var gridStore2 = new GridStore(client, "test_gs_content_type", "r"); - gridStore2.open(function(err, gridStore) { - ct = gridStore.contentType; - test.equal(GridStore.DEFAULT_CONTENT_TYPE, ct); - - var gridStore3 = new GridStore(client, "test_gs_content_type", "w+"); - gridStore3.open(function(err, gridStore) { - gridStore.contentType = "text/html"; - gridStore.close(function(err, result) { - var gridStore4 = new GridStore(client, "test_gs_content_type", "r"); - gridStore4.open(function(err, gridStore) { - test.equal("text/html", gridStore.contentType); - test.done(); - }); - }) - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveContentTypeWhenPassedInAtGridStoreCreation = function(test) { - var gridStore = new GridStore(client, "test_gs_content_type_option", "w", {'content_type':'image/jpg'}); - gridStore.open(function(err, gridStore) { - gridStore.write('hello world\n', function(err, gridStore) { - gridStore.close(function(result) { - - var gridStore2 = new GridStore(client, "test_gs_content_type_option", "r"); - gridStore2.open(function(err, gridStore) { - test.equal('image/jpg', gridStore.contentType); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReportIllegalMode = function(test) { - var gridStore = new GridStore(client, "test_gs_unknown_mode", "x"); - gridStore.open(function(err, gridStore) { - test.ok(err instanceof Error); - test.equal("Illegal mode x", err.message); - test.done(); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveAndRetrieveFileMetadata = function(test) { - var gridStore = new GridStore(client, "test_gs_metadata", "w", {'content_type':'image/jpg'}); - gridStore.open(function(err, gridStore) { - gridStore.write('hello world\n', function(err, gridStore) { - gridStore.close(function(err, result) { - - var gridStore2 = new GridStore(client, "test_gs_metadata", "r"); - gridStore2.open(function(err, gridStore) { - test.equal(null, gridStore.metadata); - - var gridStore3 = new GridStore(client, "test_gs_metadata", "w+"); - gridStore3.open(function(err, gridStore) { - gridStore.metadata = {'a':1}; - gridStore.close(function(err, result) { - - var gridStore4 = new GridStore(client, "test_gs_metadata", "r"); - gridStore4.open(function(err, gridStore) { - test.equal(1, gridStore.metadata.a); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldNotThrowErrorOnClose = function(test) { - var gridStore = new GridStore(client, "test_gs_metadata", "w", {'content_type':'image/jpg'}); - gridStore.open(function(err, gridStore) { - gridStore.write('hello world\n', function(err, gridStore) { - gridStore.close(function(err, result) { - - var gridStore2 = new GridStore(client, "test_gs_metadata", "r"); - gridStore2.open(function(err, gridStore) { - gridStore.close(function(err, fo) { - test.ok(err == null); - test.ok(fo == null); - test.done(); - }) - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the tell method. - * - * @_class gridstore - * @_function tell - * @ignore - */ -exports.shouldCorrectlyExecuteGridstoreTell = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a new file - var gridStore = new GridStore(db, "test_gs_tell", "w"); - // Open the file - gridStore.open(function(err, gridStore) { - // Write a string to the file - gridStore.write("hello, world!", function(err, gridStore) { - // Flush the file to GridFS - gridStore.close(function(err, result) { - - // Open the file in read only mode - var gridStore2 = new GridStore(db, "test_gs_tell", "r"); - gridStore2.open(function(err, gridStore) { - - // Read the first 5 characters - gridStore.read(5, function(err, data) { - test.equal("hello", data); - - // Get the current position of the read head - gridStore.tell(function(err, position) { - test.equal(5, position); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the seek method. - * - * @_class gridstore - * @_function getc - * @ignore - */ -exports.shouldCorrectlyRetrieveSingleCharacterUsingGetC = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a file and open it - var gridStore = new GridStore(db, "test_gs_getc_file", "w"); - gridStore.open(function(err, gridStore) { - // Write some content to the file - gridStore.write(new Buffer("hello, world!", "utf8"), function(err, gridStore) { - // Flush the file to GridFS - gridStore.close(function(result) { - - // Open the file in read mode - var gridStore2 = new GridStore(db, "test_gs_getc_file", "r"); - gridStore2.open(function(err, gridStore) { - - // Read first character and verify - gridStore.getc(function(err, chr) { - test.equal('h', chr); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/gridstore/grid_store_stream_test.js b/test/gridstore/grid_store_stream_test.js deleted file mode 100644 index 8214a66793e..00000000000 --- a/test/gridstore/grid_store_stream_test.js +++ /dev/null @@ -1,310 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - fs = require('fs'), - ObjectID = require('../../lib/mongodb/bson/objectid').ObjectID, - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - GridStore = mongodb.GridStore, - Chunk = mongodb.Chunk, - Step = require("step"), - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyWriteLargeFileStringAndReadBack = function(test) { - var db = client; - var fileId = new ObjectID(); - var gridStore = new GridStore(db, fileId, "w", {root:'fs'}); - gridStore.chunkSize = 5000; - - gridStore.open(function(err, gridStore) { - Step( - function writeData() { - var group = this.group(); - var d = ''; - for(var j = 0; j < 5000;j++) { - d = d + '+'; - } - - for(var i = 0; i < 15000; i += 5000) { - gridStore.write(d, false, group()); - } - }, - - function readAsStream() { - gridStore.close(function(err, result) { - var gotEnd = false; - var endLen = 0; - - var gridStore = new GridStore(db, fileId, "r"); - gridStore.open(function(err, gridStore) { - var stream = gridStore.stream(true); - - stream.on("data", function(chunk) { - endLen += chunk.length - // Test length of chunk - test.equal(5000, chunk.length); - // Check each chunk's data - for(var i = 0; i < 5000; i++) test.equal('+', String.fromCharCode(chunk[i])); - }); - - stream.on("end", function() { - gotEnd = true; - }); - - stream.on("close", function() { - test.equal(15000, endLen); - test.equal(true, gotEnd); - test.done(); - }); - }); - }); - } - ) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyWriteLargeFileBufferAndReadBack = function(test) { - var db = client; - var fileId = new ObjectID(); - var gridStore = new GridStore(db, fileId, "w", {root:'fs'}); - gridStore.chunkSize = 5000; - - gridStore.open(function(err, gridStore) { - Step( - function writeData() { - var group = this.group(); - var d = new Buffer(5000); - for(var j = 0; j < 5000;j++) { - d[j] = 43; - } - - for(var i = 0; i < 15000; i += 5000) { - gridStore.write(d, false, group()); - } - }, - - function readAsStream() { - gridStore.close(function(err, result) { - var gotEnd = false; - var endLen = 0; - - var gridStore = new GridStore(db, fileId, "r"); - gridStore.open(function(err, gridStore) { - var stream = gridStore.stream(true); - - stream.on("data", function(chunk) { - endLen += chunk.length - // Test length of chunk - test.equal(5000, chunk.length); - // Check each chunk's data - for(var i = 0; i < 5000; i++) test.equal('+', String.fromCharCode(chunk[i])); - }); - - stream.on("end", function() { - gotEnd = true; - }); - - stream.on("close", function() { - test.equal(15000, endLen); - test.equal(true, gotEnd); - test.done(); - }); - }); - }); - } - ) - }); -} - -/** - * A simple example showing the usage of the stream method. - * - * @_class gridstore - * @_function stream - * @ignore - */ -exports.shouldCorrectlyReadFileUsingStream = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Open a file for reading - var gridStoreR = new GridStore(db, "test_gs_read_stream", "r"); - // Open a file for writing - var gridStoreW = new GridStore(db, "test_gs_read_stream", "w"); - // Read in the data of a file - var data = fs.readFileSync("./test/gridstore/test_gs_weird_bug.png"); - - var readLen = 0; - var gotEnd = 0; - - // Open the file we are writting to - gridStoreW.open(function(err, gs) { - // Write the file content - gs.write(data, function(err, gs) { - // Flush the file to GridFS - gs.close(function(err, result) { - - // Open the read file - gridStoreR.open(function(err, gs) { - - // Create a stream to the file - var stream = gs.stream(true); - - // Register events - stream.on("data", function(chunk) { - // Record the length of the file - readLen += chunk.length; - }); - - stream.on("end", function() { - // Record the end was called - ++gotEnd; - }); - - stream.on("close", function() { - // Verify the correctness of the read data - test.equal(data.length, readLen); - test.equal(1, gotEnd); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should return same data for streaming as for direct read'] = function(test) { - var gridStoreR = new GridStore(client, "test_gs_read_stream", "r"); - var gridStoreW = new GridStore(client, "test_gs_read_stream", "w", {chunkSize:56}); - // var data = fs.readFileSync("./test/gridstore/test_gs_weird_bug.png"); - var data = new Buffer(100); - for(var i = 0; i < 100; i++) { - data[i] = i; - } - - var readLen = 0; - var gotEnd = 0; - - gridStoreW.open(function(err, gs) { - gs.write(data, function(err, gs) { - gs.close(function(err, result) { - gridStoreR.open(function(err, gs) { - var chunks = []; - - var stream = gs.stream(true); - stream.on("data", function(chunk) { - readLen += chunk.length; - chunks.push(chunk); - }); - stream.on("end", function() { - ++gotEnd; - }); - stream.on("close", function() { - test.equal(data.length, readLen); - test.equal(1, gotEnd); - - // Read entire file in one go and compare - var gridStoreRead = new GridStore(client, "test_gs_read_stream", "r"); - gridStoreRead.open(function(err, gs) { - gridStoreRead.read(function(err, data2) { - // Put together all the chunks - var streamData = new Buffer(data.length); - var index = 0; - for(var i = 0; i < chunks.length; i++) { - chunks[i].copy(streamData, index, 0); - index = index + chunks[i].length; - } - - // Compare data - for(var i = 0; i < data.length; i++) { - test.equal(data2[i], data[i]) - test.equal(streamData[i], data[i]) - } - - test.done(); - }) - }) - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/gridstore/grid_store_test.js b/test/gridstore/grid_store_test.js deleted file mode 100644 index 9d9082186ad..00000000000 --- a/test/gridstore/grid_store_test.js +++ /dev/null @@ -1,1351 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - fs = require('fs'), - ObjectID = require('../../lib/mongodb/bson/objectid').ObjectID, - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - GridStore = mongodb.GridStore, - Chunk = mongodb.Chunk, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -// var MONGODB = 'ruby-test-db'; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A simple example showing the usage of the Gridstore.exist method. - * - * @_class gridstore - * @_function GridStore.exist - * @ignore - */ -exports.shouldCorrectlyExecuteGridStoreExistsByObjectId = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Open a file for writing - var gridStore = new GridStore(db, null, "w"); - gridStore.open(function(err, gridStore) { - - // Writing some content to the file - gridStore.write("hello world!", function(err, gridStore) { - - // Flush the file to GridFS - gridStore.close(function(err, result) { - - // Check if the file exists using the id returned from the close function - GridStore.exist(db, result._id, function(err, result) { - test.equal(true, result); - }) - - // Show that the file does not exist for a random ObjectID - GridStore.exist(db, new ObjectID(), function(err, result) { - test.equal(false, result); - }); - - // Show that the file does not exist for a different file root - GridStore.exist(db, result._id, 'another_root', function(err, result) { - test.equal(false, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySafeFileAndReadFileByObjectId = function(test) { - var gridStore = new GridStore(client, null, "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello world!", function(err, gridStore) { - gridStore.close(function(err, result) { - - // Let's read the file using object Id - GridStore.read(client, result._id, function(err, data) { - test.equal('hello world!', data); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteGridStoreExists = function(test) { - var gridStore = new GridStore(client, "foobar", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello world!", function(err, gridStore) { - gridStore.close(function(err, result) { - GridStore.exist(client, 'foobar', function(err, result) { - test.equal(true, result); - }); - - GridStore.exist(client, 'does_not_exist', function(err, result) { - test.equal(false, result); - }); - - GridStore.exist(client, 'foobar', 'another_root', function(err, result) { - test.equal(false, result); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the eof method. - * - * @_class gridstore - * @_function GridStore.list - * @ignore - */ -exports.shouldCorrectlyExecuteGridStoreList = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Open a file for writing - var gridStore = new GridStore(db, "foobar2", "w"); - gridStore.open(function(err, gridStore) { - - // Write some content to the file - gridStore.write("hello world!", function(err, gridStore) { - // Flush to GridFS - gridStore.close(function(err, result) { - - // List the existing files - GridStore.list(db, function(err, items) { - var found = false; - items.forEach(function(filename) { - if(filename == 'foobar2') found = true; - }); - - test.ok(items.length >= 1); - test.ok(found); - }); - - // List the existing files but return only the file ids - GridStore.list(db, {id:true}, function(err, items) { - var found = false; - items.forEach(function(id) { - test.ok(typeof id == 'object'); - }); - - test.ok(items.length >= 1); - }); - - // List the existing files in a specific root collection - GridStore.list(db, 'fs', function(err, items) { - var found = false; - items.forEach(function(filename) { - if(filename == 'foobar2') found = true; - }); - - test.ok(items.length >= 1); - test.ok(found); - }); - - // List the existing files in a different root collection where the file is not located - GridStore.list(client, 'my_fs', function(err, items) { - var found = false; - items.forEach(function(filename) { - if(filename == 'foobar2') found = true; - }); - - test.ok(items.length >= 0); - test.ok(!found); - - // Write another file to GridFS - var gridStore2 = new GridStore(db, "foobar3", "w"); - gridStore2.open(function(err, gridStore) { - // Write the content - gridStore2.write('my file', function(err, gridStore) { - // Flush to GridFS - gridStore.close(function(err, result) { - - // List all the available files and verify that our files are there - GridStore.list(db, function(err, items) { - var found = false; - var found2 = false; - - items.forEach(function(filename) { - if(filename == 'foobar2') found = true; - if(filename == 'foobar3') found2 = true; - }); - - test.ok(items.length >= 2); - test.ok(found); - test.ok(found2); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPeformGridStoreReadLength = function(test) { - var gridStore = new GridStore(client, "test_gs_read_length", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello world!", function(err, gridStore) { - gridStore.close(function(err, result) { - // Assert that we have overwriten the data - GridStore.read(client, 'test_gs_read_length', 5, function(err, data) { - test.equal('hello', data); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReadFromFileWithOffset = function(test) { - var gridStore = new GridStore(client, "test_gs_read_with_offset", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.close(function(err, result) { - // Assert that we have overwriten the data - GridStore.read(client, 'test_gs_read_with_offset', 5, 7, function(err, data) { - test.equal('world', data); - }); - - GridStore.read(client, 'test_gs_read_with_offset', null, 7, function(err, data) { - test.equal('world!', data); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleMultipleChunkGridStore = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - fs_client.dropDatabase(function(err, done) { - var gridStore = new GridStore(fs_client, "test_gs_multi_chunk", "w"); - gridStore.open(function(err, gridStore) { - gridStore.chunkSize = 512; - var file1 = ''; var file2 = ''; var file3 = ''; - for(var i = 0; i < gridStore.chunkSize; i++) { file1 = file1 + 'x'; } - for(var i = 0; i < gridStore.chunkSize; i++) { file2 = file2 + 'y'; } - for(var i = 0; i < gridStore.chunkSize; i++) { file3 = file3 + 'z'; } - - gridStore.write(file1, function(err, gridStore) { - gridStore.write(file2, function(err, gridStore) { - gridStore.write(file3, function(err, gridStore) { - gridStore.close(function(err, result) { - fs_client.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(3, count); - - GridStore.read(fs_client, 'test_gs_multi_chunk', function(err, data) { - test.equal(512*3, data.length); - fs_client.close(); - - test.done(); - }); - }) - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the puts method. - * - * @_class gridstore - * @_function puts - * @ignore - */ -exports.shouldCorrectlyReadlinesAndPutLines = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Open a file for writing - var gridStore = new GridStore(db, "test_gs_puts_and_readlines", "w"); - gridStore.open(function(err, gridStore) { - - // Write a line to the file using the puts method - gridStore.puts("line one", function(err, gridStore) { - - // Flush the file to GridFS - gridStore.close(function(err, result) { - - // Read in the entire contents - GridStore.read(db, 'test_gs_puts_and_readlines', function(err, data) { - test.equal("line one\n", data.toString()); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleUnlinkingWeirdName = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - fs_client.dropDatabase(function(err, done) { - var gridStore = new GridStore(fs_client, "9476700.937375426_1271170118964-clipped.png", "w", {'root':'articles'}); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.close(function(err, result) { - fs_client.collection('articles.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - }) - }); - - fs_client.collection('articles.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - - // Unlink the file - GridStore.unlink(fs_client, '9476700.937375426_1271170118964-clipped.png', {'root':'articles'}, function(err, gridStore) { - fs_client.collection('articles.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - }) - }); - - fs_client.collection('articles.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - - fs_client.close(); - test.done(); - }) - }); - }); - }) - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the GridStore.unlink method. - * - * @_class gridstore - * @_function GridStore.unlink - * @ignore - */ -exports.shouldCorrectlyUnlink = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Open a new file for writing - var gridStore = new GridStore(db, "test_gs_unlink", "w"); - gridStore.open(function(err, gridStore) { - - // Write some content - gridStore.write("hello, world!", function(err, gridStore) { - - // Flush file to GridFS - gridStore.close(function(err, result) { - - // Verify the existance of the fs.files document - db.collection('fs.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - }) - }); - - // Verify the existance of the fs.chunks chunk document - db.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - - // Unlink the file (removing it) - GridStore.unlink(db, 'test_gs_unlink', function(err, gridStore) { - - // Verify that fs.files document is gone - db.collection('fs.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - }) - }); - - // Verify that fs.chunks chunk documents are gone - db.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - - db.close(); - test.done(); - }) - }); - }); - }) - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyUnlinkAnArrayOfFiles = function(test) { - var fs_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - fs_client.open(function(err, fs_client) { - fs_client.dropDatabase(function(err, done) { - var gridStore = new GridStore(fs_client, "test_gs_unlink_as_array", "w"); - gridStore.open(function(err, gridStore) { - gridStore.write("hello, world!", function(err, gridStore) { - gridStore.close(function(err, result) { - fs_client.collection('fs.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - }) - }); - - fs_client.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(1, count); - - // Unlink the file - GridStore.unlink(fs_client, ['test_gs_unlink_as_array'], function(err, gridStore) { - fs_client.collection('fs.files', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - }) - }); - - fs_client.collection('fs.chunks', function(err, collection) { - collection.count(function(err, count) { - test.equal(0, count); - fs_client.close(); - - test.done(); - }) - }); - }); - }) - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyWriteFileToGridStore= function(test) { - var gridStore = new GridStore(client, 'test_gs_writing_file', 'w'); - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - gridStore.open(function(err, gridStore) { - gridStore.writeFile('./test/gridstore/test_gs_weird_bug.png', function(err, doc) { - GridStore.read(client, 'test_gs_writing_file', function(err, fileData) { - test.equal(data.toString('hex'), fileData.toString('hex')); - test.equal(fileSize, fileData.length); - - // Ensure we have a md5 - var gridStore2 = new GridStore(client, 'test_gs_writing_file', 'r'); - gridStore2.open(function(err, gridStore2) { - test.ok(gridStore2.md5 != null) - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyWriteFileToGridStoreUsingObjectId= function(test) { - var gridStore = new GridStore(client, null, 'w'); - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - gridStore.open(function(err, gridStore) { - gridStore.writeFile('./test/gridstore/test_gs_weird_bug.png', function(err, doc) { - - GridStore.read(client, doc._id, function(err, fileData) { - test.equal(data.toString('hex'), fileData.toString('hex')); - test.equal(fileSize, fileData.length); - - // Ensure we have a md5 - var gridStore2 = new GridStore(client, doc._id, 'r'); - gridStore2.open(function(err, gridStore2) { - test.ok(gridStore2.md5 != null) - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformWorkingFiledRead = function(test) { - var gridStore = new GridStore(client, "test_gs_working_field_read", "w"); - var data = fs.readFileSync("./test/gridstore/test_gs_working_field_read.pdf", 'binary'); - - gridStore.open(function(err, gridStore) { - gridStore.write(data, function(err, gridStore) { - gridStore.close(function(err, result) { - // Assert that we have overwriten the data - GridStore.read(client, 'test_gs_working_field_read', function(err, fileData) { - test.equal(data.length, fileData.length); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReadAndWriteFile = function(test) { - var gridStore = new GridStore(client, "test_gs_weird_bug", "w"); - var data = fs.readFileSync("./test/gridstore/test_gs_weird_bug.png", 'binary'); - - gridStore.open(function(err, gridStore) { - gridStore.write(data, function(err, gridStore) { - gridStore.close(function(err, result) { - // Assert that we have overwriten the data - GridStore.read(client, 'test_gs_weird_bug', function(err, fileData) { - test.equal(data.length, fileData.length); - test.done(); - }); - }); - }); - }); -} - - -/** - * A simple example showing the usage of the read method. - * - * @_class gridstore - * @_function read - * @ignore - */ -exports.shouldCorrectlyWriteAndReadJpgImage = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Read in the content of a file - var data = fs.readFileSync('./test/gridstore/iya_logo_final_bw.jpg'); - // Create a new file - var gs = new GridStore(db, "test", "w"); - // Open the file - gs.open(function(err, gs) { - // Write the file to GridFS - gs.write(data, function(err, gs) { - // Flush to the GridFS - gs.close(function(err, gs) { - - // Define the file we wish to read - var gs2 = new GridStore(db, "test", "r"); - // Open the file - gs2.open(function(err, gs) { - // Set the pointer of the read head to the start of the gridstored file - gs2.seek(0, function() { - // Read the entire file - gs2.read(function(err, data2) { - // Compare the file content against the orgiinal - test.equal(data.toString('hex'), data2.toString('hex')); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReadAndWriteBuffersMultipleChunks = function(test) { - var gridStore = new GridStore(client, null, 'w'); - // Force multiple chunks to be stored - gridStore.chunkSize = 5000; - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - gridStore.open(function(err, gridStore) { - - // Write the file using write - gridStore.write(data, function(err, doc) { - gridStore.close(function(err, doc) { - - // Read the file using readBuffer - new GridStore(client, doc._id, 'r').open(function(err, gridStore) { - gridStore.read(function(err, data2) { - test.equal(data.toString('base64'), data2.toString('base64')); - test.done(); - }) - }); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReadAndWriteBuffersSingleChunks = function(test) { - var gridStore = new GridStore(client, null, 'w'); - // Force multiple chunks to be stored - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - gridStore.open(function(err, gridStore) { - - // Write the file using writeBuffer - gridStore.write(data, function(err, doc) { - gridStore.close(function(err, doc) { - - // Read the file using readBuffer - new GridStore(client, doc._id, 'r').open(function(err, gridStore) { - gridStore.read(function(err, data2) { - test.equal(data.toString('base64'), data2.toString('base64')); - test.done(); - }) - }); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReadAndWriteBuffersUsingNormalWriteWithMultipleChunks = function(test) { - var gridStore = new GridStore(client, null, 'w'); - // Force multiple chunks to be stored - gridStore.chunkSize = 5000; - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - gridStore.open(function(err, gridStore) { - - // Write the buffer using the .write method that should use writeBuffer correctly - gridStore.write(data, function(err, doc) { - gridStore.close(function(err, doc) { - - // Read the file using readBuffer - new GridStore(client, doc._id, 'r').open(function(err, gridStore) { - gridStore.read(function(err, data2) { - test.equal(data.toString('base64'), data2.toString('base64')); - test.done(); - }) - }); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyReadAndWriteBuffersSingleChunksAndVerifyExistance = function(test) { - var gridStore = new GridStore(client, null, 'w'); - // Force multiple chunks to be stored - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - gridStore.open(function(err, gridStore) { - - // Write the file using writeBuffer - gridStore.write(data, function(err, doc) { - gridStore.close(function(err, doc) { - - // Read the file using readBuffer - GridStore.exist(client, doc._id, function(err, result) { - test.equal(null, err); - test.equal(true, result); - - client.close(); - test.done(); - }); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySaveDataByObjectID = function(test) { - var id = new ObjectID(); - var gridStore = new GridStore(client, id, 'w'); - - gridStore.open(function(err, gridStore) { - gridStore.write('bar', function(err, gridStore) { - gridStore.close(function(err, result) { - - GridStore.exist(client, id, function(err, result) { - test.equal(null, err); - test.equal(true, result); - - client.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCheckExistsByUsingRegexp = function(test) { - var gridStore = new GridStore(client, 'shouldCheckExistsByUsingRegexp.txt', 'w'); - - gridStore.open(function(err, gridStore) { - gridStore.write('bar', function(err, gridStore) { - gridStore.close(function(err, result) { - - GridStore.exist(client, /shouldCheck/, function(err, result) { - test.equal(null, err); - test.equal(true, result); - - client.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing opening a file using a filename, writing to it and saving it. - * - * @_class gridstore - * @_function open - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingFilename = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a new instance of the gridstore - var gridStore = new GridStore(db, 'ourexamplefiletowrite.txt', 'w'); - - // Open the file - gridStore.open(function(err, gridStore) { - - // Write some data to the file - gridStore.write('bar', function(err, gridStore) { - test.equal(null, err); - - // Close (Flushes the data to MongoDB) - gridStore.close(function(err, result) { - test.equal(null, err); - - // Verify that the file exists - GridStore.exist(db, 'ourexamplefiletowrite.txt', function(err, result) { - test.equal(null, err); - test.equal(true, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing opening a file using an ObjectID, writing to it and saving it. - * - * @_class gridstore - * @_function open - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingObjectID = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Create a new instance of the gridstore - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the file - gridStore.open(function(err, gridStore) { - - // Write some data to the file - gridStore.write('bar', function(err, gridStore) { - test.equal(null, err); - - // Close (Flushes the data to MongoDB) - gridStore.close(function(err, result) { - test.equal(null, err); - - // Verify that the file exists - GridStore.exist(db, fileId, function(err, result) { - test.equal(null, err); - test.equal(true, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing how to write a file to Gridstore using file location path. - * - * @_class gridstore - * @_function writeFile - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingWriteFile = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Read the filesize of file on disk (provide your own) - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - // Read the buffered data for comparision reasons - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write the file to gridFS - gridStore.writeFile('./test/gridstore/test_gs_weird_bug.png', function(err, doc) { - - // Read back all the written content and verify the correctness - GridStore.read(db, fileId, function(err, fileData) { - test.equal(data.toString('hex'), fileData.toString('hex')) - test.equal(fileSize, fileData.length); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing how to write a file to Gridstore using a file handle. - * - * @_class gridstore - * @_function writeFile - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingWriteFileWithHandle = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Read the filesize of file on disk (provide your own) - var fileSize = fs.statSync('./test/gridstore/test_gs_weird_bug.png').size; - // Read the buffered data for comparision reasons - var data = fs.readFileSync('./test/gridstore/test_gs_weird_bug.png'); - - // Open a file handle for reading the file - var fd = fs.openSync('./test/gridstore/test_gs_weird_bug.png', 'r', 0666); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write the file to gridFS using the file handle - gridStore.writeFile(fd, function(err, doc) { - - // Read back all the written content and verify the correctness - GridStore.read(db, fileId, function(err, fileData) { - test.equal(data.toString('hex'), fileData.toString('hex')); - test.equal(fileSize, fileData.length); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing how to use the write command with strings and Buffers. - * - * @_class gridstore - * @_function write - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingWriteWithStringsAndBuffers = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write a text string - gridStore.write('Hello world', function(err, gridStore) { - - // Write a buffer - gridStore.write(new Buffer('Buffer Hello world'), function(err, gridStore) { - - // Close the - gridStore.close(function(err, result) { - - // Read back all the written content and verify the correctness - GridStore.read(db, fileId, function(err, fileData) { - test.equal('Hello worldBuffer Hello world', fileData.toString()); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing how to use the write command with strings and Buffers. - * - * @_class gridstore - * @_function close - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingClose = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write a text string - gridStore.write('Hello world', function(err, gridStore) { - - // Close the - gridStore.close(function(err, result) { - test.equal(err, null); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * A simple example showing how to access the chunks collection object. - * - * @_class gridstore - * @_function chunkCollection - * @ignore - */ -exports.shouldCorrectlyAccessChunkCollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Access the Chunk collection - gridStore.chunkCollection(function(err, collection) { - test.equal(err, null); - test.ok(collection instanceof Collection); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * A simple example showing how to use the instance level unlink command to delete a gridstore item. - * - * @_class gridstore - * @_function unlink - * @ignore - */ -exports.shouldCorrectlySaveSimpleFileToGridStoreUsingCloseAndThenUnlinkIt = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write a text string - gridStore.write('Hello world', function(err, gridStore) { - - // Close the - gridStore.close(function(err, result) { - test.equal(err, null); - - // Open the file again and unlin it - new GridStore(db, fileId, 'r').open(function(err, gridStore) { - - // Unlink the file - gridStore.unlink(function(err, result) { - test.equal(null, err); - - // Verify that the file no longer exists - GridStore.exist(db, fileId, function(err, result) { - test.equal(null, err); - test.equal(false, result); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing how to access the files collection object. - * - * @_class gridstore - * @_function collection - * @ignore - */ -exports.shouldCorrectlyAccessFilesCollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Access the Chunk collection - gridStore.collection(function(err, collection) { - test.equal(err, null); - test.ok(collection instanceof Collection); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * A simple example showing reading back using readlines to split the text into lines by the seperator provided. - * - * @_class gridstore - * @_function GridStore.readlines - * @ignore - */ -exports.shouldCorrectlyPutACoupleOfLinesInGridStoreAndUseReadlines = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write one line to gridStore - gridStore.puts("line one", function(err, gridStore) { - - // Write second line to gridStore - gridStore.puts("line two", function(err, gridStore) { - - // Write third line to gridStore - gridStore.puts("line three", function(err, gridStore) { - - // Flush file to disk - gridStore.close(function(err, result) { - - // Read back all the lines - GridStore.readlines(db, fileId, function(err, lines) { - test.deepEqual(["line one\n", "line two\n", "line three\n"], lines); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing reading back using readlines to split the text into lines by the seperator provided. - * - * @_class gridstore - * @_function readlines - * @ignore - */ -exports.shouldCorrectlyPutACoupleOfLinesInGridStoreAndUseInstanceReadlines = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Our file ID - var fileId = new ObjectID(); - - // Open a new file - var gridStore = new GridStore(db, fileId, 'w'); - - // Open the new file - gridStore.open(function(err, gridStore) { - - // Write one line to gridStore - gridStore.puts("line one", function(err, gridStore) { - - // Write second line to gridStore - gridStore.puts("line two", function(err, gridStore) { - - // Write third line to gridStore - gridStore.puts("line three", function(err, gridStore) { - - // Flush file to disk - gridStore.close(function(err, result) { - - // Open file for reading - gridStore = new GridStore(db, fileId, 'r'); - gridStore.open(function(err, gridStore) { - - // Read all the lines and verify correctness - gridStore.readlines(function(err, lines) { - test.deepEqual(["line one\n", "line two\n", "line three\n"], lines); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the usage of the read method. - * - * @_class gridstore - * @_function GridStore.read - * @ignore - */ -exports.shouldCorrectlyPutACoupleOfLinesInGridStoreRead = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a new file - var gridStore = new GridStore(db, null, "w"); - // Read in the content from a file, replace with your own - var data = fs.readFileSync("./test/gridstore/test_gs_weird_bug.png"); - - // Open the file - gridStore.open(function(err, gridStore) { - // Write the binary file data to GridFS - gridStore.write(data, function(err, gridStore) { - // Flush the remaining data to GridFS - gridStore.close(function(err, result) { - - // Read in the whole file and check that it's the same content - GridStore.read(client, result._id, function(err, fileData) { - test.equal(data.length, fileData.length); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/gridstore/grid_test.js b/test/gridstore/grid_test.js deleted file mode 100644 index ec13722609d..00000000000 --- a/test/gridstore/grid_test.js +++ /dev/null @@ -1,189 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../../lib/mongodb').native() : require('../../lib/mongodb').pure(); - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - GridStore = mongodb.GridStore, - Grid = mongodb.Grid, - Chunk = mongodb.Chunk, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A simple example showing the usage of the put method. - * - * @_class grid - * @_function put - * @ignore - */ -exports.shouldPutFileCorrectlyToGridUsingObjectId = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a new grid instance - var grid = new Grid(db, 'fs'); - // Some data to write - var originalData = new Buffer('Hello world'); - // Write data to grid - grid.put(originalData, {}, function(err, result) { - // Fetch the content - grid.get(result._id, function(err, data) { - test.deepEqual(originalData.toString('hex'), data.toString('hex')); - - db.close(); - test.done(); - }); - }); - }); -} - -/** - * A simple example showing the usage of the get method. - * - * @_class grid - * @_function get - * @ignore - */ -exports.shouldPutAndGetFileCorrectlyToGridUsingObjectId = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a new grid instance - var grid = new Grid(db, 'fs'); - // Some data to write - var originalData = new Buffer('Hello world'); - // Write data to grid - grid.put(originalData, {}, function(err, result) { - // Fetch the content - grid.get(result._id, function(err, data) { - test.deepEqual(originalData.toString('base64'), data.toString('base64')); - - // Should fail due to illegal objectID - grid.get('not an id', function(err, result) { - test.ok(err != null); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldFailToPutFileDueToDataObjectNotBeingBuffer = function(test) { - var grid = new Grid(client, 'fs'); - var originalData = 'Hello world'; - // Write data to grid - grid.put(originalData, {}, function(err, result) { - test.ok(err != null); - test.done(); - }) -} - -/** - * A simple example showing the usage of the delete method. - * - * @_class grid - * @_function delete - * @ignore - */ -exports.shouldCorrectlyWriteFileAndThenDeleteIt = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // Create a new grid instance - var grid = new Grid(client, 'fs'); - // Some data to write - var originalData = new Buffer('Hello world'); - // Write data to grid - grid.put(originalData, {}, function(err, result) { - - // Delete file - grid.delete(result._id, function(err, result2) { - test.equal(null, err); - test.equal(true, result2); - - // Fetch the content, showing that the file is gone - grid.get(result._id, function(err, data) { - test.ok(err != null); - test.equal(null, data); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/gridstore/iya_logo_final_bw.jpg b/test/gridstore/iya_logo_final_bw.jpg deleted file mode 100644 index 0f07b9e3a4c..00000000000 Binary files a/test/gridstore/iya_logo_final_bw.jpg and /dev/null differ diff --git a/test/gridstore/readstream_test.js b/test/gridstore/readstream_test.js deleted file mode 100644 index 5ced68a4205..00000000000 --- a/test/gridstore/readstream_test.js +++ /dev/null @@ -1,239 +0,0 @@ -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../../dev/tools/gleak'), - Db = require('../../lib/mongodb').Db, - ObjectID = require('../../lib/mongodb').ObjectID, - Cursor = require('../../lib/mongodb').Cursor, - Step = require("step"), - Collection = require('../../lib/mongodb').Collection, - GridStore = require('../../lib/mongodb').GridStore, - fs = require('fs'), - Server = require('../../lib/mongodb').Server; - -var MONGODB = 'integration_tests'; -var useSSL = process.env['USE_SSL'] != null ? true : false; -var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); -var native_parser = (process.env['TEST_NATIVE'] != null); - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A simple example showing the use of the readstream pause function. - * - * @_class readstream - * @_function pause - * @ignore - */ -exports.shouldStreamDocumentsUsingTheReadStreamPauseFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // File id - var fileId = new ObjectID(); - // Create a file - var file = new GridStore(db, fileId, "w"); - file.open(function(err, file) { - // Write some content and flush to disk - file.write('Hello world', function(err, file) { - file.close(function(err, result) { - - // Let's create a read file - file = new GridStore(db, fileId, "r"); - // Open the file - file.open(function(err, file) { - // Peform a find to get a cursor - var stream = file.stream(); - - // For each data item - stream.on("data", function(item) { - // Check if stream is paused - test.equal(false, stream.paused); - // Pause stream - stream.pause(); - // Check if cursor is paused - test.equal(true, stream.paused); - - // Restart the stream after 1 miliscecond - setTimeout(function() { - stream.resume(); - // Check if cursor is paused - test.equal(false, stream.paused); - }, 1); - }); - - // For each data item - stream.on("end", function(item) {}); - // When the stream is done - stream.on("close", function() { - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the readstream resume function. - * - * @_class readstream - * @_function resume - * @ignore - */ -exports.shouldStreamDocumentsUsingTheReadStreamResumeFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // File id - var fileId = new ObjectID(); - // Create a file - var file = new GridStore(db, fileId, "w"); - file.open(function(err, file) { - // Write some content and flush to disk - file.write('Hello world', function(err, file) { - file.close(function(err, result) { - - // Let's create a read file - file = new GridStore(db, fileId, "r"); - // Open the file - file.open(function(err, file) { - // Peform a find to get a cursor - var stream = file.stream(); - - // For each data item - stream.on("data", function(item) { - // Check if stream is paused - test.equal(false, stream.paused); - // Pause stream - stream.pause(); - // Check if cursor is paused - test.equal(true, stream.paused); - - // Restart the stream after 1 miliscecond - setTimeout(function() { - stream.resume(); - // Check if cursor is paused - test.equal(false, stream.paused); - }, 1); - }); - - // For each data item - stream.on("end", function(item) {}); - // When the stream is done - stream.on("close", function() { - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple example showing the use of the readstream destroy function. - * - * @_class readstream - * @_function destroy - * @ignore - */ -exports.shouldStreamDocumentsUsingTheReadStreamDestroyFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - // File id - var fileId = new ObjectID(); - // Create a file - var file = new GridStore(db, fileId, "w"); - file.open(function(err, file) { - // Write some content and flush to disk - file.write('Hello world', function(err, file) { - file.close(function(err, result) { - - // Let's create a read file - file = new GridStore(db, fileId, "r"); - // Open the file - file.open(function(err, file) { - // Peform a find to get a cursor - var stream = file.stream(); - - // For each data item - stream.on("data", function(item) { - // Destroy the stream - stream.destroy(); - }); - - // When the stream is done - stream.on("close", function() { - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/gridstore/test_gs_weird_bug.png b/test/gridstore/test_gs_weird_bug.png deleted file mode 100644 index 1554dc3238d..00000000000 Binary files a/test/gridstore/test_gs_weird_bug.png and /dev/null differ diff --git a/test/gridstore/test_gs_working_field_read.pdf b/test/gridstore/test_gs_working_field_read.pdf deleted file mode 100644 index 4b1247a542c..00000000000 Binary files a/test/gridstore/test_gs_working_field_read.pdf and /dev/null differ diff --git a/test/index_test.js b/test/index_test.js deleted file mode 100644 index 5f6feff5b42..00000000000 --- a/test/index_test.js +++ /dev/null @@ -1,699 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A simple createIndex using a simple single field index - * - * @_class collection - * @_function createIndex - */ -exports.shouldCreateASimpleIndexOnASingleField = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('simple_index_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1}, {a:2}, {a:3}, {a:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.createIndex('a', function(err, indexName) { - test.equal("a_1", indexName); - - // Peform a query, with explain to show we hit the query - collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { - test.deepEqual([[2, 2]], explanation[0].indexBounds.a); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * A more complex createIndex using a compound unique index in the background and dropping duplicated documents - * - * @_class collection - * @_function createIndex - */ -exports.shouldCreateComplexIndexOnTwoFields = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('more_complex_index_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.createIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Show that duplicate records got dropped - collection.find({}).toArray(function(err, items) { - test.equal(null, err); - test.equal(4, items.length); - - // Peform a query, with explain to show we hit the query - collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { - test.equal(null, err); - test.ok(explanation[0].indexBounds.a != null); - test.ok(explanation[0].indexBounds.b != null); - - db.close(); - test.done(); - }); - }) - }); - }); - }); - }); -} - -/** - * A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents. - * - * @_class collection - * @_function ensureIndex - */ -exports.shouldCreateComplexEnsureIndex = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('more_complex_ensure_index_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Show that duplicate records got dropped - collection.find({}).toArray(function(err, items) { - test.equal(null, err); - test.equal(4, items.length); - - // Peform a query, with explain to show we hit the query - collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { - test.equal(null, err); - test.ok(explanation[0].indexBounds.a != null); - test.ok(explanation[0].indexBounds.b != null); - - db.close(); - test.done(); - }); - }) - }); - }); - }); - }); -} - -/** - * An examples showing the information returned by indexInformation - * - * @_class collection - * @_function indexInformation - */ -exports.shouldCorrectlyShowTheResultsFromIndexInformation = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('more_index_information_test', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Fetch basic indexInformation for collection - collection.indexInformation(function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); - - // Fetch full index information - collection.indexInformation({full:true}, function(err, indexInformation) { - test.deepEqual({ _id: 1 }, indexInformation[0].key); - test.deepEqual({ a: 1, b: 1 }, indexInformation[1].key); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * An examples showing the creation and dropping of an index - * - * @_class collection - * @_function dropIndex - */ -exports.shouldCorrectlyCreateAndDropIndex = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('create_and_drop_an_index', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Drop the index - collection.dropIndex("a_1_b_1", function(err, result) { - test.equal(null, err); - - // Verify that the index is gone - collection.indexInformation(function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.equal(null, indexInformation.a_1_b_1); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * An examples showing the creation and dropping of an index - * - * @_class collection - * @_function dropIndexes - */ -exports.shouldCorrectlyCreateAndDropAllIndex = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('create_and_drop_all_indexes', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Create an additional index - collection.ensureIndex({c:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Drop the index - collection.dropAllIndexes(function(err, result) { - test.equal(null, err); - - // Verify that the index is gone - collection.indexInformation(function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.equal(null, indexInformation.a_1_b_1); - test.equal(null, indexInformation.c_1); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * An example showing how to force a reindex of a collection. - * - * @_class collection - * @_function reIndex - */ -exports.shouldCorrectlyForceReindexOnCollection = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a collection we want to drop later - db.createCollection('create_and_drop_all_indexes', function(err, collection) { - test.equal(null, err); - - // Insert a bunch of documents for the index - collection.insert([{a:1, b:1}, {a:1, b:1} - , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Create an index on the a field - collection.ensureIndex({a:1, b:1} - , {unique:true, background:true, dropDups:true}, function(err, indexName) { - - // Force a reindex of the collection - collection.reIndex(function(err, result) { - test.equal(null, err); - test.equal(true, result); - - // Verify that the index is gone - collection.indexInformation(function(err, indexInformation) { - test.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); - test.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExtractIndexInformation = function(test) { - client.createCollection('test_index_information', function(err, collection) { - collection.insert({a:1}, {safe:true}, function(err, ids) { - // Create an index on the collection - client.createIndex(collection.collectionName, 'a', function(err, indexName) { - test.equal("a_1", indexName); - // Let's fetch the index information - client.indexInformation(collection.collectionName, function(err, collectionInfo) { - test.ok(collectionInfo['_id_'] != null); - test.equal('_id', collectionInfo['_id_'][0][0]); - test.ok(collectionInfo['a_1'] != null); - test.deepEqual([["a", 1]], collectionInfo['a_1']); - - client.indexInformation(function(err, collectionInfo2) { - var count1 = 0, count2 = 0; - // Get count of indexes - for(var i in collectionInfo) { count1 += 1;} - for(var i in collectionInfo2) { count2 += 1;} - - // Tests - test.ok(count2 >= count1); - test.ok(collectionInfo2['_id_'] != null); - test.equal('_id', collectionInfo2['_id_'][0][0]); - test.ok(collectionInfo2['a_1'] != null); - test.deepEqual([["a", 1]], collectionInfo2['a_1']); - test.ok((collectionInfo[indexName] != null)); - test.deepEqual([["a", 1]], collectionInfo[indexName]); - - // Let's close the db - test.done(); - }); - }); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleMultipleColumnIndexes = function(test) { - client.createCollection('test_multiple_index_cols', function(err, collection) { - collection.insert({a:1}, function(err, ids) { - // Create an index on the collection - client.createIndex(collection.collectionName, [['a', -1], ['b', 1], ['c', -1]], function(err, indexName) { - test.equal("a_-1_b_1_c_-1", indexName); - // Let's fetch the index information - client.indexInformation(collection.collectionName, function(err, collectionInfo) { - var count1 = 0; - // Get count of indexes - for(var i in collectionInfo) { count1 += 1;} - - // Test - test.equal(2, count1); - test.ok(collectionInfo[indexName] != null); - test.deepEqual([['a', -1], ['b', 1], ['c', -1]], collectionInfo[indexName]); - - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleUniqueIndex = function(test) { - // Create a non-unique index and test inserts - client.createCollection('test_unique_index', function(err, collection) { - client.createIndex(collection.collectionName, 'hello', function(err, indexName) { - // Insert some docs - collection.insert([{'hello':'world'}, {'hello':'mike'}, {'hello':'world'}], {safe:true}, function(err, errors) { - // Assert that we have no erros - client.error(function(err, errors) { - test.equal(1, errors.length); - test.equal(null, errors[0].err); - - // Create a unique index and test that insert fails - client.createCollection('test_unique_index2', function(err, collection) { - client.createIndex(collection.collectionName, 'hello', {unique:true}, function(err, indexName) { - // Insert some docs - collection.insert([{'hello':'world'}, {'hello':'mike'}, {'hello':'world'}], {safe:true}, function(err, ids) { - test.ok(err != null); - test.equal(11000, err.code); - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyCreateSubfieldIndex = function(test) { - // Create a non-unique index and test inserts - client.createCollection('test_index_on_subfield', function(err, collection) { - collection.insert([{'hello': {'a':4, 'b':5}}, {'hello': {'a':7, 'b':2}}, {'hello': {'a':4, 'b':10}}], {safe:true}, function(err, ids) { - // Assert that we have no erros - client.error(function(err, errors) { - test.equal(1, errors.length); - test.ok(errors[0].err == null); - - // Create a unique subfield index and test that insert fails - client.createCollection('test_index_on_subfield2', function(err, collection) { - client.createIndex(collection.collectionName, 'hello.a', true, function(err, indexName) { - collection.insert([{'hello': {'a':4, 'b':5}}, {'hello': {'a':7, 'b':2}}, {'hello': {'a':4, 'b':10}}], {safe:true}, function(err, ids) { - // Assert that we have erros - test.ok(err != null); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyDropIndexes = function(test) { - client.createCollection('test_drop_indexes', function(err, collection) { - collection.insert({a:1}, {safe:true}, function(err, ids) { - // Create an index on the collection - client.createIndex(collection.collectionName, 'a', function(err, indexName) { - test.equal("a_1", indexName); - // Drop all the indexes - collection.dropAllIndexes(function(err, result) { - test.equal(true, result); - - collection.indexInformation(function(err, result) { - test.ok(result['a_1'] == null); - test.done(); - }) - }) - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleDistinctIndexes = function(test) { - client.createCollection('test_distinct_queries', function(err, collection) { - collection.insert([{'a':0, 'b':{'c':'a'}}, - {'a':1, 'b':{'c':'b'}}, - {'a':1, 'b':{'c':'c'}}, - {'a':2, 'b':{'c':'a'}}, {'a':3}, {'a':3}], {safe:true}, function(err, ids) { - collection.distinct('a', function(err, docs) { - test.deepEqual([0, 1, 2, 3], docs.sort()); - }); - - collection.distinct('b.c', function(err, docs) { - test.deepEqual(['a', 'b', 'c'], docs.sort()); - test.done(); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteEnsureIndex = function(test) { - client.createCollection('test_ensure_index', function(err, collection) { - // Create an index on the collection - client.ensureIndex(collection.collectionName, 'a', function(err, indexName) { - test.equal("a_1", indexName); - // Let's fetch the index information - client.indexInformation(collection.collectionName, function(err, collectionInfo) { - test.ok(collectionInfo['_id_'] != null); - test.equal('_id', collectionInfo['_id_'][0][0]); - test.ok(collectionInfo['a_1'] != null); - test.deepEqual([["a", 1]], collectionInfo['a_1']); - - client.ensureIndex(collection.collectionName, 'a', function(err, indexName) { - test.equal("a_1", indexName); - // Let's fetch the index information - client.indexInformation(collection.collectionName, function(err, collectionInfo) { - test.ok(collectionInfo['_id_'] != null); - test.equal('_id', collectionInfo['_id_'][0][0]); - test.ok(collectionInfo['a_1'] != null); - test.deepEqual([["a", 1]], collectionInfo['a_1']); - // Let's close the db - test.done(); - }); - }); - }); - }); - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyCreateAndUseSparseIndex = function(test) { - client.createCollection('create_and_use_sparse_index_test', function(err, r) { - client.collection('create_and_use_sparse_index_test', function(err, collection) { - - collection.ensureIndex({title:1}, {sparse:true}, function(err, indexName) { - collection.insert([{name:"Jim"}, {name:"Sarah", title:"Princess"}], {safe:true}, function(err, result) { - collection.find({title:{$ne:null}}).sort({title:1}).toArray(function(err, items) { - test.equal(1, items.length); - test.equal("Sarah", items[0].name); - - // Fetch the info for the indexes - collection.indexInformation({full:true}, function(err, indexInfo) { - test.equal(null, err); - test.equal(2, indexInfo.length); - test.done(); - }) - }) - }); - }) - }) - }) -} - -/** - * @ignore - */ -exports["Should correctly execute insert with keepGoing option on mongod >= 1.9.1"] = function(test) { - client.admin().serverInfo(function(err, result){ - if(parseInt((result.version.replace(/\./g, ''))) >= 191) { - client.createCollection('shouldCorrectlyExecuteKeepGoingWithMongodb191OrHigher', function(err, collection) { - collection.ensureIndex({title:1}, {unique:true}, function(err, indexName) { - collection.insert([{name:"Jim"}, {name:"Sarah", title:"Princess"}], {safe:true}, function(err, result) { - // Force keep going flag, ignoring unique index issue - collection.insert([{name:"Jim"}, {name:"Sarah", title:"Princess"}, {name:'Gump', title:"Gump"}], {safe:true, keepGoing:true}, function(err, result) { - collection.count(function(err, count) { - test.equal(3, count); - test.done(); - }) - }); - }); - }); - }); - } else { - test.done(); - } - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleGeospatialIndexes = function(test) { - client.admin().serverInfo(function(err, result){ - if(parseInt((result.version.replace(/\./g, ''))) >= 191) { - client.createCollection('geospatial_index_test', function(err, r) { - client.collection('geospatial_index_test', function(err, collection) { - collection.ensureIndex({loc:'2d'}, function(err, indexName) { - collection.insert({'loc': [-100,100]}, {safe:true}, function(err, result) { - test.equal(err,null); - collection.insert({'loc': [200,200]}, {safe:true}, function(err, result) { - err = err ? err : {}; - test.equal(err.err,"point not in interval of [ -180, 180 )"); - test.done(); - }); - }); - }); - }); - }); - } else { - test.done(); - } - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleGeospatialIndexesAlteredRange = function(test) { - client.admin().serverInfo(function(err, result){ - if(parseInt((result.version.replace(/\./g, ''))) >= 191) { - client.createCollection('geospatial_index_altered_test', function(err, r) { - client.collection('geospatial_index_altered_test', function(err, collection) { - collection.ensureIndex({loc:'2d'},{min:0,max:1024}, function(err, indexName) { - collection.insert({'loc': [100,100]}, {safe:true}, function(err, result) { - test.equal(err,null); - collection.insert({'loc': [200,200]}, {safe:true}, function(err, result) { - test.equal(err,null); - collection.insert({'loc': [-200,-200]}, {safe:true}, function(err, result) { - err = err ? err : {}; - test.equal(err.err,"point not in interval of [ 0, 1024 )"); - test.done(); - }); - }); - }); - }); - }); - }); - } else { - test.done(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/insert_test.js b/test/insert_test.js deleted file mode 100644 index 9bfe0f53b25..00000000000 --- a/test/insert_test.js +++ /dev/null @@ -1,1149 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Script = require('vm'), - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Binary = require('../lib/mongodb/bson/binary').Binary, - Code = require('../lib/mongodb/bson/code').Code, - DBRef = require('../lib/mongodb/bson/db_ref').DBRef, - Timestamp = require('../lib/mongodb/bson/timestamp').Timestamp, - Long = require('../lib/mongodb/bson/long').Long, - Collection = mongodb.Collection, - Step = require('step'), - Server = mongodb.Server, - ServerManager = require('./tools/server_manager').ServerManager; - -var MONGODB = 'integration_tests'; -var client = null; -var useSSL = process.env['USE_SSL'] != null ? true : false; -var native_parser = (process.env['TEST_NATIVE'] != null); - -/** - * Module for parsing an ISO 8601 formatted string into a Date object. - * @ignore - */ -var ISODate = function (string) { - var match; - - if (typeof string.getTime === "function") - return string; - else if (match = string.match(/^(\d{4})(-(\d{2})(-(\d{2})(T(\d{2}):(\d{2})(:(\d{2})(\.(\d+))?)?(Z|((\+|-)(\d{2}):(\d{2}))))?)?)?$/)) { - var date = new Date(); - date.setUTCFullYear(Number(match[1])); - date.setUTCMonth(Number(match[3]) - 1 || 0); - date.setUTCDate(Number(match[5]) || 0); - date.setUTCHours(Number(match[7]) || 0); - date.setUTCMinutes(Number(match[8]) || 0); - date.setUTCSeconds(Number(match[10]) || 0); - date.setUTCMilliseconds(Number("." + match[12]) * 1000 || 0); - - if (match[13] && match[13] !== "Z") { - var h = Number(match[16]) || 0, - m = Number(match[17]) || 0; - - h *= 3600000; - m *= 60000; - - var offset = h + m; - if (match[15] == "+") - offset = -offset; - - new Date(date.valueOf() + offset); - } - - return date; - } else - throw new Error("Invalid ISO 8601 date given.", __filename); -}; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A simple document insert example, not using safe mode to ensure document persistance on MongoDB - * - * @_class collection - * @_function insert - * @ignore - */ -exports.shouldCorrectlyPerformASimpleSingleDocumentInsertNoCallbackNoSafe = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch a collection to insert document into - db.collection("simple_document_insert_collection_no_safe", function(err, collection) { - - // Insert a single document - collection.insert({hello:'world_no_safe'}); - - // Wait for a second before finishing up, to ensure we have written the item to disk - setTimeout(function() { - - // Fetch the document - collection.findOne({hello:'world_no_safe'}, function(err, item) { - test.equal(null, err); - test.equal('world_no_safe', item.hello); - test.done(); - db.close(); - }) - }, 1000); - }); - }); -} - -/** - * A batch document insert example, using safe mode to ensure document persistance on MongoDB - * - * @_class collection - * @_function insert - * @ignore - */ -exports.shouldCorrectlyPerformABatchDocumentInsertSafe = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch a collection to insert document into - db.collection("batch_document_insert_collection_safe", function(err, collection) { - - // Insert a single document - collection.insert([{hello:'world_safe1'} - , {hello:'world_safe2'}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Fetch the document - collection.findOne({hello:'world_safe2'}, function(err, item) { - test.equal(null, err); - test.equal('world_safe2', item.hello); - test.done(); - db.close(); - }) - }); - }); - }); -} - -/** - * Example of inserting a document containing functions - * - * @_class collection - * @_function insert - * @ignore - */ -exports.shouldCorrectlyPerformASimpleDocumentInsertWithFunctionSafe = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch a collection to insert document into - db.collection("simple_document_insert_with_function_safe", function(err, collection) { - - // Insert a single document - collection.insert({hello:'world' - , func:function() {}}, {safe:true, serializeFunctions:true}, function(err, result) { - test.equal(null, err); - - // Fetch the document - collection.findOne({hello:'world'}, function(err, item) { - test.equal(null, err); - test.ok("function() {}", item.code); - test.done(); - db.close(); - }) - }); - }); - }); -} - -/** - * Example of using keepGoing to allow batch insert to complete even when there are illegal documents in the batch - * - * @_class collection - * @_function insert - * @ignore - */ -exports["Should correctly execute insert with keepGoing option on mongod >= 1.9.1"] = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Only run the rest of the code if we have a mongodb server with version >= 1.9.1 - db.admin().serverInfo(function(err, result){ - - // Ensure we are running at least MongoDB v1.9.1 - if(parseInt((result.version.replace(/\./g, ''))) >= 191) { - - // Create a collection - client.createCollection('keepGoingExample', function(err, collection) { - - // Add an unique index to title to force errors in the batch insert - collection.ensureIndex({title:1}, {unique:true}, function(err, indexName) { - - // Insert some intial data into the collection - collection.insert([{name:"Jim"} - , {name:"Sarah", title:"Princess"}], {safe:true}, function(err, result) { - - // Force keep going flag, ignoring unique index issue - collection.insert([{name:"Jim"} - , {name:"Sarah", title:"Princess"} - , {name:'Gump', title:"Gump"}], {safe:true, keepGoing:true}, function(err, result) { - - // Count the number of documents left (should not include the duplicates) - collection.count(function(err, count) { - test.equal(3, count); - db.close(); - test.done(); - }) - }); - }); - }); - }); - } else { - db.close(); - test.done(); - } - }); - }); -} - -/** - * @ignore - */ -exports.shouldForceMongoDbServerToAssignId = function(test) { - /// Set up server with custom pk factory - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null), 'forceServerObjectId':true}); - db.open(function(err, client) { - client.createCollection('test_insert2', function(err, r) { - client.collection('test_insert2', function(err, collection) { - - Step( - function inserts() { - var group = this.group(); - - for(var i = 1; i < 1000; i++) { - collection.insert({c:i}, {safe:true}, group()); - } - }, - - function done(err, result) { - collection.insert({a:2}, {safe:true}, function(err, r) { - collection.insert({a:3}, {safe:true}, function(err, r) { - collection.count(function(err, count) { - test.equal(1001, count); - // Locate all the entries using find - collection.find(function(err, cursor) { - cursor.toArray(function(err, results) { - test.equal(1001, results.length); - test.ok(results[0] != null); - - client.close(); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - } - ) - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformSingleInsert = function(test) { - client.createCollection('shouldCorrectlyPerformSingleInsert', function(err, collection) { - collection.insert({a:1}, {safe:true}, function(err, result) { - collection.findOne(function(err, item) { - test.equal(1, item.a); - test.done(); - }) - }) - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformBasicInsert = function(test) { - client.createCollection('test_insert', function(err, r) { - client.collection('test_insert', function(err, collection) { - - Step( - function inserts() { - var group = this.group(); - - for(var i = 1; i < 1000; i++) { - collection.insert({c:i}, {safe:true}, group()); - } - }, - - function done(err, result) { - collection.insert({a:2}, {safe:true}, function(err, r) { - collection.insert({a:3}, {safe:true}, function(err, r) { - collection.count(function(err, count) { - test.equal(1001, count); - // Locate all the entries using find - collection.find(function(err, cursor) { - cursor.toArray(function(err, results) { - test.equal(1001, results.length); - test.ok(results[0] != null); - - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - } - ) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleMultipleDocumentInsert = function(test) { - client.createCollection('test_multiple_insert', function(err, r) { - var collection = client.collection('test_multiple_insert', function(err, collection) { - var docs = [{a:1}, {a:2}]; - - collection.insert(docs, {safe:true}, function(err, ids) { - ids.forEach(function(doc) { - test.ok(((doc['_id']) instanceof ObjectID || Object.prototype.toString.call(doc['_id']) === '[object ObjectID]')); - }); - - // Let's ensure we have both documents - collection.find(function(err, cursor) { - cursor.toArray(function(err, docs) { - test.equal(2, docs.length); - var results = []; - // Check that we have all the results we want - docs.forEach(function(doc) { - if(doc.a == 1 || doc.a == 2) results.push(1); - }); - test.equal(2, results.length); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteSaveInsertUpdate= function(test) { - client.createCollection('shouldCorrectlyExecuteSaveInsertUpdate', function(err, collection) { - collection.save({ email : 'save' }, {safe:true}, function() { - collection.insert({ email : 'insert' }, {safe:true}, function() { - collection.update( - { email : 'update' }, - { email : 'update' }, - { upsert: true, safe:true}, - - function() { - collection.find(function(e, c) { - c.toArray(function(e, a) { - test.equal(3, a.length) - test.done(); - }); - }); - } - ); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertAndRetrieveLargeIntegratedArrayDocument = function(test) { - client.createCollection('test_should_deserialize_large_integrated_array', function(err, collection) { - var doc = {'a':0, - 'b':['tmp1', 'tmp2', 'tmp3', 'tmp4', 'tmp5', 'tmp6', 'tmp7', 'tmp8', 'tmp9', 'tmp10', 'tmp11', 'tmp12', 'tmp13', 'tmp14', 'tmp15', 'tmp16'] - }; - // Insert the collection - collection.insert(doc, {safe:true}, function(err, r) { - // Fetch and check the collection - collection.findOne({'a': 0}, function(err, result) { - test.deepEqual(doc.a, result.a); - test.deepEqual(doc.b, result.b); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertAndRetrieveDocumentWithAllTypes = function(test) { - client.createCollection('test_all_serialization_types', function(err, collection) { - var date = new Date(); - var oid = new ObjectID(); - var string = 'binstring' - var bin = new Binary() - for(var index = 0; index < string.length; index++) { - bin.put(string.charAt(index)) - } - - var motherOfAllDocuments = { - 'string': 'hello', - 'array': [1,2,3], - 'hash': {'a':1, 'b':2}, - 'date': date, - 'oid': oid, - 'binary': bin, - 'int': 42, - 'float': 33.3333, - 'regexp': /regexp/, - 'boolean': true, - 'long': date.getTime(), - 'where': new Code('this.a > i', {i:1}), - 'dbref': new DBRef('namespace', oid, 'integration_tests_') - } - - collection.insert(motherOfAllDocuments, {safe:true}, function(err, docs) { - collection.findOne(function(err, doc) { - // Assert correct deserialization of the values - test.equal(motherOfAllDocuments.string, doc.string); - test.deepEqual(motherOfAllDocuments.array, doc.array); - test.equal(motherOfAllDocuments.hash.a, doc.hash.a); - test.equal(motherOfAllDocuments.hash.b, doc.hash.b); - test.equal(date.getTime(), doc.long); - test.equal(date.toString(), doc.date.toString()); - test.equal(date.getTime(), doc.date.getTime()); - test.equal(motherOfAllDocuments.oid.toHexString(), doc.oid.toHexString()); - test.equal(motherOfAllDocuments.binary.value(), doc.binary.value()); - - test.equal(motherOfAllDocuments.int, doc.int); - test.equal(motherOfAllDocuments.long, doc.long); - test.equal(motherOfAllDocuments.float, doc.float); - test.equal(motherOfAllDocuments.regexp.toString(), doc.regexp.toString()); - test.equal(motherOfAllDocuments.boolean, doc.boolean); - test.equal(motherOfAllDocuments.where.code, doc.where.code); - test.equal(motherOfAllDocuments.where.scope['i'], doc.where.scope.i); - - test.equal(motherOfAllDocuments.dbref.namespace, doc.dbref.namespace); - test.equal(motherOfAllDocuments.dbref.oid.toHexString(), doc.dbref.oid.toHexString()); - test.equal(motherOfAllDocuments.dbref.db, doc.dbref.db); - test.done(); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertAndUpdateDocumentWithNewScriptContext= function(test) { - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, db) { - //convience curried handler for functions of type 'a -> (err, result) - function getResult(callback){ - return function(error, result) { - test.ok(error == null); - return callback(result); - } - }; - - db.collection('users', getResult(function(user_collection){ - user_collection.remove({}, {safe:true}, function(err, result) { - //first, create a user object - var newUser = { name : 'Test Account', settings : {} }; - user_collection.insert([newUser], {safe:true}, getResult(function(users){ - var user = users[0]; - - var scriptCode = "settings.block = []; settings.block.push('test');"; - var context = { settings : { thisOneWorks : "somestring" } }; - - Script.runInNewContext(scriptCode, context, "testScript"); - - //now create update command and issue it - var updateCommand = { $set : context }; - - user_collection.update({_id : user._id}, updateCommand, {safe:true}, - getResult(function(updateCommand) { - // Fetch the object and check that the changes are persisted - user_collection.findOne({_id : user._id}, function(err, doc) { - test.ok(err == null); - test.equal("Test Account", doc.name); - test.equal("somestring", doc.settings.thisOneWorks); - test.equal("test", doc.settings.block[0]); - - // Let's close the db - db.close(); - test.done(); - }); - }) - ); - })); - }); - })); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlySerializeDocumentWithAllTypesInNewContext = function(test) { - client.createCollection('test_all_serialization_types_new_context', function(err, collection) { - var date = new Date(); - var scriptCode = - "var string = 'binstring'\n" + - "var bin = new mongo.Binary()\n" + - "for(var index = 0; index < string.length; index++) {\n" + - " bin.put(string.charAt(index))\n" + - "}\n" + - "motherOfAllDocuments['string'] = 'hello';" + - "motherOfAllDocuments['array'] = [1,2,3];" + - "motherOfAllDocuments['hash'] = {'a':1, 'b':2};" + - "motherOfAllDocuments['date'] = date;" + - "motherOfAllDocuments['oid'] = new mongo.ObjectID();" + - "motherOfAllDocuments['binary'] = bin;" + - "motherOfAllDocuments['int'] = 42;" + - "motherOfAllDocuments['float'] = 33.3333;" + - "motherOfAllDocuments['regexp'] = /regexp/;" + - "motherOfAllDocuments['boolean'] = true;" + - "motherOfAllDocuments['long'] = motherOfAllDocuments['date'].getTime();" + - "motherOfAllDocuments['where'] = new mongo.Code('this.a > i', {i:1});" + - "motherOfAllDocuments['dbref'] = new mongo.DBRef('namespace', motherOfAllDocuments['oid'], 'integration_tests_');"; - - var context = { - motherOfAllDocuments : {}, - mongo:{ - ObjectID:ObjectID, - Binary:Binary, - Code:Code, - DBRef:DBRef - }, - date:date}; - - // Execute function in context - Script.runInNewContext(scriptCode, context, "testScript"); - // sys.puts(sys.inspect(context.motherOfAllDocuments)) - var motherOfAllDocuments = context.motherOfAllDocuments; - - collection.insert(context.motherOfAllDocuments, {safe:true}, function(err, docs) { - collection.findOne(function(err, doc) { - // Assert correct deserialization of the values - test.equal(motherOfAllDocuments.string, doc.string); - test.deepEqual(motherOfAllDocuments.array, doc.array); - test.equal(motherOfAllDocuments.hash.a, doc.hash.a); - test.equal(motherOfAllDocuments.hash.b, doc.hash.b); - test.equal(date.getTime(), doc.long); - test.equal(date.toString(), doc.date.toString()); - test.equal(date.getTime(), doc.date.getTime()); - test.equal(motherOfAllDocuments.oid.toHexString(), doc.oid.toHexString()); - test.equal(motherOfAllDocuments.binary.value(), doc.binary.value()); - - test.equal(motherOfAllDocuments.int, doc.int); - test.equal(motherOfAllDocuments.long, doc.long); - test.equal(motherOfAllDocuments.float, doc.float); - test.equal(motherOfAllDocuments.regexp.toString(), doc.regexp.toString()); - test.equal(motherOfAllDocuments.boolean, doc.boolean); - test.equal(motherOfAllDocuments.where.code, doc.where.code); - test.equal(motherOfAllDocuments.where.scope['i'], doc.where.scope.i); - test.equal(motherOfAllDocuments.dbref.namespace, doc.dbref.namespace); - test.equal(motherOfAllDocuments.dbref.oid.toHexString(), doc.dbref.oid.toHexString()); - test.equal(motherOfAllDocuments.dbref.db, doc.dbref.db); - - test.done(); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyDoToJsonForLongValue = function(test) { - client.createCollection('test_to_json_for_long', function(err, collection) { - test.ok(collection instanceof Collection); - - collection.insert([{value: Long.fromNumber(32222432)}], {safe:true}, function(err, ids) { - collection.findOne({}, function(err, item) { - test.equal(32222432, item.value); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertAndUpdateWithNoCallback = function(test) { - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, poolSize: 1, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, client) { - client.createCollection('test_insert_and_update_no_callback', function(err, collection) { - // Insert the update - collection.insert({i:1}, {safe:true}) - // Update the record - collection.update({i:1}, {"$set":{i:2}}, {safe:true}) - - // Make sure we leave enough time for mongodb to record the data - setTimeout(function() { - // Locate document - collection.findOne({}, function(err, item) { - test.equal(2, item.i) - - client.close(); - test.done(); - }); - }, 100) - }) - }); -} - -/** - * @ignore - */ -exports.shouldInsertAndQueryTimestamp = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - db.createCollection('test_insert_and_query_timestamp', function(err, collection) { - // Insert the update - collection.insert({i:Timestamp.fromNumber(100), j:Long.fromNumber(200)}, {safe:true}, function(err, r) { - // Locate document - collection.findOne({}, function(err, item) { - test.ok(item.i instanceof Timestamp); - test.equal(100, item.i); - test.ok(typeof item.j == "number"); - test.equal(200, item.j); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertAndQueryUndefined = function(test) { - client.createCollection('test_insert_and_query_undefined', function(err, collection) { - // Insert the update - collection.insert({i:undefined}, {safe:true}, function(err, r) { - // Locate document - collection.findOne({}, function(err, item) { - test.equal(null, item.i) - - test.done(); - }); - }) - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlySerializeDBRefToJSON = function(test) { - var dbref = new DBRef("foo", ObjectID.createFromHexString("fc24a04d4560531f00000000"), null); - JSON.stringify(dbref); - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyPerformSafeInsert = function(test) { - var fixtures = [{ - name: "empty", array: [], bool: false, dict: {}, float: 0.0, string: "" - }, { - name: "not empty", array: [1], bool: true, dict: {x: "y"}, float: 1.0, string: "something" - }, { - name: "simple nested", array: [1, [2, [3]]], bool: true, dict: {x: "y", array: [1,2,3,4], dict: {x: "y", array: [1,2,3,4]}}, float: 1.5, string: "something simply nested" - }]; - - - client.createCollection('test_safe_insert', function(err, collection) { - Step( - function inserts() { - var group = this.group(); - - for(var i = 0; i < fixtures.length; i++) { - collection.insert(fixtures[i], {safe:true}, group()); - } - }, - - function done() { - collection.count(function(err, count) { - test.equal(3, count); - - collection.find().toArray(function(err, docs) { - test.equal(3, docs.length) - }); - }); - - - collection.find({}, {}, function(err, cursor) { - var counter = 0; - - cursor.each(function(err, doc) { - if(doc == null) { - test.equal(3, counter); - test.done(); - } else { - counter = counter + 1; - } - }); - }); - } - ) - }) -} - -/** - * @ignore - */ -exports.shouldThrowErrorIfSerializingFunction = function(test) { - client.createCollection('test_should_throw_error_if_serializing_function', function(err, collection) { - var func = function() { return 1}; - // Insert the update - collection.insert({i:1, z:func }, {safe:true, serializeFunctions:true}, function(err, result) { - collection.findOne({_id:result[0]._id}, function(err, object) { - test.equal(func.toString(), object.z.code); - test.equal(1, object.i); - test.done(); - }) - }) - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertDocumentWithUUID = function(test) { - client.collection("insert_doc_with_uuid", function(err, collection) { - collection.insert({_id : "12345678123456781234567812345678", field: '1'}, {safe:true}, function(err, result) { - test.equal(null, err); - - collection.find({_id : "12345678123456781234567812345678"}).toArray(function(err, items) { - test.equal(null, err); - test.equal(items[0]._id, "12345678123456781234567812345678") - test.equal(items[0].field, '1') - - // Generate a binary id - var binaryUUID = new Binary('00000078123456781234567812345678', Binary.SUBTYPE_UUID); - - collection.insert({_id : binaryUUID, field: '2'}, {safe:true}, function(err, result) { - collection.find({_id : binaryUUID}).toArray(function(err, items) { - test.equal(null, err); - test.equal(items[0].field, '2') - test.done(); - }); - }); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyCallCallbackWithDbDriverInStrictMode = function(test) { - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, poolSize: 1, ssl:useSSL}), {strict:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, client) { - client.createCollection('test_insert_and_update_no_callback_strict', function(err, collection) { - collection.insert({_id : "12345678123456781234567812345678", field: '1'}, {safe:true}, function(err, result) { - test.equal(null, err); - - collection.update({ '_id': "12345678123456781234567812345678" }, { '$set': { 'field': 0 }}, function(err, numberOfUpdates) { - test.equal(null, err); - test.equal(1, numberOfUpdates); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertDBRefWithDbNotDefined = function(test) { - client.createCollection('shouldCorrectlyInsertDBRefWithDbNotDefined', function(err, collection) { - var doc = {_id: new ObjectID()}; - var doc2 = {_id: new ObjectID()}; - var doc3 = {_id: new ObjectID()}; - collection.insert(doc, {safe:true}, function(err, result) { - // Create object with dbref - doc2.ref = new DBRef('shouldCorrectlyInsertDBRefWithDbNotDefined', doc._id); - doc3.ref = new DBRef('shouldCorrectlyInsertDBRefWithDbNotDefined', doc._id, MONGODB); - - collection.insert([doc2, doc3], {safe:true}, function(err, result) { - // Get all items - collection.find().toArray(function(err, items) { - test.equal("shouldCorrectlyInsertDBRefWithDbNotDefined", items[1].ref.namespace); - test.equal(doc._id.toString(), items[1].ref.oid.toString()); - test.equal(null, items[1].ref.db); - - test.equal("shouldCorrectlyInsertDBRefWithDbNotDefined", items[2].ref.namespace); - test.equal(doc._id.toString(), items[2].ref.oid.toString()); - test.equal(MONGODB, items[2].ref.db); - - test.done(); - }) - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertUpdateRemoveWithNoOptions = function(test) { - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, db) { - db.collection('shouldCorrectlyInsertUpdateRemoveWithNoOptions', function(err, collection) { - collection.insert({a:1}); - collection.update({a:1}, {a:2}); - collection.remove({a:2}); - - collection.count(function(err, count) { - test.equal(0, count); - - db.close(); - test.done(); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyExecuteMultipleFetches = function(test) { - var db = new Db(MONGODB, new Server('localhost', 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Search parameter - var to = 'ralph' - // Execute query - db.open(function(err, db) { - db.collection('shouldCorrectlyExecuteMultipleFetches', function(err, collection) { - collection.insert({addresses:{localPart:'ralph'}}, {safe:true}, function(err, result) { - // Let's find our user - collection.findOne({"addresses.localPart" : to}, function( err, doc ) { - test.equal(null, err); - test.equal(to, doc.addresses.localPart); - - db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyFailWhenNoObjectToUpdate= function(test) { - client.createCollection('shouldCorrectlyExecuteSaveInsertUpdate', function(err, collection) { - collection.update({_id : new ObjectID()}, { email : 'update' }, {safe:true}, - function(err, result) { - test.equal(0, result); - test.done(); - } - ); - }); -} - -/** - * @ignore - */ -exports['Should correctly insert object and retrieve it when containing array and IsoDate'] = function(test) { - var doc = { - "_id" : new ObjectID("4e886e687ff7ef5e00000162"), - "str" : "foreign", - "type" : 2, - "timestamp" : ISODate("2011-10-02T14:00:08.383Z"), - "links" : [ - "http://www.reddit.com/r/worldnews/comments/kybm0/uk_home_secretary_calls_for_the_scrapping_of_the/" - ] - } - - client.createCollection('Should_correctly_insert_object_and_retrieve_it_when_containing_array_and_IsoDate', function(err, collection) { - collection.insert(doc, {safe:true}, function(err, result) { - test.ok(err == null); - - collection.findOne(function(err, item) { - test.ok(err == null); - test.deepEqual(doc, item); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should correctly insert object with timestamps'] = function(test) { - var doc = { - "_id" : new ObjectID("4e886e687ff7ef5e00000162"), - "str" : "foreign", - "type" : 2, - "timestamp" : new Timestamp(10000), - "links" : [ - "http://www.reddit.com/r/worldnews/comments/kybm0/uk_home_secretary_calls_for_the_scrapping_of_the/" - ], - "timestamp2" : new Timestamp(33333), - } - - client.createCollection('Should_correctly_insert_object_with_timestamps', function(err, collection) { - collection.insert(doc, {safe:true}, function(err, result) { - test.ok(err == null); - - collection.findOne(function(err, item) { - test.ok(err == null); - test.deepEqual(doc, item); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should fail on insert due to key starting with $'] = function(test) { - var doc = { - "_id" : new ObjectID("4e886e687ff7ef5e00000162"), - "$key" : "foreign", - } - - client.createCollection('Should_fail_on_insert_due_to_key_starting_with', function(err, collection) { - collection.insert(doc, {safe:true}, function(err, result) { - test.ok(err != null); - test.done(); - }); - }); -} - -/** - * @ignore - */ -exports['Should Correctly allow for control of serialization of functions on command level'] = function(test) { - var doc = { - str : "String", - func : function() {} - } - - client.createCollection("Should_Correctly_allow_for_control_of_serialization_of_functions_on_command_level", function(err, collection) { - test.ok(err == null); - - collection.insert(doc, {safe:true}, function(err, result) { - - collection.update({str:"String"}, {$set:{c:1, d:function(){}}}, {safe:true, serializeFunctions:false}, function(err, result) { - test.equal(1, result); - - collection.findOne({str:"String"}, function(err, item) { - test.equal(null, item.d); - - // Execute a safe insert with replication to two servers - collection.findAndModify({str:"String"}, [['a', 1]], {'$set':{'f':function() {}}}, {new:true, safe: true, serializeFunctions:true}, function(err, result) { - test.ok(result.f instanceof Code) - test.done(); - }) - }) - }) - }); - }); -} - -/** - * @ignore - */ -exports['Should Correctly allow for control of serialization of functions on collection level'] = function(test) { - var doc = { - str : "String", - func : function() {} - } - - client.createCollection("Should_Correctly_allow_for_control_of_serialization_of_functions_on_collection_level", {serializeFunctions:true}, function(err, collection) { - test.ok(err == null); - - collection.insert(doc, {safe:true}, function(err, result) { - test.equal(null, err); - - collection.findOne({str : "String"}, function(err, item) { - test.ok(item.func instanceof Code); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should Correctly allow for using a Date object as _id'] = function(test) { - var doc = { - _id : new Date(), - str : 'hello' - } - - client.createCollection("Should_Correctly_allow_for_using_a_Date_object_as__id", {serializeFunctions:true}, function(err, collection) { - test.ok(err == null); - - collection.insert(doc, {safe:true}, function(err, result) { - test.equal(null, err); - - collection.findOne({str : "hello"}, function(err, item) { - test.ok(item._id instanceof Date); - test.done(); - }); - }); - }); -} - -/** - * @ignore - */ -exports['Should Correctly fail to update returning 0 results'] = function(test) { - client.createCollection("Should_Correctly_fail_to_update_returning_0_results", {serializeFunctions:true}, function(err, collection) { - test.ok(err == null); - - collection.update({a:1}, {$set: {a:1}}, {safe:true}, function(err, numberOfUpdated) { - test.equal(0, numberOfUpdated); - test.done(); - }); - }); -} - -/** - * @ignore - */ -exports['Should Correctly update two fields including a sub field'] = function(test) { - var doc = { - _id: new ObjectID(), - Prop1: 'p1', - Prop2: 'p2', - More: { - Sub1: 's1', - Sub2: 's2', - Sub3: 's3' - } - } - - client.createCollection("Should_Correctly_update_two_fields_including_a_sub_field", {}, function(err, collection) { - collection.insert(doc, {safe:true}, function(err, result) { - test.equal(null, err); - - // Update two fields - collection.update({_id:doc._id}, {$set:{Prop1:'p1_2', 'More.Sub2':'s2_2'}}, {safe:true}, function(err, numberOfUpdatedDocs) { - test.equal(null, err); - test.equal(1, numberOfUpdatedDocs); - - collection.findOne({_id:doc._id}, function(err, item) { - test.equal(null, err); - test.equal('p1_2', item.Prop1); - test.equal('s2_2', item.More.Sub2); - test.done(); - }) - }); - }) - }); -} - -/** - * @ignore - */ -exports['Should correctly fail due to duplicate key for _id'] = function(test) { - client.createCollection("Should_Correctly_update_two_fields_including_a_sub_field_2", {}, function(err, collection) { - collection.insert({_id:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - // Update two fields - collection.insert({_id:1}, {safe:true}, function(err, result) { - test.ok(err != null); - test.done(); - }); - }) - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/logging_test.js b/test/logging_test.js deleted file mode 100644 index 8e277b6bc51..00000000000 --- a/test/logging_test.js +++ /dev/null @@ -1,93 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCorrectlyLogContent = function(test) { - var loggedOutput = false; - var logger = { - doDebug:true, - doError:true, - doLog:true, - - error:function(message, object) {}, - log:function(message, object) {}, - - debug:function(message, object) { - loggedOutput = true; - } - } - - var automatic_connect_client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null), retryMiliSeconds:50, logger:logger}); - automatic_connect_client.open(function(err, automatic_connect_client) { - automatic_connect_client.close(); - test.equal(true, loggedOutput); - test.done(); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/manual_tests/grids_fs_compatibility_test.js b/test/manual_tests/grids_fs_compatibility_test.js deleted file mode 100644 index 4f1f738a336..00000000000 --- a/test/manual_tests/grids_fs_compatibility_test.js +++ /dev/null @@ -1,20 +0,0 @@ -var Server = require("../../lib/mongodb").Server, - Db = require("../../lib/mongodb").Db, - ObjectID = require("../../lib/mongodb").ObjectID, - GridStore = require("../../lib/mongodb").GridStore; - -var options = { - auto_reconnect: true, - poolSize: 1, - socketOptions: { timeout:8000 } -}; - -var db = new Db("data", new Server( 'localhost', 27017, options)); -db.open(function(err, client){ - var id = new ObjectID(); - // Write a file into gridfs and then verify that it's readable - var gridStore = new GridStore(client, 'manual_test.jpg', "w"); - gridStore.writeFile('/Users/christiankvalheim/coding/projects/node-mongodb-native/test/gridstore/iya_logo_final_bw.jpg', function(err, result) { - db.close(); - }) -}); \ No newline at end of file diff --git a/test/manual_tests/hanging_queries_test.js b/test/manual_tests/hanging_queries_test.js deleted file mode 100644 index 09ac425852f..00000000000 --- a/test/manual_tests/hanging_queries_test.js +++ /dev/null @@ -1,182 +0,0 @@ -var ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager; - -var mongo = require('../../lib/mongodb'), - // website = new mongo.Db('simplereach_website_production', new mongo.Server('localhost', 27017, {auto_reconnect:true, poolSize:5})), - // adserver = new mongo.Db('adserver', new mongo.Server('localhost', 27017, {auto_reconnect:true, poolSize:5})), - accounts = [], accountsCollection, contentCollection, count = 0; - -RS = new ReplicaSetManager({retries:120, secondary_count:1, passive_count:0, arbiter_count:1}); -RS.startSet(true, function(err, result) { - // Replica configuration - var replSet = new mongo.ReplSetServers( [ - new mongo.Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new mongo.Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new mongo.Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, read_secondary:true, readPreference:mongo.Server.READ_SECONDARY_ONLY} - ); - - // Replica configuration - var replSet2 = new mongo.ReplSetServers( [ - new mongo.Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new mongo.Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new mongo.Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, read_secondary:true, readPreference:mongo.Server.READ_SECONDARY_ONLY} - ); - - var adserver = new mongo.Db('adserver', replSet); - var website = new mongo.Db('simplereach_website_production', replSet2); - - website.on('error', function(err){ - console.log(err); process.exit(1); - }); - - adserver.on('error', function(err){ - console.log(err); process.exit(1); - }); - - /** - * loads content for accounts in the array - */ - function loadContent(){ - var account = accounts.shift(); - fields = ['account_id','avg_ctr','cat','channels','ckw','ctr','published','topics','url', 'updated_at', 'disabled'], - sort = [['published','desc']], - criteria = { account_id:account, $or:[ { end_date: null }, { end_date:{ $gte:new Date() }} ]}; - - if(account === undefined){ - process.exit(1); - // no more accounts to process - // the return here goes into limbo - return; - } - console.log('GETTING CONTENT'); - contentCollection.find(criteria, {fields:fields, limit:100000, sort:sort}, function(err, cursor){ - - cursor.each(function(err, doc) { - if(err){ console.log(err); process.exit(1); } - if(doc === null){ - //once this account is done, load the next - console.log('FINISHED ACCOUNT', account, 'WITH', count, 'ITEMS'); - count = 0; - process.nextTick(function() { - loadContent(); - }) - } else { - count += 1; - } - }); - }); - } - - /** - * loads content for accounts in the array - */ - function loadContentParallel(account, callback){ - var fields = ['account_id','avg_ctr','cat','channels','ckw','ctr','published','topics','url', 'updated_at', 'disabled'], - sort = [['published','desc']], - criteria = { account_id:account, $or:[ { end_date: null }, { end_date:{ $gte:new Date() }} ]}; - - if(account === undefined){ - process.exit(1); - - // no more accounts to process - // the return here goes into limbo - return; - } - console.log('GETTING CONTENT'); - contentCollection.find(criteria, {fields:fields, limit:100000, sort:sort}, function(err, cursor){ - cursor.each(function(err, doc) { - if(err){ - return callback(err, account); - } - - if(doc === null){ - //once this account is done, load the next - console.log('FINISHED ACCOUNT', account, 'WITH', count, 'ITEMS'); - count = 0; - callback(null, account); - } else { - count += 1; - } - }); - }); - } - - /** - * Loads account ids and pushes them onto an array - **/ - function loadAccountsParallel(){ - accountsCollection.find({active:{$ne:null}}, { fields:{'_id':1, 'a':1}}).toArray(function(err, accounts) { - // keep track of the number of accounts - var numberOfFinishedAccount = accounts.length; - - for(var i = 0; i < accounts.length; i++) { - loadContentParallel(accounts[i].a, function(err, result) { - numberOfFinishedAccount = numberOfFinishedAccount - 1; - - if(numberOfFinishedAccount == 0) process.exit(0); - }); - } - }); - } - - /** - * Loads account ids and pushes them onto an array - **/ - function loadAccounts(){ - accountsCollection.find({active:{$ne:null}}, { fields:{'_id':1, 'a':1}}, function(err, cursor) { - if(err){ console.log(err); process.exit(1); } - console.log('GETTING ACCOUNTS'); - cursor.each(function(err, doc){ - if(err){ console.log(err); process.exit(1); } - if(doc !== null){ - accounts.push(doc.a); - } else { - console.log('FOUND', accounts.length, 'ACCOUNTS'); - loadContent(); - } - }); - }); - } - - console.log('OPENING CONNECTION TO WEBSITE'); - website.open(function(err, wsClient){ - if(err){console.log(err); process.exit(1); } - console.log('OPENING CONNECTION TO ADSERVER'); - adserver.open(function(err, asClient){ - if(err){ console.log(err); process.exit(1); } - - // Get collections and remove the content - accountsCollection = asClient.collection('accounts'); - accountsCollection.remove(); - - contentCollection = asClient.collection('content'); - contentCollection.remove(); - - // insert a bunch of account docs to trigger flows - var accountDocs = []; - for(var i = 0; i < 1000; i++) { - accountDocs.push({a:i, active:true}); - } - - // insert a bunch of account docs to trigger flows - var contentDocs = []; - for(var i = 0; i < 1000; i++) { - var a_id = Math.floor(Math.random()*1000); - contentDocs.push({a:1, end_date:null, account_id:a_id}); - } - - // Just insert some test data - accountsCollection.insert(accountDocs, {safe:{w:2, wtimout:1000}}, function(err, r) { - contentCollection.insert(contentDocs, {safe:{w:2, wtimout:1000}}, function(err, r) { - // process.exit(0); - loadAccounts(); - // loadAccountsParallel(); - }); - }); - }); - }); -}); - diff --git a/test/manual_tests/issue_replicaset_test.js b/test/manual_tests/issue_replicaset_test.js deleted file mode 100644 index ed5692b24ac..00000000000 --- a/test/manual_tests/issue_replicaset_test.js +++ /dev/null @@ -1,43 +0,0 @@ -var mongodb = require("../../lib/mongodb"), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager; - -var options = { - auto_reconnect: true, - poolSize: 4, - socketOptions: { keepAlive: 100, timeout:6000 } -}; - -var userObjects = []; - -// Build user array -for(var i = 0; i < 122; i++) { - userObjects.push({'user_id':i}); -} - -// Manual config -// mongod --rest --replSet mlocal --oplogSize 8 --dbpath=./d1 -// mongod --port 27018 --rest --replSet mlocal --dbpath=./d2 -// mongod --port=27019 --rest --replSet mlocal --dbpath=./d3 -// {"_id" : "mlocal", "members" : [{"_id" : 0,"host" : "localhost:27017"},{"_id" : 1,"host" : "localhost:27018"},{"_id" : 2,"host" : "localhost:27019","arbiterOnly" : true}]} - -// Replica configuration -var replSet = new mongodb.ReplSetServers( [ - new mongodb.Server( 'localhost', 27017, { auto_reconnect: true } ), - new mongodb.Server( 'localhost', 27018, { auto_reconnect: true } ), - new mongodb.Server( 'localhost', 27019, { auto_reconnect: true } ) - ], - {rs_name:'mlocal'} -); - -var queryCount = 0; -var users; -var db = new mongodb.Db("data", replSet); -db.on("error", function(err) { - console.log("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@") - console.dir(err) -}) - -db.open(function(err, client){ - // Just close the connection - db.close(); -}); diff --git a/test/manual_tests/manual_larger_queries.js b/test/manual_tests/manual_larger_queries.js deleted file mode 100644 index 09aceeb8dbe..00000000000 --- a/test/manual_tests/manual_larger_queries.js +++ /dev/null @@ -1,137 +0,0 @@ -var mongodb = require("../../lib/mongodb"), - ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager; - -var options = { - auto_reconnect: true, - poolSize: 4, - socketOptions: { keepAlive: 100, timeout:30000 } -}; - -var userObjects = []; -var counter = 0; -var counter2 = 0; -var maxUserId = 10000; - -// Build user array -for(var i = 0; i < 122; i++) { - userObjects.push({a:true, b:true}); -} - -RS = new ReplicaSetManager({retries:120, secondary_count:1, passive_count:0, arbiter_count:1}); -RS.startSet(true, function(err, result) { - // Replica configuration - var replSet = new mongodb.ReplSetServers( [ - new mongodb.Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, read_secondary:true, readPreference:mongodb.Server.READ_SECONDARY} - ); - - var collA; - var collB; - - var db = new mongodb.Db("data", replSet); - db.open(function(err, client){ - console.log("Connected"); - if(err != null) { - console.dir(err); - return; - } - - var userCollection = client.collection('users'); - var accountCollection = client.collection('accounts'); - - // Generate a bunch of fake accounts - var accountDocs = []; - for(var i = 0; i < 10000; i++) { - accountDocs.push({ - account_id:i, - 'somedata': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata2': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata3': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata4': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata5': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata6': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata7': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata8': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata9': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad' - }) - } - - // Generate a bunch of false users - var userDocs = []; - for(var i = 0; i < maxUserId; i++) { - // Generate a random number of account ids - var numberOfAccounts = Math.floor(Math.random(10000)); - // Generate an array of random numbers - var accountIds = []; - for(var j = 0; j < numberOfAccounts; j++) { - numberOfAccounts.push(Math.floor(Math.random(10000))); - } - - // Generate a user - userDocs.push({ - user_id:i, - ids:accountIds, - 'somedata': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata2': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata3': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata4': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata5': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata6': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata7': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata8': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad', - 'somedata9': 'dfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaaddfdfdsaaad' - }) - } - - // Insert all the docs - userCollection.insert(userDocs, {safe:true}, function(err, result) { - console.dir(err); - - accountCollection.insert(accountDocs, {safe:true}, function(err, result) { - console.dir(err); - - var timeoutFunc = function() { - lookup(function(err, result) { - console.log("-------------------------------------------- lookedup :: " + counter); - counter = counter + 1; - process.nextTick(timeoutFunc, 1); - }); - } - - process.nextTick(timeoutFunc, 1); - }); - }); - }); - - function lookup(cb){ - // Locate a random user - db.collection('users', function(err, userCollection) { - - userCollection.findOne({user_id:Math.floor(Math.random(maxUserId))}, function(err, user) { - if(err == null && user != null) { - console.log("-------------------------------------------- findOne"); - - // Fetch all the accounts - db.collection('accounts', function(err, accountCollection) { - - accountCollection.find({account_id:{$in:user.ids}}).toArray(function(err, accounts) { - if(err == null && accounts != null) { - console.log("-------------------------------------------- findAccounts :: " + accounts.length); - cb(null, null); - } else { - console.log("-------------------------------------------- findAccounts ERROR"); - cb(err, null); - } - }); - }); - } else { - console.log("-------------------------------------------- findOne ERROR"); - cb(err, null); - } - }); - }); - } -}); \ No newline at end of file diff --git a/test/manual_tests/manual_lock.js b/test/manual_tests/manual_lock.js deleted file mode 100644 index 33da8bec3f0..00000000000 --- a/test/manual_tests/manual_lock.js +++ /dev/null @@ -1,84 +0,0 @@ -var mongodb = require("../../lib/mongodb"), - ReplicaSetManager = require('../../test/tools/replica_set_manager').ReplicaSetManager; - -var options = { - auto_reconnect: true, - poolSize: 4, - socketOptions: { keepAlive: 100, timeout:30000 } -}; - -var userObjects = []; -var counter = 0; -var counter2 = 0; - -// Build user array -for(var i = 0; i < 122; i++) { - userObjects.push({a:true, b:true}); -} - -RS = new ReplicaSetManager({retries:120, secondary_count:1, passive_count:0, arbiter_count:1}); -RS.startSet(true, function(err, result) { - // Replica configuration - var replSet = new mongodb.ReplSetServers( [ - new mongodb.Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var collA; - var collB; - - var db = new mongodb.Db("data", replSet); - db.open(function(err, client){ - console.log("Connected"); - client.collection("collA", function(err, coll){ - collA = coll; - - coll.insert(userObjects, {safe:true}, function(err, result) { - - client.collection("collB", function(err, coll){ - collB = coll; - - coll.insert(userObjects, {safe:true}, function(err, result) { - - var timeoutFunc = function() { - lookup(function(err, result) { - console.log("-------------------------------------------- lookedup") - process.nextTick(timeoutFunc, 1); - }) - } - - process.nextTick(timeoutFunc, 1); - }); - }); - }); - }); - }); - - function lookup(cb){ - var a, b; - var waiting = 2; - - collA.findOne({ a: true }, function(err, result){ - a = result; - waiting--; - if(waiting === 0){ - console.log("---------------------------------------------------------------------- collA :: " + counter); - counter = counter + 1; - cb(null, [a, b]); - } - }); - - collB.findOne({ b: true }, function(err, result){ - b = result; - waiting--; - if(waiting === 0){ - console.log("---------------------------------------------------------------------- collB :: " + counter); - counter = counter + 1; - cb(null, [a, b]); - } - }); - } -}); \ No newline at end of file diff --git a/test/manual_tests/replicaset_test.js b/test/manual_tests/replicaset_test.js deleted file mode 100644 index fc61965a0d9..00000000000 --- a/test/manual_tests/replicaset_test.js +++ /dev/null @@ -1,70 +0,0 @@ -var mongodb = require("../../lib/mongodb"), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager; - -var options = { - auto_reconnect: true, - poolSize: 4, - socketOptions: { keepAlive: 100, timeout:6000 } -}; - -var userObjects = []; - -// Build user array -for(var i = 0; i < 122; i++) { - userObjects.push({'user_id':i}); -} - -RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); -RS.startSet(true, function(err, result) { - // Replica configuration - var replSet = new mongodb.ReplSetServers( [ - new mongodb.Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var queryCount = 0; - var users; - var db = new mongodb.Db("data", replSet); - db.on("error", function(err) { - console.log("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@") - console.dir(err) - }) - - db.open(function(err, client){ - if(err){ - console.log("[%s] %s", new Date, err.stack || err); - return; - } - - if(users){ - console.log("[%s] Reconnected?!", new Date); - return; - } - - client.collection("users", function(err, coll){ - coll.insert(userObjects, {safe:true}, function(err, result) { - users = coll; - query(); - }) - }); - }); - - function query(){ - var current = queryCount++; - console.log("[%s] #%s querying all users", new Date, current); - // setTimeout(query, 32 * 1000); - setTimeout(query, 7 * 1000); - users.find().count(function(err, all){ - if(err){ - console.log("[%s] #%s %s", new Date, current, err.stack || err); - }else{ - console.log("[%s] #%s found %s users", new Date, current, all); - } - }); - } -}); - - diff --git a/test/manual_tests/server_load.js b/test/manual_tests/server_load.js deleted file mode 100644 index 5640234f0b2..00000000000 --- a/test/manual_tests/server_load.js +++ /dev/null @@ -1,152 +0,0 @@ -#!/usr/bin/env node -var mongo = require("../../lib/mongodb"); -var express = require("express"); -var ObjectID = mongo.ObjectID; -var DBRef = mongo.DBRef; -var util = require("util"); - -var app = express.createServer(); - -app.configure(function() { - app.set('dbconnection', { - "port": 27017, - "host": "localhost" - }); -}); - -app.renderResponse = function(res, err, data, allCount) { - res.header('Content-Type', 'application/json'); - - if(err == null) { - if(typeof allCount == "undefined") { - res.send({data: data, success: true}); - } else { - res.send({allCount: allCount, data: data, success: true}); - } - } else { - util.log(util.inspect(err)); - console.log(err.stack); - res.send({success: false, error:err.message}); - } -}; - -app.use(express.bodyParser()); -app.use(app.router); -app.use(express.logger()); -app.use(express.errorHandler({ dumpExceptions: true, showStack: true })); - -var isISO8601 = function(dString) { - var regexp = /(\d\d\d\d)(-)?(\d\d)(-)?(\d\d)(T)?(\d\d)(:)?(\d\d)(:)?(\d\d)(\.\d+)?(Z|([+-])(\d\d)(:)?(\d\d))?/; - if (dString.toString().match(new RegExp(regexp))) { - return true; - } - else - { - return false; - } -}; - - -var decodeField = function(value) { - if(value == null) - return null; - - if(typeof value == "object" && value['namespace'] && value['oid']) { - if(/^[0-9a-fA-F]{24}$/.test(value['oid'])) - return new DBRef(value['namespace'], new ObjectID(value['oid'])); - else - return new DBRef(value['namespace'], value['oid']); - } - - if(isISO8601(value)) - return new Date(value); - - return value; -}; - -var deepDecode = function(obj) { - for(var i in obj) - { - if(obj[i] == null) { - // do nothing - } - else if(i == "_id" && /^[0-9a-fA-F]{24}$/.test(obj[i])) { - obj[i] = new ObjectID(obj[i]); - } - else if(typeof obj[i] == "object" && typeof obj[i]['namespace'] == "undefined" && typeof obj[i]['oid'] == "undefined") { - deepDecode(obj[i]); - } - else { - obj[i] = decodeField(obj[i]); - } - } -}; - -db = null; -var openConnection = function(dbname, config, callback) { - if(db) { - callback(null, db); - } - else { - var target; - target = new mongo.Server(config.host, config.port, {'auto_reconnect':true, 'poolSize':4}); - db = new mongo.Db(dbname, target, {native_parser:false}); - db.open(callback); - } -} - -var listCommand = function (target, spec, options, next){ - deepDecode(spec); - openConnection(target.db, target.connection, function(err,db) { - if(err) { next(err); return; } - // open collection - db.collection(target.collection, function(err, collection) { - - if(spec._id) { - collection.findOne(spec, options, function(err, doc){ - next(err, doc); - }); - } - else - { - // console.dir(options) - options['limit'] = 10; - - collection.find(spec, options, function(err, cursor) - { - - cursor.toArray(function(err, docs) - { - next(err, docs); - //db.close(); - }); - }); - } - }); - }); -} - -app.get('/:db/:collection/:id?', function(req, res, next) -{ - var spec = req.query.query? JSON.parse(req.query.query) : {}; - spec = req.query.spec? JSON.parse(req.query.spec) : spec; - - if(req.params.id) - spec._id = req.params.id; - - // JSON decode options - var options = req.query.options?JSON.parse(req.query.options) : {}; - - listCommand({ - connection: app.set("dbconnection"), - db: req.params.db, - collection: req.params.collection - }, - spec, - options, - function(err, docs, allCount) { - app.renderResponse(res, err, docs, allCount); - }); -}); - -app.listen(9999, '127.0.0.1'); \ No newline at end of file diff --git a/test/manual_tests/simple_test.js b/test/manual_tests/simple_test.js deleted file mode 100644 index 55b561e5f0e..00000000000 --- a/test/manual_tests/simple_test.js +++ /dev/null @@ -1,23 +0,0 @@ -var Db = require('../../lib/mongodb').Db, - Server = require('../../lib/mongodb').Server; - -var _db = new Db('mydb', new Server('localhost', 27017, {auto_reconnect: true, poolSize: 2})); -_db.open(function(err, db) { - - db.collection('coll1', function(err, coll) { - var expireDate = new Date(); - expireDate.setHours(expireDate.getHours() + 24); - coll.remove({valid_to: {$lt: expireDate}}, {safe: true}, function(err) { - console.log('Deleted the items'); - }); - }); - - db.collection('coll2', function(err, coll) { - coll.find({}, {}, function(err, cursor) { - console.log('Turning the cursor into an array'); - cursor.toArray(function(err, docs) { - console.log('Got the array'); - }); - }); - }); -}); \ No newline at end of file diff --git a/test/manual_tests/single_test.js b/test/manual_tests/single_test.js deleted file mode 100644 index 662b921e92b..00000000000 --- a/test/manual_tests/single_test.js +++ /dev/null @@ -1,61 +0,0 @@ -var mongodb = require("../../lib/mongodb"), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager; - -var options = { - auto_reconnect: true, - poolSize: 1, - // socketOptions: { keepAlive: 100, timeout:8000 } - socketOptions: { timeout:8000 } -}; - -var userObjects = []; - -// Build user array -for(var i = 0; i < 122; i++) { - userObjects.push({'user_id':i}); -} - -var queryCount = 0; -var replSet = new mongodb.Server( 'localhost', 27017, options); - -var users; -var db = new mongodb.Db("data", replSet); -db.on("error", function(err) { - console.log("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@") - console.dir(err) -}) - -db.open(function(err, client){ - if(err){ - console.log("[%s] %s", new Date, err.stack || err); - return; - } - - if(users){ - console.log("[%s] Reconnected?!", new Date); - return; - } - - client.collection("users", function(err, coll){ - coll.remove({}, {safe:true}, function(err) { - coll.insert(userObjects, {safe:true}, function(err, result) { - users = coll; - query(); - }) - }); - }); -}); - -function query(){ - var current = queryCount++; - console.log("[%s] #%s querying all users", new Date, current); - // setTimeout(query, 32 * 1000); - setTimeout(query, 7 * 1000); - users.find().count(function(err, all){ - if(err){ - console.log("[%s] #%s %s", new Date, current, err.stack || err); - }else{ - console.log("[%s] #%s found %s users", new Date, current, all); - } - }); -} \ No newline at end of file diff --git a/test/manual_tests/test.js b/test/manual_tests/test.js deleted file mode 100644 index 006668b3d09..00000000000 --- a/test/manual_tests/test.js +++ /dev/null @@ -1,83 +0,0 @@ -var mongodb = require("./lib/mongodb"), - ReplicaSetManager = require('./test/tools/replica_set_manager').ReplicaSetManager; - -var options = { - auto_reconnect: true, - poolSize: 4, - socketOptions: { keepAlive: 100, timeout:30000 } -}; - -var userObjects = []; - -// Build user array -for(var i = 0; i < 122; i++) { - userObjects.push({'user_id':i}); -} - -// var replSet = new mongodb.ReplSetServers([ -// new mongodb.Server("mongo-1", 27017, options), -// new mongodb.Server("mongo-2", 27017, options), -// new mongodb.Server("mongo-3", 27017, options) -// ]); - -RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); -RS.startSet(true, function(err, result) { - // Replica configuration - var replSet = new mongodb.ReplSetServers( [ - new mongodb.Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new mongodb.Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - // {rs_name:RS.name, strategy:'ping'} - // {rs_name:RS.name, strategy:'statistical'} - ); - - var users; - var db = new mongodb.Db("data", replSet); - db.open(function(err, client){ - if(err){ - console.log("[%s] %s", new Date, err.stack || err); - return; - } - - if(users){ - console.log("[%s] Reconnected?!", new Date); - return; - } - - client.collection("users", function(err, coll){ - console.log("Connected"); - coll.insert(userObjects, {safe:true}, function(err, result) { - users = coll; - query(); - }) - }); - // client.collection("users", function(err, users){ - // console.log("Connected"); - // db.users = users; - // query(); - // }); - }); - - function query(){ - console.log("[%s] querying all users", new Date); - // setTimeout(query, 70 * 60 * 1000); - setTimeout(query, 32 * 1000); - db.collection('users', function(err, coll) { - if(err){ - console.log("[0] :: [%s] %s", new Date, err.stack || err); - } - - coll.find().count(function(err, all){ - if(err){ - console.log("[1] :: [%s] %s", new Date, err.stack || err); - }else{ - console.log("[2] :: [%s] found %s users", new Date, all); - } - }); - }) - } -}); - - diff --git a/test/map_reduce_test.js b/test/map_reduce_test.js deleted file mode 100644 index c6ea7906bcd..00000000000 --- a/test/map_reduce_test.js +++ /dev/null @@ -1,520 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Code = require('../lib/mongodb/bson/code').Code, - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * A whole lot of different wayt to execute the group command - * - * @_class collection - * @_function group - */ -exports.shouldCorrectlyExecuteGroupFunction = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a test collection - db.createCollection('test_group', function(err, collection) { - - // Peform a simple group by on an empty collection - collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", function(err, results) { - test.deepEqual([], results); - - // Trigger some inserts on the collection - collection.insert([{'a':2}, {'b':5}, {'a':1}], {safe:true}, function(err, ids) { - - // Perform a group count - collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }" - , function(err, results) { - test.equal(3, results[0].count); - - // Pefrom a group count using the eval method - collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }" - , false, function(err, results) { - test.equal(3, results[0].count); - - // Group with a conditional - collection.group([], {'a':{'$gt':1}}, {"count":0}, "function (obj, prev) { prev.count++; }" - , function(err, results) { - // Results - test.equal(1, results[0].count); - - // Group with a conditional using the EVAL method - collection.group([], {'a':{'$gt':1}}, {"count":0}, "function (obj, prev) { prev.count++; }" - , false, function(err, results) { - // Results - test.equal(1, results[0].count); - - // Insert some more test data - collection.insert([{'a':2}, {'b':3}], {safe:true}, function(err, ids) { - - // Do a Group by field a - collection.group(['a'], {}, {"count":0}, "function (obj, prev) { prev.count++; }" - , function(err, results) { - // Results - test.equal(2, results[0].a); - test.equal(2, results[0].count); - test.equal(null, results[1].a); - test.equal(2, results[1].count); - test.equal(1, results[2].a); - test.equal(1, results[2].count); - - // Do a Group by field a - collection.group({'a':true}, {}, {"count":0}, function (obj, prev) { prev.count++; } - , true, function(err, results) { - // Results - test.equal(2, results[0].a); - test.equal(2, results[0].count); - test.equal(null, results[1].a); - test.equal(2, results[1].count); - test.equal(1, results[2].a); - test.equal(1, results[2].count); - - // Correctly handle illegal function - collection.group([], {}, {}, "5 ++ 5", function(err, results) { - test.ok(err instanceof Error); - test.ok(err.message != null); - - // Use a function to select the keys used to group by - var keyf = function(doc) { return {a: doc.a}; }; - collection.group(keyf, {a: {$gt: 0}}, {"count": 0, "value": 0} - , function(obj, prev) { prev.count++; prev.value += obj.a; }, true, function(err, results) { - // Results - results.sort(function(a, b) { return b.count - a.count; }); - test.equal(2, results[0].count); - test.equal(2, results[0].a); - test.equal(4, results[0].value); - test.equal(1, results[1].count); - test.equal(1, results[1].a); - test.equal(1, results[1].value); - - // Correctly handle illegal function when using the EVAL method - collection.group([], {}, {}, "5 ++ 5", false, function(err, results) { - test.ok(err instanceof Error); - test.ok(err.message != null); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** -* @ignore -*/ -exports.shouldCorrectlyExecuteGroupFunctionWithFinalizeFunction = function(test) { - client.createCollection('test_group2', function(err, collection) { - collection.group([], {}, {"count":0}, "function (obj, prev) { prev.count++; }", true, function(err, results) { - test.deepEqual([], results); - - // Trigger some inserts - collection.insert([{'a':2}, {'b':5, 'a':0}, {'a':1}, {'c':2, 'a':0}], {safe:true}, function(err, ids) { - collection.group([], {}, {count: 0, running_average: 0} - , function (doc, out) { - out.count++; - out.running_average += doc.a; - } - , function(out) { - out.average = out.running_average / out.count; - }, true, function(err, results) { - test.equal(3, results[0].running_average) - test.equal(0.75, results[0].average) - test.done(); - }); - }); - }); - }); -} - -/** - * A simple map reduce example - * - * @_class collection - * @_function mapReduce - */ -exports.shouldPerformSimpleMapReduceFunctions = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a test collection - db.createCollection('test_map_reduce_functions', function(err, collection) { - - // Insert some documents to perform map reduce over - collection.insert([{'user_id':1}, {'user_id':2}], {safe:true}, function(err, r) { - - // Map function - var map = function() { emit(this.user_id, 1); }; - // Reduce function - var reduce = function(k,vals) { return 1; }; - - // Peform the map reduce - collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}}, function(err, collection) { - // Mapreduce returns the temporary collection with the results - collection.findOne({'_id':1}, function(err, result) { - test.equal(1, result.value); - - collection.findOne({'_id':2}, function(err, result) { - test.equal(1, result.value); - - db.close(); - test.done(); - }); - }); - }); - }); - }); - }); -} - -/** - * A simple map reduce example using the inline output type on MongoDB > 1.7.6 - * - * @_class collection - * @_function mapReduce - */ -exports.shouldPerformMapReduceFunctionInline = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Parse version of server if available - db.admin().serverInfo(function(err, result){ - - // Only run if the MongoDB version is higher than 1.7.6 - if(parseInt((result.version.replace(/\./g, ''))) >= 176) { - - // Create a test collection - db.createCollection('test_map_reduce_functions_inline', function(err, collection) { - - // Insert some test documents - collection.insert([{'user_id':1}, {'user_id':2}], {safe:true}, function(err, r) { - - // Map function - var map = function() { emit(this.user_id, 1); }; - // Reduce function - var reduce = function(k,vals) { return 1; }; - - // Execute map reduce and return results inline - collection.mapReduce(map, reduce, {out : {inline: 1}}, function(err, results) { - test.equal(2, results.length); - - db.close(); - test.done(); - }); - }); - }); - } else { - test.done(); - } - }); - }); -} - -/** -* Mapreduce different test with a provided scope containing a javascript function. -* -* @_class collection -* @_function mapReduce -*/ -exports.shouldPerformMapReduceInContext = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Create a test collection - client.createCollection('test_map_reduce_functions_scope', function(err, collection) { - - // Insert some test documents - collection.insert([{'user_id':1, 'timestamp':new Date()} - , {'user_id':2, 'timestamp':new Date()}], {safe:true}, function(err, r) { - - // Map function - var map = function(){ - emit(test(this.timestamp.getYear()), 1); - } - - // Reduce function - var reduce = function(k, v){ - count = 0; - for(i = 0; i < v.length; i++) { - count += v[i]; - } - return count; - } - - // Javascript function available in the map reduce scope - var t = function(val){ return val+1; } - - // Execute the map reduce with the custom scope - collection.mapReduce(map, reduce, {scope:{test:new Code(t.toString())} - , out: {replace:'replacethiscollection'}}, function(err, collection) { - - // Find all entries in the map-reduce collection - collection.find().toArray(function(err, results) { - test.equal(2, results[0].value) - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** -* Mapreduce tests -* @ignore -*/ -exports.shouldPerformMapReduceWithStringFunctions = function(test) { - client.createCollection('test_map_reduce', function(err, collection) { - collection.insert([{'user_id':1}, {'user_id':2}], {safe:true}, function(err, r) { - // String functions - var map = "function() { emit(this.user_id, 1); }"; - var reduce = "function(k,vals) { return 1; }"; - - collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}}, function(err, collection) { - collection.findOne({'_id':1}, function(err, result) { - test.equal(1, result.value); - }); - - collection.findOne({'_id':2}, function(err, result) { - test.equal(1, result.value); - test.done(); - }); - }); - }); - }); -} - -/** -* @ignore -*/ -exports.shouldPerformMapReduceWithParametersBeingFunctions = function(test) { - client.createCollection('test_map_reduce_with_functions_as_arguments', function(err, collection) { - collection.insert([{'user_id':1}, {'user_id':2}], {safe:true}, function(err, r) { - // String functions - var map = function() { emit(this.user_id, 1); }; - var reduce = function(k,vals) { return 1; }; - - collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}}, function(err, collection) { - collection.findOne({'_id':1}, function(err, result) { - test.equal(1, result.value); - }); - - collection.findOne({'_id':2}, function(err, result) { - test.equal(1, result.value); - test.done(); - }); - }); - }); - }); -} - -/** -* @ignore -*/ -exports.shouldPerformMapReduceWithCodeObjects = function(test) { - client.createCollection('test_map_reduce_with_code_objects', function(err, collection) { - collection.insert([{'user_id':1}, {'user_id':2}], {safe:true}, function(err, r) { - // String functions - var map = new Code("function() { emit(this.user_id, 1); }"); - var reduce = new Code("function(k,vals) { return 1; }"); - - collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}}, function(err, collection) { - collection.findOne({'_id':1}, function(err, result) { - test.equal(1, result.value); - }); - - collection.findOne({'_id':2}, function(err, result) { - test.equal(1, result.value); - test.done(); - }); - }); - }); - }); -} - -/** -* @ignore -*/ -exports.shouldPerformMapReduceWithOptions = function(test) { - client.createCollection('test_map_reduce_with_options', function(err, collection) { - collection.insert([{'user_id':1}, {'user_id':2}, {'user_id':3}], {safe:true}, function(err, r) { - // String functions - var map = new Code("function() { emit(this.user_id, 1); }"); - var reduce = new Code("function(k,vals) { return 1; }"); - - collection.mapReduce(map, reduce, {out: {replace : 'tempCollection'}, 'query': {'user_id':{'$gt':1}}}, function(err, collection) { - collection.count(function(err, count) { - test.equal(2, count); - - collection.findOne({'_id':2}, function(err, result) { - test.equal(1, result.value); - }); - - collection.findOne({'_id':3}, function(err, result) { - test.equal(1, result.value); - test.done(); - }); - }); - }); - }); - }); -} - -/** -* @ignore -*/ -exports.shouldHandleMapReduceErrors = function(test) { - client.createCollection('test_map_reduce_error', function(err, collection) { - collection.insert([{'user_id':1}, {'user_id':2}, {'user_id':3}], {safe:true}, function(err, r) { - // String functions - var map = new Code("function() { throw 'error'; }"); - var reduce = new Code("function(k,vals) { throw 'error'; }"); - - collection.mapReduce(map, reduce, {out : {inline: 1}, 'query': {'user_id':{'$gt':1}}}, function(err, r) { - test.ok(err != null); - test.done(); - }); - }); - }); -} - -/** -* @ignore -*/ -exports.shouldCorrectlyReturnNestedKeys = function(test) { - var start = new Date().setTime(new Date().getTime() - 10000); - var end = new Date().setTime(new Date().getTime() + 10000); - - var keys = { - "data.lastname": true - }; - - var condition = { - "data.date": { - $gte: start, - $lte: end - } - }; - - condition = {} - - var initial = { - count : 0 - }; - - var reduce = function(doc, output) { - output.count++; - } - - // Execute the group - client.createCollection('data', function(err, collection) { - collection.insert({ - data: { - lastname:'smith', - date:new Date() - } - }, {safe:true}, function(err, result) { - - // Execute the group - collection.group(keys, condition, initial, reduce, true, function(err, r) { - test.equal(1, r[0].count) - test.equal('smith', r[0]['data.lastname']); - test.done(); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/multiple_dbs_on_connection_pool_test.js b/test/multiple_dbs_on_connection_pool_test.js deleted file mode 100644 index b8d364aa6ca..00000000000 --- a/test/multiple_dbs_on_connection_pool_test.js +++ /dev/null @@ -1,256 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - ServerManager = require('../test/tools/server_manager').ServerManager, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyEmitErrorOnAllDbsOnPoolClose = function(test) { - if(process.platform !== 'linux') { - var db = new Db('tests', new Server("127.0.0.1", 27027, {auto_reconnect: true}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - // All inserted docs - var docs = []; - var errs = []; - var insertDocs = []; - var numberOfCloses = 0; - - // Start server - var serverManager = new ServerManager({auth:false, purgedirectories:true, journal:false, start_port:27027}) - serverManager.start(false, function() { - db.on("close", function(err) { - numberOfCloses = numberOfCloses + 1; - }) - - db.open(function(err, db) { - db.createCollection('shouldCorrectlyErrorOnAllDbs', function(err, collection) { - test.equal(null, err); - - collection.insert({a:1}, {safe:true}, function(err, result) { - test.equal(null, err); - - // Open a second db - var db2 = db.db('tests_2'); - // Add a close handler - db2.on("close", function(err) { - numberOfCloses = numberOfCloses + 1; - }); - - db.serverConfig.connectionPool.openConnections[0].connection.destroy(); - - // Kill server and end test - serverManager.stop(9, function() { - test.equal(2, numberOfCloses) - test.done(); - }); - }); - }); - }); - }); - } else { - test.done(); - } -} - -/** - * Test the auto connect functionality of the db - * - * @ignore - */ -exports.shouldCorrectlyUseSameConnectionsForTwoDifferentDbs = function(test) { - var second_test_database = new Db(MONGODB + "_2", new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null), retryMiliSeconds:50}); - // Just create second database - second_test_database.open(function(err, second_test_database) { - // Close second database - second_test_database.close(); - // Let's grab a connection to the different db resusing our connection pools - var secondDb = client.db(MONGODB + "_2"); - secondDb.createCollection('shouldCorrectlyUseSameConnectionsForTwoDifferentDbs', function(err, collection) { - // Insert a dummy document - collection.insert({a:20}, {safe: true}, function(err, r) { - test.equal(null, err); - - // Query it - collection.findOne({}, function(err, item) { - test.equal(20, item.a); - - // Use the other db - client.createCollection('shouldCorrectlyUseSameConnectionsForTwoDifferentDbs', function(err, collection) { - // Insert a dummy document - collection.insert({b:20}, {safe: true}, function(err, r) { - test.equal(null, err); - - // Query it - collection.findOne({}, function(err, item) { - test.equal(20, item.b); - - // Drop the second db - secondDb.dropDatabase(function(err, item) { - test.equal(null, err); - test.done(); - }) - }) - }); - }); - }) - }); - }); - }); -} - -/** - * Test the auto connect functionality of the db - * - * @ignore - */ -exports.shouldCorrectlyUseSameConnectionsForTwoDifferentDbs = function(test) { - var second_test_database = new Db(MONGODB + "_2", new Server("127.0.0.1", 27017, {auto_reconnect: true, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null), retryMiliSeconds:50}); - // Just create second database - second_test_database.open(function(err, second_test_database) { - // Close second database - second_test_database.close(); - // Let's grab a connection to the different db resusing our connection pools - var secondDb = client.db(MONGODB + "_2"); - secondDb.createCollection('shouldCorrectlyUseSameConnectionsForTwoDifferentDbs', function(err, collection) { - // Insert a dummy document - collection.insert({a:20}, {safe: true}, function(err, r) { - test.equal(null, err); - - // Query it - collection.findOne({}, function(err, item) { - test.equal(20, item.a); - - // Use the other db - client.createCollection('shouldCorrectlyUseSameConnectionsForTwoDifferentDbs', function(err, collection) { - // Insert a dummy document - collection.insert({b:20}, {safe: true}, function(err, r) { - test.equal(null, err); - - // Query it - collection.findOne({}, function(err, item) { - test.equal(20, item.b); - - // Drop the second db - secondDb.dropDatabase(function(err, item) { - test.equal(null, err); - test.done(); - }) - }) - }); - }); - }) - }); - }); - }); -} - -/** - * Simple example connecting to two different databases sharing the socket connections below. - * - * @_class db - * @_function db - */ -exports.shouldCorrectlyShareConnectionPoolsAcrossMultipleDbInstances = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - test.equal(null, err); - - // Reference a different database sharing the same connections - // for the data transfer - var secondDb = db.db("integration_tests_2"); - - // Fetch the collections - var multipleColl1 = db.collection("multiple_db_instances"); - var multipleColl2 = secondDb.collection("multiple_db_instances"); - - // Write a record into each and then count the records stored - multipleColl1.insert({a:1}, {safe:true}, function(err, result) { - multipleColl2.insert({a:1}, {safe:true}, function(err, result) { - - // Count over the results ensuring only on record in each collection - multipleColl1.count(function(err, count) { - test.equal(1, count); - - multipleColl2.count(function(err, count) { - test.equal(1, count); - - db.close(); - test.done(); - }); - }); - }); - }); - }); -} - - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/objectid_test.js b/test/objectid_test.js deleted file mode 100644 index f001df8b16e..00000000000 --- a/test/objectid_test.js +++ /dev/null @@ -1,351 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyGenerateObjectID = function(test) { - var number_of_tests_done = 0; - - client.collection('test_object_id_generation.data', function(err, collection) { - // Insert test documents (creates collections and test fetch by query) - collection.insert({name:"Fred", age:42}, {safe:true}, function(err, ids) { - test.equal(1, ids.length); - test.ok(ids[0]['_id'].toHexString().length == 24); - // Locate the first document inserted - collection.findOne({name:"Fred"}, function(err, document) { - test.equal(ids[0]['_id'].toHexString(), document._id.toHexString()); - number_of_tests_done++; - }); - }); - - // Insert another test document and collect using ObjectId - collection.insert({name:"Pat", age:21}, {safe:true}, function(err, ids) { - test.equal(1, ids.length); - test.ok(ids[0]['_id'].toHexString().length == 24); - // Locate the first document inserted - collection.findOne(ids[0]['_id'], function(err, document) { - test.equal(ids[0]['_id'].toHexString(), document._id.toHexString()); - number_of_tests_done++; - }); - }); - - // Manually created id - var objectId = new ObjectID(null); - // Insert a manually created document with generated oid - collection.insert({"_id":objectId, name:"Donald", age:95}, {safe:true}, function(err, ids) { - test.equal(1, ids.length); - test.ok(ids[0]['_id'].toHexString().length == 24); - test.equal(objectId.toHexString(), ids[0]['_id'].toHexString()); - // Locate the first document inserted - collection.findOne(ids[0]['_id'], function(err, document) { - test.equal(ids[0]['_id'].toHexString(), document._id.toHexString()); - test.equal(objectId.toHexString(), document._id.toHexString()); - number_of_tests_done++; - }); - }); - }); - - var intervalId = setInterval(function() { - if(number_of_tests_done == 3) { - clearInterval(intervalId); - test.done(); - } - }, 100); -} - -/** - * Generate 12 byte binary string representation using a second based timestamp or - * default value - * - * @_class objectid - * @_function getTimestamp - * @ignore - */ -exports.shouldCorrectlyGenerate12ByteStringFromTimestamp = function(test) { - // Get a timestamp in seconds - var timestamp = Math.floor(new Date().getTime()/1000); - // Create a date with the timestamp - var timestampDate = new Date(timestamp*1000); - - // Create a new ObjectID with a specific timestamp - var objectId = new ObjectID(timestamp); - - // Get the timestamp and validate correctness - test.equal(timestampDate.toString(), objectId.getTimestamp().toString()); - test.done(); -} - -/** - * Generate a 24 character hex string representation of the ObjectID - * - * @_class objectid - * @_function toHexString - * @ignore - */ -exports.shouldCorrectlyRetrieve24CharacterHexStringFromToString = function(test) { - // Create a new ObjectID - var objectId = new ObjectID(); - // Verify that the hex string is 24 characters long - test.equal(24, objectId.toHexString().length); - test.done(); -} - -/** - * Get and set the generation time for an ObjectID - * - * @_class objectid - * @_function generationTime - * @ignore - */ -exports.shouldCorrectlyGetAndSetObjectIDUsingGenerationTimeProperty = function(test) { - // Create a new ObjectID - var objectId = new ObjectID(); - // Get the generation time - var generationTime = objectId.generationTime; - // Add 1000 miliseconds to the generation time - objectId.generationTime = generationTime + 1000; - - // Create a timestamp - var timestampDate = new Date(); - timestampDate.setTime((generationTime + 1000) * 1000); - - // Get the timestamp and validate correctness - test.equal(timestampDate.toString(), objectId.getTimestamp().toString()); - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyRetrieve24CharacterHexStringFromToString = function(test) { - // Create a new ObjectID - var objectId = new ObjectID(); - // Verify that the hex string is 24 characters long - test.equal(24, objectId.toString().length); - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyRetrieve24CharacterHexStringFromToString = function(test) { - // Create a new ObjectID - var objectId = new ObjectID(); - // Verify that the hex string is 24 characters long - test.equal(24, objectId.toJSON().length); - test.done(); -} - -/** - * Convert a ObjectID into a hex string representation and then back to an ObjectID - * - * @_class objectid - * @_function ObjectID.createFromHexString - * @ignore - */ -exports.shouldCorrectlyTransformObjectIDToAndFromHexString = function(test) { - // Create a new ObjectID - var objectId = new ObjectID(); - // Convert the object id to a hex string - var originalHex = objectId.toHexString(); - // Create a new ObjectID using the createFromHexString function - var newObjectId = new ObjectID.createFromHexString(originalHex) - // Convert the new ObjectID back into a hex string using the toHexString function - var newHex = newObjectId.toHexString(); - // Compare the two hex strings - test.equal(originalHex, newHex); - test.done(); -} - -/** - * Compare two different ObjectID's using the equals method - * - * @_class objectid - * @_function equals - * @ignore - */ -exports.shouldCorrectlyTransformObjectIDToAndFromHexString = function(test) { - // Create a new ObjectID - var objectId = new ObjectID(); - // Create a new ObjectID Based on the first ObjectID - var objectId2 = new ObjectID(objectId.id); - // Create another ObjectID - var objectId3 = new ObjectID(); - // objectId and objectId2 should be the same - test.ok(objectId.equals(objectId2)); - // objectId and objectId2 should be different - test.ok(!objectId.equals(objectId3)); - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyCreateOIDNotUsingObjectID = function(test) { - client.createCollection('test_non_oid_id', function(err, collection) { - var date = new Date(); - date.setUTCDate(12); - date.setUTCFullYear(2009); - date.setUTCMonth(11 - 1); - date.setUTCHours(12); - date.setUTCMinutes(0); - date.setUTCSeconds(30); - - collection.insert({'_id':date}, {safe:true}, function(err, ids) { - collection.find({'_id':date}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(("" + date), ("" + items[0]._id)); - - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyGenerateObjectIDFromTimestamp = function(test) { - var timestamp = Math.floor(new Date().getTime()/1000); - var objectID = new ObjectID(timestamp); - var time2 = objectID.generationTime; - test.equal(timestamp, time2); - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyCreateAnObjectIDAndOverrideTheTimestamp = function(test) { - var timestamp = 1000; - var objectID = new ObjectID(); - var id1 = objectID.id; - // Override the timestamp - objectID.generationTime = timestamp - var id2 = objectID.id; - // Check the strings - test.equal(id1.substr(4), id2.substr(4)); - test.done(); -} - -/** - * @ignore - */ -exports.shouldCorrectlyInsertWithObjectId = function(test) { - client.createCollection('shouldCorrectlyInsertWithObjectId', function(err, collection) { - collection.insert({}, {safe:true}, function(err, ids) { - setTimeout(function() { - collection.insert({}, {safe:true}, function(err, ids) { - collection.find().toArray(function(err, items) { - var compareDate = new Date(); - - // Date 1 - var date1 = new Date(); - date1.setTime(items[0]._id.generationTime * 1000); - // Date 2 - var date2 = new Date(); - date2.setTime(items[1]._id.generationTime * 1000); - - // Compare - test.equal(compareDate.getFullYear(), date1.getFullYear()); - test.equal(compareDate.getDate(), date1.getDate()); - test.equal(compareDate.getMonth(), date1.getMonth()); - test.equal(compareDate.getHours(), date1.getHours()); - - test.equal(compareDate.getFullYear(), date2.getFullYear()); - test.equal(compareDate.getDate(), date2.getDate()); - test.equal(compareDate.getMonth(), date2.getMonth()); - test.equal(compareDate.getHours(), date2.getHours()); - // Let's close the db - test.done(); - }); - }); - }, 2000); - }); - }); -} - -/** - * Show the usage of the Objectid createFromTime function - * - * @_class objectid - * @_function ObjectID.createFromTime - * @ignore - */ -exports.shouldCorrectlyTransformObjectIDToAndFromHexString = function(test) { - var objectId = ObjectID.createFromTime(1); - test.equal("000000010000000000000000", objectId.toHexString()); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/raw_test.js b/test/raw_test.js deleted file mode 100644 index 30164a18a98..00000000000 --- a/test/raw_test.js +++ /dev/null @@ -1,397 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - ObjectID = require('../lib/mongodb/bson/objectid').ObjectID, - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCorrectlySaveDocumentsAndReturnAsRaw = function(test) { - client.createCollection('shouldCorrectlySaveDocumentsAndReturnAsRaw', function(err, collection) { - // Insert some documents - collection.insert([{a:1}, {b:2000}, {c:2.3}], {safe:true}, function(err, result) { - // You have to pass at least query + fields before passing options - collection.find({}, null, {raw:true}).toArray(function(err, items) { - var objects = []; - for(var i = 0; i < items.length; i++) { - test.ok(items[i] instanceof Buffer); - objects.push(client.bson.deserialize(items[i])); - } - - test.equal(1, objects[0].a); - test.equal(2000, objects[1].b); - test.equal(2.3, objects[2].c); - - // Execute findOne - collection.findOne({a:1}, {raw:true}, function(err, item) { - test.ok(item instanceof Buffer); - var object = client.bson.deserialize(item); - test.equal(1, object.a) - test.done(); - }) - }) - }) - }); -} - -exports.shouldCorrectlyRemoveDocumentAndReturnRaw = function(test) { - client.createCollection('shouldCorrectlyRemoveDocumentAndReturnRaw', function(err, collection) { - // Insert some documents - collection.insert([{a:1}, {b:2000}, {c:2.3}], {safe:true}, function(err, result) { - // Let's create a raw delete command - var queryObject = {b:2000}; - // Create raw bson buffer - var rawQueryObject = new Buffer(client.bson.calculateObjectSize(queryObject)); - client.bson.serializeWithBufferAndIndex(queryObject, false, rawQueryObject, 0); - - // Update the document and return the raw new document - collection.remove(rawQueryObject, {safe:true}, function(err, numberOfDeleted) { - test.equal(1, numberOfDeleted); - - collection.findOne({b:2000}, function(err, item) { - test.equal(null, item) - test.done(); - }); - }); - }); - }); -} - -exports.shouldCorrectlyUpdateDocumentAndReturnRaw = function(test) { - client.createCollection('shouldCorrectlyUpdateDocumentAndReturnRaw', function(err, collection) { - // Insert some documents - collection.insert([{a:1}, {b:2000}, {c:2.3}], {safe:true}, function(err, result) { - // Let's create a raw delete command - var selectorObject = {b:2000}; - // Create raw bson buffer - var rawSelectorObject = new Buffer(client.bson.calculateObjectSize(selectorObject)); - client.bson.serializeWithBufferAndIndex(selectorObject, false, rawSelectorObject, 0); - // Let's create a raw delete command - var updateObject = {"$set":{c:2}}; - // Create raw bson buffer - var rawUpdateObject = new Buffer(client.bson.calculateObjectSize(updateObject)); - client.bson.serializeWithBufferAndIndex(updateObject, false, rawUpdateObject, 0); - // Update the document and return the raw new document - collection.update(rawSelectorObject, rawUpdateObject, {safe:true}, function(err, numberOfUpdated) { - test.equal(1, numberOfUpdated); - - // Query the document - collection.find({}, {}, {raw:true}).toArray(function(err, items) { - var objects = []; - for(var i = 0; i < items.length; i++) { - test.ok(items[i] instanceof Buffer); - objects.push(client.bson.deserialize(items[i])); - } - - test.equal(1, objects[0].a); - test.equal(2.3, objects[1].c); - test.equal(2000, objects[2].b); - test.equal(2, objects[2].c); - test.done(); - }) - }); - }); - }); -} - -exports.shouldCorreclyInsertRawDocumentAndRetrieveThem = function(test) { - client.createCollection('shouldCorreclyInsertRawDocumentAndRetrieveThem', function(err, collection) { - // Create serialized insert objects - var id = new ObjectID(); - var inputObjects = [{_id:id}, {a:1}, {b:2}, {c:4}] - var serializedObjects = []; - - // Serialize all object - for(var i = 0; i < inputObjects.length; i++) { - // Create raw bson buffer - var rawObject = new Buffer(client.bson.calculateObjectSize(inputObjects[i])); - client.bson.serializeWithBufferAndIndex(inputObjects[i], false, rawObject, 0); - serializedObjects.push(rawObject); - } - - // Insert all raw objects - collection.insert(serializedObjects, {safe:true}, function(err, result) { - test.equal(null, err); - - // Query the document - collection.find({}, {}, {raw:true}).toArray(function(err, items) { - var objects = []; - for(var i = 0; i < items.length; i++) { - test.ok(items[i] instanceof Buffer); - objects.push(client.bson.deserialize(items[i])); - } - - test.equal(id.toHexString(), objects[0]._id.toHexString()); - test.equal(1, objects[1].a); - test.equal(2, objects[2].b); - test.equal(4, objects[3].c); - test.done(); - }) - }); - }); -} - -exports.shouldCorrectlyPeformQueryUsingRaw = function(test) { - client.createCollection('shouldCorrectlyPeformQueryUsingRaw', function(err, collection) { - collection.insert([{a:1}, {b:2}, {b:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Let's create a raw query object - var queryObject = {b:3}; - // Create raw bson buffer - var rawQueryObject = new Buffer(client.bson.calculateObjectSize(queryObject)); - client.bson.serializeWithBufferAndIndex(queryObject, false, rawQueryObject, 0); - - // Let's create a raw fields object - var fieldsObject = {}; - // Create raw bson buffer - var rawFieldsObject = new Buffer(client.bson.calculateObjectSize(fieldsObject)); - client.bson.serializeWithBufferAndIndex(fieldsObject, false, rawFieldsObject, 0); - - collection.find(rawQueryObject, rawFieldsObject, {raw:true}).toArray(function(err, items) { - test.equal(1, items.length); - test.ok(items[0] instanceof Buffer); - if(items[0] == null) console.dir(items) - var object = client.bson.deserialize(items[0]); - test.equal(3, object.b) - - collection.findOne(rawQueryObject, rawFieldsObject, {raw:true}, function(err, item) { - test.equal(null, err); - test.ok(item != null); - var object = client.bson.deserialize(item); - test.equal(3, object.b) - test.done(); - }); - }); - }) - }); -} - -exports.shouldCorrectlyThrowErrorsWhenIllegalySizedMessages = function(test) { - client.createCollection('shouldCorrectlyThrowErrorsWhenIllegalySizedMessages', function(err, collection) { - var illegalBuffer = new Buffer(20); - try { - collection.insert(illegalBuffer, {safe:true}, function(err, result) {}); - } catch (err) { - test.ok(err.toString().indexOf("insert") != -1); - } - - try { - collection.update(illegalBuffer, {}, function(){}) - } catch(err) { - test.ok(err.toString().indexOf("update spec") != -1); - } - - try { - collection.update({}, illegalBuffer, function(){}) - } catch(err) { - test.ok(err.toString().indexOf("update document") != -1); - } - - try { - collection.remove(illegalBuffer, function(){}) - } catch(err) { - test.ok(err.toString().indexOf("delete") != -1); - } - - try { - collection.find(illegalBuffer).toArray(function() {}) - } catch(err) { - test.ok(err.toString().indexOf("query selector") != -1); - } - - try { - collection.find({}, illegalBuffer).toArray(function() {}) - } catch(err) { - test.ok(err.toString().indexOf("query fields") != -1); - } - - try { - collection.findOne(illegalBuffer, function() {}) - } catch(err) { - test.ok(err.toString().indexOf("query selector") != -1); - } - - try { - collection.findOne({}, illegalBuffer, function() {}) - } catch(err) { - test.ok(err.toString().indexOf("query fields") != -1); - test.done(); - } - }); -} - -exports.shouldCorrectlyPeformQueryUsingRawSettingRawAtCollectionLevel = function(test) { - client.createCollection('shouldCorrectlyPeformQueryUsingRawSettingRawAtCollectionLevel', function(err, collection) { - collection.insert([{a:1}, {b:2}, {b:3}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Let's create a raw query object - var queryObject = {b:3}; - // Create raw bson buffer - var rawQueryObject = new Buffer(client.bson.calculateObjectSize(queryObject)); - client.bson.serializeWithBufferAndIndex(queryObject, false, rawQueryObject, 0); - - // Let's create a raw fields object - var fieldsObject = {}; - // Create raw bson buffer - var rawFieldsObject = new Buffer(client.bson.calculateObjectSize(fieldsObject)); - client.bson.serializeWithBufferAndIndex(fieldsObject, false, rawFieldsObject, 0); - - client.collection('shouldCorrectlyPeformQueryUsingRaw', {raw:true}, function(err, collection) { - collection.find(rawQueryObject, rawFieldsObject).toArray(function(err, items) { - test.equal(1, items.length); - test.ok(items[0] instanceof Buffer); - var object = client.bson.deserialize(items[0]); - test.equal(3, object.b) - - collection.findOne(rawQueryObject, rawFieldsObject, {raw:true}, function(err, item) { - test.equal(null, err); - test.ok(item != null); - var object = client.bson.deserialize(item); - test.equal(3, object.b) - test.done(); - }); - }); - }); - }) - }); -} - -exports.shouldCorreclyInsertRawDocumentAndRetrieveThemSettingRawAtCollectionLevel = function(test) { - client.createCollection('shouldCorreclyInsertRawDocumentAndRetrieveThemSettingRawAtCollectionLevel', {raw:true}, function(err, collection) { - // Create serialized insert objects - var id = new ObjectID(); - var inputObjects = [{_id:id}, {a:1}, {b:2}, {c:4}] - var serializedObjects = []; - - // Serialize all object - for(var i = 0; i < inputObjects.length; i++) { - // Create raw bson buffer - var rawObject = new Buffer(client.bson.calculateObjectSize(inputObjects[i])); - client.bson.serializeWithBufferAndIndex(inputObjects[i], false, rawObject, 0); - serializedObjects.push(rawObject); - } - - // Insert all raw objects - collection.insert(serializedObjects, {safe:true}, function(err, result) { - test.equal(null, err); - - // Query the document - collection.find({}, {}).toArray(function(err, items) { - var objects = []; - for(var i = 0; i < items.length; i++) { - test.ok(items[i] instanceof Buffer); - objects.push(client.bson.deserialize(items[i])); - } - - test.equal(id.toHexString(), objects[0]._id.toHexString()); - test.equal(1, objects[1].a); - test.equal(2, objects[2].b); - test.equal(4, objects[3].c); - test.done(); - }) - }); - }); -} - -exports.shouldCorrectlyUpdateDocumentAndReturnRawSettingRawAtCollectionLevel = function(test) { - client.createCollection('shouldCorrectlyUpdateDocumentAndReturnRawSettingRawAtCollectionLevel', {raw:true}, function(err, collection) { - // Insert some documents - collection.insert([{a:1}, {b:2000}, {c:2.3}], {safe:true}, function(err, result) { - // Let's create a raw delete command - var selectorObject = {b:2000}; - // Create raw bson buffer - var rawSelectorObject = new Buffer(client.bson.calculateObjectSize(selectorObject)); - client.bson.serializeWithBufferAndIndex(selectorObject, false, rawSelectorObject, 0); - // Let's create a raw delete command - var updateObject = {"$set":{c:2}}; - // Create raw bson buffer - var rawUpdateObject = new Buffer(client.bson.calculateObjectSize(updateObject)); - client.bson.serializeWithBufferAndIndex(updateObject, false, rawUpdateObject, 0); - // Update the document and return the raw new document - collection.update(rawSelectorObject, rawUpdateObject, {safe:true}, function(err, numberOfUpdated) { - test.equal(1, numberOfUpdated); - - // Query the document - collection.find({}, {}).toArray(function(err, items) { - var objects = []; - for(var i = 0; i < items.length; i++) { - test.ok(items[i] instanceof Buffer); - objects.push(client.bson.deserialize(items[i])); - } - - test.equal(1, objects[0].a); - test.equal(2.3, objects[1].c); - test.equal(2000, objects[2].b); - test.equal(2, objects[2].c); - test.done(); - }) - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/reaper_test.js b/test/reaper_test.js deleted file mode 100644 index 3bf407476f5..00000000000 --- a/test/reaper_test.js +++ /dev/null @@ -1,88 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCorrectlySaveUnicodeContainingDocument = function(test) { - var reaperClient = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, ssl:useSSL}), {reaper:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - reaperClient.open(function(err, reaperClient) { - reaperClient._lastReaperTimestamp = (new Date().getTime() - 1000000); - var con = reaperClient.serverConfig.checkoutReader(); - // Prime the reaper with a bogus call - reaperClient._callBackStore._notReplied["3"] = {start: (new Date().getTime() - 50000), 'raw': false, chained:null, connection:con}; - reaperClient._callBackStore.once("3", function(err, result) { - reaperClient.close(); - test.done(); - }) - - reaperClient.collection("test", {safe:true}, function(err, col) { - // Does not matter - }); - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/regexp_test.js b/test/regexp_test.js deleted file mode 100644 index a3303c4d3d5..00000000000 --- a/test/regexp_test.js +++ /dev/null @@ -1,126 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCorrectlyInsertSimpleRegExpDocument = function(test) { - var regexp = /foobar/i; - - client.createCollection('test_regex', function(err, collection) { - collection.insert({'b':regexp}, {safe:true}, function(err, ids) { - collection.find({}, {'fields': ['b']}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(("" + regexp), ("" + items[0].b)); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -exports.shouldCorrectlyInsertSimpleUTF8Regexp = function(test) { - var regexp = /foobaré/; - - client.createCollection('test_utf8_regex', function(err, collection) { - collection.insert({'b':regexp}, {safe:true}, function(err, ids) { - collection.find({}, {'fields': ['b']}, function(err, cursor) { - cursor.toArray(function(err, items) { - test.equal(("" + regexp), ("" + items[0].b)); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -exports.shouldCorrectlyFindDocumentsByRegExp = function(test) { - // Serialized regexes contain extra trailing chars. Sometimes these trailing chars contain / which makes - // the original regex invalid, and leads to segmentation fault. - client.createCollection('test_regex_serialization', function(err, collection) { - collection.insert({keywords: ["test", "segmentation", "fault", "regex", "serialization", "native"]}, {safe:true}, function(err, r) { - - var count = 20, - run = function(i) { - // search by regex - collection.findOne({keywords: {$all: [/ser/, /test/, /seg/, /fault/, /nat/]}}, function(err, item) { - test.equal(6, item.keywords.length); - if (i === 0) { - test.done() - } - }); - }; - // loop a few times to catch the / in trailing chars case - while (count--) { - run(count); - } - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/remove_test.js b/test/remove_test.js deleted file mode 100644 index bc5d9f853d7..00000000000 --- a/test/remove_test.js +++ /dev/null @@ -1,171 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -/** - * An example removing all documents in a collection not using safe mode - * - * @_class collection - * @_function remove - * @ignore - */ -exports.shouldRemoveAllDocumentsNoSafe = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch a collection to insert document into - db.collection("remove_all_documents_no_safe", function(err, collection) { - - // Insert a bunch of documents - collection.insert([{a:1}, {b:2}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Remove all the document - collection.remove(); - - // Wait for a second to ensure command went through - setTimeout(function() { - - // Fetch all results - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(0, items.length); - db.close(); - test.done(); - }); - }, 1000); - }); - }) - }); -} - -/** - * An example removing a subset of documents using safe mode to ensure removal of documents - * - * @_class collection - * @_function remove - * @ignore - */ -exports.shouldRemoveSubsetOfDocumentsSafeMode = function(test) { - var db = new Db('integration_tests', new Server("127.0.0.1", 27017, - {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser}); - - // Establish connection to db - db.open(function(err, db) { - - // Fetch a collection to insert document into - db.collection("remove_subset_of_documents_safe", function(err, collection) { - - // Insert a bunch of documents - collection.insert([{a:1}, {b:2}], {safe:true}, function(err, result) { - test.equal(null, err); - - // Remove all the document - collection.remove({a:1}, {safe:true}, function(err, numberOfRemovedDocs) { - test.equal(null, err); - test.equal(1, numberOfRemovedDocs); - db.close(); - test.done(); - }); - }); - }) - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyClearOutCollection = function(test) { - client.createCollection('test_clear', function(err, r) { - client.collection('test_clear', function(err, collection) { - collection.insert({i:1}, {safe:true}, function(err, ids) { - collection.insert({i:2}, {safe:true}, function(err, ids) { - collection.count(function(err, count) { - test.equal(2, count); - // Clear the collection - collection.remove({}, {safe:true}, function(err, result) { - test.equal(2, result); - - collection.count(function(err, count) { - test.equal(0, count); - // Let's close the db - test.done(); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/replicaset/connect_test.js b/test/replicaset/connect_test.js deleted file mode 100644 index e19d0a7c12f..00000000000 --- a/test/replicaset/connect_test.js +++ /dev/null @@ -1,518 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server; - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - - // Open the db - db.open(function(err, p_db) { - db.close(); - - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 3000); - } else { - return callback(null); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -/** - * @ignore - */ -exports.shouldThrowErrorDueToSharedConnectionUsage = function(test) { - var replSet = new ReplSetServers([ - new Server('localhost', 28390, { auto_reconnect: true } ), - new Server('localhost', 28391, { auto_reconnect: true } ), - new Server('localhost', 28392, { auto_reconnect: true } ) - ] - ); - - try { - var db = new Db(MONGODB, replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - var db1 = new Db(MONGODB, replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - } catch(err) { - test.done(); - } -} - -/** - * @ignore - */ -exports.shouldCorrectlyHandleErrorWhenNoServerUpInReplicaset = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server('localhost', 28390, { auto_reconnect: true } ), - new Server('localhost', 28391, { auto_reconnect: true } ), - new Server('localhost', 28392, { auto_reconnect: true } ) - ] - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - test.ok(err != null); - test.done(); - }); -} - -/** - * Simple replicaset connection setup, requires a running replicaset on the correct ports - * - * @_class db - * @_function open - */ -exports.shouldCorrectlyConnectWithDefaultReplicasetNoOption = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server('localhost', 30000, { auto_reconnect: true } ), - new Server('localhost', 30001, { auto_reconnect: true } ), - new Server('localhost', 30002, { auto_reconnect: true } ) - ] - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - test.equal(null, err); - test.done(); - p_db.close(); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyConnectWithDefaultReplicasetNoOption = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ] - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - test.equal(null, err); - test.done(); - p_db.close(); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyConnectWithDefaultReplicaset = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - test.equal(null, err); - test.done(); - p_db.close(); - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyConnectWithDefaultReplicasetAndSocketOptionsSet = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {socketOptions:{keepAlive:100}} - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - test.equal(null, err); - test.equal(100, db.serverConfig.checkoutWriter().socketOptions.keepAlive) - test.done(); - p_db.close(); - }) -} - -/** - * @ignore - */ -exports.shouldEmitCloseNoCallback = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], {} - ); - - new Db('integration_test_', replSet).open(function(err, db) { - test.equal(null, err); - var dbCloseCount = 0, serverCloseCount = 0; - db.on('close', function() { ++dbCloseCount; }); - db.close(); - - setTimeout(function() { - test.equal(dbCloseCount, 1); - test.done(); - }, 2000); - }) -} - -/** - * @ignore - */ -exports.shouldEmitCloseWithCallback = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], {} - ); - - new Db('integration_test_', replSet).open(function(err, db) { - test.equal(null, err); - var dbCloseCount = 0; - db.on('close', function() { ++dbCloseCount; }); - - db.close(function() { - // Let all events fire. - process.nextTick(function() { - test.equal(dbCloseCount, 0); - test.done(); - }); - }); - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyPassErrorWhenWrongReplicaSet = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name + "-wrong"} - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - test.notEqual(null, err); - test.done(); - }) -} - -/** - * @ignore - */ -exports.shouldConnectWithPrimarySteppedDown = function(test) { - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Step down primary server - RS.stepDownPrimary(function(err, result) { - // Wait for new primary to pop up - ensureConnection(test, retries, function(err, p_db) { - - new Db('integration_test_', replSet).open(function(err, p_db) { - test.ok(err == null); - test.equal(true, p_db.serverConfig.isConnected()); - - p_db.close(); - test.done(); - }) - }); - }); -} - -/** - * @ignore - */ -exports.shouldConnectWithThirdNodeKilled = function(test) { - RS.getNodeFromPort(RS.ports[2], function(err, node) { - if(err != null) debug("shouldConnectWithThirdNodeKilled :: " + inspect(err)); - - RS.kill(node, function(err, result) { - if(err != null) debug("shouldConnectWithThirdNodeKilled :: " + inspect(err)); - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Wait for new primary to pop up - ensureConnection(test, retries, function(err, p_db) { - new Db('integration_test_', replSet).open(function(err, p_db) { - test.ok(err == null); - test.equal(true, p_db.serverConfig.isConnected()); - - p_db.close(); - test.done(); - }) - }); - }); - }); -} - -/** - * @ignore - */ -exports.shouldConnectWithSecondaryNodeKilled = function(test) { - RS.killSecondary(function(node) { - - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= caught error") - console.dir(err) - if(err.stack != null) console.log(err.stack) - test.done(); - }) - - db.open(function(err, p_db) { - test.ok(err == null); - test.equal(true, p_db.serverConfig.isConnected()); - - // Close and cleanup - p_db.close(); - test.done(); - }) - }); -} - -/** - * @ignore - */ -exports.shouldConnectWithPrimaryNodeKilled = function(test) { - RS.killPrimary(function(node) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var db = new Db('integration_test_', replSet); - ensureConnection(test, retries, function(err, p_db) { - if(err != null && err.stack != null) console.log(err.stack) - test.done(); - }); - }); -} - -/** - * @ignore - */ -exports.shouldCorrectlyBeAbleToUsePortAccessors = function(test) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - if(err != null) debug("shouldCorrectlyBeAbleToUsePortAccessors :: " + inspect(err)); - test.equal(replSet.host, p_db.serverConfig.primary.host); - test.equal(replSet.port, p_db.serverConfig.primary.port); - - p_db.close(); - test.done(); - }) -} - -/** - * @ignore - */ -exports.shouldCorrectlyConnect = function(test) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Replica configuration - var replSet2 = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - var db = new Db('integration_test_', replSet ); - db.open(function(err, p_db) { - if(err != null) debug("shouldCorrectlyConnect :: " + inspect(err)); - test.equal(true, p_db.serverConfig.isConnected()); - - // Test primary - RS.primary(function(err, primary) { - if(err != null) debug("shouldCorrectlyConnect :: " + inspect(err)); - - test.notEqual(null, primary); - test.equal(primary, p_db.serverConfig.primary.host + ":" + p_db.serverConfig.primary.port); - - // Perform tests - RS.secondaries(function(err, items) { - if(err != null) debug("shouldCorrectlyConnect :: " + inspect(err)); - - // Test if we have the right secondaries - test.deepEqual(items.sort(), p_db.serverConfig.allSecondaries.map(function(item) { - return item.host + ":" + item.port; - }).sort()); - - // Test if we have the right arbiters - RS.arbiters(function(err, items) { - if(err != null) debug("shouldCorrectlyConnect :: " + inspect(err)); - - test.deepEqual(items.sort(), p_db.serverConfig.arbiters.map(function(item) { - return item.host + ":" + item.port; - }).sort()); - // Force new instance - var db2 = new Db('integration_test_', replSet2 ); - db2.open(function(err, p_db2) { - if(err != null) debug("shouldCorrectlyConnect :: " + inspect(err)); - - test.equal(true, p_db2.serverConfig.isConnected()); - // Close top instance - db.close(); - db2.close(); - test.done(); - }); - }); - }); - }) - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; diff --git a/test/replicaset/count_test.js b/test/replicaset/count_test.js deleted file mode 100644 index 5e9221e8a98..00000000000 --- a/test/replicaset/count_test.js +++ /dev/null @@ -1,208 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server; - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - - // Open the db - db.open(function(err, p_db) { - db.close(); - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -exports.shouldRetrieveCorrectCountAfterInsertionReconnect = function(test) { - // debug("=========================================== shouldRetrieveCorrectCountAfterInsertionReconnect") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - // Drop collection on replicaset - p_db.dropCollection('testsets', function(err, r) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - // Recreate collection on replicaset - p_db.createCollection('testsets', function(err, collection) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - // Insert a dummy document - collection.insert({a:20}, {safe: {w:2, wtimeout: 10000}}, function(err, r) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - // Execute a count - collection.count(function(err, c) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - test.equal(1, c); - // Close starting connection - p_db.close(); - - // Ensure replication happened in time - setTimeout(function() { - // Kill the primary - RS.killPrimary(function(node) { - - // debug("=========================================== shouldRetrieveCorrectCountAfterInsertionReconnect :: 0") - // Ensure valid connection - // Do inserts - // ensureConnection(test, retries, function(err, p_db) { - // // debug("=========================================== shouldRetrieveCorrectCountAfterInsertionReconnect :: 1") - // if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - // test.ok(err == null); - - p_db.collection('testsets', function(err, collection) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - collection.insert({a:30}, {safe:true}, function(err, r) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - collection.insert({a:40}, {safe:true}, function(err, r) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - // Execute count - collection.count(function(err, c) { - if(err != null) debug("shouldRetrieveCorrectCountAfterInsertionReconnect :: " + inspect(err)); - - test.equal(3, c); - - p_db.close(); - test.done(); - }); - }); - }); - }); - // }); - }); - }, 2000); - }) - }) - }); - }); - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; - - - - - - - - - - - - - - - - diff --git a/test/replicaset/insert_test.js b/test/replicaset/insert_test.js deleted file mode 100644 index 268c04a0a42..00000000000 --- a/test/replicaset/insert_test.js +++ /dev/null @@ -1,484 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // // Print any errors - // db.on("error", function(err) { - // console.log("============================= ensureConnection caught error") - // console.dir(err) - // if(err != null && err.stack != null) console.log(err.stack) - // db.close(); - // }) - - // Open the db - db.open(function(err, p_db) { - // Close connections - db.close(); - // Process result - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -exports.shouldCorrectlyWaitForReplicationToServersOnInserts = function(test) { - // debug("=========================================== shouldWorkCorrectlyWithInserts") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Insert some data - var db = new Db('integration_test_', replSet, {numberOfRetries:20, retryMiliSeconds:5000}); - db.open(function(err, p_db) { - // Check if we got an error - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('shouldCorrectlyWaitForReplicationToServersOnInserts', function(err, r) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('shouldCorrectlyWaitForReplicationToServersOnInserts', function(err, collection) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - // Insert a dummy document - collection.insert({a:20}, {safe: {w:2, wtimeout: 10000}}, function(err, r) { - test.equal(null, err); - test.done(); - p_db.close(); - }); - }); - }); - }); -} - -exports.shouldCorrectlyThrowTimeoutForReplicationToServersOnInserts = function(test) { - // debug("=========================================== shouldWorkCorrectlyWithInserts") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Insert some data - var db = new Db('integration_test_', replSet, {numberOfRetries:20, retryMiliSeconds:5000}); - db.open(function(err, p_db) { - // Check if we got an error - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('shouldCorrectlyThrowTimeoutForReplicationToServersOnInserts', function(err, r) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('shouldCorrectlyThrowTimeoutForReplicationToServersOnInserts', function(err, collection) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - // Insert a dummy document - collection.insert({a:20}, {safe: {w:7, wtimeout: 10000}}, function(err, r) { - test.equal('timeout', err.err); - test.equal(true, err.wtimeout); - test.done(); - p_db.close(); - }); - }); - }); - }); -} - -exports.shouldCorrectlyExecuteSafeFindAndModify = function(test) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Insert some data - var db = new Db('integration_test_', replSet, {numberOfRetries:20, retryMiliSeconds:5000}); - db.open(function(err, p_db) { - // Check if we got an error - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('shouldCorrectlyExecuteSafeFindAndModify', function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('shouldCorrectlyExecuteSafeFindAndModify', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Insert a dummy document - collection.insert({a:20}, {safe: {w:2, wtimeout: 10000}}, function(err, r) { - // Execute a safe insert with replication to two servers - collection.findAndModify({'a':20}, [['a', 1]], {'$set':{'b':3}}, {new:true, safe: {w:2, wtimeout: 10000}}, function(err, result) { - test.equal(20, result.a); - test.equal(3, result.b); - test.done(); - p_db.close(); - }) - }); - }); - }); - }); -} - -exports.shouldCorrectlyInsertAfterPrimaryComesBackUp = function(test) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - // {rs_name:RS.name, socketOptions:{timeout:30000}} - {rs_name:RS.name} - ); - - - // Insert some data - var db = new Db('integration_test_', replSet, {numberOfRetries:20, retryMiliSeconds:5000}); - // Open db - db.open(function(err, p_db) { - // Check if we got an error - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('shouldCorrectlyInsertAfterPrimaryComesBackUp', function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('shouldCorrectlyInsertAfterPrimaryComesBackUp', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Insert a dummy document - collection.insert({a:20}, {safe: {w:'majority', wtimeout: 10000}}, function(err, r) { - // Kill the primary - RS.killPrimary(2, {killNodeWaitTime:0}, function(node) { - // Attempt insert (should fail) - collection.insert({a:30}, {safe: {w:2, wtimeout: 10000}}, function(err, r) { - test.ok(err != null) - - if(err != null) { - collection.insert({a:40}, {safe: {w:2, wtimeout: 10000}}, function(err, r) { - - // Peform a count - collection.count(function(err, count) { - - test.equal(2, count); - p_db.close(); - test.done(); - }); - }); - } else { - p_db.close(); - test.ok(false) - test.done(); - } - }); - }); - }); - }); - }); - }); -} - -exports.shouldCorrectlyQueryAfterPrimaryComesBackUp = function(test) { - // debug("=========================================== shouldWorkCorrectlyWithInserts") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Insert some data - var db = new Db('integration_test_', replSet, {numberOfRetries:20, retryMiliSeconds:5000}); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - // Open db - db.open(function(err, p_db) { - // Check if we got an error - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('shouldCorrectlyQueryAfterPrimaryComesBackUp', function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('shouldCorrectlyQueryAfterPrimaryComesBackUp', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Insert a dummy document - collection.insert({a:20}, {safe: {w:'majority', wtimeout: 10000}}, function(err, r) { - // Kill the primary - RS.killPrimary(2, {killNodeWaitTime:0}, function(node) { - // Ok let's execute same query a couple of times - collection.find({}).toArray(function(err, items) { - // console.log("============================================ CALLED :: 0") - test.ok(err != null); - // console.dir(err) - - collection.find({}).toArray(function(err, items) { - // console.log("============================================ CALLED :: 1") - // console.dir(err) - // console.dir(items) - - test.ok(err == null); - test.equal(1, items.length); - - collection.find({}).toArray(function(err, items) { - test.ok(err == null); - test.equal(1, items.length); - p_db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); -} - -exports.shouldWorkCorrectlyWithInserts = function(test) { - // debug("=========================================== shouldWorkCorrectlyWithInserts") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - // Insert some data - var db = new Db('integration_test_', replSet, {numberOfRetries:20, retryMiliSeconds:5000}); - db.open(function(err, p_db) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Drop collection on replicaset - p_db.dropCollection('shouldWorkCorrectlyWithInserts', function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('shouldWorkCorrectlyWithInserts', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Insert a dummy document - collection.insert({a:20}, {safe: {w:'majority', wtimeout: 10000}}, function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Execute a count - collection.count(function(err, c) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - test.equal(1, c); - - // Kill the primary - RS.killPrimary(function(node) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - test.ok(err == null); - - // p_db.collection('shouldWorkCorrectlyWithInserts', {safe:true}, function(err, collection) { - p_db.collection('shouldWorkCorrectlyWithInserts', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Execute a set of inserts - Step( - function inserts() { - var group = this.group(); - collection.save({a:30}, {safe:{w:2, wtimeout: 10000}}, group()); - collection.save({a:40}, {safe:{w:2, wtimeout: 10000}}, group()); - collection.save({a:50}, {safe:{w:2, wtimeout: 10000}}, group()); - collection.save({a:60}, {safe:{w:2, wtimeout: 10000}}, group()); - collection.save({a:70}, {safe:{w:2, wtimeout: 10000}}, group()); - }, - - function finishUp(err, values) { - if(err != null) console.log(err.stack) - // Restart the old master and wait for the sync to happen - RS.restartKilledNodes(function(err, result) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Contains the results - var results = []; - - // Just wait for the results - // setTimeout(function() { - // Ensure the connection - // ensureConnection(test, retries, function(err, p_db) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Get the collection - p_db.collection('shouldWorkCorrectlyWithInserts', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - collection.find().each(function(err, item) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - if(item == null) { - // Ensure we have the correct values - test.equal(6, results.length); - [20, 30, 40, 50, 60, 70].forEach(function(a) { - test.equal(1, results.filter(function(element) { - return element.a == a; - }).length); - }); - - // Run second check - collection.save({a:80}, {safe:true}, function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - collection.find().toArray(function(err, items) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Ensure we have the correct values - test.equal(7, items.length); - - // Sort items by a - items = items.sort(function(a,b) { return a.a > b.a}); - // Test all items - test.equal(20, items[0].a); - test.equal(30, items[1].a); - test.equal(40, items[2].a); - test.equal(50, items[3].a); - test.equal(60, items[4].a); - test.equal(70, items[5].a); - test.equal(80, items[6].a); - - p_db.close(); - test.done(); - }); - }); - } else { - results.push(item); - } - }); - }); - // }); - // }, 5000); - }) - } - ); - }); - }); - }) - }) - }); - }); - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; - - - - - - - - - - - - - - - diff --git a/test/replicaset/map_reduce_test.js b/test/replicaset/map_reduce_test.js deleted file mode 100644 index f7b04c3e966..00000000000 --- a/test/replicaset/map_reduce_test.js +++ /dev/null @@ -1,251 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Open the db - db.open(function(err, p_db) { - // Close connections - db.close(); - // Process result - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:0, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -exports['Should Correctly group using replicaset'] = function(test) { - var self = this; - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Insert some data - var db = new Db('integration_test_', replSet, {slave_ok:true}); - db.open(function(err, p_db) { - if(err != null) debug("shouldGroup :: " + inspect(err)); - - p_db.createCollection("testgroup_replicaset", {safe:{w:2, wtimeout:10000}}, function(err, collection) { - if(err != null) debug("shoulGroup :: " + inspect(err)); - - collection.insert([{key:1,x:10}, {key:2,x:30}, {key:1,x:20}, {key:3,x:20}], {safe:{w:2, wtimeout:10000}}, function(err, result) { - // Ensure replication happened in time - setTimeout(function() { - // Kill the primary - RS.killPrimary(function(node) { - // Do a collection find - collection.group(['key'], {}, {sum:0}, function reduce(record, memo){ - memo.sum += record.x; - }, true, function(err, items){ - if(err != null) debug("shouldGroup :: " + inspect(err)); - test.equal(null, err); - test.equal(3, items.length); - - p_db.close(); - test.done(); - }) - }); - }, 2000); - }) - }); - }) -} - -exports.shouldPerformMapReduceFunctionInline = function(test) { - var self = this; - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Establish connection to db - var db = new Db('integration_test_', replSet, {slave_ok:true}); - db.open(function(err, db) { - - // Parse version of server if available - db.admin().serverInfo(function(err, result){ - - // Only run if the MongoDB version is higher than 1.7.6 - if(parseInt((result.version.replace(/\./g, ''))) >= 176) { - - // Create a test collection - db.createCollection('test_map_reduce_functions_inline_map_reduce', {safe:{w:2, wtimeout:10000}}, function(err, collection) { - // Insert some test documents - collection.insert([{'user_id':1}, {'user_id':2}], {safe:{w:2, wtimeout:10000}}, function(err, r) { - - // Ensure replication happened in time - setTimeout(function() { - // Map function - var map = function() { emit(this.user_id, 1); }; - // Reduce function - var reduce = function(k,vals) { return 1; }; - - // Execute map reduce and return results inline - collection.mapReduce(map, reduce, {out : {inline: 1}}, function(err, results) { - test.equal(2, results.length); - - db.close(); - test.done(); - }); - }, 2000); - }); - }); - } else { - test.done(); - } - }); - }); -} - -exports.shouldFailToDoMapReduceToOutCollection = function(test) { - var self = this; - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Establish connection to db - var db = new Db('integration_test_', replSet, {slave_ok:true}); - db.open(function(err, db) { - - // Parse version of server if available - db.admin().serverInfo(function(err, result){ - - // Only run if the MongoDB version is higher than 1.7.6 - if(parseInt((result.version.replace(/\./g, ''))) >= 176) { - - // Create a test collection - db.createCollection('test_map_reduce_functions_notInline_map_reduce', {safe:{w:2, wtimeout:10000}}, function(err, collection) { - - // Insert some test documents - collection.insert([{'user_id':1}, {'user_id':2}], {safe:{w:2, wtimeout:10000}}, function(err, r) { - - // Ensure replication happened in time - setTimeout(function() { - // Map function - var map = function() { emit(this.user_id, 1); }; - // Reduce function - var reduce = function(k,vals) { return 1; }; - - // Execute map reduce and return results inline - collection.mapReduce(map, reduce, {out : {replace:'replacethiscollection'}}, function(err, results) { - test.ok(err != null); - - db.close(); - test.done(); - }); - }, 2000); - }); - }); - } else { - test.done(); - } - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; diff --git a/test/replicaset/query_secondaries_test.js b/test/replicaset/query_secondaries_test.js deleted file mode 100644 index 1f4bd91b08a..00000000000 --- a/test/replicaset/query_secondaries_test.js +++ /dev/null @@ -1,283 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - - // Open the db - db.open(function(err, p_db) { - db.close(); - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -exports.shouldReadPrimary = function(test) { - // debug("=========================================== shouldReadPrimary") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - // Drop collection on replicaset - p_db.dropCollection('testsets', function(err, r) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - test.equal(false, p_db.serverConfig.isReadPrimary()); - test.equal(false, p_db.serverConfig.isPrimary()); - p_db.close(); - test.done(); - }); - }) -} - -exports.shouldCorrectlyTestConnection = function(test) { - // debug("=========================================== shouldCorrectlyTestConnection") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('testsets', function(err, r) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - - test.ok(p_db.serverConfig.primary != null); - test.ok(p_db.serverConfig.read != null); - test.ok(p_db.serverConfig.primary.port != p_db.serverConfig.read.port); - p_db.close(); - test.done(); - }); - }) -} - -exports.shouldCorrectlyQuerySecondaries = function(test) { - // debug("=========================================== shouldCorrectlyQuerySecondaries") - var self = this; - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - - p_db.createCollection("testsets", {safe:{w:2, wtimeout:10000}}, function(err, collection) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - - collection.insert([{a:20}, {a:30}, {a:40}], {safe:{w:2, wtimeout:10000}}, function(err, result) { - // Ensure replication happened in time - setTimeout(function() { - // Kill the primary - RS.killPrimary(function(node) { - // Do a collection find - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(3, items.length); - p_db.close(); - test.done(); - }); - }); - }, 2000); - }) - }); - }) -} - -exports.shouldCorrectlyQuerySecondaries = function(test) { - // debug("=========================================== shouldCorrectlyQuerySecondaries") - var self = this; - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:false} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - - // Ensure the checkoutReader gives us the actual writer object - var reader = replSet.checkoutReader(); - var writer = replSet.checkoutWriter(); - // Ensure the connections are the same - test.equal(reader.socketOptions.host, writer.socketOptions.host); - test.equal(reader.socketOptions.port, writer.socketOptions.port); - // Close connection to Spain - db.close(); - test.done(); - }); -} - -exports.shouldAllowToForceReadWithPrimary = function(test) { - // debug("=========================================== shouldAllowToForceReadWithPrimary") - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - ], - {rs_name:RS.name, read_secondary:true} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - if(err != null) debug("shouldReadPrimary :: " + inspect(err)); - // Create a collection - p_db.createCollection('shouldAllowToForceReadWithPrimary', function(err, collection) { - test.equal(null, err); - // Insert a document - collection.insert({a:1}, {safe:{w:2, wtimeout:10000}}, function(err, result) { - test.equal(null, err); - - // Force read using primary - var cursor = collection.find({}, {read:'primary'}) - // Get documents - cursor.toArray(function(err, items) { - test.equal(1, items.length); - test.equal(1, items[0].a); - p_db.close(); - test.done(); - }) - }); - }) - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; - - - - - - - - - - - - - - - - diff --git a/test/replicaset/read_preference_replicaset_test.js b/test/replicaset/read_preference_replicaset_test.js deleted file mode 100644 index bdf6970b955..00000000000 --- a/test/replicaset/read_preference_replicaset_test.js +++ /dev/null @@ -1,424 +0,0 @@ -// Read Preference behaviour based on Python driver by A. Jesse Jiryu Davis -// https://github.com/mongodb/mongo-python-driver/blob/master/pymongo/__init__.py -// +----------------------+--------------------------------------------------+ -// | Connection type | Read Preference | -// +======================+================+================+================+ -// | |`PRIMARY` |`SECONDARY` |`SECONDARY_ONLY`| -// +----------------------+----------------+----------------+----------------+ -// |Connection to a single|Queries are |Queries are |Same as | -// |host. |allowed if the |allowed if the |`SECONDARY` | -// | |connection is to|connection is to| | -// | |the replica set |the replica set | | -// | |primary. |primary or a | | -// | | |secondary. | | -// +----------------------+----------------+----------------+----------------+ -// |Connection to a |Queries are sent|Queries are |Same as | -// |mongos. |to the primary |distributed |`SECONDARY` | -// | |of a shard. |among shard | | -// | | |secondaries. | | -// | | |Queries are sent| | -// | | |to the primary | | -// | | |if no | | -// | | |secondaries are | | -// | | |available. | | -// | | | | | -// +----------------------+----------------+----------------+----------------+ -// |ReplicaSetConnection |Queries are sent|Queries are |Queries are | -// | |to the primary |distributed |never sent to | -// | |of the replica |among replica |the replica set | -// | |set. |set secondaries.|primary. An | -// | | |Queries are sent|exception is | -// | | |to the primary |raised if no | -// | | |if no |secondary is | -// | | |secondaries are |available. | -// | | |available. | | -// | | | | | -// +----------------------+----------------+----------------+----------------+ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - - // Open the db - db.open(function(err, p_db) { - db.close(); - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -var identifyServers = function(rs, dbname, callback) { - // Total number of servers to query - var numberOfServersToCheck = Object.keys(rs.mongods).length; - - // Arbiters - var arbiters = []; - var secondaries = []; - var primary = null; - - // Let's establish what all servers so we can pick targets for our queries - var keys = Object.keys(rs.mongods); - for(var i = 0; i < keys.length; i++) { - var host = rs.mongods[keys[i]].host; - var port = rs.mongods[keys[i]].port; - - // Connect to the db and query the state - var server = new Server(host, port,{auto_reconnect: true}); - // Create db instance - var db = new Db(dbname, server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, db) { - numberOfServersToCheck = numberOfServersToCheck - 1; - if(db.serverConfig.isMasterDoc.ismaster) { - primary = {host:db.serverConfig.host, port:db.serverConfig.port}; - } else if(db.serverConfig.isMasterDoc.secondary) { - secondaries.push({host:db.serverConfig.host, port:db.serverConfig.port}); - } else if(db.serverConfig.isMasterDoc.arbiterOnly) { - arbiters.push({host:db.serverConfig.host, port:db.serverConfig.port}); - } - - // Close the db - db.close(); - // If we are done perform the callback - if(numberOfServersToCheck <= 0) { - callback(null, {primary:primary, secondaries:secondaries, arbiters:arbiters}); - } - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -// +----------------------+--------------------------------------------------+ -// | Connection type | Read Preference | -// +======================+================+================+================+ -// | |`PRIMARY` |`SECONDARY` |`SECONDARY_ONLY`| -// +----------------------+----------------+----------------+----------------+ -// |ReplicaSetConnection |Queries are sent|Queries are |Queries are | -// | |to the primary |distributed |never sent to | -// | |of the replica |among replica |the replica set | -// | |set. |set secondaries.|primary. An | -// | | |Queries are sent|exception is | -// | | |to the primary |raised if no | -// | | |if no |secondary is | -// | | |secondaries are |available. | -// | | |available. | | -// | | | | | -// +----------------------+----------------+----------------+----------------+ -exports['Connection to replicaset with primary read preference'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, readPreference:Server.READ_PRIMARY} - ); - - // Execute flag - var executedCorrectly = false; - - // Create db instance - var db = new Db('integration_test_', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, p_db) { - // Let's get the primary server and wrap the checkout Method to ensure it's the one called for read - var checkoutWriterMethod = p_db.serverConfig._state.master.checkoutWriter; - // Set up checkoutWriter to catch correct write request - p_db.serverConfig._state.master.checkoutWriter = function() { - executedCorrectly = true; - return checkoutWriterMethod.apply(this); - } - - // Grab the collection - db.collection("read_preference_replicaset_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - // Does not get called or we don't care - test.ok(executedCorrectly); - p_db.close(); - test.done(); - }); - }); - }); -} - -exports['Connection to replicaset with secondary read preference with no secondaries should return primary'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, readPreference:Server.READ_SECONDARY} - ); - - // Create db instance - var db = new Db('integration_test_', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, p_db) { - // Rip out secondaries forcing an attempt to read from the primary - p_db.serverConfig._state.secondaries = {}; - - // Let's get the primary server and wrap the checkout Method to ensure it's the one called for read - var checkoutWriterMethod = p_db.serverConfig._state.master.checkoutWriter; - // Set up checkoutWriter to catch correct write request - p_db.serverConfig._state.master.checkoutWriter = function() { - var r = checkoutWriterMethod.apply(p_db.serverConfig._state.master); - test.equal(servers.primary.host, r.socketOptions.host); - test.equal(servers.primary.port, r.socketOptions.port); - return r; - } - - // Grab the collection - p_db.collection("read_preference_replicaset_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - // Does not get called or we don't care - p_db.close(); - test.done(); - }); - }); - }); - }); -} - -exports['Connection to replicaset with secondary only read preference no secondaries should not return a connection'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, readPreference:Server.READ_SECONDARY_ONLY} - ); - - // Create db instance - var db = new Db('integration_test_', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, p_db) { - // Rip out secondaries forcing an attempt to read from the primary - p_db.serverConfig._state.secondaries = {}; - - // Grab the collection - p_db.collection("read_preference_replicaset_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.ok(err != null); - test.equal("no open connections", err.message); - // Does not get called or we don't care - p_db.close(); - test.done(); - }); - }); - }); - }); -} - -exports['Connection to replicaset with secondary only read preference should return secondary server'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, readPreference:Server.READ_SECONDARY_ONLY} - ); - - // Execute flag - var executedCorrectly = false; - - // Create db instance - var db = new Db('integration_test_', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, p_db) { - // Let's set up all the secondaries - var keys = Object.keys(p_db.serverConfig._state.secondaries); - - // Set up checkoutReaders - for(var i = 0; i < keys.length; i++) { - var checkoutReader = p_db.serverConfig._state.secondaries[keys[i]].checkoutReader; - p_db.serverConfig._state.secondaries[keys[i]].checkoutReader = function() { - executedCorrectly = true; - } - } - - // Grab the collection - p_db.collection("read_preference_replicaset_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - // Does not get called or we don't care - test.ok(executedCorrectly); - p_db.close(); - test.done(); - }); - }); - }); - }); -} - -exports['Connection to replicaset with secondary read preference should return secondary server'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, readPreference:Server.READ_SECONDARY_ONLY} - ); - - // Execute flag - var executedCorrectly = false; - - // Create db instance - var db = new Db('integration_test_', replSet, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, p_db) { - // Let's set up all the secondaries - var keys = Object.keys(p_db.serverConfig._state.secondaries); - - // Set up checkoutReaders - for(var i = 0; i < keys.length; i++) { - var checkoutReader = p_db.serverConfig._state.secondaries[keys[i]].checkoutReader; - p_db.serverConfig._state.secondaries[keys[i]].checkoutReader = function() { - executedCorrectly = true; - return checkoutReader.apply(this); - } - } - - // Grab the collection - p_db.collection("read_preference_replicaset_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - // Does not get called or we don't care - test.ok(executedCorrectly); - p_db.close(); - test.done(); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; - - - - - - - - - - - - - - - diff --git a/test/replicaset/read_preferences_single_test.js b/test/replicaset/read_preferences_single_test.js deleted file mode 100644 index 09f3b7defd4..00000000000 --- a/test/replicaset/read_preferences_single_test.js +++ /dev/null @@ -1,362 +0,0 @@ -// Read Preference behaviour based on Python driver by A. Jesse Jiryu Davis -// https://github.com/mongodb/mongo-python-driver/blob/master/pymongo/__init__.py -// +----------------------+--------------------------------------------------+ -// | Connection type | Read Preference | -// +======================+================+================+================+ -// | |`PRIMARY` |`SECONDARY` |`SECONDARY_ONLY`| -// +----------------------+----------------+----------------+----------------+ -// |Connection to a single|Queries are |Queries are |Same as | -// |host. |allowed if the |allowed if the |`SECONDARY` | -// | |connection is to|connection is to| | -// | |the replica set |the replica set | | -// | |primary. |primary or a | | -// | | |secondary. | | -// +----------------------+----------------+----------------+----------------+ -// |Connection to a |Queries are sent|Queries are |Same as | -// |mongos. |to the primary |distributed |`SECONDARY` | -// | |of a shard. |among shard | | -// | | |secondaries. | | -// | | |Queries are sent| | -// | | |to the primary | | -// | | |if no | | -// | | |secondaries are | | -// | | |available. | | -// | | | | | -// +----------------------+----------------+----------------+----------------+ -// |ReplicaSetConnection |Queries are sent|Queries are |Queries are | -// | |to the primary |distributed |never sent to | -// | |of the replica |among replica |the replica set | -// | |set. |set secondaries.|primary. An | -// | | |Queries are sent|exception is | -// | | |to the primary |raised if no | -// | | |if no |secondary is | -// | | |secondaries are |available. | -// | | |available. | | -// | | | | | -// +----------------------+----------------+----------------+----------------+ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - - // Open the db - db.open(function(err, p_db) { - db.close(); - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -var identifyServers = function(rs, dbname, callback) { - // Total number of servers to query - var numberOfServersToCheck = Object.keys(rs.mongods).length; - - // Arbiters - var arbiters = []; - var secondaries = []; - var primary = null; - - // Let's establish what all servers so we can pick targets for our queries - var keys = Object.keys(rs.mongods); - for(var i = 0; i < keys.length; i++) { - var host = rs.mongods[keys[i]].host; - var port = rs.mongods[keys[i]].port; - - // Connect to the db and query the state - var server = new Server(host, port,{auto_reconnect: true}); - // Create db instance - var db = new Db(dbname, server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - // Connect to the db - db.open(function(err, db) { - numberOfServersToCheck = numberOfServersToCheck - 1; - if(db.serverConfig.isMasterDoc.ismaster) { - primary = {host:db.serverConfig.host, port:db.serverConfig.port}; - } else if(db.serverConfig.isMasterDoc.secondary) { - secondaries.push({host:db.serverConfig.host, port:db.serverConfig.port}); - } else if(db.serverConfig.isMasterDoc.arbiterOnly) { - arbiters.push({host:db.serverConfig.host, port:db.serverConfig.port}); - } - - // Close the db - db.close(); - // If we are done perform the callback - if(numberOfServersToCheck <= 0) { - callback(null, {primary:primary, secondaries:secondaries, arbiters:arbiters}); - } - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, secondary_count:2, passive_count:1, arbiter_count:1}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -// +----------------------+--------------------------------------------------+ -// | Connection type | Read Preference | -// +======================+================+================+================+ -// | |`PRIMARY` |`SECONDARY` |`SECONDARY_ONLY`| -// +----------------------+----------------+----------------+----------------+ -// |Connection to a single|Queries are |Queries are |Same as | -// |host. |allowed if the |allowed if the |`SECONDARY` | -// | |connection is to|connection is to| | -// | |the replica set |the replica set | | -// | |primary. |primary or a | | -// | | |secondary. | | -// +----------------------+----------------+----------------+----------------+ -exports['Connection to a arbiter host with primary preference should give error'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Let's grab an arbiter, connect and attempt a query - var host = servers.arbiters[0].host; - var port = servers.arbiters[0].port; - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true}); - // Create db instance - var db = new Db('integration_test_', server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab a collection - p_db.createCollection('read_preference_single_test_0', function(err, collection) { - test.ok(err instanceof Error); - test.equal('Cannot write to an arbiter', err.message); - p_db.close(); - test.done(); - }); - }); - }); -} - -exports['Connection to a single primary host with different read preferences'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Select a secondary server, but specify read_primary (should fail) - // Let's grab a secondary server - var host = servers.primary.host; - var port = servers.primary.port; - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true, readPreference:Server.READ_PRIMARY}); - // Create db instance - var db = new Db('integration_test_', server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab the collection - p_db.collection("read_preference_single_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.equal(null, err); - p_db.close(); - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true, readPreference:Server.READ_SECONDARY}); - // Create db instance - var db = new Db('integration_test_', server, {slave_ok:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab the collection - db.collection("read_preference_single_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(0, items.length); - p_db.close(); - - // test.done(); - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true, readPreference:Server.READ_SECONDARY_ONLY}); - // Create db instance - var db = new Db('integration_test_', server, {slave_ok:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab the collection - db.collection("read_preference_single_test_0", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.ok(err instanceof Error); - test.equal("Cannot read from primary when secondary only specified", err.message); - - p_db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -exports['Connection to a single secondary host with different read preferences'] = function(test) { - // Fetch all the identity servers - identifyServers(RS, 'integration_test_', function(err, servers) { - // Select a secondary server, but specify read_primary (should fail) - // Let's grab a secondary server - var host = servers.secondaries[0].host; - var port = servers.secondaries[0].port; - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true, readPreference:Server.READ_PRIMARY}); - // Create db instance - var db = new Db('integration_test_', server, {native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab the collection - p_db.collection("read_preference_single_test_1", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.ok(err instanceof Error); - test.equal("Read preference is primary and server is not master", err.message); - p_db.close(); - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true, readPreference:Server.READ_SECONDARY}); - // Create db instance - var db = new Db('integration_test_', server, {slave_ok:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab the collection - db.collection("read_preference_single_test_1", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(0, items.length); - p_db.close(); - - // Connect to the db - var server = new Server(host, port,{auto_reconnect: true, readPreference:Server.READ_SECONDARY_ONLY}); - // Create db instance - var db = new Db('integration_test_', server, {slave_ok:true, native_parser: (process.env['TEST_NATIVE'] != null)}); - db.open(function(err, p_db) { - // Grab the collection - db.collection("read_preference_single_test_1", function(err, collection) { - // Attempt to read (should fail due to the server not being a primary); - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(0, items.length); - - p_db.close(); - test.done(); - }); - }); - }); - }); - }); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; - - - - - - - - - - - - - - - - diff --git a/test/replicaset/tags_test.js b/test/replicaset/tags_test.js deleted file mode 100644 index 053073febad..00000000000 --- a/test/replicaset/tags_test.js +++ /dev/null @@ -1,382 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - PingStrategy = require('../../lib/mongodb/connection/strategies/ping_strategy').PingStrategy, - StatisticsStrategy = require('../../lib/mongodb/connection/strategies/statistics_strategy').StatisticsStrategy, - Server = require('../../lib/mongodb').Server; - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - // Print any errors - db.on("error", function(err) { - console.log("============================= ensureConnection caught error") - console.dir(err) - if(err != null && err.stack != null) console.log(err.stack) - db.close(); - }) - - // Open the db - db.open(function(err, p_db) { - db.close(); - - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 3000); - } else { - return callback(null); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, passive_count:0, secondary_count:2, tags:[{"dc1":"ny"}, {"dc1":"ny"}, {"dc2":"sf"}]}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -exports['Should Correctly Connect With Default Replicaset And Insert Document For Tag Dc:NY'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Recreate collection on replicaset - p_db.createCollection('testsets', function(err, collection) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - - // Insert a dummy document - collection.insert({a:20}, {safe: {w:'majority'}}, function(err, r) { - // Should have no error - test.equal(null, err); - - // Do a read for the value - collection.findOne({a:20}, function(err, item) { - p_db.close(); - test.equal(20, item.a); - test.done(); - }) - }); - }); - }) -} - -exports['Should Honor setReadPreference primary'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - // Set read preference - replSet.setReadPreference(Server.READ_PRIMARY); - // Open the database - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Checkout a reader and make sure it's the primary - var reader = replSet.checkoutReader(); - var readerAddress = reader.socketOptions['host'] + ":" + reader.socketOptions['port']; - // Locate server instance associated with this id - var serverInstance = replSet._state.addresses[readerAddress]; - // Check that it's the primary instance - test.equal(true, serverInstance.master); - // Check that it's in the list of primary servers - var primaryAddress = replSet._state.master.host + ":" + replSet._state.master.port; - test.equal(primaryAddress, readerAddress); - // End test and close db - p_db.close(); - test.done(); - }) -} - -exports['Should Honor setReadPreference secondary'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - // Set read preference - replSet.setReadPreference(Server.READ_SECONDARY); - // Open the database - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Checkout a reader and make sure it's the primary - var reader = replSet.checkoutReader(); - var readerAddress = reader.socketOptions['host'] + ":" + reader.socketOptions['port']; - // Locate server instance associated with this id - var serverInstance = replSet._state.addresses[readerAddress]; - // Check that it's the primary instance - test.equal(false, serverInstance.master); - // Check that it's in the list of primary servers - test.ok(replSet._state.secondaries[readerAddress] != null); - // End test and close db - p_db.close(); - test.done(); - }) -} - -exports['Should correctly cleanup connection with tags'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - // Set read preference - replSet.setReadPreference({'dc3':'pa', 'dc2':'sf', 'dc1':'ny'}); - // Open the database - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Checkout a reader and make sure it's the primary - var reader = replSet.checkoutWriter(); - var readerAddress = reader.socketOptions['host'] + ":" + reader.socketOptions['port']; - // Locate server instance associated with this id - var serverInstance = replSet._state.addresses[readerAddress]; - // Force cleanup of byTags - ReplSetServers._cleanupTags(serverInstance, replSet._state.byTags); - // Check cleanup successful - test.equal(1, replSet._state.byTags['dc1']['ny'].length); - test.equal(1, replSet._state.byTags['dc2']['sf'].length); - // End test and close db - p_db.close(); - test.done(); - }) -} - -exports['Should Honor setReadPreference tag'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - // Set read preference - replSet.setReadPreference({'dc3':'pa', 'dc2':'sf', 'dc1':'ny'}); - // Open the database - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Checkout a reader and make sure it's the primary - var reader = replSet.checkoutReader(); - var readerAddress = reader.socketOptions['host'] + ":" + reader.socketOptions['port']; - // Locate server instance associated with this id - var serverInstance = replSet._state.addresses[readerAddress]; - test.deepEqual({ dc2: 'sf' }, serverInstance.tags) - p_db.close(); - test.done(); - }) -}, - -exports['Should Correctly Collect ping information from servers'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - // Set read preference - replSet.setReadPreference({'dc3':'pa', 'dc2':'sf', 'dc1':'ny'}); - // Open the database - var db = new Db('integration_test_', replSet, {recordQueryStats:true}); - db.open(function(err, p_db) { - setTimeout(function() { - var keys = Object.keys(replSet._state.addresses); - for(var i = 0; i < keys.length; i++) { - var server = replSet._state.addresses[keys[i]]; - test.ok(server.queryStats.numDataValues >= 0); - test.ok(server.queryStats.mean >= 0); - test.ok(server.queryStats.variance >= 0); - test.ok(server.queryStats.standardDeviation >= 0); - } - - p_db.close(); - test.done(); - }, 5000) - }) -} - -exports['Should correctly pick a ping strategy for secondary'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {} - ); - - // Set read preference - replSet.setReadPreference(Server.READ_SECONDARY); - // Open the database - var db = new Db('integration_test_', replSet, {recordQueryStats:true}); - db.open(function(err, p_db) { - p_db.createCollection('testsets3', function(err, collection) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - - // Insert a bunch of documents - collection.insert([{a:20}, {b:30}, {c:40}, {d:50}], {safe: {w:'majority'}}, function(err, r) { - - // Select all documents - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(4, items.length); - p_db.close(); - test.done(); - }); - }); - }); - }) -} - -exports['Should correctly pick a statistics strategy for secondary'] = function(test) { - // Replica configuration - var replSet = new ReplSetServers([ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {strategy:'statistical'} - ); - - // Ensure we have the right strategy - test.ok(replSet.strategyInstance instanceof StatisticsStrategy); - - // Set read preference - replSet.setReadPreference(Server.READ_SECONDARY); - // Open the database - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - p_db.createCollection('testsets2', function(err, collection) { - if(err != null) debug("shouldCorrectlyWaitForReplicationToServersOnInserts :: " + inspect(err)); - - // Insert a bunch of documents - collection.insert([{a:20}, {b:30}, {c:40}, {d:50}], {safe: {w:'majority'}}, function(err, r) { - - // Select all documents - collection.find().toArray(function(err, items) { - collection.find().toArray(function(err, items) { - collection.find().toArray(function(err, items) { - test.equal(null, err); - test.equal(4, items.length); - - // Total number of entries done - var totalNumberOfStrategyEntries = 0; - - // Check that we have correct strategy objects - var keys = Object.keys(replSet._state.secondaries); - for(var i = 0; i < keys.length; i++) { - var server = replSet._state.secondaries[keys[i]]; - totalNumberOfStrategyEntries += server.queryStats.numDataValues; - } - - p_db.close(); - test.equal(4, totalNumberOfStrategyEntries); - test.done(); - }); - }); - }); - }); - }); - }) -}, - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; diff --git a/test/replicaset/two_server_tests.js b/test/replicaset/two_server_tests.js deleted file mode 100644 index 34e253db571..00000000000 --- a/test/replicaset/two_server_tests.js +++ /dev/null @@ -1,162 +0,0 @@ -var noReplicasetStart = process.env['NO_REPLICASET_START'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - gleak = require('../../dev/tools/gleak'), - ReplicaSetManager = require('../tools/replica_set_manager').ReplicaSetManager, - Db = require('../../lib/mongodb').Db, - ReplSetServers = require('../../lib/mongodb').ReplSetServers, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -// Keep instance of ReplicaSetManager -var serversUp = false; -var retries = 120; -var RS = RS == null ? null : RS; - -var ensureConnection = function(test, numberOfTries, callback) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name} - ); - - if(numberOfTries <= 0) return callback(new Error("could not connect correctly"), null); - - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - db.close(); - if(err != null) { - // Wait for a sec and retry - setTimeout(function() { - numberOfTries = numberOfTries - 1; - ensureConnection(test, numberOfTries, callback); - }, 1000); - } else { - return callback(null, p_db); - } - }) -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - // Create instance of replicaset manager but only for the first call - if(!serversUp && !noReplicasetStart) { - serversUp = true; - RS = new ReplicaSetManager({retries:120, - arbiter_count:0, - secondary_count:1, - passive_count:0, - kill_node_wait_time:50000}); - RS.startSet(true, function(err, result) { - if(err != null) throw err; - // Finish setup - callback(); - }); - } else { - RS.restartKilledNodes(function(err, result) { - if(err != null) throw err; - callback(); - }) - } -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - numberOfTestsRun = numberOfTestsRun - 1; - if(numberOfTestsRun == 0) { - // Finished kill all instances - RS.killAll(function() { - callback(); - }) - } else { - callback(); - } -} - -exports.shouldCorrectlyExecuteSafeFindAndModify = function(test) { - // Replica configuration - var replSet = new ReplSetServers( [ - new Server( RS.host, RS.ports[1], { auto_reconnect: true } ), - new Server( RS.host, RS.ports[0], { auto_reconnect: true } ), - // new Server( RS.host, RS.ports[2], { auto_reconnect: true } ) - ], - {rs_name:RS.name, read_secondary:false} - ); - - // Insert some data - var db = new Db('integration_test_', replSet); - db.open(function(err, p_db) { - // Check if we got an error - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - - // Drop collection on replicaset - p_db.dropCollection('testsets', function(err, r) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Recreate collection on replicaset - p_db.createCollection('testsets', function(err, collection) { - if(err != null) debug("shouldWorkCorrectlyWithInserts :: " + inspect(err)); - // Insert a dummy document - collection.insert({a:20}, {safe: {w:1, wtimeout: 10000}}, function(err, r) { - // Execute a findAndModify - collection.findAndModify({'a':20}, [['a', 1]], {'$set':{'b':3}}, {'new':true, safe: {w:7, wtimeout: 10000}}, function(err, updated_doc) { - test.equal('timeout', err.err) - test.equal(true, err.wtimeout) - p_db.close(); - test.done(); - }); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; - - - - - - - - - - - - - - - - diff --git a/test/streaming_test.js b/test/streaming_test.js deleted file mode 100644 index 567867b8005..00000000000 --- a/test/streaming_test.js +++ /dev/null @@ -1,143 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var native_parser = (process.env['TEST_NATIVE'] != null); -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldStreamRecordsCallsDataTheRightNumberOfTimes = function(test) { - client.createCollection('test_stream_records', function(err, collection) { - test.ok(collection instanceof Collection); - collection.insert([{'a':1}, {'b' : 2}, {'c' : 3}, {'d' : 4}, {'e' : 5}], {safe:true}, function(err, ids) { - var stream = collection.find({}, {'limit' : 3}).streamRecords(); - var callsToEnd = 0; - stream.on('end', function() { - test.done(); - }); - - var callsToData = 0; - stream.on('data',function(data){ - callsToData += 1; - test.ok(callsToData <= 3); - }); - }); - }); -} - -exports.shouldStreamRecordsCallsEndTheRightNumberOfTimes = function(test) { - client.createCollection('test_stream_records', function(err, collection) { - test.ok(collection instanceof Collection); - collection.insert([{'a':1}, {'b' : 2}, {'c' : 3}, {'d' : 4}, {'e' : 5}], {safe:true}, function(err, ids) { - collection.find({}, {'limit' : 3}, function(err, cursor) { - var stream = cursor.streamRecords(function(er,item) {}); - var callsToEnd = 0; - stream.on('end', function() { - callsToEnd += 1; - test.equal(1, callsToEnd); - setTimeout(function() { - // Let's close the db - if (callsToEnd == 1) { - test.done(); - } - }.bind(this), 1000); - }); - - stream.on('data',function(data){ /* nothing here */ }); - }); - }); - }); -} - -exports.shouldStreamDocumentsWithLimitForFetching = function(test) { - var docs = [] - - for(var i = 0; i < 3000; i++) { - docs.push({'a':i}) - } - - client.createCollection('test_streaming_function_with_limit_for_fetching', function(err, collection) { - test.ok(collection instanceof Collection); - - collection.insert(docs, {safe:true}, function(err, ids) { - collection.find({}, function(err, cursor) { - // Execute find on all the documents - var stream = cursor.streamRecords({fetchSize:1000}); - var callsToEnd = 0; - stream.on('end', function() { - test.done(); - }); - - var callsToData = 0; - stream.on('data',function(data){ - callsToData += 1; - test.ok(callsToData <= 3000); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file diff --git a/test/tools/keyfile.txt b/test/tools/keyfile.txt deleted file mode 100644 index f15d6805bea..00000000000 --- a/test/tools/keyfile.txt +++ /dev/null @@ -1 +0,0 @@ -THIS IS A SECRET KEYFILE FOR REPLICA SETS BWAHAHAHAH diff --git a/test/tools/replica_set_manager.js b/test/tools/replica_set_manager.js deleted file mode 100644 index 15cd9cb5aa0..00000000000 --- a/test/tools/replica_set_manager.js +++ /dev/null @@ -1,591 +0,0 @@ -var debug = require('util').debug, - inspect = require('util').inspect, - path = require('path'), - fs = require('fs'), - exec = require('child_process').exec, - spawn = require('child_process').spawn, - Connection = require('../../lib/mongodb').Connection, - Db = require('../../lib/mongodb').Db, - Server = require('../../lib/mongodb').Server, - Step = require("step"); - -var ReplicaSetManager = exports.ReplicaSetManager = function(options) { - options = options == null ? {} : options; - - this.startPort = options["start_port"] || 30000; - this.ports = []; - this.name = options["name"] != null ? options["name"] : "replica-set-foo"; - this.host = options["host"] != null ? options["host"] : "127.0.0.1"; - this.retries = options["retries"] != null ? options["retries"] : 60; - this.config = {"_id": this.name, "version": 1, "members": []}; - this.durable = options["durable"] != null ? options["durable"] : false; - this.auth = options['auth'] != null ? options['auth'] : false; - this.path = path.resolve("data"); - this.killNodeWaitTime = options['kill_node_wait_time'] != null ? options['kill_node_wait_time'] : 20000; - this.tags = options['tags'] != null ? options['tags'] : []; - this.ssl = options['ssl'] != null ? options['ssl'] : false; - - this.arbiterCount = options["arbiter_count"] != null ? options["arbiter_count"] : 2; - this.secondaryCount = options["secondary_count"] != null ? options["secondary_count"] : 1; - this.passiveCount = options["passive_count"] != null ? options["passive_count"] : 1; - this.primaryCount = options["primary_count"] != null ? options["primary_count"] : 1; - this.keyPath = [process.cwd(), "test", "tools", "keyfile.txt"].join("/"); - try { - fs.chmodSync(this.keyPath, 0600); - } catch(err) { - console.dir(err); - } - - this.count = this.primaryCount + this.passiveCount + this.arbiterCount + this.secondaryCount; - if(this.count > 7) { - throw new Error("Cannot create a replica set with #{node_count} nodes. 7 is the max."); - } - - // Keeps all the mongod instances - this.mongods = {}; -} - -ReplicaSetManager.prototype.secondaries = function(callback) { - return this.allHostPairsWithState(2, callback); -} - -ReplicaSetManager.prototype.arbiters = function(callback) { - return this.allHostPairsWithState(7, callback); -} - -ReplicaSetManager.prototype.primary = function(callback) { - return this.allHostPairsWithState(1, function(err, items) { - if(items.length == 0) { - return callback(null, null); - } else { - return callback(null, items[0]); - } - }); -} - -ReplicaSetManager.prototype.allHostPairsWithState = function(state, callback) { - this.ensureUp(function(err, status) { - if(err != null) return callback(err, null); - - var members = status["members"]; - - // Get the correct state memebers - var nodes = members.filter(function(value) { - return value["state"] == state; - }); - - // Filter out address of the server - var servers = nodes.map(function(item) { - return item["name"]; - }); - - // Map nodes - return callback(null, servers); - }) -} - -ReplicaSetManager.prototype.startSet = function(killall, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - killall = args.length ? args.shift() : true; - debug("** Starting a replica set with " + this.count + " nodes"); - - // Kill all existing mongod instances - exec(killall ? 'killall -9 mongod' : '', function(err, stdout, stderr) { - var n = 0; - var tagsIndex = 0; - - Step( - function startAllServers() { - var group = this.group(); - // Start primary instances - for(n = 0; n < (self.primaryCount + self.secondaryCount); n++) { - self.initNode(n, {tags:self.tags[tagsIndex] != null ? self.tags[tagsIndex++] : null}, group()); - } - - // Start passive instances - for(var i = 0; i < self.passiveCount; i++) { - self.initNode(n, {passive:true, priority:0, tags:self.tags[tagsIndex] != null ? self.tags[tagsIndex++] : null}, group()) - n = n + 1; - } - - // Start arbiter instances - for(var i = 0; i < self.arbiterCount; i++) { - self.initNode(n, {arbiterOnly:true, tags:self.tags[tagsIndex] != null ? self.tags[tagsIndex++] : null}, group()); - n = n + 1; - } - }, - - function finishUp(err, values) { - self.numberOfInitiateRetries = 0; - // Initiate - self.initiate(function(err, result) { - if(err != null) return callback(err, null); - self.ensureUpRetries = 0; - - // Ensure all the members are up - debug("** Ensuring members are up..."); - // Let's ensure everything is up - self.ensureUp(function(err, result) { - if(err != null) return callback(err, null); - // Return a correct result - callback(null, result); - }) - }); - } - ); - }) -} - -ReplicaSetManager.prototype.initiate = function(callback) { - var self = this; - var done = false; - // Get master connection - self.getConnection(function(err, connection) { - if(err != null) return callback(err, null); - // Set replica configuration - connection.admin().command({replSetInitiate:self.config}, function(err, result) { - // Close connection - connection.close(); - // If we have an error let's - if(err != null) { - // Retry a number of times - if(self.numberOfInitiateRetries < self.retries) { - setTimeout(function() { - self.numberOfInitiateRetries = self.numberOfInitiateRetries + 1; - self.initiate(callback); - }, 1000); - } - } else { - // Make sure we only do this once, even if some messages are late - if(!done) { - done = true; - self.numberOfInitiateRetries = 0; - callback(null, null); - } - } - }); - }); -} - -// Get absolute path -var getPath = function(self, name) { - return path.join(self.path, name); -} - -ReplicaSetManager.prototype.initNode = function(n, fields, callback) { - var self = this; - this.mongods[n] = this.mongods[n] == null ? {} : this.mongods[n]; - var port = this.startPort + n; - this.ports.push(port); - this.mongods[n]["ssl"] = this.ssl; - this.mongods[n]["host"] = this.host; - this.mongods[n]["port"] = port; - this.mongods[n]["db_path"] = getPath(this, "rs-" + port); - this.mongods[n]["log_path"] = getPath(this, "log-" + port); - this.up = false; - - // Set priority off server in config - var priority = typeof fields === 'object' ? fields.priority : null; - - // Add extra fields provided - for(var name in fields) { - this.mongods[n][name] = fields[name]; - } - - // Perform cleanup of directories - exec("rm -rf " + self.mongods[n]["db_path"], function(err, stdout, stderr) { - if(err != null) return callback(err, null); - - // Create directory - exec("mkdir -p " + self.mongods[n]["db_path"], function(err, stdout, stderr) { - if(err != null) return callback(err, null); - self.mongods[n]["start"] = self.startCmd(n); - - // console.log("----------------------------------------------------- node start command") - // console.log(self.mongods[n]["start"]) - - self.start(n, function() { - // Add instance to list of members - var member = {"_id": n, "host": self.host + ":" + self.mongods[n]["port"]}; - // Set it to arbiter if it's been passed - if(self.mongods[n]['arbiterOnly']) { - member['arbiterOnly'] = true; - } - // Set priority level if it's defined - if(priority != null) { - member['priority'] = priority; - } - - // Check if we have tags - if(self.mongods[n]['tags'] != null) { - member["tags"] = self.mongods[n]['tags']; - } - - // Push member to config - self.config["members"].push(member); - // Return - return callback(); - }); - }); - }); -} - -ReplicaSetManager.prototype.killAll = function(callback) { - exec('killall -9 mongod', function(err, stdout, stderr) { - return callback(); - }); -} - -ReplicaSetManager.prototype.kill = function(node, signal, options, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 1); - callback = args.pop(); - signal = args.length ? args.shift() : 2; - options = args.length ? args.shift() : {}; - // kill node wait time - var killNodeWaitTime = options.killNodeWaitTime == null ? self.killNodeWaitTime : options.killNodeWaitTime; - - debug("** Killing node with pid " + this.mongods[node]["pid"] + " at port " + this.mongods[node]['port']); - var command = "kill -" + signal + " " + this.mongods[node]["pid"]; - // Kill process - exec(command, - function (error, stdout, stderr) { - debug('stdout: ' + stdout); - debug('stderr: ' + stderr); - if (error != null) { - debug('exec error: ' + error); - } - - self.mongods[node]["up"] = false; - // Wait for 5 seconds to give the server time to die a proper death - setTimeout(callback, killNodeWaitTime); - }); -} - -ReplicaSetManager.prototype.killPrimary = function(signal, options, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - signal = args.length ? args.shift() : 2; - options = args.length ? args.shift() : {}; - var done = false; - - this.getNodeWithState(1, function(err, node) { - if(!done) { - // Ensure no double callbacks due to later scheduled connections returning - done = true; - if(err != null) return callback(err, null); - - // Kill process and return node reference - self.kill(node, signal, options, function() { - // Wait for a while before passing back - callback(null, node); - }) - } - }); -} - -ReplicaSetManager.prototype.killSecondary = function(callback) { - var self = this; - var done = false; - - this.getNodeWithState(2, function(err, node) { - if(!done) { - // Ensure no double callbacks due to later scheduled connections returning - done = true; - if(err != null) return callback(err, null); - // Kill process and return node reference - self.kill(node, function() { - callback(null, node); - }) - } - }); -} - -ReplicaSetManager.prototype.stepDownPrimary = function(callback) { - var self = this; - // Get the primary node - this.getNodeWithState(1, function(err, primary) { - // Return error - if(err) return callback(err, null); - if(primary == null) return callback(new Error("No primary found"), null); - // Get the connection for the primary - self.getConnection(primary, function(err, connection) { - // Return any errors - if(err) return callback(err, null); - // Execute stepdown process - connection.admin().command({"replSetStepDown": 90}); - // Return the callback - return callback(null, connection); - }); - }); -} - -ReplicaSetManager.prototype.getNodeFromPort = function(port, callback) { - var self = this; - var nodes = Object.keys(this.mongods).filter(function(key, index, array) { - return self.mongods[key]["port"] == port; - }); - // Return first node - callback(null, nodes.length > 0 ? nodes.shift() : null); -} - -ReplicaSetManager.prototype.getNodeWithState = function(state, callback) { - var self = this; - self.ensureUpRetries = 0; - self.ensureUp(function(err, status) { - if(err != null) return callback(err, null); - - var node = status["members"].filter(function(element, index, array) { - return element["state"] == state; - }).shift(); - - if(node != null) { - var hostPort = node["name"].split(":"); - var port = hostPort[1] != null ? parseInt(hostPort[1]) : 27017; - var key = Object.keys(self.mongods).filter(function(element, index, array) { - return self.mongods[element]["port"] == port; - }).shift(); - return callback(null, key); - } else { - return callback(null, false); - } - }); -} - -ReplicaSetManager.prototype.ensureUp = function(callback) { - var self = this; - var numberOfInitiateRetries = this.retries; - var done = false; - - // Actual function doing testing - var ensureUpFunction = function() { - if(!done) { - if(!self.up) process.stdout.write("."); - // Attemp to retrieve a connection - self.getConnection(function(err, connection) { - // Adjust the number of retries - numberOfInitiateRetries = numberOfInitiateRetries - 1 - // If have no more retries stop - if(numberOfInitiateRetries == 0) { - // Set that we are done - done = true; - // perform callback - return callback(new Error("Servers did not come up again"), null); - } - - // We have a connection, execute command and update server object - if(err == null && connection != null) { - // Check repl set get status - connection.admin().command({"replSetGetStatus": 1}, function(err, object) { - // Close connection - if(connection != null) connection.close(); - // Get documents - var documents = object.documents; - // Get status object - var status = documents[0]; - - // If no members set - if(status["members"] == null || err != null) { - // if we have a connection force close it - if(connection != null) connection.close(); - // Ensure we perform enough retries - if(self.ensureUpRetries >= self.retries) { - // Set that we are done - done = true; - // Return error - return callback(new Error("Operation Failure"), null); - } else { - // Execute function again - setTimeout(ensureUpFunction, 1000); - } - } else { - // Establish all health member - var healthyMembers = status.members.filter(function(element) { - return element["health"] == 1 && [1, 2, 7].indexOf(element["state"]) != -1 - }); - - var stateCheck = status["members"].filter(function(element, indexOf, array) { - return element["state"] == 1; - }); - - if(healthyMembers.length == status.members.length && stateCheck.length > 0) { - // Set that we are done - done = true; - // if we have a connection force close it - if(connection != null) connection.close(); - // process.stdout.write("all members up! \n\n"); - if(!self.up) process.stdout.write("all members up!\n\n") - self.up = true; - return callback(null, status); - } else { - // if we have a connection force close it - if(connection != null) connection.close(); - // Ensure we perform enough retries - if(self.ensureUpRetries >= self.retries) { - // Set that we are done - done = true; - // Return error - return callback(new Error("Operation Failure"), null); - } else { - // Execute function again - setTimeout(ensureUpFunction, 1000); - } - } - } - }); - } else if(err != null && connection != null) { - if(connection != null) connection.close(); - } - }); - } - } - - // Execute the first function call - ensureUpFunction(); -} - -// Restart -ReplicaSetManager.prototype.restartKilledNodes = function(callback) { - var self = this; - - var nodes = Object.keys(self.mongods).filter(function(key) { - return self.mongods[key]["up"] == false; - }); - - var numberOfNodes = nodes.length; - if(numberOfNodes == 0) return self.ensureUp(callback); - - // Restart all the number of nodes - for(var i = 0; i < numberOfNodes; i++) { - // Start the process - self.start(nodes[i], function(err, result) { - // Adjust the number of nodes we are starting - numberOfNodes = numberOfNodes - 1; - - if(numberOfNodes === 0) { - self.ensureUp(callback); - } - }); - } -} - -ReplicaSetManager.prototype.getConnection = function(node, callback) { - var self = this; - // Function done - var done = false; - // Number of retries - var numberOfRetries = self.retries; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - node = args.length ? args.shift() : null; - - if(node == null) { - var keys = Object.keys(this.mongods); - for(var i = 0; i < keys.length; i++) { - var key = keys[i]; - // Locate first db that's runing and is not an arbiter - if(this.mongods[keys[i]]["arbiterOnly"] == null && this.mongods[key]["up"]) { - node = keys[i]; - break; - } - } - } - - // Get the node - if(self.mongods[node] != null) { - var intervalId = setInterval(function() { - var connection = new Db("replicaset_test", new Server(self.host, self.mongods[node]["port"], {ssl:self.ssl})); - connection.open(function(err, db) { - if(err == null && !done) { - // Set done - done = true; - // Clear interval - clearInterval(intervalId); - // Callback as done - return callback(null, connection); - } else { - // Close the connection - if(connection != null) connection.close(); - // Adjust the number of retries - numberOfRetries = numberOfRetries - 1; - // If we have no more retries fail - if(numberOfRetries == 0) { - // Set done - done = true; - // Clear interval - clearInterval(intervalId); - // Callback as done - return callback(new Error("Timed out connecting to primary"), null); - } - } - }); - }, 1000); - } else { - callback(new Error("no primary node found to do stepDownPrimary"), null); - } -} - -// Fire up the mongodb instance -var start = ReplicaSetManager.prototype.start = function(node, callback) { - var self = this; - - // Start up mongod process - var mongodb = exec(self.mongods[node]["start"], - function (error, stdout, stderr) { - debug('stdout: ' + stdout); - debug('stderr: ' + stderr); - if (error != null) { - debug('exec error: ' + error); - } - }); - - // Wait for a half a second then save the pids - setTimeout(function() { - // Mark server as running - self.mongods[node]["up"] = true; - self.mongods[node]["pid"]= fs.readFileSync(path.join(self.mongods[node]["db_path"], "mongod.lock"), 'ascii').trim(); - // Callback - callback(); - }, 5000); -} - -ReplicaSetManager.prototype.restart = start; - -ReplicaSetManager.prototype.startCmd = function(n) { - // Create boot command - this.mongods[n]["start"] = "mongod --rest --noprealloc --smallfiles --replSet " + this.name + " --logpath '" + this.mongods[n]['log_path'] + "' " + - " --dbpath " + this.mongods[n]['db_path'] + " --port " + this.mongods[n]['port'] + " --fork"; - this.mongods[n]["start"] = this.durable ? this.mongods[n]["start"] + " --dur" : this.mongods[n]["start"]; - - if(this.auth) { - this.mongods[n]["start"] = this.auth ? this.mongods[n]["start"] + " --keyFile " + this.keyPath : this.mongods[n]["start"]; - } - - // If we have ssl defined set up with test certificate - if(this.ssl) { - var path = getPath(this, '../test/certificates'); - this.mongods[n]["start"] = this.mongods[n]["start"] + " --sslOnNormalPorts --sslPEMKeyFile=" + path + "/mycert.pem --sslPEMKeyPassword=10gen"; - } - - return this.mongods[n]["start"]; -} - - - - - - - - - - - - - diff --git a/test/tools/server_manager.js b/test/tools/server_manager.js deleted file mode 100644 index 23c6a6103a8..00000000000 --- a/test/tools/server_manager.js +++ /dev/null @@ -1,142 +0,0 @@ -var debug = require('util').debug, - inspect = require('util').inspect, - path = require('path'), - fs = require('fs'), - exec = require('child_process').exec, - spawn = require('child_process').spawn, - Connection = require('../../lib/mongodb').Connection, - Db = require('../../lib/mongodb').Db, - Server = require('../../lib/mongodb').Server; - -var ServerManager = exports.ServerManager = function(options) { - options = options == null ? {} : options; - // Basic unpack values - this.path = path.resolve("data"); - this.port = options["start_port"] != null ? options["start_port"] : 27017; - this.db_path = getPath(this, "data-" + this.port); - this.log_path = getPath(this, "log-" + this.port); - this.journal = options["journal"] != null ? options["journal"] : false; - this.auth = options['auth'] != null ? options['auth'] : false; - this.ssl = options['ssl'] != null ? options['ssl'] : false; - this.purgedirectories = options['purgedirectories'] != null ? options['purgedirectories'] : true; - - // Server status values - this.up = false; - this.pid = null; -} - -// Start up the server instance -ServerManager.prototype.start = function(killall, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - killall = args.length ? args.shift() : true; - // Create start command - var startCmd = generateStartCmd(this, {log_path: self.log_path, - db_path: self.db_path, port: self.port, journal: self.journal, auth:self.auth, ssl:self.ssl}); - - // console.log("----------------------------------------------------------------------- start") - // console.log(startCmd) - - exec(killall ? 'killall mongod' : '', function(err, stdout, stderr) { - if(self.purgedirectories) { - // Remove directory - exec("rm -rf " + self.db_path, function(err, stdout, stderr) { - if(err != null) return callback(err, null); - // Create directory - exec("mkdir -p " + self.db_path, function(err, stdout, stderr) { - if(err != null) return callback(err, null); - // Start up mongod process - var mongodb = exec(startCmd, - function (error, stdout, stderr) { - // console.log('stdout: ' + stdout); - // console.log('stderr: ' + stderr); - if (error != null) { - console.log('exec error: ' + error); - } - }); - - // Wait for a half a second then save the pids - setTimeout(function() { - // Mark server as running - self.up = true; - self.pid = fs.readFileSync(path.join(self.db_path, "mongod.lock"), 'ascii').trim(); - // Callback - callback(); - }, 500); - }); - }); - } else { - // Ensure we remove the lock file as we are not purging the directory - fs.unlinkSync(path.join(self.db_path, "mongod.lock")); - - // Start up mongod process - var mongodb = exec(startCmd, - function (error, stdout, stderr) { - if (error != null) { - console.log('exec error: ' + error); - } - }); - - // Wait for a half a second then save the pids - setTimeout(function() { - // Mark server as running - self.up = true; - self.pid = fs.readFileSync(path.join(self.db_path, "mongod.lock"), 'ascii').trim(); - // Callback - callback(); - }, 5000); - } - }); -} - -ServerManager.prototype.stop = function(signal, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - signal = args.length ? args.shift() : 2; - // Stop the server - var command = "kill -" + signal + " " + self.pid; - // Kill process - exec(command, - function (error, stdout, stderr) { - // console.log('stdout: ' + stdout); - // console.log('stderr: ' + stderr); - if (error !== null) { - console.log('exec error: ' + error); - } - - self.up = false; - // Wait for a second - setTimeout(callback, 1000); - }); -} - -ServerManager.prototype.killAll = function(callback) { - exec('killall mongod', function(err, stdout, stderr) { - callback(null, null); - }); -} - -// Get absolute path -var getPath = function(self, name) { - return path.join(self.path, name); -} - -// Generate start command -var generateStartCmd = function(self, options) { - // Create boot command - var startCmd = "mongod --noprealloc --logpath '" + options['log_path'] + "' " + - " --dbpath " + options['db_path'] + " --port " + options['port'] + " --fork"; - startCmd = options['journal'] ? startCmd + " --journal" : startCmd; - startCmd = options['auth'] ? startCmd + " --auth" : startCmd; - // If we have ssl defined set up with test certificate - if(options['ssl']) { - var path = getPath(self, '../test/certificates'); - startCmd = startCmd + " --sslOnNormalPorts --sslPEMKeyFile=" + path + "/mycert.pem --sslPEMKeyPassword=10gen"; - } - // Return start command - return startCmd; -} diff --git a/test/tools/sharding_manager.js b/test/tools/sharding_manager.js deleted file mode 100644 index 9d58a7a2cab..00000000000 --- a/test/tools/sharding_manager.js +++ /dev/null @@ -1,155 +0,0 @@ -var debug = require('util').debug, - inspect = require('util').inspect, - path = require('path'), - fs = require('fs'), - exec = require('child_process').exec, - spawn = require('child_process').spawn, - Connection = require('../../lib/mongodb').Connection, - Db = require('../../lib/mongodb').Db, - Server = require('../../lib/mongodb').Server; - -var ShardingManager = exports.ShardingManager = function(options) { - options = options == null ? {} : options; - // Basic unpack values - this.path = path.resolve("data"); - this.port = options["start_port"] != null ? options["start_port"] : 27017; - this.number_of_sharding_servers = options["number_of_sharding_servers"] != null ? options["number_of_sharding_servers"] : 2; - this.number_of_config_servers = options["number_of_config_servers"] != null ? options["number_of_config_servers"] : 1; - this.db_path = getPath(this, "data-" + this.port); - this.log_path = getPath(this, "log-" + this.port); - this.journal = options["journal"] != null ? options["journal"] : false; - this.auth = options['auth'] != null ? options['auth'] : false; - this.ssl = options['ssl'] != null ? options['ssl'] : false; - this.purgedirectories = options['purgedirectories'] != null ? options['purgedirectories'] : true; - - // Server status values - this.up = false; - this.pid = null; -} - -// Start up the server instance -ShardingManager.prototype.start = function(killall, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - killall = args.length ? args.shift() : true; - // Create start command - var startCmd = generateStartCmd(this, {log_path: self.log_path, - db_path: self.db_path, port: self.port, journal: self.journal, auth:self.auth, ssl:self.ssl}); - - // Purge function for the data directory - var purgeFunction = function() { - if(self.purgedirectories) { - // Remove directory - exec("rm -rf " + self.db_path, function(err, stdout, stderr) { - if(err != null) return callback(err, null); - // Create directory - exec("mkdir -p " + self.db_path, function(err, stdout, stderr) { - if(err != null) return callback(err, null); - // Start up mongod process - var mongodb = exec(startCmd, - function (error, stdout, stderr) { - // console.log('stdout: ' + stdout); - // console.log('stderr: ' + stderr); - if (error != null) { - console.log('exec error: ' + error); - } - }); - - // Wait for a half a second then save the pids - setTimeout(function() { - // Mark server as running - self.up = true; - self.pid = fs.readFileSync(path.join(self.db_path, "mongod.lock"), 'ascii').trim(); - // Callback - callback(); - }, 500); - }); - }); - } else { - // Ensure we remove the lock file as we are not purging the directory - fs.unlinkSync(path.join(self.db_path, "mongod.lock")); - - // Start up mongod process - var mongodb = exec(startCmd, - function (error, stdout, stderr) { - if (error != null) { - console.log('exec error: ' + error); - } - }); - - // Wait for a half a second then save the pids - setTimeout(function() { - // Mark server as running - self.up = true; - self.pid = fs.readFileSync(path.join(self.db_path, "mongod.lock"), 'ascii').trim(); - // Callback - callback(); - }, 5000); - } - } - - // If we specified kill all the instances do that then purge the directories - if(killall) { - this.killAll(function() { - purgeFunction(); - }); - } else { - purgeFunction(); - } -} - -ShardingManager.prototype.stop = function(signal, callback) { - var self = this; - // Unpack callback and variables - var args = Array.prototype.slice.call(arguments, 0); - callback = args.pop(); - signal = args.length ? args.shift() : 2; - // Stop the server - var command = "kill -" + signal + " " + self.pid; - // Kill process - exec(command, - function (error, stdout, stderr) { - // console.log('stdout: ' + stdout); - // console.log('stderr: ' + stderr); - if (error != null) { - console.log('exec error: ' + error); - } - - self.up = false; - // Wait for a second - setTimeout(callback, 1000); - }); -} - -ShardingManager.prototype.killAll = function(callback) { - // Kill all mongos instances - exec('killall mongos', function(err, stdout, stderr) { - // Kill all mongod instances - exec('killall mongod', function(err, stdout, stderr) { - callback(null, null); - }); - }); -} - -// Get absolute path -var getPath = function(self, name) { - return path.join(self.path, name); -} - -// Generate start command -var generateStartCmd = function(self, options) { - // Create boot command - var startCmd = "mongod --noprealloc --logpath '" + options['log_path'] + "' " + - " --dbpath " + options['db_path'] + " --port " + options['port'] + " --fork"; - startCmd = options['journal'] ? startCmd + " --journal" : startCmd; - startCmd = options['auth'] ? startCmd + " --auth" : startCmd; - // If we have ssl defined set up with test certificate - if(options['ssl']) { - var path = getPath(self, '../test/certificates'); - startCmd = startCmd + " --sslOnNormalPorts --sslPEMKeyFile=" + path + "/mycert.pem --sslPEMKeyPassword=10gen"; - } - // Return start command - return startCmd; -} diff --git a/test/unicode_test.js b/test/unicode_test.js deleted file mode 100644 index 903a5941a4b..00000000000 --- a/test/unicode_test.js +++ /dev/null @@ -1,185 +0,0 @@ -var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure(); -var useSSL = process.env['USE_SSL'] != null ? true : false; - -var testCase = require('nodeunit').testCase, - debug = require('util').debug, - inspect = require('util').inspect, - nodeunit = require('nodeunit'), - gleak = require('../dev/tools/gleak'), - Db = mongodb.Db, - Cursor = mongodb.Cursor, - Collection = mongodb.Collection, - Server = mongodb.Server; - -var MONGODB = 'integration_tests'; -var client = null; - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.setUp = function(callback) { - var self = exports; - client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)}); - client.open(function(err, db_p) { - if(numberOfTestsRun == (Object.keys(self).length)) { - // If first test drop the db - client.dropDatabase(function(err, done) { - callback(); - }); - } else { - return callback(); - } - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.tearDown = function(callback) { - var self = this; - numberOfTestsRun = numberOfTestsRun - 1; - // Close connection - client.close(); - callback(); -} - -exports.shouldCorrectlySaveUnicodeContainingDocument = function(test) { - var doc = {statuses_count: 1687 - , created_at: 'Mon Oct 22 14:55:08 +0000 2007' - , description: 'NodeJS hacker, Cofounder of Debuggable, CakePHP core alumnus' - , favourites_count: 6 - , profile_sidebar_fill_color: 'EADEAA' - , screen_name: 'felixge' - , status: - { created_at: 'Fri Mar 12 08:59:44 +0000 2010' - , in_reply_to_screen_name: null - , truncated: false - , in_reply_to_user_id: null - , source: 'Tweetie' - , favorited: false - , in_reply_to_status_id: null - , id: 10364119169 - , text: '#berlin #snow = #fail : (' - } - , contributors_enabled: false - , following: null - , geo_enabled: false - , time_zone: 'Eastern Time (US & Canada)' - , profile_sidebar_border_color: 'D9B17E' - , url: 'http://debuggable.com' - , verified: false - , location: 'Berlin' - , profile_text_color: '333333' - , notifications: null - , profile_background_image_url: 'http://s.twimg.com/a/1268354287/images/themes/theme8/bg.gif' - , protected: false - , profile_link_color: '9D582E' - , followers_count: 840 - , name: 'Felix Geisend\u00f6rfer' - , profile_background_tile: false - , id: 9599342 - , lang: 'en' - , utc_offset: -18000 - , friends_count: 450 - , profile_background_color: '8B542B' - , profile_image_url: 'http://a3.twimg.com/profile_images/107142257/passbild-square_normal.jpg' - }; - - client.createCollection('test_should_correctly_save_unicode_containing_document', function(err, collection) { - doc['_id'] = 'felixge'; - - collection.save(doc, {safe:true}, function(err, doc) { - collection.findOne(function(err, doc) { - test.equal('felixge', doc._id); - test.done(); - }); - }); - }); -} - -// Test unicode characters -exports.shouldCorrectlyInsertUnicodeCharacters = function(test) { - client.createCollection('unicode_test_collection', function(err, collection) { - var test_strings = ["ouooueauiOUOOUEAUI", "öüóőúéáűíÖÜÓŐÚÉÁŰÍ", "本荘由利地域に洪水警報"]; - collection.insert({id: 0, text: test_strings[0]}, {safe:true}, function(err, ids) { - collection.insert({id: 1, text: test_strings[1]}, {safe:true}, function(err, ids) { - collection.insert({id: 2, text: test_strings[2]}, {safe:true}, function(err, ids) { - collection.find(function(err, cursor) { - cursor.each(function(err, item) { - if(item != null) { - test.equal(test_strings[item.id], item.text); - } else { - test.done(); - } - }); - }); - }); - }); - }); - }); -} - -exports.shouldCreateObjectWithChineseObjectName = function(test) { - var object = {'客家话' : 'Hello'}; - - client.createCollection('create_object_with_chinese_object_name', function(err, r) { - client.collection('create_object_with_chinese_object_name', function(err, collection) { - - collection.insert(object, {safe:true}, function(err, result) { - collection.findOne(function(err, item) { - test.equal(object['客家话'], item['客家话']) - - collection.find().toArray(function(err, items) { - test.equal(object['客家话'], items[0]['客家话']) - test.done(); - }) - }) - }); - }) - }) -} - -exports.shouldCorrectlyHandleUT8KeyNames = function(test) { - client.createCollection('test_utf8_key_name', function(err, collection) { - collection.insert({'šđžčćŠĐŽČĆ':1}, {safe:true}, function(err, ids) { - // finished_test({test_utf8_key_name:'ok'}); - collection.find({}, {'fields': ['šđžčćŠĐŽČĆ']}, function(err, cursor) { - cursor.toArray(function(err, items) { - // console.log("---------------------------------------------------------------") - // console.dir(err) - // console.dir(items) - // - test.equal(1, items[0]['šđžčćŠĐŽČĆ']); - // Let's close the db - test.done(); - }); - }); - }); - }); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -exports.noGlobalsLeaked = function(test) { - var leaks = gleak.detectNew(); - test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', ')); - test.done(); -} - -/** - * Retrieve the server information for the current - * instance of the db client - * - * @ignore - */ -var numberOfTestsRun = Object.keys(this).length - 2; \ No newline at end of file