MongoDB\ClientBulkWrite::createWithCollection()
Novidades na versão 2.1.
Definição
MongoDB\ClientBulkWrite::createWithCollection()
Crie uma instância do
MongoDB\ClientBulkWrite
construtor a partir da instância fornecida. Você pode adicionar operações de gravaçãoMongoDB\Collection
aoClientBulkWrite
para criar um novo BulkWriteCommand que a biblioteca envia para o servidor.function createWithCollection( Collection $collection, array $options = [] ): self
Parâmetros
$collection
:MongoDB\Collection
- A instância
Collection
a ser definida como destino para operações de escrita em massa. $options
: arrayUma array especificando as opções desejadas.
NomeTipoDescriçãobypassDocumentValidation
booleano
Se
true
: a operação de gravação ignora a validação em nível de documento .O padrão é
false
.comment
misto
Permite ao usuário especificar um comentário arbitrário para ajudar a rastrear a operação por meio do profiler de banco de dados, da saída currentOp e dos registros.
let
array|object
Mapa de nomes e valores de parâmetros. Os valores devem ser expressões constantes ou fechadas que não façam referência aos campos do documento. Os parâmetros podem ser acessados como variáveis em um contexto de expressão agregada (como
$$var
).Esta funcionalidade não é suportada para versões do servidor MongoDB 6.0 e anteriores. Se utilizado, o servidor retorna uma exceção no tempo de execução.
encomendado
booleano
Se
true
: quando uma única gravação falha, a operação para sem executar as gravações restantes e lança uma exceção.Se
false
: quando uma única gravação falha, a operação continua com as gravações restantes, se houver, e lança uma exceção.O padrão é
true
.verboseResults
booleano
Especifica se deseja retornar resultados detalhados.
O padrão é
false
.
Return Values
Uma nova instância ClientBulkWrite
com uma especificação BulkWriteCommand
vazia.
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).