Merge pull request #17910 from sevirov/sevirov-DOCSUP-4919-document_replication_queue_system_table

DOCSUP-4919: Document the system.replication_queue system table
2024-11-10 01:25:21 +00:00 · 2020-12-16 21:43:32 +03:00 · 2020-12-16 21:43:32 +03:00 · 521e3fc4ae
commit 521e3fc4ae
parent 170cd132da 153610b2c3
4 changed files with 164 additions and 2 deletions
--- a/docs/en/operations/system-tables/distribution_queue.md
+++ b/docs/en/operations/system-tables/distribution_queue.md
@ -39,7 +39,7 @@ data_compressed_bytes: 499
 last_exception:        
 ```

-**See also**
+**See Also**

 -   [Distributed table engine](../../engines/table-engines/special/distributed.md)

--- a/docs/en/operations/system-tables/replication_queue.md
+++ b/docs/en/operations/system-tables/replication_queue.md
@ -0,0 +1,81 @@
+# system.replication_queue {#system_tables-replication_queue}
+
+Contains information about tasks from replication queues stored in ZooKeeper for tables in the `ReplicatedMergeTree` family.
+
+Columns:
+
+-   `database` ([String](../../sql-reference/data-types/string.md)) — Name of the database.
+
+-   `table` ([String](../../sql-reference/data-types/string.md)) — Name of the table.
+
+-   `replica_name` ([String](../../sql-reference/data-types/string.md)) — Replica name in ZooKeeper. Different replicas of the same table have different names.
+
+-   `position` ([UInt32](../../sql-reference/data-types/int-uint.md)) — Position of the task in the queue.
+
+-   `node_name` ([String](../../sql-reference/data-types/string.md)) — Node name in ZooKeeper.
+
+-   `type` ([String](../../sql-reference/data-types/string.md)) — Type of the task in the queue: `GET_PARTS`, `MERGE_PARTS`, `DETACH_PARTS`, `DROP_PARTS`, or `MUTATE_PARTS`.
+
+-   `create_time` ([Datetime](../../sql-reference/data-types/datetime.md)) — Date and time when the task was submitted for execution.
+
+-   `required_quorum` ([UInt32](../../sql-reference/data-types/int-uint.md)) — The number of replicas waiting for the task to complete with confirmation of completion. This column is only relevant for the `GET_PARTS` task.
+
+-   `source_replica` ([String](../../sql-reference/data-types/string.md)) — Name of the source replica.
+
+-   `new_part_name` ([String](../../sql-reference/data-types/string.md)) — Name of the new part.
+
+-   `parts_to_merge` ([Array](../../sql-reference/data-types/array.md) ([String](../../sql-reference/data-types/string.md))) — Names of parts to merge or update.
+
+-   `is_detach` ([UInt8](../../sql-reference/data-types/int-uint.md)) — The flag indicates whether the `DETACH_PARTS` task is in the queue.
+
+-   `is_currently_executing` ([UInt8](../../sql-reference/data-types/int-uint.md)) — The flag indicates whether a specific task is being performed right now.
+
+-   `num_tries` ([UInt32](../../sql-reference/data-types/int-uint.md)) — The number of failed attempts to complete the task.
+
+-   `last_exception` ([String](../../sql-reference/data-types/string.md)) — Text message about the last error that occurred (if any).
+
+-   `last_attempt_time` ([Datetime](../../sql-reference/data-types/datetime.md)) — Date and time when the task was last attempted.
+
+-   `num_postponed` ([UInt32](../../sql-reference/data-types/int-uint.md)) — The number of postponed tasks.
+
+-   `postpone_reason` ([String](../../sql-reference/data-types/string.md)) — The reason why the task was postponed.
+
+-   `last_postpone_time` ([Datetime](../../sql-reference/data-types/datetime.md)) — Date and time when the task was last postponed.
+
+-   `merge_type` ([String](../../sql-reference/data-types/string.md)) — Type of the current merge. Empty if it's a mutation.
+
+**Example**
+
+``` sql
+SELECT * FROM system.replication_queue LIMIT 1 FORMAT Vertical;
+```
+
+``` text
+Row 1:
+──────
+database:               merge
+table:                  visits_v2
+replica_name:           mtgiga001-1t.metrika.yandex.net
+position:               15
+node_name:              queue-0009325559
+type:                   MERGE_PARTS
+create_time:            2020-12-07 14:04:21
+required_quorum:        0
+source_replica:         mtgiga001-1t.metrika.yandex.net
+new_part_name:          20201130_121373_121384_2
+parts_to_merge:         ['20201130_121373_121378_1','20201130_121379_121379_0','20201130_121380_121380_0','20201130_121381_121381_0','20201130_121382_121382_0','20201130_121383_121383_0','20201130_121384_121384_0']
+is_detach:              0
+is_currently_executing: 0
+num_tries:              36
+last_exception:         Code: 226, e.displayText() = DB::Exception: Marks file '/opt/clickhouse/data/merge/visits_v2/tmp_fetch_20201130_121373_121384_2/CounterID.mrk' doesn't exist (version 20.8.7.15 (official build))
+last_attempt_time:      2020-12-08 17:35:54
+num_postponed:          0
+postpone_reason:        
+last_postpone_time:     1970-01-01 03:00:00
+```
+
+**See Also**
+
+-   [Managing ReplicatedMergeTree Tables](../../sql-reference/statements/system.md/#query-language-system-replicated)
+
+[Original article](https://clickhouse.tech/docs/en/operations/system_tables/replication_queue) <!--hide-->
--- a/docs/en/sql-reference/statements/system.md
+++ b/docs/en/sql-reference/statements/system.md
@ -204,7 +204,7 @@ SYSTEM STOP MOVES [[db.]merge_tree_family_table_name]

 ## Managing ReplicatedMergeTree Tables {#query-language-system-replicated}

-ClickHouse can manage background replication related processes in [ReplicatedMergeTree](../../engines/table-engines/mergetree-family/replication/#table_engines-replication) tables.
+ClickHouse can manage background replication related processes in [ReplicatedMergeTree](../../engines/table-engines/mergetree-family/replication.md#table_engines-replication) tables.

 ### STOP FETCHES {#query_language-system-stop-fetches}

--- a/docs/ru/operations/system-tables/replication_queue.md
+++ b/docs/ru/operations/system-tables/replication_queue.md
@ -0,0 +1,81 @@
+# system.replication_queue {#system_tables-replication_queue}
+
+Содержит информацию о задачах из очередей репликации, хранящихся в ZooKeeper, для таблиц семейства `ReplicatedMergeTree`.
+
+Столбцы:
+
+-   `database` ([String](../../sql-reference/data-types/string.md)) — имя базы данных.
+
+-   `table` ([String](../../sql-reference/data-types/string.md)) — имя таблицы.
+
+-   `replica_name` ([String](../../sql-reference/data-types/string.md)) — имя реплики в ZooKeeper. Разные реплики одной и той же таблицы имеют различные имена.
+
+-   `position` ([UInt32](../../sql-reference/data-types/int-uint.md)) — позиция задачи в очереди.
+
+-   `node_name` ([String](../../sql-reference/data-types/string.md)) — имя узла в ZooKeeper.
+
+-   `type` ([String](../../sql-reference/data-types/string.md)) — тип задачи в очереди: `GET_PARTS`, `MERGE_PARTS`, `DETACH_PARTS`, `DROP_PARTS` или `MUTATE_PARTS`.
+
+-   `create_time` ([Datetime](../../sql-reference/data-types/datetime.md)) — дата и время отправки задачи на выполнение.
+
+-   `required_quorum` ([UInt32](../../sql-reference/data-types/int-uint.md)) — количество реплик, ожидающих завершения задачи, с подтверждением о завершении. Этот столбец актуален только для задачи `GET_PARTS`.
+
+-   `source_replica` ([String](../../sql-reference/data-types/string.md)) — имя исходной реплики.
+
+-   `new_part_name` ([String](../../sql-reference/data-types/string.md)) — имя нового куска.
+
+-   `parts_to_merge` ([Array](../../sql-reference/data-types/array.md) ([String](../../sql-reference/data-types/string.md))) — имена кусков, которые требуется смержить или обновить.
+
+-   `is_detach` ([UInt8](../../sql-reference/data-types/int-uint.md)) — флаг, указывающий на присутствие в очереди задачи `DETACH_PARTS`.
+
+-   `is_currently_executing` ([UInt8](../../sql-reference/data-types/int-uint.md)) — флаг, указывающий на выполнение конкретной задачи на данный момент.
+
+-   `num_tries` ([UInt32](../../sql-reference/data-types/int-uint.md)) — количество неудачных попыток выполнить задачу.
+
+-   `last_exception` ([String](../../sql-reference/data-types/string.md)) — текст сообщения о последней возникшей ошибке, если таковые имеются.
+
+-   `last_attempt_time` ([Datetime](../../sql-reference/data-types/datetime.md)) — дата и время последней попытки выполнить задачу.
+
+-   `num_postponed` ([UInt32](../../sql-reference/data-types/int-uint.md)) — количество отложенных задач.
+
+-   `postpone_reason` ([String](../../sql-reference/data-types/string.md)) — причина, по которой была отложена задача.
+
+-   `last_postpone_time` ([Datetime](../../sql-reference/data-types/datetime.md)) — дата и время, когда была отложена задача в последний раз.
+
+-   `merge_type` ([String](../../sql-reference/data-types/string.md)) — тип текущего слияния. Пусто, если это мутация.
+
+**Пример**
+
+``` sql
+SELECT * FROM system.replication_queue LIMIT 1 FORMAT Vertical;
+```
+
+``` text
+Row 1:
+──────
+database:               merge
+table:                  visits_v2
+replica_name:           mtgiga001-1t.metrika.yandex.net
+position:               15
+node_name:              queue-0009325559
+type:                   MERGE_PARTS
+create_time:            2020-12-07 14:04:21
+required_quorum:        0
+source_replica:         mtgiga001-1t.metrika.yandex.net
+new_part_name:          20201130_121373_121384_2
+parts_to_merge:         ['20201130_121373_121378_1','20201130_121379_121379_0','20201130_121380_121380_0','20201130_121381_121381_0','20201130_121382_121382_0','20201130_121383_121383_0','20201130_121384_121384_0']
+is_detach:              0
+is_currently_executing: 0
+num_tries:              36
+last_exception:         Code: 226, e.displayText() = DB::Exception: Marks file '/opt/clickhouse/data/merge/visits_v2/tmp_fetch_20201130_121373_121384_2/CounterID.mrk' doesn't exist (version 20.8.7.15 (official build))
+last_attempt_time:      2020-12-08 17:35:54
+num_postponed:          0
+postpone_reason:        
+last_postpone_time:     1970-01-01 03:00:00
+```
+
+**Смотрите также**
+
+-   [Управление таблицами ReplicatedMergeTree](../../sql-reference/statements/system.md/#query-language-system-replicated)
+
+[Оригинальная статья](https://clickhouse.tech/docs/ru/operations/system_tables/replication_queue) <!--hide-->