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

Add Db schema #300

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

IperGiove
Copy link
Contributor

This PR introduces the database schema as a visual diagram and a DBML file.

Changes

  • Added schema.png to src/resources/.data/.
  • Added schema.dbml to src/resources/.data/.
  • Updated README.md to include the database schema image.

@oso-prs
Copy link

oso-prs bot commented May 27, 2024

Validation Results

✅ Good to go as long as status checks pass

commit 98151abd37b6e973e1aa7e76fb9ba73d2e59db85


@ryscheng
Copy link
Member

I really like this idea!
Though I would much prefer that we programmatically generate it, rather than have to try to keep it consistent.

Is there a library that will convert json schema to dbml, which we can add as a build step to the package.json?

@IperGiove
Copy link
Contributor Author

It makes sense to automate the process, but unfortunately, DBML is designed for SQL and doesn't have a JSON parser. I'm not sure if there is a visualizer available that can work with a JSON file

@ryscheng
Copy link
Member

I'm just concerned that anything that's not programmatically generated will get out of date and will be a burden to keep up-to-date.

How about using something like this instead?
https://www.npmjs.com/package/@adobe/jsonschema2md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants