]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
clarify clauses argument for order_by, group_by
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 19 Sep 2025 14:32:43 +0000 (10:32 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 19 Sep 2025 14:34:59 +0000 (10:34 -0400)
Change-Id: Idabfde4a6850a2649a2f32dc42d0320f1ec7692d

lib/sqlalchemy/sql/selectable.py

index 08fdadc253f5135dd19a5649fdad9eecc1c2d7c5..4d72377c2bb255431b0360c20513a6eecebc15be 100644 (file)
@@ -4368,8 +4368,13 @@ class GenerativeSelect(DialectKWArgs, SelectBase, Generative):
             stmt = stmt.order_by(None).order_by(new_col)
 
         :param \*clauses: a series of :class:`_expression.ColumnElement`
-         constructs
-         which will be used to generate an ORDER BY clause.
+         constructs which will be used to generate an ORDER BY clause.
+
+         Alternatively, an individual entry may also be the string name of a
+         label located elsewhere in the columns clause of the statement which
+         will be matched and rendered in a backend-specific way based on
+         context; see :ref:`tutorial_order_by_label` for background on string
+         label matching in ORDER BY and GROUP BY expressions.
 
         .. seealso::
 
@@ -4410,8 +4415,13 @@ class GenerativeSelect(DialectKWArgs, SelectBase, Generative):
             stmt = select(table.c.name, func.max(table.c.stat)).group_by(table.c.name)
 
         :param \*clauses: a series of :class:`_expression.ColumnElement`
-         constructs
-         which will be used to generate an GROUP BY clause.
+         constructs which will be used to generate an GROUP BY clause.
+
+         Alternatively, an individual entry may also be the string name of a
+         label located elsewhere in the columns clause of the statement which
+         will be matched and rendered in a backend-specific way based on
+         context; see :ref:`tutorial_order_by_label` for background on string
+         label matching in ORDER BY and GROUP BY expressions.
 
         .. seealso::