From d9cf8454c70d754fa837f071aee3f1bb97f8f0d5 Mon Sep 17 00:00:00 2001 From: Fred Boniface Date: Wed, 21 Dec 2022 20:06:09 +0000 Subject: [PATCH] Update 'Database Schema' --- Database-Schema.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 Database-Schema.md diff --git a/Database-Schema.md b/Database-Schema.md new file mode 100644 index 0000000..cffad84 --- /dev/null +++ b/Database-Schema.md @@ -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| +