Class: Mongo::Error::InvalidUpdateDocument

Inherits:
Error
  • Object
show all
Defined in:
lib/mongo/error/invalid_update_document.rb

Overview

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

Since:

  • 2.0.0

Constant Summary collapse

MESSAGE =
Deprecated.

The error message.

Since:

  • 2.0.0

'Invalid update document provided'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key: nil) ⇒ InvalidUpdateDocument

Instantiate the new exception.

Parameters:

  • :key (String) —

    The invalid key.

Since:

  • 2.0.0



54
55
56
 
# File 'lib/mongo/error/invalid_update_document.rb', line 54

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

Class Method Details

.message(key) ⇒ String

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.

Construct the error message.

Parameters:

  • key (String) —

    The invalid key.

Returns:

  • (String) —

    The error message.

Since:

  • 2.0.0



35
36
37
38
39
 
# File 'lib/mongo/error/invalid_update_document.rb', line 35

def self.message(key)
  message = 'Invalid update document provided. Update documents must only '
  message += "contain only atomic modifiers. The \"#{key}\" key is invalid."
  message
end

.warn(logger, key) ⇒ 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.

Send and cache the warning.

Since:

  • 2.0.0



44
45
46
47
48
49
 
# File 'lib/mongo/error/invalid_update_document.rb', line 44

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