Ajouter un validateur à une collection

MongoDB est flexible au niveau du schéma par défaut : tout document peut être inséré, quelle que soit sa structure. Bien que cela soit utile pendant le développement, les bases de données de production ont besoin de garde-fous pour empêcher les données mal formées. La fonctionnalité de validation de schéma de MongoDB vous permet d’associer un ensemble de règles de schéma JSON à une collection afin que seuls les documents correctement structurés puissent être insérés ou mis à jour, en détectant les problèmes de qualité des données au niveau de la base avant qu’ils ne se propagent.

MongoDB utilise la spécification standard du secteur JSON Schema (version 4) pour exprimer les règles de validation. Vous définissez un objet $jsonSchema qui indique quels champs sont obligatoires, quels types ils doivent avoir et quelles contraintes supplémentaires s’appliquent. Le même format est utilisé partout où JSON Schema intervient : dans les spécifications OpenAPI, les bibliothèques de formulaires et désormais les validateurs MongoDB.

Transmettez une option validator lors de l’appel à db.createCollection(). Le validateur contient un document $jsonSchema. L’exemple ci-dessous exige que chaque document users contienne un name (chaîne de caractères) et un email (chaîne de caractères), et autorise facultativement un age (entier).

Utilisez la commande collMod (modification de collection) pour associer ou mettre à jour un validateur sur une collection qui existe déjà et peut déjà contenir des données. Par défaut, cette opération ne valide pas les documents existants : elle s’applique uniquement aux écritures futures, sauf si vous modifiez également validationLevel.

Par défaut, si un document ne respecte pas le validateur, MongoDB rejette l’écriture et génère une erreur : Document failed validation. L’erreur contient un champ details qui explique précisément quelle règle a été enfreinte, ce qui facilite le diagnostic et la correction du document concerné. L’insertion ou la mise à jour est entièrement annulée : aucune écriture partielle n’a lieu.

Pour inspecter le validateur associé à une collection, utilisez db.getCollectionInfos() ou interrogez l’espace de noms system.js. Le document renvoyé contient la spécification complète du validateur sous options.validator, ce qui vous permet de consulter, copier ou comparer les validateurs entre différents environnements.

Pour supprimer toute validation d’une collection, exécutez collMod avec un objet de validation vide. La collection revient ainsi à son état par défaut, sans schéma imposé. Vous pouvez effectuer cette opération temporairement lors d’une migration massive de données ou définitivement lorsque vous abandonnez la validation au profit de contrôles au niveau de l’application.

Mongoose possède sa propre validation de schéma au niveau de l’ODM, qui s’exécute en JavaScript avant l’envoi des données à MongoDB. Toutefois, la validation Mongoose peut être contournée avec insertMany ou des appels directs au pilote. L’ajout d’un validateur JSON Schema au niveau de la base de données constitue un filet de sécurité supplémentaire qu’aucun client ne peut contourner, quel que soit le pilote ou le langage utilisé.

Les validateurs JSON Schema peuvent vérifier les sous-documents intégrés. Utilisez la clé properties pour définir des règles concernant les champs imbriqués, et indiquez que l’objet imbriqué lui-même est de type bsonType: 'object'. Vous pouvez ainsi valider chaque niveau d’un document hiérarchique.

Pour vérifier qu’un champ de type tableau contient uniquement des documents présentant une structure donnée, utilisez items dans la définition de la propriété. Chaque élément du tableau sera validé par rapport au schéma items. Cette approche est utile pour imposer la structure des lignes intégrées, des balises ou des tableaux d’adresses.

MongoDB Atlas fournit une interface graphique permettant de créer et de modifier les validateurs de collections sans écrire de JSON brut. Dans l’onglet Schema de la collection, vous pouvez ajouter des propriétés, définir des types et marquer des champs comme obligatoires à l’aide d’un formulaire. Atlas affiche également un score de validation — le pourcentage de documents existants qui respectent le schéma actuel — afin de vous aider à mesurer la qualité des données avant d’activer une validation stricte.

Dans cette leçon, vous avez appris que les validateurs JSON Schema sont associés via createCollection ou collMod, que les échecs de validation rejettent l’écriture et renvoient une erreur détaillée, et que les objets imbriqués et les tableaux peuvent également être validés dans le même document de schéma. Nous allons maintenant explorer en détail les contraintes type, required et enum.