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 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.
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 para el mapa de tipos del cliente. Esto se utilizará para el documento de resultado del comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	nivel de confirmación de escritura (write concern) para usar en la operación. Por defecto, se utiliza el nivel de confirmación de escritura (write concern) 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 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 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 comando dropDatabase en el manual de MongoDB