Added clarity clickhouse benchmark

updated

4 files changed, 71 insertions, 4 deletions

diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md
index f1c4e28196..d6d06e6b2c 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md
@@ -21,5 +21,5 @@
 
 В данный момент поддерживаются следующие виды нагрузочных тестов:
 * [Stock](../stock.md) - симулятор склада интернет-магазина.
-* [Key-value](../../../workload-kv.md) - Key-Value нагрузка
-* [ClickBench](../click-bench.md) - нагрузка аналитическими запросами
+* [Key-value](../../../workload-kv.md) - Key-Value нагрузка.
+* [ClickBench](../../../workload-click-bench.md) - аналитический бенчмарк ClickBench (https://github.com/ClickHouse/ClickBench).
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md
deleted file mode 100644
index ff7a2e722e..0000000000
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/click-bench.md
+++ /dev/null
@@ -1 +0,0 @@
-{% include [click-bench.md](_includes/click-bench.md) %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
index a85b636227..af17731a4d 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -100,7 +100,7 @@ items:
     - name: Stock нагрузка
       href: commands/workload/stock.md
     - name: ClickBench нагрузка
-      href: commands/workload/click-bench.md
+      href: workload-click-bench.md
     - name: Key-Value нагрузка
       href: workload-kv.md
 
diff --git a/ydb/docs/ru/core/reference/ydb-cli/workload-click-bench.md b/ydb/docs/ru/core/reference/ydb-cli/workload-click-bench.md
new file mode 100644
index 0000000000..0ae31e4e7e
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-click-bench.md
@@ -0,0 +1,68 @@
+# ClickBench нагрузка
+
+Нагрузка базируется на данных и запросах из репозитория [https://github.com/ClickHouse/ClickBench](https://github.com/ClickHouse/ClickBench), а запросы и схема таблица адаптированы под {{ ydb-short-name }}.
+
+Тест генерирует типичную рабочую нагрузку в следующих областях: анализ потока кликов и трафика, веб-аналитика, машинно-генерируемые данные, структурированные журналы и данные о событиях. Он охватывает типичные запросы в аналитике и информационных панелях реального времени.
+
+Набор данных для бенчмарка был получен на основе фактической записи трафика одной из крупнейших в мире платформ веб-аналитики. Он анонимизирован, при этом сохраняет все основные распределения данных. Набор запросов был импровизирован, чтобы отразить реалистичные рабочие нагрузки, в то время как запросы не исходят непосредственно из производства.
+
+## Инициализация нагрузочного теста {#init}
+
+Перед запуском теста создайте таблицу:
+
+```bash
+{{ ydb-cli }} workload clickbench init
+```
+
+Посмотрите описание команды для запуска нагрузки:
+
+```bash
+{{ ydb-cli }} workload clickbench init --help
+```
+
+### Доступные параметры {#init_options}
+
+Имя параметра | Описание параметра
+---|---
+`--table <значение>` | Имя таблицы. Значение по умолчанию `clickbench/hits`.
+
+## Загрузка данных в таблицу {#load}
+
+Загрузите данные в таблицу. Для этого скачайте и распакуйте архив с данными, затем загрузите данные в таблицу:
+
+```bash
+wget https://datasets.clickhouse.com/hits_compatible/hits.csv.gz
+unzip hits.csv.gz
+{{ ydb-cli }} import file csv --path clickbench/hits --input-file hits.csv
+```
+
+## Запуск нагрузочного теста {#run}
+
+Запустите нагрузку:
+
+```bash
+{{ ydb-cli }} workload clickbench run
+```
+
+В течение теста на экран выводится статистика по нагрузке для каждого запроса.
+
+Посмотрите описание команды для запуска нагрузки:
+
+```bash
+{{ ydb-cli }} workload clickbench run --help
+```
+
+### Общие параметры для всех видов нагрузки {#run_options}
+
+Имя параметра | Описание параметра
+---|---
+`--output <значение>` |  Имя файла, в котором будут сохранены результаты выполнения запросов. Значение по умолчанию `results.out`.
+`--iterations <значение>` | Количество выполнений каждого из запросов нагрузки, создающих нагрузку. Значение по умолчанию: `1`.
+`--json` | Имя файла, в котором будет сохранена статистика выполнения запросов в формате `json`. По умолчанию файл не сохраняется.
+`--ministat` | Имя файла, в котором будет сохранена статистика выполнения запросов в формате `ministat`. По умолчанию файл не сохраняется.
+`--query-settings` | Настройки выполнения запроса. По умолчанию не указывается.
+`--ext-queries-file` | Имя файла, в котором можно указать внешние запросы для выполнения нагрузки. По умолчанию файл не требуется.
+`--ext-query` | Строка с внешними запросами для выполнения нагрузки. Значение по умолчанию отсутствует.
+`--table` | Имя таблицы. Значение по умолчанию: `clickbench/hits`.
+`--include` | Номера или отрезки номеров запросов, которые нужно выполнить в рамках нагрузки. По умолчанию выполняются все запросы. Указываются через запятую, например `1,2,4-6`.
+`--exclude` | Номера или отрезки номеров запросов, которые нужно исключить в рамках нагрузки. По умолчанию выполняются все запросы. Указываются через запятую, например `1,2,4-6`.