Module: Mongoid::Indexes::Validators::Options

Extended by:

Options

Included in:

Options

Defined in:

lib/mongoid/indexes/validators/options.rb

Overview

Validates the options passed to the index macro.

Constant Summary

VALID_OPTIONS =

[ :background, :drop_dups, :name, :sparse, :unique, :max, :min ]

VALID_TYPES =

[ 1, -1, "2d" ]

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.

Since:

• 3.0.0

# File 'lib/mongoid/indexes/validators/options.rb', line 25

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