WriteResult()

定义

WriteResult()

包含 mongosh写入方法的结果状态的包装器。

提示

请参阅：

• db.collection.insert()

• db.collection.update()

• db.collection.remove()

注意

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

替换方法返回的结果采用不同的格式。对于类似 WriteResult() 的输出，可以考虑使用 db.collection.bulkWrite()。

兼容性

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

• MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

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

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

属性

WriteResult() 具有以下属性：

WriteResult.nInserted

插入的文档数，不包括 upserted 文档。有关通过更新或插入来插入的文档数，请参阅 WriteResult.nUpserted。

WriteResult.nMatched

选择更新的文档数。如果更新操作不会导致文档发生任何更改，例如，$set 表达式将数值更新为当前值，nMatched 可大于 nModified。

WriteResult.nModified

已更新的现有文档数。如果更新/替换操作导致文档未发生变化，例如将字段的值设置为其当前值，则 nModified 可以小于 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.1中进行了更改： 当从WriteResult() 收到 时，即使发生一个或多个写入错误，也始终会报告写关注（writemongos concern）错误。

在以前的版本中，发生写入错误可能会导致WriteResult()不报告写关注（write concern）错误。

WriteResult.writeConcernError.code

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

WriteResult.writeConcernError.errmsg

写关注错误原因的描述。

WriteResult.writeConcernError.errInfo.writeConcern

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

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

WriteResult.writeConcernError.errInfo.writeConcern.provenance

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

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