summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKitzunu <24550914+Kitzunu@users.noreply.github.com>2021-07-06 01:21:09 +0200
committerGitHub <noreply@github.com>2021-07-06 01:21:09 +0200
commit6fe46c4315c716d1c5edec157d9f928543742d80 (patch)
tree8c888d87e77485333927bd4d079a17766ab137d4 /docs
parent01982c495599a03302eba041fcc6089b151b0a6c (diff)
downloadwiki-6fe46c4315c716d1c5edec157d9f928543742d80.tar.gz
wiki-6fe46c4315c716d1c5edec157d9f928543742d80.tar.bz2
wiki-6fe46c4315c716d1c5edec157d9f928543742d80.zip
feat: updates updates_include (#574)
* chore: test * feat: updates updates_include * Revert "chore: test" This reverts commit 4086c6734a939a9967fd192276db6f1a10427919. * why does this always get in there
Diffstat (limited to 'docs')
-rw-r--r--docs/database-auth.md2
-rw-r--r--docs/database-characters.md2
-rw-r--r--docs/database-world.md2
-rw-r--r--docs/updates.md46
-rw-r--r--docs/updates_include.md29
5 files changed, 81 insertions, 0 deletions
diff --git a/docs/database-auth.md b/docs/database-auth.md
index 69c891d..7300aa7 100644
--- a/docs/database-auth.md
+++ b/docs/database-auth.md
@@ -14,5 +14,7 @@ The auth database currently has 14 tables, which mainly store information relate
- [realmcharacters](realmcharacters.md)
- [realmlist](realmlist.md)
- [secret_digest](secret_digest.md)
+- [updates](updates.md)
+- [updates_include](updates_include.md)
- [uptime](uptime.md)
- [version_db_auth](version_db_auth.md)
diff --git a/docs/database-characters.md b/docs/database-characters.md
index 32c985c..d0adc36 100644
--- a/docs/database-characters.md
+++ b/docs/database-characters.md
@@ -92,6 +92,8 @@ NOTE: the DB documentation is still a work in progress. We need your help to mak
- [quest_tracker](quest_tracker.md)
- [recovery_item](recovery_item.md)
- [reserved_name](reserved_name.md)
+- [updates](updates.md)
+- [updates_include](updates_include.md)
- [version_db_characters](version_db_characters.md)
- [warden_action](warden_action.md)
- [worldstates](worldstates.md)
diff --git a/docs/database-world.md b/docs/database-world.md
index 29dd264..eaf3bd4 100644
--- a/docs/database-world.md
+++ b/docs/database-world.md
@@ -165,6 +165,8 @@ The world database has information basically related to creatures, objects, item
- [spell_threat](spell_threat.md)
- [spelldifficulty_dbc](spelldifficulty_dbc.md)
- [transports](transports.md)
+- [updates](updates.md)
+- [updates_include](updates_include.md)
- [vehicle_accessory](vehicle_accessory.md)
- [vehicle_template_accessory](vehicle_template_accessory.md)
- [version](version.md)
diff --git a/docs/updates.md b/docs/updates.md
new file mode 100644
index 0000000..3897e4c
--- /dev/null
+++ b/docs/updates.md
@@ -0,0 +1,46 @@
+# updates
+
+[<-Back-to:Auth](database-auth.md)
+[<-Back-to:Characters](database-characters.md)
+[<-Back-to:World](database-world.md)
+
+**The \`updates\` table**
+
+**Structure**
+
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+| -------------- | ------------ | ------------------------ | --- | ---- | ----------------- | ----- | ----------------------------------------------------- |
+| [name][1] | VARCHAR(200) | | PRI | NO | | | Filename with extension of the update. |
+| [hash][2] | CHAR(40) | | | YES | '' | | SHA1 hash of the sql file. |
+| [state][3] | ENUM | RELEASED,CUSTOM,ARCHIVED | | NO | RELEASED | | Defines if an update is released, custom or archived. |
+| [timestamp][4] | TIMESTAMP) | | | NO | CURRENT_TIMESTAMP | | Timestamp when the query was applied. |
+| [speed][5] | INT | UNSIGNED | | NO | 0 | | Time the query takes to apply in ms. |
+
+[1]: #name
+[2]: #hash
+[3]: #state
+[4]: #timestamp
+[5]: #speed
+
+
+## Description of the fields
+
+### name
+
+The filename of the imported file.
+
+### hash
+
+The SHA1 hash from the imported file.
+
+### state
+
+Defines if the update is released, custom or archived.
+
+### timestamp
+
+The time that the file was imported.
+
+### speed
+
+How long in ms it took to import the file.
diff --git a/docs/updates_include.md b/docs/updates_include.md
new file mode 100644
index 0000000..121b9b7
--- /dev/null
+++ b/docs/updates_include.md
@@ -0,0 +1,29 @@
+# updates_include
+
+[<-Back-to:Auth](database-auth.md)
+[<-Back-to:Characters](database-characters.md)
+[<-Back-to:World](database-world.md)
+
+**The \`updates_include\` table**
+
+**Structure**
+
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+| ---------- | ------------ | ------------------------ | --- | ---- | -------- | ----- | --------------------------------------------------------------- |
+| [path][1] | VARCHAR(200) | | PRI | NO | | | Directory to include. $ means relative to the source directory. |
+| [state][2] | ENUM | RELEASED,CUSTOM,ARCHIVED | | NO | RELEASED | | Defines if the directory contains released or archived updates. |
+
+[1]: #path
+[2]: #state
+
+## Description of the fields
+
+### path
+
+The directory to include in updates.
+
+$ means relative to the source directory.
+
+### state
+
+Defines if the directory has released, custom or archived updates.