From 23d19b389108963f09cf0c52eb7045bdff33d5b3 Mon Sep 17 00:00:00 2001
From: BayoNet <bayonet@yandex-team.ru>
Date: Mon, 16 Apr 2018 08:32:37 +0300
Subject: [PATCH] The description of `clickhouse-local` utility is extended.

---
 docs/mkdocs-material-theme/partials/nav.html |  4 +-
 docs/ru/query_language/queries.md            |  2 +
 docs/ru/utils/clickhouse-local.md            | 69 +++++++++++++++++++-
 3 files changed, 71 insertions(+), 4 deletions(-)

diff --git a/docs/mkdocs-material-theme/partials/nav.html b/docs/mkdocs-material-theme/partials/nav.html
index 2d65e408fda..9a5c4b3da09 100644
--- a/docs/mkdocs-material-theme/partials/nav.html
+++ b/docs/mkdocs-material-theme/partials/nav.html
@@ -25,9 +25,9 @@
       <a href="{{ config.repo_url }}" rel="external nofollow" target="_blank" class="md-nav__link">
         <script type="text/javascript">
         if (window.location.pathname.indexOf('/ru/') >= 0) {
-          document.write('Исходный код');
+          document.write('Исходники ClickHouse');
         } else {
-          document.write('Source code');
+          document.write('ClickHouse sources');
         }
      </script>
       </a>
diff --git a/docs/ru/query_language/queries.md b/docs/ru/query_language/queries.md
index 61957616f2c..5e37137d4a0 100644
--- a/docs/ru/query_language/queries.md
+++ b/docs/ru/query_language/queries.md
@@ -1,3 +1,5 @@
+<a name="queries"></a>
+
 # Запросы
 
 ## CREATE DATABASE
diff --git a/docs/ru/utils/clickhouse-local.md b/docs/ru/utils/clickhouse-local.md
index 0cee8e4ee3c..1a80d65c07f 100644
--- a/docs/ru/utils/clickhouse-local.md
+++ b/docs/ru/utils/clickhouse-local.md
@@ -1,5 +1,70 @@
 <a name="utils-clickhouse-local"></a>
 
-#clickhouse-local
+# clickhouse-local
 
-Программа `clickhouse-local` позволяет выполнять быструю обработку локальных файлов, хранящих таблицы, не прибегая к развертыванию и настройке сервера ClickHouse.
+Принимает на вход данные, которые можно представить в табличном виде и выполняет над ними операции, заданные на [языке запросов](../query_language/queries.md#queries) ClickHouse.
+
+`clickhouse-local` использует движок сервера ClickHouse, т.е. поддерживает все форматы данных и движки таблиц, с которыми работает и сервер, при этом для выполнения операций не требуется запущенный сервер ClickHouse.
+
+`clickhouse-local` при настройке по умолчанию не имеет доступа к данным, которыми управляет сервер ClickHouse, установленный на этом же хосте, однако можно подключить серверную конфигурацию.
+
+<div class="admonition warning">
+Мы не рекомендуем подключать серверную конфигурацию к `clickhouse-local`, поскольку данные можно легко повредить неосторожными действиями.
+</div>
+
+
+##Вызов программы
+
+Основной формат вызова:
+
+``` bash
+clickhouse-local --structure "table_structure" --input-format "format_of_incoming_data" -q "query"
+```
+
+Ключи команды:
+
+- `-S`, `--structure` — структура таблицы, в которую будут помещены входящие данные.
+- `-if`, `--input-format` — формат входящих данных. По умолчанию — `TSV`.
+- `-f`, `--file` — путь к файлу с данными. По умолчанию — `stdin`.
+- `-q` `--query` — запросы на выполнение. Разделитель запросов — `;`.
+- `-N`, `--table` — имя таблицы, в которую будут помещены входящие данные. По умолчанию - `table`.
+- `-of`, `--format`, `--output-format` — формат выходных данных. По умолчанию — `TSV`.
+- `--stacktrace` — вывод отладочной информации при исключениях.
+- `--verbose` — подробный вывод при выполнении запроса.
+- `-s` — отключает вывод системных логов в `stderr`.
+- `--config-file` — путь к файлу конфигурации. По умолчанию `clickhouse-local` запускается с пустой конфигурацией. Конфигурационный файл имеет тот же формат, что и для сервера ClickHouse и в нём можно использовать все конфигурационные параметры сервера. Обычно подключение конфигурации не требуется, если требуется установить отдельный параметр, то это можно сделать ключом с именем параметра.
+- `--help` — вывод справочной информации о `clickhouse-local`.
+
+
+## Примеры вызова
+
+``` bash
+echo -e "1,2\n3,4" | clickhouse-local -S "a Int64, b Int64" -if "CSV" -q "SELECT * FROM table"
+Read 2 rows, 32.00 B in 0.000 sec., 5182 rows/sec., 80.97 KiB/sec.
+1	2
+3	4
+```
+
+Вызов выше эквивалентен следующему:
+
+``` bash
+$ echo -e "1,2\n3,4" | clickhouse-local -q "CREATE TABLE table (a Int64, b Int64) ENGINE = File(CSV, stdin); SELECT a, b FROM table; DROP TABLE table"
+Read 2 rows, 32.00 B in 0.000 sec., 4987 rows/sec., 77.93 KiB/sec.
+1	2
+3	4
+```
+
+А теперь давайте выведем на экран объем оперативной памяти, занимаемой пользователями (Unix):
+
+``` bash
+$ ps aux | tail -n +2 | awk '{ printf("%s\t%s\n", $1, $4) }' | clickhouse-local -S "user String, mem Float64" -q "SELECT user, round(sum(mem), 2) as memTotal FROM table GROUP BY user ORDER BY memTotal DESC FORMAT Pretty"
+Read 186 rows, 4.15 KiB in 0.035 sec., 5302 rows/sec., 118.34 KiB/sec.
+┏━━━━━━━━━━┳━━━━━━━━━━┓
+┃ user     ┃ memTotal ┃
+┡━━━━━━━━━━╇━━━━━━━━━━┩
+│ bayonet  │    113.5 │
+├──────────┼──────────┤
+│ root     │      8.8 │
+├──────────┼──────────┤
+...
+```