mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/operation/write.rb

@@ -0,0 +1,25 @@
+# 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/delete'
+require 'mongo/operation/write/bulk_delete'
+require 'mongo/operation/write/insert'
+require 'mongo/operation/write/bulk_insert'
+require 'mongo/operation/write/update'
+require 'mongo/operation/write/bulk_update'
+require 'mongo/operation/write/create_index'
+require 'mongo/operation/write/drop_index'
+require 'mongo/operation/write/create_user'
+require 'mongo/operation/write/remove_user'
+require 'mongo/operation/write/command'

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

@@ -0,0 +1,158 @@
+# 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/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
+        include Batchable
+
+        # Execute the delete operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @params [ Mongo::Server::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)
+        #
+        # @params [ Hash ] 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
+
+        # The index of each delete as it was added onto the bulk object.
+        #
+        # @params [ Integer ] The index of each delete.
+        #
+        # @since 2.0.0
+        def indexes
+          @spec[:indexes] || []
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::Delete.new(spec).execute(context)).set_indexes(indexes)
+        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.set_indexes(indexes)
+              else
+                result.reply
+              end
+            end
+          end
+          LegacyResult.new(replies.compact.empty? ? nil : replies).set_indexes(indexes)
+        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 batch_key
+          DELETES
+        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_insert.rb

@@ -0,0 +1,160 @@
+# 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/bulk_insert/result'
+
+module Mongo
+  module Operation
+    module Write
+
+      # 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
+      #   })
+      #
+      # @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 BulkInsert
+        include Executable
+        include Specifiable
+        include Batchable
+
+        # Execute the bulk insert 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)
+          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)
+        #
+        # @params [ Hash ] 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
+
+        # The index of each document as it was added onto the bulk object.
+        #
+        # @params [ Integer ] The index of each document.
+        #
+        # @since 2.0.0
+        def indexes
+          @spec[:indexes] || []
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::Insert.new(spec).execute(context)).set_indexes(indexes)
+        end
+
+        def execute_message(context)
+          replies = []
+          messages.map do |m|
+            context.with_connection do |connection|
+              result = LegacyResult.new(connection.dispatch([ m, gle ].compact))
+              replies << result.reply
+              if stop_sending?(result)
+                return LegacyResult.new(replies).set_indexes(indexes)
+              end
+            end
+          end
+          LegacyResult.new(replies.compact.empty? ? nil : replies).set_indexes(indexes)
+        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 batch_key
+          DOCUMENTS
+        end
+
+        def initialize_copy(original)
+          @spec = original.spec.dup
+          @spec[DOCUMENTS] = original.spec[DOCUMENTS].dup
+        end
+
+        def messages
+          if ordered? || gle
+            documents.collect do |doc|
+              Protocol::Insert.new(db_name, coll_name, [ doc ], options)
+            end
+          else
+            [ Protocol::Insert.new(db_name, coll_name, documents, { :flags => [:continue_on_error] }) ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# 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/bulk_update/result'
+
+module Mongo
+  module Operation
+    module Write
+
+      # 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
+      #   })
+      #
+      # @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 BulkUpdate
+        include Executable
+        include Specifiable
+        include Batchable
+
+        # Execute the update 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)
+          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)
+        #
+        # @params [ Hash ] 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
+
+        # The index of each update as it was added onto the bulk object.
+        #
+        # @params [ Integer ] The index of each update.
+        #
+        # @since 2.0.0
+        def indexes
+          @spec[:indexes] || []
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::Update.new(spec).execute(context)).set_indexes(indexes)
+        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.set_indexes(indexes)
+              else
+                result.reply
+              end
+            end
+          end
+          LegacyResult.new(replies.compact.empty? ? nil : replies).set_indexes(indexes)
+        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 batch_key
+          UPDATES
+        end
+
+        def initialize_copy(original)
+          @spec = original.spec.dup
+          @spec[UPDATES] = original.spec[UPDATES].dup
+        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