More default argument values

Actual interactive mode call conditions
This commit is contained in:
Alexey 2021-12-02 20:19:50 +00:00
parent 1b155c98ca
commit 6e27c9c625
2 changed files with 14 additions and 6 deletions

View File

@ -61,18 +61,22 @@ To use the gRPC interface set `grpc_port` in the main [server configuration](../
You can write a client in any of the programming languages supported by gRPC using the provided [specification](https://github.com/ClickHouse/ClickHouse/blob/master/src/Server/grpc_protos/clickhouse_grpc.proto)
Or you can use a built-in Python client. It is placed in [utils/grpc-client/clickhouse-grpc-client.py](https://github.com/ClickHouse/ClickHouse/blob/master/utils/grpc-client/clickhouse-grpc-client.py) in the repository. The built-in client requires [grpcio and grpcio-tools](https://grpc.io/docs/languages/python/quickstart) Python modules.
To run the client in an interactive mode call it without arguments. The client supports the following arguments:
The client supports the following arguments:
- `--help` Shows a help message and exits.
- `--host HOST, -h HOST` A server name. Default value: `localhost`. You can use IPv4 or IPv6 addresses also.
- `--port PORT` A port to connect to. This port should be enabled in the ClickHouse server configuration (see `grpc_port`).
- `--port PORT` A port to connect to. This port should be enabled in the ClickHouse server configuration (see `grpc_port`). Default value: `9100`.
- `--user USER_NAME, -u USER_NAME` A user name. Default value: `default`.
- `--password PASSWORD` A password. Default value: empty string.
- `--query QUERY, -q QUERY` A query to process when using non-interactive mode.
- `--database DATABASE, -d DATABASE` A default database. If not specified, the current database set in the server settings is used (`default` by default).
- `--format OUTPUT_FORMAT, -f OUTPUT_FORMAT` A result output [format](formats.md).
- `--format OUTPUT_FORMAT, -f OUTPUT_FORMAT` A result output [format](formats.md). Default value for interactive mode: `PrettyCompact`.
- `--debug` Enables showing debug information.
To run the client in an interactive mode call it without `--query` argument.
In a batch mode query data can be passed via `stdin`.
**Client Usage Example**
In the following example a table is created and loaded with data from a CSV file. Then the content of the table is queried.

View File

@ -61,18 +61,22 @@ ClickHouse поддерживает интерфейс [gRPC](https://grpc.io/).
Можно написать клиент на любом языке программирования, который поддерживается gRPC с использованием [спецификации](https://github.com/ClickHouse/ClickHouse/blob/master/src/Server/grpc_protos/clickhouse_grpc.proto)
Также можно воспользоваться встроенным Python клиентом. Он расположен в [utils/grpc-client/clickhouse-grpc-client.py](https://github.com/ClickHouse/ClickHouse/blob/master/utils/grpc-client/clickhouse-grpc-client.py) в репозитории. Для работы встроенного клиента требуются Python модули [grpcio и grpcio-tools](https://grpc.io/docs/languages/python/quickstart).
Чтобы запустить клиент в интерактивном режиме, вызовите его без аргументов. Клиент поддерживает аргументы:
Клиент поддерживает аргументы:
- `--help` вывести справку и завершить работу.
- `--host HOST, -h HOST` имя сервера. Значение по умолчанию: `localhost`. Можно задать адрес IPv4 или IPv6.
- `--port PORT` номер порта. Этот порт должен быть задан в конфигурации сервера ClickHouse настройкой `grpc_port`.
- `--port PORT` номер порта. Этот порт должен быть задан в конфигурации сервера ClickHouse настройкой `grpc_port`. Значение по умолчанию: `9100`
- `--user USER_NAME, -u USER_NAME` имя пользователя. Значение по умолчанию: `default`.
- `--password PASSWORD` пароль. Значение по умолчанию: пустая строка.
- `--query QUERY, -q QUERY` запрос, который нужно выполнить.
- `--database DATABASE, -d DATABASE` база данных по умолчанию. Если не указана, то будет использована база данных, заданная в настройках сервера (по умолчанию `default`).
- `--format OUTPUT_FORMAT, -f OUTPUT_FORMAT` [формат](formats.md) вывода результата.
- `--format OUTPUT_FORMAT, -f OUTPUT_FORMAT` [формат](formats.md) вывода результата. Значение по умолчанию для интерактивного режима: `PrettyCompact`.
- `--debug` вывод отладочной информации.
Чтобы запустить клиент в интерактивном режиме, не указывайте аргумент `--query`.
В пакетном режиме данные запроса можно передать через `stdin`.
**Пример использования клиента**
В примере создается таблица, и в нее загружаются данные из CSV файла. Затем выводится содержимое таблицы.