Documenter une base de données avec SchemaSpy

Lors de mes missions de consulting, il m’arrive souvent d’obtenir de la part des équipes techniques des exports de bases de données et une liste de fichiers plats mais souvent (toujours ?) aucune documentation digne de ce nom concernant ces données.

Le turnover, le manque d’expertise ou de temps des équipes que je rencontre fait que je me retrouve souvent à devoir “documenter” les données que je récupère avant même d’en commencer l’analyse.

Aujourd’hui, je vais donc vous parler de SchemaSpy : une application Java qui me sert à construire une documentation au format HTML pour commencer à explorer et documenter les différentes entités et relations entre entités du système d’information de mes clients.

SchemaSpy : logiciel qui profite également d’une très bonne documentation

Pour fonctionner, vous aurez besoin de Java 8 sur votre poste de travail et accessible dans votre invite de commandes. Ensuite, tout dépend du type de base de données avec laquelle vous travaillez mais il faudra télécharger le connecteur pour chacune de ces bases :

• Pour MySQL, il faut télécharger le connecteur correspondant à la version de MySQL et à votre système d’exploitation ;
• Pour PostgreSQL, il faut télécharger le connecteur correspondant à la version de PostgreSQL ;