Merge pull request #12288 from annando/api-tags

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

diff --git a/doc/database/db_fcontact.md b/doc/database/db_fcontact.md
index 2801605229587010b598721c0ab951e5c5abc680..095c47aafd467d514c678837ac19fa0d1c31f20a 100644 (file)
--- a/doc/database/db_fcontact.md
+++ b/doc/database/db_fcontact.md
@@ -1,24 +1,51 @@
 Table fcontact
-==============
-
-| Field    | Description   | Type             | Null | Key | Default             | Extra           |
-| -------- | ------------- | ---------------- | ---- | --- | ------------------- | --------------- |
-| id       | sequential ID | int(10) unsigned | NO   | PRI | NULL                | auto_increment  |
-| guid     | unique id     | varchar(64)      | NO   |     |                     |                 |
-| url      |               | varchar(255)     | NO   |     |                     |                 |
-| name     |               | varchar(255)     | NO   |     |                     |                 |
-| photo    |               | varchar(255)     | NO   |     |                     |                 |
-| request  |               | varchar(255)     | NO   |     |                     |                 |
-| nick     |               | varchar(255)     | NO   |     |                     |                 |
-| addr     |               | varchar(255)     | NO   | MUL |                     |                 |
-| batch    |               | varchar(255)     | NO   |     |                     |                 |
-| notify   |               | varchar(255)     | NO   |     |                     |                 |
-| poll     |               | varchar(255)     | NO   |     |                     |                 |
-| confirm  |               | varchar(255)     | NO   |     |                     |                 |
-| priority |               | tinyint(1)       | NO   |     | 0                   |                 |
-| network  |               | varchar(32)      | NO   |     |                     |                 |
-| alias    |               | varchar(255)     | NO   |     |                     |                 |
-| pubkey   |               | text             | NO   |     | NULL                |                 |
-| updated  |               | datetime         | NO   |     | 0000-00-00 00:00:00 |                 |
+===========
+
+Diaspora compatible contacts - used in the Diaspora implementation
+
+Fields
+------
+
+| Field             | Description                                                   | Type             | Null | Key | Default             | Extra          |
+| ----------------- | ------------------------------------------------------------- | ---------------- | ---- | --- | ------------------- | -------------- |
+| id                | sequential ID                                                 | int unsigned     | NO   | PRI | NULL                | auto_increment |
+| guid              | unique id                                                     | varbinary(255)   | NO   |     |                     |                |
+| url               |                                                               | varbinary(383)   | NO   |     |                     |                |
+| uri-id            | Id of the item-uri table entry that contains the fcontact url | int unsigned     | YES  |     | NULL                |                |
+| name              |                                                               | varchar(255)     | NO   |     |                     |                |
+| photo             |                                                               | varbinary(383)   | NO   |     |                     |                |
+| request           |                                                               | varbinary(383)   | NO   |     |                     |                |
+| nick              |                                                               | varchar(255)     | NO   |     |                     |                |
+| addr              |                                                               | varchar(255)     | NO   |     |                     |                |
+| batch             |                                                               | varbinary(383)   | NO   |     |                     |                |
+| notify            |                                                               | varbinary(383)   | NO   |     |                     |                |
+| poll              |                                                               | varbinary(383)   | NO   |     |                     |                |
+| confirm           |                                                               | varbinary(383)   | NO   |     |                     |                |
+| priority          |                                                               | tinyint unsigned | NO   |     | 0                   |                |
+| network           |                                                               | char(4)          | NO   |     |                     |                |
+| alias             |                                                               | varbinary(383)   | NO   |     |                     |                |
+| pubkey            |                                                               | text             | YES  |     | NULL                |                |
+| created           |                                                               | datetime         | NO   |     | 0001-01-01 00:00:00 |                |
+| updated           |                                                               | datetime         | NO   |     | 0001-01-01 00:00:00 |                |
+| interacting_count | Number of contacts this contact interactes with               | int unsigned     | YES  |     | 0                   |                |
+| interacted_count  | Number of contacts that interacted with this contact          | int unsigned     | YES  |     | 0                   |                |
+| post_count        | Number of posts and comments                                  | int unsigned     | YES  |     | 0                   |                |
+
+Indexes
+------------
+
+| Name    | Fields           |
+| ------- | ---------------- |
+| PRIMARY | id               |
+| addr    | addr(32)         |
+| url     | UNIQUE, url(190) |
+| uri-id  | UNIQUE, uri-id   |
+
+Foreign Keys
+------------
+
+| Field | Target Table | Target Field |
+|-------|--------------|--------------|
+| uri-id | [item-uri](help/database/db_item-uri) | id |
 
 Return to [database documentation](help/database)