keith/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
friendica/doc/database/db_contact.md

138 lines
21 KiB
Markdown
Raw Normal View History

docu - add schema of each db table
2015-12-28 01:50:25 +00:00
Table contact
Updates database structure documentation
2021-06-13 20:33:50 +00:00
===========
Trailing whitespace removed
2021-06-14 06:10:11 +00:00
Updates database structure documentation
2021-06-13 20:33:50 +00:00
contact table
docu - add schema of each db table
2015-12-28 01:50:25 +00:00
Indexes and foreign keys added
2021-06-14 08:53:37 +00:00
Fields
------
Rearranged fields
2021-09-13 08:22:11 +00:00
| 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 | |
| created | | datetime | NO | | 0001-01-01 00:00:00 | |
| updated | Date of last contact update | datetime | YES | | 0001-01-01 00:00:00 | |
| network | Network of the contact | char(4) | NO | | | |
| name | Name that this contact is known by | varchar(255) | NO | | | |
| nick | Nick- and user name of the contact | varchar(255) | NO | | | |
| location | | varchar(255) | YES | | | |
| about | | text | YES | | NULL | |
| keywords | public keywords (interests) of the contact | text | YES | | NULL | |
| xmpp | XMPP address | varchar(255) | NO | | | |
| matrix | Matrix address | varchar(255) | NO | | | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| avatar | | varbinary(383) | NO | | | |
Add more BlurHash to avoid not being able to display some picture
2022-12-11 09:56:30 +00:00
| blurhash | BlurHash representation of the avatar | varbinary(255) | YES | | NULL | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| header | Header picture | varbinary(383) | YES | | NULL | |
| url | | varbinary(383) | NO | | | |
| nurl | | varbinary(383) | NO | | | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| uri-id | Id of the item-uri table entry that contains the contact url | int unsigned | YES | | NULL | |
| addr | | varchar(255) | NO | | | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| alias | | varbinary(383) | NO | | | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| pubkey | RSA public key 4096 bit | text | YES | | NULL | |
| prvkey | RSA private key 4096 bit | text | YES | | NULL | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| batch | | varbinary(383) | NO | | | |
| notify | | varbinary(383) | YES | | NULL | |
| poll | | varbinary(383) | YES | | NULL | |
| subscribe | | varbinary(383) | YES | | NULL | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| last-update | Date of the last try to update the contact info | datetime | NO | | 0001-01-01 00:00:00 | |
Improved performance when updating contacts
2022-08-13 09:01:48 +00:00
| next-update | Next connection request | datetime | YES | | NULL | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| success_update | Date of the last successful contact update | datetime | NO | | 0001-01-01 00:00:00 | |
| failure_update | Date of the last failed update | datetime | NO | | 0001-01-01 00:00:00 | |
| failed | Connection failed | boolean | YES | | NULL | |
| term-date | | datetime | NO | | 0001-01-01 00:00:00 | |
| last-item | date of the last post | datetime | NO | | 0001-01-01 00:00:00 | |
| last-discovery | date of the last follower discovery | datetime | NO | | 0001-01-01 00:00:00 | |
Improved performance when updating contacts
2022-08-13 09:01:48 +00:00
| local-data | Is true when there are posts with this contact on the system | boolean | YES | | NULL | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| blocked | Node-wide block status | boolean | NO | | 1 | |
| block_reason | Node-wide block reason | text | YES | | NULL | |
| readonly | posts of the contact are readonly | boolean | NO | | 0 | |
| contact-type | Person, organisation, news, community, relay | tinyint | NO | | 0 | |
| manually-approve | Contact requests have to be approved manually | boolean | YES | | NULL | |
| archive | | boolean | NO | | 0 | |
| unsearchable | Contact prefers to not be searchable | boolean | NO | | 0 | |
| sensitive | Contact posts sensitive content | boolean | NO | | 0 | |
[Database 1529] Add author baseurl to post-user-view - Explicit the contact.baseurl and contact.gsid caveat
2023-08-24 11:48:35 +00:00
| baseurl | baseurl of the contact from the gserver record, can be missing | varbinary(383) | YES | | | |
| gsid | Global Server ID, can be missing | int unsigned | YES | | NULL | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| bd | | date | NO | | 0001-01-01 | |
| reason | | text | YES | | NULL | |
| self | 1 if the contact is the user him/her self | boolean | NO | | 0 | |
| remote_self | | boolean | NO | | 0 | |
| rel | The kind of the relation between the user and the contact | tinyint unsigned | NO | | 0 | |
| protocol | Protocol of the contact | char(4) | NO | | | |
| subhub | | boolean | NO | | 0 | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| hub-verify | | varbinary(383) | NO | | | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| rating | Automatically detected feed poll frequency | tinyint | NO | | 0 | |
| priority | Feed poll priority | tinyint unsigned | NO | | 0 | |
| attag | | varchar(255) | NO | | | |
| hidden | | boolean | NO | | 0 | |
| pending | Contact request is pending | boolean | NO | | 1 | |
| deleted | Contact has been deleted | boolean | NO | | 0 | |
| info | | mediumtext | YES | | NULL | |
| notify_new_posts | | boolean | NO | | 0 | |
| fetch_further_information | | tinyint unsigned | NO | | 0 | |
| ffi_keyword_denylist | | text | YES | | NULL | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| photo | Link to the profile photo of the contact | varbinary(383) | YES | | | |
| thumb | Link to the profile photo (thumb size) | varbinary(383) | YES | | | |
| micro | Link to the profile photo (micro size) | varbinary(383) | YES | | | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| name-date | | datetime | NO | | 0001-01-01 00:00:00 | |
| uri-date | | datetime | NO | | 0001-01-01 00:00:00 | |
| avatar-date | | datetime | NO | | 0001-01-01 00:00:00 | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| request | | varbinary(383) | YES | | NULL | |
| confirm | | varbinary(383) | YES | | NULL | |
| poco | | varbinary(383) | YES | | NULL | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| writable | | boolean | NO | | 0 | |
Replace "forum" by "group" in database comments
2023-05-30 13:13:48 +00:00
| forum | contact is a group. Deprecated, use 'contact-type' = 'community' and 'manually-approve' = false instead | boolean | NO | | 0 | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| prv | contact is a private group. Deprecated, use 'contact-type' = 'community' and 'manually-approve' = true instead | boolean | NO | | 0 | |
| bdyear | | varchar(4) | NO | | | |
| site-pubkey | Deprecated | text | YES | | NULL | |
| gender | Deprecated | varchar(32) | NO | | | |
| duplex | Deprecated | boolean | NO | | 0 | |
All URL fields are now binary and longer
2022-09-04 07:54:01 +00:00
| issued-id | Deprecated | varbinary(383) | NO | | | |
| dfrn-id | Deprecated | varbinary(383) | NO | | | |
Rearranged fields
2021-09-13 08:22:11 +00:00
| aes_allow | Deprecated | boolean | NO | | 0 | |
| ret-aes | Deprecated | boolean | NO | | 0 | |
| usehub | Deprecated | boolean | NO | | 0 | |
| closeness | Deprecated | tinyint unsigned | NO | | 99 | |
| profile-id | Deprecated | int unsigned | YES | | NULL | |
docu - add schema of each db table
2015-12-28 01:50:25 +00:00
Indexes and foreign keys added
2021-06-14 08:53:37 +00:00
Indexes
------------
Formatted index list
2021-06-14 12:15:10 +00:00
| Name | Fields |
| --------------------------- | ------------------------------------ |
| PRIMARY | id |
| uid_name | uid, name(190) |
| self_uid | self, uid |
| alias_uid | alias(128), uid |
| pending_uid | pending, uid |
| blocked_uid | blocked, uid |
| uid_rel_network_poll | uid, rel, network, poll(64), archive |
| uid_network_batch | uid, network, batch(64) |
| batch_contact-type | batch(64), contact-type |
| addr_uid | addr(128), uid |
| nurl_uid | nurl(128), uid |
| nick_uid | nick(128), uid |
| attag_uid | attag(96), uid |
| network_uid_lastupdate | network, uid, last-update |
| uid_network_self_lastupdate | uid, network, self, last-update |
Improved performance when updating contacts
2022-08-13 09:01:48 +00:00
| next-update | next-update |
| local-data-next-update | local-data, next-update |
Formatted index list
2021-06-14 12:15:10 +00:00
| uid_lastitem | uid, last-item |
| baseurl | baseurl(64) |
| uid_contact-type | uid, contact-type |
| uid_self_contact-type | uid, self, contact-type |
| self_network_uid | self, network, uid |
Several performance improvements
2022-08-15 13:23:01 +00:00
| gsid_uid_failed | gsid, uid, failed |
we now have got an uri-id field for the contact table
2021-07-08 18:59:58 +00:00
| uri-id | uri-id |
Indexes and foreign keys added
2021-06-14 08:53:37 +00:00
Foreign Keys
------------
| Field | Target Table | Target Field |
|-------|--------------|--------------|
| uid | [user](help/database/db_user) | uid |
we now have got an uri-id field for the contact table
2021-07-08 18:59:58 +00:00
| uri-id | [item-uri](help/database/db_item-uri) | id |
Indexes and foreign keys added
2021-06-14 08:53:37 +00:00
| gsid | [gserver](help/database/db_gserver) | id |
docu - add schema of each db table
2015-12-28 01:50:25 +00:00
Return to [database documentation](help/database)
Reference in a new issue Copy permalink