1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
import getpass
import sys
from dataclasses import dataclass
from typing import Any, Sequence, Optional, Dict
from clickhouse_connect import __version__
from clickhouse_connect.driver.exceptions import ProgrammingError
def version():
return __version__.version
def format_error(msg: str) -> str:
max_size = _common_settings['max_error_size'].value
if max_size:
return msg[:max_size]
return msg
@dataclass
class CommonSetting:
name: str
options: Sequence[Any]
default: Any
value: Optional[Any] = None
_common_settings: Dict[str, CommonSetting] = {}
def build_client_name(client_name: str):
product_name = get_setting('product_name')
product_name = product_name.strip() + ' ' if product_name else ''
client_name = client_name.strip() + ' ' if client_name else ''
py_version = sys.version.split(' ', maxsplit=1)[0]
os_user = ''
if get_setting('send_os_user'):
try:
os_user = f'; os_user:{getpass.getuser()}'
except Exception: # pylint: disable=broad-except
pass
return (f'{client_name}{product_name}clickhouse-connect/{version()}' +
f' (lv:py/{py_version}; mode:sync; os:{sys.platform}{os_user})')
def get_setting(name: str):
setting = _common_settings.get(name)
if setting is None:
raise ProgrammingError(f'Unrecognized common setting {name}')
return setting.value if setting.value is not None else setting.default
def set_setting(name: str, value: Any):
setting = _common_settings.get(name)
if setting is None:
raise ProgrammingError(f'Unrecognized common setting {name}')
if setting.options and value not in setting.options:
raise ProgrammingError(f'Unrecognized option {value} for setting {name})')
if value == setting.default:
setting.value = None
else:
setting.value = value
def _init_common(name: str, options: Sequence[Any], default: Any):
_common_settings[name] = CommonSetting(name, options, default)
_init_common('autogenerate_session_id', (True, False), True)
_init_common('dict_parameter_format', ('json', 'map'), 'json')
_init_common('invalid_setting_action', ('send', 'drop', 'error'), 'error')
_init_common('max_connection_age', (), 10 * 60) # Max time in seconds to keep reusing a database TCP connection
_init_common('product_name', (), '') # Product name used as part of client identification for ClickHouse query_log
_init_common('readonly', (0, 1), 0) # Implied "read_only" ClickHouse settings for versions prior to 19.17
_init_common('send_os_user', (True, False), True)
# Use the client protocol version This is needed for DateTime timezone columns but breaks with current version of
# chproxy
_init_common('use_protocol_version', (True, False), True)
_init_common('max_error_size', (), 1024)
# HTTP raw data buffer for streaming queries. This should not be reduced below 64KB to ensure compatibility with LZ4 compression
_init_common('http_buffer_size', (), 10 * 1024 * 1024)
|
