Module: Mongoid::Indexable::ClassMethods

Defined in:
lib/mongoid/indexable.rb

Overview

Since:

  • 4.0.0

Instance Method Summary collapse

Instance Method Details

#add_indexestrue

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.

Since:

  • 1.0.0



82
83
84
85
86
87
# File 'lib/mongoid/indexable.rb', line 82

def add_indexes
  if hereditary? && !index_keys.include?(_type: 1)
    index({ _type: 1 }, unique: false, background: true)
  end
  true
end

#create_indexestrue

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.

Since:

  • 1.0.0



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/mongoid/indexable.rb', line 29

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 (Symbol)

    The index spec.

  • options (Hash) (defaults to: nil)

    The index options.

Returns:

  • (Hash)

    The index options.

Since:

  • 1.0.0



104
105
106
107
108
109
# File 'lib/mongoid/indexable.rb', line 104

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.

Since:

  • 4.0.0



122
123
124
125
126
127
# File 'lib/mongoid/indexable.rb', line 122

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_indexestrue

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.

Since:

  • 3.0.0



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/mongoid/indexable.rb', line 55

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