mongo 1.12.5 → 2.0.0

data/lib/mongo/operation/specifiable.rb

@@ -0,0 +1,397 @@
+# 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
+
+    # This module contains common functionality for convenience methods getting
+    # various values from the spec.
+    #
+    # @since 2.0.0
+    module Specifiable
+
+      # The field for database name.
+      #
+      # @since 2.0.0
+      DB_NAME = :db_name.freeze
+
+      # The field for deletes.
+      #
+      # @since 2.0.0
+      DELETES = :deletes.freeze
+
+      # The field for delete.
+      #
+      # @since 2.0.0
+      DELETE = :delete.freeze
+
+      # The field for documents.
+      #
+      # @since 2.0.0
+      DOCUMENTS = :documents.freeze
+
+      # The field for collection name.
+      #
+      # @since 2.0.0
+      COLL_NAME = :coll_name.freeze
+
+      # The field for cursor count.
+      #
+      # @since 2.0.0
+      CURSOR_COUNT = :cursor_count.freeze
+
+      # The field for cursor id.
+      #
+      # @since 2.0.0
+      CURSOR_ID = :cursor_id.freeze
+
+      # The field for cursor ids.
+      #
+      # @since 2.0.0
+      CURSOR_IDS = :cursor_ids.freeze
+
+      # The field for an index.
+      #
+      # @since 2.0.0
+      INDEX = :index.freeze
+
+      # The field for multiple indexes.
+      #
+      # @since 2.0.0
+      INDEXES = :indexes.freeze
+
+      # The field for index names.
+      #
+      # @since 2.0.0
+      INDEX_NAME = :index_name.freeze
+
+      # The field for options.
+      #
+      # @since 2.0.0
+      OPTIONS = :options.freeze
+
+      # The field for a selector.
+      #
+      # @since 2.0.0
+      SELECTOR = :selector.freeze
+
+      # The field for number to return.
+      #
+      # @since 2.0.0
+      TO_RETURN = :to_return.freeze
+
+      # The field for updates.
+      #
+      # @since 2.0.0
+      UPDATES = :updates.freeze
+
+      # The field for update.
+      #
+      # @since 2.0.0
+      UPDATE = :update.freeze
+
+      # The field name for a user.
+      #
+      # @since 2.0.0
+      USER = :user.freeze
+
+      # The field name for user name.
+      #
+      # @since 2.0.0
+      USER_NAME = :user_name.freeze
+
+      # The field name for a write concern.
+      #
+      # @since 2.0.0
+      WRITE_CONCERN = :write_concern.freeze
+
+      # The field name for the read preference.
+      #
+      # @since 2.0.0
+      READ = :read.freeze
+
+      # @return [ Hash ] spec The specification for the operation.
+      attr_reader :spec
+
+      # Check equality of two specifiable operations.
+      #
+      # @example Are the operations equal?
+      #   operation == other
+      #
+      # @param [ Object ] other The other operation.
+      #
+      # @return [ true, false ] Whether the objects are equal.
+      #
+      # @since 2.0.0
+      def ==(other)
+        return false unless other.is_a?(Specifiable)
+        spec == other.spec
+      end
+      alias_method :eql?, :==
+
+      # Get the cursor count from the spec.
+      #
+      # @example Get the cursor count.
+      #   specifiable.cursor_count
+      #
+      # @return [ Integer ] The cursor count.
+      #
+      # @since 2.0.0
+      def cursor_count
+        spec[CURSOR_COUNT]
+      end
+
+      # The name of the database to which the operation should be sent.
+      #
+      # @example Get the database name.
+      #   specifiable.db_name
+      #
+      # @return [ String ] Database name.
+      #
+      # @since 2.0.0
+      def db_name
+        spec[DB_NAME]
+      end
+
+      # Get the deletes from the specification.
+      #
+      # @example Get the deletes.
+      #   specifiable.deletes
+      #
+      # @return [ Array<BSON::Document> ] The deletes.
+      #
+      # @since 2.0.0
+      def deletes
+        spec[DELETES]
+      end
+
+      # Get the delete document from the specification.
+      #
+      # @example Get the delete document.
+      #   specifiable.delete
+      #
+      # @return [ Hash ] The delete document.
+      #
+      # @since 2.0.0
+      def delete
+        spec[DELETE]
+      end
+
+      # The documents to in the specification.
+      #
+      # @example Get the documents.
+      #   specifiable.documents
+      #
+      # @return [ Array<BSON::Document> ] The documents.
+      #
+      # @since 2.0.0
+      def documents
+        spec[DOCUMENTS]
+      end
+
+      # The name of the collection to which the operation should be sent.
+      #
+      # @example Get the collection name.
+      #   specifiable.coll_name
+      #
+      # @return [ String ] Collection name.
+      #
+      # @since 2.0.0
+      def coll_name
+        spec[COLL_NAME]
+      end
+
+      # The id of the cursor created on the server.
+      #
+      # @example Get the cursor id.
+      #   specifiable.cursor_id
+      #
+      # @return [ Integer ] The cursor id.
+      #
+      # @since 2.0.0
+      def cursor_id
+        spec[CURSOR_ID]
+      end
+
+      # The ids of the cursors to kill from the spec.
+      #
+      # @example Get the cursor ids from the spec.
+      #   specifiable.cursor_ids
+      #
+      # @return [ Array<Integer> ] The cursor ids.
+      #
+      # @since 2.0.0
+      def cursor_ids
+        spec[CURSOR_IDS]
+      end
+
+      # Get the index from the specification.
+      #
+      # @example Get the index specification.
+      #   specifiable.index
+      #
+      # @return [ Hash ] The index specification.
+      #
+      # @since 2.0.0
+      def index
+        spec[INDEX]
+      end
+
+      # Get the index name from the spec.
+      #
+      # @example Get the index name.
+      #   specifiable.index_name
+      #
+      # @return [ String ] The index name.
+      #
+      # @since 2.0.0
+      def index_name
+        spec[INDEX_NAME]
+      end
+
+      # Get the indexes from the specification.
+      #
+      # @example Get the index specifications.
+      #   specifiable.indexes
+      #
+      # @return [ Hash ] The index specifications.
+      #
+      # @since 2.0.0
+      def indexes
+        spec[INDEXES]
+      end
+
+      # Create the new specifiable operation.
+      #
+      # @example Create the new specifiable operation.
+      #   Specifiable.new(spec)
+      #
+      # @param [ Hash ] spec The operation specification.
+      #
+      # @see The individual operations for the values they require in their
+      #   specs.
+      #
+      # @since 2.0.0
+      def initialize(spec)
+        @spec = spec
+      end
+
+      # Get the options for the operation.
+      #
+      # @example Get the options.
+      #   specifiable.options
+      #
+      # @return [ Hash ] The options.
+      #
+      # @since 2.0.0
+      def options
+        spec[OPTIONS] || {}
+      end
+
+      # The selector for from the specification.
+      #
+      # @example Get a selector specification.
+      #   specifiable.selector.
+      #
+      # @return [ Hash ] The selector spec.
+      #
+      # @since 2.0.0
+      def selector
+        spec[SELECTOR]
+      end
+
+      # The number of documents to request from the server.
+      #
+      # @example Get the to return value from the spec.
+      #   specifiable.to_return
+      #
+      # @return [ Integer ] The number of documents to return.
+      #
+      # @since 2.0.0
+      def to_return
+        spec[TO_RETURN]
+      end
+
+      # The update documents from the spec.
+      #
+      # @example Get the update documents.
+      #
+      # @return [ Array<BSON::Document> ] The update documents.
+      #
+      # @since 2.0.0
+      def updates
+        spec[UPDATES]
+      end
+
+      # The update document from the spec.
+      #
+      # @example Get the update document.
+      #
+      # @return [ Hash ] The update document.
+      #
+      # @since 2.0.0
+      def update
+        spec[UPDATE]
+      end
+
+      # The user for user related operations.
+      #
+      # @example Get the user.
+      #   specifiable.user
+      #
+      # @return [ Auth::User ] The user.
+      #
+      # @since 2.0.0
+      def user
+        spec[USER]
+      end
+
+      # The user name from the specification.
+      #
+      # @example Get the user name.
+      #   specifiable.user_name
+      #
+      # @return [ String ] The user name.
+      #
+      # @since 2.0.
+      def user_name
+        spec[USER_NAME]
+      end
+
+      # The write concern to use for this operation.
+      #
+      # @example Get the write concern.
+      #   specifiable.write_concern
+      #
+      # @return [ Mongo::WriteConcern ] The write concern.
+      #
+      # @since 2.0.0
+      def write_concern
+        @spec[WRITE_CONCERN] || WriteConcern.get(WriteConcern::DEFAULT)
+      end
+
+      # The read preference for this operation.
+      #
+      # @example Get the read preference.
+      #   specifiable.read
+      #
+      # @return [ Mongo::ServerSelector ] The read preference.
+      #
+      # @since 2.0.0
+      def read
+        @spec[READ] || ServerSelector.get
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/bulk/bulk_delete/result.rb

@@ -0,0 +1,75 @@
+# 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/write/bulk/bulk_mergable'
+require 'mongo/operation/write/bulk/legacy_bulk_mergable'
+
+module Mongo
+  module Operation
+    module Write
+      class BulkDelete
+
+        # Defines custom behaviour of results when deleting.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+          include BulkMergable
+
+          # The aggregate number of deleted docs reported in the replies.
+          #
+          # @since 2.0.0
+          REMOVED = 'nRemoved'.freeze
+
+          # Gets the number of documents deleted.
+          #
+          # @example Get the deleted count.
+          #   result.n_removed
+          #
+          # @return [ Integer ] The number of documents deleted.
+          #
+          # @since 2.0.0
+          def n_removed
+            return 0 unless acknowledged?
+            @replies.reduce(0) do |n, reply|
+              n += reply.documents.first[N]
+            end
+          end
+        end
+
+        # Defines custom behaviour of results when deleting.
+        # For server versions < 2.5.5 (that don't use write commands).
+        #
+        # @since 2.0.0
+        class LegacyResult < Operation::Result
+          include LegacyBulkMergable
+
+          # Gets the number of documents deleted.
+          #
+          # @example Get the deleted count.
+          #   result.n_removed
+          #
+          # @return [ Integer ] The number of documents deleted.
+          #
+          # @since 2.0.0
+          def n_removed
+            return 0 unless acknowledged?
+            @replies.reduce(0) do |n, reply|
+              n += reply.documents.first[N]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/bulk/bulk_delete.rb

@@ -0,0 +1,144 @@
+# 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/write/bulk/bulk_delete/result'
+
+module Mongo
+  module Operation
+    module Write
+
+      # A MongoDB bulk delete operation.
+      #
+      # @note If a server with version >= 2.5.5 is selected, a write command
+      #   operation will be created and sent instead.
+      #
+      # @example Create the delete operation.
+      #   Write::BulkDelete.new({
+      #     :deletes => [{ :q => { :foo => 1 }, :limit => 1 }],
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :write_concern => write_concern
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the delete.
+      #
+      # @option spec :deletes [ Array ] The delete documents.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the delete should be executed.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the delete should be executed.
+      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern
+      #   for this operation.
+      # @option spec :ordered [ true, false ] Whether the operations should be
+      #   executed in order.
+      # @option spec :options [Hash] Options for the command, if it ends up being a
+      #   write command.
+      #
+      # @since 2.0.0
+      class BulkDelete
+        include Executable
+        include Specifiable
+
+        # Execute the delete operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        # Set the write concern on this operation.
+        #
+        # @example Set a write concern.
+        #   new_op = operation.write_concern(:w => 2)
+        #
+        # @param [ Hash ] wc The write concern.
+        #
+        # @since 2.0.0
+        def write_concern(wc = nil)
+          if wc
+            self.class.new(spec.merge(write_concern: WriteConcern.get(wc)))
+          else
+            spec[WRITE_CONCERN]
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::Delete.new(spec).execute(context))
+        end
+
+        def execute_message(context)
+          replies = messages.map do |m|
+            context.with_connection do |connection|
+              result = LegacyResult.new(connection.dispatch([ m, gle ].compact))
+              if stop_sending?(result)
+                return result
+              else
+                result.reply
+              end
+            end
+          end
+          LegacyResult.new(replies.compact.empty? ? nil : replies)
+        end
+
+        def stop_sending?(result)
+          ordered? && !result.successful?
+        end
+
+        # @todo put this somewhere else
+        def ordered?
+          @spec.fetch(:ordered, true)
+        end
+
+        def gle
+          gle_message = ( ordered? && write_concern.get_last_error.nil? ) ?
+                           Mongo::WriteConcern.get(:w => 1).get_last_error :
+                           write_concern.get_last_error
+          if gle_message
+            Protocol::Query.new(
+              db_name,
+              Database::COMMAND,
+              gle_message,
+              options.merge(limit: -1)
+            )
+          end
+        end
+
+        def initialize_copy(original)
+          @spec = original.spec.dup
+          @spec[DELETES] = original.spec[DELETES].clone
+        end
+
+        def messages
+          deletes.collect do |del|
+            opts = ( del[:limit] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
+            Protocol::Delete.new(db_name, coll_name, del[:q], opts)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/bulk/bulk_insert/result.rb

@@ -0,0 +1,68 @@
+# 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/write/bulk/bulk_mergable'
+require 'mongo/operation/write/bulk/legacy_bulk_mergable'
+
+module Mongo
+  module Operation
+    module Write
+      class BulkInsert
+
+        # Defines custom behaviour of results when inserting.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+          include BulkMergable
+
+          # Gets the number of documents inserted.
+          #
+          # @example Get the number of documents inserted.
+          #   result.n_inserted
+          #
+          # @return [ Integer ] The number of documents inserted.
+          #
+          # @since 2.0.0
+          def n_inserted
+            written_count
+          end
+        end
+
+        # Defines custom behaviour of results when inserting.
+        # For server versions < 2.5.5 (that don't use write commands).
+        #
+        # @since 2.0.0
+        class LegacyResult < Operation::Result
+          include LegacyBulkMergable
+
+          # Gets the number of documents inserted.
+          #
+          # @example Get the number of documents inserted.
+          #   result.n_inserted
+          #
+          # @return [ Integer ] The number of documents inserted.
+          #
+          # @since 2.0.0
+          def n_inserted
+            return 0 unless acknowledged?
+            @replies.reduce(0) do |n, reply|
+              n += 1 unless reply_write_errors?(reply)
+              n
+            end
+          end
+        end
+      end
+    end
+  end
+end