mongo 1.12.5 → 2.0.0.beta

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

@@ -0,0 +1,98 @@
+# 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
+
+      # A MongoDB 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::Update.new({
+      #     :update =>
+      #       {
+      #         :q => { :foo => 1 },
+      #         :u => { :$set => { :bar => 1 }},
+      #         :multi  => true,
+      #         :upsert => false
+      #       },
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :write_concern => write_concern
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the update.
+      #
+      # @option spec :update [ Hash ] The update document.
+      # @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 :options [ Hash ] Options for the command, if it ends up being a
+      #   write command.
+      #
+      # @since 2.0.0
+      class Update
+        include Executable
+        include Specifiable
+
+        # 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
+
+        private
+
+        def execute_write_command(context)
+          s = spec.merge(:updates => [ update ])
+          s.delete(:update)
+          Result.new(Command::Update.new(s).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def initialize_copy(original)
+          @spec = original.spec.dup
+          @spec[:updates] = original.spec[:updates].dup
+        end
+
+        def message(update_spec = {})
+          opts = update[:multi] ? { :flags => [:multi_update] } : {}
+          Protocol::Update.new(db_name, coll_name, update[:q], update[:u], opts)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/protocol.rb

@@ -0,0 +1,15 @@
+# Wire Protocol Base
+require 'mongo/protocol/serializers'
+require 'mongo/protocol/bit_vector'
+require 'mongo/protocol/message'
+
+# Client Requests
+require 'mongo/protocol/delete'
+require 'mongo/protocol/get_more'
+require 'mongo/protocol/insert'
+require 'mongo/protocol/kill_cursors'
+require 'mongo/protocol/query'
+require 'mongo/protocol/update'
+
+# Server Responses
+require 'mongo/protocol/reply'

data/lib/mongo/protocol/bit_vector.rb

@@ -0,0 +1,61 @@
+# 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 Protocol
+    module Serializers
+      # Class used to define a bitvector for a MongoDB wire protocol message.
+      #
+      # Defines serialization strategy upon initialization.
+      #
+      # @api private
+      class BitVector
+
+        # Initializes a BitVector with a layout
+        #
+        # @param layout [Array<Symbol>] the array of fields in the bit vector
+        def initialize(layout)
+          @masks = {}
+          layout.each_with_index do |field, index|
+            @masks[field] = 2**index
+          end
+        end
+
+        # Serializes vector by encoding each symbol according to its mask
+        #
+        # @param buffer [IO] Buffer to receive the serialized vector
+        # @param value [Array<Symbol>] Array of flags to encode
+        # @return [IO] Buffer that received the serialized vector
+        def serialize(buffer, value)
+          bits = 0
+          value.each { |flag| bits |= @masks[flag] }
+          buffer << [bits].pack(INT32_PACK)
+        end
+
+        # Deserializes vector by decoding the symbol according to its mask
+        #
+        # @param io [IO] Stream containing the vector to be deserialized
+        # @return [Array<Symbol>] Flags contained in the vector
+        def deserialize(io)
+          vector = io.read(4).unpack(INT32_PACK).first
+          flags = []
+          @masks.each do |flag, mask|
+            flags << flag if mask & vector != 0
+          end
+          flags
+        end
+      end
+    end
+  end
+end

data/lib/mongo/protocol/delete.rb

@@ -0,0 +1,94 @@
+# 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 Protocol
+
+    # MongoDB Wire protocol Delete message.
+    #
+    # This is a client request message that is sent to the server in order
+    # to delete selected documents in the specified namespace.
+    #
+    # The operation, by default, operates on many documents. Setting
+    # the +:single_remove+ flag allows for a single matching document
+    # to be removed.
+    #
+    # @api semipublic
+    class Delete < Message
+
+      # Creates a new Delete message
+      #
+      # @example Remove all users named Tyler.
+      #   Query.new('xgen', 'users', {:name => 'Tyler'})
+      #
+      # @param database [String, Symbol] The database to remove from.
+      # @param collection [String, Symbol] The collection to remove from.
+      # @param selector [Hash] The query used to select doc(s) to remove.
+      # @param options [Hash] The additional delete options.
+      #
+      # @option options :flags [Array] The flags for the delete message.
+      #
+      #   Supported flags: +:single_remove+
+      def initialize(database, collection, selector, options = {})
+        @namespace = "#{database}.#{collection}"
+        @selector  = selector
+        @flags     = options[:flags] || []
+      end
+
+      # The log message for a delete operation.
+      #
+      # @example Get the log message.
+      #   delete.log_message
+      #
+      # @return [ String ] The log message
+      #
+      # @since 2.0.0
+      def log_message
+        fields = []
+        fields << ["%s |", "DELETE"]
+        fields << ["namespace=%s", namespace]
+        fields << ["selector=%s", selector.inspect]
+        fields << ["flags=%s", flags.inspect]
+        f, v = fields.transpose
+        f.join(" ") % v
+      end
+
+      private
+
+      # The operation code required to specify a Delete message.
+      # @return [Fixnum] the operation code.
+      def op_code
+        2006
+      end
+
+      # Available flags for a Delete message.
+      FLAGS = [:single_remove]
+
+      # Field representing Zero encoded as an Int32.
+      field :zero, Zero
+
+      # @!attribute
+      # @return [String] The namespace for this Delete message.
+      field :namespace, CString
+
+      # @!attribute
+      # @return [Array<Symbol>] The flags for this Delete message.
+      field :flags, BitVector.new(FLAGS)
+
+      # @!attribute
+      # @return [Hash] The selector for this Delete message.
+      field :selector, Document
+    end
+  end
+end

data/lib/mongo/protocol/get_more.rb

@@ -0,0 +1,99 @@
+# 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 Protocol
+
+    # MongoDB Wire protocol GetMore message.
+    #
+    # This is a client request message that is sent to the server in order
+    # to retrieve additional documents from a cursor that has already been
+    # instantiated.
+    #
+    # The operation requires that you specify the database and collection
+    # name as well as the cursor id because cursors are scoped to a namespace.
+    #
+    # @api semipublic
+    class GetMore < Message
+
+      # Creates a new GetMore message
+      #
+      # @example Get 15 additional documents from cursor 123 in 'xgen.users'.
+      #   GetMore.new('xgen', 'users', 15, 123)
+      #
+      # @param database [String, Symbol] The database to query.
+      # @param collection [String, Symbol] The collection to query.
+      # @param number_to_return [Integer] The number of documents to return.
+      # @param cursor_id [Integer] The cursor id returned in a reply.
+      def initialize(database, collection, number_to_return, cursor_id)
+        @namespace = "#{database}.#{collection}"
+        @number_to_return = number_to_return
+        @cursor_id = cursor_id
+      end
+
+      # The log message for a get more operation.
+      #
+      # @example Get the log message.
+      #   get_more.log_message
+      #
+      # @return [ String ] The log message
+      #
+      # @since 2.0.0
+      def log_message
+        fields = []
+        fields << ["%s |", "GETMORE"]
+        fields << ["namespace=%s", namespace]
+        fields << ["number_to_return=%s", number_to_return]
+        fields << ["cursor_id=%s", cursor_id]
+        f, v = fields.transpose
+        f.join(" ") % v
+      end
+
+      # Get more messages require replies from the database.
+      #
+      # @example Does the message require a reply?
+      #   message.replyable?
+      #
+      # @return [ true ] Always true for get more.
+      #
+      # @since 2.0.0
+      def replyable?
+        true
+      end
+
+      private
+
+      # The operation code required to specify a GetMore message.
+      # @return [Fixnum] the operation code.
+      def op_code
+        2005
+      end
+
+      # Field representing Zero encoded as an Int32
+      field :zero, Zero
+
+      # @!attribute
+      # @return [String] The namespace for this GetMore message.
+      field :namespace, CString
+
+      # @!attribute
+      # @return [Fixnum] The number to return for this GetMore message.
+      field :number_to_return, Int32
+
+      # @!attribute
+      # @return [Fixnum] The cursor id to get more documents from.
+      field :cursor_id, Int64
+    end
+  end
+end

data/lib/mongo/protocol/insert.rb

@@ -0,0 +1,99 @@
+# 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 Protocol
+
+    # MongoDB Wire protocol Insert message.
+    #
+    # This is a client request message that is sent to the server in order
+    # to insert documents within a namespace.
+    #
+    # The operation only has one flag +:continue_on_error+ which the user
+    # can use to instruct the database server to continue processing a bulk
+    # insertion if one happens to fail (e.g. due to duplicate IDs). This makes
+    # builk insert behave similarly to a seires of single inserts, except
+    # lastError will be set if any insert fails, not just the last one.
+    #
+    # If multiple errors occur, only the most recent will be reported by the
+    # getLastError mechanism.
+    #
+    # @api semipublic
+    class Insert < Message
+
+      # Creates a new Insert message
+      #
+      # @example Insert a user document
+      #   Insert.new('xgen', 'users', [{:name => 'Tyler'}])
+      #
+      # @example Insert serveral user documents and continue on errors
+      #   Insert.new('xgen', 'users', users, :flags => [:continue_on_error])
+      #
+      # @param database [String, Symbol]  The database to insert into.
+      # @param collection [String, Symbol] The collection to insert into.
+      # @param documents [Array<Hash>] The documents to insert.
+      # @param options [Hash] Additional options for the insertion.
+      #
+      # @option options :flags [Array] The flags for the insertion message.
+      #
+      #   Supported flags: +:continue_on_error+
+      def initialize(database, collection, documents, options = {})
+        @namespace = "#{database}.#{collection}"
+        @documents = documents
+        @flags = options[:flags] || []
+      end
+
+      # The log message for a insert operation.
+      #
+      # @example Get the log message.
+      #   insert.log_message
+      #
+      # @return [ String ] The log message
+      #
+      # @since 2.0.0
+      def log_message
+        fields = []
+        fields << ["%s |", "INSERT"]
+        fields << ["namespace=%s", namespace]
+        fields << ["documents=%s", documents.inspect]
+        fields << ["flags=%s", flags.inspect]
+        f, v = fields.transpose
+        f.join(" ") % v
+      end
+
+      private
+
+      # The operation code required to specify an Insert message.
+      # @return [Fixnum] the operation code.
+      def op_code
+        2002
+      end
+
+      # Available flags for an Insert message.
+      FLAGS = [:continue_on_error]
+
+      # @!attribute
+      # @return [Array<Symbol>] The flags for this Insert message.
+      field :flags, BitVector.new(FLAGS)
+
+      # @!attribute
+      # @return [String] The namespace for this Insert message.
+      field :namespace, CString
+
+      # @!attribute
+      # @return [Array<Hash>] The documents to insert.
+      field :documents, Document, true
+    end
+  end
+end