class documentation
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 |
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 |
Undocumented |
Class Variable | _is |
Undocumented |
Inherited from ORMOption
:
Method | _adapt |
adapt this option to the "uncached" version of itself in a loader strategy context. |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Class Variable | _is |
Undocumented |
Inherited from ExecutableOption
(via ORMOption
):
Class Variable | __visit |
Undocumented |
Method | _clone |
Create a shallow copy of this ExecutableOption. |
Class Variable | _is |
Undocumented |
Inherited from HasCopyInternals
(via ORMOption
, ExecutableOption
):
Method | _copy |
Reassign internal elements to be clones of themselves. |
Inherited from HasTraverseInternals
(via ORMOption
, ExecutableOption
, HasCopyInternals
):
Method | get |
Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`. |
Class Variable | _is |
Undocumented |
Class Variable | _traverse |
Undocumented |