diff options
| author | Simon Charette <charette.s@gmail.com> | 2019-03-19 01:05:47 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2019-03-21 18:47:46 -0400 |
| commit | 9dc367dc10594ad024c83d398a8e3c3f8f221446 (patch) | |
| tree | 4b0d07779536cac024a2edc44271f7d665dd3637 /docs/ref | |
| parent | 2aaabe2004e1953eb7d7057edcf2fabd37f7394d (diff) | |
Refs #30158 -- Added alias argument to Expression.get_group_by_cols().
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/models/expressions.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/ref/models/expressions.txt b/docs/ref/models/expressions.txt index bfd5ddea2c..4dc8d9476a 100644 --- a/docs/ref/models/expressions.txt +++ b/docs/ref/models/expressions.txt @@ -974,12 +974,17 @@ calling the appropriate methods on the wrapped expression. A hook allowing the expression to coerce ``value`` into a more appropriate type. - .. method:: get_group_by_cols() + .. method:: get_group_by_cols(alias=None) Responsible for returning the list of columns references by this expression. ``get_group_by_cols()`` should be called on any nested expressions. ``F()`` objects, in particular, hold a reference - to a column. + to a column. The ``alias`` parameter will be ``None`` unless the + expression has been annotated and is used for grouping. + + .. versionchanged:: 3.0 + + The ``alias`` parameter was added. .. method:: asc(nulls_first=False, nulls_last=False) |