Infinidat/infi.clickhouse_orm
1
1
Fork 0
mirror of https://github.com/Infinidat/infi.clickhouse_orm.git synced 2024-09-21 03:08:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Itai Shirav 2019-02-27 08:42:09 +02:00
parent ad81a811fc
commit ba8bb1d5f4
2 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

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

24
docs/class_reference.md
View File

@ -835,7 +835,7 @@ is equivalent to:
Returns the whole query as a SQL string. Returns the whole query as a SQL string.
#### conditions_as_sql(prewhere=True) #### conditions_as_sql(prewhere=False)
Returns the contents of the query's `WHERE` or `PREWHERE` clause as a string. Returns the contents of the query's `WHERE` or `PREWHERE` clause as a string.
@ -854,17 +854,18 @@ Adds a DISTINCT clause to the query, meaning that any duplicate rows
in the results will be omitted. in the results will be omitted.
#### exclude(**filter_fields) #### exclude(*q, **kwargs)
Returns a copy of this queryset that excludes all rows matching the conditions. Returns a copy of this queryset that excludes all rows matching the conditions.
Pass `prewhere=True` to apply the conditions as PREWHERE instead of WHERE.
#### filter(*q, **filter_fields) #### filter(*q, **kwargs)
Returns a copy of this queryset that includes only rows matching the conditions. Returns a copy of this queryset that includes only rows matching the conditions.
Add q object to query if it specified. Pass `prewhere=True` to apply the conditions as PREWHERE instead of WHERE.
#### final() #### final()
@ -908,6 +909,9 @@ The result is a namedtuple containing `objects` (list), `number_of_objects`,
`pages_total`, `number` (of the current page), and `page_size`. `pages_total`, `number` (of the current page), and `page_size`.
#### select_fields_as_sql()
### AggregateQuerySet ### AggregateQuerySet
Extends QuerySet Extends QuerySet
@ -943,7 +947,7 @@ This method is not supported on `AggregateQuerySet`.
Returns the whole query as a SQL string. Returns the whole query as a SQL string.
#### conditions_as_sql(prewhere=True) #### conditions_as_sql(prewhere=False)
Returns the contents of the query's `WHERE` or `PREWHERE` clause as a string. Returns the contents of the query's `WHERE` or `PREWHERE` clause as a string.
@ -962,17 +966,18 @@ Adds a DISTINCT clause to the query, meaning that any duplicate rows
in the results will be omitted. in the results will be omitted.
#### exclude(**filter_fields) #### exclude(*q, **kwargs)
Returns a copy of this queryset that excludes all rows matching the conditions. Returns a copy of this queryset that excludes all rows matching the conditions.
Pass `prewhere=True` to apply the conditions as PREWHERE instead of WHERE.
#### filter(*q, **filter_fields) #### filter(*q, **kwargs)
Returns a copy of this queryset that includes only rows matching the conditions. Returns a copy of this queryset that includes only rows matching the conditions.
Add q object to query if it specified. Pass `prewhere=True` to apply the conditions as PREWHERE instead of WHERE.
#### final() #### final()
@ -1022,3 +1027,6 @@ The result is a namedtuple containing `objects` (list), `number_of_objects`,
`pages_total`, `number` (of the current page), and `page_size`. `pages_total`, `number` (of the current page), and `page_size`.
#### select_fields_as_sql()