doc/database/db_contact.md

   1 Table contact
   2 ===========
   3
   4 contact table
   5
   6 Fields
   7 ------
   8
   9 | Field                     | Description                                                                                                    | Type               | Null | Key | Default             | Extra          |
  10 | ------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------ | ---- | --- | ------------------- | -------------- |
  11 | id                        | sequential ID                                                                                                  | int unsigned       | NO   | PRI | NULL                | auto_increment |
  12 | uid                       | Owner User id                                                                                                  | mediumint unsigned | NO   |     | 0                   |                |
  13 | created                   |                                                                                                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  14 | updated                   | Date of last contact update                                                                                    | datetime           | YES  |     | 0001-01-01 00:00:00 |                |
  15 | network                   | Network of the contact                                                                                         | char(4)            | NO   |     |                     |                |
  16 | name                      | Name that this contact is known by                                                                             | varchar(255)       | NO   |     |                     |                |
  17 | nick                      | Nick- and user name of the contact                                                                             | varchar(255)       | NO   |     |                     |                |
  18 | location                  |                                                                                                                | varchar(255)       | YES  |     |                     |                |
  19 | about                     |                                                                                                                | text               | YES  |     | NULL                |                |
  20 | keywords                  | public keywords (interests) of the contact                                                                     | text               | YES  |     | NULL                |                |
  21 | xmpp                      | XMPP address                                                                                                   | varchar(255)       | NO   |     |                     |                |
  22 | matrix                    | Matrix address                                                                                                 | varchar(255)       | NO   |     |                     |                |
  23 | avatar                    |                                                                                                                | varbinary(383)     | NO   |     |                     |                |
  24 | blurhash                  | BlurHash representation of the avatar                                                                          | varbinary(255)     | YES  |     | NULL                |                |
  25 | header                    | Header picture                                                                                                 | varbinary(383)     | YES  |     | NULL                |                |
  26 | url                       |                                                                                                                | varbinary(383)     | NO   |     |                     |                |
  27 | nurl                      |                                                                                                                | varbinary(383)     | NO   |     |                     |                |
  28 | uri-id                    | Id of the item-uri table entry that contains the contact url                                                   | int unsigned       | YES  |     | NULL                |                |
  29 | addr                      |                                                                                                                | varchar(255)       | NO   |     |                     |                |
  30 | alias                     |                                                                                                                | varbinary(383)     | NO   |     |                     |                |
  31 | pubkey                    | RSA public key 4096 bit                                                                                        | text               | YES  |     | NULL                |                |
  32 | prvkey                    | RSA private key 4096 bit                                                                                       | text               | YES  |     | NULL                |                |
  33 | batch                     |                                                                                                                | varbinary(383)     | NO   |     |                     |                |
  34 | notify                    |                                                                                                                | varbinary(383)     | YES  |     | NULL                |                |
  35 | poll                      |                                                                                                                | varbinary(383)     | YES  |     | NULL                |                |
  36 | subscribe                 |                                                                                                                | varbinary(383)     | YES  |     | NULL                |                |
  37 | last-update               | Date of the last try to update the contact info                                                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  38 | next-update               | Next connection request                                                                                        | datetime           | YES  |     | NULL                |                |
  39 | success_update            | Date of the last successful contact update                                                                     | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  40 | failure_update            | Date of the last failed update                                                                                 | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  41 | failed                    | Connection failed                                                                                              | boolean            | YES  |     | NULL                |                |
  42 | term-date                 |                                                                                                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  43 | last-item                 | date of the last post                                                                                          | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  44 | last-discovery            | date of the last follower discovery                                                                            | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  45 | local-data                | Is true when there are posts with this contact on the system                                                   | boolean            | YES  |     | NULL                |                |
  46 | blocked                   | Node-wide block status                                                                                         | boolean            | NO   |     | 1                   |                |
  47 | block_reason              | Node-wide block reason                                                                                         | text               | YES  |     | NULL                |                |
  48 | readonly                  | posts of the contact are readonly                                                                              | boolean            | NO   |     | 0                   |                |
  49 | contact-type              | Person, organisation, news, community, relay                                                                   | tinyint            | NO   |     | 0                   |                |
  50 | manually-approve          | Contact requests have to be approved manually                                                                  | boolean            | YES  |     | NULL                |                |
  51 | archive                   |                                                                                                                | boolean            | NO   |     | 0                   |                |
  52 | unsearchable              | Contact prefers to not be searchable                                                                           | boolean            | NO   |     | 0                   |                |
  53 | sensitive                 | Contact posts sensitive content                                                                                | boolean            | NO   |     | 0                   |                |
  54 | baseurl                   | baseurl of the contact from the gserver record, can be missing                                                 | varbinary(383)     | YES  |     |                     |                |
  55 | gsid                      | Global Server ID, can be missing                                                                               | int unsigned       | YES  |     | NULL                |                |
  56 | bd                        |                                                                                                                | date               | NO   |     | 0001-01-01          |                |
  57 | reason                    |                                                                                                                | text               | YES  |     | NULL                |                |
  58 | self                      | 1 if the contact is the user him/her self                                                                      | boolean            | NO   |     | 0                   |                |
  59 | remote_self               |                                                                                                                | boolean            | NO   |     | 0                   |                |
  60 | rel                       | The kind of the relation between the user and the contact                                                      | tinyint unsigned   | NO   |     | 0                   |                |
  61 | protocol                  | Protocol of the contact                                                                                        | char(4)            | NO   |     |                     |                |
  62 | subhub                    |                                                                                                                | boolean            | NO   |     | 0                   |                |
  63 | hub-verify                |                                                                                                                | varbinary(383)     | NO   |     |                     |                |
  64 | rating                    | Automatically detected feed poll frequency                                                                     | tinyint            | NO   |     | 0                   |                |
  65 | priority                  | Feed poll priority                                                                                             | tinyint unsigned   | NO   |     | 0                   |                |
  66 | attag                     |                                                                                                                | varchar(255)       | NO   |     |                     |                |
  67 | hidden                    |                                                                                                                | boolean            | NO   |     | 0                   |                |
  68 | pending                   | Contact request is pending                                                                                     | boolean            | NO   |     | 1                   |                |
  69 | deleted                   | Contact has been deleted                                                                                       | boolean            | NO   |     | 0                   |                |
  70 | info                      |                                                                                                                | mediumtext         | YES  |     | NULL                |                |
  71 | notify_new_posts          |                                                                                                                | boolean            | NO   |     | 0                   |                |
  72 | fetch_further_information |                                                                                                                | tinyint unsigned   | NO   |     | 0                   |                |
  73 | ffi_keyword_denylist      |                                                                                                                | text               | YES  |     | NULL                |                |
  74 | photo                     | Link to the profile photo of the contact                                                                       | varbinary(383)     | YES  |     |                     |                |
  75 | thumb                     | Link to the profile photo (thumb size)                                                                         | varbinary(383)     | YES  |     |                     |                |
  76 | micro                     | Link to the profile photo (micro size)                                                                         | varbinary(383)     | YES  |     |                     |                |
  77 | name-date                 |                                                                                                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  78 | uri-date                  |                                                                                                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  79 | avatar-date               |                                                                                                                | datetime           | NO   |     | 0001-01-01 00:00:00 |                |
  80 | request                   |                                                                                                                | varbinary(383)     | YES  |     | NULL                |                |
  81 | confirm                   |                                                                                                                | varbinary(383)     | YES  |     | NULL                |                |
  82 | poco                      |                                                                                                                | varbinary(383)     | YES  |     | NULL                |                |
  83 | writable                  |                                                                                                                | boolean            | NO   |     | 0                   |                |
  84 | forum                     | contact is a group. Deprecated, use 'contact-type' = 'community' and 'manually-approve' = false instead        | boolean            | NO   |     | 0                   |                |
  85 | prv                       | contact is a private group. Deprecated, use 'contact-type' = 'community' and 'manually-approve' = true instead | boolean            | NO   |     | 0                   |                |
  86 | bdyear                    |                                                                                                                | varchar(4)         | NO   |     |                     |                |
  87 | site-pubkey               | Deprecated                                                                                                     | text               | YES  |     | NULL                |                |
  88 | gender                    | Deprecated                                                                                                     | varchar(32)        | NO   |     |                     |                |
  89 | duplex                    | Deprecated                                                                                                     | boolean            | NO   |     | 0                   |                |
  90 | issued-id                 | Deprecated                                                                                                     | varbinary(383)     | NO   |     |                     |                |
  91 | dfrn-id                   | Deprecated                                                                                                     | varbinary(383)     | NO   |     |                     |                |
  92 | aes_allow                 | Deprecated                                                                                                     | boolean            | NO   |     | 0                   |                |
  93 | ret-aes                   | Deprecated                                                                                                     | boolean            | NO   |     | 0                   |                |
  94 | usehub                    | Deprecated                                                                                                     | boolean            | NO   |     | 0                   |                |
  95 | closeness                 | Deprecated                                                                                                     | tinyint unsigned   | NO   |     | 99                  |                |
  96 | profile-id                | Deprecated                                                                                                     | int unsigned       | YES  |     | NULL                |                |
  97
  98 Indexes
  99 ------------
 100
 101 | Name                        | Fields                               |
 102 | --------------------------- | ------------------------------------ |
 103 | PRIMARY                     | id                                   |
 104 | uid_name                    | uid, name(190)                       |
 105 | self_uid                    | self, uid                            |
 106 | alias_uid                   | alias(128), uid                      |
 107 | pending_uid                 | pending, uid                         |
 108 | blocked_uid                 | blocked, uid                         |
 109 | uid_rel_network_poll        | uid, rel, network, poll(64), archive |
 110 | uid_network_batch           | uid, network, batch(64)              |
 111 | batch_contact-type          | batch(64), contact-type              |
 112 | addr_uid                    | addr(128), uid                       |
 113 | nurl_uid                    | nurl(128), uid                       |
 114 | nick_uid                    | nick(128), uid                       |
 115 | attag_uid                   | attag(96), uid                       |
 116 | network_uid_lastupdate      | network, uid, last-update            |
 117 | uid_network_self_lastupdate | uid, network, self, last-update      |
 118 | next-update                 | next-update                          |
 119 | local-data-next-update      | local-data, next-update              |
 120 | uid_lastitem                | uid, last-item                       |
 121 | baseurl                     | baseurl(64)                          |
 122 | uid_contact-type            | uid, contact-type                    |
 123 | uid_self_contact-type       | uid, self, contact-type              |
 124 | self_network_uid            | self, network, uid                   |
 125 | gsid_uid_failed             | gsid, uid, failed                    |
 126 | uri-id                      | uri-id                               |
 127
 128 Foreign Keys
 129 ------------
 130
 131 | Field | Target Table | Target Field |
 132 |-------|--------------|--------------|
 133 | uid | [user](help/database/db_user) | uid |
 134 | uri-id | [item-uri](help/database/db_item-uri) | id |
 135 | gsid | [gserver](help/database/db_gserver) | id |
 136
 137 Return to [database documentation](help/database)