MongoDB\Collection::drop()

Definición

MongoDB\Collection::drop()

Descarta la colección.

function drop(array $options = []): void

Parámetros

$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 perfiles de 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 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

La siguiente operación elimina la colección restaurants en la base de datos test:

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$collection->drop();

Ver también

MongoDB\Database::dropCollection()
Referencia del comandodrop en el manual de MongoDB

Volver

distinto()

soltarÍndice()