Merge remote-tracking branch 'upstream/develop' into api-edit

[friendica.git] / doc / database / db_pconfig.md

diff --git a/doc/database/db_pconfig.md b/doc/database/db_pconfig.md
index a4ed10a359cdf124612dcec730e50a6fc1d0e91c..cf9b0d7810f9a3520be13d4c4d5263870e7ebf7c 100644 (file)
--- a/doc/database/db_pconfig.md
+++ b/doc/database/db_pconfig.md
@@ -1,12 +1,32 @@
-Table pconfic
-=============
-
-| Field | Description | Type       | Null | Key | Default | Extra          |
-|-------|-------------|------------|------|-----|---------|----------------|
-| id    |             | int(11)    | NO   | PRI | NULL    | auto_increment |
-| uid   |             | int(11)    | NO   | MUL | 0       |                |
-| cat   |             | char(255)  | NO   |     |         |                |
-| k     |             | char(255)  | NO   |     |         |                |
-| v     |             | mediumtext | NO   |     | NULL    |                |
+Table pconfig
+===========
+
+personal (per user) configuration storage
+
+Fields
+------
+
+| Field | Description | Type               | Null | Key | Default | Extra          |
+| ----- | ----------- | ------------------ | ---- | --- | ------- | -------------- |
+| id    | Primary key | int unsigned       | NO   | PRI | NULL    | auto_increment |
+| uid   | User id     | mediumint unsigned | NO   |     | 0       |                |
+| cat   | Category    | varchar(50)        | NO   |     |         |                |
+| k     | Key         | varchar(100)       | NO   |     |         |                |
+| v     | Value       | mediumtext         | YES  |     | NULL    |                |
+
+Indexes
+------------
+
+| Name      | Fields              |
+| --------- | ------------------- |
+| PRIMARY   | id                  |
+| uid_cat_k | UNIQUE, uid, cat, k |
+
+Foreign Keys
+------------
+
+| Field | Target Table | Target Field |
+|-------|--------------|--------------|
+| uid | [user](help/database/db_user) | uid |
 
 Return to [database documentation](help/database)