123456789_123456789_123456789_123456789_123456789_

Exception: Mongo::Error::MaxBSONSize

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/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

::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?

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(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

[ GitHub ] 

  


# 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