MongoDB\Collection::listSearchIndexes()
Novidade na versão 1.17.
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 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
$options
: arrayUma array especificando as opções desejadas.
NomeTipoDescriçãobatchSize
inteiro
Especifica o tamanho do lote para o cursor, que se aplicará ao comando
aggregate
inicial e quaisquer comandosgetMore
subsequentes. Isso determina o número máximo de documentos para retornar em cada resposta do servidor.Um batchSize de
0
é especial para isso e só se aplica ao comandoaggregate
inicial; os comandosgetMore
subsequentes usam o tamanho de lote padrão do servidor. Isso pode ser útil para retornar rapidamente um cursor ou uma falha doaggregate
sem fazer um trabalho significativo do lado do servidor.Codec
MongoDB\Codec\DocumentCodec
Ocodec a ser usado para codificar ou decodificar 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çãotypeMap
.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
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
Preferência de leitura a ser usada na operação. O padrão é a preferência de leitura da coleção.
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
Referência de estágio do pipeline de agregação $listSearchIndexes no manual MongoDB
Documentação da Atlas Search no Manual do MongoDB