JSON Schema is a vocabulary that allows you to annotate and validate JSON documents. You can use JSON schema to specify validation rules for your fields in a human-readable format.
You can use JSON schema validation for deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
MongoDB supports draft 4 of JSON Schema, including core specification and validation specification , with some differences. For details, see Extensions and Omissions.
For more information about JSON Schema, see the official website.
You can't specify schema validation for:
Collections in the admin, local, and config databases
If you have Client-Side Field Level Encryption or Queryable Encryption enabled on a collection, validation is subject to the following restrictions:
For CSFLE, when running collMod, the libmongocrypt library prefers the the JSON encryption schema specified in the command. This enables setting a schema on a collection that does not yet have one.
For Queryable Encryption, any JSON schema that includes an encrypted field results in a query analysis error.
In this example, you create a students collection with validation rules and observe the results after you attempt to insert an invalid document.
In mongosh, run the following command to create a students collection and use the $jsonSchema operator to set schema validation rules:
db.createCollection("students", { validator: { $jsonSchema: { bsonType: "object", title: "Student Object Validation", required: [ "address", "major", "name", "year" ], properties: { name: { bsonType: "string", description: "'name' must be a string and is required" }, year: { bsonType: "int", minimum: 2017, maximum: 3017, description: "'year' must be an integer in [ 2017, 3017 ] and is required" }, gpa: { bsonType: [ "double" ], description: "'gpa' must be a double if the field exists" } } } }} )You can use title and description fields to provide an explanation of validation rules when the rules are not immediately clear. When a document fails validation, MongoDB includes these fields in the error output.
Run the following command. The insert operation fails because gpa is an integer when the validator requires a double.
db.students.insertOne( { name: "Alice", year: Int32( 2019 ), major: "History", gpa: Int32(3), address: { city: "NYC", street: "33rd Street" }} )MongoServerError: Document failed validationAdditional information: { failingDocumentId: ObjectId("630d093a931191850b40d0a9"), details: { operatorName: '$jsonSchema', title: 'Student Object Validation', schemaRulesNotSatisfied: [ { operatorName: 'properties', propertiesNotSatisfied: [ { propertyName: 'gpa', description: "'gpa' must be a double if the field exists", details: [ { operatorName: 'bsonType', specifiedAs: { bsonType: [ 'double' ] }, reason: 'type did not match', consideredValue: 3, consideredType: 'int' } ] } ] } ] }}If you change the gpa field value to a double type, the insert operation succeeds. Run the following command to insert the valid document:
db.students.insertOne( { name: "Alice", year: Int32(2019), major: "History", gpa: Double(3.0), address: { city: "NYC", street: "33rd Street" }} )To confirm that you've successfully inserted the document, run the following command to query the students collection:
[ { _id: ObjectId("62bb413014b92d148400f7a5"), name: 'Alice', year: 2019, major: 'History', gpa: 3, address: { city: 'NYC', street: '33rd Street' } }]You can combine JSON Schema validation with query operator validation.
For example, consider a sales collection with this schema validation:
db.createCollection("sales", { validator: { "$and": [ { "$expr": { "$lt": ["$lineItems.discountedPrice", "$lineItems.price"] } }, { "$jsonSchema": { "properties": { "items": { "bsonType": "array" } } } } ] } })The preceding validation enforces these rules for documents in the sales collection:
lineItems.discountedPrice must be less than lineItems.price. This rule is specified using the $lt operator.
The items field must be an array. This rule is specified using $jsonSchema.
To see the complete list of allowed keywords in a JSON schema, see Available Keywords.
To restrict what values a certain field can contain, see Specify Allowed Field Values.
To avoid issues with JSON schema validation, see Tips for JSON Schema Validation.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4