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

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

diff --git a/doc/database/db_group.md b/doc/database/db_group.md
index 11e6d667c75616f5632e22c946cfe68839e982e4..ad7fa4a3dde4dab728affad6c133a15b9c587c79 100644 (file)
--- a/doc/database/db_group.md
+++ b/doc/database/db_group.md
@@ -1,13 +1,35 @@
 Table group
 ===========
+
 privacy groups, group info
 
-| Field | Description | Type | Null | Key | Default | Extra |
-| ----- | ----------- | ---- | ---- | --- | ------- | ----- |
-| id      | sequential ID                              | int unsigned       | NO | PRI | NULL | auto_increment |    
-| uid     | Owner User id                              | mediumint unsigned | NO |     | 0    |                |    
-| visible | 1 indicates the member list is not private | boolean            | NO |     | 0    |                |    
-| deleted | 1 indicates the group has been deleted     | boolean            | NO |     | 0    |                |    
-| name    | human readable name of group               | varchar(255)       | NO |     |      |                |    
+Fields
+------
+
+| Field   | Description                                                                               | Type               | Null | Key | Default | Extra          |
+| ------- | ----------------------------------------------------------------------------------------- | ------------------ | ---- | --- | ------- | -------------- |
+| id      | sequential ID                                                                             | int unsigned       | NO   | PRI | NULL    | auto_increment |
+| uid     | Owner User id                                                                             | mediumint unsigned | NO   |     | 0       |                |
+| visible | 1 indicates the member list is not private                                                | boolean            | NO   |     | 0       |                |
+| deleted | 1 indicates the group has been deleted                                                    | boolean            | NO   |     | 0       |                |
+| cid     | Contact id of forum. When this field is filled then the members are synced automatically. | int unsigned       | YES  |     | NULL    |                |
+| name    | human readable name of group                                                              | varchar(255)       | NO   |     |         |                |
+
+Indexes
+------------
+
+| Name    | Fields |
+| ------- | ------ |
+| PRIMARY | id     |
+| uid     | uid    |
+| cid     | cid    |
+
+Foreign Keys
+------------
+
+| Field | Target Table | Target Field |
+|-------|--------------|--------------|
+| uid | [user](help/database/db_user) | uid |
+| cid | [contact](help/database/db_contact) | id |
 
 Return to [database documentation](help/database)