class documentation

class CriteriaOption(CompileStateOption):

Known subclasses: sqlalchemy.orm.util.LoaderCriteriaOption

View In Hierarchy

Describe a WHERE criteria modification to an ORM statement at compilation time.

New in version 1.4.
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.
def get_global_criteria(self, attributes):
update additional entity criteria options in the given attributes dictionary.
def process_compile_state(self, compile_state):
Apply a modification to a given .CompileState.
_is_criteria_option: bool =