MongoDB\Client::dropDatabase()

Definição

MongoDB\Client::dropDatabase()

Solte um reconhecimento de data center no servidor.

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

Parâmetros

$databaseName : string

O nome do reconhecimento de data center a ser eliminado.

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
comment	misto	Permite que os usuários especifiquem um comentário arbitrário para ajudar a rastrear a operação por meio do profiler do banco de dados, saída currentOp e registros. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidade na versão 1.13.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação. Novidade na versão 1.3.
typeMap	array	O mapa de tipos aplicar aos cursores, o que determina como os documentos BSON são convertidos em valores PHP. O padrão é o mapa de tipos do cliente. Isso será usado para o documento de resultado do comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	Write concern a ser usada para a operação. O padrão é a write concern do cliente.

Return Values

Um array ou objeto com o documento de resultado do comando dropDatabase . O tipo de retorno depende da opção typeMap .

Erros/exceções

MongoDB\Exception\UnsupportedException se as opções forem usadas e não aceitas pelo servidor selecionado (p. ex., collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\RuntimeException para outros erros no nível da extensão (por exemplo erros de conexão).

Exemplo

O exemplo a seguir descarta o banco de dados test :

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

A saída seria então semelhante a:

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

Veja também

• MongoDB\Database::drop()

• referência do comando dropDatabase no manual MongoDB