Sha256: 34c9595cfb85a02412a1df3b1221dd2e52d8446b6f218b127c4aebb8ac5e7c93

Contents?: true

Size: 1.6 KB

Versions: 33

Compression:

Stored size: 1.6 KB

Contents

# Copyright (C) 2015-2019 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
    class ParallelScan

      # Defines custom behavior of results in a parallel scan.
      #
      # @since 2.0.0
      class Result < Operation::Result

        # The name of the cursors field in the result.
        #
        # @since 2.0.0
        CURSORS = 'cursors'.freeze

        # Get all the cursor ids from the result.
        #
        # @example Get the cursor ids.
        #   result.cursor_ids
        #
        # @return [ Array<Integer> ] The cursor ids.
        #
        # @since 2.0.0
        def cursor_ids
          documents.map {|doc| doc[CURSOR][CURSOR_ID]}
        end

        # Get the documents from parallel scan.
        #
        # @example Get the documents.
        #   result.documents
        #
        # @return [ Array<BSON::Document> ] The documents.
        #
        # @since 2.0.0
        def documents
          reply.documents[0][CURSORS]
        end

        private

        def first
          @first ||= reply.documents[0] || {}
        end
      end
    end
  end
end

Version data entries

33 entries across 33 versions & 2 rubygems

Version Path
tdiary-5.1.6 vendor/bundle/ruby/2.7.0/gems/mongo-2.8.0/lib/mongo/operation/parallel_scan/result.rb
mongo-2.12.4 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.6 lib/mongo/operation/parallel_scan/result.rb
mongo-2.12.3 lib/mongo/operation/parallel_scan/result.rb
mongo-2.12.2 lib/mongo/operation/parallel_scan/result.rb
mongo-2.10.5 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.5 lib/mongo/operation/parallel_scan/result.rb
mongo-2.12.1 lib/mongo/operation/parallel_scan/result.rb
mongo-2.12.0.rc0 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.4 lib/mongo/operation/parallel_scan/result.rb
mongo-2.10.4 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.3 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.2 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.1 lib/mongo/operation/parallel_scan/result.rb
mongo-2.10.3 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.0 lib/mongo/operation/parallel_scan/result.rb
mongo-2.9.2 lib/mongo/operation/parallel_scan/result.rb
mongo-2.10.2 lib/mongo/operation/parallel_scan/result.rb
mongo-2.11.0.rc0 lib/mongo/operation/parallel_scan/result.rb
mongo-2.10.1 lib/mongo/operation/parallel_scan/result.rb