Classe « FunctionElement »

Informations générales

Héritage

                            builtins.object
                                HasMemoized
                                    Generative
        builtins.object
            Visitable
                CompilerElement
        builtins.object
            Visitable
        builtins.object
            HasTraverseInternals
                ExternallyTraversible
        builtins.object
            HasTraverseInternals
                HasCopyInternals
        builtins.object
            HasMemoized
        builtins.object
            HasCacheKey
                MemoizedHasCacheKey
builtins.object
    Visitable
builtins.object
    HasTraverseInternals
        ExternallyTraversible
            SupportsAnnotations
                SupportsWrappingAnnotations
                    ClauseElement
                        DQLDMLClauseElement
                builtins.object
                    SQLRole
                        ReturnsRowsRole
                            ReturnsRows
                                Selectable
        builtins.object
            SQLRole
                StructuralRole
            builtins.object
                UsesInspection
            builtins.object
                AllowsLambdaRole
                    JoinTargetRole
        builtins.object
            SQLRole
                ColumnListRole
            builtins.object
                UsesInspection
            builtins.object
                AllowsLambdaRole
                    ColumnsClauseRole
                        FromClauseRole
                            StrictFromClauseRole
                                AnonymizedFromClauseRole
                                    FromClause
                builtins.object
                    Visitable
                        CompilerElement
                builtins.object
                    Visitable
                builtins.object
                    HasTraverseInternals
                        ExternallyTraversible
                builtins.object
                    HasTraverseInternals
                        HasCopyInternals
                builtins.object
                    HasMemoized
                builtins.object
                    HasCacheKey
                        MemoizedHasCacheKey
        builtins.object
            Visitable
        builtins.object
            HasTraverseInternals
                ExternallyTraversible
                    SupportsAnnotations
                        SupportsWrappingAnnotations
                            ClauseElement
                                DQLDMLClauseElement
                        builtins.object
                            TypingOnly
                builtins.object
                    SQLRole
                builtins.object
                    Generic
                        TypedColumnsClauseRole
                            ExpressionElementRole
                    builtins.object
                        TypingOnly
                builtins.object
                    Operators
                        ColumnOperators
                    builtins.object
                        Generic
                            SQLCoreOperations
                                SQLColumnExpression
                    builtins.object
                        SQLRole
                            StructuralRole
                                DDLExpressionRole
                        builtins.object
                            SQLRole
                                DDLConstraintColumnRole
                        builtins.object
                            SQLRole
                                DMLColumnRole
                        builtins.object
                            SQLRole
                                LimitOffsetRole
                    builtins.object
                        SQLRole
                            ColumnListRole
                        builtins.object
                            UsesInspection
                        builtins.object
                            AllowsLambdaRole
                                ColumnsClauseRole
                builtins.object
                    SQLRole
                        ColumnListRole
                            ByOfRole
                        builtins.object
                            AllowsLambdaRole
                                OrderByRole
                builtins.object
                    SQLRole
                builtins.object
                    Generic
                        TypedColumnsClauseRole
                            ExpressionElementRole
                                BinaryElementRole
                builtins.object
                    SQLRole
                        StructuralRole
                    builtins.object
                        AllowsLambdaRole
                            OnClauseRole
                                WhereHavingRole
                    builtins.object
                        SQLRole
                            StructuralRole
                                StatementOptionRole
                    builtins.object
                        SQLRole
                            ColumnArgumentRole
                                ColumnArgumentOrKeyRole
                                    ColumnElement
                        builtins.object
                            SQLRole
                                StatementRole
                                    Executable
                                        FunctionElement

Définition

class FunctionElement(Executable, ColumnElement, FromClause, Generative):

help(FunctionElement)

Base for SQL function-oriented constructs.

This is a `generic type <https://peps.python.org/pep-0484/#generics>`_,
meaning that type checkers and IDEs can be instructed on the types to
expect in a :class:`_engine.Result` for this function. See
:class:`.GenericFunction` for an example of how this is done.

.. seealso::

    :ref:`tutorial_functions` - in the :ref:`unified_tutorial`

    :class:`.Function` - named SQL function.

    :data:`.func` - namespace which produces registered or ad-hoc
    :class:`.Function` instances.

    :class:`.GenericFunction` - allows creation of registered function
    types.

Constructeur(s)

Signature du constructeur	Description
__init__(self, *clauses: '_ColumnExpressionOrLiteralArgument[Any]')	Construct a :class:`.FunctionElement`. _{[extrait de __init__.__doc__]}

Liste des attributs statiques

Nom de l'attribut	Valeur
allows_lambda	True
base_columns	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020D9F7432A0>
c	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020DA0A6DE50>
clauses	<sqlalchemy.util.langhelpers.HasMemoized.memoized_attribute object at 0x0000020DA0A71CD0>
columns	<sqlalchemy.util.langhelpers._non_memoized_property object at 0x0000020DA0A6DC70>
comparator	<sqlalchemy.util.langhelpers.HasMemoized.memoized_attribute object at 0x0000020D9F6F0190>
description	<sqlalchemy.util.langhelpers._non_memoized_property object at 0x0000020D9F937410>
foreign_keys	frozenset()
inherit_cache	None
is_clause_element	True
is_delete	False
is_dml	False
is_from_statement	False
is_insert	False
is_select	False
is_selectable	True
is_text	False
is_update	False
key	None
named_with_column	False
packagenames	()
primary_key	False
proxy_set	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020D9F73FF50>
schema	None
stringify_dialect	default
supports_execution	True
timetuple	None
type	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020D9F743230>
uses_inspection	True

Attributs statiques hérités de la classe FromClause

entity_namespace, exported_columns

Liste des propriétés

Nom de la propriété	Description
anon_key_label
anon_label
entity_namespace	overrides FromClause.entity_namespace as functions are generally _{[extrait de entity_namespace.__doc__]}
exported_columns
expression	Return a column expression. _{[extrait de expression.__doc__]}
selectable

Liste des opérateurs

Opérateurs hérités de la classe ClauseElement

__invert__

Liste des opérateurs

Opérateurs hérités de la classe ColumnOperators

__add__, __contains__, __eq__, __floordiv__, __ge__, __getitem__, __gt__, __le__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __radd__, __rfloordiv__, __rmod__, __rmul__, __rshift__, __rsub__, __rtruediv__, __sub__, __truediv__

Liste des opérateurs

Opérateurs hérités de la classe Operators

__and__, __or__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__class_getitem__	Parameterizes a generic class. _{[extrait de __class_getitem__.__doc__]}
alias(self, name: 'Optional[str]' = None, joins_implicitly: 'bool' = False) -> 'TableValuedAlias'	Produce a :class:`_expression.Alias` construct against this _{[extrait de alias.__doc__]}
as_comparison(self, left_index: 'int', right_index: 'int') -> 'FunctionAsBinary'	Interpret this expression as a boolean comparison between two _{[extrait de as_comparison.__doc__]}
column_valued(self, name: 'Optional[str]' = None, joins_implicitly: 'bool' = False) -> 'TableValuedColumn[_T]'	Return this :class:`_functions.FunctionElement` as a column expression that _{[extrait de column_valued.__doc__]}
filter(self, *criterion: '_ColumnExpressionArgument[bool]') -> 'Union[Self, FunctionFilter[_T]]'	Produce a FILTER clause against this function. _{[extrait de filter.__doc__]}
over(self, *, partition_by: 'Optional[_ByArgument]' = None, order_by: 'Optional[_ByArgument]' = None, rows: 'Optional[Tuple[Optional[int], Optional[int]]]' = None, range_: 'Optional[Tuple[Optional[int], Optional[int]]]' = None) -> 'Over[_T]'	Produce an OVER clause against this function. _{[extrait de over.__doc__]}
scalar_table_valued(self, name: 'str', type_: 'Optional[_TypeEngineArgument[_T]]' = None) -> 'ScalarFunctionColumn[_T]'	Return a column expression that's against this _{[extrait de scalar_table_valued.__doc__]}
select(self) -> 'Select[Tuple[_T]]'	Produce a :func:`_expression.select` construct _{[extrait de select.__doc__]}
self_group(self, against: 'Optional[OperatorType]' = None) -> 'ClauseElement'
table_valued(self, expr: '_ColumnExpressionOrStrLabelArgument[Any]', *kw: 'Any') -> 'TableValuedAlias'	Return a :class:`_sql.TableValuedAlias` representation of this _{[extrait de table_valued.__doc__]}
within_group(self, *order_by: '_ColumnExpressionArgument[Any]') -> 'WithinGroup[_T]'	Produce a WITHIN GROUP (ORDER BY expr) clause against this function. _{[extrait de within_group.__doc__]}
within_group_type(self, within_group: 'WithinGroup[_S]') -> 'Optional[TypeEngine[_S]]'	For types that define their return type as based on the criteria _{[extrait de within_group_type.__doc__]}

Méthodes héritées de la classe Generative

__init_subclass__, __subclasshook__

Méthodes héritées de la classe FromClause

is_derived_from, join, outerjoin, tablesample

Méthodes héritées de la classe Selectable

corresponding_column, lateral, replace_selectable

Méthodes héritées de la classe ColumnElement

__getattr__, __setstate__, cast, label, operate, reverse_operate, shares_lineage

Méthodes héritées de la classe ClauseElement

__bool__, __getstate__, __repr__, compare, params, unique_params

Méthodes héritées de la classe CompilerElement

__str__, compile

Méthodes héritées de la classe HasMemoized

memoized_attribute, memoized_instancemethod

Méthodes héritées de la classe HasTraverseInternals

get_children

Méthodes héritées de la classe ColumnOperators

all_, any_, asc, between, bitwise_and, bitwise_lshift, bitwise_not, bitwise_or, bitwise_rshift, bitwise_xor, collate, concat, contains, desc, distinct, endswith, icontains, iendswith, ilike, in_, is_, is_distinct_from, is_not, is_not_distinct_from, isnot, isnot_distinct_from, istartswith, like, match, not_ilike, not_in, not_like, notilike, notin_, notlike, nulls_first, nulls_last, nullsfirst, nullslast, regexp_match, regexp_replace, startswith