Página inicial do Docs → Manual da Biblioteca PHP
MongoDB\reconhecimento de data center::dropCollection()
Definição
Parâmetros
$collectionName
: string- O nome da collection a ser descartada.
$options
: arrayUm array especificando as opções desejadas.
NomeTipoDescriçãocomentáriomistoPermite que os usuários especifiquem um comentário arbitrário para ajudar a rastrear a operação por meio do perfil 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 criptografadosarray|objectUm documento que descreve campos criptografados para queryable encryption. Se omitida, a opção
encryptedFieldsMap
dentro da opção de driverautoEncryption
será consultada. SeencryptedFieldsMap
foi definido, mas não especificar esta coleção, a biblioteca fará uma tentativa final de consultar o valor do lado do servidor paraencryptedFields
. Consulte Criptografia de campo e consultabilidade no manual do MongoDB para obter mais informações.Observação
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.
sessionSessão do cliente a ser associada à operação.
Novidade na versão 1.3.
typeMaparrayO 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 banco de dados.
Isso será usado para o documento de resultado do comando retornado.
Escreva preocupaçãoWrite concern a ser usada para a operação. O padrão é a preocupação de gravação do banco de dados.
Valores de retorno
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 do driver (por exemplo, erros de conexão).
Exemplo
O exemplo a seguir descarta a collection users
no reconhecimento de data center test
:
$db = (new MongoDB\Client)->test; $result = $db->dropCollection('users'); var_dump($result);
A saída seria então semelhante a:
object(MongoDB\Model\BSONDocument)#8 (1) { ["storage":"ArrayObject":private]=> array(3) { ["ns"]=> string(10) "test.users" ["nIndexesWas"]=> int(1) ["ok"]=> float(1) } }
Veja também
referência do comando drop no manual MongoDB