Module: Mongoid::Indexable::ClassMethods

Defined in:
lib/mongoid/indexable.rb

Instance Method Summary collapse

Instance Method Details

#add_indexes ⇒ true

Add the default indexes to the root document if they do not already exist. Currently this is only _type.

Examples:

Add Mongoid internal indexes.

Person.add_indexes

Returns:

  • (true) —

    If the operation succeeded.

 76 77 78 79 80 81
 
# File 'lib/mongoid/indexable.rb', line 76 def add_indexes if hereditary? && !index_keys.include?(self.discriminator_key.to_sym => 1) index({ self.discriminator_key.to_sym => 1 }, unique: false, background: true) end true end

#create_indexes ⇒ true

Send the actual index creation comments to the MongoDB driver

Examples:

Create the indexes for the class.

Person.create_indexes

Returns:

  • (true) —

    If the operation succeeded.

 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
 
# File 'lib/mongoid/indexable.rb', line 27 def create_indexes return unless index_specifications default_options = {background: Config.background_indexing} index_specifications.each do |spec| key, options = spec.key, default_options.merge(spec.options) if database = options[:database] with(database: database) do |klass| klass.collection.indexes(session: _session).create_one(key, options.except(:database)) end else collection.indexes(session: _session).create_one(key, options) end end and true end

#index(spec, options = nil) ⇒ Hash

Adds an index definition for the provided single or compound keys.

Examples:

Create a basic index.

class Person include Mongoid::Document field :name, type: String index({ name: 1 }, { background: true }) end

Parameters:

  • spec (Hash) —

    The index spec.

  • options (Hash) (defaults to: nil) —

    The index options.

Returns:

  • (Hash) —

    The index options.

 96 97 98 99 100 101
 
# File 'lib/mongoid/indexable.rb', line 96 def index(spec, options = nil) specification = Specification.new(self, spec, options) if !index_specifications.include?(specification) index_specifications.push(specification) end end

#index_specification(index_hash, index_name = nil) ⇒ Specification

Get an index specification for the provided key.

Examples:

Get the index specification.

Model.index_specification(name: 1)

Parameters:

  • index_hash (Hash) —

    The index key/direction pair.

  • index_name (String) (defaults to: nil) —

    The index name.

Returns:

  • (Specification) —

    The found specification.

 112 113 114 115 116 117
 
# File 'lib/mongoid/indexable.rb', line 112 def index_specification(index_hash, index_name = nil) index = OpenStruct.new(fields: index_hash.keys, key: index_hash) index_specifications.detect do |spec| spec == index || (index_name && index_name == spec.name) end end

#remove_indexes ⇒ true

Send the actual index removal comments to the MongoDB driver, but lets _id untouched.

Examples:

Remove the indexes for the class.

Person.remove_indexes

Returns:

  • (true) —

    If the operation succeeded.

 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
 
# File 'lib/mongoid/indexable.rb', line 51 def remove_indexes indexed_database_names.each do |database| with(database: database) do |klass| begin klass.collection.indexes(session: _session).each do |spec| unless spec["name"] == "_id_" klass.collection.indexes(session: _session).drop_one(spec["key"]) logger.info( "MONGOID: Removed index '#{spec["name"]}' on collection " + "'#{klass.collection.name}' in database '#{database}'." ) end end rescue Mongo::Error::OperationFailure; end end end and true end