Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: update sql schema autogen tool #331

Merged
merged 12 commits into from
Oct 16, 2024

Conversation

neil-iohk
Copy link
Contributor

@neil-iohk neil-iohk commented Oct 14, 2024

Description

Replacement of dbviz, schema generation tool with SchemaSpy. Removal of old references to dbviz in the postgres earthly target and Catalyst-CI Postgres Example

Output Link For Docs:
https://input-output-hk.github.io/catalyst-ci/branch/chore_update_sql_schema_autogen_tool/appendix/examples/

Related Issue(s)

#315

Description of Changes

  • Modified the SQL schema autogen tool to removing existing dbviz tool and replacing with SchemaSpy for automated schema generation.
  • Improved documentation around tooling,removing references no longer relevant to SchemaSpy autogen tool.
  • Added markdown template and custom script to ensure the auto-generated SchemaSpy UI displays correctly and fills the screen removing double scroll bars in the view.
  • Added Java Eartly stage to use as a base from which to copy necessary files during document build stage and improve caching.
  • Refactored how Java dependencies are downloaded and cached. Added a base image openjdk:21-jdk-slim to avoid network calls like apt-get running on every build. This caches the Java installation and other dependencies to avoid unnecessary network calls during a build.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

…aSpy, remove dependencies in catalyst-ci postgresql base
…aSpy, remove dependencies in catalyst-ci postgresql base
…ched to avoid apt install executing every run (reduced network calls)
…ched to avoid apt install executing every run (reduced network calls)
…ngs required on md file as it is just a container for SchemaSpy
@neil-iohk neil-iohk changed the title Chore/update sql schema autogen tool refactor/update sql schema autogen tool Oct 14, 2024
@neil-iohk neil-iohk changed the title refactor/update sql schema autogen tool refactor: update sql schema autogen tool Oct 14, 2024
@neil-iohk neil-iohk added the review me PR is ready for review label Oct 14, 2024
earthly/postgresql/Earthfile Show resolved Hide resolved
earthly/postgresql/Earthfile Show resolved Hide resolved
…n PR feedback. Removed seperate layers for package installs
earthly/postgresql/Earthfile Outdated Show resolved Hide resolved
@stevenj
Copy link
Collaborator

stevenj commented Oct 16, 2024

Also, because its no longer used, we can totally remove the dbviz tooling from this repo. Add that to this PR.

… longer required and has been replaced with SchemaSpy for database schema visualizations diagram generation
stevenj
stevenj previously approved these changes Oct 16, 2024
Copy link
Collaborator

@stevenj stevenj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevenj stevenj merged commit 6f05e44 into master Oct 16, 2024
65 checks passed
@stevenj stevenj deleted the chore/update-sql-schema-autogen-tool branch October 16, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review me PR is ready for review
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants