aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoraidarsamer <aidarsamer@ydb.tech>2023-06-30 18:45:17 +0300
committeraidarsamer <aidarsamer@ydb.tech>2023-06-30 18:45:17 +0300
commit658607172c32129ee978144b997c884e4284a325 (patch)
tree650256de95009fe83bd1107c5580b3a526d62a0f
parent83e9195e30a0c2891f89d3cddf69b1c863cf3c52 (diff)
downloadydb-658607172c32129ee978144b997c884e4284a325.tar.gz
Add TPC-H workload doc
-rw-r--r--ydb/docs/en/core/reference/ydb-cli/workload-click-bench.md4
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/commands/workload/_includes/index.md3
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml4
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/workload-click-bench.md3
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/workload-tpch.md70
5 files changed, 79 insertions, 5 deletions
diff --git a/ydb/docs/en/core/reference/ydb-cli/workload-click-bench.md b/ydb/docs/en/core/reference/ydb-cli/workload-click-bench.md
index a7762d78221..a9c35c4b607 100644
--- a/ydb/docs/en/core/reference/ydb-cli/workload-click-bench.md
+++ b/ydb/docs/en/core/reference/ydb-cli/workload-click-bench.md
@@ -20,7 +20,7 @@ See the description of the command to init the data load:
{{ ydb-cli }} workload clickbench init --help
```
-### Available parameters {#init_options}
+### Available parameters {#init-options}
| Parameter name | Parameter description |
---|---
@@ -52,7 +52,7 @@ See the description of the command to run the data load:
{{ ydb-cli }} workload clickbench run --help
```
-### Global parameters for all types of load {#run_options}
+### Global parameters for all types of load {#run-options}
| Parameter name | Parameter description |
---|---
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 d7b9f90168b..e3456cd319a 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
@@ -24,4 +24,5 @@
* [Stock](../stock.md) - симулятор склада интернет-магазина.
* [Key-value](../../../workload-kv.md) - Key-Value нагрузка.
* [ClickBench](../../../workload-click-bench.md) - аналитический бенчмарк ClickBench (https://github.com/ClickHouse/ClickBench).
-<!-- * [Topic](../../../workload-topic.md) - Topic нагрузка. -->
+* [TPC-H](../../../workload-tpch.md) - TPC-H бенчмарк (https://www.tpc.org/tpch/).
+* [Topic](../../../workload-topic.md) - Topic нагрузка.
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 416cdeaf2b1..05b1e12ea45 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -66,7 +66,7 @@ items:
- name: Запись в топик
href: topic-write.md
- name: Конвейерная обработка сообщений
- href: topic-pipeline.md
+ href: topic-pipeline.md
- name: Выполнение YQL
items:
- name: Обзор
@@ -117,3 +117,5 @@ items:
href: workload-kv.md
- name: Topic нагрузка
href: workload-topic.md
+ - name: TPC-H нагрузка
+ href: workload-tpch.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
index 0ae31e4e7ed..1de9cb98a87 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/workload-click-bench.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-click-bench.md
@@ -1,6 +1,6 @@
# ClickBench нагрузка
-Нагрузка базируется на данных и запросах из репозитория [https://github.com/ClickHouse/ClickBench](https://github.com/ClickHouse/ClickBench), а запросы и схема таблица адаптированы под {{ ydb-short-name }}.
+Нагрузка базируется на данных и запросах из репозитория [https://github.com/ClickHouse/ClickBench](https://github.com/ClickHouse/ClickBench), а запросы и схема таблицы адаптированы под {{ ydb-short-name }}.
Тест генерирует типичную рабочую нагрузку в следующих областях: анализ потока кликов и трафика, веб-аналитика, машинно-генерируемые данные, структурированные журналы и данные о событиях. Он охватывает типичные запросы в аналитике и информационных панелях реального времени.
@@ -25,6 +25,7 @@
Имя параметра | Описание параметра
---|---
`--table <значение>` | Имя таблицы. Значение по умолчанию `clickbench/hits`.
+`--store <значение>` | Тип хранилища таблиц. Возможные значения: `row`, `column`. Значение по умолчанию `row`.
## Загрузка данных в таблицу {#load}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/workload-tpch.md b/ydb/docs/ru/core/reference/ydb-cli/workload-tpch.md
new file mode 100644
index 00000000000..fb8b24828a9
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-tpch.md
@@ -0,0 +1,70 @@
+# TPC-H нагрузка
+
+Нагрузка базируется на документе TPC-H [документация](https://www.tpc.org/tpc_documents_current_versions/pdf/tpc-h_v2.17.1.pdf), а запросы и схемы таблиц адаптированы под {{ ydb-short-name }}.
+
+Тест генерирует типичную рабочую нагрузку в области помощи в принятии решений.
+
+## Инициализация нагрузочного теста {#init}
+
+Перед запуском теста создайте таблицу:
+
+```bash
+{{ ydb-cli }} workload tpch init
+```
+
+Посмотрите описание команды для запуска нагрузки:
+
+```bash
+{{ ydb-cli }} workload tpch init --help
+```
+
+### Доступные параметры {#init-options}
+
+Имя параметра | Описание параметра
+---|---
+`--path <значение>` | Директория, в которой будут созданы таблицы. Значение по умолчанию `""`.
+`--store <значение>` | Тип хранилища таблиц. Возможные значения: `row`, `column`. Значение по умолчанию `row`.
+
+## Загрузка данных в таблицу {#load}
+
+Генератор набора данных для TPC-H бенчмарка можно скачать по [ссылке](http://tpc.org/tpc_documents_current_versions/current_specifications5.asp).
+Дальше надо следовать инструкции из README.
+В файле `dss.h` можно задать необходимый разделитель полей. По умолчанию: `#define SEPARATOR '|'`.
+В примере скрипта загрузки данных используется `'\t'` как разделитель.
+
+```bash
+for table in region nation supplier customer part partsupp orders lineitem; do
+ echo "Start data load to $table"
+ {{ ydb-cli }} import file tsv --header --path "$table" --input-file $table.tsv --newline-delimited
+ echo "Finish data load to $table"
+done
+```
+
+## Запуск нагрузочного теста {#run}
+
+Запустите нагрузку:
+
+```bash
+{{ ydb-cli }} workload tpch run
+```
+
+В течение теста на экран выводится статистика по нагрузке для каждого запроса.
+
+Посмотрите описание команды для запуска нагрузки:
+
+```bash
+{{ ydb-cli }} workload tpch run --help
+```
+
+### Общие параметры для всех видов нагрузки {#run-options}
+
+Имя параметра | Описание параметра
+---|---
+`--output <значение>` | Имя файла, в котором будут сохранены результаты выполнения запросов. Значение по умолчанию `results.out`.
+`--iterations <значение>` | Количество выполнений каждого из запросов нагрузки, создающих нагрузку. Значение по умолчанию: `1`.
+`--json` | Имя файла, в котором будет сохранена статистика выполнения запросов в формате `json`. По умолчанию файл не сохраняется.
+`--ministat` | Имя файла, в котором будет сохранена статистика выполнения запросов в формате `ministat`. По умолчанию файл не сохраняется.
+`--query-settings` | Настройки выполнения запроса. По умолчанию не указывается.
+`--ext-queries-dir` | Имя директории, в которой находятся внешние запросы для выполнения нагрузки.
+`--include` | Номера или отрезки номеров запросов, которые нужно выполнить в рамках нагрузки. По умолчанию выполняются все запросы. Указываются через запятую, например `1,2,4-6`.
+`--exclude` | Номера или отрезки номеров запросов, которые нужно исключить в рамках нагрузки. По умолчанию выполняются все запросы. Указываются через запятую, например `1,2,4-6`.