MongoDB\Collection::dropIndex()
Definição
Parâmetros
$indexName
: string|MongoDB\Model\IndexInfo
- O nome ou objeto de modelo do índice a ser eliminado. Visualize os índices existentes na coleção utilizando o método
MongoDB\Collection::listIndexes()
. $options
: arrayUma array especificando as opções desejadas.
NomeTipoDescriçãocomentáriomistoPermite que os usuários especifiquem um comentário arbitrário para ajudar a rastrear a operação por meio do profiler do banco de dados, saída currentOp e registros.
Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor.
Novidade na versão 1.13.
maxTimeMSinteiroO 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.
Novidade na versão 1.3.
sessionSessão do cliente a ser associada à operação.
Novidade na versão 1.3.
typeMaparrayO 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.
Isso será usado para o documento de resultado do comando retornado.
Escreva preocupaçãoPreocupação de gravação a ser usada na operação. O padrão é a preocupação de gravação da coleção.
Não é possível especificar uma preocupação de gravação para operações individuais como parte de uma transação. Em vez disso, defina a opção
writeConcern
ao iniciar a transação.
Valores de retorno
Um array ou objeto com o documento de resultado do comando dropIndexes . O tipo de retorno depende da opção typeMap
.
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).
Exemplo
O seguinte descarta um índice com o nome borough_1
da collection restaurants
no reconhecimento de data center test
:
$collection = (new MongoDB\Client)->test->restaurants; $result = $collection->dropIndex('borough_1'); var_dump($result);
A saída seria então semelhante a:
object(MongoDB\Model\BSONDocument)#9 (1) { ["storage":"ArrayObject":private]=> array(2) { ["nIndexesWas"]=> int(2) ["ok"]=> float(1) } }
Veja também
Referência do comando dropIndexes no manual MongoDB
Documentação do índice no manual do MongoDB