class documentation

class UserDefinedOption(ORMOption): (source)

View In Hierarchy

Base class for a user-defined option that can be consumed from the :meth:`.SessionEvents.do_orm_execute` event hook.

Method __init__ Undocumented
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.
Instance Variable payload Undocumented
Class Variable _is_legacy_option Undocumented
Class Variable _is_user_defined 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

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 __init__(self, payload: Optional[Any] = None): (source)

Undocumented

propagate_to_loaders: bool = (source)

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

Undocumented