Exception: Mongo::Error::UnchangeableCollectionOption

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

Overview

Raised if a new collection is created from an existing one and options other than the changeable ones are provided.

Since:

  • 2.1.0

Constant Summary

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(option) ⇒ UnchangeableCollectionOption

Create the new exception.

Examples:

Create the new exception.

Mongo::Error::UnchangeableCollectionOption.new(option)

Parameters:

  • option (String, Symbol) —

    The option that was attempted to be changed.

Since:

  • 2.1.0



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

def initialize(option)
  super("The option #{option} cannot be set on a new collection instance." +
            " The options that can be updated are #{Collection::CHANGEABLE_OPTIONS}")
end