mongo 2.0.6 → 2.1.0

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

@@ -0,0 +1,174 @@
+# 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
+    module Write
+      module Bulk
+        class Update
+
+          # Defines custom behaviour of results when updating.
+          #
+          # @since 2.0.0
+          class Result < Operation::Result
+            include Mergable
+
+            # The number of modified docs field in the result.
+            #
+            # @since 2.0.0
+            MODIFIED = 'nModified'.freeze
+
+            # The upserted docs field in the result.
+            #
+            # @since 2.0.0
+            UPSERTED = 'upserted'.freeze
+
+            # Gets the number of documents upserted.
+            #
+            # @example Get the upserted count.
+            #   result.n_upserted
+            #
+            # @return [ Integer ] The number of documents upserted.
+            #
+            # @since 2.0.0
+            def n_upserted
+              return 0 unless acknowledged?
+              @replies.reduce(0) do |n, reply|
+                if upsert?(reply)
+                  n += 1
+                else
+                  n += 0
+                end
+              end
+            end
+
+            # Gets the number of documents matched.
+            #
+            # @example Get the matched count.
+            #   result.n_matched
+            #
+            # @return [ Integer ] The number of documents matched.
+            #
+            # @since 2.0.0
+            def n_matched
+              return 0 unless acknowledged?
+              @replies.reduce(0) do |n, reply|
+                if upsert?(reply)
+                  n += 0
+                else
+                  n += reply.documents.first[N]
+                end
+              end
+            end
+
+            # Gets the number of documents modified.
+            #
+            # @example Get the modified count.
+            #   result.n_modified
+            #
+            # @return [ Integer ] The number of documents modified.
+            #
+            # @since 2.0.0
+            def n_modified
+              return 0 unless acknowledged?
+              @replies.reduce(0) do |n, reply|
+                n += reply.documents.first[MODIFIED] || 0
+              end
+            end
+
+            # Get the upserted documents.
+            #
+            # @example Get upserted documents.
+            #   result.upserted
+            #
+            # @return [ Array<BSON::Document> ] The upserted document info
+            #
+            # @since 2.1.0
+            def upserted
+              reply.documents.first[UPSERTED] || []
+            end
+
+            private
+
+            def upsert?(reply)
+              upserted.any?
+            end
+          end
+
+          # Defines custom behaviour of results when updating.
+          # For server versions < 2.5.5 (that don't use write commands).
+          #
+          # @since 2.0.0
+          class LegacyResult < Operation::Result
+            include LegacyMergable
+
+            # The updated existing field in the result.
+            #
+            # @since 2.0.0
+            UPDATED_EXISTING = 'updatedExisting'.freeze
+
+            # Gets the number of documents upserted.
+            #
+            # @example Get the upserted count.
+            #   result.n_upserted
+            #
+            # @return [ Integer ] The number of documents upserted.
+            #
+            # @since 2.0.0
+            def n_upserted
+              return 0 unless acknowledged?
+              @replies.reduce(0) do |n, reply|
+                if upsert?(reply)
+                  n += reply.documents.first[N]
+                else
+                  n
+                end
+              end
+            end
+
+            # Gets the number of documents matched.
+            #
+            # @example Get the matched count.
+            #   result.n_matched
+            #
+            # @return [ Integer ] The number of documents matched.
+            #
+            # @since 2.0.0
+            def n_matched
+              return 0 unless acknowledged?
+              @replies.reduce(0) do |n, reply|
+                if upsert?(reply)
+                  n
+                else
+                  n += reply.documents.first[N]
+                end
+              end
+            end
+            alias :n_modified :n_matched
+
+            private
+
+            def upsert?(reply)
+              !updated_existing?(reply) && reply.documents.first[N] == 1
+            end
+
+            def updated_existing?(reply)
+              reply.documents.first[UPDATED_EXISTING]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# 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/update/result'
+
+module Mongo
+  module Operation
+    module Write
+      module Bulk
+
+        # A MongoDB bulk update operation.
+        #
+        # @note If the server version is >= 2.5.5, a write command operation
+        #   will be created and sent instead.
+        #
+        # @example Create the update operation.
+        #   Write::BulkUpdate.new({
+        #     :updates => [
+        #       {
+        #         :q => { :foo => 1 },
+        #         :u => { :$set => { :bar => 1 }},
+        #         :multi  => true,
+        #         :upsert => false
+        #       }
+        #     ],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern,
+        #     :ordered => false
+        #   })
+        #
+        # Initialization:
+        #   param [ Hash ] spec The specifications for the update.
+        #
+        #   option spec :updates [ Array ] The update documents.
+        #   option spec :db_name [ String ] The name of the database on which
+        #     the query should be run.
+        #   option spec :coll_name [ String ] The name of the collection on which
+        #     the query should be run.
+        #   option spec :write_concern [ Mongo::WriteConcern ] The write concern.
+        #   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 Update
+          include Bulkable
+          include Specifiable
+
+          private
+
+          def execute_write_command(context)
+            Result.new(Command::Update.new(spec).execute(context))
+          end
+
+
+          def messages
+            updates.collect do |u|
+              opts = { :flags => [] }
+              opts[:flags] << :multi_update if !!u[Operation::MULTI]
+              opts[:flags] << :upsert if !!u[Operation::UPSERT]
+              Protocol::Update.new(db_name, coll_name, u[Operation::Q], u[Operation::U], opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/write/bulk/bulk_delete'
-require 'mongo/operation/write/bulk/bulk_insert'
-require 'mongo/operation/write/bulk/bulk_update'
+require 'mongo/operation/write/bulk/mergable'
+require 'mongo/operation/write/bulk/legacy_mergable'
+require 'mongo/operation/write/bulk/bulkable'
+require 'mongo/operation/write/bulk/delete'
+require 'mongo/operation/write/bulk/insert'
+require 'mongo/operation/write/bulk/update'

data/lib/mongo/operation/write/command/create_index.rb

@@ -29,7 +29,6 @@ module Mongo
         # @since 2.0.0
         class CreateIndex
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/create_user.rb

@@ -23,7 +23,6 @@ module Mongo
         # @since 2.0.0
         class CreateUser
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/delete.rb

@@ -31,7 +31,6 @@ module Mongo
         # @since 2.0.0
         class Delete
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/drop_index.rb

@@ -30,7 +30,6 @@ module Mongo
         # @since 2.0.0
         class DropIndex
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/insert.rb

@@ -30,7 +30,6 @@ module Mongo
         # @since 2.0.0
         class Insert
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/remove_user.rb

@@ -22,7 +22,6 @@ module Mongo
         # @since 2.0.0
         class RemoveUser
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/update.rb

@@ -37,7 +37,6 @@ module Mongo
         # @since 2.0.0
         class Update
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/update_user.rb

@@ -23,7 +23,6 @@ module Mongo
         # @since 2.0.0
         class UpdateUser
           include Specifiable
-          include Executable
           include Writable
 
           private

data/lib/mongo/operation/write/command/writable.rb

@@ -17,35 +17,30 @@ module Mongo
     module Write
       module Command
 
-        # Provides common behavior for all write commands.
+        # Provides common behavior for write commands.
+        # Assigns an operation id when executed.
         #
         # @since 2.0.0
         module Writable
           include Limited
 
-          private
-
-          # Whether this operation may be executed on a secondary server.
+          # Execute the operation.
+          # The context gets a connection on which the operation
+          # is sent in the block.
           #
-          # @return [ false ] A write command may not be executed on a secondary.
-          def secondary_ok?
-            false
-          end
-
-          # Whether the batch writes should be applied in the same order the
-          # items appear, ie. sequentially. 
-          # If ordered is false, the server applies the batch items in no particular
-          # order, and possibly in parallel. Execution halts after the first error.
-          # The default value is true, which means the batch items are applied
-          # sequentially.
+          # @param [ Mongo::Server::Context ] context The context for this operation.
           #
-          # @return [ true, false ] Whether batch items are applied sequentially. 
+          # @return [ Result ] The operation response, if there is one.
           #
           # @since 2.0.0
-          def ordered?
-            @spec.fetch(:ordered, true)
+          def execute(context)
+            context.with_connection do |connection|
+              connection.dispatch([ message ], operation_id)
+            end
           end
 
+          private
+
           # The wire protocol message for this write operation.
           #
           # @return [ Mongo::Protocol::Query ] Wire protocol message.

data/lib/mongo/operation/write/create_index.rb

@@ -42,37 +42,14 @@ module Mongo
       #
       # @since 2.0.0
       class CreateIndex
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         include Specifiable
 
-        # Execute the ensure index operation.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The result of the operation.
-        #
-        # @since 2.0.0
-        def execute(context)
-          if context.features.write_command_enabled?
-            execute_write_command(context)
-          else
-            execute_message(context)
-          end
-        end
-
         private
 
-        def execute_write_command(context)
-          Result.new(Command::CreateIndex.new(spec).execute(context)).validate!
-        end
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message, gle ].compact)).validate!
-          end
+        def write_command_op
+          Command::CreateIndex.new(spec)
         end
 
         def index_documents

data/lib/mongo/operation/write/create_user.rb

@@ -30,40 +30,14 @@ module Mongo
       #
       # @since 2.0.0
       class CreateUser
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         include Specifiable
 
-        # Execute the operation.
-        #
-        # @note Creating users behaves different on 2.7+, 2.6.x, and
-        #   2.4- so we need to break this out into separate operations.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation result.
-        #
-        # @since 2.0.0
-        def execute(context)
-          if context.features.write_command_enabled?
-            execute_write_command(context)
-          else
-            execute_message(context)
-          end
-        end
-
         private
 
-        def execute_write_command(context)
-          Result.new(Command::CreateUser.new(spec).execute(context)).validate!
-        end
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message, gle ].compact)).validate!
-          end
+        def write_command_op
+          Command::CreateUser.new(spec)
         end
 
         def message

data/lib/mongo/operation/write/delete.rb

@@ -48,44 +48,21 @@ module Mongo
       #
       # @since 2.0.0
       class Delete
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         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
-
         private
 
-        def execute_write_command(context)
+        def write_command_op
           s = spec.merge(:deletes => [ delete ])
           s.delete(:delete)
-          Result.new(Command::Delete.new(s).execute(context)).validate!
-        end
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message, gle ].compact)).validate!
-          end
+          Command::Delete.new(s)
         end
 
         def message
-          selector = delete[:q]
-          opts     = ( delete[:limit] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
+          selector = delete[Operation::Q]
+          opts     = (delete[Operation::LIMIT] || 0) <= 0 ? {} : { :flags => [ :single_remove ] }
           Protocol::Delete.new(db_name, coll_name, selector, opts)
         end
       end

data/lib/mongo/operation/write/drop_index.rb

@@ -35,7 +35,7 @@ module Mongo
       #
       # @since 2.0.0
       class DropIndex
-        include Executable
+        include WriteCommandEnabled
         include Specifiable
 
         # Execute the drop index operation.
@@ -54,8 +54,8 @@ module Mongo
 
         private
 
-        def execute_write_command(context)
-          Result.new(Command::DropIndex.new(spec).execute(context)).validate!
+        def write_command_op
+          Command::DropIndex.new(spec)
         end
       end
     end

data/lib/mongo/operation/write/gle.rb

@@ -0,0 +1,48 @@
+# 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
+    module Write
+
+      # This module contains common functionality for operations that need to
+      # be followed by a GLE message.
+      #
+      # @since 2.1.0
+      module GLE
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            result_class = defined?(self.class::LegacyResult) ? self.class::LegacyResult :
+                defined?(self.class::Result) ? self.class::Result : Result
+            result_class.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def gle
+          if gle_message = write_concern.get_last_error
+            Protocol::Query.new(
+                db_name,
+                Database::COMMAND,
+                gle_message,
+                options.merge(limit: -1)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/idable.rb

@@ -15,6 +15,11 @@
 module Mongo
   module Operation
     module Write
+
+      # This module provides functionality to ensure that documents contain
+      # an id field. Used by insert operations (Bulk, legacy, write command inserts).
+      #
+      # @since 2.1.0
       module Idable
 
         private

data/lib/mongo/operation/write/insert.rb

@@ -43,28 +43,11 @@ module Mongo
       #
       # @since 2.0.0
       class Insert
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         include Specifiable
         include Idable
 
-        # Execute the insert operation.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation result.
-        #
-        # @since 2.0.0
-        def execute(context)
-          if context.features.write_command_enabled?
-            execute_write_command(context)
-          else
-            execute_message(context)
-          end
-        end
-
         private
 
         def execute_write_command(context)
@@ -78,11 +61,6 @@ module Mongo
           end
         end
 
-        def initialize_copy(original)
-          @spec = original.spec.dup
-          @spec[:documents] = original.spec[:documents].dup
-        end
-
         def message
           opts = !!options[:continue_on_error] ? { :flags => [:continue_on_error] } : {}
           Protocol::Insert.new(db_name, coll_name, ensure_ids(documents), opts)