Removed read variable, using readPreference everywhere

Author: christkv

lib/mongodb/collection/aggregation.js

@@ -81,7 +81,7 @@ var mapReduce = function mapReduce (map, reduce, options, callback) {
  var self = this;
  var cmd = DbCommand.createDbCommand(this.db, mapCommandHash);
 
- this.db._executeQueryCommand(cmd, {read:readPreference}, function (err, result) {
+ this.db._executeQueryCommand(cmd, {readPreference:readPreference}, function (err, result) {
  if(err) return callback(err);
  if(!result || !result.documents || result.documents.length == 0)
  return callback(Error("command failed to return results"), null)
@@ -226,7 +226,7 @@ var group = function group(keys, condition, initial, reduce, finalize, command,
  var readPreference = shared._getReadConcern(this, options);
  // Execute the command
  this.db._executeQueryCommand(cmd
- , {read:readPreference}
+ , {readPreference:readPreference}
  , utils.handleSingleCommandResultReturn(null, null, function(err, result) {
  if(err) return callback(err, null);
  callback(null, result.retval);

lib/mongodb/collection/commands.js

@@ -48,7 +48,7 @@ var count = function count(query, options, callback) {
  var readPreference = shared._getReadConcern(this, options);
  // Execute the command
  this.db._executeQueryCommand(DbCommand.createDbSlaveOkCommand(this.db, commandObject)
- , {read: readPreference}
+ , {readPreference: readPreference}
  , utils.handleSingleCommandResultReturn(null, null, function(err, result) {
  if(err) return callback(err, null);
  if(result == null) return callback(new Error("no result returned for count"), null);
@@ -73,7 +73,7 @@ var distinct = function distinct(key, query, options, callback) {
  // Create the command
  var cmd = DbCommand.createDbSlaveOkCommand(this.db, mapCommandHash);
 
- this.db._executeQueryCommand(cmd, {read:readPreference}, function (err, result) {
+ this.db._executeQueryCommand(cmd, {readPreference:readPreference}, function (err, result) {
  if(err)
  return callback(err);
  if(result.documents[0].ok != 1)

lib/mongodb/collection/core.js

@@ -362,7 +362,7 @@ var remove = function remove(selector, options, callback) {
  // Execute the command, do not add a callback as it's async
  if(shared._hasWriteConcern(errorOptions) && typeof callback == 'function') {
  // Insert options
- var commandOptions = {read:false};
+ var commandOptions = {readPreference:false};
  // If we have safe set set async to false
  if(errorOptions == null) commandOptions['async'] = true;
  // Set safe option
@@ -617,7 +617,7 @@ var update = function update(selector, document, options, callback) {
  // If safe is defined check for error message
  if(shared._hasWriteConcern(errorOptions) && typeof callback == 'function') {
  // Insert options
- var commandOptions = {read:false};
+ var commandOptions = {readPreference:false};
  // If we have safe set set async to false
  if(errorOptions == null) commandOptions['async'] = true;
  // Set safe option

lib/mongodb/collection/query.js

@@ -129,10 +129,9 @@ var find = function find () {
  var o = newOptions;
  // Support read/readPreference
  if(o["read"] != null) o["readPreference"] = o["read"];
- // Set the read preference
- o.read = o["readPreference"] ? o.readPreference : this.readPreference;
- // Adjust slave ok if read preference is secondary or secondary only
- if(o.read == "secondary" || o.read == "secondaryOnly") options.slaveOk = true;
+ // If no readPreference specified set the collection level readPreference
+ o.readPreference = o.readPreference ? o.readPreference : this.readPreference;
+ if(o.readPreference == "secondary" || o.read == "secondaryOnly") o.slaveOk = true;
 
  // Set the selector
  o.selector = selector; 

lib/mongodb/cursor.js

@@ -70,7 +70,7 @@ function Cursor(db, collection, selector, fields, options) {
  this.currentNumberOfRetries = this.numberOfRetries;
  this.batchSizeValue = options.batchSize == null ? 0 : options.batchSize;
  this.raw = options.raw == null ? false : options.raw;
- this.read = options.read == null ? ReadPreference.PRIMARY : options.read;
+ this.readPreference = options.readPreference == null ? ReadPreference.PRIMARY : options.readPreference;
  this.returnKey = options.returnKey;
  this.maxScan = options.maxScan;
  this.min = options.min;
@@ -431,7 +431,7 @@ Cursor.prototype.setReadPreference = function(readPreference, tags, callback) {
  if(callback == null) throw new Error("only readPreference of primary, secondary, secondaryPreferred, primaryPreferred or nearest supported");
  callback(new Error("only readPreference of primary, secondary, secondaryPreferred, primaryPreferred or nearest supported"));
  } else {
- this.read = readPreference;
+ this.readPreference = readPreference;
  if(callback != null) callback(null, this);
  }
 
@@ -553,13 +553,13 @@ var generateQueryCommand = function(self) {
  }
 
  // Unpack the read preference to set slave ok correctly
- var read = self.read instanceof ReadPreference ? self.read.mode : self.read;
+ var readPreference = self.readPreference instanceof ReadPreference ? self.readPreference.mode : self.readPreference;
 
  // if(self.read == 'secondary')
- if(read == ReadPreference.PRIMARY_PREFERRED
- || read == ReadPreference.SECONDARY
- || read == ReadPreference.SECONDARY_PREFERRED
- || read == ReadPreference.NEAREST) {
+ if(readPreference == ReadPreference.PRIMARY_PREFERRED
+ || readPreference == ReadPreference.SECONDARY
+ || readPreference == ReadPreference.SECONDARY_PREFERRED
+ || readPreference == ReadPreference.NEAREST) {
  queryOptions |= QueryCommand.OPTS_SLAVE;
  }
 
@@ -665,7 +665,7 @@ Cursor.prototype.nextObject = function(options, callback) {
  // No need to check the keys
  var queryOptions = {exhaust: self.exhaust
  , raw:self.raw
- , read:self.read
+ , readPreference:self.readPreference
  , connection:self.connection
  , checkKeys: false};
 
@@ -716,7 +716,7 @@ Cursor.prototype.nextObject = function(options, callback) {
  // If we have no connection set on this cursor check one out
  if(self.connection == null) {
  try {
- self.connection = self.db.serverConfig.checkoutReader(this.read);
+ self.connection = self.db.serverConfig.checkoutReader(this.readPreference);
 
  // Check if we have an error from the checkout Reader function
  if(self.connection instanceof Error) {
@@ -782,7 +782,7 @@ var getMore = function(self, options, callback) {
  );
 
  // Set up options
- var command_options = {read: self.read, raw: self.raw, connection:self.connection };
+ var command_options = {readPreference: self.readPreference, raw: self.raw, connection:self.connection };
 
  // Execute the command
  self.db._executeQueryCommand(getMoreCommand, command_options, function(err, result) {
@@ -897,7 +897,7 @@ Cursor.prototype.explain = function(callback) {
  , batchSize: this.batchSizeValue
  , slaveOk: this.slaveOk
  , raw: this.raw
- , read: this.read
+ , readPreference: this.readPreference
  , returnKey: this.returnKey
  , maxScan: this.maxScan
  , min: this.min
@@ -949,7 +949,7 @@ Cursor.prototype.close = function(callback) {
  try {
  var command = new KillCursorCommand(this.db, [this.cursorId]);
  // Added an empty callback to ensure we don't throw any null exceptions
- this.db._executeQueryCommand(command, {read:self.read, raw:self.raw, connection:self.connection});
+ this.db._executeQueryCommand(command, {readPreference:self.readPreference, raw:self.raw, connection:self.connection});
  } catch(err) {}
  }
 

lib/mongodb/db.js

@@ -1011,7 +1011,7 @@ Db.prototype.createCollection = function(collectionName, options, callback) {
 
  // Create a new collection and return it
  self._executeQueryCommand(DbCommand.createCreateCollectionCommand(self, collectionName, options)
- , {read:false, safe:safe}
+ , {read:'primary', safe:safe}
  , utils.handleSingleCommandResultReturn(null, null, function(err, result) {
  if(err) return callback(err, null);
  // Create collection and return
@@ -1175,7 +1175,7 @@ Db.prototype.executeDbAdminCommand = function(command_hash, options, callback) {
  }
 
  if(options.readPreference) {
- options.read = options.readPreference;
+ options.readPreference = options.readPreference;
  }
 
  this._executeQueryCommand(DbCommand.createAdminDbCommand(this, command_hash), options, function(err, result) {
@@ -1592,23 +1592,22 @@ var bindToCurrentDomain = function(callback) {
  */
 var __executeQueryCommand = function(self, db_command, options, callback) {
  // Options unpacking
- var read = options['read'] != null ? options['read'] : false; 
- read = options['readPreference'] != null && options['read'] == null ? options['readPreference'] : read;
+ var readPreference = options.readPreference != null ? options.readPreference : 'primary';
  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;
 
- // Correct read preference to default primary if set to false, null or primary
- if(!(typeof read == 'object') && read._type == 'ReadPreference') {
- read = (read == null || read == 'primary' || read == false) ? ReadPreference.PRIMARY : read;
- if(!ReadPreference.isValid(read)) return callback(new Error("Illegal readPreference mode specified, " + read));
- } else if(typeof read == 'object' && read._type == 'ReadPreference') {
- if(!read.isValid()) return callback(new Error("Illegal readPreference mode specified, " + read.mode));
+ // Correct readPreference preference to default primary if set to false, null or primary
+ if(!(typeof readPreference == 'object') && readPreference._type == 'ReadPreference') {
+ readPreference = (readPreference == null || readPreference == 'primary' || readPreference == false) ? ReadPreference.PRIMARY : readPreference;
+ if(!ReadPreference.isValid(readPreference)) return callback(new Error("Illegal readPreference mode specified, " + readPreference));
+ } else if(typeof readPreference == 'object' && readPreference._type == 'ReadPreference') {
+ if(!readPreference.isValid()) return callback(new Error("Illegal readPreference mode specified, " + readPreference.mode));
  }
 
  // If we have a read preference set and we are a mongos pass the read preference on to the mongos instance,
- if(self.serverConfig.isMongos() && read != null && read != false) {
- db_command.setMongosReadPreference(read);
+ if(self.serverConfig.isMongos() && readPreference != null && readPreference != 'primary') {
+ db_command.setMongosReadPreference(readPreference);
  }
 
  // If we got a callback object
@@ -1619,10 +1618,10 @@ var __executeQueryCommand = function(self, db_command, options, callback) {
 
  if(connection instanceof Error) return callback(connection, null);
 
- // Fetch either a reader or writer dependent on the specified read option if no connection
+ // Fetch either a reader or writer dependent on the specified readPreference option if no connection
  // was passed in
  if(connection == null) {
- connection = self.serverConfig.checkoutReader(read);
+ connection = self.serverConfig.checkoutReader(readPreference);
  }
 
  if(connection == null) {
@@ -1687,8 +1686,7 @@ var __executeQueryCommand = function(self, db_command, options, callback) {
  }
  } else {
  // Fetch either a reader or writer dependent on the specified read option
- // var connection = read == null || read == 'primary' || read == false ? self.serverConfig.checkoutWriter(true) : self.serverConfig.checkoutReader(read);
- var connection = self.serverConfig.checkoutReader(read);
+ var connection = self.serverConfig.checkoutReader(readPreference);
  // Override connection if needed
  connection = specifiedConnection != null ? specifiedConnection : connection;
  // Ensure we have a valid connection
@@ -1743,17 +1741,17 @@ Db.prototype._executeQueryCommand = function(db_command, options, callback) {
 
  // Get the configuration
  var config = this.serverConfig;
- var read = options.read;
+ var readPreference = options.readPreference;
  // Allow for the usage of the readPreference model
- if(read == null) {
- read = options.readPreference;
+ if(readPreference == null) {
+ readPreference = options.readPreference;
  }
 
- if(!connection && !config.canRead(read) && !config.canWrite() && config.isAutoReconnect()) {
- if(read == ReadPreference.PRIMARY 
- || read == ReadPreference.PRIMARY_PREFERRED
- || (read != null && typeof read == 'object' && read.mode)
- || read == null) {
+ if(!connection && !config.canRead(readPreference) && !config.canWrite() && config.isAutoReconnect()) {
+ if(readPreference == ReadPreference.PRIMARY 
+ || readPreference == ReadPreference.PRIMARY_PREFERRED
+ || (readPreference != null && typeof readPreference == 'object' && readPreference.mode)
+ || readPreference == null) {
 
  // Save the command
  self.serverConfig._commandsStore.read_from_writer(
@@ -1783,7 +1781,7 @@ Db.prototype._executeQueryCommand = function(db_command, options, callback) {
  if(!self.serverConfig._commandsStore.validateBufferLimit(self.bufferMaxEntries)) {
  self.close();
  } 
- } else if(!connection && !config.canRead(read) && !config.canWrite() && !config.isAutoReconnect()) {
+ } else if(!connection && !config.canRead(readPreference) && !config.canWrite() && !config.isAutoReconnect()) {
  return callback(new Error("no open connections"), null);
  } else {
  if(typeof callback == 'function') {

lib/mongodb/scope.js

@@ -103,15 +103,15 @@ var Cursor = function Cursor(_scope_options, _cursor) {
  }
  });
 
- Object.defineProperty(this, "read", {
+ Object.defineProperty(this, "items", {
  get: function() {
- return _cursor.read;
+ return _cursor.items;
  }
- });
+ }); 
 
- Object.defineProperty(this, "items", {
+ Object.defineProperty(this, "readPreference", {
  get: function() {
- return _cursor.items;
+ return _cursor.readPreference;
  }
  }); 
 }

test/tests/repl_set/read_preferences_tests.js

@@ -384,7 +384,7 @@ exports['Should Set read preference at collection level using collection method'
  cursor.toArray(function(err, items) {
  // Does not get called or we don't care
  test.ok(executedCorrectlyRead);
- test.equal(Server.READ_SECONDARY_ONLY, cursor.read)
+ test.equal(Server.READ_SECONDARY_ONLY, cursor.readPreference)
  p_db.close();
  test.done();
  });
@@ -438,7 +438,7 @@ exports['Should Set read preference at collection level using createCollection m
  cursor.toArray(function(err, items) {
  // Does not get called or we don't care
  test.ok(executedCorrectlyRead);
- test.equal(Server.READ_SECONDARY_ONLY, cursor.read)
+ test.equal(Server.READ_SECONDARY_ONLY, cursor.readPreference)
  p_db.close();
  test.done();
  });
@@ -561,7 +561,7 @@ exports['Attempt to change read preference at cursor level after object read leg
  })
 
  // Assert it's the same
- test.equal(Server.READ_SECONDARY_ONLY, cursor.read);
+ test.equal(Server.READ_SECONDARY_ONLY, cursor.readPreference);
  }
  });
  });
@@ -613,7 +613,7 @@ exports['Set read preference at db level'] = function(configuration, test) {
  cursor.toArray(function(err, items) {
  // Does not get called or we don't care
  test.ok(executedCorrectlyRead);
- test.equal(ReadPreference.SECONDARY, cursor.read.mode)
+ test.equal(ReadPreference.SECONDARY, cursor.readPreference.mode)
  p_db.close();
  test.done();
  });
@@ -665,7 +665,7 @@ exports['Set read preference at collection level using collection method'] = fun
  cursor.toArray(function(err, items) {
  // Does not get called or we don't care
  test.ok(executedCorrectlyRead);
- test.equal(ReadPreference.SECONDARY, cursor.read.mode)
+ test.equal(ReadPreference.SECONDARY, cursor.readPreference.mode)
  p_db.close();
  test.done();
  });
@@ -717,7 +717,7 @@ exports['Set read preference at collection level using createCollection method']
  cursor.toArray(function(err, items) {
  // Does not get called or we don't care
  test.ok(executedCorrectlyRead);
- test.equal(ReadPreference.SECONDARY, cursor.read.mode)
+ // test.equal(ReadPreference.SECONDARY, cursor.readPreference.mode)
  p_db.close();
  test.done();
  });
@@ -841,7 +841,7 @@ exports['Attempt to change read preference at cursor level after object read'] =
  })
 
  // Assert it's the same
- test.equal(ReadPreference.SECONDARY, cursor.read.mode);
+ test.equal(ReadPreference.SECONDARY, cursor.readPreference.mode);
  }
  });
  });