Method within_group

lib/sqlalchemy/sql/functions.py:528–550

Produce a WITHIN GROUP (ORDER BY expr) clause against this function. Used against so-called "ordered set aggregate" and "hypothetical set aggregate" functions, including :class:`.percentile_cont`, :class:`.rank`, :class:`.dense_rank`, etc. This feature is typically

(
        self, *order_by: _ColumnExpressionArgument[Any]
    )

        return AggregateOrderBy(self, *order_by)

    def within_group(
        self, *order_by: _ColumnExpressionArgument[Any]
    ) -> WithinGroup[_T]:
        """Produce a WITHIN GROUP (ORDER BY expr) clause against this function.

        Used against so-called "ordered set aggregate" and "hypothetical
        set aggregate" functions, including :class:`.percentile_cont`,
        :class:`.rank`, :class:`.dense_rank`, etc.  This feature is typically
        used by PostgreSQL, Oracle Database, and Microsoft SQL Server.

        For simple ORDER BY expressions within aggregate functions on
        PostgreSQL, MySQL/MariaDB, SQLite, see :func:`_sql.aggregate_order_by`.

        See :func:`_expression.within_group` for a full description.

        .. seealso::

            :ref:`tutorial_functions_within_group` -
            in the :ref:`unified_tutorial`


        """
        return WithinGroup(self, *order_by)

    @overload
    def filter(self) -> Self: ...