mongo 2.1.0.beta → 2.1.0.rc0

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

@@ -0,0 +1,129 @@
+# 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 Insert
+
+          # Defines custom behaviour of results when inserting.
+          #
+          # @since 2.0.0
+          class Result < Operation::Result
+            include Mergable
+
+            # Get the ids of the inserted documents.
+            #
+            # @since 2.0.0
+            attr_reader :inserted_ids
+
+            # Initialize a new result.
+            #
+            # @example Instantiate the result.
+            #   Result.new(replies, inserted_ids)
+            #
+            # @param [ Protocol::Reply ] replies The wire protocol replies.
+            # @param [ Array<Object> ] ids The ids of the inserted documents.
+            #
+            # @since 2.0.0
+            def initialize(replies, ids)
+              @replies = replies.is_a?(Protocol::Reply) ? [ replies ] : replies
+              @inserted_ids = ids
+            end
+
+            # 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
+
+            # Gets the id of the document inserted.
+            #
+            # @example Get id of the document inserted.
+            #   result.inserted_id
+            #
+            # @return [ Object ] The id of the document inserted.
+            #
+            # @since 2.0.0
+            def inserted_id
+              inserted_ids.first
+            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 LegacyMergable
+
+            # Get the ids of the inserted documents.
+            #
+            # @since 2.0.0
+            attr_reader :inserted_ids
+
+            # Initialize a new result.
+            #
+            # @example Instantiate the result.
+            #   Result.new(replies, inserted_ids)
+            #
+            # @param [ Protocol::Reply ] replies The wire protocol replies.
+            # @param [ Array<Object> ] ids The ids of the inserted documents.
+            #
+            # @since 2.0.0
+            def initialize(replies, ids)
+              @replies = replies.is_a?(Protocol::Reply) ? [ replies ] : replies
+              @inserted_ids = ids
+            end
+
+            # 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
+
+            # Gets the id of the document inserted.
+            #
+            # @example Get id of the document inserted.
+            #   result.inserted_id
+            #
+            # @return [ Object ] The id of the document inserted.
+            #
+            # @since 2.0.0
+            def inserted_id
+              inserted_ids.first
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# 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
+
+        # This module contains common functionality for merging results from
+        # writes during a bulk operation. Used for server versions < 2.6.
+        #
+        # @since 2.0.0
+        module LegacyMergable
+
+          # Aggregate the write errors returned from this result.
+          #
+          # @example Aggregate the write errors.
+          #   result.aggregate_write_errors(0)
+          #
+          # @param [ Integer ] count The number of documents already executed.
+          #
+          # @return [ Array ] The aggregate write errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_errors(count)
+            @replies.each_with_index.reduce(nil) do |errors, (reply, i)|
+              if reply_write_errors?(reply)
+                errors ||= []
+                errors << { 'errmsg' => reply.documents.first[Error::ERROR],
+                            'index' => count + 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(4)
+          #
+          # @param [ Integer ] count The number of documents already executed.
+          #
+          # @return [ Array ] The aggregate write concern errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_concern_errors(count)
+            @replies.each_with_index.reduce(nil) do |errors, (reply, i)|
+              if error = reply_write_errors?(reply)
+                errors ||= []
+                if note = reply.documents.first['wnote'] || reply.documents.first['jnote']
+                  code = reply.documents.first['code'] || Error::BAD_VALUE
+                  error_string = "#{code}: #{note}"
+                elsif error == 'timeout'
+                  code = reply.documents.first['code'] || Error::UNKNOWN_ERROR
+                  error_string = "#{code}: #{error}"
+                end
+                errors << { 'errmsg' => error_string,
+                            'index' => count + i,
+                            'code' => code } if error_string
+              end
+              errors
+            end
+          end
+
+          private
+
+          def reply_write_errors?(reply)
+            reply.documents.first[Error::ERROR] ||
+              reply.documents.first[Error::ERRMSG]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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
+
+        # This module contains common functionality for merging results from
+        # write commands during a bulk operation. Used for server versions >= 2.6.
+        #
+        # @since 2.0.0
+        module Mergable
+
+          # Aggregate the write errors returned from this result.
+          #
+          # @example Aggregate the write errors.
+          #   result.aggregate_write_errors(0)
+          #
+          # @param [ Integer ] count The number of documents already executed.
+          #
+          # @return [ Array ] The aggregate write errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_errors(count)
+            @replies.reduce(nil) do |errors, reply|
+              if write_errors = reply.documents.first[Error::WRITE_ERRORS]
+                wes = write_errors.collect do |we|
+                  we.merge!('index' => count + we['index'])
+                end
+                (errors || []) << wes if wes
+              end
+            end
+          end
+
+          # Aggregate the write concern errors returned from this result.
+          #
+          # @example Aggregate the write concern errors.
+          #   result.aggregate_write_concern_errors(100)
+          #
+          # @param [ Integer ] count The number of documents already executed.
+          #
+          # @return [ Array ] The aggregate write concern errors.
+          #
+          # @since 2.0.0
+          def aggregate_write_concern_errors(count)
+            @replies.each_with_index.reduce(nil) do |errors, (reply, i)|
+              if write_concern_errors = reply.documents.first[Error::WRITE_CONCERN_ERRORS]
+                (errors || []) << write_concern_errors.reduce(nil) do |errs, wce|
+                    wce.merge!('index' => count + wce['index'])
+                    (errs || []) << write_concern_error
+                end
+              end
+            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[:multi]
+              opts[:flags] << :upsert if !!u[:upsert]
+              Protocol::Update.new(db_name, coll_name, u[:q], u[:u], opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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