QgisCadastrePlugin-documentation

Ce dépôt permet de stocker une documentation automatique de la base de données créée par le plugin Cadastre pour QGIS. L'outil SchemaSpy est utilisé.

Visualiser la documentation

Vous pouvez consulter la documentation via le lien suivant: https://3liz.github.io/QgisCadastrePlugin-documentation/index.html

Remarque sur les contraintes

Il n'existe actuellement aucune contrainte de clés étrangères sur les tables du schéma cadastre. Nous proposerons à l'avenir un script qui permettra de les créer, lorsque les données le permettent (ce qui n'est pas toujours le cas, comme des voies non référencées dans voie mais référencées dans parcelle).

Générer la documentation via SchemaSpy

Pour créer la documentation, il faut lancer un script en ligne de commande, sous distribution Linux, en passant les paramètres attendus.

Ce script se base sur l'outil SchemaSpy, qu'il faut donc télécharger et mettre dans le répertoire schemaspy, ainsi que sur le driver pour PostgreSQL. Les binaires java peuvent être téléchargés ici:

• SchemaSpy: https://github.com/schemaspy/schemaspy/releases Par exemple schemaspy-6.0.0.jar
• Driver PostgreSQL: https://jdbc.postgresql.org/download.html Par exemple postgresql-42.2.5.jar

Une fois les deux fichiers jar mis dans le répertoire schemaspy, on peut lancer la génération de la documentation:

# Se placer dans le repertoire contenant le script de génération
cd schemaspy/

# Lancer la commande avec les bons paramètres
./generation_documentation_schemaspy.sh -h localhost -p 5432 -d cadastre -u cadastre -s schema_cadastre -o "../docs"

Le mot de passe est demandé, puis la documentation est générée.