mongo 1.12.5 → 2.0.0.beta

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

@@ -0,0 +1,295 @@
+# 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
+      class BulkUpdate
+
+        # Defines custom behaviour of results when updating.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+          attr_reader :indexes
+
+          # 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
+
+          # Set a list of indexes of the operations creating this result.
+          #
+          # @example Set the list of indexes.
+          #   result.set_indexes([1,2,3])
+          #
+          # @return [ self ] The result.
+          #
+          # @since 2.0.0
+          def set_indexes(indexes)
+            @indexes = indexes
+            self
+          end
+
+          # Aggregate the write errors returned from this result.
+          #
+          # @example Aggregate the write errors.
+          #   result.aggregate_write_errors
+          #
+          # @return [ Array ] The aggregate write errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_errors
+            @replies.reduce(nil) do |errors, reply|
+              if write_errors = reply.documents.first['writeErrors']
+                errors ||= []
+                write_errors.each do |write_error|
+                  errors << write_error.merge('index' => indexes[write_error['index']])
+                end
+              end
+              errors
+            end
+          end
+
+          # Aggregate the write concern errors returned from this result.
+          #
+          # @example Aggregate the write concern errors.
+          #   result.aggregate_write_concern_errors
+          #
+          # @return [ Array ] The aggregate write concern errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_concern_errors
+            @replies.each_with_index.reduce(nil) do |errors, (reply, i)|
+              if write_concern_errors = reply.documents.first['writeConcernError']
+                errors ||= []
+                write_concern_errors.each do |write_concern_error|
+                  errors << write_concern_error.merge('index' =>
+                                                      indexes[write_concern_error['index']])
+                end
+              elsif reply.documents.first['errmsg']
+                errors ||= []
+                errors << { 'errmsg' => reply.documents.first['errmsg'],
+                            'index' => indexes[i],
+                            'code' => reply.documents.first['code'] }
+              end
+              errors
+            end
+          end
+
+          private
+
+          def upsert?(reply)
+            reply.documents.first[UPSERTED]
+          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
+
+          attr_reader :indexes
+
+          # 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
+
+          # Gets the number of documents modified.
+          #
+          # @example Get the modified count.
+          #   result.n_modified
+          #
+          # @return [ nil ] nil for legacy.
+          #
+          # @since 2.0.0
+          def n_modified
+            nil
+          end
+
+          # Set a list of indexes of the operations creating this result.
+          #
+          # @example Set the list of indexes.
+          #   result.set_indexes([1,2,3])
+          #
+          # @return [ self ] The result.
+          #
+          # @since 2.0.0
+          def set_indexes(indexes)
+            @indexes = indexes
+            self
+          end
+
+          # Aggregate the write errors returned from this result.
+          #
+          # @example Aggregate the write errors.
+          #   result.aggregate_write_errors
+          #
+          # @return [ Array ] The aggregate write errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_errors
+            @replies.each_with_index.reduce(nil) do |errors, (reply, i)|
+              if reply_write_errors?(reply)
+                errors ||= []
+                errors << { 'errmsg' => reply.documents.first[Error::ERROR],
+                            'index' => indexes[i],
+                            'code' => reply.documents.first[Error::CODE] }
+              end
+              errors
+            end
+          end
+
+          # Aggregate the write concern errors returned from this result.
+          #
+          # @example Aggregate the write concern errors.
+          #   result.aggregate_write_concern_errors
+          #
+          # @return [ Array ] The aggregate write concern errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_concern_errors
+            @replies.each_with_index.reduce(nil) do |errors, (reply, i)|
+              # @todo: only raise if error is timeout
+              if error = reply_write_errors?(reply)
+                errors ||= []
+                note = reply.documents.first['wnote'] || reply.documents.first['jnote']
+                if note
+                  code = reply.documents.first['code'] || "bad value constant"
+                  error_string = "#{code}: #{note}"
+                else
+                  code = reply.documents.first['code'] || "unknown error constant"
+                  error_string = "#{code}: #{error}"
+                end
+                errors << { 'errmsg' => error_string,
+                            'index' => indexes[i],
+                            'code' => code }
+              end
+              errors
+            end
+          end
+
+          private
+
+          def reply_write_errors?(reply)
+            reply.documents.first[Error::ERROR] ||
+              reply.documents.first[Error::ERRMSG]
+          end
+
+          def upsert?(reply)
+            !reply.documents.first[UPDATED_EXISTING]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/command.rb

@@ -0,0 +1,62 @@
+# 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 } })
+    #
+    # @note A command is actually a query on the virtual '$cmd' collection.
+    #
+    # @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)
+      #
+      # @params [ Mongo::Server::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/executable.rb

@@ -0,0 +1,105 @@
+# 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 defining an operation
+    # and executing it, given a certain context.
+    #
+    # @since 2.0.0
+    module Executable
+
+      # Execute the operation.
+      # The context gets a connection on which the operation
+      # is sent in the block.
+      #
+      # @params [ Mongo::Server::Context ] The context for this operation.
+      #
+      # @return [ Result ] The operation response, if there is one.
+      #
+      # @since 2.0.0
+      def execute(context)
+        context.with_connection do |connection|
+          connection.dispatch([ message ])
+        end
+      end
+
+      # Merge this operation with another operation, returning a new one.
+      # Requires that the collection and database of the two ops are the same.
+      #
+      # @params[ Object ] The other operation.
+      #
+      # @return [ Object ] A new operation merging this one and another.
+      #
+      # @since 2.0.0
+      def merge(other)
+        # @todo: use specific exception
+        raise Exception, "Cannot merge" unless self.class == other.class &&
+            coll_name == other.coll_name &&
+            db_name == other.db_name
+        dup.merge!(other)
+      end
+
+      # Get the full namespace that this operates on.
+      #
+      # @example Get the namespace.
+      #   executable.namespace
+      #
+      # @return [ String ] The namespace.
+      #
+      # @since 2.0.0
+      def namespace
+        "#{db_name}.#{coll_name}"
+      end
+
+      # If an operation including this module doesn't define #merge!, neither
+      # #merge nor #merge! will be allowed.
+      #
+      # @params[ Object ] The other operation.
+      #
+      # @raise [ Exception ] Merging is not supported for this operation.
+      #
+      # @since 2.0.0
+      def merge!(other)
+        raise Exception, "Merging not allowed for this operation type"
+      end
+
+      private
+
+      # If it's ok that this operation be sent to a secondary server.
+      #
+      # @return [ true, false ] Whether it's ok for this op to go to a secondary.
+      #
+      # @since 2.0.0
+      def secondary_ok?
+        true
+      end
+
+      # Gets the legacy get last error command as a wire protocol query.
+      #
+      # @since 2.0.0
+      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