polars.DataFrame.groupby#

DataFrame.groupby(
by: IntoExpr | Iterable[IntoExpr],
*more_by: IntoExpr,
maintain_order: bool = False,
) GroupBy[source]#

Start a group by operation.

Deprecated since version 0.19.0: This method has been renamed to DataFrame.group_by().

Parameters:
by

Column(s) to group by. Accepts expression input. Strings are parsed as column names.

*more_by

Additional columns to group by, specified as positional arguments.

maintain_order

Ensure that the order of the groups is consistent with the input data. This is slower than a default group by. Settings this to True blocks the possibility to run on the streaming engine.

Note

Within each group, the order of rows is always preserved, regardless of this argument.

Returns:
GroupBy

Object which can be used to perform aggregations.