mongo 2.0.6 → 2.1.0

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

@@ -1,118 +0,0 @@
-# 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 Read
-      class ListIndexes
-
-        # Defines custom behaviour of results when using the
-        # listIndexes command.
-        #
-        # @since 2.0.0
-        class Result < Operation::Result
-
-          # The field name for the cursor document in a listIndexes result.
-          #
-          # @since 2.0.0
-          CURSOR = 'cursor'.freeze
-
-          # The cursor id field in the cursor document.
-          #
-          # @since 2.0.0
-          CURSOR_ID = 'id'.freeze
-
-          # The namespace field in the cursor document.
-          #
-          # @since 2.0.0
-          NAMESPACE = 'ns'.freeze
-
-          # The field name for the first batch of a cursor.
-          #
-          # @since 2.0.0
-          FIRST_BATCH = 'firstBatch'.freeze
-
-          # Get the cursor id for the result.
-          #
-          # @example Get the cursor id.
-          #   result.cursor_id
-          #
-          # @note Even though the wire protocol has a cursor_id field for all
-          #   messages of type reply, it is always zero when using the
-          #   listIndexes command and must be retrieved from the cursor
-          #   document itself.
-          #
-          # @return [ Integer ] The cursor id.
-          #
-          # @since 2.0.0
-          def cursor_id
-            cursor_document ? cursor_document[CURSOR_ID] : super
-          end
-
-          # Get the namespace for the cursor.
-          #
-          # @example Get the namespace.
-          #   result.namespace
-          #
-          # @return [ String ] The namespace.
-          #
-          # @since 2.0.0
-          def namespace
-            cursor_document ? cursor_document[NAMESPACE] : super
-          end
-
-          # Get the documents for the listIndexes result. This is the 'firstBatch'
-          # field in the 'cursor' field of the first document returned.
-          #
-          # @example Get the documents.
-          #   result.documents
-          #
-          # @return [ Array<BSON::Document> ] The documents.
-          #
-          # @since 2.0.0
-          def documents
-            cursor_document[FIRST_BATCH]
-          end
-
-          # Validate the result. In the case where the database or collection
-          # does not exist on the server we will get an error, and it's better
-          # to raise a meaningful exception here than the ambiguous one when
-          # the error occurs.
-          #
-          # @example Validate the result.
-          #   result.validate!
-          #
-          # @raise [ NoNamespace ] If the ns doesn't exist.
-          #
-          # @return [ Result ] Self if successful.
-          #
-          # @since 2.0.0
-          def validate!
-            !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
-          end
-
-          private
-
-          def cursor_document
-            @cursor_document ||= first_document[CURSOR]
-          end
-
-          def first_document
-            @first_document ||= reply.documents[0]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/read/collections_info.rb

@@ -1,68 +0,0 @@
-# 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 Read
-
-      # A MongoDB operation to get a list of collection names in a database.
-      #
-      # @example Create the collection names operation.
-      #   Read::CollectionNames.new(:db_name => 'test-db')
-      #
-      # Initialization:
-      #   param [ Hash ] spec The specifications for the collection names operation.
-      #
-      #   option spec :db_name [ String ] The name of the database whose collection
-      #     names is requested.
-      #   option spec :options [ Hash ] Options for the operation.
-      #
-      # @since 2.0.0
-      class CollectionsInfo
-        include Executable
-        include Specifiable
-        include ReadPreferrable
-
-        # Execute the operation.
-        # The context gets a connection on which the operation
-        # is sent in the block.
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation response, if there is one.
-        #
-        # @since 2.0.0
-        def execute(context)
-          if context.features.list_collections_enabled?
-            ListCollections.new(spec).execute(context)
-          else
-            context.with_connection do |connection|
-              Result.new(connection.dispatch([ message(context) ])).validate!
-            end
-          end
-        end
-
-        private
-
-        def selector
-          { :name => { '$not' => /system\.|\$/ } }
-        end
-
-        def query_coll
-          Database::NAMESPACES
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/read/indexes.rb

@@ -1,69 +0,0 @@
-# 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 Read
-
-      # A MongoDB get indexes operation.
-      #
-      # Initialize the get indexes operation.
-      #
-      # @example Instantiate the operation.
-      #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
-      #
-      # Initialization:
-      #   param [ Hash ] spec The specifications for the insert.
-      #
-      #   option spec :db_name [ String ] The name of the database.
-      #   option spec :coll_name [ String ] The name of the collection.
-      #
-      # @since 2.0.0
-      class Indexes
-        include Executable
-        include Specifiable
-        include ReadPreferrable
-
-        # Execute the operation.
-        # The context gets a connection on which the operation
-        # is sent in the block.
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The indexes operation response.
-        #
-        # @since 2.0.0
-        def execute(context)
-          if context.features.list_indexes_enabled?
-            ListIndexes.new(spec).execute(context)
-          else
-            context.with_connection do |connection|
-              Result.new(connection.dispatch([ message(context) ]))
-            end
-          end
-        end
-
-        private
-
-        def selector
-          { ns: namespace }
-        end
-
-        def query_coll
-          Index::COLLECTION
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/read/list_collections.rb

@@ -1,76 +0,0 @@
-# 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/list_collections/result'
-
-module Mongo
-  module Operation
-    module Read
-
-      # A MongoDB listCollections command operation.
-      #
-      # @example Create the listCollections command operation.
-      #   Mongo::Operation::Read::ListCollections.new(db_name: 'test')
-      #
-      # @note A command is actually a query on the virtual '$cmd' collection.
-      #
-      # Initialization:
-      #   param [ Hash ] spec The specifications for the command.
-      #
-      #   option spec :db_name [ String ] The name of the database whose list of
-      #     collection names is requested.
-      #   option spec :options [ Hash ] Options for the command.
-      #
-      # @since 2.0.0
-      class ListCollections
-        include Executable
-        include Specifiable
-        include Limited
-        include ReadPreferrable
-
-        # Execute the listCollections command 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)
-          execute_message(context)
-        end
-
-        private
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message(context) ])).validate!
-          end
-        end
-
-        def query_coll
-          Database::COMMAND
-        end
-
-        def selector
-          (spec[SELECTOR] || {}).merge(
-            listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
-          )
-        end
-      end
-    end
-  end
-end

data/lib/mongo/operation/read/list_indexes.rb

@@ -1,78 +0,0 @@
-# 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/list_indexes/result'
-
-module Mongo
-  module Operation
-    module Read
-
-      # A MongoDB listIndexes command operation.
-      #
-      # @example Create the listIndexes command operation.
-      #   Mongo::Operation::Read::ListIndexes.new({ db_name: 'test', coll_name: 'example' })
-      #
-      # @note A command is actually a query on the virtual '$cmd' collection.
-      #
-      # Initialization:
-      #   param [ Hash ] spec The specifications for the command.
-      #
-      #   option spec :coll_name [ Hash ] The name of the collection whose index
-      #     info is requested.
-      #   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 ListIndexes
-        include Executable
-        include Specifiable
-        include Limited
-        include ReadPreferrable
-
-        # Execute the listIndexes command 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)
-          execute_message(context)
-        end
-
-        private
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message(context) ])).validate!
-          end
-        end
-
-        def query_coll
-          Database::COMMAND
-        end
-
-        def selector
-          (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
-        end
-      end
-    end
-  end
-end
-
-

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

@@ -1,75 +0,0 @@
-# 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/bulk_mergable'
-require 'mongo/operation/write/bulk/legacy_bulk_mergable'
-
-module Mongo
-  module Operation
-    module Write
-      class BulkDelete
-
-        # Defines custom behaviour of results when deleting.
-        #
-        # @since 2.0.0
-        class Result < Operation::Result
-          include BulkMergable
-
-          # 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 LegacyBulkMergable
-
-          # 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

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

@@ -1,145 +0,0 @@
-# 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/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
-      #   })
-      #
-      # 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 BulkDelete
-        include Executable
-        include Specifiable
-
-        # Execute the delete operation.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] 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)
-        #
-        # @param [ Hash ] wc 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
-
-        private
-
-        def execute_write_command(context)
-          Result.new(Command::Delete.new(spec).execute(context))
-        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
-              else
-                result.reply
-              end
-            end
-          end
-          LegacyResult.new(replies.compact.empty? ? nil : replies)
-        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 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