MongoDB\Collection::updateSearchIndex()

Definição

MongoDB\Collection::updateSearchIndex()

Atualizar um Atlas Search índice de pesquisa para a collection.

function updateSearchIndex(
    string $name,
    array|object $definition,
    array $options = []
): void

Este comando só pode ser executado em um sistema hospedado no MongoDB Atlas e requer uma camada do cluster Atlas de pelo menos M10. Um sistema local do Atlas também pode ser usado para desenvolvimento.

Parâmetros

$name : string

Nome do índice a ser atualizado.

$definition : array|object

Documento que descreve a definição de índice atualizada do Atlas Search . A definição especificada substitui a definição anterior no índice do Atlas Search . Para obter detalhes sobre a sintaxe de definição, consulte Sintaxe de definição do índiceAtlas Search .

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
comment	misto	Permite ao usuário especificar um comentário arbitrário para ajudar a rastrear a operação por meio do profiler de banco de dados, da saída currentOp e dos registros.

Erros/exceções

MongoDB\Exception\UnsupportedException se as opções forem usadas e não aceitas pelo servidor selecionado (p. ex., collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\RuntimeException para outros erros no nível da extensão (por exemplo erros de conexão).

Comportamento

Os índices do Atlas Search são gerenciados de forma assíncrona. Após criar ou atualizar um índice, você pode executar periodicamente o MongoDB\Collection::listSearchIndexes() e verificar o campo de saída do queryable para determinar se ele está pronto para ser utilizado.

Veja também

• MongoDB\Collection::createSearchIndex()

• MongoDB\Collection::createSearchIndexes()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::listSearchIndexes()

• referência do comando updateSearchIndex no manual do MongoDB

• Documentação da Atlas Search no Manual do MongoDB