MongoDB\Database::dropCollection()

Definición

MongoDB\Database::dropCollection()

Eliminar una colección dentro de la base de datos actual.

function dropCollection(
    string $collectionName,
    array $options = []
): void

Parámetros

$collectionName : cadena

El nombre de la colección que se va a soltar.

$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.
encryptedFields	matriz|objeto	Un documento que describe los campos cifrados para el cifrado consultable. Si se omite, se encryptedFieldsMap consultará la opción dentro de la autoEncryption opción del controlador. Si encryptedFieldsMap se definió, pero no especifica esta colección, la biblioteca intentará por última vez consultar el valor del servidor encryptedFields para. Consulte "Cifrado de campos y consultabilidad" en el manual de MongoDB para obtener más información. Esta opción no se pasa al comando "drop". La biblioteca la utiliza para determinar las colecciones de metadatos relacionadas que deben eliminarse, además de una colección cifrada. Novedades en la versión 1.13.
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 base de datos. Esto se utilizará para el documento de resultado del comando devuelto.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) a utilizar para la operación. Se utiliza por defecto el nivel de confirmación de escritura (write concern) de la base de datos.

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

El siguiente ejemplo elimina la colección users en la base de datos test:

<?php
$db = (new MongoDB\Client)->test;
$db->dropCollection('users');

Ver también

• MongoDB\Collection::drop()

• Referencia del comandodrop en el manual de MongoDB