验证

定义

validate

命令validate命令检查集合的数据和索引的正确性，并返回结果。如果您不在后台运行此命令，该命令还将修复集合计数和数据大小中的任何不一致。

提示

在mongosh中，此命令也可以通过validate()辅助方法.

辅助方法对于mongosh用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。在不需要便利性或需要额外的返回字段的情况下，请使用数据库命令。

在版本中更改中5.0.

从版本5.0开始，validate命令还可以在集合中找到不一致之处，并在可能的情况下修复它们。

索引不一致包括

• 一个索引是多键，但没有多键字段。

• 索引包含覆盖非多键字段的多键路径。

• 索引没有多键路径，但有包含多键文档的文档（对于在3.4之前构建的索引）。

如果db.collection.validate()命令检测到任何不一致性，则会返回警告，并将索引上的修复标志设置为true。

db.collection.validate()还会验证任何违反集合模式验证规则的文档。

注意

validate命令不支持视图，并在针对视图运行时引发错误。

db.collection.validate()方法在mongosh中为validate提供包装。

兼容性

此命令在以下环境中托管的部署中可用

• MongoDB Atlas：云中MongoDB部署的全面托管服务

• MongoDB Enterprise：基于订阅的自托管MongoDB版本

• MongoDB Community：源可用的免费使用和自托管MongoDB版本

语法

命令有以下语法

db.runCommand(
   {
     validate: <string>,  // Collection name
     full: <boolean>,  // Optional
     repair: <boolean>,  // Optional, added in MongoDB 5.0
     metadata: <boolean>,  // Optional, added in MongoDB 5.0.4
     checkBSONConformance: <boolean>  // Optional, added in MongoDB 6.2
     background: <boolean> // Optional
   }
)

命令字段

命令包含以下字段

db.runCommand( { collMod: <collectionName> } )

行为

示例

• 使用默认验证设置（特别是，full: false）验证集合myCollection

  db.runCommand( { validate: "myCollection" } )

• 要执行集合myCollection的完整验证，指定full: true:

  db.runCommand( { validate: "myCollection", full: true } )

• 要修复集合myCollection，指定repair: true:

  db.runCommand( { validate: "myCollection", repair: true } )

• 要验证集合myCollection中的元数据，指定metadata: true:

  db.runCommand( { validate: "myCollection", metadata: true } )

• 要在myCollection中执行额外的BSON合规性检查，指定checkBSONConformance: true:

  db.runCommand( { validate: "myCollection", checkBSONConformance: true } )

验证输出

指定full: true以获得更详细的输出。

validate.uuid

集合的全局唯一标识符（UUID）。

新中6.2.

validate.nInvalidDocuments

集合中无效文档的数量。无效文档是指不可读的文档，这意味着BSON文档已损坏或大小不匹配。

validate.nNonCompliantDocuments

不符合集合模式的文档数量。不符合规范的文档不计入 nInvalidDocuments.

从MongoDB 6.2版本开始，nNonCompliantDocuments 还包括不符合BSON 或 时间序列集合要求的文档数量。

validate.nrecords

集合中的文档数量。

validate.nIndexes

已验证的集合索引数量。

validate.keysPerIndex

包含每个索引的名称和索引条目计数的一个文档。

"keysPerIndex" : {
   "_id_" : <num>,
   "<index2_name>" : <num>,
   ...
}

keysPerIndex 通过名称来识别索引。

validate.indexDetails

包含每个索引索引验证状态的文档。

"indexDetails" : {
   "_id_" : {
      "valid" : <boolean>
   },
   "<index2_name>" : {
      "valid" : <boolean>
   },
   ...
}

• indexDetails标识了无效的特定索引（或索引）。MongoDB的早期版本在任一索引无效时，会将所有索引标记为无效。

• indexDetails通过索引名称标识索引。MongoDB的早期版本显示索引的完整命名空间；即 <db>.<collection>.$<index_name>。

validate.ns

集合的完整命名空间名称。命名空间包括数据库名和集合名，形式为 database.collection。

validate.valid

一个布尔值，当 validate 确定集合的所有方面都有效时为 true。当为 false 时，请参阅 errors 字段以获取更多信息。

validate.repaired

一个布尔值，当 validate 修复了集合时为 true。

validate.warnings

一个包含有关验证操作本身的警告消息的数组（如果有）。警告消息不表示集合本身无效。例如

"warnings" : [
   "Could not complete validation of table:collection-28-6471619540207520785. This is a transient issue as the collection was actively in use by other operations."
],

validate.errors

如果集合无效（即 valid 为假），则此字段将包含描述验证错误的消息。

validate.extraIndexEntries

一个数组，包含指向集合中不存在文档的每个索引条目的信息。

"extraIndexEntries" : [
   {
      "indexName" : <string>,
      "recordId" : <NumberLong>,  // for the non-existent document
      "indexKey" : {
         "<key1>" : <value>,
         ...
      }
   }
   ...
]

注意

对于 extraIndexEntries 数组，所有 indexKey 字段大小的总和有一个限制为 1MB，其中大小包括 indexKey 的键和值。如果总和超过此大小，则警告字段将显示一条消息。

validate.missingIndexEntries

一个数组，包含缺少相应索引条目的每个文档的信息。

"missingIndexEntries" : [
   {
      "indexName" : <string>,
      "recordId" : <NumberLong>,
      "idKey" : <_id key value>,     // The _id value of the document. Only present if an ``_id`` index exists.
      "indexKey" : {                 // The missing index entry
         "<key1>" : <value>,
         ...
      }
   }
   ...
 ]

注意

对于 missingIndexEntries 数组，idKey 字段大小及其所有 indexKey 字段大小的总和有一个限制为 1MB，其中字段大小包括 idKey 和 indexKey 的键和值。如果总和超过此大小，则警告字段将显示一条消息。

validate.corruptRecords

一个包含不可读文档的 RecordId 值的数组，可能是因为数据损坏。这些文档在验证过程中被报告为损坏。一个 RecordId 是一个唯一标识集合中文档的 64 位整数内部键。

"corruptRecords" : [
   NumberLong(1),  // RecordId 1
   NumberLong(2)   // RecordId 2
]

新中5.0.

validate.ok

当命令成功时，该整数值为 1。如果命令失败，则 ok 字段值为 0。