mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-09-20 08:40:50 +00:00
DOCAPI-7431: Queries with parameters docs. EN review. RU translation. (#6632)
* Update cli.md (#36) * Update http.md (#37) * DOCAPI-7431: RU Translation. * DOCAPI-7431: Fix. * Update docs/en/interfaces/cli.md Co-Authored-By: Ivan Blinkov <github@blinkov.ru> * DOCAPI-7431: Fixes.
This commit is contained in:
BayoNet
GitHub
parent
66203973f2
commit
9c0b377868
@ -67,22 +67,22 @@ The command-line client allows passing external data (external temporary tables)
|
||||
|
||||
### Queries with Parameters {#cli-queries-with-parameters}
|
||||
|
||||
You can create a query with parameters, and pass values for these parameters with the parameters of the client app. For example:
|
||||
You can create a query with parameters and pass values to them from client application. This allows to avoid formatting query with specific dynamic values on client side. For example:
|
||||
|
||||
```bash
|
||||
clickhouse-client --param_parName="[1, 2]" -q "SELECT * FROM table WHERE a = {parName:Array(UInt16)}"
|
||||
```
|
||||
|
||||
#### Syntax of a Query {#cli-queries-with-parameters-syntax}
|
||||
#### Query Syntax {#cli-queries-with-parameters-syntax}
|
||||
|
||||
Format a query by the standard method. Values that you want to put into the query from the app parameters place in braces and format as follows:
|
||||
Format a query as usual, then place the values that you want to pass from the app parameters to the query in braces in the following format:
|
||||
|
||||
```
|
||||
{<name>:<data type>}
|
||||
```
|
||||
|
||||
- `name` — Identifier of a placeholder that should be used in app parameter as `--param_name = value`.
|
||||
- `data type` — A data type of app parameter value. For example, data structure like `(integer, ('string', integer))` can have a data type `Tuple(UInt8, Tuple(String, UInt8))` (also you can use another [integer](../data_types/int_uint.md) types).
|
||||
- `name` — Placeholder identifier. In the console client it should be used in app parameters as `--param_<name> = value`.
|
||||
- `data type` — [Data type](../data_types/index.md) of the app parameter value. For example, a data structure like `(integer, ('string', integer))` can have the `Tuple(UInt8, Tuple(String, UInt8))` data type (you can also use another [integer](../data_types/int_uint.md) types).
|
||||
|
||||
#### Example
|
||||
|
||||
@ -118,6 +118,8 @@ You can pass parameters to `clickhouse-client` (all parameters have a default va
|
||||
- `--stacktrace` – If specified, also print the stack trace if an exception occurs.
|
||||
- `--config-file` – The name of the configuration file.
|
||||
- `--secure` – If specified, will connect to server over secure connection.
|
||||
- `--param_<name>` — Value for a [query with parameters](#cli-queries-with-parameters).
|
||||
|
||||
|
||||
### Configuration Files
|
||||
|
||||
|
||||
@ -246,7 +246,7 @@ Use buffering to avoid situations where a query processing error occurred after
|
||||
|
||||
### Queries with Parameters {#cli-queries-with-parameters}
|
||||
|
||||
You can create a query with parameters, and pass values for these parameters with the parameters of the HTTP request. For more information, see [CLI Formatted Queries](cli.md#cli-queries-with-parameters).
|
||||
You can create a query with parameters and pass values for them from the corresponding HTTP request parameters. For more information, see [Queries with Parameters for CLI](cli.md#cli-queries-with-parameters).
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@ -54,8 +54,7 @@ cat file.csv | clickhouse-client --database=test --query="INSERT INTO test FORMA
|
||||
|
||||
По умолчанию, в качестве формата, используется формат PrettyCompact (красивые таблички). Вы можете изменить формат с помощью секции FORMAT запроса, или с помощью указания `\G` на конце запроса, с помощью аргумента командной строки `--format` или `--vertical`, или с помощью конфигурационного файла клиента.
|
||||
|
||||
Чтобы выйти из клиента, нажмите Ctrl+D (или Ctrl+C), или наберите вместо запроса одно из:
|
||||
"exit", "quit", "logout", "учше", "йгше", "дщпщге", "exit;", "quit;", "logout;", "учшеж", "йгшеж", "дщпщгеж", "q", "й", "q", "Q", ":q", "й", "Й", "Жй"
|
||||
Чтобы выйти из клиента, нажмите Ctrl+D (или Ctrl+C), или наберите вместо запроса одно из: "exit", "quit", "logout", "учше", "йгше", "дщпщге", "exit;", "quit;", "logout;", "учшеж", "йгшеж", "дщпщгеж", "q", "й", "q", "Q", ":q", "й", "Й", "Жй"
|
||||
|
||||
При выполнении запроса, клиент показывает:
|
||||
|
||||
@ -68,38 +67,64 @@ cat file.csv | clickhouse-client --database=test --query="INSERT INTO test FORMA
|
||||
|
||||
Клиент командной строки позволяет передать внешние данные (внешние временные таблицы) для использования запроса. Подробнее смотрите раздел "Внешние данные для обработки запроса"
|
||||
|
||||
### Запросы с параметрами {#cli-queries-with-parameters}
|
||||
|
||||
Вы можете создать запрос с параметрами и передавать в них значения из приложения. Это позволяет избежать форматирования запросов на стороне клиента, если известно, какие из параметров запроса динамически меняются. Например:
|
||||
|
||||
```bash
|
||||
clickhouse-client --param_parName="[1, 2]" -q "SELECT * FROM table WHERE a = {parName:Array(UInt16)}"
|
||||
```
|
||||
|
||||
#### Cинтаксис запроса {#cli-queries-with-parameters-syntax}
|
||||
|
||||
Отформатируйте запрос обычным способом. Представьте значения, которые вы хотите передать из параметров приложения в запрос в следующем формате:
|
||||
|
||||
```
|
||||
{<name>:<data type>}
|
||||
```
|
||||
|
||||
- `name` — идентификатор подстановки. В консольном клиенте его следует использовать как часть имени параметра `--param_<name> = value`.
|
||||
- `data type` — [тип данных](../data_types/index.md) значения. Например, структура данных `(integer, ('string', integer))` может иметь тип данных `Tuple(UInt8, Tuple(String, UInt8))` ([целочисленный](../data_types/int_uint.md) тип может быть и другим).
|
||||
|
||||
#### Пример
|
||||
|
||||
```bash
|
||||
clickhouse-client --param_tuple_in_tuple="(10, ('dt', 10))" -q "SELECT * FROM table WHERE val = {tuple_in_tuple:Tuple(UInt8, Tuple(String, UInt8))}"
|
||||
```
|
||||
|
||||
## Конфигурирование {#interfaces_cli_configuration}
|
||||
|
||||
В `clickhouse-client` можно передавать различные параметры (все параметры имеют значения по умолчанию) с помощью:
|
||||
|
||||
- Командной строки.
|
||||
- Командной строки.
|
||||
|
||||
Параметры командной строки переопределяют значения по умолчанию и параметры конфигурационных файлов.
|
||||
|
||||
- Конфигурационных файлов.
|
||||
- Конфигурационных файлов.
|
||||
|
||||
Параметры в конфигурационных файлах переопределяют значения по умолчанию.
|
||||
|
||||
### Параметры командной строки
|
||||
|
||||
- `--host, -h` - имя сервера, по умолчанию - localhost. Вы можете использовать как имя, так и IPv4 или IPv6 адрес.
|
||||
- `--port` - порт, к которому соединяться, по умолчанию - 9000. Замечу, что для HTTP и родного интерфейса используются разные порты.
|
||||
- `--user, -u` - имя пользователя, по умолчанию - default.
|
||||
- `--password` - пароль, по умолчанию - пустая строка.
|
||||
- `--query, -q` - запрос для выполнения, при использовании в неинтерактивном режиме.
|
||||
- `--database, -d` - выбрать текущую БД, по умолчанию - текущая БД из настроек сервера (по умолчанию - БД default).
|
||||
- `--multiline, -m` - если указано - разрешить многострочные запросы, не отправлять запрос по нажатию Enter.
|
||||
- `--multiquery, -n` - если указано - разрешить выполнять несколько запросов, разделённых точкой с запятой. Работает только в неинтерактивном режиме.
|
||||
- `--format, -f` - использовать указанный формат по умолчанию для вывода результата.
|
||||
- `--vertical, -E` - если указано, использовать формат Vertical по умолчанию для вывода результата. То же самое, что --format=Vertical. В этом формате каждое значение выводится на отдельной строке, что удобно для отображения широких таблиц.
|
||||
- `--time, -t` - если указано, в неинтерактивном режиме вывести время выполнения запроса в stderr.
|
||||
- `--stacktrace` - если указано, в случае исключения, выводить также его стек трейс.
|
||||
- `--config-file` - имя конфигурационного файла.
|
||||
- `--secure` - если указано, будет использован безопасный канал.
|
||||
- `--host, -h` — имя сервера, по умолчанию — localhost. Вы можете использовать как имя, так и IPv4 или IPv6 адрес.
|
||||
- `--port` — порт, к которому соединяться, по умолчанию — 9000. Замечу, что для HTTP и родного интерфейса используются разные порты.
|
||||
- `--user, -u` — имя пользователя, по умолчанию — default.
|
||||
- `--password` — пароль, по умолчанию — пустая строка.
|
||||
- `--query, -q` — запрос для выполнения, при использовании в неинтерактивном режиме.
|
||||
- `--database, -d` — выбрать текущую БД, по умолчанию — текущая БД из настроек сервера (по умолчанию — БД default).
|
||||
- `--multiline, -m` — если указано — разрешить многострочные запросы, не отправлять запрос по нажатию Enter.
|
||||
- `--multiquery, -n` — если указано — разрешить выполнять несколько запросов, разделённых точкой с запятой. Работает только в неинтерактивном режиме.
|
||||
- `--format, -f` — использовать указанный формат по умолчанию для вывода результата.
|
||||
- `--vertical, -E` — если указано, использовать формат Vertical по умолчанию для вывода результата. То же самое, что --format=Vertical. В этом формате каждое значение выводится на отдельной строке, что удобно для отображения широких таблиц.
|
||||
- `--time, -t` — если указано, в неинтерактивном режиме вывести время выполнения запроса в stderr.
|
||||
- `--stacktrace` — если указано, в случае исключения, выводить также его стек трейс.
|
||||
- `--config-file` — имя конфигурационного файла.
|
||||
- `--secure` — если указано, будет использован безопасный канал.
|
||||
- `--param_<name>` — значение параметра для [запроса с параметрами](#cli-queries-with-parameters).
|
||||
|
||||
### Конфигурационные файлы
|
||||
|
||||
`clickhouse-client` использует первый существующий файл из:
|
||||
`clickhouse—client` использует первый существующий файл из:
|
||||
|
||||
- Определенного параметром `--config-file`.
|
||||
- `./clickhouse-client.xml`
|
||||
|
||||
@ -245,5 +245,15 @@ curl -sS 'http://localhost:8123/?max_result_bytes=4000000&buffer_size=3000000&wa
|
||||
|
||||
Буферизация позволяет избежать ситуации когда код ответа и HTTP-заголовки были отправлены клиенту, после чего возникла ошибка выполнения запроса. В такой ситуации сообщение об ошибке записывается в конце тела ответа, и на стороне клиента ошибка может быть обнаружена только на этапе парсинга.
|
||||
|
||||
### Запросы с параметрами {#cli-queries-with-parameters}
|
||||
|
||||
Можно создать запрос с параметрами и передать для них значения из соответствующих параметров HTTP-запроса. Дополнительную информацию смотрите в [Запросы с параметрами для консольного клиента](cli.md#cli-queries-with-parameters).
|
||||
|
||||
### Пример
|
||||
|
||||
```bash
|
||||
curl -sS "<address>?param_id=2¶m_phrase=test" -d "SELECT * FROM table WHERE int_column = {id:UInt8} and string_column = {phrase:String}"
|
||||
```
|
||||
|
||||
[Оригинальная статья](https://clickhouse.yandex/docs/ru/interfaces/http_interface/) <!--hide-->
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user