MongoDB\Collection::dropIndex()

Definición

MongoDB\Collection::dropIndex()

Eliminar un índice de la colección.

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

Parámetros

$indexName : cadena| MongoDB\Model\IndexInfo

El nombre o el objeto de modelo del índice que se eliminará. Visualice los índices existentes en la colección mediante el MongoDB\Collection::listIndexes() método.

$options : matriz

Una matriz 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 del generador de perfilesde base de datos, salidacurrentOpy registros. Esta opción está disponible desde MongoDB 4.4 y generará una excepción en el momento de ejecución si se especifica para una versión de servidor anterior. Novedades en la versión 1.13.
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para procesar operaciones en el cursor. MongoDB cancela la operación en el punto de interrupción posterior más cercano. Nuevo en la versión 1.3.
sesión	MongoDB\Controlador\Sesión	Sesión de cliente para asociar a la operación. Nuevo en la versión 1.3.
typeMap	arreglo	El mapa de tipos que se aplica a los cursores y que determina cómo se convierten los documentos BSON a valores PHP. El valor predeterminado es el mapa de tipos de la colección. Esto se utilizará para el documento de resultado del comando devuelto.
writeConcern	MongoDB\Driver\WriteConcern	Escriba la preocupación que se usará para la operación. El valor predeterminado es la preocupación de escritura de la colección. No es posible especificar una preocupación de escritura para operaciones individuales como parte de una transacción. En su lugar, configure la writeConcern opción al iniciar la transacción.

Errores/Excepciones

MongoDB\Exception\UnsupportedException si se utilizan opciones que no son compatibles con el servidor seleccionado (porcollation readConcernwriteConcernejemplo,,,).

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

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

Ejemplo

Lo siguiente elimina 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;
$collection->dropIndex('borough_1');

Ver también

• MongoDB\Collection::dropIndexes()

• Índices para la optimización de consultas

• Referencia del comandodropIndexes en el manual de MongoDB

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