]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
docs: document sequence arguments to any_ and all_ 13456/head
authornightcityblade <nightcityblade@gmail.com>
Sun, 26 Jul 2026 16:53:13 +0000 (00:53 +0800)
committernightcityblade <nightcityblade@gmail.com>
Sun, 26 Jul 2026 16:53:13 +0000 (00:53 +0800)
lib/sqlalchemy/sql/_elements_constructors.py

index 1273d7c23a5da29522658c88762049f4752ad4a4..7da1107d550bd32865efa1d75b2231a9600ea8e3 100644 (file)
@@ -84,6 +84,12 @@ def all_(expr: _ColumnExpressionArgument[_T]) -> CollectionAggregate[bool]:
         # '5 = ALL (SELECT value FROM table)'
         expr = 5 == all_(select(table.c.value))
 
+    When using a Python sequence with PostgreSQL, wrap it with
+    :func:`_sql.literal` to produce a SQL expression.  Whether the sequence
+    can be adapted to an array parameter is DBAPI-specific::
+
+        expr = 5 == all_(literal([1, 2, 3]))
+
     Comparison to NULL may work using ``None``::
 
         None == all_(mytable.c.somearray)
@@ -267,6 +273,12 @@ def any_(expr: _ColumnExpressionArgument[_T]) -> CollectionAggregate[bool]:
         # '5 = ANY (SELECT value FROM table)'
         expr = 5 == any_(select(table.c.value))
 
+    When using a Python sequence with PostgreSQL, wrap it with
+    :func:`_sql.literal` to produce a SQL expression.  Whether the sequence
+    can be adapted to an array parameter is DBAPI-specific::
+
+        expr = 5 == any_(literal([1, 2, 3]))
+
     Comparison to NULL may work using ``None`` or :func:`_sql.null`::
 
         None == any_(mytable.c.somearray)