r"""declare a new ORM-mapped :class:`_schema.Column` construct for use within :ref:`Declarative Table ` configuration. The :func:`_orm.mapped_column` function provides an ORM-aware and Python-typing-compatible construct which is used with :ref:`declarative
(
__name_pos: Optional[
Union[str, _TypeEngineArgument[Any], SchemaEventTarget]
] = None,
__type_pos: Optional[
Union[_TypeEngineArgument[Any], SchemaEventTarget]
] = None,
*args: SchemaEventTarget,
init: Union[_NoArg, bool] = _NoArg.NO_ARG,
repr: Union[_NoArg, bool] = _NoArg.NO_ARG, # noqa: A002
default: Optional[Any] = _NoArg.NO_ARG,
default_factory: Union[_NoArg, Callable[[], _T]] = _NoArg.NO_ARG,
compare: Union[_NoArg, bool] = _NoArg.NO_ARG,
kw_only: Union[_NoArg, bool] = _NoArg.NO_ARG,
hash: Union[_NoArg, bool, None] = _NoArg.NO_ARG, # noqa: A002
nullable: Optional[
Union[bool, Literal[SchemaConst.NULL_UNSPECIFIED]]
] = SchemaConst.NULL_UNSPECIFIED,
primary_key: Optional[bool] = False,
deferred: Union[_NoArg, bool] = _NoArg.NO_ARG,
deferred_group: Optional[str] = None,
deferred_raiseload: Optional[bool] = None,
use_existing_column: bool = False,
name: Optional[str] = None,
type_: Optional[_TypeEngineArgument[Any]] = None,
autoincrement: _AutoIncrementType = "auto",
doc: Optional[str] = None,
key: Optional[str] = None,
index: Optional[bool] = None,
unique: Optional[bool] = None,
info: Optional[_InfoType] = None,
onupdate: Optional[Any] = None,
insert_default: Optional[Any] = _NoArg.NO_ARG,
server_default: Optional[_ServerDefaultArgument] = None,
server_onupdate: Optional[_ServerOnUpdateArgument] = None,
active_history: bool = False,
quote: Optional[bool] = None,
system: bool = False,
comment: Optional[str] = None,
sort_order: Union[_NoArg, int] = _NoArg.NO_ARG,
dataclass_metadata: Union[_NoArg, Mapping[Any, Any], None] = _NoArg.NO_ARG,
**kw: Any,
)
| 96 | |
| 97 | |
| 98 | def mapped_column( |
| 99 | __name_pos: Optional[ |
| 100 | Union[str, _TypeEngineArgument[Any], SchemaEventTarget] |
| 101 | ] = None, |
| 102 | __type_pos: Optional[ |
| 103 | Union[_TypeEngineArgument[Any], SchemaEventTarget] |
| 104 | ] = None, |
| 105 | *args: SchemaEventTarget, |
| 106 | init: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 107 | repr: Union[_NoArg, bool] = _NoArg.NO_ARG, # noqa: A002 |
| 108 | default: Optional[Any] = _NoArg.NO_ARG, |
| 109 | default_factory: Union[_NoArg, Callable[[], _T]] = _NoArg.NO_ARG, |
| 110 | compare: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 111 | kw_only: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 112 | hash: Union[_NoArg, bool, None] = _NoArg.NO_ARG, # noqa: A002 |
| 113 | nullable: Optional[ |
| 114 | Union[bool, Literal[SchemaConst.NULL_UNSPECIFIED]] |
| 115 | ] = SchemaConst.NULL_UNSPECIFIED, |
| 116 | primary_key: Optional[bool] = False, |
| 117 | deferred: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 118 | deferred_group: Optional[str] = None, |
| 119 | deferred_raiseload: Optional[bool] = None, |
| 120 | use_existing_column: bool = False, |
| 121 | name: Optional[str] = None, |
| 122 | type_: Optional[_TypeEngineArgument[Any]] = None, |
| 123 | autoincrement: _AutoIncrementType = "auto", |
| 124 | doc: Optional[str] = None, |
| 125 | key: Optional[str] = None, |
| 126 | index: Optional[bool] = None, |
| 127 | unique: Optional[bool] = None, |
| 128 | info: Optional[_InfoType] = None, |
| 129 | onupdate: Optional[Any] = None, |
| 130 | insert_default: Optional[Any] = _NoArg.NO_ARG, |
| 131 | server_default: Optional[_ServerDefaultArgument] = None, |
| 132 | server_onupdate: Optional[_ServerOnUpdateArgument] = None, |
| 133 | active_history: bool = False, |
| 134 | quote: Optional[bool] = None, |
| 135 | system: bool = False, |
| 136 | comment: Optional[str] = None, |
| 137 | sort_order: Union[_NoArg, int] = _NoArg.NO_ARG, |
| 138 | dataclass_metadata: Union[_NoArg, Mapping[Any, Any], None] = _NoArg.NO_ARG, |
| 139 | **kw: Any, |
| 140 | ) -> MappedColumn[Any]: |
| 141 | r"""declare a new ORM-mapped :class:`_schema.Column` construct |
| 142 | for use within :ref:`Declarative Table <orm_declarative_table>` |
| 143 | configuration. |
| 144 | |
| 145 | The :func:`_orm.mapped_column` function provides an ORM-aware and |
| 146 | Python-typing-compatible construct which is used with |
| 147 | :ref:`declarative <orm_declarative_mapping>` mappings to indicate an |
| 148 | attribute that's mapped to a Core :class:`_schema.Column` object. It |
| 149 | provides the equivalent feature as mapping an attribute to a |
| 150 | :class:`_schema.Column` object directly when using Declarative, |
| 151 | specifically when using :ref:`Declarative Table <orm_declarative_table>` |
| 152 | configuration. |
| 153 | |
| 154 | .. versionadded:: 2.0 |
| 155 |