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 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
|
import logging
import socket
import ssl
from collections import deque
from contextlib import contextmanager
from time import time
from urllib.parse import urlparse
from . import defines
from . import errors
from .block import RowOrientedBlock
from .blockstreamprofileinfo import BlockStreamProfileInfo
from .bufferedreader import BufferedSocketReader
from .bufferedwriter import BufferedSocketWriter
from .clientinfo import ClientInfo
from .compression import get_compressor_cls
from .context import Context
from .log import log_block
from .progress import Progress
from .protocol import Compression, ClientPacketTypes, ServerPacketTypes
from .queryprocessingstage import QueryProcessingStage
from .reader import read_binary_str
from .readhelpers import read_exception
from .settings.writer import write_settings
from .streams.native import BlockInputStream, BlockOutputStream
from .util.compat import threading
from .varint import write_varint, read_varint
from .writer import write_binary_str
logger = logging.getLogger(__name__)
class Packet(object):
def __init__(self):
self.type = None
self.block = None
self.exception = None
self.progress = None
self.profile_info = None
self.multistring_message = None
super(Packet, self).__init__()
class ServerInfo(object):
def __init__(self, name, version_major, version_minor, version_patch,
revision, timezone, display_name):
self.name = name
self.version_major = version_major
self.version_minor = version_minor
self.version_patch = version_patch
self.revision = revision
self.timezone = timezone
self.display_name = display_name
super(ServerInfo, self).__init__()
def version_tuple(self):
return self.version_major, self.version_minor, self.version_patch
def __repr__(self):
version = '%s.%s.%s' % (
self.version_major, self.version_minor, self.version_patch
)
items = [
('name', self.name),
('version', version),
('revision', self.revision),
('timezone', self.timezone),
('display_name', self.display_name)
]
params = ', '.join('{}={}'.format(key, value) for key, value in items)
return '<ServerInfo(%s)>' % (params)
class Connection(object):
"""
Represents connection between client and ClickHouse server.
:param host: host with running ClickHouse server.
:param port: port ClickHouse server is bound to.
Defaults to ``9000`` if connection is not secured and
to ``9440`` if connection is secured.
:param database: database connect to. Defaults to ``'default'``.
:param user: database user. Defaults to ``'default'``.
:param password: user's password. Defaults to ``''`` (no password).
:param client_name: this name will appear in server logs.
Defaults to ``'python-driver'``.
:param connect_timeout: timeout for establishing connection.
Defaults to ``10`` seconds.
:param send_receive_timeout: timeout for sending and receiving data.
Defaults to ``300`` seconds.
:param sync_request_timeout: timeout for server ping.
Defaults to ``5`` seconds.
:param compress_block_size: size of compressed block to send.
Defaults to ``1048576``.
:param compression: specifies whether or not use compression.
Defaults to ``False``. Possible choices:
* ``True`` is equivalent to ``'lz4'``.
* ``'lz4'``.
* ``'lz4hc'`` high-compression variant of
``'lz4'``.
* ``'zstd'``.
:param secure: establish secure connection. Defaults to ``False``.
:param verify: specifies whether a certificate is required and whether it
will be validated after connection.
Defaults to ``True``.
:param ssl_version: see :func:`ssl.wrap_socket` docs.
:param ca_certs: see :func:`ssl.wrap_socket` docs.
:param ciphers: see :func:`ssl.wrap_socket` docs.
:param keyfile: see :func:`ssl.wrap_socket` docs.
:param certfile: see :func:`ssl.wrap_socket` docs.
:param server_hostname: Hostname to use in SSL Wrapper construction.
Defaults to `None` which will send the passed
host param during SSL initialization. This param
may be used when connecting over an SSH tunnel
to correctly identify the desired server via SNI.
:param alt_hosts: list of alternative hosts for connection.
Example: alt_hosts=host1:port1,host2:port2.
:param settings_is_important: ``False`` means unknown settings will be
ignored, ``True`` means that the query will
fail with UNKNOWN_SETTING error.
Defaults to ``False``.
"""
def __init__(
self, host, port=None,
database=defines.DEFAULT_DATABASE,
user=defines.DEFAULT_USER, password=defines.DEFAULT_PASSWORD,
client_name=defines.CLIENT_NAME,
connect_timeout=defines.DBMS_DEFAULT_CONNECT_TIMEOUT_SEC,
send_receive_timeout=defines.DBMS_DEFAULT_TIMEOUT_SEC,
sync_request_timeout=defines.DBMS_DEFAULT_SYNC_REQUEST_TIMEOUT_SEC,
compress_block_size=defines.DEFAULT_COMPRESS_BLOCK_SIZE,
compression=False,
secure=False,
# Secure socket parameters.
verify=True, ssl_version=None, ca_certs=None, ciphers=None,
keyfile=None, certfile=None,
server_hostname=None,
alt_hosts=None,
settings_is_important=False,
):
if secure:
default_port = defines.DEFAULT_SECURE_PORT
else:
default_port = defines.DEFAULT_PORT
self.hosts = deque([(host, port or default_port)])
if alt_hosts:
for host in alt_hosts.split(','):
url = urlparse('clickhouse://' + host)
self.hosts.append((url.hostname, url.port or default_port))
self.database = database
self.user = user
self.password = password
self.client_name = defines.DBMS_NAME + ' ' + client_name
self.connect_timeout = connect_timeout
self.send_receive_timeout = send_receive_timeout
self.sync_request_timeout = sync_request_timeout
self.settings_is_important = settings_is_important
self.secure_socket = secure
self.verify_cert = verify
ssl_options = {}
if ssl_version is not None:
ssl_options['ssl_version'] = ssl_version
if ca_certs is not None:
ssl_options['ca_certs'] = ca_certs
if ciphers is not None:
ssl_options['ciphers'] = ciphers
if keyfile is not None:
ssl_options['keyfile'] = keyfile
if certfile is not None:
ssl_options['certfile'] = certfile
self.ssl_options = ssl_options
self.server_hostname = server_hostname
# Use LZ4 compression by default.
if compression is True:
compression = 'lz4'
if compression is False:
self.compression = Compression.DISABLED
self.compressor_cls = None
self.compress_block_size = None
else:
self.compression = Compression.ENABLED
self.compressor_cls = get_compressor_cls(compression)
self.compress_block_size = compress_block_size
self.socket = None
self.fin = None
self.fout = None
self.connected = False
self.client_trace_context = None
self.server_info = None
self.context = Context()
# Block writer/reader
self.block_in = None
self.block_out = None
self.block_in_raw = None # log blocks are always not compressed
self._lock = threading.Lock()
self.is_query_executing = False
super(Connection, self).__init__()
def __repr__(self):
dsn = '%s://%s:***@%s:%s/%s' % (
'clickhouses' if self.secure_socket else 'clickhouse',
self.user, self.host, self.port, self.database
) if self.connected else '(not connected)'
return '<Connection(dsn=%s, compression=%s)>' % (dsn, self.compression)
def get_description(self):
return '{}:{}'.format(self.host, self.port)
def force_connect(self):
self.check_query_execution()
if not self.connected:
self.connect()
elif not self.ping():
logger.warning('Connection was closed, reconnecting.')
self.connect()
def _create_socket(self, host, port):
"""
Acts like socket.create_connection, but wraps socket with SSL
if connection is secure.
"""
ssl_options = {}
if self.secure_socket:
if self.verify_cert:
cert_reqs = ssl.CERT_REQUIRED
else:
cert_reqs = ssl.CERT_NONE
ssl_options = self.ssl_options.copy()
ssl_options['cert_reqs'] = cert_reqs
err = None
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
af, socktype, proto, canonname, sa = res
sock = None
try:
sock = socket.socket(af, socktype, proto)
sock.settimeout(self.connect_timeout)
if self.secure_socket:
ssl_context = self._create_ssl_context(ssl_options)
sock = ssl_context.wrap_socket(
sock, server_hostname=self.server_hostname or host)
sock.connect(sa)
return sock
except socket.error as _:
err = _
if sock is not None:
sock.close()
if err is not None:
raise err
else:
raise socket.error("getaddrinfo returns an empty list")
def _create_ssl_context(self, ssl_options):
purpose = ssl.Purpose.SERVER_AUTH
version = ssl_options.get('ssl_version', ssl.PROTOCOL_TLS)
context = ssl.SSLContext(version)
if 'ca_certs' in ssl_options:
context.load_verify_locations(ssl_options['ca_certs'])
elif ssl_options.get('cert_reqs') != ssl.CERT_NONE:
context.load_default_certs(purpose
)
if 'ciphers' in ssl_options:
context.set_ciphers(ssl_options['ciphers'])
if 'cert_reqs' in ssl_options:
context.options = ssl_options['cert_reqs']
if 'certfile' in ssl_options:
keyfile = ssl_options.get('keyfile')
context.load_cert_chain(ssl_options['certfile'], keyfile=keyfile)
return context
def _init_connection(self, host, port):
self.socket = self._create_socket(host, port)
self.connected = True
self.host, self.port = host, port
self.socket.settimeout(self.send_receive_timeout)
# performance tweak
self.socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self.fin = BufferedSocketReader(self.socket, defines.BUFFER_SIZE)
self.fout = BufferedSocketWriter(self.socket, defines.BUFFER_SIZE)
self.send_hello()
self.receive_hello()
self.block_in = self.get_block_in_stream()
self.block_in_raw = BlockInputStream(self.fin, self.context)
self.block_out = self.get_block_out_stream()
def _format_connection_error(self, e, host, port):
err = (e.strerror + ' ') if e.strerror else ''
return err + '({}:{})'.format(host, port)
def connect(self):
if self.connected:
self.disconnect()
logger.debug(
'Connecting. Database: %s. User: %s', self.database, self.user
)
err = None
for i in range(len(self.hosts)):
host, port = self.hosts[0]
logger.debug('Connecting to %s:%s', host, port)
try:
return self._init_connection(host, port)
except socket.timeout as e:
self.disconnect()
logger.warning(
'Failed to connect to %s:%s', host, port, exc_info=True
)
err_str = self._format_connection_error(e, host, port)
err = errors.SocketTimeoutError(err_str)
except socket.error as e:
self.disconnect()
logger.warning(
'Failed to connect to %s:%s', host, port, exc_info=True
)
err_str = self._format_connection_error(e, host, port)
err = errors.NetworkError(err_str)
self.hosts.rotate(-1)
if err is not None:
raise err
def reset_state(self):
self.host = None
self.port = None
self.socket = None
self.fin = None
self.fout = None
self.connected = False
self.client_trace_context = None
self.server_info = None
self.block_in = None
self.block_in_raw = None
self.block_out = None
self.is_query_executing = False
def disconnect(self):
"""
Closes connection between server and client.
Frees resources: e.g. closes socket.
"""
if self.connected:
# There can be errors on shutdown.
# We need to close socket and reset state even if it happens.
try:
self.socket.shutdown(socket.SHUT_RDWR)
except socket.error as e:
logger.warning('Error on socket shutdown: %s', e)
self.socket.close()
# Socket can be constructed but not connected.
elif self.socket:
self.socket.close()
self.reset_state()
def send_hello(self):
write_varint(ClientPacketTypes.HELLO, self.fout)
write_binary_str(self.client_name, self.fout)
write_varint(defines.CLIENT_VERSION_MAJOR, self.fout)
write_varint(defines.CLIENT_VERSION_MINOR, self.fout)
# NOTE For backward compatibility of the protocol,
# client cannot send its version_patch.
write_varint(defines.CLIENT_REVISION, self.fout)
write_binary_str(self.database, self.fout)
write_binary_str(self.user, self.fout)
write_binary_str(self.password, self.fout)
self.fout.flush()
def receive_hello(self):
packet_type = read_varint(self.fin)
if packet_type == ServerPacketTypes.HELLO:
server_name = read_binary_str(self.fin)
server_version_major = read_varint(self.fin)
server_version_minor = read_varint(self.fin)
server_revision = read_varint(self.fin)
server_timezone = None
if server_revision >= \
defines.DBMS_MIN_REVISION_WITH_SERVER_TIMEZONE:
server_timezone = read_binary_str(self.fin)
server_display_name = ''
if server_revision >= \
defines.DBMS_MIN_REVISION_WITH_SERVER_DISPLAY_NAME:
server_display_name = read_binary_str(self.fin)
server_version_patch = server_revision
if server_revision >= \
defines.DBMS_MIN_REVISION_WITH_VERSION_PATCH:
server_version_patch = read_varint(self.fin)
self.server_info = ServerInfo(
server_name, server_version_major, server_version_minor,
server_version_patch, server_revision,
server_timezone, server_display_name
)
self.context.server_info = self.server_info
logger.debug(
'Connected to %s server version %s.%s.%s, revision: %s',
server_name, server_version_major, server_version_minor,
server_version_patch, server_revision
)
elif packet_type == ServerPacketTypes.EXCEPTION:
raise self.receive_exception()
else:
message = self.unexpected_packet_message('Hello or Exception',
packet_type)
self.disconnect()
raise errors.UnexpectedPacketFromServerError(message)
def ping(self):
timeout = self.sync_request_timeout
with self.timeout_setter(timeout):
try:
write_varint(ClientPacketTypes.PING, self.fout)
self.fout.flush()
packet_type = read_varint(self.fin)
while packet_type == ServerPacketTypes.PROGRESS:
self.receive_progress()
packet_type = read_varint(self.fin)
if packet_type != ServerPacketTypes.PONG:
msg = self.unexpected_packet_message('Pong', packet_type)
raise errors.UnexpectedPacketFromServerError(msg)
except errors.Error:
raise
except (socket.error, EOFError) as e:
# It's just a warning now.
# Current connection will be closed, new will be established.
logger.warning(
'Error on %s ping: %s', self.get_description(), e
)
return False
return True
def receive_packet(self):
packet = Packet()
packet.type = packet_type = read_varint(self.fin)
if packet_type == ServerPacketTypes.DATA:
packet.block = self.receive_data(may_be_use_numpy=True)
elif packet_type == ServerPacketTypes.EXCEPTION:
packet.exception = self.receive_exception()
elif packet_type == ServerPacketTypes.PROGRESS:
packet.progress = self.receive_progress()
elif packet_type == ServerPacketTypes.PROFILE_INFO:
packet.profile_info = self.receive_profile_info()
elif packet_type == ServerPacketTypes.TOTALS:
packet.block = self.receive_data()
elif packet_type == ServerPacketTypes.EXTREMES:
packet.block = self.receive_data()
elif packet_type == ServerPacketTypes.LOG:
packet.block = self.receive_data(may_be_compressed=False)
log_block(packet.block)
elif packet_type == ServerPacketTypes.END_OF_STREAM:
self.is_query_executing = False
pass
elif packet_type == ServerPacketTypes.TABLE_COLUMNS:
packet.multistring_message = self.receive_multistring_message(
packet_type
)
elif packet_type == ServerPacketTypes.PART_UUIDS:
packet.block = self.receive_data()
elif packet_type == ServerPacketTypes.READ_TASK_REQUEST:
packet.block = self.receive_data()
elif packet_type == ServerPacketTypes.PROFILE_EVENTS:
packet.block = self.receive_data(may_be_compressed=False)
else:
message = 'Unknown packet {} from server {}'.format(
packet_type, self.get_description()
)
self.disconnect()
raise errors.UnknownPacketFromServerError(message)
return packet
def get_block_in_stream(self):
if self.compression:
from .streams.compressed import CompressedBlockInputStream
return CompressedBlockInputStream(self.fin, self.context)
else:
return BlockInputStream(self.fin, self.context)
def get_block_out_stream(self):
if self.compression:
from .streams.compressed import CompressedBlockOutputStream
return CompressedBlockOutputStream(
self.compressor_cls, self.compress_block_size,
self.fout, self.context
)
else:
return BlockOutputStream(self.fout, self.context)
def receive_data(self, may_be_compressed=True, may_be_use_numpy=False):
revision = self.server_info.revision
if revision >= defines.DBMS_MIN_REVISION_WITH_TEMPORARY_TABLES:
read_binary_str(self.fin)
reader = self.block_in if may_be_compressed else self.block_in_raw
use_numpy = False if not may_be_use_numpy else None
return reader.read(use_numpy=use_numpy)
def receive_exception(self):
return read_exception(self.fin)
def receive_progress(self):
progress = Progress()
progress.read(self.server_info.revision, self.fin)
return progress
def receive_profile_info(self):
profile_info = BlockStreamProfileInfo()
profile_info.read(self.fin)
return profile_info
def receive_multistring_message(self, packet_type):
num = ServerPacketTypes.strings_in_message(packet_type)
return [read_binary_str(self.fin) for _i in range(num)]
def send_data(self, block, table_name=''):
start = time()
write_varint(ClientPacketTypes.DATA, self.fout)
revision = self.server_info.revision
if revision >= defines.DBMS_MIN_REVISION_WITH_TEMPORARY_TABLES:
write_binary_str(table_name, self.fout)
self.block_out.write(block)
logger.debug('Block "%s" send time: %f', table_name, time() - start)
def send_query(self, query, query_id=None):
if not self.connected:
self.connect()
write_varint(ClientPacketTypes.QUERY, self.fout)
write_binary_str(query_id or '', self.fout)
revision = self.server_info.revision
if revision >= defines.DBMS_MIN_REVISION_WITH_CLIENT_INFO:
client_info = ClientInfo(self.client_name, self.context)
client_info.query_kind = ClientInfo.QueryKind.INITIAL_QUERY
client_info.write(revision, self.fout)
settings_as_strings = (
revision >= defines
.DBMS_MIN_REVISION_WITH_SETTINGS_SERIALIZED_AS_STRINGS
)
write_settings(self.context.settings, self.fout, settings_as_strings,
self.settings_is_important)
if revision >= defines.DBMS_MIN_REVISION_WITH_INTERSERVER_SECRET:
write_binary_str('', self.fout)
write_varint(QueryProcessingStage.COMPLETE, self.fout)
write_varint(self.compression, self.fout)
write_binary_str(query, self.fout)
logger.debug('Query: %s', query)
self.fout.flush()
def send_cancel(self):
write_varint(ClientPacketTypes.CANCEL, self.fout)
self.fout.flush()
def send_external_tables(self, tables, types_check=False):
for table in tables or []:
if not table['structure']:
raise ValueError(
'Empty table "{}" structure'.format(table['name'])
)
data = table['data']
block_cls = RowOrientedBlock
if self.context.client_settings['use_numpy']:
from .numpy.block import NumpyColumnOrientedBlock
columns = [x[0] for x in table['structure']]
data = [data[column].values for column in columns]
block_cls = NumpyColumnOrientedBlock
block = block_cls(table['structure'], data,
types_check=types_check)
self.send_data(block, table_name=table['name'])
# Empty block, end of data transfer.
self.send_data(RowOrientedBlock())
@contextmanager
def timeout_setter(self, new_timeout):
old_timeout = self.socket.gettimeout()
self.socket.settimeout(new_timeout)
yield
self.socket.settimeout(old_timeout)
def unexpected_packet_message(self, expected, packet_type):
packet_type = ServerPacketTypes.to_str(packet_type)
return (
'Unexpected packet from server {} (expected {}, got {})'
.format(self.get_description(), expected, packet_type)
)
def check_query_execution(self):
self._lock.acquire(blocking=False)
if self.is_query_executing:
raise errors.PartiallyConsumedQueryError()
self.is_query_executing = True
self._lock.release()
|