Ii} S SK r S SKJr S SKJr S SKJr S SKrS SKJr SSK J
r
J r SSK J
r
Jr SS KJr SS
KJr SS KJr SS KJrJrJrJr SS
KJr SSK J r J r J r " S S\ 5 r!g) N)deque)contextmanager)time)urlparse )errorsdefines)ColumnOrientedBlockRowOrientedBlock)
Connection) log_block)ServerPacketTypes)IterQueryResultProgressQueryResult QueryResult QueryInfo)
escape_params)
column_chunkschunks parse_urlc f ^ \ rS rSrSrSrU 4S jrS rS rS r S r
S r S
r S%S jr
S&S jrS
rS rS rS rS r\S 5 r S'S jr S'S jr S(S jr S)S jr S*S jr S+S jr S+S jr S,S jr S-S jr S r S.S jr S r!S r"S r#S&S! jr$S" r%\&S# 5 r'S$r(U =r)$ )/Client a
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 (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.
The following keys when passed in ``settings`` are used for configuring the
client itself:
* ``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*.
* ``opentelemetry_traceparent`` -- OpenTelemetry traceparent header as
described by W3C Trace Context recommendation.
New in version *0.2.2*.
* ``opentelemetry_tracestate`` -- OpenTelemetry tracestate header as
described by W3C Trace Context recommendation.
New in version *0.2.2*.
* ``quota_key`` -- A string to differentiate quotas when the user have
keyed quotas configured on server.
New in version *0.2.3*.
* ``input_format_null_as_default`` -- Initialize null fields with
default values if data type of this field is not
nullable. Does not work for NumPy. Default: False.
New in version *0.2.4*.
* ``round_robin`` -- If ``alt_hosts`` are provided the query will be
executed on host picked with round-robin algorithm.
New in version *0.2.5*.
* ``namedtuple_as_json`` -- Controls named tuple and nested types
deserialization. To interpret these column alongside
with ``allow_experimental_object_type=1`` as Python
tuple set ``namedtuple_as_json`` to ``False``.
Default: True.
New in version *0.2.6*.
* ``server_side_params`` -- Species on which side query parameters
should be rendered into placeholders.
Default: False. Means that parameters are rendered
on driver's side.
New in version *0.2.7*.
insert_block_sizestrings_as_bytesstrings_encoding use_numpyopentelemetry_traceparentopentelemetry_tracestate quota_key input_format_null_as_defaultnamedtuple_as_jsonserver_side_paramsc
l > UR SS 5 =( d 0 R 5 U l [ U R R S[ R
5 5 U R R SS5 U R R S[ R 5 U R R SS5 U R R SS 5 U R R SS 5 U R R S
S 5 U R R S S5 U R R S S
5 U R R SS5 S.
U l U R S ( a SSKJ nJ
nJ n XPl X0l
X@l O![" U l [$ U l
[& U l UR SS5 n[) [+ U0 UD6/5 U l U( a SU; a UR S5 nUR/ S5 H n[1 SU- 5 n UR 5 n
[3 U5 n U S: a U R4 U R6 4USS - n OQU S: a# U R4 4USS - n U R6 U
S' O([9 5 n U R4 U
S' U R6 U
S' [+ U 0 U
D6n
U R, R; U
5 M U R= 5 U l U RA 5 [B [D U ] 5 g ! [ a [! S5 ef = f)Nsettingsr r Fr r r r r! r" r# Tr$ r r )NumpyIterQueryResultNumpyProgressQueryResultNumpyQueryResult"Extras for NumPy must be installed round_robin alt_hosts,z
clickhouse:// porthost)$popcopyr& intr DEFAULT_INSERT_BLOCK_SIZESTRINGS_ENCODINGclient_settings numpy.resultr( r) r* query_result_clsiter_query_result_clsprogress_query_result_cls ImportError RuntimeErrorr r r r r connectionssplitr lenhostnamer0 tupleappendget_connection
connectionreset_last_querysuperr __init__)selfargskwargsr( r) r* r, r- r1 urlconnection_kwargsnum_argsconnection_argsrE __class__s >/venv/lib/python3.13/site-packages/clickhouse_driver/client.pyrH Client.__init__U s J5;AAC
"%T]]%6%6#W%F%F& " !%
1 1"E! !%
1 1"G$<$<! **U *. ):):+T* )-
(9(9*B) **R -1MM,=,=.- #'--"3"3$d# #'--"3"3$e#9
B ,
I )9%-A*1I. %0D !)8D &-@D * jj 6 *d"=f"=!>? ;&0
;/I!, 56$*KKM! t9q='*||SXX&>ab&IO ]'*||&6ab&AO03%f- ',gO03 %f-03%f- ' N rC rE popleftr& contextr7 rI rE s rQ rD Client.get_connection sg 4 & & # #DOO 4%%--/
&*mm
#-1-A-A
*rY c j U R 5 U R H nUR 5 M g rT )disconnect_connectionr> r[ re s rQ r[ Client.disconnect s* ""$ **J ! ! # +rY c X U R R 5 U R 5 g)z
Disconnects from the server.
N)rE r[ rF rV s rQ rh Client.disconnect_connection s
""$ rY c S U l g rT )
last_queryrV s rQ rF Client.reset_last_query s rY c U R 5 nU( a U R XAUS9$ U R XAUS9nUR 5 $ )Nwith_column_typescolumnar)packet_generatorr; r9
get_result)rI rq progressrr genresults rQ receive_resultClient.receive_result s_ ##% 118 2
**8 + F $$& &rY c # v # U R 5 nU R X!S9nU H nU H nUv M M g 7fNrq )rs r: )rI rq rv rw rowsrows rQ iter_receive_resultClient.iter_receive_result sF ##%++ ,
D s 79c # # U R 5 nU( d g USL a M! Uv M& ! [ [ 4 a U R 5 e f = f7f)NT)receive_packet ExceptionKeyboardInterruptr[ rI packets rQ rs Client.packet_generator sX
,,. T> 01
!
s+ A* A* A* A"A Ac U R R 5 nUR [ R :X a UR
eUR [ R :X a' U R R UR 5 U$ UR [ R :X a gUR [ R :X a U$ UR [ R :X a U$ UR [ R :X a U$ UR [ R :X a& U R R UR 5 gg)NFT)rE r typer EXCEPTION exceptionPROGRESSrm store_progressru
END_OF_STREAMDATATOTALSEXTREMES PROFILE_INFO
store_profile profile_infor s rQ r Client.receive_packet s //1 ;;+55 5"" "
[[ - 6 6
6 OO * *6?? ;M
[[ - ; ;
;
[[ - 2 2
2M
[[ - 4 4
4M
[[ - 6 6
6M
[[ - : :
: OO ) )&*=*= > rY c x [ U=( d 0 5 nU R R 5 nU R H nX1; d M
UR U5 X#' M X R
R l U R R 5 nUR U5 X@R
R l g rT ) dictr7 r3 available_client_settingsr2 rE rd r& update)rI r& r7 keyquery_settingss rQ make_query_settingsClient.make_query_settings s B' ..33511C'/||C'8$ 2 3B / ++- h'+9 (rY c UR S5 nUR 5 R S5 ( a# USS R 5 U R l g g )Nz; zuse )striplower
startswithrE database)rI querys rQ track_current_database Client.track_current_database sE D! ;;= # #F + +',QRy'8DOO $ ,rY c [ U R 5 n[ U S5 ( a US-
n[ U5 HS n U R 5 U l U R
U5 U R
R 5 [ 5 U l g g ! [ R [ R 4 a
X2S-
: a M e f = f)NrE r )
r@ r> rb rangerD rE r
force_connectr rm r SocketTimeoutError NetworkError)rI r& num_connectionsis rQ establish_connectionClient.establish_connection# s d . ./ 4 & & q O'A
"&"5"5"7((2--/"++
( --v/B/BC
**
s AB,C >C c # # U R U5 S U R R l S v U R U5 g ! [
[ 4 a U R 5 e f = f7frT )r rE server_infosession_timezoner r r r[ )rI r r& s rQ disconnect_on_errorClient.disconnect_on_error6 s\
% %h /;?DOO ' ' 8 ' ' .,- OO s A+AA A+"A((A+c b [ 5 n U R X5 [ U[ [ [
R 45 n
U
( a U R XUXWUS9n OU R XUUXWUS9n U R R [ 5 U -
5 U sSSS5 $ ! , ( d f g= f)az
Executes query.
Establishes new connection if it wasn't established yet.
After query execution connection remains intact for next queries.
If connection can't be reused it will be closed and new connection will
be created.
:param query: query that will be send to server.
:param params: substitution parameters for SELECT queries and data for
INSERT queries. Data for INSERT can be `list`, `tuple`
or :data:`~types.GeneratorType`.
Defaults to ``None`` (no parameters or data).
:param with_column_types: if specified column names and types will be
returned alongside with result.
Defaults to ``False``.
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:param types_check: enables type checking of data for INSERT queries.
Causes additional overhead. Defaults to ``False``.
:param columnar: if specified the result of the SELECT query will be
returned in column-oriented form.
It also allows to INSERT data in columnar form.
Defaults to ``False`` (row-like form).
:return: * number of inserted rows for INSERT queries with data.
Returning rows count from INSERT FROM SELECT is not
supported.
* if `with_column_types=False`: `list` of `tuples` with
rows/columns.
* if `with_column_types=True`: `tuple` of 2 elements:
* The first element is `list` of `tuples` with
rows/columns.
* The second element information is about columns: names
and types.
)external_tablesquery_id types_checkrr paramsrq r r r rr N) r r
isinstancelistrB types
GeneratorTypeprocess_insert_queryprocess_ordinary_queryrm
store_elapsed) rI r r rq r r r& r rr
start_time is_insertrvs rQ executeClient.executeD s X V
%
%e
6 #6D%9L9L+MNI..? % % / 00' 7
6
6s A:B
B.c ~ U R X5 U R XUXEXxS9sSSS5 $ ! , ( d f g= f)a
Executes SELECT query with progress information.
See, :ref:`execute-with-progress`.
:param query: query that will be send to server.
:param params: substitution parameters for SELECT queries and data for
INSERT queries. Data for INSERT can be `list`, `tuple`
or :data:`~types.GeneratorType`.
Defaults to ``None`` (no parameters or data).
:param with_column_types: if specified column names and types will be
returned alongside with result.
Defaults to ``False``.
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:param types_check: enables type checking of data for INSERT queries.
Causes additional overhead. Defaults to ``False``.
:param columnar: if specified the result will be returned in
column-oriented form.
Defaults to ``False`` (row-like form).
:return: :ref:`progress-query-result` proxy.
r N)r $process_ordinary_query_with_progress) rI r r rq r r r& r rr s rQ execute_with_progress Client.execute_with_progress s= <
%
%e
6<<8I / ' = 7
6
6s .
<c
U R X5 U R XUUXWS9n US: a [ X5 OU sSSS5 $ ! , ( d f g= f)aw
*New in version 0.0.14.*
Executes SELECT query with results streaming. See, :ref:`execute-iter`.
:param query: query that will be send to server.
:param params: substitution parameters for SELECT queries and data for
INSERT queries. Data for INSERT can be `list`, `tuple`
or :data:`~types.GeneratorType`.
Defaults to ``None`` (no parameters or data).
:param with_column_types: if specified column names and types will be
returned alongside with result.
Defaults to ``False``.
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:param types_check: enables type checking of data for INSERT queries.
Causes additional overhead. Defaults to ``False``.
:param chunk_size: chunk query results.
:return: :ref:`iter-query-result` proxy.
)r rq r r r r N)r iter_process_ordinary_queryr )
rI r r rq r r r& r
chunk_sizer s
rQ execute_iterClient.execute_iter sQ 8
%
%e
6118I /! 2 B
.8!^6")
7
6
6s %A
Ac
r SSK nU R USSUX4US9u pU V
V s/ s H u pU
PM n n
n U( a( U V s/ s H n [ R
" SSU 5 PM n n UR
[ X5 V
Vs0 s H u pX_M snn
U S9$ ! [ a [ S5 ef = fs sn n
f s sn f s snn
f ) a
*New in version 0.2.0.*
Queries DataFrame with specified SELECT query.
:param query: query that will be send to server.
:param params: substitution parameters.
Defaults to ``None`` (no parameters or data).
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:param replace_nonwords: boolean to replace non-words in column names
to underscores. Defaults to ``True``.
:return: pandas DataFrame.
r Nr+ T)rr rq r r r r& z\W_)columns)pandasr< r= r resub DataFramezip)rI r r r r r& replace_nonwordspddatar nametype_xdcols rQ query_dataframeClient.query_dataframe s , E DD + %
,337KD473 6=>grvveS!,gG>||"%d"4 5"4SV"4 5w
E CD D E 4>
6s B B("B.:B3
B%c SSK n[ 5 nU R X5 U R
R
XS9 U R
R U5 U R 5 nSn U( a UR V
s/ s H oS PM n n
[ U 5 [ UR 5 -
n [ U 5 ( a% Sn
[ U
R [ U 5 5 5 eU Vs/ s H oU R PM nnU R# XSS9n U R% 5 U R& R) [ 5 U-
5 U sSSS5 $ ! [ a [ S5 ef = fs sn
f s snf ! , ( d f g= f)a
*New in version 0.2.0.*
Inserts pandas DataFrame with specified query.
:param query: query that will be send to server.
:param dataframe: pandas DataFrame.
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:return: number of inserted rows.
r Nr+ r z&DataFrame missing required columns: {}T)rr )r r< r= r r rE
send_querysend_external_tablesreceive_sample_blockcolumns_with_typessetr r@
ValueErrorformatr values send_datareceive_end_of_queryrm r )rI r dataframer r r& r r sample_blockr r r diffmsgcolumnr s rQ insert_dataframeClient.insert_dataframe sN & E V
%
%e
6 OO & &u & @ OO 0 0 A 446LB)5)H)HI)HAQ4)HI7|c)*;*;&<<t99BC$SZZT
%;<' 7
6 E CD D E J H 7
6s7 E A E5=E+ A E5'E0?A E5E(+
E55
Fc Ub& U R XU R R 5 nU R R XUS9 U R R UUS9 U R USUS9$ )Nr r r T)rq ru rr substitute_paramsrE rd r r rx rI r r rq r r r rr s rQ r +Client.process_ordinary_query_with_progress( s
**t 6 6E
""5F"K ,,_9D - F""5F,08 # E ErY c Ub& U R XU R R 5 nU R R XUS9 U R R UUS9 U R UUS9$ )Nr r rp r r s rQ r Client.process_ordinary_query8 s}
**t 6 6E
""5F"K ,,_9D - F""5F,4 # 6 6rY c Ub& U R XU R R 5 nU R R XUS9 U R R UUS9 U R US9$ )Nr r r| )r rE rd r r r )rI r r rq r r r s rQ r "Client.iter_process_ordinary_queryG st
**t 6 6E
""5F"K ,,_9D - F'':K'LLrY c U R R XS9 U R R UUS9 U R 5 nU( a" U R XrXVS9nU R 5 U$ g )Nr r )r rr )rE r r r r receive_end_of_insert_query) rI query_without_datar r r r rr r r s rQ r Client.process_insert_queryV sw
""#5"I ,,_9D - F002 ,7 LB , , .I rY c U R R 5 nUR [ R :X a UR
$ UR [ R :X a UR eUR [ R :X a [ UR
5 O[UR [ R :X a O C> >Dc U R R 5 nUR [ R :X a g UR [ R
:X a& U R R UR 5 OUR [ R :X a UR eUR [ R :X a [ UR 5 OUR [ R :X a OUR [ R :X a& U R R! UR" 5 O >>--f.A.AB 1 : ::..v? 1 5 55&,,' 1 ; ;; &&& 1 A AA //CC%&,kk < r: rm r; r9 r& )FFF)F)NFNNNFF)NFNNNFr )NNNNT)NNN)NFNNFF)NFNNF)NNFF)FF)*__name__
__module__ __qualname____firstlineno____doc__r rH rW r_ rD r[ rh rF rx r rs r r r r r r r r r r r r r r r r r r r r r$ r classmethodr+ __static_attributes__
__classcell__)rP s @rQ r r sK 1f ! P'd$
@E %' :: 9
& =B>B,1AH 9>:>(-#L 9>:>*+"DJ FJ,0'
T DH-` 9>+/(-E" 9>+/(-
6 9>+/
M =A9> F,& PF:F, FDH 6 # #rY r )"r collectionsr
contextlibr r r urllib.parser r' r r r r
r rE r logr
protocolr rw r r r r util.escaper util.helpersr r r objectr rU rY rQ r= sI % ! 8 " ' ' : :X #V X #rY