Merge pull request #13390 from annando/channel

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

diff --git a/doc/database/db_notification.md b/doc/database/db_notification.md
index f4e524d73c40be1d1e1ab08f903fb7a993d8d953..a2f319ead4d73bf4269c73f72ce51b282b2d645a 100644 (file)
--- a/doc/database/db_notification.md
+++ b/doc/database/db_notification.md
@@ -1,17 +1,47 @@
 Table notification
 ===========
+
 notifications
 
-| Field | Description | Type | Null | Key | Default | Extra |
-| ----- | ----------- | ---- | ---- | --- | ------- | ----- |
-| id | sequential ID | int unsigned | YES | PRI |  | auto_increment |    
-| uid | Owner User id | mediumint unsigned | NO |  |  |  |    
-| vid | Id of the verb table entry that contains the activity verbs | smallint unsigned | NO |  |  |  |    
-| type |  | tinyint unsigned | NO |  |  |  |    
-| actor-id | Link to the contact table with uid=0 of the actor that caused the notification | int unsigned | NO |  |  |  |    
-| target-uri-id | Item-uri id of the related post | int unsigned | NO |  |  |  |    
-| parent-uri-id | Item-uri id of the parent of the related post | int unsigned | NO |  |  |  |    
-| created |  | datetime | NO |  |  |  |    
-| seen |  | boolean | NO |  | 0 |  |    
+Fields
+------
+
+| Field         | Description                                                                    | Type               | Null | Key | Default | Extra          |
+| ------------- | ------------------------------------------------------------------------------ | ------------------ | ---- | --- | ------- | -------------- |
+| id            | sequential ID                                                                  | int unsigned       | NO   | PRI | NULL    | auto_increment |
+| uid           | Owner User id                                                                  | mediumint unsigned | YES  |     | NULL    |                |
+| vid           | Id of the verb table entry that contains the activity verbs                    | smallint unsigned  | YES  |     | NULL    |                |
+| type          |                                                                                | smallint unsigned  | YES  |     | NULL    |                |
+| actor-id      | Link to the contact table with uid=0 of the actor that caused the notification | int unsigned       | YES  |     | NULL    |                |
+| target-uri-id | Item-uri id of the related post                                                | int unsigned       | YES  |     | NULL    |                |
+| parent-uri-id | Item-uri id of the parent of the related post                                  | int unsigned       | YES  |     | NULL    |                |
+| created       |                                                                                | datetime           | YES  |     | NULL    |                |
+| seen          | Seen on the desktop                                                            | boolean            | YES  |     | 0       |                |
+| dismissed     | Dismissed via the API                                                          | boolean            | YES  |     | 0       |                |
+
+Indexes
+------------
+
+| Name                                | Fields                                          |
+| ----------------------------------- | ----------------------------------------------- |
+| PRIMARY                             | id                                              |
+| uid_vid_type_actor-id_target-uri-id | UNIQUE, uid, vid, type, actor-id, target-uri-id |
+| vid                                 | vid                                             |
+| actor-id                            | actor-id                                        |
+| target-uri-id                       | target-uri-id                                   |
+| parent-uri-id                       | parent-uri-id                                   |
+| seen_uid                            | seen, uid                                       |
+| uid_type_parent-uri-id_actor-id     | uid, type, parent-uri-id, actor-id              |
+
+Foreign Keys
+------------
+
+| Field | Target Table | Target Field |
+|-------|--------------|--------------|
+| uid | [user](help/database/db_user) | uid |
+| vid | [verb](help/database/db_verb) | id |
+| actor-id | [contact](help/database/db_contact) | id |
+| target-uri-id | [item-uri](help/database/db_item-uri) | id |
+| parent-uri-id | [item-uri](help/database/db_item-uri) | id |
 
 Return to [database documentation](help/database)