TFRS Automated SchemaSpy Deployment

page owner: TFRS-DevOps-Specialist

What is SchemaSpy

SchemaSpy is a tool to explore database schema. It can connect to database and generate html pages and diagrams to reflect the structure of the database.

How SchemaSpy is integrated with TFRS

SchemaSpy is part of TFRS pipeline, once the application is deployed successfully. The SchemaSpy instances will be redeployed to connect to TFRS database and recreate the htmls pages and diagrams in order to show the most up-to-date database structure.

The SchemaSpy URLs for TFRS

Dev

• TFRS DEV public Schema
• TFRS DEV tfrs-audit Schema

Test

• TFRS TEST public Schema
• TFRS TEST tfrs-audit Schema

Prod

• TFRS PROD public Schema
• TFRS PROD tfrs-audit Schema

Database Comments

Django Rest Framework has no way to insert comments into the postgresql database. To overcome this our team built an extension to the DRF.
https://github.com/bcgov/ldf_drf_db_comments
This module is built in support of the Living Documentation Framework