WriteResult() (método mongosh)

Definição

WriteResult()

A wrapper that contains the result status of mongosh write methods.

Dica

• db.collection.insert()

• db.collection.update()

• db.collection.remove()

Observação

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

The results returned by the replacement methods have a different format. For output similar to WriteResult(), consider using db.collection.bulkWrite().

Compatibilidade

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

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

• 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

The WriteResult() has the following properties:

WriteResult.nInserted

The number of documents inserted, excluding upserted documents. See WriteResult.nUpserted for the number of documents inserted through an upsert.

WriteResult.nMatched

The number of documents selected for update. If the update operation results in no change to the document, e.g. $set expression updates the value to the current value, nMatched can be greater than nModified.

WriteResult.nModified

The number of existing documents updated. If the update/replacement operation results in no change to the document, such as setting the value of the field to its current value, nModified can be less than 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 de esquema, o servidor produz um erro neste 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.0.6:

(also available in 6.0.14 and 5.0.30): When WriteResult() is received from mongos, write concern errors are always reported, even when one or more write errors occur. In previous releases, the occurrence of write errors could cause the WriteResult() to not report write concern errors.

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 write concern foi especificada no aplicativo.
customDefault	A write concern originou-se de um valor padrão personalizado definido. Consulte setDefaultRWConcern.
getLastErrorDefaults	A write concern originada do campo settings.getLastErrorDefaults do conjunto de réplicas.
implicitDefault	A write concern originou-se do servidor na ausência de todas as outras especificações de write concern.