Skip to content

Commit cb157ed

Browse files
revert docstring changes
1 parent 478060d commit cb157ed

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

clickhouse_connect/driver/asyncclient.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -518,9 +518,7 @@ def create_query_context(self,
518518
Creates or updates a reusable QueryContext object
519519
:param query: Query statement/format string
520520
:param parameters: Optional dictionary used to format the query
521-
:param settings: Optional dictionary of ClickHouse settings (key/string values). This includes both
522-
server settings (e.g., max_threads, max_memory_usage) and HTTP interface parameters (e.g., query_id,
523-
session_id, database). All settings are sent as URL query parameters.
521+
:param settings: Optional dictionary of ClickHouse settings (key/string values)
524522
:param query_formats: See QueryContext __init__ docstring
525523
:param column_formats: See QueryContext __init__ docstring
526524
:param encoding: See QueryContext __init__ docstring
@@ -545,9 +543,7 @@ def create_query_context(self,
545543
:param use_extended_dtypes: Only relevant to Pandas Dataframe queries. Use Pandas "missing types", such as
546544
pandas.NA and pandas.NaT for ClickHouse NULL values, as well as extended Pandas dtypes such as IntegerArray
547545
and StringArray. Defaulted to True for query_df methods
548-
:param transport_settings: Optional dictionary of transport level settings sent as HTTP headers. Use this for
549-
custom headers (e.g., X-Workload) for load balancers or proxies. ClickHouse parameters like query_id should
550-
go in the settings dict, not here.
546+
:param transport_settings: Optional dictionary of transport level settings (HTTP headers, etc.)
551547
:return: Reusable QueryContext
552548
"""
553549

clickhouse_connect/driver/client.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -473,9 +473,7 @@ def create_query_context(self,
473473
Creates or updates a reusable QueryContext object
474474
:param query: Query statement/format string
475475
:param parameters: Optional dictionary used to format the query
476-
:param settings: Optional dictionary of ClickHouse settings (key/string values). This includes both
477-
server settings (e.g., max_threads, max_memory_usage) and HTTP interface parameters (e.g., query_id,
478-
session_id, database). All settings are sent as URL query parameters.
476+
:param settings: Optional dictionary of ClickHouse settings (key/string values)
479477
:param query_formats: See QueryContext __init__ docstring
480478
:param column_formats: See QueryContext __init__ docstring
481479
:param encoding: See QueryContext __init__ docstring
@@ -502,9 +500,7 @@ def create_query_context(self,
502500
:param use_extended_dtypes: Only relevant to Pandas Dataframe queries. Use Pandas "missing types", such as
503501
pandas.NA and pandas.NaT for ClickHouse NULL values, as well as extended Pandas dtypes such as IntegerArray
504502
and StringArray. Defaulted to True for query_df methods
505-
:param transport_settings: Optional dictionary of transport level settings sent as HTTP headers. Use this for
506-
custom headers (e.g., X-Workload) for load balancers or proxies. ClickHouse parameters like query_id should
507-
go in the settings dict, not here.
503+
:param transport_settings: Optional dictionary of transport level settings (HTTP headers, etc.)
508504
:return: Reusable QueryContext
509505
"""
510506
resolved_utc_tz_aware = self.utc_tz_aware if utc_tz_aware is None else utc_tz_aware

0 commit comments

Comments
 (0)