pahagon-mongo-abd 0.14.1

data/lib/mongo/connection.rb

@@ -0,0 +1,151 @@
+# --
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# 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.
+# ++
+
+require 'mongo/db'
+
+module Mongo
+
+  # A connection to MongoDB.
+  class Connection
+
+    DEFAULT_PORT = 27017
+
+    # Create a Mongo database server instance. You specify either one or a
+    # pair of servers. If one, you also say if connecting to a slave is
+    # OK. In either case, the host default is "localhost" and port default
+    # is DEFAULT_PORT.
+    #
+    # If you specify a pair, pair_or_host is a hash with two keys :left
+    # and :right. Each key maps to either
+    # * a server name, in which case port is DEFAULT_PORT
+    # * a port number, in which case server is "localhost"
+    # * an array containing a server name and a port number in that order
+    #
+    # +options+ are passed on to each DB instance:
+    #
+    # :slave_ok :: Only used if one host is specified. If false, when
+    #              connecting to that host/port a DB object will check to
+    #              see if the server is the master. If it is not, an error
+    #              is thrown.
+    #
+    # :auto_reconnect :: If a DB connection gets closed (for example, we
+    #                    have a server pair and saw the "not master"
+    #                    error, which closes the connection), then
+    #                    automatically try to reconnect to the master or
+    #                    to the single server we have been given. Defaults
+    #                    to +false+.
+    # :logger :: Optional Logger instance to which driver usage information
+    #            will be logged.
+    #
+    # Since that's so confusing, here are a few examples:
+    #
+    #  Connection.new                         # localhost, DEFAULT_PORT, !slave
+    #  Connection.new("localhost")            # localhost, DEFAULT_PORT, !slave
+    #  Connection.new("localhost", 3000)      # localhost, 3000, slave not ok
+    #  # localhost, 3000, slave ok
+    #  Connection.new("localhost", 3000, :slave_ok => true)
+    #  # localhost, DEFAULT_PORT, auto reconnect
+    #  Connection.new(nil, nil, :auto_reconnect => true)
+    #
+    #  # A pair of servers. DB will always talk to the master. On socket
+    #  # error or "not master" error, we will auto-reconnect to the
+    #  # current master.
+    #  Connection.new({:left  => ["db1.example.com", 3000],
+    #             :right => "db2.example.com"}, # DEFAULT_PORT
+    #            nil, :auto_reconnect => true)
+    #
+    #  # Here, :right is localhost/DEFAULT_PORT. No auto-reconnect.
+    #  Connection.new({:left => ["db1.example.com", 3000]})
+    #
+    # When a DB object first connects to a pair, it will find the master
+    # instance and connect to that one.
+    def initialize(pair_or_host=nil, port=nil, options={})
+      @pair = case pair_or_host
+               when String
+                 [[pair_or_host, port ? port.to_i : DEFAULT_PORT]]
+               when Hash
+                connections = []
+                connections << pair_val_to_connection(pair_or_host[:left])
+                connections << pair_val_to_connection(pair_or_host[:right])
+                connections
+               when nil
+                 [['localhost', DEFAULT_PORT]]
+               end
+
+      @options = options
+    end
+
+    # Return the Mongo::DB named +db_name+. The slave_ok and
+    # auto_reconnect options passed in via #new may be overridden here.
+    # See DB#new for other options you can pass in.
+    def db(db_name, options={})
+      DB.new(db_name, @pair, @options.merge(options))
+    end
+
+    # Returns a hash containing database names as keys and disk space for
+    # each as values.
+    def database_info
+      doc = single_db_command('admin', :listDatabases => 1)
+      h = {}
+      doc['databases'].each { |db|
+        h[db['name']] = db['sizeOnDisk'].to_i
+      }
+      h
+    end
+
+    # Returns an array of database names.
+    def database_names
+      database_info.keys
+    end
+
+    # Drops the database +name+.
+    def drop_database(name)
+      single_db_command(name, :dropDatabase => 1)
+    end
+
+    protected
+
+    # Turns an array containing a host name string and a
+    # port number integer into a [host, port] pair array.
+    def pair_val_to_connection(a)
+      case a
+      when nil
+        ['localhost', DEFAULT_PORT]
+      when String
+        [a, DEFAULT_PORT]
+      when Integer
+        ['localhost', a]
+      when Array
+        a
+      end
+    end
+
+    # Send cmd (a hash, possibly ordered) to the admin database and return
+    # the answer. Raises an error unless the return is "ok" (DB#ok?
+    # returns +true+).
+    def single_db_command(db_name, cmd)
+      db = nil
+      begin
+        db = db(db_name)
+        doc = db.db_command(cmd)
+        raise "error retrieving database info: #{doc.inspect}" unless db.ok?(doc)
+        doc
+      ensure
+        db.close if db
+      end
+    end
+  end
+end

data/lib/mongo/cursor.rb

@@ -0,0 +1,279 @@
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# 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.
+
+require 'mongo/message'
+require 'mongo/util/byte_buffer'
+require 'mongo/util/bson'
+
+module Mongo
+
+  # A cursor over query results. Returned objects are hashes.
+  class Cursor
+
+    include Enumerable
+
+    RESPONSE_HEADER_SIZE = 20
+
+    attr_reader :db, :collection, :query
+
+    # Create a new cursor.
+    #
+    # Should not be called directly by application developers.
+    def initialize(db, collection, query, admin=false)
+      @db, @collection, @query, @admin = db, collection, query, admin
+      @cache = []
+      @closed = false
+      @query_run = false
+    end
+
+    # Return the next object or nil if there are no more. Raises an error
+    # if necessary.
+    def next_object
+      refill_via_get_more if num_remaining == 0
+      o = @cache.shift
+
+      if o && o['$err']
+        err = o['$err']
+
+        # If the server has stopped being the master (e.g., it's one of a
+        # pair but it has died or something like that) then we close that
+        # connection. If the db has auto connect option and a pair of
+        # servers, next request will re-open on master server.
+        @db.close if err == "not master"
+
+        raise err
+      end
+
+      o
+    end
+
+    # Get the size of the results set for this query.
+    #
+    # Returns the number of objects in the results set for this query. Does
+    # not take limit and skip into account. Raises OperationFailure on a
+    # database error.
+    def count
+      command = OrderedHash["count", @collection.name,
+                            "query", @query.selector,
+                            "fields", @query.fields()]
+      response = @db.db_command(command)
+      return response['n'].to_i if response['ok'] == 1
+      return 0 if response['errmsg'] == "ns missing"
+      raise OperationFailure, "Count failed: #{response['errmsg']}"
+    end
+
+    # Sort this cursor's result
+    #
+    # Takes either a hash of field names as keys and 1/-1 as values; 1 ==
+    # ascending, -1 == descending, or array of field names (all assumed to be
+    # sorted in ascending order).
+    #
+    # Raises InvalidOperation if this cursor has already been used.
+    #
+    # This method overrides any sort order specified in the Collection#find
+    # method, and only the last sort applied has an effect
+    def sort(order)
+      check_modifiable
+      @query.order_by = order
+      self
+    end
+
+    # Limits the number of results to be returned by this cursor.
+    #
+    # Raises InvalidOperation if this cursor has already been used.
+    #
+    # This method overrides any limit specified in the Collection#find method,
+    # and only the last limit applied has an effect.
+    def limit(number_to_return)
+      check_modifiable
+      raise ArgumentError, "limit requires an integer" unless number_to_return.is_a? Integer
+
+      @query.number_to_return = number_to_return
+      self
+    end
+
+    # Skips the first +number_to_skip+ results of this cursor.
+    #
+    # Raises InvalidOperation if this cursor has already been used.
+    #
+    # This method overrides any skip specified in the Collection#find method,
+    # and only the last skip applied has an effect.
+    def skip(number_to_skip)
+      check_modifiable
+      raise ArgumentError, "skip requires an integer" unless number_to_skip.is_a? Integer
+
+      @query.number_to_skip = number_to_skip
+      self
+    end
+
+    # Iterate over each document in this cursor, yielding it to the given
+    # block.
+    #
+    # Iterating over an entire cursor will close it.
+    def each
+      num_returned = 0
+      while more? && (@query.number_to_return <= 0 || num_returned < @query.number_to_return)
+        yield next_object()
+        num_returned += 1
+      end
+    end
+
+    # Return all of the documents in this cursor as an array of hashes.
+    #
+    # Raises InvalidOperation if this cursor has already been used (including
+    # any previous calls to this method).
+    #
+    # Use of this method is discouraged - iterating over a cursor is much
+    # more efficient in most cases.
+    def to_a
+      raise InvalidOperation, "can't call Cursor#to_a on a used cursor" if @query_run
+      rows = []
+      num_returned = 0
+      while more? && (@query.number_to_return <= 0 || num_returned < @query.number_to_return)
+        rows << next_object()
+        num_returned += 1
+      end
+      rows
+    end
+
+    # Returns an explain plan record for this cursor.
+    def explain
+      limit = @query.number_to_return
+      @query.explain = true
+      @query.number_to_return = -limit.abs
+
+      c = Cursor.new(@db, @collection, @query)
+      explanation = c.next_object
+      c.close
+
+      @query.explain = false
+      @query.number_to_return = limit
+      explanation
+    end
+
+    # Close the cursor.
+    #
+    # Note: if a cursor is read until exhausted (read until OP_QUERY or
+    # OP_GETMORE returns zero for the cursor id), there is no need to
+    # close it by calling this method.
+    #
+    # Collection#find takes an optional block argument which can be used to
+    # ensure that your cursors get closed. See the documentation for
+    # Collection#find for details.
+    def close
+      @db.send_to_db(KillCursorsMessage.new(@cursor_id)) if @cursor_id
+      @cache = []
+      @cursor_id = 0
+      @closed = true
+    end
+
+    # Returns true if this cursor is closed, false otherwise.
+    def closed?; @closed; end
+
+    private
+
+    def read_all
+      read_message_header
+      read_response_header
+      read_objects_off_wire
+    end
+
+    def read_objects_off_wire
+      while doc = next_object_on_wire
+        @cache << doc
+      end
+    end
+
+    def read_message_header
+      MessageHeader.new.read_header(@db)
+    end
+
+    def read_response_header
+      header_buf = ByteBuffer.new
+      header_buf.put_array(@db.receive_full(RESPONSE_HEADER_SIZE).unpack("C*"))
+      raise "Short read for DB response header; expected #{RESPONSE_HEADER_SIZE} bytes, saw #{header_buf.length}" unless header_buf.length == RESPONSE_HEADER_SIZE
+      header_buf.rewind
+      @result_flags = header_buf.get_int
+      @cursor_id = header_buf.get_long
+      @starting_from = header_buf.get_int
+      @n_returned = header_buf.get_int
+      @n_remaining = @n_returned
+    end
+
+    def num_remaining
+      refill_via_get_more if @cache.length == 0
+      @cache.length
+    end
+
+    # Internal method, not for general use. Return +true+ if there are
+    # more records to retrieve. We do not check @query.number_to_return;
+    # #each is responsible for doing that.
+    def more?
+      num_remaining > 0
+    end
+
+    def next_object_on_wire
+      # if @n_remaining is 0 but we have a non-zero cursor, there are more
+      # to fetch, so do a GetMore operation, but don't do it here - do it
+      # when someone pulls an object out of the cache and it's empty
+      return nil if @n_remaining == 0
+      object_from_stream
+    end
+
+    def refill_via_get_more
+      if send_query_if_needed or @cursor_id == 0
+        return
+      end
+      @db._synchronize {
+        @db.send_to_db(GetMoreMessage.new(@admin ? 'admin' : @db.name, @collection.name, @cursor_id))
+        read_all
+      }
+    end
+
+    def object_from_stream
+      buf = ByteBuffer.new
+      buf.put_array(@db.receive_full(4).unpack("C*"))
+      buf.rewind
+      size = buf.get_int
+      buf.put_array(@db.receive_full(size - 4).unpack("C*"), 4)
+      @n_remaining -= 1
+      buf.rewind
+      BSON.new.deserialize(buf)
+    end
+
+    def send_query_if_needed
+      # Run query first time we request an object from the wire
+      if @query_run
+        false
+      else
+        @db._synchronize {
+          @db.send_query_message(QueryMessage.new(@admin ? 'admin' : @db.name, @collection.name, @query))
+          @query_run = true
+          read_all
+        }
+        true
+      end
+    end
+
+    def to_s
+      "DBResponse(flags=#@result_flags, cursor_id=#@cursor_id, start=#@starting_from, n_returned=#@n_returned)"
+    end
+
+    def check_modifiable
+      if @query_run || @closed
+        raise InvalidOperation, "Cannot modify the query once it has been run or closed."
+      end
+    end
+  end
+end

data/lib/mongo/db.rb

@@ -0,0 +1,560 @@
+# --
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# 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.
+# ++
+
+require 'socket'
+require 'digest/md5'
+require 'mutex_m'
+require 'mongo/collection'
+require 'mongo/message'
+require 'mongo/query'
+require 'mongo/util/ordered_hash.rb'
+require 'mongo/admin'
+
+module Mongo
+
+  # A Mongo database.
+  class DB
+
+    SYSTEM_NAMESPACE_COLLECTION = "system.namespaces"
+    SYSTEM_INDEX_COLLECTION = "system.indexes"
+    SYSTEM_PROFILE_COLLECTION = "system.profile"
+    SYSTEM_USER_COLLECTION = "system.users"
+    SYSTEM_COMMAND_COLLECTION = "$cmd"
+
+    # Strict mode enforces collection existence checks. When +true+,
+    # asking for a collection that does not exist or trying to create a
+    # collection that already exists raises an error.
+    #
+    # Strict mode is off (+false+) by default. Its value can be changed at
+    # any time.
+    attr_writer :strict
+
+    # Returns the value of the +strict+ flag.
+    def strict?; @strict; end
+
+    # The name of the database.
+    attr_reader :name
+
+    # Host to which we are currently connected.
+    attr_reader :host
+    # Port to which we are currently connected.
+    attr_reader :port
+
+    # An array of [host, port] pairs.
+    attr_reader :nodes
+
+    # The database's socket. For internal (and Cursor) use only.
+    attr_reader :socket
+
+    def slave_ok?; @slave_ok; end
+    def auto_reconnect?; @auto_reconnect; end
+
+    # A primary key factory object (or +nil+). See the README.doc file or
+    # DB#new for details.
+    attr_reader :pk_factory
+
+    def pk_factory=(pk_factory)
+      raise "error: can not change PK factory" if @pk_factory
+      @pk_factory = pk_factory
+    end
+
+    # Instances of DB are normally obtained by calling Mongo#db.
+    #
+    # db_name :: The database name
+    #
+    # nodes :: An array of [host, port] pairs. See Connection#new, which offers
+    #          a more flexible way of defining nodes.
+    #
+    # options :: A hash of options.
+    #
+    # Options:
+    #
+    # :strict :: If true, collections must exist to be accessed and must
+    #            not exist to be created. See #collection and
+    #            #create_collection.
+    #
+    # :pk :: A primary key factory object that must respond to :create_pk,
+    #        which should take a hash and return a hash which merges the
+    #        original hash with any primary key fields the factory wishes
+    #        to inject. (NOTE: if the object already has a primary key,
+    #        the factory should not inject a new key; this means that the
+    #        object is being used in a repsert but it already exists.) The
+    #        idea here is that when ever a record is inserted, the :pk
+    #        object's +create_pk+ method will be called and the new hash
+    #        returned will be inserted.
+    #
+    # :slave_ok :: Only used if +nodes+ contains only one host/port. If
+    #              false, when connecting to that host/port we check to
+    #              see if the server is the master. If it is not, an error
+    #              is thrown.
+    #
+    # :auto_reconnect :: If the connection gets closed (for example, we
+    #                    have a server pair and saw the "not master"
+    #                    error, which closes the connection), then
+    #                    automatically try to reconnect to the master or
+    #                    to the single server we have been given. Defaults
+    #                    to +false+.
+    # :logger :: Optional Logger instance to which driver usage information
+    #            will be logged.
+    #
+    # When a DB object first connects to a pair, it will find the master
+    # instance and connect to that one. On socket error or if we recieve a
+    # "not master" error, we again find the master of the pair.
+    def initialize(db_name, nodes, options={})
+      case db_name
+      when Symbol, String
+      else
+        raise TypeError, "db_name must be a string or symbol"
+      end
+
+      [" ", ".", "$", "/", "\\"].each do |invalid_char|
+        if db_name.include? invalid_char
+          raise InvalidName, "database names cannot contain the character '#{invalid_char}'"
+        end
+      end
+      if db_name.empty?
+        raise InvalidName, "database name cannot be the empty string"
+      end
+
+      @name, @nodes = db_name, nodes
+      @strict = options[:strict]
+      @pk_factory = options[:pk]
+      @slave_ok = options[:slave_ok] && @nodes.length == 1 # only OK if one node
+      @auto_reconnect = options[:auto_reconnect]
+      @semaphore = Object.new
+      @semaphore.extend Mutex_m
+      @socket = nil
+      @logger = options[:logger]
+      connect_to_master
+    end
+
+    def connect_to_master
+      close if @socket
+      @host = @port = nil
+      @nodes.detect { |hp|
+        @host, @port = *hp
+        begin
+          @socket = TCPSocket.new(@host, @port)
+          @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+
+          # Check for master. Can't call master? because it uses mutex,
+          # which may already be in use during this call.
+          semaphore_is_locked = @semaphore.locked?
+          @semaphore.unlock if semaphore_is_locked
+          is_master = master?
+          @semaphore.lock if semaphore_is_locked
+
+          @slave_ok || is_master
+        rescue SocketError, SystemCallError, IOError => ex
+          close if @socket
+          false
+        end
+      }
+      raise "error: failed to connect to any given host:port" unless @socket
+    end
+
+    # Returns true if +username+ has +password+ in
+    # +SYSTEM_USER_COLLECTION+. +name+ is username, +password+ is
+    # plaintext password.
+    def authenticate(username, password)
+      doc = db_command(:getnonce => 1)
+      raise "error retrieving nonce: #{doc}" unless ok?(doc)
+      nonce = doc['nonce']
+
+      auth = OrderedHash.new
+      auth['authenticate'] = 1
+      auth['user'] = username
+      auth['nonce'] = nonce
+      auth['key'] = Digest::MD5.hexdigest("#{nonce}#{username}#{hash_password(username, password)}")
+      ok?(db_command(auth))
+    end
+
+    # Deauthorizes use for this database for this connection.
+    def logout
+      doc = db_command(:logout => 1)
+      raise "error logging out: #{doc.inspect}" unless ok?(doc)
+    end
+
+    # Returns an array of collection names in this database.
+    def collection_names
+      names = collections_info.collect { |doc| doc['name'] || '' }
+      names = names.delete_if {|name| name.index(@name).nil? || name.index('$')}
+      names.map {|name| name.sub(@name + '.', '')}
+    end
+
+    # Retruns an array of Collection instances, one for each collection in this
+    # database.
+    def collections
+      collection_names.map do |collection_name|
+        Collection.new(self, collection_name)
+      end
+    end
+
+    # Returns a cursor over query result hashes. Each hash contains a
+    # 'name' string and optionally an 'options' hash. If +coll_name+ is
+    # specified, an array of length 1 is returned.
+    def collections_info(coll_name=nil)
+      selector = {}
+      selector[:name] = full_coll_name(coll_name) if coll_name
+      query(Collection.new(self, SYSTEM_NAMESPACE_COLLECTION), Query.new(selector))
+    end
+
+    # Create a collection. If +strict+ is false, will return existing or
+    # new collection. If +strict+ is true, will raise an error if
+    # collection +name+ already exists.
+    #
+    # Options is an optional hash:
+    #
+    # :capped :: Boolean. If not specified, capped is +false+.
+    #
+    # :size :: If +capped+ is +true+, specifies the maximum number of
+    #          bytes. If +false+, specifies the initial extent of the
+    #          collection.
+    #
+    # :max :: Max number of records in a capped collection. Optional.
+    def create_collection(name, options={})
+      # First check existence
+      if collection_names.include?(name)
+        if strict?
+          raise "Collection #{name} already exists. Currently in strict mode."
+        else
+          return Collection.new(self, name)
+        end
+      end
+
+      # Create new collection
+      oh = OrderedHash.new
+      oh[:create] = name
+      doc = db_command(oh.merge(options || {}))
+      ok = doc['ok']
+      return Collection.new(self, name) if ok.kind_of?(Numeric) && (ok.to_i == 1 || ok.to_i == 0)
+      raise "Error creating collection: #{doc.inspect}"
+    end
+
+    def admin
+      Admin.new(self)
+    end
+
+    # Return a collection. If +strict+ is false, will return existing or
+    # new collection. If +strict+ is true, will raise an error if
+    # collection +name+ does not already exists.
+    def collection(name)
+      return Collection.new(self, name) if !strict? || collection_names.include?(name)
+      raise "Collection #{name} doesn't exist. Currently in strict mode."
+    end
+    alias_method :[], :collection
+
+    # Drop collection +name+. Returns +true+ on success or if the
+    # collection does not exist, +false+ otherwise.
+    def drop_collection(name)
+      return true unless collection_names.include?(name)
+
+      ok?(db_command(:drop => name))
+    end
+
+    # Returns the error message from the most recently executed database
+    # operation for this connection, or +nil+ if there was no error.
+    #
+    # Note: as of this writing, errors are only detected on the db server
+    # for certain kinds of operations (writes). The plan is to change this
+    # so that all operations will set the error if needed.
+    def error
+      doc = db_command(:getlasterror => 1)
+      raise "error retrieving last error: #{doc}" unless ok?(doc)
+      doc['err']
+    end
+
+    # Returns +true+ if an error was caused by the most recently executed
+    # database operation.
+    #
+    # Note: as of this writing, errors are only detected on the db server
+    # for certain kinds of operations (writes). The plan is to change this
+    # so that all operations will set the error if needed.
+    def error?
+      error != nil
+    end
+
+    # Get the most recent error to have occured on this database
+    #
+    # Only returns errors that have occured since the last call to
+    # DB#reset_error_history - returns +nil+ if there is no such error.
+    def previous_error
+      error = db_command(:getpreverror => 1)
+      if error["err"]
+        error
+      else
+        nil
+      end
+    end
+
+    # Reset the error history of this database
+    #
+    # Calls to DB#previous_error will only return errors that have occurred
+    # since the most recent call to this method.
+    def reset_error_history
+      db_command(:reseterror => 1)
+    end
+
+    # Returns true if this database is a master (or is not paired with any
+    # other database), false if it is a slave.
+    def master?
+      doc = db_command(:ismaster => 1)
+      is_master = doc['ismaster']
+      ok?(doc) && is_master.kind_of?(Numeric) && is_master.to_i == 1
+    end
+
+    # Returns a string of the form "host:port" that points to the master
+    # database. Works even if this is the master database.
+    def master
+      doc = db_command(:ismaster => 1)
+      is_master = doc['ismaster']
+      raise "Error retrieving master database: #{doc.inspect}" unless ok?(doc) && is_master.kind_of?(Numeric)
+      case is_master.to_i
+      when 1
+        "#@host:#@port"
+      else
+        doc['remote']
+      end
+    end
+
+    # Close the connection to the database.
+    def close
+      if @socket
+        s = @socket
+        @socket = nil
+        s.close
+      end
+    end
+
+    def connected?
+      @socket != nil
+    end
+
+    def receive_full(length)
+      message = ""
+      while message.length < length do
+        chunk = @socket.recv(length - message.length)
+        raise "connection closed" unless chunk.length > 0
+        message += chunk
+      end
+      message
+    end
+
+    # Send a MsgMessage to the database.
+    def send_message(msg)
+      send_to_db(MsgMessage.new(msg))
+    end
+
+    # Returns a Cursor over the query results.
+    #
+    # Note that the query gets sent lazily; the cursor calls
+    # #send_query_message when needed. If the caller never requests an
+    # object from the cursor, the query never gets sent.
+    def query(collection, query, admin=false)
+      Cursor.new(self, collection, query, admin)
+    end
+
+    # Used by a Cursor to lazily send the query to the database.
+    def send_query_message(query_message)
+      send_to_db(query_message)
+    end
+
+    # Remove the records that match +selector+ from +collection_name+.
+    # Normally called by Collection#remove or Collection#clear.
+    def remove_from_db(collection_name, selector)
+      _synchronize {
+        send_to_db(RemoveMessage.new(@name, collection_name, selector))
+      }
+    end
+
+    # Update records in +collection_name+ that match +selector+ by
+    # applying +obj+ as an update. Normally called by Collection#replace.
+    def replace_in_db(collection_name, selector, obj)
+      _synchronize {
+        send_to_db(UpdateMessage.new(@name, collection_name, selector, obj, false))
+      }
+    end
+
+    # Update records in +collection_name+ that match +selector+ by
+    # applying +obj+ as an update. If no match, inserts (???). Normally
+    # called by Collection#repsert.
+    def repsert_in_db(collection_name, selector, obj)
+      _synchronize {
+        obj = @pk_factory.create_pk(obj) if @pk_factory
+        send_to_db(UpdateMessage.new(@name, collection_name, selector, obj, true))
+        obj
+      }
+    end
+
+    # Dereference a DBRef, getting the document it points to.
+    def dereference(dbref)
+      collection(dbref.namespace).find_one("_id" => dbref.object_id)
+    end
+
+    # Evaluate a JavaScript expression on MongoDB.
+    # +code+ should be a string or Code instance containing a JavaScript
+    # expression. Additional arguments will be passed to that expression
+    # when it is run on the server.
+    def eval(code, *args)
+      if not code.is_a? Code
+        code = Code.new(code)
+      end
+
+      oh = OrderedHash.new
+      oh[:$eval] = code
+      oh[:args] = args
+      doc = db_command(oh)
+      return doc['retval'] if ok?(doc)
+      raise OperationFailure, "eval failed: #{doc['errmsg']}"
+    end
+
+    # Rename collection +from+ to +to+. Meant to be called by
+    # Collection#rename.
+    def rename_collection(from, to)
+      oh = OrderedHash.new
+      oh[:renameCollection] = "#{@name}.#{from}"
+      oh[:to] = "#{@name}.#{to}"
+      doc = db_command(oh, true)
+      raise "Error renaming collection: #{doc.inspect}" unless ok?(doc)
+    end
+
+    # Drop index +name+ from +collection_name+. Normally called from
+    # Collection#drop_index or Collection#drop_indexes.
+    def drop_index(collection_name, name)
+      oh = OrderedHash.new
+      oh[:deleteIndexes] = collection_name
+      oh[:index] = name
+      doc = db_command(oh)
+      raise "Error with drop_index command: #{doc.inspect}" unless ok?(doc)
+    end
+
+    # Get information on the indexes for the collection +collection_name+.
+    # Normally called by Collection#index_information. Returns a hash where
+    # the keys are index names (as returned by Collection#create_index and
+    # the values are lists of [key, direction] pairs specifying the index
+    # (as passed to Collection#create_index).
+    def index_information(collection_name)
+      sel = {:ns => full_coll_name(collection_name)}
+      info = {}
+      query(Collection.new(self, SYSTEM_INDEX_COLLECTION), Query.new(sel)).each { |index|
+        info[index['name']] = index['key'].to_a
+      }
+      info
+    end
+
+    # Create a new index on +collection_name+. +field_or_spec+
+    # should be either a single field name or a Array of [field name,
+    # direction] pairs. Directions should be specified as
+    # Mongo::ASCENDING or Mongo::DESCENDING. Normally called
+    # by Collection#create_index. If +unique+ is true the index will
+    # enforce a uniqueness constraint.
+    def create_index(collection_name, field_or_spec, unique=false)
+      field_h = OrderedHash.new
+      if field_or_spec.is_a?(String) || field_or_spec.is_a?(Symbol)
+        field_h[field_or_spec.to_s] = 1
+      else
+        field_or_spec.each { |f| field_h[f[0].to_s] = f[1] }
+      end
+      name = gen_index_name(field_h)
+      sel = {
+        :name => name,
+        :ns => full_coll_name(collection_name),
+        :key => field_h,
+        :unique => unique
+      }
+      _synchronize {
+        send_to_db(InsertMessage.new(@name, SYSTEM_INDEX_COLLECTION, false, sel))
+      }
+      name
+    end
+
+    # Insert +objects+ into +collection_name+. Normally called by
+    # Collection#insert. Returns a new array containing the _ids
+    # of the inserted documents.
+    def insert_into_db(collection_name, objects)
+      _synchronize {
+        if @pk_factory
+          objects.collect! { |o|
+            @pk_factory.create_pk(o)
+          }
+        else
+          objects = objects.collect do |o|
+            o[:_id] || o['_id'] ? o : o.merge!(:_id => ObjectID.new)
+          end
+        end
+        send_to_db(InsertMessage.new(@name, collection_name, true, *objects))
+        objects.collect { |o| o[:_id] || o['_id'] }
+      }
+    end
+
+    def send_to_db(message)
+      connect_to_master if !connected? && @auto_reconnect
+      begin
+        @logger.debug("  MONGODB #{message}") if @logger
+        @socket.print(message.buf.to_s)
+        @socket.flush
+      rescue => ex
+        close
+        raise ex
+      end
+    end
+
+    def full_coll_name(collection_name)
+      "#{@name}.#{collection_name}"
+    end
+
+    # Return +true+ if +doc+ contains an 'ok' field with the value 1.
+    def ok?(doc)
+      ok = doc['ok']
+      ok.kind_of?(Numeric) && ok.to_i == 1
+    end
+
+    # DB commands need to be ordered, so selector must be an OrderedHash
+    # (or a Hash with only one element). What DB commands really need is
+    # that the "command" key be first.
+    #
+    # Do not call this. Intended for driver use only.
+    def db_command(selector, use_admin_db=false)
+      if !selector.kind_of?(OrderedHash)
+        if !selector.kind_of?(Hash) || selector.keys.length > 1
+          raise "db_command must be given an OrderedHash when there is more than one key"
+        end
+      end
+
+      q = Query.new(selector)
+      q.number_to_return = 1
+      query(Collection.new(self, SYSTEM_COMMAND_COLLECTION), q, use_admin_db).next_object
+    end
+
+    def _synchronize &block
+      @semaphore.synchronize &block
+    end
+
+    private
+
+    def hash_password(username, plaintext)
+      Digest::MD5.hexdigest("#{username}:mongo:#{plaintext}")
+    end
+
+    def gen_index_name(spec)
+      temp = []
+      spec.each_pair { |field, direction|
+        temp = temp.push("#{field}_#{direction}")
+      }
+      return temp.join("_")
+    end
+  end
+end