WriteResult()

Definição

WriteResult()

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

Dica

Consulte:

• db.collection.insert()

• db.collection.update()

• db.collection.remove()

Observação

db.collection.insert() and db.collection.update() are deprecated.

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: 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

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

The number of documents inserted by an upsert.

WriteResult._id

The _id of the document inserted by an upsert. Returned only if an upsert results in an insert.

WriteResult.nRemoved

The number of documents removed.

WriteResult.writeError

A document that contains information regarding any error, excluding write concern errors, encountered during the write operation.

WriteResult.writeError.code

Um valor inteiro identificando o erro.

WriteResult.writeError.errmsg

Uma descrição do erro.

WriteResult.writeConcernError

Document describing errors that relate to the write concern.

Changed in version 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.

Cada documento de erro contém os seguintes campos:

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.