diff options
| -rw-r--r-- | docs/account.md | 120 |
1 files changed, 62 insertions, 58 deletions
diff --git a/docs/account.md b/docs/account.md index e6aaa4f..fe63a54 100644 --- a/docs/account.md +++ b/docs/account.md @@ -2,38 +2,39 @@ [<-Back-to:Auth](database-auth.md) -**The \`account\` table** +**The `account` table** This table holds information on all available accounts. ## Structure -| Field | Type | Attributes | Key | Null | Default | Extra | Comment | -|---------------------|--------------|------------|-----|------|---------------------|----------------|------------| -| [id][1] | int(10) | unsigned | PRI | NO | | Auto increment | Identifier | -| [username][2] | varchar(32) | | UNI | NO | '' | | | -| [sha_pass_hash][3] | varchar(40) | | | NO | '' | | | -| [sessionkey][4] | varchar(80) | | | NO | '' | | | -| [v][5] | varchar(64) | | | NO | '' | | | -| [s][6] | varchar(64) | | | NO | '' | | | -| [token_key][7] | varchar(100) | | | NO | '' | | | -| [email][8] | varchar(255) | | | NO | '' | | | -| [reg_mail][9] | varchar(255) | | | NO | '' | | | -| [joindate][10] | timestamp | signed | | NO | CURRENT_TIMESTAMP | | | -| [last_ip][11] | varchar(15) | | | NO | 127.0.0.1 | | | -| [failed_logins][12] | int(10) | unsigned | | NO | 0 | | | -| [locked][13] | tinyint(3) | unsigned | | NO | 0 | | | -| [last_login][14] | timestamp | signed | | NO | 0000-00-00 00:00:00 | | | -| [totaltime][15] | int(10) | unsigned | | NO | 0 | | | -| [online][16] | tinyint(3) | signed | | NO | 0 | | | -| [expansion][17] | tinyint(3) | unsigned | | NO | 2 | | | -| [mutetime][18] | bigint(20) | signed | | NO | 0 | | | -| [mutereason][19] | varchar(255) | signed | | NO | '' | | | -| [muteby][20] | varchar(50) | signed | | NO | '' | | | -| [locale][21] | tinyint(3) | unsigned | | NO | 0 | | | -| [os][22] | varchar(3) | signed | | NO | '' | | | -| [recruiter][23] | int(10) | unsigned | | NO | 0 | | | - +| Field | Type | Attributes | Key | Null | Default | Extra | Comment | +|-----------------------|--------------|------------|-----|------|-------------------|----------------|------------| +| [id][1] | int(10) | unsigned | PRI | NO | | auto_increment | Identifier | +| [username][2] | varchar(32) | | UNI | NO | | | | +| [sha_pass_hash][3] | varchar(40) | | | NO | | | | +| [sessionkey][4] | varchar(80) | | | NO | | | | +| [v][5] | varchar(64) | | | NO | | | | +| [s][6] | varchar(64) | | | NO | | | | +| [token_key][7] | varchar(100) | | | NO | | | | +| [email][8] | varchar(255) | | | NO | | | | +| [reg_mail][9] | varchar(255) | | | NO | | | | +| [joindate][10] | timestamp | | | NO | CURRENT_TIMESTAMP | | | +| [last_ip][11] | varchar(15) | | | NO | 127.0.0.1 | | | +| [last_attempt_ip][12] | varchar(15) | | | NO | 127.0.0.1 | | | +| [failed_logins][13] | int(10) | unsigned | | NO | 0 | | | +| [locked][14] | tinyint(3) | unsigned | | NO | 0 | | | +| [lock_country][15] | varchar(2) | | | NO | 0 | | | +| [last_login][16] | timestamp | | | YES | NULL | | | +| [online][17] | int(10) | unsigned | | NO | 0 | | | +| [expansion][18] | tinyint(3) | unsigned | | NO | 2 | | | +| [mutetime][19] | bigint(20) | signed | | NO | 0 | | | +| [mutereason][20] | varchar(255) | | | NO | | | | +| [muteby][21] | varchar(50) | | | NO | | | | +| [locale][22] | tinyint(3) | unsigned | | NO | 0 | | | +| [os][23] | varchar(3) | | | NO | | | | +| [recruiter][24] | int(10) | unsigned | | NO | 0 | | | +| [totaltime][25] | int(10) | unsigned | | NO | 0 | | | [1]: #id [2]: #username @@ -46,19 +47,20 @@ This table holds information on all available accounts. [9]: #reg_mail [10]: #joindate [11]: #last_ip -[12]: #failed_logins -[13]: #locked -[14]: #last_login -[15]: #totaltime -[16]: #online -[17]: #expansion -[18]: #mutetime -[19]: #mutereason -[20]: #muteby -[21]: #locale -[22]: #os -[23]: #recruiter - +[12]: #last_attempt_ip +[13]: #failed_logins +[14]: #locked +[15]: #lock_country +[16]: #last_login +[17]: #online +[18]: #expansion +[19]: #mutetime +[20]: #mutereason +[21]: #muteby +[22]: #locale +[23]: #os +[24]: #recruiter +[25]: #totaltime ## Description of the fields @@ -72,7 +74,7 @@ The user's account name. **NOTE**: usernames are limited to 20 characters and have no character restriction. -### sha\_pass\_hash +### sha_pass_hash This field contains the encrypted password. The encryption is SHA1 and is in the following format: username:password. The SQL to create the password (or to compare with the current hash) is: @@ -95,7 +97,7 @@ This field contains the encrypted password. The encryption is SHA1 and is in the If you change the password these fields must be set to 0 allowing the server to regenerate them at login. The .account password command already does it, but you must take care about it on external registration systems (web client) -### **token\_key** +### **token_key** The authenticator key. @@ -109,7 +111,7 @@ Implementation link on Wikipedia for the Google Authenticator API The e-mail address associated with this account. -### reg\_mail +### reg_mail The registration e-mail address associated with this account. @@ -117,19 +119,19 @@ The registration e-mail address associated with this account. The date when the account was created. -### last\_ip +### last_ip The last IP used by the person who logged in the account. -### failed\_logins +### failed_logins The number of failed logins attempted on the account. ### locked -Boolean 0 or 1 controlling if the account has been locked or not. This can be controlled with the ".account lock" GM command. If locked (1), the user can only log in with their [last\_ip](#account-last_ip). If unlocked (0), a user can log in from any IP, and their last\_ip will be updated if it is different. ".Ban account" does not lock it. +Boolean 0 or 1 controlling if the account has been locked or not. This can be controlled with the ".account lock" GM command. If locked (1), the user can only log in with their [last_ip][11]. If unlocked (0), a user can log in from any IP, and their last_ip will be updated if it is different. ".Ban account" does not lock it. -### last\_login +### last_login The date when the account was last logged into. @@ -146,19 +148,21 @@ Boolean 0 or 1 controlling if the account is currently logged in and online. Integer 0, 1 or 2 controlling if the client logged in on the account has any expansions. (for example if client is TBC, but expansion is set to 0, it will not be able to enter outlands and etc.) -- 0 = Classic -- 1 = The Burning Crusade (TBC) -- 2 = Wrath of the Lich King (WotLK) -- 3 = Cataclysm -- 4 = Mist of Pandaria (MOP) -- 5 = Warlords of Draenor (WOD) -- 6 = Legion +| Value | Expansion | +|-------|--------------------------------| +| 0 | Classic | +| 1 | The Burning Crusade (TBC) | +| 2 | Wrath of the Lich King (WotLK) | +| 3 | Cataclysm | +| 4 | Mist of Pandaria (MOP) | +| 5 | Warlords of Draenor (WOD) | +| 6 | Legion | ### mutetime The time, in Unix time, when the account will be unmuted. To see when mute will be expired you can use this query: -``` cpp +```sql SELECT FROM_UNIXTIME(`mutetime`); ``` @@ -178,9 +182,9 @@ The locale used by the client logged into this account. If multiple locale data Stores information about client's OS. Used by Warden system. -- Win -- Mac +- Win +- Mac ### recruiter -The account ID of another account. Used for recuit-a-friend system. See [account.id](account#id) +The account ID of another account. Used for recuit-a-friend system. See [account.id][1] |