Gerenciamento de índices

Especificando índices

Você pode definir índices em documentos usando a macro de índice. Forneça a chave do índice junto com uma direção. Opções adicionais podem ser fornecidas no segundo parâmetro de hash de opções:

class Person
  include Mongoid::Document
  field :ssn
  index({ ssn: 1 }, { unique: true, name: "ssn_index" })
end

Você também pode definir índices em campos de documentos incorporados:

class Person
  include Mongoid::Document
  embeds_many :addresses
  index "addresses.street" => 1
end

Você pode indexar em vários campos e fornecer orientações:

class Person
  include Mongoid::Document
  field :first_name
  field :last_name
  index({ first_name: 1, last_name: 1 }, { unique: true })
end

Os índices podem ser esparsos:

class Person
  include Mongoid::Document
  field :ssn
  index({ ssn: -1 }, { sparse: true })
end

Para índices geoespaciais, certifique-se de que o campo que está sendo indexado é do tipo Array:

class Person
  include Mongoid::Document
  field :location, type: Array
  index({ location: "2d" }, { min: -200, max: 200 })
end

Os índices podem ter como escopo um banco de dados específico:

class Person
  include Mongoid::Document
  field :ssn
  index({ ssn: 1 }, { database: "users", unique: true, background: true })
end

Você pode usar nomes de campos com alias em definições de índice. Os nomes alternativos de campo também serão resolvidos nas seguintes opções: partial_filter_expression, weights, wildcard_projection.

class Person
  include Mongoid::Document
  field :a, as: :age
  index({ age: 1 }, { partial_filter_expression: { age: { '$gte' => 20 } })
end

O Mongoid pode definir índices em campos de "chave estrangeira" para associações. Isso só funciona na macro de associação em que a chave estrangeira está armazenada:

class Comment
  include Mongoid::Document
  belongs_to :post, index: true
  has_and_belongs_to_many :preferences, index: true
end

Obsoleto: no MongoDB 4.0 e versões anteriores, os usuários podem controlar se desejam criar índices em primeiro plano (bloqueio) ou background (sem bloqueio, mas menos eficiente) usando a opção background .

class Person
  include Mongoid::Document
  field :ssn
  index({ ssn: 1 }, { unique: true, background: true })
end

O valor padrão de background é controlado pelaopção de configuração background_indexing do Mongoid.

A opção background não tem efeito a partir do MongoDB 4.2.

Especificando índices de pesquisa no MongoDB Atlas

Se o seu aplicativo estiver conectado ao MongoDB Atlas, você poderá declarar e gerenciar índices de pesquisa em seus modelos. (Esta funcionalidade está disponível apenas no MongoDB Atlas.)

Para declarar um índice de pesquisa, use a macro search_index em seu modelo:

class Message
  include Mongoid::Document
  search_index { ... }
  search_index :named_index, { ... }
end

Os índices de pesquisa podem receber um nome explícito; isso será necessário se você tiver mais de um índice de pesquisa em um modelo.

Tarefas de Rake de Gerenciamento de Índices

Quando você quiser criar os índices no reconhecimento de data center, use a tarefa Rake db:mongoid:create_indexes fornecida:

$ rake db:mongoid:create_indexes

O Mongoid também fornece uma tarefa Rake para excluir todos os índices secundários.

$ rake db:mongoid:remove_indexes

Observação: a saída dessas tarefas do Rake vai para o registrador padrão configurado pelo Rails. Geralmente, é um arquivo como log/development.log e não é o resultado padrão.

Esses comandos de criação/remoção de índices também funcionam para apenas um modelo executado no console do Rails:

# Create indexes for Model
Model.create_indexes
# Remove indexes for Model
Model.remove_indexes

$ rake db:mongoid:create_search_indexes
$ rake db:mongoid:remove_search_indexes

$ rake WAIT_FOR_SEARCH_INDEXES=0 db:mongoid:create_search_indexes

# Create all defined search indexes on the model; this will return
# immediately and the indexes will be created in the background.
Model.create_search_indexes
# Remove all search indexes from the model
Model.remove_search_indexes
# Enumerate all search indexes on the model
Model.search_indexes.each { |index| ... }

# Rakefile
# keep the defaults, but add more paths to look for models
Mongoid.model_paths += [ "./src/models", "./lib/documents" ]
# or, override the defaults entirely
Mongoid.model_paths = [ "./src/models", "./lib/documents" ]

# Rakefile
$LOAD_PATHS.concat [ "./src/models", "./lib/documents" ]

# Rakefile
require 'mongoid'
load 'mongoid/tasks/database.rake'

# Rakefile
require 'bundler/setup'
load 'mongoid/tasks/database.rake'