123456789_123456789_123456789_123456789_123456789_

Exception: Mongo::Error::InvalidReplacementDocument

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Mongo::Error, StandardError
Instance Chain:
self, ::Mongo::Error, ChangeStreamResumable, WriteRetryable, Labelable, Notable, StandardError
Inherits: Mongo::Error
  • Object
Defined in: lib/mongo/error/invalid_replacement_document.rb

Overview

Exception raised if the object is not a valid replacement document.

Since:

  • 2.0.0

Constant Summary

::Mongo::Error - Inherited

BAD_VALUE, CODE, CURSOR_NOT_FOUND, ERR, ERRMSG, ERROR, TRANSIENT_TRANSACTION_ERROR_LABEL, UNKNOWN_ERROR, UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL, WRITE_CONCERN_ERROR, WRITE_CONCERN_ERRORS, WRITE_ERRORS

Class Method Summary

::Mongo::Error - Inherited

.new

Instance Attribute Summary

::Mongo::Error - Inherited

#change_stream_resumable?

Can the change stream on which this error occurred be resumed, provided the operation that triggered this error was a getMore?
#network_error?

ChangeStreamResumable - Included

#change_stream_resumable?

Can the change stream on which this error occurred be resumed, provided the operation that triggered this error was a getMore?

WriteRetryable - Included

#write_retryable?

Notable - Included

#connection_global_id

Returns global id of the connection on which the error occurred.
#generation

Returns connection pool generation for the connection on which the error occurred.
#service_id

Returns service id for the connection on which the error occurred.

Instance Method Summary

::Mongo::Error - Inherited

#write_concern_error_label?

Does the write concern error have the given label?
#write_concern_error_labels

The set of error labels associated with the write concern error.

Labelable - Included

#add_label

Adds the specified label to the error instance, if the label is not already in the set of labels.
#label?

Does the error have the given label?
#labels

Gets the set of labels associated with the error.

Notable - Included

#add_note,
#add_notes

Allows multiple notes to be added in a single call, for convenience.
#notes

Returns an array of strings with additional information about the exception.
#to_s, #notes_tail

Constructor Details

.new(key: nil) ⇒ InvalidReplacementDocument

Instantiate the new exception.

Parameters:

  • :key (String) —

    The invalid key.

Since:

  • 2.0.0

[ GitHub ] 

  


# File 'lib/mongo/error/invalid_replacement_document.rb', line 55



def initialize(key: nil)
  super(self.class.message(key))
end


  







Class Method Details



  

    .message(key)  ⇒ String 
  

  

    This method is for internal use only.
  



  

    

Construct the error message.


  





  
Parameters:


    
  
  • 
    key
    (String)
—    
    

    The invalid key.
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    

    The error message.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/error/invalid_replacement_document.rb', line 36



def self.message(key)
  message = "Invalid replacement document provided. Replacement documents "
  message += "must not contain atomic modifiers. The \"#{key}\" key is invalid."
  message
end


  








  

    .warn(logger, key)  
  

  

    This method is for internal use only.
  



  

    

Send and cache the warning.


  





  
Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/error/invalid_replacement_document.rb', line 45



def self.warn(logger, key)
  @warned ||= begin
    logger.warn(message(key))
    true
  end
end