sqlalchemy.orm.interfaces.MapperOption

class documentation

class MapperOption(ORMOption): (source)

View In Hierarchy

Describe a modification to a Query

Method process_query Apply a modification to the given :class:`_query.Query`.
Method process_query_conditionally same as process_query(), except that this option may not apply to the given query.
Class Variable __slots__ Undocumented
Class Variable propagate_to_loaders if True, indicate this option should be carried along to "secondary" Query objects produced during lazy loads or refresh operations.
Class Variable _is_legacy_option Undocumented

Inherited from ORMOption:

Method _adapt_cached_option_to_uncached_option adapt this option to the "uncached" version of itself in a loader strategy context.
Class Variable _is_compile_state Undocumented
Class Variable _is_core Undocumented
Class Variable _is_criteria_option Undocumented
Class Variable _is_strategy_option Undocumented
Class Variable _is_user_defined Undocumented

Inherited from ExecutableOption (via ORMOption):

Class Variable __visit_name__ Undocumented
Method _clone Create a shallow copy of this ExecutableOption.
Class Variable _is_has_cache_key Undocumented

Inherited from HasCopyInternals (via ORMOption, ExecutableOption):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from HasTraverseInternals (via ORMOption, ExecutableOption, HasCopyInternals):

Method get_children Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`.
Class Variable _is_immutable Undocumented
Class Variable _traverse_internals Undocumented
def process_query(self, query: Query[Any]): (source)

Apply a modification to the given :class:`_query.Query`.

def process_query_conditionally(self, query: Query[Any]): (source)

same as process_query(), except that this option may not apply to the given query. This is typically applied during a lazy load or scalar refresh operation to propagate options stated in the original Query to the new Query being used for the load. It occurs for those options that specify propagate_to_loaders=True.

__slots__: tuple = (source)
overrides sqlalchemy.orm.interfaces.ORMOption.__slots__

Undocumented

propagate_to_loaders: bool = (source)
overrides sqlalchemy.orm.interfaces.ORMOption.propagate_to_loaders

if True, indicate this option should be carried along to "secondary" Query objects produced during lazy loads or refresh operations.

_is_legacy_option: bool = (source)
overrides sqlalchemy.orm.interfaces.ORMOption._is_legacy_option

Undocumented