Class: Mongo::Error::MaxBSONSize

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

Overview

Exception that is raised when trying to serialize a document that exceeds max BSON object size.

Since:

  • 2.0.0

Constant Summary collapse

MESSAGE =

The message is constant.

Since:

  • 2.0.0

'The document exceeds maximum allowed BSON size'

Instance Method Summary collapse

Constructor Details

#initialize(max_size_or_msg = nil) ⇒ MaxBSONSize

Instantiate the new exception.

Examples:

Instantiate the exception.

Mongo::Error::MaxBSONSize.new(max)

Parameters:

  • max_size_or_msg (String | Numeric) (defaults to: nil) —

    The message to use or the maximum size to insert into the predefined message. The Numeric argument type is deprecated.

Since:

  • 2.0.0



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mongo/error/max_bson_size.rb', line 39

def initialize(max_size_or_msg = nil)
  msg = if max_size_or_msg.is_a?(Numeric)
          "#{MESSAGE}. The maximum allowed size is #{max_size_or_msg}"
        elsif max_size_or_msg
          max_size_or_msg
        else
          MESSAGE
        end
  super(msg)
end