Índices de pesquisa do Atlas

Visão geral

O recurso Atlas Search permite realizar pesquisas de texto completo em collections hospedadas no MongoDB Atlas. Os índices especificam o comportamento da busca e quais campos indexar.

Para saber mais sobre o MongoDB Atlas Search, consulte a documentação dosíndices do Atlas Search .

Você pode chamar os seguintes métodos em uma coleção para gerenciar seus índices de Atlas Search:

• create_search_index()

• create_search_indexes()

• list_search_indexes()

• update_search_index()

• drop_search_index()

As seções a seguir fornecem exemplos de código que demonstram como usar cada um dos métodos anteriores.

Criar um índice de pesquisa

Você pode usar o create_search_index() e o create_search_indexes() métodos para criar índices do Atlas Search.

O seguinte exemplo de código mostra como criar um único índice:

index = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "<index name>",
}
collection.create_search_index(index)

O seguinte exemplo de código mostra como criar múltiplos índices:

index_one = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "my_index",
}
index_two = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "my_other_index",
}
indexes = [index_one, index_two]
collection.create_search_indexes(models=indexes)

Listar índices de pesquisa

Você pode usar o list_search_indexes() para retornar os índices do Atlas Search de uma coleção.

O seguinte exemplo de código mostra como imprimir uma lista dos índices de pesquisa de uma coleção:

results = list(collection.list_search_indexes())
for index in results:
    print(index)

Atualizar um Índice de Pesquisa

Você pode usar o update_search_index() para atualizar um índice do Atlas Search.

O seguinte código mostra como atualizar um índice de pesquisa:

new_index = {
    "definition": {
        "mappings": {
            "dynamic": True
        }
    },
    "name": "my_new_index",
}
collection.update_search_index("my_index", new_index)

Excluir um índice de pesquisa

Você pode usar o método drop_search_index() para remover um índice do Atlas Search.

O seguinte código mostra como excluir um índice de pesquisa de uma coleção:

collection.drop_index("my_index")