Exception: Mongo::Error::UnsupportedArrayFilters Deprecated

Inherits:
UnsupportedOption show all
Defined in:
build/ruby-driver-master/lib/mongo/error/unsupported_array_filters.rb

Overview

Deprecated.

RUBY-2260 In driver version 3.0, this error class will be replaced with UnsupportedOption. To handle this error, catch Mongo::Error::UnsupportedOption, which will prevent any breaking changes in your application when upgrading to version 3.0 of the driver.

Raised if the array filters option is specified for an operation but the server selected does not support array filters.

Since:

  • 2.5.0

Constant Summary collapse

DEFAULT_MESSAGE =

The default error message describing that array filters are not supported.

Returns:

  • (String)

    A default message describing that array filters are not supported by the server.

Since:

  • 2.5.0

"The array_filters option is not a supported feature of the server handling this operation. " +
"Operation results may be unexpected.".freeze
UNACKNOWLEDGED_WRITES_MESSAGE =

The error message describing that array filters cannot be used when write concern is unacknowledged.

Returns:

  • (String)

    A message describing that array filters cannot be used when write concern is unacknowledged.

Since:

  • 2.5.0

"The array_filters option cannot be specified when using unacknowledged writes. " +
"Either remove the array_filters option or use acknowledged writes (w >= 1).".freeze

Constants inherited from UnsupportedOption

Mongo::Error::UnsupportedOption::ALLOW_DISK_USE_MESSAGE, Mongo::Error::UnsupportedOption::COMMIT_QUORUM_MESSAGE, Mongo::Error::UnsupportedOption::HINT_MESSAGE, Mongo::Error::UnsupportedOption::UNACKNOWLEDGED_HINT_MESSAGE

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

#generation, #service_id

Instance Method Summary collapse

Methods inherited from UnsupportedOption

allow_disk_use_error, commit_quorum_error, hint_error

Methods inherited from Mongo::Error

#add_label, #change_stream_resumable?, #label?, #labels, #write_concern_error_label?, #write_concern_error_labels

Methods included from Notable

#add_note, #notes, #to_s

Constructor Details

#initialize(message = nil) ⇒ UnsupportedArrayFilters

Create the new exception.

Examples:

Create the new exception.

Mongo::Error::UnsupportedArrayFilters.new

Since:

  • 2.5.0



54
55
56
# File 'build/ruby-driver-master/lib/mongo/error/unsupported_array_filters.rb', line 54

def initialize(message = nil)
  super(message || DEFAULT_MESSAGE)
end