Validación de Datos en MongoDB: JSON Schema y Actualizaciones

Contenido del curso

Introducción

Proyecto

Validación de datos

Relaciones

Bonus: patrones

Próximos pasos

22
Modelado de Datos con MongoDB: Relaciones y Consultas Avanzadas
02:03 min

Tomar examen

Cursos Empresas Blog Live Conf Eventos Precios

0:0012:04

Validación de Datos en MongoDB: JSON Schema y Actualizaciones

Curso de Modelado de Datos en MongoDB

Clase 11 de 22

Clase 11 / 22

Comentarios (7)7 comentarios

Sebastián Groselj Pausic

Hace 3 años

APUNTES Tips para validacion en MongoDB

https://www.mongodb.com/docs/v6.0/core/schema-validation/specify-json-schema/json-schema-tips/#tips-for-json-schema-validation

Quitar la flexibilidad a mongo

Para quitar la posibilidad de que aparescan propiedades adicionales en un documento que no esten especificadas.

Esto se logra agregando: additionalProperties: false

$jsonSchema: {
    bsonType: 'object',
    required: ['email', 'password', 'role'],
    additionalProperties: false, // quitar flexibilidad
    properties: {...}

De Christian Gonzalo: Algo que no mencionó Nicolas, es que cuando se coloca la propiedad additionalProperties en false, también se debe agregar obligatoriamente la propiedad _id en el array de required y además validarlo en properties. De lo contrario Mongo no permitirá la inserción de documentos, así tengan la estructura correcta.

$jsonSchema: {
	required: ['_id','email', 'password', 'role'],
	additionalProperties: false,
	properties: {
        _id: {
            bsonType: 'objectId'
        },
	}
}

Reajustar el esquema sin borrar

Primero, para ver la informacion de las colecciones:

use("platzi_store");
db.getCollectionInfos();

Actualizar el esquema

Para cambiarlo, hay que enviar toda la definicion del validador porque va a re-escribirlo. Y requiere de un usuario con permisos de administrador en la base de datos.

Cambiar permisos (Mongo Atlas)

Ir a la administracion de la base de datos
Ir a Security
Ir a Database Access
Editar/Elevar los permisos del usuario elegido (incluso para el original)
Pasar del Read and write to any database a Atlas admin
Guardar los cambios con Update User

Comando de actualización

db.runCommand({
    collMod: 'users', // coleccion a modificar
    validator: { // propiedad de la coleccion a modificar
        $jsonSchema: {
            bsonType: 'object', // igual
            required: ['email', 'password', 'role'], // igual
            additionalProperties: true, // el cambio
            properties: {...} // igual
        }
    }
})

Felipe Mendieta

Hace 3 años

Excelente aporte. Muchas gracias

BALFRE VAZQUEZ CASTREJON

Hace 4 años

Algo a considerar es que el campo name es diferente de Name

Esteban Casallas

Hace 4 años

Hola 👋🏽 ¿Existe algun historial de esos cambios al schema?

Danny Zavid Herrera Hitas

Hace 3 años

Mongo no lo hace, pero puedes versionar los cambios que hagas al mismo con git.

Danilo Sicre

Hace 4 años

Que sucedería si yo quiero agregar un campo nuevo usando el updateOne para un documento ya creado (con un schema definido)?

El schema me lo rechaza o me lo permite?

Fernando Orozco Velasquez

Hace 3 años

Creo que si te permitiría agregarlo siempre y cuando 'additionalProperties' este como true

Danny Zavid Herrera Hitas

Hace 3 años

No te lo permite, todos los updates o inserts deben cumplir con el nuevo esquema definido.

https://www.mongodb.com/docs/manual/core/schema-validation/update-schema-validation/

Emanuel Salazar

Hace 2 años

En mi caso particular cuando genere el esquema con el additionalProperties: false y trataba de insertar un documento me generaba un error de validación. De modo que para que MongoDB me permitiera insertar el documento tuve que agregar la propiedad _id: { bsonType: 'objectId'}, de esta manera si me permitió insertar un documento y generó el id del mismo de manera automática. En caso de que ingreses el '_id' dentro del array de required: ['_id'] MongoDB no permitirá insertar documentos si no relacionas un Id para el documento, es decir no lo va a generar automáticamente, dado que es un campo obligatorio espera que tu mismo insertes este campo.

Oscar Eduardo Muñoz Bernales

Hace 2 años

A mi me pasó que agregando el "additionalProperties" en false no me dejaba insertar un dato

use("platzi_store");

db.getCollection('users').drop();

db.createCollection('users', {

validator: { $jsonSchema: {

bsonType: 'object',

required: [ 'email', 'password', 'rol' ],

additionalProperties: false,

properties: {

name: {

bsonType: 'string',

description: 'El nombre debe ser alfa-numerico de 3 a 50 caracteres',

maxLength: 50,

minLength: 3,

pattern: "^[a-zA-ZñÑáéíóúÁÉÍÚÓ\s]+$"

},

last_name: {

bsonType: 'string',

description: 'El apellido debe ser alfa-numerico de 3 a 50 caracteres',

maxLength: 50,

minLength: 3,

pattern: "^[a-zA-ZñÑáéíóúÁÉÍÚÓ\s ]+$"

},

email: {

bsonType: 'string',

description: 'Email requerido',

maxLength: 50,

minLength: 5,

pattern: "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"

},

password: {

bsonType: 'string',

description: 'password requerido',

maxLength: 10,

minLength: 1,

pattern: "^[\\w]+$"

},

age: {

bsonType: 'number',

minimum: 18,

maximum: 99,

pattern: "^[\d]+$"

},

isSingle: {

bsonType: 'bool',

},

rol: {

enum: [ 'admin', 'customer', 'seller', 'guess' ]

}

}}

});

use("platzi_store");

db.users.insertOne({

'email': 'email@email.com',

'password': 'asd123',

'rol': 'admin'

})

db.users.find();

lo solucioné agregando el _id como propiedad y con bsonType 'ObjectId'

Bryan Carvajal

Hace 3 años

Si despues de haber elevado los permisos no te deja correr la operacion en VSC solo tienes que ir a la extension de mongo en VSC y darle refresh a la DB.

Recursos

Controlar qué datos entran a una colección de MongoDB va más allá de definir campos obligatorios. Existe la posibilidad de bloquear propiedades adicionales para que ningún documento incluya atributos inesperados, y también de actualizar un JSON Schema sin borrar la colección ni sus datos. Estas dos técnicas son fundamentales para mantener la integridad de la información en entornos productivos.

¿Cómo restringir propiedades adicionales en un JSON Schema?

MongoDB, por naturaleza, permite agregar cualquier atributo nuevo a un documento sin necesidad de migraciones. Si insertas un campo como social_accounts que no está definido en el validator, Mongo lo acepta sin problema [01:23]. Esa flexibilidad es una ventaja frente a bases de datos relacionales, donde agregar una columna implica crear toda una migración.

Sin embargo, hay escenarios de negocio donde se necesita que todos los documentos compartan exactamente la misma estructura. Para lograrlo se utiliza la propiedad additionalProperties dentro del JSON Schema [02:18]:

Por defecto su valor es true, lo que permite campos extra.
Al colocarlo en false, MongoDB rechaza cualquier atributo que no esté declarado en properties.
Los campos marcados en required siguen siendo obligatorios y los demás permanecen opcionales, pero ningún campo fuera del schema será aceptado.

Cuando se activa esta restricción e intentas insertar un documento con un campo no definido, Mongo devuelve un error de validación indicando que ese atributo no está permitido [03:08]. Es un comportamiento similar al de una tabla relacional con columnas fijas.

¿Cuándo conviene activar esta restricción?

El consejo práctico es mantener additionalProperties en true salvo que el caso de negocio exija uniformidad estricta. La flexibilidad de MongoDB permite almacenar atributos específicos para ciertos documentos sin afectar al resto, y eso es valioso. Si un usuario necesita un campo particular, simplemente se agrega y, opcionalmente, se incluye en la validación como campo opcional [03:45].

¿Cómo consultar las validaciones existentes en una base de datos?

Antes de modificar un schema conviene saber qué validaciones ya existen. El comando db.getCollectionInfos() devuelve toda la definición de las colecciones, incluyendo su JSON Schema [04:35]. Esto resulta especialmente útil cuando:

No existe documentación sobre los schemas vigentes.
Se hereda una base de datos en producción.
Se necesita auditar la integridad del modelo de datos.

El resultado muestra cada colección con su validator, las expresiones regulares, los tipos de dato y el estado de additionalProperties.

¿Cómo actualizar un JSON Schema sin borrar la colección?

Para modificar la validación de una colección que ya contiene datos se utiliza el comando db.runCommand con la operación collMod [05:30]:

Se indica el nombre de la colección a modificar.
Se envía el validator completo con el JSON Schema actualizado.
MongoDB sobreescribe todo el validador, por lo que es necesario enviar la definición íntegra, no solo el campo que cambia.

javascript db.runCommand({ collMod: "users", validator: { $jsonSchema: { // definición completa del schema actualizado additionalProperties: true } } })

¿Qué permisos se necesitan para ejecutar collMod?

Un usuario con rol de lectura y escritura (readWriteAnyDatabase) no tiene permisos suficientes para ejecutar collMod [06:25]. Es necesario elevar el rol a Atlas Admin desde la sección de seguridad y acceso de la base de datos. Una vez actualizado el rol, el comando se ejecuta correctamente y el schema queda modificado sin perder ningún documento [07:15].

¿Cómo ejecutar solo una parte del script en el Playground?

Un tip útil al trabajar con el MongoDB Playground en Visual Studio Code: si seleccionas únicamente un fragmento de código, solo esa porción se ejecuta [07:30]. Hay que tener cuidado con la posición del cursor, porque si está en medio del archivo, MongoDB interpreta que debe ejecutar todo hasta ese punto.

La validación de datos en MongoDB abarca desde tipos básicos como números, strings y enums, hasta restricciones con valores mínimos, máximos y expresiones regulares. Dominar la administración de estos schemas —consultarlos con getCollectionInfos y actualizarlos con collMod— permite mantener la integridad del modelo sin sacrificar la operación. ¿Has encontrado un caso donde additionalProperties en false te haya resultado útil? Comparte tu experiencia en los comentarios.

db.runCommand({
    collMod: 'users', // coleccion a modificar
    validator: { // propiedad de la coleccion a modificar
        $jsonSchema: {
            bsonType: 'object', // igual
            required: ['email', 'password', 'role'], // igual
            additionalProperties: true, // el cambio
            properties: {...} // igual
        }
    }
})

Resumen

¿Cómo restringir propiedades adicionales en un JSON Schema?

Por defecto su valor es true, lo que permite campos extra.
Al colocarlo en false, MongoDB rechaza cualquier atributo que no esté declarado en properties.
Los campos marcados en required siguen siendo obligatorios y los demás permanecen opcionales, pero ningún campo fuera del schema será aceptado.

¿Cuándo conviene activar esta restricción?

¿Cómo consultar las validaciones existentes en una base de datos?

No existe documentación sobre los schemas vigentes.
Se hereda una base de datos en producción.
Se necesita auditar la integridad del modelo de datos.

El resultado muestra cada colección con su validator, las expresiones regulares, los tipos de dato y el estado de additionalProperties.

¿Cómo actualizar un JSON Schema sin borrar la colección?

Para modificar la validación de una colección que ya contiene datos se utiliza el comando db.runCommand con la operación collMod [05:30]:

Se indica el nombre de la colección a modificar.
Se envía el validator completo con el JSON Schema actualizado.
MongoDB sobreescribe todo el validador, por lo que es necesario enviar la definición íntegra, no solo el campo que cambia.

javascript db.runCommand({ collMod: "users", validator: { $jsonSchema: { // definición completa del schema actualizado additionalProperties: true } } })

¿Qué permisos se necesitan para ejecutar collMod?

¿Cómo ejecutar solo una parte del script en el Playground?

Introducción

Modelado de datos en MongoDB desde cero

Modelado de Datos en MongoDB: Uso de JSON y Diagrama Entidad-Relación

Metodología de modelado de datos en MongoDB

Proyecto

Creación de Clúster y Bases de Datos en Mongo Atlas

Modelado de Workloads en Bases de Datos con MongoDB

Configuración de Entorno y Conexión a MongoDB con VSCode

Validación de datos

Validación de strings con JSON Schema en MongoDB

Validación de números, booleanos y enums en MongoDB

Validar arrays y subdocumentos en MongoDB

Validar contraseñas en MongoDB con regex

Validación de Datos en MongoDB: JSON Schema y Actualizaciones

Relaciones

Relaciones en Bases de Datos NoSQL: Embebidas y Referenciales

Relaciones uno a uno embebidas en MongoDB

Relaciones uno a uno con $lookup en MongoDB

Relaciones Uno a Muchos: Embebidas y Referenciadas en Bases de Datos

Relaciones Uno a Muchos con Referencias en Bases de Datos

Relaciones Muchos a Muchos en Bases de Datos: Tiendas y Productos

Relaciones Muchos a Muchos en Bases de Datos Documentales

Bonus: patrones

Desnormalización en Bases de Datos Documentales: Optimización Avanzada

Computed pattern en MongoDB para totales

Balance entre Simplicidad y Rendimiento en MongoDB

Próximos pasos

Modelado de Datos con MongoDB: Relaciones y Consultas Avanzadas

Validación de Datos en MongoDB: JSON Schema y Actualizaciones

Progreso del curso

Introducción

Proyecto

Validación de datos

Relaciones

Bonus: patrones

Próximos pasos

Recursos

Recursos