sqlalchemy.orm.interfaces.UserDefinedOption

class documentation

class UserDefinedOption(ORMOption):

View In Hierarchy

Base class for a user-defined option that can be consumed from the .SessionEvents.do_orm_execute event hook.
Method __init__ Undocumented
Class Variable ​_is​_legacy​_option 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

Inherited from ORMOption:

Class Variable __slots__ Undocumented
Class Variable ​_is​_compile​_state Undocumented
Class Variable ​_is​_criteria​_option Undocumented
Class Variable ​_is​_strategy​_option Undocumented

Inherited from ExecutableOption (via ORMOption):

Method ​_clone Create a shallow copy of this ExecutableOption.
Class Variable __visit​_name__ Undocumented
Class Variable ​_is​_has​_cache​_key Undocumented

Inherited from HasCopyInternals (via ORMOption, ExecutableOption):

Method ​_copy​_internals Reassign internal elements to be clones of themselves.
def __init__(self, payload=None):

Undocumented

_is_legacy_option: bool =
overrides sqlalchemy.orm.interfaces.ORMOption._is_legacy_option

Undocumented

propagate_to_loaders: bool =
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.
payload =

Undocumented