Exception: Mongo::Error::InvalidConfigOption

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

Overview

This error is raised when a bad configuration option is attempted to be set.

Since:

  • 2.0.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(name) ⇒ InvalidConfigOption

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.

Create the new error.

Parameters:

  • name (Symbol, String) —

    The attempted config option name.

Since:

  • 2.0.0



16
17
18
 
# File 'lib/mongo/error/invalid_config_option.rb', line 16

def initialize(name)
  super("Invalid config option #{name}.")
end