docs(ahb.db): Update Documentation How To Update Database #633
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates the README file to reflect the current process of creating the AHB database. It now references the `fundament` python package and the corresponding script for database creation, as well as the private repository containing the XML files.
Provides a comprehensive README for the `ahb.db` database, explaining its purpose, structure, generation process, and maintenance. The documentation clarifies the database's role in the AHB Tabellen application, its dependency on the private `xml-migs-and-ahbs` repository, and the steps required to update the database with new data.
Adds documentation on how to update the AHB database, including its source repository location and why it's private. The README in `src/server/data` now points to the root README for database information, and the detailed database documentation has been moved to the root README.
hf-krechan
changed the title
github-actions
bot
added
the
documentation
hf-fvesely
approved these changes
Aug 1, 2025
hf-kklein
reviewed
Sep 4, 2025
|
|
||
| #### Creation/Update Process | ||
|
|
||
| The database is created using the [fundament](https://github.com/Hochfrequenz/xml-fundamend-python/) Python package, which processes XML files containing AHB specifications. |
There was a problem hiding this comment.
Suggested change
| The database is created using the [fundament](https://github.com/Hochfrequenz/xml-fundamend-python/) Python package, which processes XML files containing AHB specifications. | |
| The database is created using the [fundamend](https://github.com/Hochfrequenz/xml-fundamend-python/) Python package, which processes XML files containing AHB specifications. |
Comment on lines
+193
to
+210
| #### Source Repository | ||
|
|
||
| The database generation script is located in the private repository: | ||
|
|
||
| - **Repository**: [xml-migs-and-ahbs](https://github.com/Hochfrequenz/xml-migs-and-ahbs) | ||
| - **Script**: `load_ahbs_into_sqlitedb.py` | ||
| - **Access**: Private repository - only accessible to Hochfrequenz organization members | ||
|
|
||
| #### Why Private? | ||
|
|
||
| The source XML files must be paid for, so they are not publicly available, which is why the repository is private. | ||
|
|
||
| ### Maintenance | ||
|
|
||
| To update the database with new AHB data: | ||
|
|
||
| 1. Access the private xml-migs-and-ahbs repository | ||
| 2. Run the `load_ahbs_into_sqlitedb.py` script |
There was a problem hiding this comment.
wie vor einigerzeit besprochen: es ist besser (weil reproduzierbarer und weniger individueller setup-aufwand und ohne secret aus 1password rausfummeln), wenn man im xml-migs-and-ahbs repo ein neues release erstellt. die relevante sqlite-db wird dann schon verschlüsselt als release-artefact an das release dran gehängt. vllt an dieser stelle ein link auf ein exemplarisches release oder den release-workflow im privaten XML-repo.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.