mongo 1.8.0 → 1.8.2

data/lib/mongo/db.rb

@@ -55,7 +55,7 @@ module Mongo
     attr_accessor :cache_time
 
     # Read Preference
-    attr_accessor :read_preference, :tag_sets, :acceptable_latency
+    attr_accessor :read, :tag_sets, :acceptable_latency
 
     # Instances of DB are normally obtained by calling Mongo#db.
     #
@@ -71,11 +71,17 @@ module Mongo
     #   fields the factory wishes to inject. (NOTE: if the object already has a primary key,
     #   the factory should not inject a new key).
     #
-    # @option opts [Hash] :w, :j, :wtimeout, :fsync Set the default write concern for this database.
-    #   Propagated to Collection objects instantiated off of this DB. If no
-    #   options are provided, the default write concern set on this instance's MongoClient object will be used. This
-    #   default can be overridden upon instantiation of any collection by explicitly setting write concern values
-    #   on initialization
+    # @option opts [String, Integer, Symbol] :w (1) Set default number of nodes to which a write
+    #   should be acknowledged
+    # @option opts [Boolean] :j (false) Set journal acknowledgement
+    # @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout
+    # @option opts [Boolean] :fsync (false) Set fsync acknowledgement.
+    #
+    #   Notes on write concern:
+    #     These write concern options are propagated to Collection objects instantiated off of this DB. If no
+    #     options are provided, the default write concern set on this instance's MongoClient object will be used. This
+    #     default can be overridden upon instantiation of any collection by explicitly setting write concern options
+    #     on initialization or at the time of an operation.
     #
     # @option opts [Integer] :cache_time (300) Set the time that all ensure_index calls should cache the command.
     #
@@ -88,12 +94,8 @@ module Mongo
 
       @write_concern = get_write_concern(opts, client)
 
-      if value = opts[:read]
-        Mongo::Support.validate_read_preference(value)
-      else
-        value = @connection.read_preference
-      end
-      @read_preference = value.is_a?(Hash) ? value.dup : value
+      @read = opts[:read] || @connection.read
+      Mongo::ReadPreference::validate(@read)
       @tag_sets = opts.fetch(:tag_sets, @connection.tag_sets)
       @acceptable_latency = opts.fetch(:acceptable_latency, @connection.acceptable_latency)
       @cache_time = opts[:cache_time] || 300 #5 minutes.
@@ -504,8 +506,11 @@ module Mongo
     # hashes are ordered by default.
     #
     # @option opts [Boolean] :check_response (true) If +true+, raises an exception if the
-    # command fails.
+    #   command fails.
     # @option opts [Socket] :socket a socket to use for sending the command. This is mainly for internal use.
+    # @option opts [:primary, :secondary] :read Read preference for this command. See Collection#find for
+    #   more details.
+    # @option opts [String]  :comment (nil) a comment to include in profiling logs
     #
     # @return [Hash]
     #
@@ -518,9 +523,20 @@ module Mongo
         raise MongoArgumentError, "DB#command requires an OrderedHash when hash contains multiple keys"
       end
 
+      if read_pref = opts[:read]
+        Mongo::ReadPreference::validate(read_pref)
+        unless read_pref == :primary || Mongo::Support::secondary_ok?(selector)
+          raise MongoArgumentError, "Command is not supported on secondaries: #{selector.keys.first}"
+        end
+      end
+
       begin
         result = Cursor.new(system_command_collection,
-          :limit => -1, :selector => selector, :socket => socket).next_document
+                            :limit => -1,
+                            :selector => selector,
+                            :socket => socket,
+                            :read => read_pref,
+                            :comment => opts[:comment]).next_document
       rescue OperationFailure => ex
         raise OperationFailure, "Database command '#{selector.keys.first}' failed: #{ex.message}"
       end

data/lib/mongo/gridfs/grid.rb

@@ -62,9 +62,11 @@ module Mongo
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
     # @option opts [Integer] (262144) :chunk_size size of file chunks in bytes.
-    # @option opts [Boolean] :w (1) Set the write concern
-    #   When :w > 0, the chunks sent to the server are validated using an md5 hash. 
-    #   If validation fails, an exception will be raised.
+    # @option opts [String, Integer, Symbol] :w (1) Set write concern
+    #
+    #   Notes on write concern:  
+    #      When :w > 0, the chunks sent to the server are validated using an md5 hash. 
+    #      If validation fails, an exception will be raised.
     #
     # @return [BSON::ObjectId] the file's id.
     def put(data, opts={})

data/lib/mongo/gridfs/grid_file_system.rb

@@ -69,9 +69,11 @@ module Mongo
     # @option opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option
     #  only work in 'w' mode. Certain precautions must be taken when deleting GridFS files. See the notes under
     #  GridFileSystem#delete.
-    # @option opts [Hash] :w (1) Set the write concern
-    #   When :w > 0, the chunks sent to the server
-    #   will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [String, Integer, Symbol] :w (1) Set write concern
+    #
+    #   Notes on write concern:
+    #     When :w > 0, the chunks sent to the server
+    #     will be validated using an md5 hash. If validation fails, an exception will be raised.
     # @option opts [Integer] :versions (false) deletes all versions which exceed the number specified to 
     #   retain ordered by uploadDate. This option only works in 'w' mode. Certain precautions must be taken when 
     #   deleting GridFS files. See the notes under GridFileSystem#delete.

data/lib/mongo/gridfs/grid_io.rb

@@ -50,9 +50,11 @@ module Mongo
     # @option opts [String] :content_type ('binary/octet-stream') If no content type is specified,
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
-    # @option opts [Hash] :w (1) Set the default write concern
-    #   When :w > 0, the chunks sent to the server
-    #   will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [String, Integer, Symbol] :w (1) Set the write concern
+    #
+    #   Notes on write concern:
+    #     When :w > 0, the chunks sent to the server
+    #     will be validated using an md5 hash. If validation fails, an exception will be raised.
     def initialize(files, chunks, filename, mode, opts={})
       @files          = files
       @chunks         = chunks

data/lib/mongo/legacy.rb

@@ -43,16 +43,22 @@ end
 
 module Mongo
   # @deprecated Use Mongo::MongoClient instead. Support will be removed after v2.0
+  # Please see old documentation for the Connection class
   class Connection < MongoClient
     include Mongo::LegacyWriteConcern
 
-    def initialize(host=nil, port=nil, opts={})
-      write_concern_from_legacy(opts)
+    def initialize(*args)
+      if args.last.is_a?(Hash)
+        opts = args.pop
+        write_concern_from_legacy(opts)
+        args.push(opts)
+      end
       super
     end
   end
 
   # @deprecated Use Mongo::MongoReplicaSetClient instead. Support will be removed after v2.0
+  # Please see old documentation for the ReplSetConnection class
   class ReplSetConnection < MongoReplicaSetClient
     include Mongo::LegacyWriteConcern
 
@@ -67,6 +73,7 @@ module Mongo
   end
 
   # @deprecated Use Mongo::MongoShardedClient instead. Support will be removed after v2.0
+  # Please see old documentation for the ShardedConnection class
   class ShardedConnection < MongoShardedClient
     include Mongo::LegacyWriteConcern
 

data/lib/mongo/mongo_client.rb

@@ -28,18 +28,18 @@ module Mongo
     include Mongo::Networking
     include Mongo::WriteConcern
 
-    TCPSocket          = Mongo::TCPSocket
     Mutex              = ::Mutex
     ConditionVariable  = ::ConditionVariable
 
-    DEFAULT_HOST       = 'localhost'
-    DEFAULT_PORT       = 27017
-    DEFAULT_DB_NAME    = 'test'
-    GENERIC_OPTS       = [:ssl, :auths, :logger, :connect]
-    TIMEOUT_OPTS       = [:timeout, :op_timeout, :connect_timeout]
-    POOL_OPTS          = [:pool_size, :pool_timeout]
-    WRITE_CONCERN_OPTS = [:w, :j, :fsync, :wtimeout]
-    CLIENT_ONLY_OPTS   = [:slave_ok]
+    DEFAULT_HOST         = 'localhost'
+    DEFAULT_PORT         = 27017
+    DEFAULT_DB_NAME      = 'test'
+    GENERIC_OPTS         = [:ssl, :auths, :logger, :connect]
+    TIMEOUT_OPTS         = [:timeout, :op_timeout, :connect_timeout]
+    POOL_OPTS            = [:pool_size, :pool_timeout]
+    READ_PREFERENCE_OPTS = [:read, :tag_sets, :secondary_acceptable_latency_ms]
+    WRITE_CONCERN_OPTS   = [:w, :j, :fsync, :wtimeout]
+    CLIENT_ONLY_OPTS     = [:slave_ok]
 
     mongo_thread_local_accessor :connections
 
@@ -56,7 +56,8 @@ module Mongo
                 :socket_class,
                 :op_timeout,
                 :tag_sets,
-                :acceptable_latency
+                :acceptable_latency,
+                :read
 
     # Create a connection to single MongoDB instance.
     #
@@ -72,13 +73,19 @@ module Mongo
     # MongoClient#arbiters. This is useful if your application needs to connect manually to nodes other
     # than the primary.
     #
-    # @param [String, Hash] host
+    # @param [String] host
     # @param [Integer] port specify a port number here if only one host is being specified.
     #
-    # @option opts [Hash] :w (1), :j (false), :wtimeout (false), :fsync (false) Set the default write concern
-    #   options propagated to DB objects instantiated off of this MongoClient.
-    #   This default can be overridden upon instantiation of any DB by explicitly setting an options hash
-    #   on initialization.  It can also be overridden at instantiation of a collection or at the time of a write operation.
+    # @option opts [String, Integer, Symbol] :w (1) Set default number of nodes to which a write
+    #   should be acknowledged
+    # @option opts [Boolean] :j (false) Set journal acknowledgement
+    # @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout
+    # @option opts [Boolean] :fsync (false) Set fsync acknowledgement.
+    #
+    #     Notes about write concern options:
+    #       Write concern options are propagated to objects instantiated from this MongoClient.
+    #       These defaults can be overridden upon instantiation of any object by explicitly setting an options hash
+    #       on initialization.
     # @option opts [Boolean] :slave_ok (false) Must be set to +true+ when connecting
     #   to a single, slave node.
     # @option opts [Logger, #debug] :logger (nil) A Logger instance for debugging driver ops. Note that
@@ -106,6 +113,9 @@ module Mongo
     # @example localhost, 3000, where this node may be a slave
     #   MongoClient.new("localhost", 3000, :slave_ok => true)
     #
+    # @example Unix Domain Socket
+    #   MongoClient.new("/var/run/mongodb.sock")
+    #
     # @see http://api.mongodb.org/ruby/current/file.REPLICA_SETS.html Replica sets in Ruby
     #
     # @raise [ReplicaSetConnectionError] This is raised if a replica set name is specified and the
@@ -114,24 +124,9 @@ module Mongo
     # @raise [MongoArgumentError] If called with no arguments and <code>ENV["MONGODB_URI"]</code> implies a replica set.
     #
     # @core self.connections
-    def initialize(host=nil, port=nil, opts={})
-      if host.nil? and ENV.has_key?('MONGODB_URI')
-        parser = URIParser.new ENV['MONGODB_URI']
-        if parser.replicaset?
-          raise MongoArgumentError, "Mongo::MongoClient.new called with no arguments, but ENV['MONGODB_URI'] implies a replica set."
-        end
-        opts.merge!(parser.connection_options)
-        @host_to_try = [parser.host, parser.port]
-      elsif host.is_a?(String) && (port || DEFAULT_PORT).respond_to?(:to_i)
-        @host_to_try = [host, (port || DEFAULT_PORT).to_i]
-      elsif host || port
-        raise MongoArgumentError, "Mongo::MongoClient.new host or port argument error, host:#{host.inspect}, port:#{port.inspect}"
-      else
-        @host_to_try = [DEFAULT_HOST, DEFAULT_PORT]
-      end
-
-      # Host and port of current master.
-      @host = @port = nil
+    def initialize(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      @host, @port = parse_init(args[0], args[1], opts)
 
       # Default maximum BSON object size
       @max_bson_size = Mongo::DEFAULT_MAX_BSON_SIZE
@@ -139,16 +134,17 @@ module Mongo
       # Lock for request ids.
       @id_lock = Mutex.new
 
-      # Connection pool for primay node
+      # Connection pool for primary node
       @primary      = nil
       @primary_pool = nil
+      @mongos       = false
 
       # Not set for direct connection
-      @tag_sets = {}
+      @tag_sets = []
       @acceptable_latency = 15
 
       check_opts(opts)
-      setup(opts)
+      setup(opts.dup)
     end
 
     # DEPRECATED
@@ -180,12 +176,12 @@ module Mongo
     def self.multi(nodes, opts={})
       warn "MongoClient.multi is now deprecated and will be removed in v2.0. Please use MongoReplicaSetClient.new instead."
 
-      MongoReplicaSetClient.new(*(nodes+[opts]))
+      MongoReplicaSetClient.new(nodes, opts)
     end
 
     # Initialize a connection to MongoDB using the MongoDB URI spec.
     #
-    # Since MongoClient.new cannot be used with any <code>ENV["MONGODB_URI"]</code> that has multiple hosts (implying a replicaset), 
+    # Since MongoClient.new cannot be used with any <code>ENV["MONGODB_URI"]</code> that has multiple hosts (implying a replicaset),
     # you may use this when the type of your connection varies by environment and should be determined solely from <code>ENV["MONGODB_URI"]</code>.
     #
     # @param uri [String]
@@ -199,6 +195,20 @@ module Mongo
       parser.connection(extra_opts)
     end
 
+    def parse_init(host, port, opts)
+      if host.nil? && port.nil? && ENV.has_key?('MONGODB_URI')
+        parser = URIParser.new(ENV['MONGODB_URI'])
+        if parser.replicaset?
+          raise MongoArgumentError,
+            "ENV['MONGODB_URI'] implies a replica set."
+        end
+        opts.merge! parser.connection_options
+        [parser.host, parser.port]
+      else
+        [host || DEFAULT_HOST, port || DEFAULT_PORT]
+      end
+    end
+
     # The host name used for this connection.
     #
     # @return [String]
@@ -213,6 +223,10 @@ module Mongo
       @primary_pool.port
     end
 
+    def host_port
+      [@host, @port]
+    end
+
     # Fsync, then lock the mongod process against writes. Use this to get
     # the datafiles in a state safe for snapshotting, backing up, etc.
     #
@@ -415,7 +429,6 @@ module Mongo
       self["admin"].command({:buildinfo => 1})
     end
 
-
     # Get the build version of the current server.
     #
     # @return [Mongo::ServerVersion]
@@ -431,6 +444,10 @@ module Mongo
       @slave_ok
     end
 
+    def mongos?
+      @mongos
+    end
+
     # Create a new socket and attempt to connect to master.
     # If successful, sets host and port to master and returns the socket.
     #
@@ -441,7 +458,8 @@ module Mongo
     def connect
       close
 
-      config = check_is_master(@host_to_try)
+      config = check_is_master(host_port)
+
       if config
         if config['ismaster'] == 1 || config['ismaster'] == true
           @read_primary = true
@@ -449,15 +467,22 @@ module Mongo
           @read_primary = false
         end
 
+        if config.has_key?('msg') && config['msg'] == 'isdbgrid'
+          @mongos = true
+        end
+
         @max_bson_size = config['maxBsonObjectSize'] || Mongo::DEFAULT_MAX_BSON_SIZE
-        set_primary(@host_to_try)
+        set_primary(host_port)
       end
 
       if !connected?
-        raise ConnectionFailure, "Failed to connect to a master node at #{@host_to_try[0]}:#{@host_to_try[1]}"
+        raise ConnectionFailure, "Failed to connect to a master node at #{host_port.join(":")}"
       end
     end
-    alias :reconnect :connect
+
+    # Ensures that the alias carries over to the overridden connect method when using
+    # the replica set or sharded clients.
+    def reconnect; connect end
 
     # It's possible that we defined connected as all nodes being connected???
     # NOTE: Do check if this needs to be more stringent.
@@ -489,7 +514,10 @@ module Mongo
     def read_primary?
       @read_primary
     end
-    alias :primary? :read_primary?
+
+    # Ensures that the alias carries over to the overridden connect method when using
+    # the replica set or sharded clients.
+    def primary?; read_primary? end
 
     # The socket pool that this connection reads from.
     #
@@ -498,15 +526,6 @@ module Mongo
       @primary_pool
     end
 
-    # The value of the read preference.
-    def read_preference
-      if slave_ok?
-        :secondary_preferred
-      else
-        :primary
-      end
-    end
-
     # Close the connection to the database.
     def close
       @primary_pool.close if @primary_pool
@@ -550,6 +569,7 @@ module Mongo
       GENERIC_OPTS +
       CLIENT_ONLY_OPTS +
       POOL_OPTS +
+      READ_PREFERENCE_OPTS +
       WRITE_CONCERN_OPTS +
       TIMEOUT_OPTS
     end
@@ -564,13 +584,15 @@ module Mongo
 
     # Parse option hash
     def setup(opts)
-      # slave_ok can be true only if one node is specified
       @slave_ok = opts.delete(:slave_ok)
 
-      # Determine whether to use SSL.
       @ssl = opts.delete(:ssl)
+      @unix = @host ? @host.end_with?('.sock') : false
+
       if @ssl
         @socket_class = Mongo::SSLSocket
+      elsif @unix
+        @socket_class = Mongo::UNIXSocket
       else
         @socket_class = Mongo::TCPSocket
       end
@@ -590,41 +612,47 @@ module Mongo
       @op_timeout = opts.delete(:op_timeout) || nil
 
       # Timeout on socket connect.
-      @connect_timeout = opts.delete(:connect_timeout) || nil
+      @connect_timeout = opts.delete(:connect_timeout) || 30
 
-      @logger = opts.fetch(:logger, nil)
-
-      # Connection level write concern options.
-      @write_concern = get_write_concern(opts)
+      @logger = opts.delete(:logger) || nil
 
       if @logger
         write_logging_startup_message
       end
 
-      if opts.fetch(:connect, true)
-        connect
+      # Determine read preference
+      if defined?(@slave_ok) && (@slave_ok) || defined?(@read_secondary) && @read_secondary
+        @read = :secondary_preferred
+      else
+        @read = opts.delete(:read) || :primary
       end
-    end
+      Mongo::ReadPreference::validate(@read)
 
-    private
+      @tag_sets = opts.delete(:tag_sets) || []
+      @acceptable_latency = opts.delete(:secondary_acceptable_latency_ms) || 15
 
-    ## Methods for establishing a connection:
+      # Connection level write concern options.
+      @write_concern = get_write_concern(opts)
 
-    # If a ConnectionFailure is raised, this method will be called
-    # to close the connection and reset connection values.
-    # TODO: evaluate whether this method is actually necessary
-    def reset_connection
-      close
+      connect if opts.fetch(:connect, true)
     end
 
+    private
+
     def check_is_master(node)
       begin
         host, port = *node
         socket = nil
         config = nil
 
-        socket = @socket_class.new(host, port, @op_timeout, @connect_timeout) 
-        config = self['admin'].command({:ismaster => 1}, :socket => socket)
+        socket = @socket_class.new(host, port, @op_timeout, @connect_timeout)
+        if(@connect_timeout)
+          Timeout::timeout(@connect_timeout, OperationTimeout) do
+            config = self['admin'].command({:ismaster => 1}, :socket => socket)
+          end
+        else
+          config = self['admin'].command({:ismaster => 1}, :socket => socket)
+        end
       rescue OperationFailure, SocketError, SystemCallError, IOError
         close
       ensure