Class: Mongo::Operation::Write::Bulk::Insert::Result

Inherits:
Result
  • Object
show all
Includes:
Mergable
Defined in:
lib/mongo/operation/write/bulk/insert/result.rb

Overview

Defines custom behaviour of results when inserting.

Since:

  • 2.0.0

Constant Summary

Constants inherited from Result

Result::CURSOR, Result::CURSOR_ID, Result::FIRST_BATCH, Result::N, Result::NAMESPACE, Result::NEXT_BATCH, Result::OK, Result::RESULT

Instance Attribute Summary collapse

Attributes inherited from Result

#replies

Instance Method Summary collapse

Methods included from Mergable

#aggregate_write_concern_errors, #aggregate_write_errors

Methods inherited from Result

#acknowledged?, #cursor_id, #documents, #each, #inspect, #multiple?, #namespace, #ok?, #reply, #returned_count, #successful?, #validate!, #written_count

Constructor Details

#initialize(replies, ids) ⇒ Result

Initialize a new result.

Examples:

Instantiate the result.

Result.new(replies, inserted_ids)

Parameters:

  • replies (Protocol::Reply) —

    The wire protocol replies.

  • ids (Array<Object>) —

    The ids of the inserted documents.

Since:

  • 2.0.0



41
42
43
44
 
# File 'lib/mongo/operation/write/bulk/insert/result.rb', line 41

def initialize(replies, ids)
  @replies = replies.is_a?(Protocol::Reply) ? [ replies ] : replies
  @inserted_ids = ids
end

Instance Attribute Details

#inserted_ids ⇒ Object (readonly)

Get the ids of the inserted documents.

Since:

  • 2.0.0



30
31
32
 
# File 'lib/mongo/operation/write/bulk/insert/result.rb', line 30

def inserted_ids
  @inserted_ids
end

Instance Method Details

#inserted_id ⇒ Object

Gets the id of the document inserted.

Examples:

Get id of the document inserted.

result.inserted_id

Returns:

  • (Object) —

    The id of the document inserted.

Since:

  • 2.0.0



66
67
68
 
# File 'lib/mongo/operation/write/bulk/insert/result.rb', line 66

def inserted_id
  inserted_ids.first
end

#n_inserted ⇒ Integer

Gets the number of documents inserted.

Examples:

Get the number of documents inserted.

result.n_inserted

Returns:

  • (Integer) —

    The number of documents inserted.

Since:

  • 2.0.0



54
55
56
 
# File 'lib/mongo/operation/write/bulk/insert/result.rb', line 54

def n_inserted
  written_count
end