Exception: Mongo::Error::MaxBSONSize

Inherits:
Mongo::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".freeze

Constants inherited from Mongo::Error

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

Instance Attribute Summary

Attributes included from Notable

#connection_global_id, #generation, #service_id

Instance Method Summary collapse

Methods inherited from Mongo::Error

#change_stream_resumable?, #write_concern_error_label?, #write_concern_error_labels

Methods included from ChangeStreamResumable

#change_stream_resumable?

Methods included from WriteRetryable

#write_retryable?

Methods included from Labelable

#add_label, #label?, #labels

Methods included from Notable

#add_note, #add_notes, #notes, #to_s

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



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/mongo/error/max_bson_size.rb', line 42

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