thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-21 23:21:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

add query params info to English grpc docs

Browse Source
This commit is contained in:
Attila Szakacs 2024-10-26 18:01:29 +02:00
parent d3863606cc
commit 72325abc8e
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/en/interfaces/grpc.md
View File

@ -14,6 +14,7 @@ ClickHouse supports [gRPC](https://grpc.io/) interface. It is an open source rem
- authentication;
- sessions;
- compression;
- query parameters;
- parallel queries through the same channel;
- cancellation of queries;
- getting progress and logs;
@ -21,6 +22,14 @@ ClickHouse supports [gRPC](https://grpc.io/) interface. It is an open source rem
The specification of the interface is described in [clickhouse_grpc.proto](https://github.com/ClickHouse/ClickHouse/blob/master/src/Server/grpc_protos/clickhouse_grpc.proto).
Query parameters can be set in the Metadata fields of the Client Context, with `param_` prefix for the key, for example:
```py
[
("param_table", "my_table"),
("param_column", "my_column"),
]
```
## gRPC Configuration {#grpc-interface-configuration}
To use the gRPC interface set `grpc_port` in the main [server configuration](../operations/configuration-files.md). Other configuration options see in the following example:
@ -72,6 +81,7 @@ The client supports the following arguments:
- `--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). Default value for interactive mode: `PrettyCompact`.
- `--param PARAM` – Query parameters in `key=value` format. Can be used multiple times.
- `--debug` – Enables showing debug information.
To run the client in an interactive mode call it without `--query` argument.