mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-21 15:12:02 +00:00
add query params info to English grpc docs
This commit is contained in:
parent
d3863606cc
commit
72325abc8e
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user