sqlalchemy.orm.interfaces.ORMOption

class documentation

class ORMOption(ExecutableOption):

Known subclasses: sqlalchemy.orm.interfaces.CompileStateOption, sqlalchemy.orm.interfaces.MapperOption, sqlalchemy.orm.interfaces.UserDefinedOption

View In Hierarchy

Base class for option objects that are passed to ORM queries.

These options may be consumed by .Query.options, .Select.options, or in a more general sense by any .Executable.options method. They are interpreted at statement compile time or execution time in modern use. The deprecated .MapperOption is consumed at ORM query construction time.

New in version 1.4.
Class Variable __slots__ Undocumented
Class Variable ​_is​_compile​_state Undocumented
Class Variable ​_is​_criteria​_option Undocumented
Class Variable ​_is​_legacy​_option Undocumented
Class Variable ​_is​_strategy​_option Undocumented
Class Variable propagate​_to​_loaders if True, indicate this option should be carried along to "secondary" SELECT statements that occur for relationship lazy loaders as well as attribute load / refresh operations.

Inherited from ExecutableOption:

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 ExecutableOption):

Method ​_copy​_internals Reassign internal elements to be clones of themselves.
__slots__: tuple =

Undocumented

_is_compile_state: bool =
overridden in sqlalchemy.orm.interfaces.CompileStateOption

Undocumented

_is_criteria_option: bool =
overridden in sqlalchemy.orm.interfaces.CriteriaOption

Undocumented

_is_legacy_option: bool =
overridden in sqlalchemy.orm.interfaces.MapperOption, sqlalchemy.orm.interfaces.UserDefinedOption

Undocumented

_is_strategy_option: bool =
overridden in sqlalchemy.orm.strategy_options.Load

Undocumented

propagate_to_loaders: bool =
overridden in sqlalchemy.orm.strategy_options.Load, sqlalchemy.orm.interfaces.MapperOption, sqlalchemy.orm.interfaces.UserDefinedOption, sqlalchemy.orm.util.LoaderCriteriaOption
if True, indicate this option should be carried along to "secondary" SELECT statements that occur for relationship lazy loaders as well as attribute load / refresh operations.