[FLYWAY] export schema documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- databases, documentation
Research direction
The issue names no files, tests, or entry points. Read the existing JavaDoc-style schema documentation and clarify whether the project will use database comments with a Python package or retain JavaDoc formatting. Done means the documentation approach and implementation scope for Sphinx/read-the-docs are agreed.
Written by the indexing model from the issue text.
Description
Current schema uses JavaDoc style comment for tables, view, packages, etc. This works as the tables and view and defined direction and updated in place. With flyway, every change is a change.
Proposed mechanism:
- Comments on Packages and Types remain (Oracle does not support comments on those objects)
- However we move to pydocs
- Table/View/Column information will be pull from the database (so
comment on ... is '...'should be used) - And a "python package" created
With a python library created that maps to the packages, tables, and view, we can more readily pull the docs into the sphinx read-the-docs system.
Alternative:
- Instead of python we can retain the javadoc style formatting and host separately.
However, as PLSQL supports default parameters and Python does as well, this will likely be a cleaner mapping.
- Dominant language
- Visual Basic 6.0
- Stars
- 4
- Forks
- 8
- Avg merge
- 8d 20h
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from HydrologicEngineeringCenter/cwms-database
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
-
enhancement
HydrologicEngineeringCenter/cwms-database#231 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
HydrologicEngineeringCenter/cwms-database#223 · 3 comments · 2 assignees ·
All issues in HydrologicEngineeringCenter/cwms-database
Similar issues
-
bug: AI Gateway client filter lists "Unknown" twice when NULL and literal Unknown clients coexist Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
[BUG] A column whose default is the empty string is drawn in the ER diagram as having no default Openbug database-provider good first issue hacktoberfest
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
libredb/libredb-studio#1030 · 6 comments ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug redshift
Difficulty 2/5 1-3 hours Newbie friendliness 88/100