Ruderverein-Donau-Linz/rowt
1
1
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects Wiki Activity

docs #756

Merged
philipp merged 9 commits from docs into staging 2024-10-08 10:10:40 +02:00
Conversation 0 Commits 9 Files Changed 19 +7 -7
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 318fe13666 - Show all commits

14
doc/db/README.md
View File

@ -3,14 +3,14 @@
Since the database stabilized quite well over the last months/years, hopefully it will not change that much in the future. Since the database stabilized quite well over the last months/years, hopefully it will not change that much in the future.
Thus, here is the current (October '24) model and the reasoning behind it: Thus, here is the current (October '24) model and the reasoning behind it:
- **User** ## User
![](./user.svg) ![](./user.svg)
- All user-relevant fields are stored in `User`. - All user-relevant fields are stored in `User`.
- `Role` (and its associative table `UserRole`) map current roles the user has. This is used for e.g. permissions (`Vorstand`, `Admin`, `cox`, ... roles) and fee calculation (`Donau Linz`, `scheckbuch`, `Rennjugend`). - `Role` (and its associative table `UserRole`) map current roles the user has. This is used for e.g. permissions (`Vorstand`, `Admin`, `cox`, ... roles) and fee calculation (`Donau Linz`, `scheckbuch`, `Rennjugend`).
- `Family` specifies, well, a family. Currently only used for fee calculation. - `Family` specifies, well, a family. Currently only used for fee calculation.
- **Planned rowing adventures :-)** ## Planned rowing adventures :-)
![](./planned.svg) ![](./planned.svg)
There are 2 main types: There are 2 main types:
@ -25,7 +25,7 @@ This table expects either...
- a `user_id`, if a person who has an account registers to the trip/event - a `user_id`, if a person who has an account registers to the trip/event
- a `user_note`, if the cox of a trip, or a `manage_events` user of an event wants to add a guest which has no account - a `user_note`, if the cox of a trip, or a `manage_events` user of an event wants to add a guest which has no account
- **Logbook** ## Logbook
![](./logbook.svg) ![](./logbook.svg)
If `arrival` is NULL, the boat is assumed to still be on the water. If `arrival` is NULL, the boat is assumed to still be on the water.
@ -36,13 +36,13 @@ There are a few `LogbookType`s:
If the number of users entered is less than the boat's maximum capacity, the remaining spaces will be automatically assigned to guests. If the number of users entered is less than the boat's maximum capacity, the remaining spaces will be automatically assigned to guests.
- **Boat** ## Boat
![](./boat.svg) ![](./boat.svg)
- **Trailer** ## Trailer
![](./trailer.svg) ![](./trailer.svg)
- **Fetching** ## Fetching
![](./fetching.svg) ![](./fetching.svg)
This tables are used to automatically fetch data (every hour). Currently we have: This tables are used to automatically fetch data (every hour). Currently we have:
@ -50,7 +50,7 @@ This tables are used to automatically fetch data (every hour). Currently we have
- `Waterlevel` which fetches the current waterlevel in Linz from hydro (with their explicit permission :-)) - `Waterlevel` which fetches the current waterlevel in Linz from hydro (with their explicit permission :-))
- `Weather` weather data from *Open Weather* - `Weather` weather data from *Open Weather*
- **Misc** ## Misc
![](./misc.svg) ![](./misc.svg)
- **Log:** Logs "interesting" activities, to be viewed in the web ui - **Log:** Logs "interesting" activities, to be viewed in the web ui