Class: Mongo::Operation::Write::Update::Result

Inherits:
Result
  • Object
show all
Defined in:
lib/mongo/operation/write/update/result.rb

Overview

Defines custom behaviour of results for an update.

Since:

  • 2.0.0

Constant Summary

MODIFIED =

The number of modified docs field in the result.

Since:

  • 2.0.0

'nModified'.freeze
UPSERTED =

The upserted docs field in the result.

Since:

  • 2.0.0

'upserted'.freeze

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

Attributes inherited from Result

#replies

Instance Method Summary collapse

Methods inherited from Result

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

Constructor Details

This class inherits a constructor from Mongo::Operation::Result

Instance Method Details

#matched_countInteger

Get the number of documents matched.

Examples:

Get the matched count.

result.matched_count

Returns:

  • (Integer)

    The matched count.

Since:

  • 2.0.0



43
44
45
46
47
48
49
50
# File 'lib/mongo/operation/write/update/result.rb', line 43

def matched_count
  return 0 unless acknowledged?
  if upsert?
    0
  else
    n
  end
end

#modified_countInteger

Get the number of documents modified.

Examples:

Get the modified count.

result.modified_count

Returns:

  • (Integer)

    The modified count.

Since:

  • 2.0.0



60
61
62
63
# File 'lib/mongo/operation/write/update/result.rb', line 60

def modified_count
  return 0 unless acknowledged?
  first[MODIFIED]
end

#upserted_countInteger

Returns the number of documents upserted.

Examples:

Get the number of upserted documents.

result.upserted_count

Returns:

  • (Integer)

    The number upserted.

Since:

  • 2.4.2



87
88
89
# File 'lib/mongo/operation/write/update/result.rb', line 87

def upserted_count
  upsert? ? n : 0
end

#upserted_idObject

The identifier of the inserted document if an upsert

took place.

Examples:

Get the upserted document's identifier.

result.upserted_id

Returns:

  • (Object)

    The upserted id.

Since:

  • 2.0.0



74
75
76
77
# File 'lib/mongo/operation/write/update/result.rb', line 74

def upserted_id
  return nil unless upsert?
  upsert?.first['_id']
end