MongoDB\Client::dropDatabase()

Definición

MongoDB\Client::dropDatabase()

Descarta una base de datos en el servidor.

function dropDatabase(string $databaseName, array $options = []): array|object

Parámetros

$databaseName : string

El nombre de la base de datos que se va a eliminar.

$options : arreglo

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 de generador de perfilesde base de datos, salidacurrentOpy 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.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar a la operación. Nueva 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 del cliente. Esto se utilizará para el documento de resultado del comando devuelto.
writeConcern	MongoDB\Driver\WriteConcern	Escriba la preocupación que se utilizará para la operación. El valor predeterminado es la preocupación de escritura del cliente.

Return Values

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

Errores/Excepciones

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

MongoDB\Exception\InvalidArgumentException por 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 base de datos test:

<?php
$client = new MongoDB\Client;
$result = $client->dropDatabase('test');
var_dump($result);

La vista de salida se ilustraría como sigue:

object(MongoDB\Model\BSONDocument)#8 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["dropped"]=>
    string(4) "test"
    ["ok"]=>
    float(1)
  }
}

Ver también

• MongoDB\Database::drop()

• Referencia del comandodropDatabase en el manual de MongoDB