mongo 0.1.0 → 0.15

data/lib/mongo/collection.rb

@@ -1,153 +1,415 @@
 # --
 # Copyright (C) 2008-2009 10gen Inc.
 #
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Affero General Public License, version 3, as
-# published by the Free Software Foundation.
+# 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
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
-# for more details.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# 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/query'
 
-module XGen
-  module Mongo
-    module Driver
+module Mongo
 
-      # A named collection of records in a database.
-      class Collection
+  # A named collection of records in a database.
+  class Collection
 
-        attr_reader :db, :name, :hint_fields
+    attr_reader :db, :name, :hint
 
-        def initialize(db, name)
-          @db = db
-          @name = name
-        end
+    def initialize(db, name)
+      case name
+      when Symbol, String
+      else
+        raise TypeError, "new_name must be a string or symbol"
+      end
 
-        # Set hint fields to use and return +self+. hint_fields may be a
-        # single field name, array of field names, or a hash whose keys will
-        # become the hint field names. May be +nil+.
-        def hint(hint_fields)
-          @hint_fields = case hint_fields
-                         when String
-                           [hint_fields]
-                         when Hash
-                           hint_fields.keys
-                         when nil
-                           nil
-                         else
-                           hint_fields.to_a
-                         end
-          self
-        end
+      name = name.to_s
 
-        # Return records that match a +selector+ hash. See Mongo docs for
-        # details.
-        #
-        # Options:
-        # :fields :: Array of collection field names; only those will be returned (plus _id if defined)
-        # :offset :: Start at this record when returning records
-        # :limit :: Maximum number of records to return
-        # :sort :: Either 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).
-        def find(selector={}, options={})
-          fields = options.delete(:fields)
-          fields = nil if fields && fields.empty?
-          offset = options.delete(:offset) || 0
-          limit = options.delete(:limit) || 0
-          sort = options.delete(:sort)
-          raise RuntimeError, "Unknown options [#{options.inspect}]" unless options.empty?
-          @db.query(self, Query.new(selector, fields, offset, limit, sort))
-        end
+      if name.empty? or name.include? ".."
+        raise InvalidName, "collection names cannot be empty"
+      end
+      if name.include? "$" and not name.match(/^\$cmd/)
+        raise InvalidName, "collection names must not contain '$'"
+      end
+      if name.match(/^\./) or name.match(/\.$/)
+        raise InvalidName, "collection names must not start or end with '.'"
+      end
 
-        # Insert +objects+, which are hashes. "<<" is aliased to this method.
-        def insert(*objects)
-          objects = objects.first if objects.size == 1 && objects.first.is_a?(Array)
-          res = @db.insert_into_db(@name, objects)
-          res.size > 1 ? res : res.first
-        end
-        alias_method :<<, :insert
+      @db, @name = db, name
+      @hint = nil
+    end
 
-        # Remove the records that match +selector+.
-        def remove(selector={})
-          @db.remove_from_db(@name, selector)
-        end
+    # Get a sub-collection of this collection by name.
+    #
+    # Raises InvalidName if an invalid collection name is used.
+    #
+    # :name :: the name of the collection to get
+    def [](name)
+      name = "#{self.name}.#{name}"
+      return Collection.new(db, name) if !db.strict? || db.collection_names.include?(name)
+      raise "Collection #{name} doesn't exist. Currently in strict mode."
+    end
 
-        # Remove all records.
-        def clear
-          remove({})
-        end
+    # Set hint fields to use and return +self+. hint may be a single field
+    # name, array of field names, or a hash (preferably an OrderedHash).
+    # May be +nil+.
+    def hint=(hint)
+      @hint = normalize_hint_fields(hint)
+      self
+    end
 
-        # Update records that match +selector+ by applying +obj+ as an update.
-        # If no match, inserts (???).
-        def repsert(selector, obj)
-          @db.repsert_in_db(@name, selector, obj)
-        end
+    # Query the database.
+    #
+    # The +selector+ argument is a prototype document that all results must
+    # match. For example:
+    #
+    # collection.find({"hello" => "world"})
+    #
+    # only matches documents that have a key "hello" with value "world".
+    # Matches can have other keys *in addition* to "hello".
+    #
+    # If given an optional block +find+ will yield a Cursor to that block,
+    # close the cursor, and then return nil. This guarantees that partially
+    # evaluated cursors will be closed. If given no block +find+ returns a
+    # cursor.
+    #
+    # :selector :: A document (hash) specifying elements which must be
+    #              present for a document to be included in the result set.
+    #
+    # Options:
+    # :fields :: Array of field names that should be returned in the result
+    #            set ("_id" will always be included). By limiting results
+    #            to a certain subset of fields you can cut down on network
+    #            traffic and decoding time.
+    # :skip :: Number of documents to omit (from the start of the result set)
+    #          when returning the results
+    # :limit :: Maximum number of records to return
+    # :sort :: Either 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).
+    # :hint :: See #hint. This option overrides the collection-wide value.
+    # :snapshot :: If true, snapshot mode will be used for this query.
+    #              Snapshot mode assures no duplicates are returned, or
+    #              objects missed, which were preset at both the start and
+    #              end of the query's execution. For details see
+    #              http://www.mongodb.org/display/DOCS/How+to+do+Snapshotting+in+the+Mongo+Database
+    def find(selector={}, options={})
+      fields = options.delete(:fields)
+      fields = ["_id"] if fields && fields.empty?
+      skip = options.delete(:offset) || nil
+      if !skip.nil?
+        warn "the :offset option to find is deprecated and will be removed. please use :skip instead"
+      end
+      skip = options.delete(:skip) || skip || 0
+      limit = options.delete(:limit) || 0
+      sort = options.delete(:sort)
+      hint = options.delete(:hint)
+      snapshot = options.delete(:snapshot)
+      if hint
+        hint = normalize_hint_fields(hint)
+      else
+        hint = @hint        # assumed to be normalized already
+      end
+      raise RuntimeError, "Unknown options [#{options.inspect}]" unless options.empty?
 
-        # Update records that match +selector+ by applying +obj+ as an update.
-        def replace(selector, obj)
-          @db.replace_in_db(@name, selector, obj)
-        end
+      cursor = @db.query(self, Query.new(selector, fields, skip, limit, sort, hint, snapshot))
+      if block_given?
+        yield cursor
+        cursor.close()
+        nil
+      else
+        cursor
+      end
+    end
 
-        # Update records that match +selector+ by applying +obj+ as an update.
-        # Both +selector+ and +modifier_obj+ are required.
-        def modify(selector, modifier_obj)
-          raise "no object" unless modifier_obj
-          raise "no selector" unless selector
-          @db.modify_in_db(@name, selector, modifier_obj)
-        end
+    # Get a single object from the database.
+    #
+    # Raises TypeError if the argument is of an improper type. Returns a
+    # single document (hash), or nil if no result is found.
+    #
+    # :spec_or_object_id :: a hash specifying elements which must be
+    #   present for a document to be included in the result set OR an
+    #   instance of ObjectID to be used as the value for an _id query.
+    #   if nil an empty spec, {}, will be used.
+    # :options :: options, as passed to Collection#find
+    def find_one(spec_or_object_id=nil, options={})
+      spec = case spec_or_object_id
+             when nil
+               {}
+             when ObjectID
+               {:_id => spec_or_object_id}
+             when Hash
+               spec_or_object_id
+             else
+               raise TypeError, "spec_or_object_id must be an instance of ObjectID or Hash, or nil"
+             end
+      find(spec, options.merge(:limit => -1)).next_object
+    end
 
-        # Create a new index named +index_name+. +fields+ should be an array
-        # of field names.
-        def create_index(name, *fields)
-          @db.create_index(@name, name, fields)
-        end
+    # Save a document in this collection.
+    #
+    # If +to_save+ already has an '_id' then an update (upsert) operation
+    # is performed and any existing document with that _id is overwritten.
+    # Otherwise an insert operation is performed. Returns the _id of the
+    # saved document.
+    #
+    # :to_save :: the document (a hash) to be saved
+    #
+    # Options:
+    # :safe :: if true, check that the save succeeded. OperationFailure
+    #   will be raised on an error. Checking for safety requires an extra
+    #   round-trip to the database
+    def save(to_save, options={})
+      if id = to_save[:_id] || to_save['_id']
+        update({:_id => id}, to_save, :upsert => true, :safe => options.delete(:safe))
+        id
+      else
+        insert(to_save, :safe => options.delete(:safe))
+      end
+    end
 
-        # Drop index +name+.
-        def drop_index(name)
-          @db.drop_index(@name, name)
+    # Insert a document(s) into this collection.
+    #
+    # "<<" is aliased to this method. Returns the _id of the inserted
+    # document or a list of _ids of the inserted documents. The object(s)
+    # may have been modified by the database's PK factory, if it has one.
+    #
+    # :doc_or_docs :: a document (as a hash) or Array of documents to be
+    #   inserted
+    #
+    # Options:
+    # :safe :: if true, check that the insert succeeded. OperationFailure
+    #   will be raised on an error. Checking for safety requires an extra
+    #   round-trip to the database
+    def insert(doc_or_docs, options={})
+      doc_or_docs = [doc_or_docs] if !doc_or_docs.is_a?(Array)
+      res = @db.insert_into_db(@name, doc_or_docs)
+      if options.delete(:safe)
+        error = @db.error
+        if error
+          raise OperationFailure, error
         end
+      end
+      res.size > 1 ? res : res.first
+    end
+    alias_method :<<, :insert
+
+    # Remove the records that match +selector+.
+    def remove(selector={})
+      @db.remove_from_db(@name, selector)
+    end
+
+    # Remove all records.
+    def clear
+      remove({})
+    end
+
+    # Update a single document in this collection.
+    #
+    # :spec :: a hash specifying elements which must be present for
+    #   a document to be updated
+    # :document :: a hash specifying the fields to be changed in the
+    #   selected document, or (in the case of an upsert) the document to
+    #   be inserted
+    #
+    # Options:
+    # :upsert :: if true, perform an upsert operation
+    # :safe :: if true, check that the update succeeded. OperationFailure
+    #   will be raised on an error. Checking for safety requires an extra
+    #   round-trip to the database
+    def update(spec, document, options={})
+      upsert = options.delete(:upsert)
+      safe = options.delete(:safe)
 
-        # Drop all indexes.
-        def drop_indexes
-          # just need to call drop indexes with no args; will drop them all
-          @db.drop_index(@name, '*')
+      if upsert
+        @db.repsert_in_db(@name, spec, document)
+      else
+        @db.replace_in_db(@name, spec, document)
+      end
+      if safe
+        error = @db.error
+        if error
+          raise OperationFailure, error
         end
+      end
+    end
+
+    # Create a new index. +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.
+    # +unique+ is an optional boolean indicating whether this index
+    # should enforce a uniqueness constraint.
+    def create_index(field_or_spec, unique=false)
+      @db.create_index(@name, field_or_spec, unique)
+    end
+
+    # Drop index +name+.
+    def drop_index(name)
+      @db.drop_index(@name, name)
+    end
+
+    # Drop all indexes.
+    def drop_indexes
+      # just need to call drop indexes with no args; will drop them all
+      @db.drop_index(@name, '*')
+    end
+
+    # Drop the entire collection. USE WITH CAUTION.
+    def drop
+      @db.drop_collection(@name)
+    end
 
-        # Return an array of hashes, one for each index. Each hash contains:
-        #
-        # :name :: Index name
-        #
-        # :keys :: Hash whose keys are the names of the fields that make up
-        #          the key and values are integers.
-        #
-        # :ns :: Namespace; same as this collection's name.
-        def index_information
-          @db.index_information(@name)
+    # Perform a query similar to an SQL group by operation.
+    #
+    # Returns an array of grouped items.
+    #
+    # :keys :: Array of fields to group by
+    # :condition :: specification of rows to be considered (as a 'find'
+    #               query specification)
+    # :initial :: initial value of the aggregation counter object
+    # :reduce :: aggregation function as a JavaScript string
+    # :command :: if true, run the group as a command instead of in an
+    #             eval - it is likely that this option will eventually be
+    #             deprecated and all groups will be run as commands
+    def group(keys, condition, initial, reduce, command=false)
+      if command
+        hash = {}
+        keys.each do |k|
+          hash[k] = 1
         end
 
-        # Return a hash containing options that apply to this collection.
-        # 'create' will be the collection name. For the other possible keys
-        # and values, see DB#create_collection.
-        def options
-          @db.collections_info(@name).next_object()['options']
+        case reduce
+        when Code
+        else
+          reduce = Code.new(reduce)
         end
 
-        # Return the number of records that match +selector+. If +selector+ is
-        # +nil+ or an empty hash, returns the count of all records.
-        def count(selector={})
-          @db.count(@name, selector || {})
+        result = @db.db_command({"group" =>
+                                  {
+                                    "ns" => @name,
+                                    "$reduce" => reduce,
+                                    "key" => hash,
+                                    "cond" => condition,
+                                    "initial" => initial}})
+        if result["ok"] == 1
+          return result["retval"]
+        else
+          raise OperationFailure, "group command failed: #{result['errmsg']}"
         end
+      end
 
+      case reduce
+      when Code
+        scope = reduce.scope
+      else
+        scope = {}
+      end
+      scope.merge!({
+                     "ns" => @name,
+                     "keys" => keys,
+                     "condition" => condition,
+                     "initial" => initial })
+
+      group_function = <<EOS
+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; i < keys.length; 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()};
+}
+EOS
+      return @db.eval(Code.new(group_function, scope))["result"]
+    end
+
+    # Rename this collection.
+    #
+    # If operating in auth mode, client must be authorized as an admin to
+    # perform this operation. Raises +InvalidName+ if +new_name+ is an invalid
+    # collection name.
+    #
+    # :new_name :: new name for this collection
+    def rename(new_name)
+      case new_name
+      when Symbol, String
+      else
+        raise TypeError, "new_name must be a string or symbol"
+      end
+
+      new_name = new_name.to_s
+
+      if new_name.empty? or new_name.include? ".."
+        raise InvalidName, "collection names cannot be empty"
+      end
+      if new_name.include? "$"
+        raise InvalidName, "collection names must not contain '$'"
+      end
+      if new_name.match(/^\./) or new_name.match(/\.$/)
+        raise InvalidName, "collection names must not start or end with '.'"
+      end
+
+      @db.rename_collection(@name, new_name)
+    end
+
+    # Get information on the indexes for the collection +collection_name+.
+    # 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
+      @db.index_information(@name)
+    end
+
+    # Return a hash containing options that apply to this collection.
+    # 'create' will be the collection name. For the other possible keys
+    # and values, see DB#create_collection.
+    def options
+      @db.collections_info(@name).next_object()['options']
+    end
+
+    # Get the number of documents in this collection.
+    def count()
+      find().count()
+    end
+
+    protected
+
+    def normalize_hint_fields(hint)
+      case hint
+      when String
+        {hint => 1}
+      when Hash
+        hint
+      when nil
+        nil
+      else
+        h = OrderedHash.new
+        hint.to_a.each { |k| h[k] = 1 }
+        h
       end
     end
   end
 end
-