mongodb 2.1.0-alpha → 2.1.2

package/lib/command_cursor.js

@@ -11,17 +11,17 @@ var inherits = require('util').inherits
   , ReadPreference = require('./read_preference')
   , MongoError = require('mongodb-core').MongoError
   , Readable = require('stream').Readable || require('readable-stream').Readable
-  // , CoreCursor = require('mongodb-core').Cursor
+  , Define = require('./metadata')
   , CoreCursor = require('./cursor')
   , Query = require('mongodb-core').Query
   , CoreReadPreference = require('mongodb-core').ReadPreference;
 
 /**
- * @fileOverview The **CommandCursor** class is an internal class that embodies a 
- * generalized cursor based on a MongoDB command allowing for iteration over the 
- * results returned. It supports one by one document iteration, conversion to an 
+ * @fileOverview The **CommandCursor** class is an internal class that embodies a
+ * generalized cursor based on a MongoDB command allowing for iteration over the
+ * results returned. It supports one by one document iteration, conversion to an
  * array or can be iterated as a Node 0.10.X or higher stream
- * 
+ *
  * **CommandCursor Cannot directly be instantiated**
  * @example
  * var MongoClient = require('mongodb').MongoClient,
@@ -37,7 +37,7 @@ var inherits = require('util').inherits
  *     , {a:2, b:2}, {a:3, b:3}
  *     , {a:4, b:4}], {w:1}, function(err, result) {
  *     test.equal(null, err);
- * 
+ *
  *     // List the database collections available
  *     db.listCollections().toArray(function(err, items) {
  *       test.equal(null, err);
@@ -104,7 +104,7 @@ var CommandCursor = function(bson, ns, cmd, options, topology, topologyOptions)
     // Topology Options
     , topologyOptions: topologyOptions
     // Promise library
-    , promiseLibrary: promiseLibrary 
+    , promiseLibrary: promiseLibrary
   }
 }
 
@@ -137,17 +137,42 @@ var CommandCursor = function(bson, ns, cmd, options, topology, topologyOptions)
  */
 
 // Inherit from Readable
-inherits(CommandCursor, Readable);  
+inherits(CommandCursor, Readable);
 
 // Set the methods to inherit from prototype
 var methodsToInherit = ['_next', 'next', 'each', 'forEach', 'toArray'
-  , 'rewind', 'bufferedCount', 'readBufferedDocuments', 'close', 'isClosed'];
+  , 'rewind', 'bufferedCount', 'readBufferedDocuments', 'close', 'isClosed', 'kill'
+  , '_find', '_getmore', '_killcursor', 'isDead', 'explain', 'isNotified', 'isKilled'];
 
 // Only inherit the types we need
 for(var i = 0; i < methodsToInherit.length; i++) {
   CommandCursor.prototype[methodsToInherit[i]] = CoreCursor.prototype[methodsToInherit[i]];
 }
 
+var define = CommandCursor.define = new Define('CommandCursor', CommandCursor, true);
+
+/**
+ * Set the ReadPreference for the cursor.
+ * @method
+ * @param {(string|ReadPreference)} readPreference The new read preference for the cursor.
+ * @throws {MongoError}
+ * @return {Cursor}
+ */
+CommandCursor.prototype.setReadPreference = function(r) {
+  if(this.s.state == CommandCursor.CLOSED || this.isDead()) throw MongoError.create({message: "Cursor is closed", driver:true});
+  if(this.s.state != CommandCursor.INIT) throw MongoError.create({message: 'cannot change cursor readPreference after cursor has been accessed', driver:true});
+
+  if(r instanceof ReadPreference) {
+    this.s.options.readPreference = new CoreReadPreference(r.mode, r.tags);
+  } else {
+    this.s.options.readPreference = new CoreReadPreference(r);
+  }
+
+  return this;
+}
+
+define.classMethod('setReadPreference', {callback: false, promise:false, returns: [CommandCursor]});
+
 /**
  * Set the batch size for the cursor.
  * @method
@@ -156,13 +181,15 @@ for(var i = 0; i < methodsToInherit.length; i++) {
  * @return {CommandCursor}
  */
 CommandCursor.prototype.batchSize = function(value) {
-  if(this.s.state == CommandCursor.CLOSED || this.isDead()) throw new MongoError("Cursor is closed");
-  if(typeof value != 'number') throw new MongoError("batchSize requires an integer");
+  if(this.s.state == CommandCursor.CLOSED || this.isDead()) throw MongoError.create({message: "Cursor is closed", driver:true});
+  if(typeof value != 'number') throw MongoError.create({message: "batchSize requires an integer", driver:true});
   if(this.s.cmd.cursor) this.s.cmd.cursor.batchSize = value;
   this.setCursorBatchSize(value);
   return this;
 }
 
+define.classMethod('batchSize', {callback: false, promise:false, returns: [CommandCursor]});
+
 /**
  * Add a maxTimeMS stage to the aggregation pipeline
  * @method
@@ -176,30 +203,31 @@ CommandCursor.prototype.maxTimeMS = function(value) {
   return this;
 }
 
+define.classMethod('maxTimeMS', {callback: false, promise:false, returns: [CommandCursor]});
+
 CommandCursor.prototype.get = CommandCursor.prototype.toArray;
 
+define.classMethod('get', {callback: true, promise:false});
+
+// Inherited methods
+define.classMethod('toArray', {callback: true, promise:true});
+define.classMethod('each', {callback: true, promise:false});
+define.classMethod('forEach', {callback: true, promise:false});
+define.classMethod('next', {callback: true, promise:true});
+define.classMethod('close', {callback: true, promise:true});
+define.classMethod('isClosed', {callback: false, promise:false, returns: [Boolean]});
+define.classMethod('rewind', {callback: false, promise:false});
+define.classMethod('bufferedCount', {callback: false, promise:false, returns: [Number]});
+define.classMethod('readBufferedDocuments', {callback: false, promise:false, returns: [Array]});
+
 /**
  * Get the next available document from the cursor, returns null if no more documents are available.
  * @function CommandCursor.prototype.next
- * @param {CommandCursor~resultCallback} callback The result callback.
+ * @param {CommandCursor~resultCallback} [callback] The result callback.
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */
 
-/**
- * Set the new batchSize of the cursor
- * @function CommandCursor.prototype.setBatchSize
- * @param {number} value The new batchSize for the cursor
- * @return {null}
- */
-
-/**
- * Get the batchSize of the cursor
- * @function CommandCursor.prototype.batchSize
- * @param {number} value The current batchSize for the cursor
- * @return {null}
- */
-
 /**
  * The callback format for results
  * @callback CommandCursor~toArrayResultCallback
@@ -212,7 +240,7 @@ CommandCursor.prototype.get = CommandCursor.prototype.toArray;
  * is enough memory to store the results. Note that the array only contain partial
  * results when this cursor had been previouly accessed.
  * @method CommandCursor.prototype.toArray
- * @param {CommandCursor~toArrayResultCallback} callback The result callback.
+ * @param {CommandCursor~toArrayResultCallback} [callback] The result callback.
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */
@@ -242,25 +270,25 @@ CommandCursor.prototype.get = CommandCursor.prototype.toArray;
  * @method CommandCursor.prototype.close
  * @param {CommandCursor~resultCallback} [callback] The result callback.
  * @return {Promise} returns Promise if no callback passed
- */   
+ */
 
 /**
  * Is the cursor closed
  * @method CommandCursor.prototype.isClosed
  * @return {boolean}
- */   
+ */
 
 /**
  * Clone the cursor
  * @function CommandCursor.prototype.clone
  * @return {CommandCursor}
- */     
+ */
 
 /**
  * Resets the cursor
  * @function CommandCursor.prototype.rewind
  * @return {CommandCursor}
- */  
+ */
 
 /**
  * The callback format for the forEach iterator method
@@ -287,4 +315,4 @@ CommandCursor.INIT = 0;
 CommandCursor.OPEN = 1;
 CommandCursor.CLOSED = 2;
 
-module.exports = CommandCursor;
+module.exports = CommandCursor;