class CriteriaOption(CompileStateOption):
Known subclasses: sqlalchemy.orm.util.LoaderCriteriaOption
Describe a WHERE criteria modification to an ORM statement at compilation time.
Method | get_global_criteria |
update additional entity criteria options in the given attributes dictionary. |
Method | process_compile_state |
Apply a modification to a given .CompileState . |
Class Variable | _is_criteria_option |
Undocumented |
Inherited from CompileStateOption
:
Method | process_compile_state_replaced_entities |
Apply a modification to a given .CompileState , given entities that were replaced by with_only_columns() or with_entities(). |
Class Variable | _is_compile_state |
Undocumented |
Inherited from HasCacheKey
(via CompileStateOption
):
Class Variable | inherit_cache |
Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass. |
Class Method | _generate_cache_attrs |
generate cache key dispatcher for a new class. |
Class Method | _generate_cache_key_for_object |
Undocumented |
Method | _gen_cache_key |
return an optional cache key. |
Method | _generate_cache_key |
return a cache key. |
Class Variable | __slots__ |
Undocumented |
Class Variable | _hierarchy_supports_caching |
private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses. |
Class Variable | _is_has_cache_key |
Undocumented |
Inherited from ORMOption
(via CompileStateOption
):
Class Variable | __slots__ |
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
(via CompileStateOption
, 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 CompileStateOption
, ORMOption
, ExecutableOption
):
Method | _copy_internals |
Reassign internal elements to be clones of themselves. |
sqlalchemy.orm.util.LoaderCriteriaOption
sqlalchemy.orm.util.LoaderCriteriaOption
.CompileState
.