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 relationship diagram to doc #1350

Merged
merged 20 commits into from Nov 24, 2022
Merged

add db relationship diagram to doc #1350

merged 20 commits into from Nov 24, 2022

Conversation

pindge
Copy link
Contributor

@pindge pindge commented Nov 13, 2022

Reason for this pull request

any odc dba needs to explorer the database to workout where the information is stored in the database, as odc API does not cover all the queries.

Proposed changes

  • add database entity relationship diagram to odc doc, concept page

image

  • Tests added / passed
  • Fully documented, including docs/about/whats_new.rst for all changes

📚 Documentation preview 📚: https://datacube-core--1350.org.readthedocs.build/en/1350/

@codecov
Copy link

codecov bot commented Nov 13, 2022

Codecov Report

Base: 92.34% // Head: 92.34% // No change to project coverage 👍

Coverage data is based on head (30a258a) compared to base (54491c4).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1350   +/-   ##
========================================
  Coverage    92.34%   92.34%           
========================================
  Files          127      127           
  Lines        13583    13583           
========================================
  Hits         12543    12543           
  Misses        1040     1040           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@omad omad left a comment

Choose a reason for hiding this comment

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

I love the idea of documenting the database schema, but I don't like that it's all hand written in swagger. (And is missing a couple of columns and relationships)

Here's an auto-generated version of the same diagram using SchemaSpy. It contains both the .dot format which can be used with the Sphinx Graphviz extension. Or probably better, is to use the generated svg directly, and include documentation next to it for updating the diagram if necessary.

@pindge
Copy link
Contributor Author

pindge commented Nov 24, 2022

I love the idea of documenting the database schema, but I don't like that it's all hand written in swagger. (And is missing a couple of columns and relationships)

Here's an auto-generated version of the same diagram using SchemaSpy. It contains both the .dot format which can be used with the Sphinx Graphviz extension. Or probably better, is to use the generated svg directly, and include documentation next to it for updating the diagram if necessary.

Thank you, I have updated the pr

@pindge pindge requested a review from omad November 24, 2022 21:40
Copy link
Member

@omad omad left a comment

Choose a reason for hiding this comment

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

Thanks Pin :)

@omad omad merged commit 1f505d6 into develop Nov 24, 2022
@omad omad deleted the db-relation branch November 24, 2022 22:36
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.

None yet

3 participants