Fix ydb cli workload-kv

updated

8 files changed, 54 insertions, 45 deletions

diff --git a/ydb/docs/en/core/reference/ydb-cli/commands/workload/_includes/index.md b/ydb/docs/en/core/reference/ydb-cli/commands/workload/_includes/index.md
index b9414d0ce4..f47dff1ec8 100644
--- a/ydb/docs/en/core/reference/ydb-cli/commands/workload/_includes/index.md
+++ b/ydb/docs/en/core/reference/ydb-cli/commands/workload/_includes/index.md
@@ -22,4 +22,4 @@ See the description of the command to run the data load:
 The following types of load tests are supported at the moment:
 
 * [Stock](../stock.md): An online store warehouse simulator.
-* [Kv](../kv.md): Key-Value load.
+* [Key-value](../../../workload-kv.md): Key-Value load.
diff --git a/ydb/docs/en/core/reference/ydb-cli/commands/workload/kv.md b/ydb/docs/en/core/reference/ydb-cli/commands/workload/kv.md
deleted file mode 100644
index d501311cf7..0000000000
--- a/ydb/docs/en/core/reference/ydb-cli/commands/workload/kv.md
+++ /dev/null
@@ -1 +0,0 @@
-{% include [kv.md](_includes/kv.md) %}
diff --git a/ydb/docs/en/core/reference/ydb-cli/toc_i.yaml b/ydb/docs/en/core/reference/ydb-cli/toc_i.yaml
index c2d01c9f43..bfeb30957b 100644
--- a/ydb/docs/en/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/en/core/reference/ydb-cli/toc_i.yaml
@@ -77,7 +77,7 @@ items:
       href: commands/workload/index.md
     - name: Stock load
       href: commands/workload/stock.md
-    - name: Kv load
-      href: commands/workload/kv.md
+    - name: Key-Value load
+      href: workload-kv.md
 
 
diff --git a/ydb/docs/en/core/reference/ydb-cli/commands/workload/_includes/kv.md b/ydb/docs/en/core/reference/ydb-cli/workload-kv.md
index 8eb6b89e60..0da17e606f 100644
--- a/ydb/docs/en/core/reference/ydb-cli/commands/workload/_includes/kv.md
+++ b/ydb/docs/en/core/reference/ydb-cli/workload-kv.md
@@ -107,9 +107,9 @@ Parameter name | Short name | Parameter Description
 `--threads <value>` | `-t <value>` | The number of parallel threads creating the load. Default value: 10.
 `--quiet` | - | Outputs only the final test result.
 `--print-timestamp` | - | Print the time together with the statistics of each time window.
-`--client-timeout` | - | [Transport timeout in milliseconds](../../../../../best_practices/timeouts.md).
-`--operation-timeout` | - | [Operation timeout in milliseconds](../../../../../best_practices/timeouts.md).
-`--cancel-after` | - | [Operation cancellation timeout in milliseconds](../../../../../best_practices/timeouts.md).
+`--client-timeout` | - | [Transport timeout in milliseconds](../../best_practices/timeouts.md).
+`--operation-timeout` | - | [Operation timeout in milliseconds](../../best_practices/timeouts.md).
+`--cancel-after` | - | [Operation cancellation timeout in milliseconds](../../best_practices/timeouts.md).
 `--window` | - | Duration of the statistics collection window in seconds. Default value: 1.
 `--max-first-key` | - | The maximum value of the primary key of the table. Default value: $2^{64} - 1$.
 `--cols` | - | Number of columns in the table. Default value: 2, counting Key.
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 52fe1703b5..fe1b6dd772 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,4 +21,4 @@
 
 В данный момент поддерживаются следующие виды нагрузочных тестов:
 * [Stock](../stock.md) - симулятор склада интернет-магазина.
-* [Kv](../kv.md) - Key-Value нагрузка
+* [Key-value](../../../workload-kv.md) - Key-Value нагрузка
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/kv.md b/ydb/docs/ru/core/reference/ydb-cli/commands/workload/kv.md
deleted file mode 100644
index d501311cf7..0000000000
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/kv.md
+++ /dev/null
@@ -1 +0,0 @@
-{% include [kv.md](_includes/kv.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 c9e07d72c1..480743f64e 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -77,6 +77,6 @@ items:
       href: commands/workload/index.md
     - name: Stock нагрузка
       href: commands/workload/stock.md
-    - name: Kv нагрузка
-      href: commands/workload/kv.md
+    - name: Key-Value нагрузка
+      href: workload-kv.md
 
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/kv.md b/ydb/docs/ru/core/reference/ydb-cli/workload-kv.md
index f0738146d0..f467a83d34 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/kv.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-kv.md
@@ -1,22 +1,23 @@
 # Key-Value нагрузка
 
-Простой вид нагрузки, использующий YDB базу данных как Key-Value хранилище
+Простой вид нагрузки, использующий БД YDB как Key-Value хранилище.
 
-## Виды нагрузки {#workload_types}
+## Виды нагрузки {#workload-types}
 
 Данный нагрузочный тест содержит 3 вида нагрузки:
-* [upsert](#upsertKv) - при помощи операции UPSERT вставляет в заранее созданную командой init таблицу строки, которые представляют из себя кортежи (key, value1, value2, ... valueN), число N задается в параметрах
-* [insert](#insertKv) - функционал такой же, как у нагрузки upsert, но для вставки используется операция INSERT
-* [select](#selectKv) - читает данные при помощи операции SELECT * WHERE key = $key. Запрос всегда затрагивает все колонки таблицы, но не всегда является точечным, количеством вариаций primary ключа можно управлять с помощью параметров.
+* [upsert](#upsert-kv) — при помощи операции UPSERT вставляет в заранее созданную командой init таблицу строки, которые представляют из себя кортежи (key, value1, value2, ... valueN), число N задается в параметрах.
+* [insert](#insert-kv) — функционал такой же, как у нагрузки upsert, но для вставки используется операция INSERT.
+* [select](#select-kv) — читает данные при помощи операции SELECT * WHERE key = $key. Запрос всегда затрагивает все колонки таблицы, но не всегда является точечным, количеством вариаций primary ключа можно управлять с помощью параметров.
 
 ## Инициализация нагрузочного теста {#init}
 
-Для начала работы необходимо создать таблицы, при создании можно указать, сколько строк необходимо вставить при инициализации
+Для начала работы необходимо создать таблицы, при создании можно указать, сколько строк необходимо вставить при инициализации:
+
 ```bash
 {{ ydb-cli }} workload kv init [init options...]
 ```
 
-* `init options` — [параметры инициализации](#init_options).
+* `init options` — [параметры инициализации](#init-options).
 
 Посмотрите описание команды для инициализации таблицы:
 
@@ -24,21 +25,21 @@
 {{ ydb-cli }} workload kv init --help
 ```
 
-### Доступные параметры {#init_options}
+### Доступные параметры {#init-options}
 
 Имя параметра | Описание параметра
 ---|---
 `--init-upserts <значение>` | Количество операций вставки, которые нужно сделать при инициализации. Значение по умолчанию: 1000.
 `--min-partitions` | Минимальное количество шардов для таблиц. Значение по умолчанию: 40.
 `--auto-partition` | Включение/выключение автошардирования. Возможные значения: 0 или 1. Значение по умолчанию: 1.
-`--max-first-key` | Максимальное значение primary ключа таблицы. Значение по умолчанию: $2^{64} - 1$.
+`--max-first-key` | Максимальное значение primary ключа таблицы. Значение по умолчанию: $2^{64} — 1$.
 `--len` | Размер строк в байтах, которые вставляются в таблицу, как values. Значение по умолчанию: 8.
 `--cols` | Количество колонок в таблице. Значение по умолчанию: 2, считая Key.
 `--rows` | Количество затрагиваемых строк в одном запросе. Значение по умолчанию: 1.
 
-
 Для создания таблицы используется следующая команда:
-```sql
+
+```yql
 CREATE TABLE `DbPath/kv_test`(
     c0 Uint64,
     c1 String,
@@ -64,19 +65,20 @@ CREATE TABLE `DbPath/kv_test`(
 
 ## Удаление таблицы {#clean}
 
-После завершения работы можно удалить таблицу
+После завершения работы можно удалить таблицу:
+
 ```bash
 {{ ydb-cli }} workload kv clean
 ```
 
 Исполняется следующая YQL команда:
+
 ```sql
 DROP TABLE `DbPath/kv_test`
 ```
 
 ### Примеры использования clean {#clean-kv-examples}
 
-
 ```bash
 {{ ydb-cli }} workload kv clean
 ```
@@ -84,14 +86,16 @@ DROP TABLE `DbPath/kv_test`
 ## Запуск нагрузочного теста {#run}
 
 Для запуска нагрузки необходимо выполнить команду:
+
 ```bash
 {{ ydb-cli }} workload kv run [workload type...] [global workload options...] [specific workload options...]
 ```
+
 В течение теста на экран выводится статистика по нагрузке для каждого временного окна.
 
-* `workload type` — [виды нагрузки](#workload_types).
-* `global workload options` - [общие параметры для всех видов нагрузки](#global_workload_options).
-* `specific workload options` - параметры конкретного вида нагрузки.
+* `workload type` — [виды нагрузки](#workload-types).
+* `global workload options` — [общие параметры для всех видов нагрузки](#global-workload-options).
+* `specific workload options` — параметры конкретного вида нагрузки.
 
 Посмотрите описание команды для запуска нагрузки:
 
@@ -99,7 +103,7 @@ DROP TABLE `DbPath/kv_test`
 {{ ydb-cli }} workload kv run --help
 ```
 
-### Общие параметры для всех видов нагрузки {#global_workload_options}
+### Общие параметры для всех видов нагрузки {#global-workload-options}
 
 Имя параметра | Короткое имя | Описание параметра
 ---|---|---
@@ -107,21 +111,21 @@ DROP TABLE `DbPath/kv_test`
 `--threads <значение>` | `-t <значение>` | Количество параллельных потоков, создающих нагрузку. Значение по умолчанию: 10.
 `--quiet` | - | Выводит только итоговый результат теста.
 `--print-timestamp` | - | Печатать время вместе со статистикой каждого временного окна.
-`--client-timeout` | - | [Транспортный таймаут в миллисекундах](../../../../../best_practices/timeouts.md).
-`--operation-timeout` | - | [Таймаут на операцию в миллисекундах](../../../../../best_practices/timeouts.md).
-`--cancel-after` | - | [Таймаут отмены операции в миллисекундах](../../../../../best_practices/timeouts.md).
+`--client-timeout` | - | [Транспортный таймаут в миллисекундах](../../best_practices/timeouts.md).
+`--operation-timeout` | - | [Таймаут на операцию в миллисекундах](../../best_practices/timeouts.md).
+`--cancel-after` | - | [Таймаут отмены операции в миллисекундах](../../best_practices/timeouts.md).
 `--window` | - | Длительность окна сбора статистики в секундах. Значение по умолчанию: 1.
 `--max-first-key` | - | Максимальное значение primary ключа таблицы. Значение по умолчанию: $2^{64} - 1$.
 `--cols` | - | Количество колонок в таблице. Значение по умолчанию: 2, считая Key.
 `--rows` | - |Количество затрагиваемых строк в одном запросе. Значение по умолчанию: 1.
 
-
-## Нагрузка upsert {#upsertKv}
+## Нагрузка upsert {#upsert-kv}
 
 Данный вид нагрузки вставляет кортежи (key, value1, value2, ..., valueN)
 
 YQL Запрос:
-```sql
+
+```yql
 DECLARE r0 AS Uint64
 DECLARE c00 AS String;
 DECLARE c01 AS String;
@@ -136,24 +140,27 @@ UPSERT INTO `kv_test`(c0, c1, ... cN) VALUES ( (r0, c00, ... c0{N - 1}), (r1, c1
 ```
 
 Для запуска данного вида нагрузки необходимо выполнить команду:
+
 ```bash
 {{ ydb-cli }} workload kv run upsert [global workload options...] [specific workload options...]
 ```
 
-* `global workload options` - [общие параметры для всех видов нагрузки](#global_workload_options).
-* `specific workload options` - [параметры конкретного вида нагрузки](#upsert_options)
+* `global workload options` - [общие параметры для всех видов нагрузки](#global-workload-options).
+* `specific workload options` - [параметры конкретного вида нагрузки](#upsert-options).
+
+### Параметры для upsert {#upsert-options}
 
-### Параметры для upsert {#upsert_options}
 Имя параметра | Описание параметра
 ---|---
 `--len` | Размер строк в байтах, которые вставляются в таблицу, как values. Значение по умолчанию: 8.
 
-## Нагрузка insert {#insertKv}
+## Нагрузка insert {#insert-kv}
 
 Данный вид нагрузки вставляет кортежи (key, value1, value2, ..., valueN)
 
 YQL Запрос:
-```sql
+
+```yql
 DECLARE r0 AS Uint64
 DECLARE c00 AS String;
 DECLARE c01 AS String;
@@ -168,24 +175,27 @@ INSERT INTO `kv_test`(c0, c1, ... cN) VALUES ( (r0, c00, ... c0{N - 1}), (r1, c1
 ```
 
 Для запуска данного вида нагрузки необходимо выполнить команду:
+
 ```bash
 {{ ydb-cli }} workload kv run insert [global workload options...] [specific workload options...]
 ```
 
-* `global workload options` - [общие параметры для всех видов нагрузки](#global_workload_options).
-* `specific workload options` - [параметры конкретного вида нагрузки](#insert_options)
+* `global workload options` - [общие параметры для всех видов нагрузки](#global-workload-options).
+* `specific workload options` - [параметры конкретного вида нагрузки](#insert-options).
+
+### Параметры для insert {#insert-options}
 
-### Параметры для insert {#insert_options}
 Имя параметра | Описание параметра
 ---|---
 `--len` | Размер строк в байтах, которые вставляются в таблицу, как values. Значение по умолчанию: 8.
 
-## Нагрузка select {#selectKv}
+## Нагрузка select {#select-kv}
 
 Данный вид нагрузки создает SELECT запросы, возвращающие строки по точному совпадению primary ключа.
 
 YQL Запрос:
-```sql
+
+```yql
 DECLARE r0 AS Uint64
 DECLARE r1 AS Uint64
 ...
@@ -199,8 +209,9 @@ SELECT * FROM `kv_test`(c0, c1, ..., cN) WHERE (
 ```
 
 Для запуска данного вида нагрузки необходимо выполнить команду:
+
 ```bash
 {{ ydb-cli }} workload kv run select [global workload options...]
 ```
 
-* `global workload options` - [общие параметры для всех видов нагрузки](#global_workload_options).
+* `global workload options` - [общие параметры для всех видов нагрузки](#global-workload-options).