summaryrefslogtreecommitdiffstats
path: root/Database.md
diff options
context:
space:
mode:
Diffstat (limited to 'Database.md')
-rw-r--r--Database.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/Database.md b/Database.md
new file mode 100644
index 0000000..3b20dfb
--- /dev/null
+++ b/Database.md
@@ -0,0 +1,37 @@
+# Documentation: Database structure
+
+## Table `page` [`InnoDB`]
+In this table are all created page objects stored and will be removed if the admin deletes them.
+
+* Column `id`: Contains the unique primary ID to identify a page
+* Column `time_insert`: Contains the time stamp (Format: `YYYY-MM-DD HH:II:SS`) when the page was created
+* Column `time_update`: Contains the time stamp (Format: `YYYY-MM-DD HH:II:SS`) when the page was updated
+* Column `user`: Contains the user ID of the user who created this page (`user.id`)
+* Column `slug`: Contains the slug part of the pages absolute URL
+* Column `name`: Contains the name of the page
+* Column `body`: Contains the body of the page in the markdown format
+
+## Table `post` [`MyISAM`]
+In this table are all created post objects stored and will be removed if the admin deletes them.
+The table type is `MyISAM` because the fulltext search doesn't work with `InnoDB` in MySQL < `5.6`.
+
+* Column `id`: Contains the unique primary ID to identify a post
+* Column `time_insert`: Contains the time stamp (Format: `YYYY-MM-DD HH:II:SS`) when the post was created
+* Column `time_update`: Contains the time stamp (Format: `YYYY-MM-DD HH:II:SS`) when the post was updated
+* Column `user`: Contains the user ID of the user who created this post (`user.id`)
+* Column `slug`: Contains the slug part of the posts absolute URL
+* Column `name`: Contains the name of the post
+* Column `body`: Contains the body of the post in the markdown format
+
+## Table `user` [`InnoDB`]
+In this table are all created user objects stored and will be removed if the admin deletes them.
+
+* Column `id`: Contains the unique primary ID to identify a user
+* Column `time_insert`: Contains the time stamp (Format: `YYYY-MM-DD HH:II:SS`) when the user was created
+* Column `time_update`: Contains the time stamp (Format: `YYYY-MM-DD HH:II:SS`) when the user was updated
+* Column `slug`: Contains the slug part of the users absolute URL
+* Column `username`: Contains the username of the user
+* Column `password`: Contains the `bcrypt` hashed password of the user
+* Column `fullname`: Contains the full name of the user
+* Column `mailaddr`: Contains the contact email address of the user
+* Column `body`: Contains the body of the user in the markdown format \ No newline at end of file