Module: Mongoid::Indexable::Validators::Options

Extended by:

Options

Included in:

Options

Defined in:

lib/mongoid/indexable/validators/options.rb

Overview

Validates the options passed to the index macro.

Constant Summary

VALID_OPTIONS =

[
  :background,
  :database,
  :default_language,
  :language_override,
  :name,
  :sparse,
  :unique,
  :max,
  :min,
  :bits,
  :bucket_size,
  :expire_after_seconds,
  :weights,
  :storage_engine,
  :key,
  :sphere_version,
  :text_version,
  :version,
  :partial_filter_expression,
  :collation,
  :wildcard_projection,
]

VALID_TYPES =

[
  1,
  -1,
  "2d",
  "2dsphere",
  "geoHaystack",
  "text",
  "hashed"
]

Instance Method Summary

• #validate(klass, spec, options) ⇒ Object

  Validate the index specification.

Instance Method Details

#validate(klass, spec, options) ⇒ Object

Validate the index specification.

Examples:

Validate the index spec.

Options.validate(Band, name: 1)

Parameters:

• klass (Class) —

  The model class.

• spec (Hash) —

  The index specification.

• options (Hash) —

  The index options.

Raises:

• (Errors::InvalidIndex) —

  If validation failed.

# File 'lib/mongoid/indexable/validators/options.rb', line 56

def validate(klass, spec, options)
  validate_spec(klass, spec, options)
  validate_options(klass, spec, options)
end