sqlalchemy.orm.descriptor_props.Synonym

Class Variable

inherit_cache

:meta private:

Inherited from SynonymProperty:

Method	__init__	Undocumented
Method	get_history	Undocumented
Method	set_parent	Set the parent mapper that references this MapperProperty.
Instance Variable	comparator_factory	Undocumented
Instance Variable	descriptor	Undocumented
Instance Variable	doc	optional documentation string
Instance Variable	map_column	Undocumented
Instance Variable	name	Undocumented
Instance Variable	parent	the :class:`.Mapper` managing this property.
Property	uses_objects	Undocumented
Method	_comparator_factory	Undocumented
Property	_proxied_object	Undocumented

Inherited from DescriptorProperty (via SynonymProperty):

Method	instrument_class	Hook called by the Mapper to the property to initiate instrumentation of the class attribute managed by this MapperProperty.
Class Variable	_links_to_entity	True if this MapperProperty refers to a mapped entity.

Inherited from MapperProperty (via SynonymProperty, DescriptorProperty):

Method	__repr__	Undocumented
Method	cascade_iterator	Iterate through instances related to the given instance for a particular 'cascade', starting with this MapperProperty.
Method	create_row_processor	Produce row processing functions and append to the given set of populators lists.
Method	do_init	Perform subclass-specific initialization post-mapper-creation steps.
Method	init	Called after all mappers are created to assemble relationships between mappers and perform other post-mapper-creation initialization steps.
Method	merge	Merge the attribute represented by this ``MapperProperty`` from source to destination object.
Method	post_instrument_class	Perform instrumentation adjustments that need to occur after init() has completed.
Method	setup	Called by Query for the purposes of constructing a SQL statement.
Class Variable	__slots__	Undocumented
Class Variable	cascade	Undocumented
Class Variable	comparator	The :class:`_orm.PropComparator` instance that implements SQL expression construction on behalf of this mapped attribute.
Class Variable	info	Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`.
Class Variable	is_property	Part of the InspectionAttr interface; states this object is a mapper property.
Class Variable	key	name of class attribute
Property	class_attribute	Return the class-bound descriptor corresponding to this :class:`.MapperProperty`.
Method	_memoized_attr_info	Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`.
Class Variable	_cache_key_traversal	Undocumented
Class Variable	_is_relationship	Undocumented
Instance Variable	_attribute_options	behavioral options for ORM-enabled Python attributes
Instance Variable	_configure_finished	Undocumented
Instance Variable	_configure_started	Undocumented
Instance Variable	_has_dataclass_arguments	Undocumented

Inherited from HasCacheKey (via SynonymProperty, DescriptorProperty, MapperProperty):

Class Method	_generate_cache_attrs	generate cache key dispatcher for a new class.
Class Method	_generate_cache_key_for_object	Undocumented
Method	_gen_cache_key	return an optional cache key.
Method	_generate_cache_key	return a cache key.
Class Variable	_generated_cache_key_traversal	Undocumented
Class Variable	_hierarchy_supports_caching	private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable	_is_has_cache_key	Undocumented

Inherited from _DeclarativeMapped (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions):

Method	operate	Operate on an argument.
Method	reverse_operate	Reverse operate on an argument.

Inherited from Mapped (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped):

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

Inherited from SQLORMOperations (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression):

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

Inherited from SQLCoreOperations (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _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 SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations):

Method	label	Undocumented
Class Variable	_role_name	Undocumented

Inherited from ColumnOperators (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _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 SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators):

Method

__init_subclass__

Undocumented

Inherited from InspectionAttr (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, InspectionAttrInfo):

Class Variable	is_aliased_class	True if this object is an instance of :class:`.AliasedClass`.
Class Variable	is_attribute	True if this object is a Python :term:`descriptor`.
Class Variable	is_bundle	True if this object is an instance of :class:`.Bundle`.
Class Variable	is_clause_element	True if this object is an instance of :class:`_expression.ClauseElement`.
Class Variable	is_instance	True if this object is an instance of :class:`.InstanceState`.
Class Variable	is_mapper	True if this object is an instance of :class:`_orm.Mapper`.
Class Variable	is_selectable	Return True if this object is an instance of :class:`_expression.Selectable`.
Class Variable	_is_internal_proxy	True if this object is an internal proxy object.

Inherited from MemoizedSlots (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, InspectionAttrInfo, InspectionAttr):

Method	__getattr__	Undocumented
Method	_fallback_getattr	Undocumented

Inherited from SQLRole (via SynonymProperty, DescriptorProperty, MapperProperty, HasCacheKey, _DCAttributeOptions, _DeclarativeMapped, Mapped, SQLORMExpression, SQLORMOperations, SQLColumnExpression, SQLCoreOperations, ExpressionElementRole, TypedColumnsClauseRole, ORMDescriptor, _MappedAnnotationBase, _MappedAttribute, ColumnOperators, Operators, TypingOnly, InspectionAttrInfo, InspectionAttr, MemoizedSlots, DDLConstraintColumnRole):

Class Variable	allows_lambda	Undocumented
Class Variable	uses_inspection	Undocumented