123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Operation::Insert::BulkResult

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Mongo::Operation::Result, Forwardable
Instance Chain:
self, Aggregatable, ::Mongo::Operation::Result, Enumerable
Inherits: Mongo::Operation::Result
Defined in: lib/mongo/operation/insert/bulk_result.rb

Overview

Defines custom behavior of results for an insert when sent as part of a bulk write.

Since:

  • 2.0.0

Constant Summary

::Mongo::Operation::Result - Inherited

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

Class Method Summary

::Mongo::Operation::Result - Inherited

.new

Initialize a new result.

Instance Attribute Summary

::Mongo::Operation::Result - Inherited

#acknowledged?

Is the result acknowledged?
#connection, #connection_description, #connection_global_id, #context,
#has_cursor_id?

Whether the result contains cursor_id.
#ok?

Check the first document’s ok field.
#replies,
#successful?

If the result was a command then determine if it was considered a success.
#write_concern_error?

Whether the operation failed with a write concern error.
#query_failure?

Instance Method Summary

::Mongo::Operation::Result - Inherited

#cluster_time

Get the cluster time reported in the server response.
#cursor_id

Get the cursor id if the response is acknowledged.
#documents

Get the documents in the result.
#each

Iterate over the documents in the replies.
#error

The exception instance (of Error::OperationFailure::Family) that would be raised during processing of this result.
#inspect

Get the pretty formatted inspection of the result.
#labels

Gets the set of error labels associated with the result.
#n

Alias for Result#written_count.
#namespace

Get the namespace of the cursor.
#operation_time

Get the operation time reported in the server response.
#reply

Get the reply from the result.
#returned_count

Get the number of documents returned by the server in this batch.
#snapshot_timestamp, #topology_version,
#validate!

Validate the result by checking for any errors.
#written_count

Get the number of documents written by the server.
#aggregate_returned_count, #aggregate_written_count, #first_document, #operation_failure_class, #parser,
#raise_operation_failure

Raises a Mongo::OperationFailure exception corresponding to the error information in this result.

Instance Attribute Details

#inserted_ids (readonly)

Get the ids of the inserted documents.

Since:

  • 2.0.0

[ GitHub ] 

  


# File 'lib/mongo/operation/insert/bulk_result.rb', line 33



attr_reader :inserted_ids


  







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
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/operation/insert/bulk_result.rb', line 110



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
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/operation/insert/bulk_result.rb', line 97



def n_inserted
  written_count
end