DOCSUP-8776: Docs for clickhouse-format

docs/en/operations/utilities/clickhouse-format.md

@@ -0,0 +1,98 @@
+---
+toc_priority: 65
+toc_title: clickhouse-format
+---
+
+# clickhouse-format {#clickhouse-format}
+
+Allows formatting input queries.
+
+Keys:
+
+- `--help` or`-h` — Produce help message.
+- `--hilite` — Add syntax highlight with ANSI terminal escape sequences.
+- `--oneline` — Format in single line.
+- `--quiet` or `-q` — Just check syntax, no output on success.
+- `--multiquery` or `-n` — Allow multiple queries in the same file.
+- `--obfuscate` — Obfuscate instead of formatting.
+- `--seed <string>` — Seed arbitrary string that determines the result of obfuscation.
+- `--backslash` — Add a backslash at the end of each line of the formatted query. Can be useful when you copy a query from web or somewhere else with multiple lines, and want to execute it in command line.
+
+## Examples {#examples} 
+
+1. Highlighting and single line:
+
+```bash
+$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"
+```
+
+Result:
+
+```sql
+SELECT sum(number) FROM numbers(5)
+```
+
+2. Multiqueries: 
+
+```bash
+$ clickhouse-format -n <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
+```
+
+Result:
+
+```text
+SELECT *
+FROM
+(
+    SELECT 1 AS x
+    UNION ALL
+    SELECT 1
+    UNION DISTINCT
+    SELECT 3
+)
+;
+```
+
+3. Obfuscating:
+
+```bash
+$ clickhouse-format --seed Hello --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
+```
+
+Result:
+
+```text
+SELECT treasury_mammoth_hazelnut BETWEEN nutmeg AND span, CASE WHEN chive >= 116 THEN switching ELSE ANYTHING END;
+```
+
+Same query and another seed string:
+
+```bash
+$ clickhouse-format --seed World --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
+```
+
+Result:
+
+```text
+SELECT horse_tape_summer BETWEEN folklore AND moccasins, CASE WHEN intestine >= 116 THEN nonconformist ELSE FORESTRY END;
+```
+
+4. Adding backslash:
+
+```bash
+$ clickhouse-format --backslash <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
+```
+
+Result:
+
+```text
+SELECT * \
+FROM  \
+( \
+    SELECT 1 AS x \
+    UNION ALL \
+    SELECT 1 \
+    UNION DISTINCT \
+    SELECT 3 \
+)
+``` 

docs/en/operations/utilities/index.md

@@ -9,5 +9,8 @@ toc_title: Overview
 -   [clickhouse-local](../../operations/utilities/clickhouse-local.md) — Allows running SQL queries on data without stopping the ClickHouse server, similar to how `awk` does this.
 -   [clickhouse-copier](../../operations/utilities/clickhouse-copier.md) — Copies (and reshards) data from one cluster to another cluster.
 -   [clickhouse-benchmark](../../operations/utilities/clickhouse-benchmark.md) — Loads server with the custom queries and settings.
+-   [clickhouse-format](../../operations/utilities/clickhouse-format.md) — Enables formatting input queries.
+-   [ClickHouse obfuscator](../../operations/utilities/clickhouse-obfuscator.md) — Obfuscates data.
+-   [ClickHouse compressor](../../operations/utilities/clickhouse-compressor.md) — Compresses and decompresses data.
+-   [clickhouse-odbc-bridge](../../operations/utilities/odbc-bridge.md) — A proxy server for ODBC driver.
 
-[Original article](https://clickhouse.tech/docs/en/operations/utils/) <!--hide-->

docs/ru/operations/settings/settings.md

@@ -2757,12 +2757,12 @@ SELECT * FROM test2;
 
 ## prefer_column_name_to_alias {#prefer-column-name-to-alias}
 
-Включает или отключает замену названий столбцов на синонимы в выражениях и секциях запросов, см. [Примечания по использованию синонимов](../../sql-reference/syntax.md#syntax-expression_aliases). Включите эту настройку, чтобы синтаксис синонимов в ClickHouse был более совместим с большинством других СУБД.
+Включает или отключает замену названий столбцов на псевдонимы (alias) в выражениях и секциях запросов, см. [Примечания по использованию синонимов](../../sql-reference/syntax.md#syntax-expression_aliases). Включите эту настройку, чтобы синтаксис псевдонимов в ClickHouse был более совместим с большинством других СУБД.
 
 Возможные значения:
 
-- 0 — синоним подставляется вместо имени столбца.
-- 1 — синоним не подставляется вместо имени столбца.
+- 0 — псевдоним подставляется вместо имени столбца.
+- 1 — псевдоним не подставляется вместо имени столбца.
 
 Значение по умолчанию: `0`.
 

docs/ru/operations/utilities/clickhouse-compressor.md

@@ -0,0 +1,27 @@
+## ClickHouse compressor
+
+Simple program for data compression and decompression in ClickHouse way.
+
+### Examples
+
+Compress data with LZ4:
+```
+$ ./clickhouse-compressor < input_file > output_file
+```
+
+Decompress data from LZ4 format:
+```
+$ ./clickhouse-compressor --decompress < input_file > output_file
+```
+
+Compress data with ZSTD at level 5:
+
+```
+$ ./clickhouse-compressor --codec 'ZSTD(5)' < input_file > output_file
+```
+
+Compress data with Delta of four bytes and ZSTD level 10.
+
+```
+$ ./clickhouse-compressor --codec 'Delta(4)' --codec 'ZSTD(10)' < input_file > output_file
+```

docs/ru/operations/utilities/clickhouse-format.md

@@ -0,0 +1,98 @@
+---
+toc_priority: 65
+toc_title: clickhouse-format
+---
+
+# clickhouse-format {#clickhouse-format}
+
+Позволяет форматировать входящие запросы.
+
+Ключи:
+
+- `--help` или`-h` — выводит описание ключей.
+- `--hilite` — добавляет подсветку синтаксиса с экранированием символов.
+- `--oneline` — форматирование в одну строку.
+- `--quiet` или `-q` — проверяет синтаксис без вывода результата.
+- `--multiquery` or `-n` — поддерживает несколько запросов в одной строке.
+- `--obfuscate` — обфусцирует вместо форматирования.
+- `--seed <строка>` — задает строку, которая определяет результат обфускации.
+- `--backslash` — добавляет обратный слеш в конце каждой строки отформатированного запроса. Удобно использовать если многострочный запрос скопирован из интернета или другого источника и его нужно выполнить из командной строки.
+
+## Примеры {#examples} 
+
+1. Подсветка синтаксиса и форматирование в одну строку:
+
+```bash
+$ clickhouse-format --oneline --hilite <<< "SELECT sum(number) FROM numbers(5);"
+```
+
+Результат:
+
+```sql
+SELECT sum(number) FROM numbers(5)
+```
+
+2. Несколько запросов в одной строке: 
+
+```bash
+$ clickhouse-format -n <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
+```
+
+Результат:
+
+```text
+SELECT *
+FROM
+(
+    SELECT 1 AS x
+    UNION ALL
+    SELECT 1
+    UNION DISTINCT
+    SELECT 3
+)
+;
+```
+
+3. Обфускация:
+
+```bash
+$ clickhouse-format --seed Hello --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
+```
+
+Результат:
+
+```text
+SELECT treasury_mammoth_hazelnut BETWEEN nutmeg AND span, CASE WHEN chive >= 116 THEN switching ELSE ANYTHING END;
+```
+
+Тот же запрос с другой инициализацией обфускатора:
+
+```bash
+$ clickhouse-format --seed World --obfuscate <<< "SELECT cost_first_screen BETWEEN a AND b, CASE WHEN x >= 123 THEN y ELSE NULL END;"
+```
+
+Результат:
+
+```text
+SELECT horse_tape_summer BETWEEN folklore AND moccasins, CASE WHEN intestine >= 116 THEN nonconformist ELSE FORESTRY END;
+```
+
+4. Добавление обратного слеша:
+
+```bash
+$ clickhouse-format --backslash <<< "SELECT * FROM (SELECT 1 AS x UNION ALL SELECT 1 UNION DISTINCT SELECT 3);"
+```
+
+Результат:
+
+```text
+SELECT * \
+FROM  \
+( \
+    SELECT 1 AS x \
+    UNION ALL \
+    SELECT 1 \
+    UNION DISTINCT \
+    SELECT 3 \
+)
+``` 

docs/ru/operations/utilities/index.md

@@ -6,6 +6,10 @@ toc_title: "Обзор"
 
 # Утилиты ClickHouse {#utility-clickhouse}
 
--   [clickhouse-local](clickhouse-local.md)
+-   [clickhouse-local](clickhouse-local.md) - позволяет выполнять SQL-запросы над данными без остановки сервера ClickHouse, подобно утилите `awk`.
 -   [clickhouse-copier](clickhouse-copier.md) - копирует (и перешардирует) данные с одного кластера на другой.
-
+-   [clickhouse-benchmark](../../operations/utilities/clickhouse-benchmark.md) — устанавливает соединение с сервером ClickHouse и запускает циклическое выполнение указанных запросов.
+-   [clickhouse-format](../../operations/utilities/clickhouse-format.md) — позволяет форматировать входящие запросы.
+-   [ClickHouse obfuscator](../../operations/utilities/clickhouse-obfuscator.md) — обфусцирует данные.
+-   [ClickHouse compressor](../../operations/utilities/clickhouse-compressor.md) — упаковывает и распаковывает данные.
+-   [clickhouse-odbc-bridge](../../operations/utilities/odbc-bridge.md) — прокси-сервер для ODBC.

docs/ru/operations/utilities/odbc-bridge.md

@@ -0,0 +1,38 @@
+# clickhouse-odbc-bridge
+
+Simple HTTP-server which works like a proxy for ODBC driver. The main motivation
+was possible segfaults or another faults in ODBC implementations, which can
+crash whole clickhouse-server process.
+
+This tool works via HTTP, not via pipes, shared memory, or TCP because:
+- It's simpler to implement
+- It's simpler to debug
+- jdbc-bridge can be implemented in the same way
+
+## Usage
+
+`clickhouse-server` use this tool inside odbc table function and StorageODBC.
+However it can be used as standalone tool from command line with the following
+parameters in POST-request URL:
+- `connection_string` -- ODBC connection string.
+- `columns` -- columns in ClickHouse NamesAndTypesList format, name in backticks,
+  type as string. Name and type are space separated, rows separated with
+  newline.
+- `max_block_size` -- optional parameter, sets maximum size of single block.
+Query is send in post body. Response is returned in RowBinary format.
+
+## Example:
+
+```bash
+$ clickhouse-odbc-bridge --http-port 9018 --daemon
+
+$ curl -d "query=SELECT PageID, ImpID, AdType FROM Keys ORDER BY PageID, ImpID" --data-urlencode "connection_string=DSN=ClickHouse;DATABASE=stat" --data-urlencode "columns=columns format version: 1
+3 columns:
+\`PageID\` String
+\`ImpID\` String
+\`AdType\` String
+"  "http://localhost:9018/" > result.txt
+
+$ cat result.txt # Result in RowBinary format
+12246623837185725195925621517
+```