Otimizar consultas usando índices

Visão geral

Nesta página, você pode ver exemplos de código copiáveis que mostram como gerenciar diferentes tipos de índices usando o MongoDB Ruby Driver.

Para usar um exemplo desta página, copie o exemplo de código no aplicação de amostra ou em seu próprio aplicação. Certifique-se de substituir todos os espaços reservados nos exemplos de código, como <connection string>, pelos valores relevantes para sua implantação do MongoDB .

require 'mongo'
# Replace the placeholders with your credentials
uri = "<connection string>"
# Sets the server_api field of the options object to Stable API version 1
options = { server_api: { version: "1" }}
# Creates a new client and connect to the server
client = Mongo::Client.new(uri, options)
database = client.use('<database name>')
collection = database[:<collection name>]
# Start example code here
    
# End example code here
client.close

Índice de campo único

O exemplo seguinte cria um índice ascendente no campo especificado:

collection.indexes.create_one({ <field name>: 1 })

Para saber mais sobre índices de campo único, consulte o guia Índices de campo único .

Índice composto

O exemplo seguinte cria um índice composto nos dois campos especificados.

collection.indexes.create_one({ <field name 1>: -1, <field name 2>: 1 })

Para saber mais sobre índices compostos, consulte o guia Índices compostos .

Multikey Index

O exemplo a seguir cria um índice de múltiplas chaves no campo com valor de array especificado:

collection.indexes.create_one({ <field name>: 1 })

Para saber mais sobre índices de várias chaves, consulte o guia Índices de várias chaves.

Índice Geoespacial

O exemplo seguinte cria um índice dsphere do 2no campo especificado que contém objetos GeoJSON:

collection.indexes.create_one({ <GeoJSON field name>: '2dsphere' })

Para saber mais sobre índices geoespaciais, consulte o guia Índices geoespaciais .

Gerenciamento do índice de pesquisa do MongoDB

As seções a seguir contêm exemplos de código que descrevem como gerenciar índices de pesquisa MongoDB .

Para saber mais sobre índices de pesquisa, consulte o guia MongoDB Search e MongoDB Vector Search Indexes.

index_definition = {
  mappings: {
    dynamic: false,  
    fields: { 
      <field name>: { type: '<field type>' }
    }
  }
}
collection.search_indexes.create_one(index_definition, name: '<index name>')

puts collection.search_indexes.collect(&:to_json)

updated_definition = {
  mappings: {
    dynamic: false,  
    fields: { <updated field name>: { type: '<updated field type>' } }
    }
}
collection.search_indexes.update_one(updated_definition, name: '<index name>')

collection.search_indexes.drop_one(name: '<index name>')

Text Index

O exemplo seguinte cria um índice de texto no campo de string especificado:

collection.indexes.create_one({ <field name>: 'text' })

Para saber mais sobre índices de texto, consulte o guia Índices de texto .

Criar muitos índices

O exemplo a seguir cria vários índices na array fornecida de especificações de índice:

collection.indexes.create_many([
  { key: { <field name 1>: 1 } },
  { key: { <field name 2>: -1 } },
])

Índice de queda

O exemplo a seguir exclui um índice com o nome especificado:

collection.indexes.drop_one( '<index name>' )

O exemplo a seguir mostra como excluir todos os índices em uma coleção:

collection.indexes.drop_all

Listar índices

O exemplo a seguir imprime uma lista de todos os índices na collection especificada:

puts collection.indexes.collect(&:to_json)

Opções de índice

A seguir está uma lista completa das opções disponíveis que você pode adicionar ao criar índices. Estas opções espelham as opções suportadas pelo comando createIndex. Para obter mais informações, consulte o comando createIndex no manual do MongoDB Server.

Documentação da API

Para saber mais sobre os métodos ou objetos usados neste guia, consulte a seguinte documentação da API:

• Índices

• create_one

• drop_one

• drop_all