From db6bbab53ffe1a033042351f4838f0a509e6726b Mon Sep 17 00:00:00 2001 From: Marco Baringer Date: Tue, 2 Mar 2021 14:23:45 +0100 Subject: [PATCH 1/2] update link to clickhouse docs' settings page --- clickhouse_driver/client.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clickhouse_driver/client.py b/clickhouse_driver/client.py index 7e4bfeb7..e7396211 100644 --- a/clickhouse_driver/client.py +++ b/clickhouse_driver/client.py @@ -24,7 +24,7 @@ class Client(object): :param settings: Dictionary of settings that passed to every query. Defaults to ``None`` (no additional settings). See all available settings in `ClickHouse docs - `_. + `_. Driver's settings: From 85e8ffbb59b036093e90d6a94581b66b7ff4b05f Mon Sep 17 00:00:00 2001 From: Marco Baringer Date: Tue, 2 Mar 2021 14:16:55 +0100 Subject: [PATCH 2/2] Link to `Connection` in `Client`'s docstring so we know where to pass host/port values. --- clickhouse_driver/client.py | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/clickhouse_driver/client.py b/clickhouse_driver/client.py index e7396211..4f4fc5c9 100644 --- a/clickhouse_driver/client.py +++ b/clickhouse_driver/client.py @@ -21,21 +21,24 @@ class Client(object): Client for communication with the ClickHouse server. Single connection is established per each connected instance of the client. - :param settings: Dictionary of settings that passed to every query. - Defaults to ``None`` (no additional settings). See all - available settings in `ClickHouse docs + :param settings: Dictionary of settings that passed to every query (except + for the client settings, see below). Defaults to ``None`` + (no additional settings). See all available settings in + `ClickHouse docs `_. + :param \\**kwargs: All other args are passed to the + :py:class:`~clickhouse_driver.connection.Connection` + constructor. - Driver's settings: + The following keys when passed in ``settings`` are used for configuring the + client itself: - * insert_block_size -- chunk size to split rows for ``INSERT``. + * ``insert_block_size`` -- chunk size to split rows for ``INSERT``. Defaults to ``1048576``. - - * strings_as_bytes -- turns off string column encoding/decoding. - - * strings_encoding -- specifies string encoding. UTF-8 by default. - - * use_numpy -- Use numpy for columns reading. New in version *0.2.0*. + * ``strings_as_bytes`` -- turns off string column encoding/decoding. + * ``strings_encoding`` -- specifies string encoding. UTF-8 by default. + * ``use_numpy`` -- Use numpy for columns reading. New in version + *0.2.0*. """