summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/functions.py
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2022-03-23 16:59:30 +0000
committerGerrit Code Review <gerrit@ci3.zzzcomputing.com>2022-03-23 16:59:30 +0000
commit4f0978079b967388c03da2c194ec83680230727e (patch)
tree2ff300e735c342b524ff0b6310b3bbdc6b07c727 /lib/sqlalchemy/sql/functions.py
parent675d11f113b3eb5a931d8dfb31328feee2080c27 (diff)
parent04dcc5c704dbf0b22705523e263e512c24936175 (diff)
downloadsqlalchemy-4f0978079b967388c03da2c194ec83680230727e.tar.gz
Merge "Add option to disable from linting for table valued function" into main
Diffstat (limited to 'lib/sqlalchemy/sql/functions.py')
-rw-r--r--lib/sqlalchemy/sql/functions.py29
1 files changed, 26 insertions, 3 deletions
diff --git a/lib/sqlalchemy/sql/functions.py b/lib/sqlalchemy/sql/functions.py
index 563b58418..9e801a99f 100644
--- a/lib/sqlalchemy/sql/functions.py
+++ b/lib/sqlalchemy/sql/functions.py
@@ -226,8 +226,16 @@ class FunctionElement(Executable, ColumnElement[_T], FromClause, Generative):
string name will be added as a column to the .c collection
of the resulting :class:`_sql.TableValuedAlias`.
+ :param joins_implicitly: when True, the table valued function may be
+ used in the FROM clause without any explicit JOIN to other tables
+ in the SQL query, and no "cartesian product" warning will be generated.
+ May be useful for SQL functions such as ``func.json_each()``.
+
+ .. versionadded:: 1.4.33
+
.. versionadded:: 1.4.0b2
+
.. seealso::
:ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial`
@@ -248,6 +256,7 @@ class FunctionElement(Executable, ColumnElement[_T], FromClause, Generative):
new_func = self._generate()
with_ordinality = kw.pop("with_ordinality", None)
+ joins_implicitly = kw.pop("joins_implicitly", None)
name = kw.pop("name", None)
if with_ordinality:
@@ -258,7 +267,7 @@ class FunctionElement(Executable, ColumnElement[_T], FromClause, Generative):
*expr
)
- return new_func.alias(name=name)
+ return new_func.alias(name=name, joins_implicitly=joins_implicitly)
def column_valued(self, name=None):
"""Return this :class:`_functions.FunctionElement` as a column expression that
@@ -511,7 +520,7 @@ class FunctionElement(Executable, ColumnElement[_T], FromClause, Generative):
return None
- def alias(self, name=None):
+ def alias(self, name=None, joins_implicitly=False):
r"""Produce a :class:`_expression.Alias` construct against this
:class:`.FunctionElement`.
@@ -553,6 +562,17 @@ class FunctionElement(Executable, ColumnElement[_T], FromClause, Generative):
.. versionadded:: 1.4.0b2 Added the ``.column`` accessor
+ :param name: alias name, will be rendered as ``AS <name>`` in the
+ FROM clause
+
+ :param joins_implicitly: when True, the table valued function may be
+ used in the FROM clause without any explicit JOIN to other tables
+ in the SQL query, and no "cartesian product" warning will be
+ generated. May be useful for SQL functions such as
+ ``func.json_each()``.
+
+ .. versionadded:: 1.4.33
+
.. seealso::
:ref:`tutorial_functions_table_valued` -
@@ -568,7 +588,10 @@ class FunctionElement(Executable, ColumnElement[_T], FromClause, Generative):
"""
return TableValuedAlias._construct(
- self, name, table_value_type=self.type
+ self,
+ name,
+ table_value_type=self.type,
+ joins_implicitly=joins_implicitly,
)
def select(self) -> "Select":