Update docs

CHANGELOG.md

@@ -4,6 +4,7 @@ Change Log
 Unreleased
 ----------
 - Add PREWHERE support to querysets (M1hacka)
+- Add WITH TOTALS support to querysets (M1hacka)
 - Extend date field range (trthhrtz)
 - Fix parsing of server errors in ClickHouse v19.3.3+
 - Fix pagination when asking for the last page on a query that matches no records

docs/class_reference.md

@@ -912,6 +912,9 @@ The result is a namedtuple containing `objects` (list), `number_of_objects`,
 #### select_fields_as_sql()
 
 
+Returns the selected fields or expressions as a SQL string.
+
+
 ### AggregateQuerySet
 
 Extends QuerySet
@@ -1030,3 +1033,14 @@ The result is a namedtuple containing `objects` (list), `number_of_objects`,
 #### select_fields_as_sql()
 
 
+Returns the selected fields or expressions as a SQL string.
+
+
+#### with_totals()
+
+
+Adds WITH TOTALS modifier ot GROUP BY, making query return extra row
+with aggregate function calculated across all the rows. More information:
+https://clickhouse.yandex/docs/en/query_language/select/#with-totals-modifier
+
+

docs/querysets.md

@@ -214,14 +214,14 @@ If you limit aggregation results, it might be useful to get total aggregation va
 To achieve this, you can use `with_totals` method. It will return extra row (last) with
 values aggregated for all rows suitable for filters.
 
-    qs = Person.objects_in(database).aggregate('first_name' num='count()').with_totals().order_by('-count')[:3]
+    qs = Person.objects_in(database).aggregate('first_name', num='count()').with_totals().order_by('-count')[:3]
     >>> print qs.count()
     4
     >>> for row in qs:
-    >>>     print(row.first_name, row.count)
+    >>>     print("'{}': {}".format(row.first_name, row.count))
-    'Cassandra' 2
+    'Cassandra': 2
-    'Alexandra' 2
+    'Alexandra': 2
-    '' 100
+    '': 100
 
 ---
 

src/infi/clickhouse_orm/query.py

@@ -333,6 +333,9 @@ class QuerySet(object):
             return qs
 
     def select_fields_as_sql(self):
+        """
+        Returns the selected fields or expressions as a SQL string.
+        """
         return comma_join('`%s`' % field for field in self._fields) if self._fields else '*'
 
     def as_sql(self):
@@ -574,6 +577,9 @@ class AggregateQuerySet(QuerySet):
         raise NotImplementedError('Cannot re-aggregate an AggregateQuerySet')
 
     def select_fields_as_sql(self):
+        """
+        Returns the selected fields or expressions as a SQL string.
+        """
         return comma_join(list(self._fields) + ['%s AS %s' % (v, k) for k, v in self._calculated_fields.items()])
 
     def __iter__(self):