MongoDB\Collection::dropIndex()

Definición

MongoDB\Collection::dropIndex()

Descartar un índice de la colección.

function dropIndex(
    string|MongoDB\Model\IndexInfo $indexName,
    array $options = []
): array|object

Parámetros

$indexName : string| MongoDB\Model\IndexInfo

El nombre u objeto de modelo del índice que se va a descartar. Consulta los índices existentes en la colección usando el método MongoDB\Collection::listIndexes().

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través de perfilador de base de datos, output de currentOp y registros. Esta opción está disponible desde MongoDB 4.4 y, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedades en la versión 1.13.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación en el siguiente punto de interrupción.. Nueva en la versión 1.3.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación. Nueva en la versión 1.3.
typeMap	arreglo	El mapa de tipos para aplicar a cursores, que determina cómo se convierten los documentos BSON en valores PHP. Por defecto, se utiliza el mapa de tipos de la colección. Esto se utilizará para el documento de resultado del comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) a usar en la operación. Por defecto, se aplica el nivel de confirmación de escritura (write concern) de la colección. No es posible especificar un nivel de confirmación de escritura (write concern) para operaciones individuales como parte de una transacción. En su lugar, configura la opción writeConcern al iniciar la transacción.

Return Values

Un arreglo u objeto con el documento resultado del comando dropIndexes. El tipo de retorno dependerá de la opción typeMap.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se usan opciones que no sean compatibles con el servidor seleccionado (p. ej. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\RuntimeException para otros errores a nivel de extensión (por ejemplo, " errores de conexión).

Ejemplo

Lo siguiente descarta un índice con el nombre borough_1 de la colección restaurants en la base de datos test:

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$result = $collection->dropIndex('borough_1');
var_dump($result);

La vista de salida se ilustraría como sigue:

object(MongoDB\Model\BSONDocument)#9 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["nIndexesWas"]=>
    int(2)
    ["ok"]=>
    float(1)
  }
}

Ver también

• MongoDB\Collection::dropIndexes()

• Índices para la optimización de query

• Referencia de comandos de dropIndexes en el manual de MongoDB

• Documentación del índice en el manual de MongoDB