validate (database command数据库命令)

Definition定义

validate

The validate command checks a collection's data and indexes for correctness and returns the results. The command also repairs any inconsistencies in the count and data size of a collection.validate命令检查集合的数据和索引是否正确，并返回结果。该命令还修复集合的计数和数据大小中的任何不一致。

Tip

In mongosh, this command can also be run through the validate() helper method.在mongosh中，此命令也可以通过validate()辅助方法运行。

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. 助手方法对mongosh用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。In cases where the convenience is not needed or the additional return fields are required, use the database command.如果不需要便利性或需要额外的返回字段，请使用database命令。

Changed in version 5.0.在版本5.0中的更改。

Starting in version 5.0, the validate command can also find inconsistencies in the collection and fix them if possible.从5.0版本开始，validate命令还可以发现集合中的不一致，并在可能的情况下进行修复。

Index inconsistencies include:指数不一致包括：

• An index is multikey but there are no multikey fields.索引是多键的，但没有multikey字段。
• An index has multikeyPaths covering fields that are not multikey.索引具有覆盖非多键字段的multikeyPaths。
• An index does not have multikeyPaths but there are multikey documents (for indexes built before 3.4).索引没有multikeyPaths，但有多键文档（适用于3.4之前构建的索引）。

If any inconsistencies are detected by the db.collection.validate() command, a warning is returned and the repair flag on the index is set to true.如果db.collection.validate()命令检测到任何不一致，将返回警告，并将索引上的修复标志设置为true。

db.collection.validate() also validates any documents that violate the collection's schema validation rules.还验证任何违反集合模式验证规则的文档。

Note

The validate command does not support views and raises an error when run against a view.validate命令不支持视图，并在对视图运行时引发错误。

The db.collection.validate() method in mongosh provides a wrapper around validate.mongosh中的db.collection.validate()方法提供了一个围绕validate的包装器。

Compatibility兼容性

This command is available in deployments hosted in the following environments:此命令在以下环境中托管的部署中可用：

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud：云中MongoDB部署的完全托管服务

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB：MongoDB的基于订阅的自我管理版本
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB：MongoDB的源代码可用、免费使用和自我管理版本

Syntax语法

The command has the following syntax:该命令具有以下语法：

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
   }
)

Command Fields命令字段

The command takes the following fields:该命令包含以下字段：

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

Behavior行为

Examples示例

• To validate a collection myCollection using the default validation setting (specifically, full: false):要使用默认验证设置（特别是full:false）验证集合myCollection，请执行以下操作：

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

• To perform a full validation of collection myCollection, specify full: true:要对集合myCollection执行完整验证，请指定full:true：

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

• To repair collection myCollection, specify repair: true:要修复集合myCollection，请指定repair:true：

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

• To validate the metadata in the myCollection collection, specify metadata: true:要验证myCollection集合中的元数据，请指定metadata:true：

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

• To perform additional BSON conformance checks in myCollection, specify checkBSONConformance: true:要在myCollection中执行其他BSON一致性检查，请指定checkBSONConformance:true：

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

Validate Output验证输出

Specify full: true for more detailed output.指定full:true以获得更详细的输出。

validate.uuid

The universally unique identifier (UUID) for the collection.集合的通用唯一标识符（UUID）。

New in version 6.2.在版本6.2中新增。

validate.nInvalidDocuments

The number of invalid documents in the collection. Invalid documents are those that are not readable, which means the BSON document is corrupt and has an error or a size mismatch.集合中无效文档的数量。无效文档是指不可读的文档，这意味着BSON文档已损坏，存在错误或大小不匹配。

validate.nNonCompliantDocuments

The number of documents not conforming to the collection's schema. Non-compliant documents are not counted as invalid in nInvalidDocuments.不符合集合架构的文档数。不符合要求的文档在nInvalidDocuments中不被视为无效。

Starting in MongoDB 6.2, nNonCompliantDocuments also includes the number of documents that do not conform to the BSON or time series collection requirements.从MongoDB 6.2开始，nNonComplianceDocuments还包括不符合BSON或时间序列集合要求的文档数量。

validate.nrecords

The number of documents in the collection.集合中的文档数量。

validate.nIndexes

The number of indexes on the collection that were validated.集合上已验证的索引数。

validate.keysPerIndex

A document that contains the name and index entry count for each index on the collection.包含集合上每个索引的名称和索引条目计数的文档。

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

keysPerIndex identifies the index by its name only.仅通过索引名称标识索引。

validate.indexDetails

Changed in version 8.1.在版本8.1中的更改。

A document that contains the status of the index validation for each index and the index specification.包含每个索引的索引验证状态和索引规范的文档。

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

• indexDetails identifies the specific index (or indexes) that is invalid. Earlier versions of MongoDB would mark all indexes as invalid, if any of the indexes were invalid.标识无效的特定索引。如果任何索引无效，早期版本的MongoDB会将所有索引标记为无效。
• indexDetails identifies the index by its name only. Earlier versions of MongoDB displayed the full namespace of the index; i.e. <db>.<collection>.$<index_name>.仅通过索引名称标识索引。早期版本的MongoDB显示了索引的完整命名空间；即<db>.<collection>.$<index_name>。

• The spec document is the index specification, which varies depending on how the index is defined. Some example spec document fields include:spec文档是索引规范，根据索引的定义而有所不同。一些示例spec文档字段包括：

  • spec.v. The index version..索引版本。
  • spec.unique. A Boolean value that indicates if the index is unique.。一个布尔值，指示索引是否唯一。
  • spec.key. The index key identifier.索引键标识符。
  • spec.name. The index name.。索引名称。

  New in version 8.1.在版本8.1中新增。

validate.ns

The full namespace name of the collection. Namespaces include the database name and the collection name in the form database.collection.集合的完整命名空间名称。命名空间包括数据库名称和表单database.collection中的集合名称。

validate.valid

A boolean that is true if validate determines that all aspects of the collection are valid. When false, see the errors field for more information.如果validate确定集合的所有方面都有效，则布尔值为true。如果为false，请参阅错误字段以获取更多信息。

validate.repaired

A boolean that is true if validate repaired the collection.一个布尔值，如果validate修复了集合，则为true。

validate.repairMode

New in version 8.2.在版本8.2中新增。

A string that indicates what types of data inconsistencies the validate command attempted to repair, if detected. 一个字符串，指示validate命令尝试修复哪些类型的数据不一致（如果检测到）。Possible repairMode values include:可能的repairMode值包括：

• None: No repair actions are taken.：未采取任何维修行动。
• FixErrors: Attempts to fix any validation errors.：尝试修复任何验证错误。
• AdjustMultikey: Attempts to fix multikey inconsistencies by adjusting multikey metadata.：尝试通过调整多键元数据来修复多键不一致。

validate.warnings

An array that contains warning messages, if any, regarding the validate operation itself. The warning messages do not indicate that the collection is itself invalid. For example:一个数组，其中包含有关验证操作本身的警告消息（如果有的话）。警告消息并不表示集合本身无效。例如：

"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

If the collection is not valid (i.e valid is false), this field will contain a message describing the validation error.如果集合无效（即valid为false），则此字段将包含一条描述验证错误的消息。

validate.extraIndexEntries

An array that contains information for each index entry that points to a document that does not exist in the collection.一个数组，包含指向集合中不存在的文档的每个索引条目的信息。

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

Note

For the extraIndexEntries array, the sum of all the indexKey field sizes has a limit of 1MB where the sizes include both the keys and values for the indexKey. If the sum exceeds this size, the warning field displays a message.对于extraIndexEntries数组，所有indexKey字段大小的总和限制为1MB，其中大小包括indexKey的键和值。如果总和超过此大小，警告字段将显示一条消息。

validate.missingIndexEntries

An array that contains information for each document that is missing the corresponding index entry.一个数组，包含缺少相应索引条目的每个文档的信息。

"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>,
         ...
      }
   }
   ...
 ]

Note

For the missingIndexEntries array, the sum of the idKey field size and all its indexKey field sizes has a limit of 1MB where the field sizes include both the keys and values for the idKey and indexKey. 对于missingIndexEntries数组，idKey字段大小与其所有indexKey字段大小之和的限制为1MB，其中字段大小包括idKey和indexKey的键和值。If the sum exceeds this size, the warning field displays a message.如果总和超过此大小，警告字段将显示一条消息。

validate.corruptRecords

An array of RecordId values for documents that are unreadable, possibly because the data is damaged. These documents are reported as corrupt during validation. 不可读文档的RecordId值数组，可能是因为数据已损坏。这些文档在验证过程中被报告为已损坏。A RecordId is a 64-bit integer internal key that uniquely identifies a document in a collection.RecordId是一个64位整数内部键，用于唯一标识集合中的文档。

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

New in version 5.0.在版本5.0中新增。

validate.ok

An integer with the value 1 when the command succeeds. If the command fails the ok field has a value of 0.命令成功时，值为1的整数。如果命令失败，ok字段的值为0。