Contents

# Copyright (C) 2017 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 Commands
      class Explain

        # Defines custom behaviour of results in find command with explain.
        #
        # @since 2.5.0
        class Result < Operation::Result

          # Get the cursor id.
          #
          # @example Get the cursor id.
          #   result.cursor_id
          #
          # @return [ 0 ] Always 0 because explain doesn't return a cursor.
          #
          # @since 2.5.0
          def cursor_id
            0
          end

          # Get the documents in the result.
          #
          # @example Get the documents.
          #   result.documents
          #
          # @return [ Array<BSON::Document> ] The documents.
          #
          # @since 2.5.0
          def documents
            reply.documents
          end
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 2 rubygems

Version	Path
tdiary-5.0.8	vendor/bundle/gems/mongo-2.5.1/lib/mongo/operation/commands/explain/result.rb
mongo-2.5.1	lib/mongo/operation/commands/explain/result.rb
mongo-2.5.0	lib/mongo/operation/commands/explain/result.rb
mongo-2.5.0.beta	lib/mongo/operation/commands/explain/result.rb