Specify JSON Schema Validation

Context

MongoDB admite el borrador 4 de JSON Schema, incluidos especificación central y especificación de validación, con algunas diferencias. Para más detalles, consulte Extensiones y Omisiones.

Para obtener más información sobre JSON Schema, consulta el sitio web oficial.

Restricciones

No puedes especificar la validación del esquema para:

• Colecciones en el adminlocal, y config bases de datos

• Colecciones del sistema

Si tiene Cifrado a nivel de campo del lado del cliente o Queryable Encryption habilitado en una colección, la validación está sujeta a las siguientes restricciones:

• Para CSFLE, al collMod ejecutar, la biblioteca libmongocrypt prefiere el esquema de cifrado JSON especificado en el comando. Esta preferencia permite establecer un esquema en una colección que aún no tiene uno.

• Para Queryable Encryption, cualquier JSON schema que incluya un campo cifrado resulta en un error de análisis de query.

Pasos

En este ejemplo, se crea una colección students con reglas de validación y se pueden observar los resultados después de intentar insertar un documento no válido.

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

db.students.insertOne( {
   name: "Alice",
   year: Int32( 2019 ),
   major: "History",
   gpa: Int32(3),
   address: {
      city: "NYC",
      street: "33rd Street"
   }
} )

MongoServerError: Document failed validation
Additional 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'
              }
            ]
          }
        ]
      }
    ]
  }
}

config.set("inspectDepth", Infinity)

db.students.insertOne( {
   name: "Alice",
   year: Int32(2019),
   major: "History",
   gpa: Double(3.0),
   address: {
      city: "NYC",
      street: "33rd Street"
   }
} )

db.students.find()

[
   {
      _id: ObjectId("62bb413014b92d148400f7a5"),
      name: 'Alice',
      year: 2019,
      major: 'History',
      gpa: 3,
      address: { city: 'NYC', street: '33rd Street' }
   }
]

Información Adicional

Puedes combinar la validación de esquema JSON con la validación del operador del query.

Por ejemplo, considere una colección sales con esta validación de esquema:

 db.createCollection("sales", {
   validator: {
     "$and": [
       // Validation with query operators
       {
         "$expr": {
           "$lt": ["$lineItems.discountedPrice", "$lineItems.price"]
         }
       },
       // Validation with JSON Schema
       {
         "$jsonSchema": {
           "properties": {
             "items": { "bsonType": "array" }
           }
          }
        }
      ]
    }
  }
)

La validación anterior aplica estas reglas para los documentos de la colección sales:

• lineItems.discountedPrice debe ser menor lineItems.price que. Esta regla utiliza el $lt operador.

• El items campo debe ser una matriz. Esta regla $jsonSchema utiliza.

Obtén más información

• Para obtener una lista completa de las palabras clave permitidas en el esquema JSON, consulte Palabras clave disponibles.

• Para restringir los valores que puede contener un determinado campo, consulte Especificar valores permitidos para el campo.

• Para evitar problemas con la validación del esquema JSON,consulte los consejos para la validación del esquema JSON.