mongo 2.1.0.beta → 2.2.0

data/lib/mongo/operation/aggregate/result.rb

@@ -1,103 +0,0 @@
-# Copyright (C) 2014-2015 MongoDB, 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.
-
-module Mongo
-  module Operation
-    class Aggregate
-
-      # Defines custom behaviour of results in an aggregation context.
-      #
-      # @since 2.0.0
-      class Result < Operation::Result
-
-        # The field name for the cursor document in an aggregation.
-        #
-        # @since 2.0.0
-        CURSOR = 'cursor'.freeze
-
-        # The cursor id field in the cursor document.
-        #
-        # @since 2.0.0
-        CURSOR_ID = 'id'.freeze
-
-        # The field name for the aggregation explain information.
-        #
-        # @since 2.0.5
-        EXPLAIN = 'stages'.freeze
-
-        # The legacy field name for the aggregation explain information.
-        #
-        # @since 2.0.5
-        EXPLAIN_LEGACY = 'serverPipeline'.freeze
-
-        # The field name for the first batch of a cursor.
-        #
-        # @since 2.0.0
-        FIRST_BATCH = 'firstBatch'.freeze
-
-        # The field name for a result without a cursor.
-        #
-        # @since 2.0.0
-        RESULT = 'result'.freeze
-
-        # Get the cursor id for the result.
-        #
-        # @example Get the cursor id.
-        #   result.cursor_id
-        #
-        # @note Even though the wire protocol has a cursor_id field for all
-        #   messages of type reply, it is always zero when using the
-        #   aggregation framework and must be retrieved from the cursor
-        #   document itself. Wahnsinn!
-        #
-        # @return [ Integer ] The cursor id.
-        #
-        # @since 2.0.0
-        def cursor_id
-          cursor_document ? cursor_document[CURSOR_ID] : super
-        end
-
-        # Get the documents for the aggregation result. This is either the
-        # first document's 'result' field, or if a cursor option was selected
-        # it is the 'firstBatch' field in the 'cursor' field of the first
-        # document returned.
-        #
-        # @example Get the documents.
-        #   result.documents
-        #
-        # @return [ Array<BSON::Document> ] The documents.
-        #
-        # @since 2.0.0
-        def documents
-          reply.documents[0][RESULT] || explain_document ||
-              cursor_document[FIRST_BATCH]
-        end
-
-        private
-
-        def explain_document
-          first_document[EXPLAIN] || first_document[EXPLAIN_LEGACY]
-        end
-
-        def cursor_document
-          @cursor_document ||= reply.documents[0][CURSOR]
-        end
-
-        def first_document
-          @first_document ||= reply.documents[0]
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/aggregate.rb

@@ -1,108 +0,0 @@
-# Copyright (C) 2014-2015 MongoDB, 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/operation/aggregate/result'
-
-module Mongo
-  module Operation
-
-    # A MongoDB aggregate operation.
-    #
-    # @note An aggregate operation can behave like a read and return a 
-    #   result set, or can behave like a write operation and
-    #   output results to a user-specified collection.
-    #
-    # @example Create the aggregate operation.
-    #   Aggregate.new({
-    #     :selector => {
-    #       :aggregate => 'test_coll', :pipeline => [{ '$out' => 'test-out' }]
-    #     },
-    #     :db_name => 'test_db'
-    #   })
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the operation.
-    #
-    #   option spec :selector [ Hash ] The aggregate selector.
-    #   option spec :db_name [ String ] The name of the database on which
-    #     the operation should be executed.
-    #   option spec :options [ Hash ] Options for the aggregate command.
-    #
-    # @since 2.0.0
-    class Aggregate
-      include Executable
-      include Specifiable
-      include Limited
-      include ReadPreferrable
-
-      # The need primary error message.
-      #
-      # @since 2.0.0
-      ERROR_MESSAGE = "The pipeline contains the '$out' operator so the primary must be used.".freeze
-
-      # Execute the operation.
-      # The context gets a connection on which the operation
-      # is sent in the block.
-      # If the aggregation will be written to an output collection and the
-      # server is not primary, the operation will be rerouted to the primary
-      # with a warning.
-      #
-      # @param [ Server::Context ] context The context for this operation.
-      #
-      # @return [ Result ] The operation response, if there is one.
-      #
-      # @since 2.0.0
-      def execute(context)
-        unless valid_context?(context)
-          raise Error::NeedPrimaryServer.new(ERROR_MESSAGE)
-        end
-        execute_message(context)
-      end
-
-      private
-
-      def execute_message(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ])).validate!
-        end
-      end
-
-      def valid_context?(context)
-        context.standalone? || context.mongos? || context.primary? || secondary_ok?
-      end
-
-      def secondary_ok?
-        selector[:pipeline].none? { |op| op.key?('$out') || op.key?(:$out) }
-      end
-
-      def query_coll
-        Database::COMMAND
-      end
-
-      def filter_selector(context)
-        return selector if context.features.write_command_enabled?
-        selector.reject{ |option, value| option.to_s == 'cursor' }
-      end
-
-      def update_selector(context)
-        if context.mongos? && read_pref = read.to_mongos
-          sel = selector[:$query] ? filter_selector(context) : { :$query => filter_selector(context) }
-          sel.merge(:$readPreference => read_pref)
-        else
-          filter_selector(context)
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/command.rb

@@ -1,61 +0,0 @@
-# Copyright (C) 2014-2015 MongoDB, 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.
-
-module Mongo
-  module Operation
-
-    # A MongoDB command operation.
-    #
-    # @example Create the command operation.
-    #   Mongo::Operation::Command.new({ :selector => { :isMaster => 1 } })
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the command.
-    #
-    #   option spec :selector [ Hash ] The command selector.
-    #   option spec :db_name [ String ] The name of the database on which
-    #   the command should be executed.
-    #   option spec :options [ Hash ] Options for the command.
-    #
-    # @since 2.0.0
-    class Command
-      include Executable
-      include Specifiable
-      include Limited
-      include ReadPreferrable
-
-      # Execute the command operation.
-      #
-      # @example Execute the operation.
-      #   operation.execute(context)
-      #
-      # @param [ Server::Context ] context The context for this operation.
-      #
-      # @return [ Result ] The operation result.
-      #
-      # @since 2.0.0
-      def execute(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ])).validate!
-        end
-      end
-
-      private
-
-      def query_coll
-        Database::COMMAND
-      end
-    end
-  end
-end

data/lib/mongo/operation/map_reduce/result.rb

@@ -1,122 +0,0 @@
-# Copyright (C) 2014-2015 MongoDB, 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.
-
-module Mongo
-  module Operation
-    class MapReduce
-
-      # Defines custom behaviour of results in an aggregation context.
-      #
-      # @since 2.0.0
-      class Result < Operation::Result
-
-        # The counts field for the map/reduce.
-        #
-        # @since 2.0.0
-        COUNTS = 'counts'.freeze
-
-        # The result field for when output is a collection.
-        #
-        # @since 2.0.0
-        RESULT = 'result'.freeze
-
-        # The field name for a result without a cursor.
-        #
-        # @since 2.0.0
-        RESULTS = 'results'.freeze
-
-        # The time the operation took constant.
-        #
-        # @since 2.0.0
-        TIME = 'timeMillis'.freeze
-
-        # Gets the map/reduce counts from the reply.
-        #
-        # @example Get the counts.
-        #   result.counts
-        #
-        # @return [ Hash ] A hash of the result counts.
-        #
-        # @since 2.0.0
-        def counts
-          reply.documents[0][COUNTS]
-        end
-
-        # Get the documents from the map/reduce.
-        #
-        # @example Get the documents.
-        #   result.documents
-        #
-        # @return [ Array<BSON::Document> ] The documents.
-        #
-        # @since 2.0.0
-        def documents
-          reply.documents[0][RESULTS] || reply.documents[0][RESULT]
-        end
-
-        # If the result was a command then determine if it was considered a
-        # success.
-        #
-        # @note If the write was unacknowledged, then this will always return
-        #   true.
-        #
-        # @example Was the command successful?
-        #   result.successful?
-        #
-        # @return [ true, false ] If the command was successful.
-        #
-        # @since 2.0.0
-        def successful?
-          !documents.nil?
-        end
-
-        # Get the execution time of the map/reduce.
-        #
-        # @example Get the execution time.
-        #   result.time
-        #
-        # @return [ Integer ] The executiong time in milliseconds.
-        #
-        # @since 2.0.0
-        def time
-          reply.documents[0][TIME]
-        end
-
-        # Validate the result by checking for any errors.
-        #
-        # @note This only checks for errors with writes since authentication is
-        #   handled at the connection level and any authentication errors would
-        #   be raised there, before a Result is ever created.
-        #
-        # @example Validate the result.
-        #   result.validate!
-        #
-        # @raise [ Error::OperationFailure ] If an error is in the result.
-        #
-        # @return [ Result ] The result if verification passed.
-        #
-        # @since 2.0.0
-        def validate!
-          documents.nil? ? raise(Error::OperationFailure.new(parser.message)) : self
-        end
-
-        private
-
-        def first_document
-          @first_document ||= reply.documents[0]
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/map_reduce.rb

@@ -1,95 +0,0 @@
-# Copyright (C) 2014-2015 MongoDB, 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/operation/map_reduce/result'
-
-module Mongo
-  module Operation
-
-    # A MongoDB map reduce operation.
-    #
-    # @note A map/reduce operation can behave like a read and
-    #   return a result set, or can behave like a write operation and
-    #   output results to a user-specified collection.
-    #
-    # @example Create the map/reduce operation.
-    #   MapReduce.new({
-    #     :selector => {
-    #       :mapreduce => 'test_coll',
-    #       :map => '',
-    #       :reduce => ''
-    #     },
-    #     :db_name  => 'test_db'
-    #   })
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the operation.
-    #
-    #   option spec :selector [ Hash ] The map reduce selector.
-    #   option spec :db_name [ String ] The name of the database on which
-    #     the operation should be executed.
-    #   option spec :options [ Hash ] Options for the map reduce command.
-    #
-    # @since 2.0.0
-    class MapReduce
-      include Executable
-      include Specifiable
-      include Limited
-      include ReadPreferrable
-
-      # The error message for needing a primary.
-      #
-      # @since 2.0.
-      ERROR_MESSAGE = "If 'out' is specified as a collection, the primary server must be used.".freeze
-
-      # Execute the map/reduce operation.
-      #
-      # @example Execute the operation.
-      #   operation.execute(context)
-      #
-      # @param [ Server::Context ] context The context for this operation.
-      #
-      # @return [ Result ] The operation response, if there is one.
-      #
-      # @since 2.0.0
-      def execute(context)
-        unless valid_context?(context)
-          raise Error::NeedPrimaryServer.new(ERROR_MESSAGE)
-        end
-        execute_message(context)
-      end
-
-      private
-
-      def valid_context?(context)
-        context.standalone? || context.mongos? || context.primary? || secondary_ok?
-      end
-
-      def execute_message(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ])).validate!
-        end
-      end
-
-      def secondary_ok?
-        selector[:out].respond_to?(:keys) &&
-          selector[:out].keys.first.to_s.downcase == 'inline'
-      end
-
-      def query_coll
-        Database::COMMAND
-      end
-    end
-  end
-end

data/lib/mongo/operation/parallel_scan/result.rb

@@ -1,72 +0,0 @@
-
-# Copyright (C) 2009-2014 MongoDB, 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.
-
-module Mongo
-  module Operation
-    class ParallelScan
-
-      # Defines custom behaviour of results in a parallel scan.
-      #
-      # @since 2.0.0
-      class Result < Operation::Result
-
-        # Get the name of the cursor field.
-        #
-        # @since 2.0.0
-        CURSOR = 'cursor'.freeze
-
-        # The name of the cursors field in the result.
-        #
-        # @since 2.0.0
-        CURSORS = 'cursors'.freeze
-
-        # Get the name of the id field.
-        #
-        # @since 2.0.0
-        ID = 'id'.freeze
-
-        # Get all the cursor ids from the result.
-        #
-        # @example Get the cursor ids.
-        #   result.cursor_ids
-        #
-        # @return [ Array<Integer> ] The cursor ids.
-        #
-        # @since 2.0.0
-        def cursor_ids
-          documents.map{ |doc| doc[CURSOR][ID] }
-        end
-
-        # Get the documents from parallel scan.
-        #
-        # @example Get the documents.
-        #   result.documents
-        #
-        # @return [ Array<BSON::Document> ] The documents.
-        #
-        # @since 2.0.0
-        def documents
-          reply.documents[0][CURSORS]
-        end
-
-        private
-
-        def first
-          @first ||= reply.documents[0] || {}
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/parallel_scan.rb

@@ -1,76 +0,0 @@
-# Copyright (C) 2009-2014 MongoDB, 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/operation/parallel_scan/result'
-
-module Mongo
-  module Operation
-
-    # A MongoDB parallel scan operation.
-    #
-    # @example Create the parallel scan operation.
-    #   ParallelScan.new({
-    #     :db_name  => 'test_db',
-    #     :coll_name = > 'test_collection',
-    #     :cursor_count => 5
-    #   })
-    #
-    # Initialization:
-    #   param [ Hash ] spec The specifications for the operation.
-    #
-    #   option spec :db_name [ String ] The name of the database on which
-    #     the operation should be executed.
-    #   option spec :coll_name [ String ] The collection to scan.
-    #   option spec :cursor_count [ Integer ] The number of cursors to use.
-    #   option spec :options [ Hash ] Options for the command.
-    #
-    # @since 2.0.0
-    class ParallelScan
-      include Executable
-      include Specifiable
-      include Limited
-      include ReadPreferrable
-
-      # Execute the parallel scan operation.
-      #
-      # @example Execute the operation.
-      #   operation.execute(context)
-      #
-      # @param [ Mongo::Server::Context ] context The context for this operation.
-      #
-      # @return [ Result ] The operation response, if there is one.
-      #
-      # @since 2.0.0
-      def execute(context)
-        execute_message(context)
-      end
-
-      private
-
-      def execute_message(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ])).validate!
-        end
-      end
-
-      def selector
-        { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
-      end
-
-      def query_coll
-        Database::COMMAND
-      end
-    end
-  end
-end