MongoDB\Client::bulkWrite()

Definição

MongoDB\Client::bulkWrite()

Execute múltiplas operações de gravação em múltiplos namespaces.

function bulkWrite(
    BulkWriteCommand|ClientBulkWrite $bulk,
    array $options = []
): MongoDB\BulkWriteCommandResult

Parâmetros

$bulk : MongoDB\ClientBulkWrite ou

BulkWriteCommand

Dica

Preferir API ClientBulkWrite

Recomendamos usar a classe e os métodos do construtor ClientBulkWrite para especificar operações de escrita em um comando de escrita em massa em vez de usar a classe BulkWriteCommand. O ClientBulkWrite fornece uma API fluente com métodos semelhantes aos métodos CRUD da classe MongoDB\Collection.

Representa o comando ou construtor de gravação em massa montado. MongoDB\Client::bulkWrite() suporta operações deleteMany(), deleteOne(), insertOne(), replaceOne(), updateMany() e updateOne().

$options : array

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação.
writeConcern	MongoDB\Driver\WriteConcern	Write concern a ser usada na operação. O padrão é a write concern da coleção. Não é possível especificar uma write concern 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 objeto MongoDB\BulkWriteCommandResult .

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).

MongoDB\Driver\Exception\BulkWriteCommandException para erros relacionados à operação de gravação. Você pode inspecionar o valor retornado por getWriteErrors() para determinar a natureza do erro.

Comportamento

Se uma MongoDB\Driver\Exception\BulkWriteCommandException for lançada, você poderá chamar getWriteErrors() e inspecionar as informações na array retornada para determinar a natureza do erro.

Por exemplo, uma operação de gravação pode ter sido aplicada com êxito ao servidor primário , mas não atendeu ao preocupação de gravação. Como alternativa, uma operação de gravação pode ter falhado completamente, por exemplo , por violar a restrição de chave exclusiva.

No caso de uma escrita em massa, o resultado pode indicar múltiplas operações de escrita bem-sucedidas e/ou erros. Se a opção ordered for true, algumas operações podem ter sido bem-sucedidas antes de o primeiro erro ser encontrado e a exceção lançada. Se a opção ordered for false, vários erros podem ter sido encontrados.

Veja também

• Seção Gravação em massa do cliente do Guia de operações de gravação em massa

• Operações CRUD
• MongoDB\Collection::deleteMany()
• MongoDB\Collection::deleteOne()
• MongoDB\Collection::insertMany()
• MongoDB\Collection::insertOne()
• MongoDB\Collection::replaceOne()
• MongoDB\Collection::updateMany()
• MongoDB\Collection::updateOne()