sqlalchemy.orm.properties.MappedColumn

class documentation

class MappedColumn(_IntrospectsAnnotations, _MapsColumns[_T], _DeclarativeMapped[_T]): (source)

View In Hierarchy

Maps a single :class:`_schema.Column` on a class. :class:`_orm.MappedColumn` is a specialization of the :class:`_orm.ColumnProperty` class and is oriented towards declarative configuration. To construct :class:`_orm.MappedColumn` objects, use the :func:`_orm.mapped_column` constructor function. .. versionadded:: 2.0

Method __clause_element__ Undocumented
Method __init__ Undocumented
Method declarative_scan Perform class-specific initializaton at early declarative scanning time.
Method declarative_scan_for_composite Undocumented
Method found_in_pep593_annotated return a copy of this object to use in declarative when the object is found inside of an Annotated object.
Method operate Operate on an argument.
Method reverse_operate Reverse operate on an argument.
Class Variable __slots__ Undocumented
Instance Variable column Undocumented
Instance Variable deferred Undocumented
Instance Variable deferred_group Undocumented
Instance Variable deferred_raiseload Undocumented
Instance Variable foreign_keys Undocumented
Property columns_to_assign A list of Column objects that should be declaratively added to the new Table object.
Property mapper_property_to_assign return a MapperProperty to be assigned to the declarative mapping
Property name Undocumented
Method _copy Undocumented
Method _init_column_for_annotation Undocumented
Instance Variable _attribute_options behavioral options for ORM-enabled Python attributes
Instance Variable _has_dataclass_arguments Undocumented
Instance Variable _has_insert_default Undocumented
Instance Variable _has_nullable Undocumented
Instance Variable _sort_order Undocumented
Instance Variable _use_existing_column Undocumented

Inherited from _IntrospectsAnnotations:

Method _raise_for_required Undocumented

Inherited from Mapped (via _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped):

Method __delete__ Undocumented
Method __get__ Undocumented
Method __set__ Undocumented
Class Method _empty_constructor Undocumented

Inherited from SQLORMOperations (via _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression):

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

Inherited from SQLCoreOperations (via _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped, Mapped, 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 regexp_match Implements a database-specific 'regexp match' operator.
Method regexp_replace Implements a database-specific 'regexp replace' operator.
Method startswith Implement the ``startswith`` operator.
Property _propagate_attrs Undocumented

Inherited from ExpressionElementRole (via _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations):

Method label Undocumented
Class Variable _role_name Undocumented

Inherited from ColumnOperators (via _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute):

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 _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators):

Method __init_subclass__ Undocumented

Inherited from SQLRole (via _IntrospectsAnnotations, _MapsColumns, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, DDLConstraintColumnRole):

Class Variable allows_lambda Undocumented
Class Variable uses_inspection Undocumented
def __clause_element__(self) -> Column[_T]: (source)

Undocumented

def __init__(self, *arg: Any, **kw: Any): (source)

Undocumented

def declarative_scan(self, decl_scan: _ClassScanMapperConfig, registry: _RegistryType, cls: Type[Any], originating_module: Optional[str], key: str, mapped_container: Optional[Type[Mapped[Any]]], annotation: Optional[_AnnotationScanType], extracted_mapped_annotation: Optional[_AnnotationScanType], is_dataclass_field: bool): (source)
overrides sqlalchemy.orm.interfaces._IntrospectsAnnotations.declarative_scan

Perform class-specific initializaton at early declarative scanning time. .. versionadded:: 2.0

@util.preload_module('sqlalchemy.orm.decl_base')
def declarative_scan_for_composite(self, registry: _RegistryType, cls: Type[Any], originating_module: Optional[str], key: str, param_name: str, param_annotation: _AnnotationScanType): (source)

Undocumented

def found_in_pep593_annotated(self) -> Any: (source)
overrides sqlalchemy.orm.interfaces._IntrospectsAnnotations.found_in_pep593_annotated

return a copy of this object to use in declarative when the object is found inside of an Annotated object.

def operate(self, op: OperatorType, *other: Any, **kwargs: Any) -> ColumnElement[Any]: (source)
overrides sqlalchemy.orm.base._DeclarativeMapped.operate

Operate on an argument. This is the lowest level of operation, raises :class:`NotImplementedError` by default. Overriding this on a subclass can allow common behavior to be applied to all operations. For example, overriding :class:`.ColumnOperators` to apply ``func.lower()`` to the left and right side:: class MyComparator(ColumnOperators): def operate(self, op, other, **kwargs): return op(func.lower(self), func.lower(other), **kwargs) :param op: Operator callable. :param \*other: the 'other' side of the operation. Will be a single scalar for most operations. :param \**kwargs: modifiers. These may be passed by special operators such as :meth:`ColumnOperators.contains`.

def reverse_operate(self, op: OperatorType, other: Any, **kwargs: Any) -> ColumnElement[Any]: (source)
overrides sqlalchemy.orm.base._DeclarativeMapped.reverse_operate

Reverse operate on an argument. Usage is the same as :meth:`operate`.

__slots__: tuple[str, ...] = (source)
overrides sqlalchemy.orm.interfaces._IntrospectsAnnotations.__slots__

Undocumented

column = (source)

Undocumented

deferred = (source)

Undocumented

deferred_group = (source)

Undocumented

deferred_raiseload = (source)

Undocumented

foreign_keys = (source)

Undocumented

@property
columns_to_assign: List[Tuple[Column[Any], int]] = (source)
overrides sqlalchemy.orm.interfaces._MapsColumns.columns_to_assign

A list of Column objects that should be declaratively added to the new Table object.

@property
mapper_property_to_assign: Optional[MapperProperty[_T]] = (source)
overrides sqlalchemy.orm.interfaces._MapsColumns.mapper_property_to_assign

return a MapperProperty to be assigned to the declarative mapping

@property
name: str = (source)

Undocumented

def _copy(self, **kw: Any) -> Self: (source)

Undocumented

def _init_column_for_annotation(self, cls: Type[Any], registry: _RegistryType, argument: _AnnotationScanType, originating_module: Optional[str]): (source)

Undocumented

_attribute_options = (source)
overrides sqlalchemy.orm.interfaces._DCAttributeOptions._attribute_options

behavioral options for ORM-enabled Python attributes .. versionadded:: 2.0

_has_dataclass_arguments: bool = (source)
overrides sqlalchemy.orm.interfaces._DCAttributeOptions._has_dataclass_arguments

Undocumented

_has_insert_default = (source)

Undocumented

_has_nullable = (source)

Undocumented

_sort_order = (source)

Undocumented

_use_existing_column = (source)

Undocumented