Finished Release v1.0.4

CHANGELOG.md

@@ -1,6 +1,13 @@
 Change Log
 ==========
 
+v1.0.4
+------
+- Added `timeout` parameter to database initializer (SUHAR1K)
+- Added `verify_ssl_cert` parameter to database initializer
+- Added `final()` method to querysets (M1hacka)
+- Fixed a migrations problem - cannot add a new materialized field after a regular field
+
 v1.0.3
 ------
 - Bug fix: `QuerySet.count()` ignores slicing

docs/class_reference.md

@@ -10,7 +10,7 @@ infi.clickhouse_orm.database
 Database instances connect to a specific ClickHouse database for running queries,
 inserting data and other operations.
 
-#### Database(db_name, db_url="http://localhost:8123/", username=None, password=None, readonly=False, autocreate=True)
+#### Database(db_name, db_url="http://localhost:8123/", username=None, password=None, readonly=False, autocreate=True, timeout=60, verify_ssl_cert=True)
 
 
 Initializes a database instance. Unless it's readonly, the database will be
@@ -21,7 +21,9 @@ created on the ClickHouse server if it does not already exist.
 - `username`: optional connection credentials.
 - `password`: optional connection credentials.
 - `readonly`: use a read-only connection.
-- `autocreate`: automatically create the database if does not exist (unless in readonly mode).
+- `autocreate`: automatically create the database if it does not exist (unless in readonly mode).
+- `timeout`: the connection timeout in seconds.
+- `verify_ssl_cert`: whether to verify the server's certificate when connecting via HTTPS.
 
 
 #### add_setting(name, value)
@@ -865,6 +867,13 @@ Returns a copy of this queryset that includes only rows matching the conditions.
 Add q object to query if it specified.
 
 
+#### final()
+
+
+Adds a FINAL modifier to table, meaning data will be collapsed to final version.
+Can be used with `CollapsingMergeTree` engine only.
+
+
 #### only(*field_names)
 
 
@@ -966,6 +975,13 @@ Returns a copy of this queryset that includes only rows matching the conditions.
 Add q object to query if it specified.
 
 
+#### final()
+
+
+Adds a FINAL modifier to table, meaning data will be collapsed to final version.
+Can be used with `CollapsingMergeTree` engine only.
+
+
 #### group_by(*args)
 
 

docs/querysets.md

@@ -117,6 +117,17 @@ Adds a DISTINCT clause to the query, meaning that any duplicate rows in the resu
     >>> Person.objects_in(database).only('first_name').distinct().count()
     94
 
+Final
+--------
+
+This method can be used only with CollapsingMergeTree engine.  
+Adds a FINAL modifier to the query, meaning data is selected fully "collapsed" by sign field.
+
+    >>> Person.objects_in(database).count()
+    100
+    >>> Person.objects_in(database).final().count()
+    94
+    
 Slicing
 -------
 

docs/toc.md

@@ -25,6 +25,7 @@
       * [Ordering](querysets.md#ordering)
       * [Omitting Fields](querysets.md#omitting-fields)
       * [Distinct](querysets.md#distinct)
+      * [Final](querysets.md#final)
       * [Slicing](querysets.md#slicing)
       * [Pagination](querysets.md#pagination)
       * [Aggregation](querysets.md#aggregation)

src/infi/clickhouse_orm/database.py

@@ -73,7 +73,8 @@ class Database(object):
     '''
 
     def __init__(self, db_name, db_url='http://localhost:8123/',
-                 username=None, password=None, readonly=False, autocreate=True):
+                 username=None, password=None, readonly=False, autocreate=True,
+                 timeout=60, verify_ssl_cert=True):
         '''
         Initializes a database instance. Unless it's readonly, the database will be
         created on the ClickHouse server if it does not already exist.
@@ -83,15 +84,20 @@ class Database(object):
         - `username`: optional connection credentials.
         - `password`: optional connection credentials.
         - `readonly`: use a read-only connection.
-        - `autocreate`: automatically create the database if does not exist (unless in readonly mode).
+        - `autocreate`: automatically create the database if it does not exist (unless in readonly mode).
+        - `timeout`: the connection timeout in seconds.
+        - `verify_ssl_cert`: whether to verify the server's certificate when connecting via HTTPS.
         '''
         self.db_name = db_name
         self.db_url = db_url
         self.username = username
         self.password = password
         self.readonly = False
+        self.timeout = timeout
+        self.request_session = requests.Session()
+        self.request_session.verify = verify_ssl_cert
         self.settings = {}
-        self.db_exists = False
+        self.db_exists = False # this is required before running _is_existing_database
         self.db_exists = self._is_existing_database()
         if readonly:
             if not self.db_exists:
@@ -116,6 +122,7 @@ class Database(object):
         Deletes the database on the ClickHouse server.
         '''
         self._send('DROP DATABASE `%s`' % self.db_name)
+        self.db_exists = False
 
     def create_table(self, model_class):
         '''
@@ -319,7 +326,7 @@ class Database(object):
         if isinstance(data, string_types):
             data = data.encode('utf-8')
         params = self._build_params(settings)
-        r = requests.post(self.db_url, params=params, data=data, stream=stream)
+        r = self.request_session.post(self.db_url, params=params, data=data, stream=stream, timeout=self.timeout)
         if r.status_code != 200:
             raise ServerError(r.text)
         return r

src/infi/clickhouse_orm/migrations.py

@@ -75,13 +75,16 @@ class AlterTable(Operation):
         # Identify fields that were added to the model
         prev_name = None
         for name, field in iteritems(self.model_class.fields()):
+            is_regular_field = not (field.materialized or field.alias)
             if name not in table_fields:
                 logger.info('        Add column %s', name)
                 assert prev_name, 'Cannot add a column to the beginning of the table'
-                cmd = 'ADD COLUMN %s %s AFTER %s' % (name, field.get_sql(), prev_name)
+                cmd = 'ADD COLUMN %s %s' % (name, field.get_sql())
+                if is_regular_field:
+                    cmd += ' AFTER %s' % prev_name
                 self._alter_table(database, cmd)
 
-            if not field.materialized and not field.alias:
+            if is_regular_field:
                 # ALIAS and MATERIALIZED fields are not stored in the database, and raise DatabaseError
                 # (no AFTER column). So we will skip them
                 prev_name = name

src/infi/clickhouse_orm/query.py

@@ -1,8 +1,11 @@
 from __future__ import unicode_literals
+
 import six
 import pytz
 from copy import copy
 from math import ceil
+
+from .engines import CollapsingMergeTree
 from .utils import comma_join
 
 
@@ -243,6 +246,7 @@ class QuerySet(object):
         self._fields = model_cls.fields().keys()
         self._limits = None
         self._distinct = False
+        self._final = False
 
     def __iter__(self):
         """
@@ -290,9 +294,10 @@ class QuerySet(object):
             fields = comma_join('`%s`' % field for field in self._fields)
         ordering = '\nORDER BY ' + self.order_by_as_sql() if self._order_by else ''
         limit = '\nLIMIT %d, %d' % self._limits if self._limits else ''
-        params = (distinct, fields, self._model_cls.table_name(),
+        final = ' FINAL' if self._final else ''
+        params = (distinct, fields, self._model_cls.table_name(), final,
                   self.conditions_as_sql(), ordering, limit)
-        return u'SELECT %s%s\nFROM `%s`\nWHERE %s%s%s' % params
+        return u'SELECT %s%s\nFROM `%s`%s\nWHERE %s%s%s' % params
 
     def order_by_as_sql(self):
         """
@@ -399,6 +404,18 @@ class QuerySet(object):
         qs._distinct = True
         return qs
 
+    def final(self):
+        """
+        Adds a FINAL modifier to table, meaning data will be collapsed to final version.
+        Can be used with `CollapsingMergeTree` engine only.
+        """
+        if not isinstance(self._model_cls.engine, CollapsingMergeTree):
+            raise TypeError('final() method can be used only with CollapsingMergeTree engine')
+
+        qs = copy(self)
+        qs._final = True
+        return qs
+
     def aggregate(self, *args, **kwargs):
         """
         Returns an `AggregateQuerySet` over this query, with `args` serving as

tests/base_test_with_data.py

@@ -148,4 +148,4 @@ data = [
     {"first_name": "Whitney", "last_name": "Scott", "birthday": "1971-07-04", "height": "1.70"},
     {"first_name": "Wynter", "last_name": "Garcia", "birthday": "1975-01-10", "height": "1.69"},
     {"first_name": "Yolanda", "last_name": "Duke", "birthday": "1997-02-25", "height": "1.74"}
-];
+]

tests/test_database.py

@@ -151,10 +151,15 @@ class DatabaseTestCase(TestCaseWithData):
         exc = cm.exception
         self.assertEqual(exc.code, 81)
         self.assertEqual(exc.message, "Database db_not_here doesn't exist")
+        # Create and delete the db twice, to ensure db_exists gets updated
+        for i in range(2):
             # Now create the database - should succeed
             db.create_database()
+            self.assertTrue(db.db_exists)
             db.create_table(Person)
+            # Drop the database
             db.drop_database()
+            self.assertFalse(db.db_exists)
 
     def test_preexisting_db(self):
         db = Database(self.database.db_name, autocreate=False)

tests/test_engines.py

@@ -161,9 +161,9 @@ class EnginesTestCase(_EnginesHelperTestCase):
 
         self.assertEqual(2, len(parts))
         self.assertEqual('testcollapsemodel', parts[0].table)
-        self.assertEqual('(201701, 13)', parts[0].partition)
+        self.assertEqual('(201701, 13)'.replace(' ', ''), parts[0].partition.replace(' ', ''))
         self.assertEqual('testmodel', parts[1].table)
-        self.assertEqual('(201701, 13)', parts[1].partition)
+        self.assertEqual('(201701, 13)'.replace(' ', ''), parts[1].partition.replace(' ', ''))
 
 
 class SampleModel(Model):

tests/test_migrations.py

@@ -93,10 +93,10 @@ class MigrationsTestCase(unittest.TestCase):
         self.database.migrate('tests.sample_migrations', 14)
         self.assertTrue(self.tableExists(MaterializedModel1))
         self.assertEqual(self.getTableFields(MaterializedModel1),
-                          [('date_time', "DateTime"), ('int_field', 'Int8'), ('date', 'Date')])
+                          [('date_time', 'DateTime'), ('int_field', 'Int8'), ('date', 'Date'), ('int_field_plus_one', 'Int8')])
         self.assertTrue(self.tableExists(AliasModel1))
         self.assertEqual(self.getTableFields(AliasModel1),
-                          [('date', 'Date'), ('int_field', 'Int8'), ('date_alias', "Date")])
+                          [('date', 'Date'), ('int_field', 'Int8'), ('date_alias', 'Date'), ('int_field_plus_one', 'Int8')])
 
 
 # Several different models with the same table name, to simulate a table that changes over time
@@ -183,6 +183,7 @@ class MaterializedModel1(Model):
     date_time = DateTimeField()
     date = DateField(materialized='toDate(date_time)')
     int_field = Int8Field()
+    int_field_plus_one = Int8Field(materialized='int_field + 1')
 
     engine = MergeTree('date', ('date',))
 
@@ -206,6 +207,7 @@ class AliasModel1(Model):
     date = DateField()
     date_alias = DateField(alias='date')
     int_field = Int8Field()
+    int_field_plus_one = Int8Field(alias='int_field + 1')
 
     engine = MergeTree('date', ('date',))
 

tests/test_querysets.py

@@ -104,6 +104,22 @@ class QuerySetTestCase(TestCaseWithData):
         self._test_qs(qs.filter(birthday=date(1970, 12, 2)), 1)
         self._test_qs(qs.filter(birthday__lte=date(1970, 12, 2)), 3)
 
+    def test_mutiple_filter(self):
+        qs = Person.objects_in(self.database)
+        # Single filter call with multiple conditions is ANDed
+        self._test_qs(qs.filter(first_name='Ciaran', last_name='Carver'), 1)
+        # Separate filter calls are also ANDed
+        self._test_qs(qs.filter(first_name='Ciaran').filter(last_name='Carver'), 1)
+        self._test_qs(qs.filter(birthday='1970-12-02').filter(birthday='1986-01-07'), 0)
+
+    def test_multiple_exclude(self):
+        qs = Person.objects_in(self.database)
+        # Single exclude call with multiple conditions is ANDed
+        self._test_qs(qs.exclude(first_name='Ciaran', last_name='Carver'), 99)
+        # Separate exclude calls are ORed
+        self._test_qs(qs.exclude(first_name='Ciaran').exclude(last_name='Carver'), 98)
+        self._test_qs(qs.exclude(birthday='1970-12-02').exclude(birthday='1986-01-07'), 98)
+
     def test_only(self):
         qs = Person.objects_in(self.database).only('first_name', 'last_name')
         for person in qs:
@@ -141,6 +157,20 @@ class QuerySetTestCase(TestCaseWithData):
             SampleModel(timestamp=now, num=4, color=Color.white),
         ])
 
+    def _insert_sample_collapsing_model(self):
+        self.database.create_table(SampleCollapsingModel)
+        now = datetime.now()
+        self.database.insert([
+            SampleCollapsingModel(timestamp=now, num=1, color=Color.red),
+            SampleCollapsingModel(timestamp=now, num=2, color=Color.red),
+            SampleCollapsingModel(timestamp=now, num=2, color=Color.red, sign=-1),
+            SampleCollapsingModel(timestamp=now, num=2, color=Color.green),
+            SampleCollapsingModel(timestamp=now, num=3, color=Color.white),
+            SampleCollapsingModel(timestamp=now, num=4, color=Color.white, sign=1),
+            SampleCollapsingModel(timestamp=now, num=4, color=Color.white, sign=-1),
+            SampleCollapsingModel(timestamp=now, num=4, color=Color.blue, sign=1),
+        ])
+
     def test_filter_enum_field(self):
         self._insert_sample_model()
         qs = SampleModel.objects_in(self.database)
@@ -249,6 +279,17 @@ class QuerySetTestCase(TestCaseWithData):
         self._test_qs(qs[70:80], 10)
         self._test_qs(qs[80:], 20)
 
+    def test_final(self):
+        # Final can be used with CollapsingMergeTree engine only
+        with self.assertRaises(TypeError):
+            Person.objects_in(self.database).final()
+
+        self._insert_sample_collapsing_model()
+        res = list(SampleCollapsingModel.objects_in(self.database).final().order_by('num'))
+        self.assertEqual(4, len(res))
+        for item, exp_color in zip(res, (Color.red, Color.green, Color.white, Color.blue)):
+            self.assertEqual(exp_color, item.color)
+
 
 class AggregateTestCase(TestCaseWithData):
 
@@ -392,6 +433,13 @@ class SampleModel(Model):
     engine = MergeTree('materialized_date', ('materialized_date',))
 
 
+class SampleCollapsingModel(SampleModel):
+
+    sign = Int8Field(default=1)
+
+    engine = CollapsingMergeTree('materialized_date', ('num',), 'sign')
+
+
 class Numbers(Model):
 
     number = UInt64Field()