Sha256: c162ac5706872ccedabf5848d39f648a73646e6a21595d7b93d9eed6817ea881

Contents?: true

Size: 1.87 KB

Versions: 33

Compression:

Stored size: 1.87 KB

Contents

# Copyright (C) 2014-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 Insert

      # Defines custom behavior of results for an insert.
      #
      # According to the CRUD spec, reporting the inserted ids
      # is optional. It can be added to this class later, if needed.
      #
      # @since 2.0.0
      class Result < Operation::Result

        # Get the ids of the inserted documents.
        #
        # @since 2.0.0
        attr_reader :inserted_ids

        # Initialize a new result.
        #
        # @example Instantiate the result.
        #   Result.new(replies, inserted_ids)
        #
        # @param [ Array<Protocol::Message> | nil ] replies The wire protocol replies, if any.
        # @param [ Array<Object> ] ids The ids of the inserted documents.
        #
        # @since 2.0.0
        def initialize(replies, ids)
          @replies = [*replies] if replies
          @inserted_ids = ids
        end

        # Gets the id of the document inserted.
        #
        # @example Get id of the document inserted.
        #   result.inserted_id
        #
        # @return [ Object ] The id of the document inserted.
        #
        # @since 2.0.0
        def inserted_id
          inserted_ids.first
        end

        def bulk_result
          BulkResult.new(@replies, @inserted_ids)
        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/insert/result.rb
mongo-2.12.4 lib/mongo/operation/insert/result.rb
mongo-2.11.6 lib/mongo/operation/insert/result.rb
mongo-2.12.3 lib/mongo/operation/insert/result.rb
mongo-2.12.2 lib/mongo/operation/insert/result.rb
mongo-2.10.5 lib/mongo/operation/insert/result.rb
mongo-2.11.5 lib/mongo/operation/insert/result.rb
mongo-2.12.1 lib/mongo/operation/insert/result.rb
mongo-2.12.0.rc0 lib/mongo/operation/insert/result.rb
mongo-2.11.4 lib/mongo/operation/insert/result.rb
mongo-2.10.4 lib/mongo/operation/insert/result.rb
mongo-2.11.3 lib/mongo/operation/insert/result.rb
mongo-2.11.2 lib/mongo/operation/insert/result.rb
mongo-2.11.1 lib/mongo/operation/insert/result.rb
mongo-2.10.3 lib/mongo/operation/insert/result.rb
mongo-2.11.0 lib/mongo/operation/insert/result.rb
mongo-2.9.2 lib/mongo/operation/insert/result.rb
mongo-2.10.2 lib/mongo/operation/insert/result.rb
mongo-2.11.0.rc0 lib/mongo/operation/insert/result.rb
mongo-2.10.1 lib/mongo/operation/insert/result.rb