Class: Mongo::Operation::Delete::Result Private

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

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defines custom behavior of results for a delete.

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

Attributes inherited from Result

#connection_description, #replies

Instance Method Summary collapse

Methods inherited from Result

#acknowledged?, #cluster_time, #cursor_id, #documents, #each, #error, #initialize, #inspect, #labels, #namespace, #ok?, #operation_time, #reply, #returned_count, #successful?, #topology_version, #validate!, #write_concern_error?, #written_count

Constructor Details

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

Instance Method Details

#bulk_result ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0



36
37
38
 
# File 'lib/mongo/operation/delete/result.rb', line 36

def bulk_result
  BulkResult.new(@replies, connection_description)
end

#deleted_count ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the number of documents deleted.

Examples:

Get the deleted count.

result.deleted_count

Returns:

  • (Integer) —

    The deleted count.

Since:

  • 2.0.0



32
33
34
 
# File 'lib/mongo/operation/delete/result.rb', line 32

def deleted_count
  n
end