WriteResult()（mongosh方法）

定义

WriteResult()

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

提示

• db.collection.insert()

• db.collection.update()

• db.collection.remove()

注意

db.collection.insert() 和 db.collection.update() 已弃用。

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

兼容性

此方法可用于以下环境中托管的部署：

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

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

属性

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

upsert 插入的文档数。

WriteResult._id

通过 upsert 插入的文档的 _id。仅当 upsert 导致插入时返回。

WriteResult.nRemoved

删除的文档数。

WriteResult.writeError

包含写入操作过程中遇到的任何错误（不包括写关注错误）的相关信息的文档。

WriteResult.writeError.code

标识错误的整数值。

WriteResult.writeError.errmsg

错误描述。

WriteResult.writeError.errInfo

包含写入操作期间遇到的任何写入错误（不包括写关注（write concern）错误）的信息的文档。 当操作模式验证失败时，服务器会在此字段下产生错误，解释文档与集合的验证器表达式不匹配的原因。

WriteResult.writeConcernError

描述与写关注（write concern）相关的错误的文档。

在版本 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

一个整数值，用于标识写关注错误原因。

WriteResult.writeConcernError.errmsg

写关注错误原因的描述。

WriteResult.writeConcernError.errInfo.writeConcern

用于相应操作的写关注对象。有关写关注对象字段的信息，请参阅写关注规范。

写关注对象还可能包含以下字段，指示写关注的来源：

WriteResult.writeConcernError.errInfo.writeConcern.provenance

一个表示写关注来源（称为写关注provenance）的字符串值。下表显示该字段的可能值及其有效位数：

来源	说明
clientSupplied	应用程序中指定了写关注。
customDefault	写入关注源自自定义的默认值。请参阅 setDefaultRWConcern。
getLastErrorDefaults	写关注源自副本集的 settings.getLastErrorDefaults 字段。
implicitDefault	在没有所有其他写入关注规范的情况下，写入关注源自服务器。