Merge pull request #12407 from HankG/friendica-api-photo-endpoint-updates

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

diff --git a/doc/database/db_workerqueue.md b/doc/database/db_workerqueue.md
index 8ab68466be9f02a9e03467a6a20ec95c00cb8b03..a479ecbcaa22ee7dc54881db0b8fcf0a231868ec 100644 (file)
--- a/doc/database/db_workerqueue.md
+++ b/doc/database/db_workerqueue.md
@@ -1,13 +1,38 @@
 Table workerqueue
-=================
-
-| Field     | Description      | Type                | Null | Key | Default             | Extra          |
-|-----------|------------------|---------------------|------|-----|---------------------|----------------|
-| id        | sequential ID    | int(11)             | NO   | PRI | NULL                | auto_increment |
-| parameter |                  | text                | NO   |     | NULL                |                |
-| priority  |                  | tinyint(3) unsigned | NO   |     | 0                   |                |
-| created   |                  | datetime            | NO   | MUL | 0001-01-01 00:00:00 |                |
-| pid       |                  | int(11)             | NO   |     | 0                   |                |
-| executed  |                  | datetime            | NO   |     | 0001-01-01 00:00:00 |                |
+===========
+
+Background tasks queue entries
+
+Fields
+------
+
+| Field     | Description                                             | Type             | Null | Key | Default             | Extra          |
+| --------- | ------------------------------------------------------- | ---------------- | ---- | --- | ------------------- | -------------- |
+| id        | Auto incremented worker task id                         | int unsigned     | NO   | PRI | NULL                | auto_increment |
+| command   | Task command                                            | varchar(100)     | YES  |     | NULL                |                |
+| parameter | Task parameter                                          | mediumtext       | YES  |     | NULL                |                |
+| priority  | Task priority                                           | tinyint unsigned | NO   |     | 0                   |                |
+| created   | Creation date                                           | datetime         | NO   |     | 0001-01-01 00:00:00 |                |
+| pid       | Process id of the worker                                | int unsigned     | NO   |     | 0                   |                |
+| executed  | Execution date                                          | datetime         | NO   |     | 0001-01-01 00:00:00 |                |
+| next_try  | Next retrial date                                       | datetime         | NO   |     | 0001-01-01 00:00:00 |                |
+| retrial   | Retrial counter                                         | tinyint          | NO   |     | 0                   |                |
+| done      | Marked 1 when the task was done - will be deleted later | boolean          | NO   |     | 0                   |                |
+
+Indexes
+------------
+
+| Name                          | Fields                           |
+| ----------------------------- | -------------------------------- |
+| PRIMARY                       | id                               |
+| command                       | command                          |
+| done_command_parameter        | done, command, parameter(64)     |
+| done_executed                 | done, executed                   |
+| done_priority_retrial_created | done, priority, retrial, created |
+| done_priority_next_try        | done, priority, next_try         |
+| done_pid_next_try             | done, pid, next_try              |
+| done_pid_retrial              | done, pid, retrial               |
+| done_pid_priority_created     | done, pid, priority, created     |
+
 
 Return to [database documentation](help/database)