Classe « Synonym »

Informations générales

Héritage

                builtins.object
                    TypingOnly
                builtins.object
                    Generic
                        _MappedAttribute
            builtins.object
                SQLRole
                    DDLConstraintColumnRole
            builtins.object
                TypingOnly
            builtins.object
                Generic
                    _MappedAnnotationBase
            builtins.object
                TypingOnly
            builtins.object
                Generic
                    ORMDescriptor
            builtins.object
                TypingOnly
        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
            TypingOnly
    builtins.object
        TypingOnly
builtins.object
    Operators
        ColumnOperators
    builtins.object
        Generic
            SQLCoreOperations
                SQLORMOperations
                    SQLORMExpression
                        Mapped
                            _DeclarativeMapped
            builtins.object
                MemoizedSlots
        builtins.object
            InspectionAttr
                InspectionAttrInfo
        builtins.object
            TypingOnly
        builtins.object
            Generic
                _MappedAttribute
            builtins.object
                _DCAttributeOptions
            builtins.object
                HasCacheKey
                    MapperProperty
                        DescriptorProperty
                            SynonymProperty
                                Synonym

Définition

class Synonym(SynonymProperty, _DeclarativeMapped):

help(Synonym)

Declarative front-end for the :class:`.SynonymProperty` class.

Public constructor is the :func:`_orm.synonym` function.

.. versionchanged:: 2.0 Added :class:`_orm.Synonym` as a Declarative
   compatible subclass for :class:`_orm.SynonymProperty`

.. seealso::

    :ref:`synonyms` - Overview of synonyms

Constructeur(s)

Signature du constructeur	Description
__init__(self, name: 'str', map_column: 'Optional[bool]' = None, descriptor: 'Optional[Any]' = None, comparator_factory: 'Optional[Type[PropComparator[_T]]]' = None, attribute_options: 'Optional[_AttributeOptions]' = None, info: 'Optional[_InfoType]' = None, doc: 'Optional[str]' = None)

Liste des attributs statiques

Nom de l'attribut	Valeur
allows_lambda	False
cascade	None
doc	None
extension_type	NotExtension.NOT_EXTENSION
inherit_cache	True
is_aliased_class	False
is_attribute	False
is_bundle	False
is_clause_element	False
is_instance	False
is_mapper	False
is_property	True
is_selectable	False
timetuple	None
uses_inspection	False

Attributs statiques hérités de la classe MapperProperty

info, key, parent

Liste des propriétés

Nom de la propriété	Description
class_attribute	Return the class-bound descriptor corresponding to this _{[extrait de class_attribute.__doc__]}
uses_objects

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__, __invert__, __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__]}

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

__init_subclass__, __sa_operate__, __subclasshook__, operate, reverse_operate

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

label

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