fred.boniface/OwlBoard
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects 1 Releases Wiki Activity

Update 'Database Schema'

Fred Boniface 2022-12-21 20:06:09 +00:00
parent be1c327602
commit d9cf8454c7
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Database-Schema.md Normal file

@ -0,0 +1,14 @@
# Database Schema
OwlBoard uses MongoDB which is a schema-less NoSQL Document store.
Nevertheless, an unenforced schema does apply due to the format information is imported into the database.
**If you are reading this looking to run OwlBoard yourself, the database is setup automatically. See `Deployment` for more information.**
| Collection Name | Data Format Eg. | Desc. |
| -------- | -------- | -------- |
| corpus |{"NLC":993600,"STANOX":"5111","TIPLOC":"POLMONT","3ALPHA":"PMT","UIC":"99360","NLCDESC":"POLMONT","NLCDESC16":"POLMONT"}|Raw data from the Network Rail CORPUS API|
| stations |{"STANOX":"5111","TIPLOC":"POLMONT","3ALPHA":"PMT","NLCDESC16":"POLMONT"}|Filtered data from the Network Rail CORPUS API|
| users | **NOT IMPLEMENTED** | Not yet implemented|