DOCSUP-13875: Document the replication_wait_for_inactive_replica_timeout setting #28464

sevirov · 2021-09-01T20:38:09Z

I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=en

Changelog category:

Documentation for Avoid too long waiting for inactive replicas #27931

Задокументировал две настройки.

Поправил ссылки.

docs/en/operations/settings/settings.md

docs/en/sql-reference/statements/alter/index.md

docs/en/sql-reference/statements/optimize.md

docs/en/sql-reference/statements/truncate.md

Co-authored-by: olgarev <56617294+olgarev@users.noreply.github.com>

Выполнил перевод на русский язык.

Поправил ссылки.

…-DOCSUP-13875-document_the_replication_wait_for_inactive_replica_timeout_setting

Поправил перевод.

docs/en/operations/settings/settings.md

docs/en/sql-reference/statements/alter/index.md

docs/en/sql-reference/statements/optimize.md

docs/en/sql-reference/statements/truncate.md

docs/ru/operations/settings/settings.md

docs/en/operations/settings/settings.md

Co-authored-by: olgarev <56617294+olgarev@users.noreply.github.com>

sevirov · 2021-09-08T19:27:28Z

@tavplubix Please, review this PR.

tavplubix · 2021-09-08T16:32:14Z

docs/en/operations/settings/settings.md

@@ -3458,6 +3458,30 @@ Possible values:

 Default value: `0`.

+## replication_alter_partitions_sync {#replication-alter-partitions-sync}
+
+Determines how actions that manipulate partitions are executed.


Now it's also applicable to OPTIMIZE, TRUNCATE and all replicated ALTER queries, not only to ALTER PARTITION

tavplubix · 2021-09-09T09:43:44Z

docs/en/operations/settings/settings.md

+-   0 — Do not wait. The next action can start any time, not waiting for the previous action to be completed.
+-   1 — Wait for own execution. The next action on the partition starts only after the previous action is completed on this partition.
+-   2 — Wait for everyone. The next action starts only after the previous action is completed on all partitions.


What is "the next action" and "the previous action"?

tavplubix · 2021-09-09T09:46:09Z

docs/en/sql-reference/statements/alter/index.md

+You can specify how long (in seconds) to wait for inactive replicas to execute all `ALTER` queries with the [replication_wait_for_inactive_replica_timeout seconds](../../../operations/settings/settings.md#replication-wait-for-inactive-replica-timeout) setting.
+
+!!! warning "Warning"
+    For all `ALTER` queries, if `replication_alter_partitions_sync = 2` and some replicas are not active for more than the time, specified in the `replication_wait_for_inactive_replica_timeout seconds` setting, then an exception `UNFINISHED` is thrown.


It's rather a note than a warning

Исправил неточности в описании.

tavplubix · 2021-09-09T17:42:38Z

docs/en/sql-reference/statements/optimize.md

@@ -18,13 +18,17 @@ OPTIMIZE TABLE [db.]name [ON CLUSTER cluster] [PARTITION partition | PARTITION I

 The `OPTMIZE` query is supported for [MergeTree](../../engines/table-engines/mergetree-family/mergetree.md) family, the [MaterializedView](../../engines/table-engines/special/materializedview.md) and the [Buffer](../../engines/table-engines/special/buffer.md) engines. Other table engines aren’t supported.

-When `OPTIMIZE` is used with the [ReplicatedMergeTree](../../engines/table-engines/mergetree-family/replication.md) family of table engines, ClickHouse creates a task for merging and waits for execution on all nodes (if the `replication_alter_partitions_sync` setting is enabled).
+When `OPTIMIZE` is used with the [ReplicatedMergeTree](../../engines/table-engines/mergetree-family/replication.md) family of table engines, ClickHouse creates a task for merging and waits for execution on all nodes (if the [replication_alter_partitions_sync](../../operations/settings/settings.md#replication-alter-partitions-sync) setting is enabled).


It waits for all replicas if replication_alter_partitions_sync is set to 2 (and waits for current replica if it is set to 1)

Поправил описание запроса OPTIMIZE.

Add documentation of settings

afc7842

Задокументировал две настройки.

robot-clickhouse added the pr-documentation Documentation PRs for the specific code PR label Sep 1, 2021

tavplubix self-assigned this Sep 2, 2021

Fix links

d8856f1

Поправил ссылки.