clickhouse-driver 0.0.4__tar.gz → 0.2.9__tar.gz

clickhouse-driver-0.2.9/LICENSE

@@ -0,0 +1,21 @@
+This is the MIT license: http://www.opensource.org/licenses/mit-license.php
+
+Copyright (c) 2017 by Konstantin Lebedev.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

clickhouse-driver-0.2.9/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include clickhouse_driver *.pyx

clickhouse-driver-0.2.9/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.1
+Name: clickhouse-driver
+Version: 0.2.9
+Summary: Python driver with native interface for ClickHouse
+Home-page: https://github.com/mymarilyn/clickhouse-driver
+Author: Konstantin Lebedev
+Author-email: kostyan.lebedev@gmail.com
+License: MIT
+Project-URL: Documentation, https://clickhouse-driver.readthedocs.io
+Project-URL: Changes, https://github.com/mymarilyn/clickhouse-driver/blob/master/CHANGELOG.md
+Description: ClickHouse Python Driver
+        ========================
+        
+        .. image:: https://img.shields.io/pypi/v/clickhouse-driver.svg
+            :target: https://pypi.org/project/clickhouse-driver
+        
+        .. image:: https://coveralls.io/repos/github/mymarilyn/clickhouse-driver/badge.svg?branch=master
+            :target: https://coveralls.io/github/mymarilyn/clickhouse-driver?branch=master
+        
+        .. image:: https://img.shields.io/pypi/l/clickhouse-driver.svg
+            :target: https://pypi.org/project/clickhouse-driver
+        
+        .. image:: https://img.shields.io/pypi/pyversions/clickhouse-driver.svg
+            :target: https://pypi.org/project/clickhouse-driver
+        
+        .. image:: https://img.shields.io/pypi/dm/clickhouse-driver.svg
+            :target: https://pypi.org/project/clickhouse-driver
+        
+        .. image:: https://github.com/mymarilyn/clickhouse-driver/actions/workflows/actions.yml/badge.svg
+           :target: https://github.com/mymarilyn/clickhouse-driver/actions/workflows/actions.yml
+        
+        ClickHouse Python Driver with native (TCP) interface support.
+        
+        Asynchronous wrapper is available here: https://github.com/mymarilyn/aioch
+        
+        Features
+        ========
+        
+        - External data for query processing.
+        
+        - Query settings.
+        
+        - Compression support.
+        
+        - TLS support.
+        
+        - Types support:
+        
+          * Float32/64
+          * [U]Int8/16/32/64/128/256
+          * Date/Date32/DateTime('timezone')/DateTime64('timezone')
+          * String/FixedString(N)
+          * Enum8/16
+          * Array(T)
+          * Nullable(T)
+          * Bool
+          * UUID
+          * Decimal
+          * IPv4/IPv6
+          * LowCardinality(T)
+          * SimpleAggregateFunction(F, T)
+          * Tuple(T1, T2, ...)
+          * Nested
+          * Map(key, value)
+        
+        - Query progress information.
+        
+        - Block by block results streaming.
+        
+        - Reading query profile info.
+        
+        - Receiving server logs.
+        
+        - Multiple hosts support.
+        
+        - Python DB API 2.0 specification support.
+        
+        - Optional NumPy arrays support.
+        
+        Documentation
+        =============
+        
+        Documentation is available at https://clickhouse-driver.readthedocs.io.
+        
+        Usage
+        =====
+        
+        There are two ways to communicate with server:
+        
+        - using pure Client;
+        - using DB API.
+        
+        Pure Client example:
+        
+            .. code-block:: python
+        
+                >>> from clickhouse_driver import Client
+                >>>
+                >>> client = Client('localhost')
+                >>>
+                >>> client.execute('SHOW TABLES')
+                [('test',)]
+                >>> client.execute('DROP TABLE IF EXISTS test')
+                []
+                >>> client.execute('CREATE TABLE test (x Int32) ENGINE = Memory')
+                []
+                >>> client.execute(
+                ...     'INSERT INTO test (x) VALUES',
+                ...     [{'x': 100}]
+                ... )
+                1
+                >>> client.execute('INSERT INTO test (x) VALUES', [[200]])
+                1
+                >>> client.execute(
+                ...     'INSERT INTO test (x) '
+                ...     'SELECT * FROM system.numbers LIMIT %(limit)s',
+                ...     {'limit': 3}
+                ... )
+                []
+                >>> client.execute('SELECT sum(x) FROM test')
+                [(303,)]
+        
+        DB API example:
+        
+            .. code-block:: python
+        
+                >>> from clickhouse_driver import connect
+                >>>
+                >>> conn = connect('clickhouse://localhost')
+                >>> cursor = conn.cursor()
+                >>>
+                >>> cursor.execute('SHOW TABLES')
+                >>> cursor.fetchall()
+                [('test',)]
+                >>> cursor.execute('DROP TABLE IF EXISTS test')
+                >>> cursor.fetchall()
+                []
+                >>> cursor.execute('CREATE TABLE test (x Int32) ENGINE = Memory')
+                >>> cursor.fetchall()
+                []
+                >>> cursor.executemany(
+                ...     'INSERT INTO test (x) VALUES',
+                ...     [{'x': 100}]
+                ... )
+                >>> cursor.rowcount
+                1
+                >>> cursor.executemany('INSERT INTO test (x) VALUES', [[200]])
+                >>> cursor.rowcount
+                1
+                >>> cursor.execute(
+                ...     'INSERT INTO test (x) '
+                ...     'SELECT * FROM system.numbers LIMIT %(limit)s',
+                ...     {'limit': 3}
+                ... )
+                >>> cursor.rowcount
+                0
+                >>> cursor.execute('SELECT sum(x) FROM test')
+                >>> cursor.fetchall()
+                [(303,)]
+        
+        License
+        =======
+        
+        ClickHouse Python Driver is distributed under the `MIT license
+        <http://www.opensource.org/licenses/mit-license.php>`_.
+        
+Keywords: ClickHouse db database cloud analytics
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: SQL
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.7, <4
+Provides-Extra: lz4
+Provides-Extra: zstd
+Provides-Extra: numpy

clickhouse-driver-0.2.9/README.rst

@@ -0,0 +1,155 @@
+ClickHouse Python Driver
+========================
+
+.. image:: https://img.shields.io/pypi/v/clickhouse-driver.svg
+    :target: https://pypi.org/project/clickhouse-driver
+
+.. image:: https://coveralls.io/repos/github/mymarilyn/clickhouse-driver/badge.svg?branch=master
+    :target: https://coveralls.io/github/mymarilyn/clickhouse-driver?branch=master
+
+.. image:: https://img.shields.io/pypi/l/clickhouse-driver.svg
+    :target: https://pypi.org/project/clickhouse-driver
+
+.. image:: https://img.shields.io/pypi/pyversions/clickhouse-driver.svg
+    :target: https://pypi.org/project/clickhouse-driver
+
+.. image:: https://img.shields.io/pypi/dm/clickhouse-driver.svg
+    :target: https://pypi.org/project/clickhouse-driver
+
+.. image:: https://github.com/mymarilyn/clickhouse-driver/actions/workflows/actions.yml/badge.svg
+   :target: https://github.com/mymarilyn/clickhouse-driver/actions/workflows/actions.yml
+
+ClickHouse Python Driver with native (TCP) interface support.
+
+Asynchronous wrapper is available here: https://github.com/mymarilyn/aioch
+
+Features
+========
+
+- External data for query processing.
+
+- Query settings.
+
+- Compression support.
+
+- TLS support.
+
+- Types support:
+
+  * Float32/64
+  * [U]Int8/16/32/64/128/256
+  * Date/Date32/DateTime('timezone')/DateTime64('timezone')
+  * String/FixedString(N)
+  * Enum8/16
+  * Array(T)
+  * Nullable(T)
+  * Bool
+  * UUID
+  * Decimal
+  * IPv4/IPv6
+  * LowCardinality(T)
+  * SimpleAggregateFunction(F, T)
+  * Tuple(T1, T2, ...)
+  * Nested
+  * Map(key, value)
+
+- Query progress information.
+
+- Block by block results streaming.
+
+- Reading query profile info.
+
+- Receiving server logs.
+
+- Multiple hosts support.
+
+- Python DB API 2.0 specification support.
+
+- Optional NumPy arrays support.
+
+Documentation
+=============
+
+Documentation is available at https://clickhouse-driver.readthedocs.io.
+
+Usage
+=====
+
+There are two ways to communicate with server:
+
+- using pure Client;
+- using DB API.
+
+Pure Client example:
+
+    .. code-block:: python
+
+        >>> from clickhouse_driver import Client
+        >>>
+        >>> client = Client('localhost')
+        >>>
+        >>> client.execute('SHOW TABLES')
+        [('test',)]
+        >>> client.execute('DROP TABLE IF EXISTS test')
+        []
+        >>> client.execute('CREATE TABLE test (x Int32) ENGINE = Memory')
+        []
+        >>> client.execute(
+        ...     'INSERT INTO test (x) VALUES',
+        ...     [{'x': 100}]
+        ... )
+        1
+        >>> client.execute('INSERT INTO test (x) VALUES', [[200]])
+        1
+        >>> client.execute(
+        ...     'INSERT INTO test (x) '
+        ...     'SELECT * FROM system.numbers LIMIT %(limit)s',
+        ...     {'limit': 3}
+        ... )
+        []
+        >>> client.execute('SELECT sum(x) FROM test')
+        [(303,)]
+
+DB API example:
+
+    .. code-block:: python
+
+        >>> from clickhouse_driver import connect
+        >>>
+        >>> conn = connect('clickhouse://localhost')
+        >>> cursor = conn.cursor()
+        >>>
+        >>> cursor.execute('SHOW TABLES')
+        >>> cursor.fetchall()
+        [('test',)]
+        >>> cursor.execute('DROP TABLE IF EXISTS test')
+        >>> cursor.fetchall()
+        []
+        >>> cursor.execute('CREATE TABLE test (x Int32) ENGINE = Memory')
+        >>> cursor.fetchall()
+        []
+        >>> cursor.executemany(
+        ...     'INSERT INTO test (x) VALUES',
+        ...     [{'x': 100}]
+        ... )
+        >>> cursor.rowcount
+        1
+        >>> cursor.executemany('INSERT INTO test (x) VALUES', [[200]])
+        >>> cursor.rowcount
+        1
+        >>> cursor.execute(
+        ...     'INSERT INTO test (x) '
+        ...     'SELECT * FROM system.numbers LIMIT %(limit)s',
+        ...     {'limit': 3}
+        ... )
+        >>> cursor.rowcount
+        0
+        >>> cursor.execute('SELECT sum(x) FROM test')
+        >>> cursor.fetchall()
+        [(303,)]
+
+License
+=======
+
+ClickHouse Python Driver is distributed under the `MIT license
+<http://www.opensource.org/licenses/mit-license.php>`_.

clickhouse-driver-0.2.9/clickhouse_driver/__init__.py

@@ -0,0 +1,9 @@
+
+from .client import Client
+from .dbapi import connect
+
+
+VERSION = (0, 2, 9)
+__version__ = '.'.join(str(x) for x in VERSION)
+
+__all__ = ['Client', 'connect']

clickhouse-driver-0.2.9/clickhouse_driver/block.py

@@ -0,0 +1,227 @@
+from .columns.util import get_inner_spec, get_inner_columns_with_types
+from .reader import read_varint, read_binary_uint8, read_binary_int32
+from .varint import write_varint
+from .writer import write_binary_uint8, write_binary_int32
+
+
+class BlockInfo(object):
+    is_overflows = False
+    bucket_num = -1
+
+    def write(self, buf):
+        # Set of pairs (`FIELD_NUM`, value) in binary form. Then 0.
+        write_varint(1, buf)
+        write_binary_uint8(self.is_overflows, buf)
+
+        write_varint(2, buf)
+        write_binary_int32(self.bucket_num, buf)
+
+        write_varint(0, buf)
+
+    def read(self, buf):
+        while True:
+            field_num = read_varint(buf)
+            if not field_num:
+                break
+
+            if field_num == 1:
+                self.is_overflows = bool(read_binary_uint8(buf))
+
+            elif field_num == 2:
+                self.bucket_num = read_binary_int32(buf)
+
+
+class BaseBlock(object):
+    def __init__(self, columns_with_types=None, data=None,
+                 info=None, types_check=False):
+        self.columns_with_types = columns_with_types or []
+        self.types_check = types_check
+        self.info = info or BlockInfo()
+        self.data = self.normalize(data or [])
+
+        super(BaseBlock, self).__init__()
+
+    def normalize(self, data):
+        return data
+
+    @property
+    def num_columns(self):
+        raise NotImplementedError
+
+    @property
+    def num_rows(self):
+        raise NotImplementedError
+
+    def get_columns(self):
+        raise NotImplementedError
+
+    def get_rows(self):
+        raise NotImplementedError
+
+    def get_column_by_index(self, index):
+        raise NotImplementedError
+
+    def transposed(self):
+        return list(zip(*self.data))
+
+
+class ColumnOrientedBlock(BaseBlock):
+    def normalize(self, data):
+        if not data:
+            return []
+
+        self._check_number_of_columns(data)
+        self._check_all_columns_equal_length(data)
+        return data
+
+    @property
+    def num_columns(self):
+        return len(self.data)
+
+    @property
+    def num_rows(self):
+        return len(self.data[0]) if self.num_columns else 0
+
+    def get_columns(self):
+        return self.data
+
+    def get_rows(self):
+        return self.transposed()
+
+    def get_column_by_index(self, index):
+        return self.data[index]
+
+    def _check_number_of_columns(self, data):
+        expected_row_len = len(self.columns_with_types)
+
+        got = len(data)
+        if expected_row_len != got:
+            msg = 'Expected {} columns, got {}'.format(expected_row_len, got)
+            raise ValueError(msg)
+
+    def _check_all_columns_equal_length(self, data):
+        expected = len(data[0])
+
+        for column in data:
+            got = len(column)
+            if got != expected:
+                msg = 'Expected {} rows, got {}'.format(expected, got)
+                raise ValueError(msg)
+
+
+class RowOrientedBlock(BaseBlock):
+    dict_row_types = (dict, )
+    tuple_row_types = (list, tuple)
+    supported_row_types = dict_row_types + tuple_row_types
+
+    def normalize(self, data):
+        if not data:
+            return []
+
+        # Guessing about whole data format by first row.
+        first_row = data[0]
+
+        if self.types_check:
+            self._check_row_type(first_row)
+
+        if isinstance(first_row, dict):
+            self._mutate_dicts_to_rows(data)
+        else:
+            self._check_rows(data)
+
+        return data
+
+    @property
+    def num_columns(self):
+        if self.columns_with_types is not None:
+            return len(self.columns_with_types)
+
+        return len(self.data[0]) if self.num_rows else 0
+
+    @property
+    def num_rows(self):
+        return len(self.data)
+
+    def get_columns(self):
+        return self.transposed()
+
+    def get_rows(self):
+        return self.data
+
+    def get_column_by_index(self, index):
+        return [row[index] for row in self.data]
+
+    def _mutate_dicts_to_rows(self, data):
+        check_row_type = False
+        if self.types_check:
+            check_row_type = self._check_dict_row_type
+
+        return self._pure_mutate_dicts_to_rows(
+            data,
+            self.columns_with_types,
+            check_row_type,
+        )
+
+    def _pure_mutate_dicts_to_rows(
+        self,
+        data,
+        columns_with_types,
+        check_row_type,
+    ):
+        columns_with_cwt = []
+        for name, type_ in columns_with_types:
+            cwt = None
+            if type_.startswith('Nested'):
+                inner_spec = get_inner_spec('Nested', type_)
+                cwt = get_inner_columns_with_types(inner_spec)
+            columns_with_cwt.append((name, cwt))
+
+        for i, row in enumerate(data):
+            if check_row_type:
+                check_row_type(row)
+
+            new_data = []
+            for name, cwt in columns_with_cwt:
+                if cwt is None:
+                    new_data.append(row[name])
+                else:
+                    new_data.append(self._pure_mutate_dicts_to_rows(
+                        row[name], cwt, check_row_type
+                    ))
+            data[i] = new_data
+        # return for recursion
+        return data
+
+    def _check_rows(self, data):
+        expected_row_len = len(self.columns_with_types)
+
+        got = len(data[0])
+        if expected_row_len != got:
+            msg = 'Expected {} columns, got {}'.format(expected_row_len, got)
+            raise ValueError(msg)
+
+        if self.types_check:
+            check_row_type = self._check_tuple_row_type
+            for row in data:
+                check_row_type(row)
+
+    def _check_row_type(self, row):
+        if not isinstance(row, self.supported_row_types):
+            raise TypeError(
+                'Unsupported row type: {}. dict, list or tuple is expected.'
+                .format(type(row))
+            )
+
+    def _check_tuple_row_type(self, row):
+        if not isinstance(row, self.tuple_row_types):
+            raise TypeError(
+                'Unsupported row type: {}. list or tuple is expected.'
+                .format(type(row))
+            )
+
+    def _check_dict_row_type(self, row):
+        if not isinstance(row, self.dict_row_types):
+            raise TypeError(
+                'Unsupported row type: {}. dict is expected.'
+                .format(type(row))
+            )

{clickhouse-driver-0.0.4/src → clickhouse-driver-0.2.9/clickhouse_driver}/blockstreamprofileinfo.py

@@ -1,4 +1,5 @@
-from .reader import read_varint, read_binary_uint8
+from .reader import read_binary_uint8
+from .varint import read_varint
 
 
 class BlockStreamProfileInfo(object):