MongoDB\Database::dropCollection()

Definición

MongoDB\Database::dropCollection()

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

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

Parámetros

$collectionName : string

El nombre de la colección a descartar.

$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.
encryptedFields	arreglo|objeto	Un documento que describe los campos cifrados para Queryable Encryption. Si se omite, se consultará la opción encryptedFieldsMap dentro de la opción del controlador autoEncryption. Si se ha definido encryptedFieldsMap pero no se especifica esta colección, la librería hará un último intento de consultar el valor del lado del servidor para encryptedFields. Consulta campo cifrado y capacidad de consulta en el manual de MongoDB para obtener más información. Esta opción no se pasa al comando descartar. La librería lo utiliza para determinar las colecciones de metadatos relacionadas que deben descartarse además de una colección cifrada. Novedades en la versión 1.13.
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 que se debe aplicar a los cursores, lo que determina cómo se convierten los documentos BSON en valores PHP. Por defecto, se utiliza el mapa de tipos de la base de datos. Esto se utilizará para el documento de resultado del comando retornado.
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.

Return Values

Un arreglo o objeto con el documento de resultado del comando descartar. 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

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

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

La vista de salida se ilustraría como sigue:

object(MongoDB\Model\BSONDocument)#8 (1) {
  ["storage":"ArrayObject":private]=>
  array(3) {
    ["ns"]=>
    string(10) "test.users"
    ["nIndexesWas"]=>
    int(1)
    ["ok"]=>
    float(1)
  }
}

Ver también

• MongoDB\Collection::drop()

• Referencia del comando descartar en el manual de MongoDB