Docs HomeDevelop ApplicationsMongoDB Manual

Specify Validation Level for Existing Documents指定现有文档的验证级别

On this page本页内容

For documents that already exist in your collection prior to adding validation, you can specify how MongoDB applies validation rules to these documents.对于在添加验证之前已经存在于集合中的文档,您可以指定MongoDB如何将验证规则应用于这些文档。

Context上下文

Your schema's validationLevel determines the documents for which MongoDB applies validation rules:您的模式的validationLevel确定MongoDB应用验证规则的文档:

Validation Level验证级别Behavior
strict (Default) MongoDB applies validation rules to all inserts and updates.(默认)MongoDB将验证规则应用于所有插入和更新。
moderate MongoDB only applies validation rules to existing valid documents. MongoDB仅将验证规则应用于现有的有效文档。Updates to invalid documents which exist prior to the validation being added are not checked for validity.对添加验证之前存在的无效文档的更新不会进行有效性检查。

Prerequisite先决条件

The examples on this page use a contacts collection with these documents:本页上的示例将contacts集合用于以下文档:

db.contacts.insertMany([
   { "_id": 1, "name": "Anne", "phone": "+1 555 123 456", "city": "London", "status": "Complete" },
   { "_id": 2, "name": "Ivan", "city": "Vancouver" }
])

Steps: Use strict Validation步骤:使用strict验证

The following example adds a strict validation to the contacts collection and shows the results when attempting to update invalid documents.下面的示例向contacts集合添加了strict验证,并显示了尝试更新无效文档时的结果。

1

Specify validation rules with strict validation level.指定具有strict验证级别的验证规则。

Add a validator to the contacts collection with strict validationLevel:使用strict validationLevel将验证器添加到contacts集合:

db.runCommand( {
   collMod: "contacts",
   validator: { $jsonSchema: {
      bsonType: "object",
      required: [ "phone", "name" ],
      properties: {
         phone: {
            bsonType: "string",
            description: "phone must be a string and is required"
         },
         name: {
            bsonType: "string",
            description: "name must be a string and is required"
         }
      }
   } },
   validationLevel: "strict"
} )

Because the validationLevel is strict, when any document is updated, MongoDB checks that document for validation.因为validationLevelstrict,所以当更新任何文档时,MongoDB都会检查该文档是否有效。

2

Test the validation.测试验证。

The following update commands modify both documents in the contacts collection such that neither of the documents are consistent with the validation rule which requires name to be a string:以下更新命令修改contacts集合中的两个文档,以使两个文档都不符合要求name为字符串的验证规则:

db.contacts.updateOne(
   { _id: 1 },
   { $set: { name: 10 } }
)
db.contacts.updateOne( { _id: 2 }, { $set: { name: 20 } } )
3

Observe results.观察结果。

Both update operations fail. MongoDB returns the following output for each operation:两个更新操作都失败。MongoDB为每个操作返回以下输出:

 MongoServerError: Document failed validation
 Additional information: {
   failingDocumentId: <id>,
   details: {
     operatorName: '$jsonSchema',
     schemaRulesNotSatisfied: [
       {
         operatorName: 'properties',
         propertiesNotSatisfied: [
           {
             propertyName: 'name',
             description: 'name must be a string and is required',
             details: [
               {
                 operatorName: 'bsonType',
                 specifiedAs: { bsonType: 'string' },
                 reason: 'type did not match',
                 consideredValue: <value>,
                 consideredType: 'int'
               }
             ]
           }
         ]
       },
       {
         operatorName: 'required',
         specifiedAs: { required: [ 'phone', 'name' ] },
         missingProperties: [ 'phone' ]
       }
     ]
   }
 }

Steps: Use moderate Validation步骤:使用moderate验证

The following example adds a moderate validation to the contacts collection and shows the results when attempting to update invalid documents.下面的示例向contacts集合添加了moderate验证,并显示了尝试更新无效文档时的结果。

1

Specify validation rules with moderate validation level.指定具有moderate验证级别的验证规则。

Add a validator to the contacts collection with moderate validationLevel:将验证器添加到具有validationLevelmoderatecontacts集合:

db.runCommand( {
   collMod: "contacts",
   validator: { $jsonSchema: {
      bsonType: "object",
      required: [ "phone", "name" ],
      properties: {
         phone: {
            bsonType: "string",
            description: "phone must be a string and is required"
         },
         name: {
            bsonType: "string",
            description: "name must be a string and is required"
         }
      }
   } },
   validationLevel: "moderate"
} )

Because the validationLevel is moderate:因为validationLevelmoderate的:

  • If you update the document with _id: 1, MongoDB applies the new validation rules because the existing document meets the validation requirements.如果使用_id:1更新文档,MongoDB将应用新的验证规则,因为现有文档满足验证要求。

  • If you update the document with _id: 2, MongoDB does not apply the new validation rules because the existing document does not meet the validation requirements.如果使用_id:2更新文档,MongoDB不会应用新的验证规则,因为现有文档不符合验证要求。

2

Test the validation.测试验证。

The following update commands modify both documents in the contacts collection such that neither of the documents are consistent with the validation rule which requires name to be a string:以下更新命令修改contacts集合中的两个文档,以使两个文档都不符合要求name为字符串的验证规则:

db.contacts.updateOne(
   { _id: 1 },
   { $set: { name: 10 } }
)
db.contacts.updateOne( { _id: 2 }, { $set: { name: 20 } } )
3

Observe results.观察结果。

MongoDB returns the following output for each operation:MongoDB为每个操作返回以下输出:

// _id: 1
MongoServerError: Document failed validation Additional information: { failingDocumentId: 1, details: { operatorName: '$jsonSchema', schemaRulesNotSatisfied: [ { operatorName: 'properties', propertiesNotSatisfied: [ { propertyName: 'name', description: 'name must be a string and is required', details: [ { operatorName: 'bsonType', specifiedAs: { bsonType: 'string' }, reason: 'type did not match', consideredValue: 10, consideredType: 'int' } ] } ] } ] } }
// _id: 2
{ acknowledged: true, insertedId: null, matchedCount: 1, modifiedCount: 0, upsertedCount: 0 }

The output shows that:输出显示:

  • The update fails for the document with _id: 1. 对于_id1的文档,更新失败。This document met the initial validation requirements, and MongoDB applies validation rules to this document.本文档满足初始验证要求,MongoDB将验证规则应用于本文档。

  • The update succeeds for the document with _id: 2. _id2的文档更新成功。This document did not meet the initial validation requirements, and MongoDB does not apply validation rules to this document.本文档不符合初始验证要求,MongoDB不将验证规则应用于本文档。

Important重要

The error output is intended for human consumption. 错误输出旨在供人类使用。It may change in the future and should not be relied upon in scripts.它可能在将来发生变化,不应在脚本中依赖。

Learn More

←  Modify Schema Validation修改架构验证Choose How to Handle Invalid Documents选择如何处理无效文档 →