MongoDB\Collection::drop()

Definição

MongoDB\Collection::drop()

Solte a coleção.

function drop(array $options = []): array|object

Parâmetros

$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.
Campos criptografados	array|object	Documento que descreve campos criptografados para Queryable Encryption. Se omitida, a opção encryptedFieldsMap dentro da opção de driver autoEncryption será consultada. Se encryptedFieldsMap foi definido, mas não especificar esta coleção, a biblioteca fará uma tentativa final de consultar o valor do lado do servidor para encryptedFields. Consulte Criptografia de campo e consultabilidade no manual do MongoDB para obter mais informações. Esta opção não é passada para o comando soltar . A biblioteca o utiliza para determinar as collections de metadados relacionadas que devem ser descartadas além de uma collection criptografada. 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 para aplicar aos cursores, que determina como os documentos BSON são convertidos para valores PHP. O padrão é o mapa de tipos da coleção. Isso será usado para o documento de resultado do comando retornado.
writeConcern	MongoDB\Driver\WriteConcern	Preocupação de gravação a ser usada na operação. O padrão é a preocupação de gravação da coleção. Não é possível especificar uma preocupação de gravação para operações individuais como parte de uma transação. Em vez disso, defina a opção writeConcern ao iniciar a transação.

Return Values

Um array ou objeto com o documento de resultado do comando soltar . 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

A seguinte operação descarta a collection restaurants no reconhecimento de data center test :

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

A saída seria então semelhante a:

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

Veja também

• MongoDB\Database::dropCollection()

• referência do comando drop no manual MongoDB