MongoDB\Collection::listSearchIndexes()

Definição

MongoDB\Collection::listSearchIndexes()

Obtém informações de índice para um ou mais índices de pesquisa na collection.

function listSearchIndexes(array $options = []): Countable&Iterator

Esse comando só pode ser executado em uma implantação hospedada 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

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
batchSize	inteiro	O número máximo de documentos dentro de cada lote retornado na lista de índices, que se aplica ao comando aggregate. Por padrão, o comando aggregate tem um tamanho de lote inicial de 101 documentos e um tamanho máximo de 16 mebibytes (MiB) para cada lote subsequente. Esta opção pode impor um limite menor que 16 MiB, mas não maior. Se você definir batchSize para um limite que resulte em lotes maiores que 16 MiB, essa opção não terá efeito.
Codec	MongoDB\Codec\DocumentCodec	O codec a ser usado para codificação ou decodificação de documentos. Esta opção é mutuamente exclusiva com a opção typeMap. O padrão é o codec da coleção. A herança de uma opção codec padrão tem precedência sobre a da opção typeMap. Novidade na versão 1.17.
agrupamento	array|object	A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de string , como regras para letras maiúsculas e marcas de acento. Ao especificar agrupamento, o campo locale é obrigatório; todos os outros campos de agrupamento são opcionais. Para obter descrições dos campos, consulte Documento de agrupamento.
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.
maxTimeMS	inteiro	O limite de tempo cumulativo em milésimos de segundo para operações de processamento no cursor. O MongoDB aborta a operação o mais cedo possível após o ponto de interrupção.
name	string	Nome do índice sobre o qual retornar informações. Se o nome não for especificado, as informações de todos os índices da collection serão retornadas.
readConcern	MongoDB\Driver\ReadConcern	Preocupação de leitura a ser usada para a operação. O padrão é a preocupação de leitura da coleção. Não é possível especificar uma preocupação de leitura para operações individuais como parte de uma transação. Em vez disso, defina a opção readConcern ao iniciar a transação.
readPreference	MongoDB\Driver\ReadPreference	Preferência de leitura a ser usada na operação. O padrão é a preferência de leitura da coleção.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação.
typeMap	array	O mapa de tipos para aplicar aos cursores, que determina como os documentos BSON são convertidos para valores PHP. O padrão é o mapa de tipos da coleção.

Return Values

Uma lista de documentos, cada um dos quais descreve um índice do Atlas Search na coleção. Para obter detalhes sobre os campos de saída, consulte $listSearchIndexes: Saída no manual do MongoDB.

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).

Veja também

• MongoDB\Collection::createSearchIndex()

• MongoDB\Collection::createSearchIndexes()

• MongoDB\Collection::dropSearchIndex()

• MongoDB\Collection::updateSearchIndex()

• Referência de estágio do pipeline de agregação $listSearchIndexes no manual MongoDB

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