sqlalchemy.orm.base.Mapped

class documentation

class Mapped(SQLORMExpression[_T], ORMDescriptor[_T], _MappedAnnotationBase[_T], roles.DDLConstraintColumnRole): (source)

Known subclasses: sqlalchemy.orm.base._DeclarativeMapped

View In Hierarchy

Represent an ORM mapped attribute on a mapped class. This class represents the complete descriptor interface for any class attribute that will have been :term:`instrumented` by the ORM :class:`_orm.Mapper` class. Provides appropriate information to type checkers such as pylance and mypy so that ORM-mapped attributes are correctly typed. The most prominent use of :class:`_orm.Mapped` is in the :ref:`Declarative Mapping <orm_explicit_declarative_base>` form of :class:`_orm.Mapper` configuration, where used explicitly it drives the configuration of ORM attributes such as :func:`_orm.mapped_class` and :func:`_orm.relationship`. .. seealso:: :ref:`orm_explicit_declarative_base` :ref:`orm_declarative_table` .. tip:: The :class:`_orm.Mapped` class represents attributes that are handled directly by the :class:`_orm.Mapper` class. It does not include other Python descriptor classes that are provided as extensions, including :ref:`hybrids_toplevel` and the :ref:`associationproxy_toplevel`. While these systems still make use of ORM-specific superclasses and structures, they are not :term:`instrumented` by the :class:`_orm.Mapper` and instead provide their own functionality when they are accessed on a class. .. versionadded:: 1.4

Method	`__delete__`	Undocumented
Method	`__get__`	Undocumented
Method	`__set__`	Undocumented
Class Variable	`__slots__`	Undocumented
Class Method	`_empty_constructor`	Undocumented

Inherited from SQLORMOperations (via SQLORMExpression):

Method	`and_`	Undocumented
Method	`any`	Undocumented
Method	`has`	Undocumented
Method	`of_type`	Undocumented

Inherited from SQLCoreOperations (via SQLORMExpression, SQLORMOperations, SQLColumnExpression):

Method	`__add__`	Implement the ``+`` operator.
Method	`__and__`	Implement the ``&`` operator.
Method	`__contains__`	Undocumented
Method	`__eq__`	Implement the ``==`` operator.
Method	`__floordiv__`	Implement the ``//`` operator.
Method	`__ge__`	Implement the ``>=`` operator.
Method	`__getitem__`	Implement the [] operator.
Method	`__gt__`	Implement the ``>`` operator.
Method	`__invert__`	Implement the ``~`` operator.
Method	`__le__`	Implement the ``<=`` operator.
Method	`__lt__`	Implement the ``<`` operator.
Method	`__mod__`	Implement the ``%`` operator.
Method	`__mul__`	Implement the ``*`` operator.
Method	`__ne__`	Implement the ``!=`` operator.
Method	`__neg__`	Implement the ``-`` operator.
Method	`__or__`	Implement the ``\|`` operator.
Method	`__radd__`	Implement the ``+`` operator in reverse.
Method	`__rfloordiv__`	Implement the ``//`` operator in reverse.
Method	`__rmod__`	Implement the ``%`` operator in reverse.
Method	`__rmul__`	Implement the ``*`` operator in reverse.
Method	`__rsub__`	Implement the ``-`` operator in reverse.
Method	`__rtruediv__`	Implement the ``/`` operator in reverse.
Method	`__sub__`	Implement the ``-`` operator.
Method	`__truediv__`	Implement the ``/`` operator.
Method	`all_`	Produce an :func:`_expression.all_` clause against the parent object.
Method	`any_`	Produce an :func:`_expression.any_` clause against the parent object.
Method	`asc`	Produce a :func:`_expression.asc` clause against the parent object.
Method	`between`	Produce a :func:`_expression.between` clause against the parent object, given the lower and upper range.
Method	`bool_op`	Return a custom boolean operator.
Method	`collate`	Produce a :func:`_expression.collate` clause against the parent object, given the collation string.
Method	`concat`	Implement the 'concat' operator.
Method	`contains`	Implement the 'contains' operator.
Method	`desc`	Produce a :func:`_expression.desc` clause against the parent object.
Method	`distinct`	Produce a :func:`_expression.distinct` clause against the parent object.
Method	`endswith`	Implement the 'endswith' operator.
Method	`ilike`	Implement the ``ilike`` operator, e.g. case insensitive LIKE.
Method	`in_`	Implement the ``in`` operator.
Method	`is_`	Implement the ``IS`` operator.
Method	`is_distinct_from`	Implement the ``IS DISTINCT FROM`` operator.
Method	`is_not`	Implement the ``IS NOT`` operator.
Method	`is_not_distinct_from`	Implement the ``IS NOT DISTINCT FROM`` operator.
Method	`isnot`	Undocumented
Method	`like`	Implement the ``like`` operator.
Method	`match`	Implements a database-specific 'match' operator.
Method	`not_ilike`	implement the ``NOT ILIKE`` operator.
Method	`not_in`	implement the ``NOT IN`` operator.
Method	`not_like`	implement the ``NOT LIKE`` operator.
Method	`notilike`	Undocumented
Method	`notin_`	Undocumented
Method	`notlike`	Undocumented
Method	`nulls_first`	Produce a :func:`_expression.nulls_first` clause against the parent object.
Method	`nulls_last`	Produce a :func:`_expression.nulls_last` clause against the parent object.
Method	`nullsfirst`	Undocumented
Method	`nullslast`	Undocumented
Method	`op`	Produce a generic operator function.
Method	`operate`	Operate on an argument.
Method	`regexp_match`	Implements a database-specific 'regexp match' operator.
Method	`regexp_replace`	Implements a database-specific 'regexp replace' operator.
Method	`reverse_operate`	Reverse operate on an argument.
Method	`startswith`	Implement the ``startswith`` operator.
Property	`_propagate_attrs`	Undocumented

Inherited from ExpressionElementRole (via SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations):

Method	`label`	Undocumented
Class Variable	`_role_name`	Undocumented

Inherited from ColumnOperators (via SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase):

Method	`__lshift__`	implement the << operator.
Method	`__rshift__`	implement the >> operator.
Method	`bitwise_and`	Produce a bitwise AND operation, typically via the ``&`` operator.
Method	`bitwise_lshift`	Produce a bitwise LSHIFT operation, typically via the ``<<`` operator.
Method	`bitwise_not`	Produce a bitwise NOT operation, typically via the ``~`` operator.
Method	`bitwise_or`	Produce a bitwise OR operation, typically via the ``\|`` operator.
Method	`bitwise_rshift`	Produce a bitwise RSHIFT operation, typically via the ``>>`` operator.
Method	`bitwise_xor`	Produce a bitwise XOR operation, typically via the ``^`` operator, or ``#`` for PostgreSQL.
Method	`icontains`	Implement the ``icontains`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.contains`.
Method	`iendswith`	Implement the ``iendswith`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.endswith`.
Method	`isnot_distinct_from`	Undocumented
Method	`istartswith`	Implement the ``istartswith`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.startswith`.
Class Variable	`timetuple`	Hack, allows datetime objects to be compared on the LHS.
Method	`_rconcat`	Implement an 'rconcat' operator.

Inherited from TypingOnly (via SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, ColumnOperators, Operators):

Method __init_subclass__ Undocumented

Inherited from SQLRole (via SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole):

Class Variable	`allows_lambda`	Undocumented
Class Variable	`uses_inspection`	Undocumented

def __delete__(self, instance: Any): (source) ¶

overridden in sqlalchemy.orm.attributes.InstrumentedAttribute

Undocumented

@overload

def __get__(self, instance: None, owner: Any) -> InstrumentedAttribute[_T]:

@overload

def __get__(self, instance: object, owner: Any) -> _T:

(source) ¶

overrides sqlalchemy.orm.base.ORMDescriptor.__get__

overridden in sqlalchemy.orm.attributes.InstrumentedAttribute

Undocumented

def __set__(self, instance: Any, value: Union[SQLCoreOperations[_T], _T]): (source) ¶

overridden in sqlalchemy.orm.attributes.InstrumentedAttribute

Undocumented

__slots__: tuple = (source) ¶

overrides sqlalchemy.orm.base.SQLORMExpression.__slots__

overridden in sqlalchemy.orm.base._DeclarativeMapped

Undocumented

@classmethod
def _empty_constructor(cls, arg1: Any) -> Mapped[_T]: (source) ¶

Undocumented