mongo-ruby-driver/lib/mongo/collection.rb

# Copyright (C) 2008 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.
#
# 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.
#
# 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/>.

require 'mongo/query'

module XGen
  module Mongo
    module Driver
      class Collection

        attr_reader :db, :name

        def initialize(db, name)
          @db = db
          @name = name
        end

        # Options:
        # * <tt>:fields</tt> - Array of collection field names; only those will be returned (plus _id if defined)
        # * <tt>:offset</tt> - Start at this record when returning records
        # * <tt>:limit</tt> - Maximum number of records to return
        # * <tt>:sort</tt> - Hash of field names as keys and 1/-1 as values; 1 == ascending, -1 == descending
        # <tt>
        def find(selector={}, options={})
          fields = options.delete(:fields)
          fields = nil if fields && fields.empty?
          @db.query(@name, Query.new(selector, fields, options[:offset] || 0, options[:limit] || 0, options[:sort]))
        end

        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

        def remove(selector={})
          @db.remove_from_db(@name, selector)
        end

        def clear
          remove({})
        end

        def repsert(selector, obj)
          @db.repsert_in_db(@name, selector, obj)
        end

        def replace(selector, obj)
          @db.replace_in_db(@name, selector, obj)
        end

        def modify(selector, modifierObj)
          raise "no object" unless modifierObj
          raise "no selector" unless selector
          @db.modify_in_db(@name, selector, modifierObj)
        end

        def create_index(name, *fields)
          @db.create_index(@name, name, fields)
        end

        def drop_index(name)
          @db.drop_index(@name, name)
        end

        def drop_indexes
          # just need to call drop indexes with no args; will drop them all
          @db.drop_index(@name, '*')
        end

        def index_information
          @db.index_information(@name)
        end

        def count(selector={})
          @db.count(@name, selector || {})
        end

      end
    end
  end
end