WriteResult()

Definição

WriteResult()

Um wrapper que contém o status do resultado dos métodos de escrita mongosh .

Dica

Consulte:

• db.collection.insert()

• db.collection.update()

• db.collection.remove()

Observação

db.collection.insert() e db.collection.update() estão obsoletos.

Os resultados retornados pelos métodos de substituição têm um formato diferente. Para uma saída semelhante a WriteResult(), considere usar db.collection.bulkWrite().

Compatibilidade

Esse método está disponível em implantações hospedadas nos seguintes ambientes:

• MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

• MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

• MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Propriedades

O WriteResult() tem as seguintes propriedades:

WriteResult.nInserted

O número de documentos inseridos, excluindo os documentos upserted. Consulte WriteResult.nUpserted para saber o número de documentos inseridos por meio de um upsert.

WriteResult.nMatched

O número de documentos selecionados para atualização. Se a operação de atualização não resultar em alterações no documento, por exemplo, a expressão $set atualiza o valor para o valor atual, nMatched pode ser maior que nModified.

WriteResult.nModified

O número de documentos existentes atualizados. Se a operação de atualização/substituição não resultar em nenhuma alteração no documento, como a definição do valor do campo para seu valor atual, nModified poderá ser menor que nMatched.

WriteResult.nUpserted

O número de documentos inseridos por upsert.

WriteResult._id

O _id do documento inserido por upsert. Retornado somente se um upsert resultar em uma inserção.

WriteResult.nRemoved

O número de documentos removidos.

WriteResult.writeError

Um documento que contém informações sobre qualquer erro, exceto erros de write concern, encontrado durante a operação de escrita.

WriteResult.writeError.code

Um valor inteiro identificando o erro.

WriteResult.writeError.errmsg

Uma descrição do erro.

WriteResult.writeError.errInfo

Um documento que contém informações sobre qualquer erro de escrita, exceto erros de preocupação de gravação , que foram encontrados durante a operação de escrita. Quando uma operação falha na validação do documento , o servidor produz um erro nesse campo explicando por que o documento não correspondeu à expressão validador da coleção.

WriteResult.writeConcernError

Documento descrevendo erros relacionados à preocupação de gravação.

Alterado na versão 7.1: Quando WriteResult() é recebido de mongos, os erros de preocupação de gravação são sempre relatados, mesmo quando ocorrem um ou mais erros de escrita.

Em versões anteriores, a ocorrência de erros de gravação poderia fazer com que WriteResult() não relatasse erros de preocupação de gravação .

WriteResult.writeConcernError.code

Um valor inteiro que identifica a causa do erro de write concern.

WriteResult.writeConcernError.errmsg

Uma descrição da causa do erro de write concern.

WriteResult.writeConcernError.errInfo.writeConcern

O objeto de write concern usado para a operação correspondente. Para obter informações sobre os campos de objeto de write concern, consulte Especificação de write concern.

O objeto de write concern também pode conter o seguinte campo, indicando a origem da write concern:

WriteResult.writeConcernError.errInfo.writeConcern.provenance

Um valor de string que indica a origem do write concern (conhecido como write concern provenance). A tabela a seguir mostra os valores possíveis para este campo e sua significância:

Proveniência	Descrição
clientSupplied	A preocupação de gravação foi especificada no aplicativo.
customDefault	A preocupação de gravação originou-se de um valor padrão personalizado definido. Consulte setDefaultRWConcern.
getLastErrorDefaults	A preocupação de gravação originada do campo settings.getLastErrorDefaults do conjunto de réplicas.
implicitDefault	A preocupação de gravação originou-se do servidor na ausência de todas as outras especificações de preocupação de gravação.