mongo 2.0.6 → 2.1.0

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

@@ -0,0 +1,82 @@
+# 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
+
+        # Provides common behavior for bulk write operations.
+        # Note that #validate! is not called on operation results because they are merged
+        # at a higher level.
+        #
+        # @since 2.1.0
+        module Bulkable
+
+          # Execute the bulk 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_message(context)
+            replies = messages.map do |m|
+              context.with_connection do |connection|
+                result = self.class::LegacyResult.new(connection.dispatch([ m, gle ].compact, operation_id))
+                if stop_sending?(result)
+                  return result
+                else
+                  result.reply
+                end
+              end
+            end
+            self.class::LegacyResult.new(replies.compact.empty? ? nil : replies)
+          end
+
+          def stop_sending?(result)
+            ordered? && !result.successful?
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# 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 Delete
+
+          # Defines custom behaviour of results when deleting.
+          #
+          # @since 2.0.0
+          class Result < Operation::Result
+            include Mergable
+
+            # 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 LegacyMergable
+
+            # 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
+end

data/lib/mongo/operation/write/bulk/delete.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.
+
+require 'mongo/operation/write/bulk/delete/result'
+
+module Mongo
+  module Operation
+    module Write
+      module Bulk
+
+        # 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::Bulk::Delete.new({
+        #     :deletes => [{ :q => { :foo => 1 }, :limit => 1 }],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern
+        #   })
+        #
+        # Initialization:
+        #   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 Delete
+          include Bulkable
+          include Specifiable
+
+          private
+
+          def execute_write_command(context)
+            Result.new(Command::Delete.new(spec).execute(context))
+          end
+
+          def messages
+            deletes.collect do |del|
+              opts = ( del[Operation::LIMIT] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
+              Protocol::Delete.new(db_name, coll_name, del[Operation::Q], opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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/insert.rb

@@ -0,0 +1,96 @@
+# 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/insert/result'
+
+module Mongo
+  module Operation
+    module Write
+      module Bulk
+
+        # A MongoDB bulk insert operation.
+        # This class should only be used by the Bulk API.
+        #
+        # @note If a server with version >= 2.5.5 is being used, a write command
+        #   operation will be created and sent instead.
+        #
+        # @example Create the new insert operation.
+        #   Write::BulkInsert.new({
+        #     :documents => [{ :foo => 1 }],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern,
+        #     :ordered => false
+        #   })
+        #
+        # Initialization:
+        #   param [ Hash ] spec The specifications for the insert.
+        #
+        #   option spec :documents [ Array ] The documents to insert.
+        #   option spec :db_name [ String ] The name of the database.
+        #   option spec :coll_name [ String ] The name of the collection.
+        #   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 Insert
+          include Bulkable
+          include Specifiable
+          include Idable
+
+          private
+
+          def execute_write_command(context)
+            command_spec = spec.merge(:documents => ensure_ids(documents))
+            Result.new(Command::Insert.new(command_spec).execute(context), @ids)
+          end
+
+          def execute_message(context)
+            replies = []
+            messages.map do |m|
+              context.with_connection do |connection|
+                result = LegacyResult.new(connection.dispatch([ m, gle ].compact, operation_id), @ids)
+                replies << result.reply
+                if stop_sending?(result)
+                  return LegacyResult.new(replies, @ids)
+                end
+              end
+            end
+            LegacyResult.new(replies.compact.empty? ? nil : replies, @ids)
+          end
+
+          def messages
+            if ordered? || gle
+              documents.collect do |doc|
+                Protocol::Insert.new(db_name, coll_name, ensure_ids([ doc ]), spec)
+              end
+            else
+              [
+                Protocol::Insert.new(
+                  db_name,
+                  coll_name,
+                  ensure_ids(documents),
+                  spec.merge({ :flags => [:continue_on_error] })
+                )
+              ]
+            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