Update database schema description

2020-01-25 22:16:08 +01:00 · 2020-01-25 22:16:08 +01:00 · 1bfbbfde6d
parent 5f7d36f0fa
commit 1bfbbfde6d
2 changed files with 36 additions and 19 deletions
--- a/app/database/muhscheme
+++ b/app/database/muhscheme
@ -1,19 +0,0 @@
-ORDERS
-=======
-OrderID | User | LocatieID | Starttijdstip | Eindtijstip | Comment
-
-Item
-=====
-ItemID | OrderID | User | FoodID
-
-Locaties
-======
-LocatieID | Naam | Adres | Coordinaten(2.0) | Website
-
-LocatieMetaData
-===============
-LocatieID | Key | Value
-
-Food
-=====
-FoodID | LocatieID | Naam | Prijs 
--- a/app/database/muhscheme.txt
+++ b/app/database/muhscheme.txt
@ -0,0 +1,36 @@
+This is just a description of the database schema. It's not generated automatically, nor is it used
+to automatically generate anything.
+
+
+user
+  username
+  is_admin
+  bias
+
+order
+  id
+  location_id       HLDS identifier
+  location_name     this allows historical orders to keep the same location name
+  create_at
+  close_at
+  creator_id
+  courier_id
+
+order_item
+  id
+  order_id
+  item_id           HLDS identifier
+  user_id
+  user_name         for users who are not logged in
+  price             this allows historical orders to keep their correct price
+  product_name
+  commit_hash       Git commit hash to identify HLDS data version
+
+order_item_choice
+  id
+  choice_id         HLDS identifier
+  kind              single_choice/multi_choice
+  order_item
+  name
+  description
+  value             just a textual description of the chosen values