sqlalchemy.orm.context.ORMCompileState

class documentation

class ORMCompileState(AbstractORMCompileState): (source)

Known subclasses: sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

View In Hierarchy

Undocumented

Class default_compile_options Undocumented
Class Method create_for_statement Create a context for a statement given a :class:`.Compiler`.
Class Method get_column_descriptions Undocumented
Class Method orm_pre_session_exec Undocumented
Class Method orm_setup_cursor_result Undocumented
Method __init__ Undocumented
Class Variable attributes Undocumented
Class Variable compile_options Undocumented
Class Variable create_eager_joins Undocumented
Class Variable dedupe_columns Undocumented
Class Variable global_attributes Undocumented
Class Variable primary_columns Undocumented
Class Variable secondary_columns Undocumented
Class Variable select_statement Undocumented
Class Variable statement Undocumented
Class Variable use_legacy_query_style Undocumented
Class Method _column_naming_convention Undocumented
Class Method _create_entities_collection Undocumented
Method _append_dedupe_col_collection Undocumented
Method _create_with_polymorphic_adapter given MapperEntity or ORMColumnEntity, setup polymorphic loading if called for by the Mapper.
Method _mapper_loads_polymorphically_with Undocumented
Class Variable _entities Undocumented
Class Variable _has_mapper_entities Undocumented
Class Variable _label_convention Undocumented
Class Variable _polymorphic_adapters Undocumented
Class Variable _primary_entity Undocumented
Property _lead_mapper_entities return all _MapperEntity objects in the lead entities collection.

Inherited from AbstractORMCompileState:

Class Method orm_execute_statement Undocumented
Class Variable is_dml_returning Undocumented

Inherited from CompileState (via AbstractORMCompileState):

Class Method get_plugin_class Undocumented
Class Method plugin_for Undocumented
Class Variable __slots__ Undocumented
Class Variable plugins Undocumented
Class Method _get_plugin_class_for_plugin Undocumented
Class Variable _ambiguous_table_name_map Undocumented
@classmethod
def create_for_statement(cls, statement: Union[Select, FromStatement], compiler: Optional[SQLCompiler], **kw: Any) -> ORMCompileState: (source)
overrides sqlalchemy.orm.context.AbstractORMCompileState.create_for_statement
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Create a context for a statement given a :class:`.Compiler`. This method is always invoked in the context of SQLCompiler.process(). For a Select object, this would be invoked from SQLCompiler.visit_select(). For the special FromStatement object used by Query to indicate "Query.from_statement()", this is called by FromStatement._compiler_dispatch() that would be called by SQLCompiler.process().

@classmethod
def get_column_descriptions(cls, statement): (source)

Undocumented

@classmethod
def orm_pre_session_exec(cls, session, statement, params, execution_options, bind_arguments, is_pre_event): (source)
overrides sqlalchemy.orm.context.AbstractORMCompileState.orm_pre_session_exec

Undocumented

@classmethod
def orm_setup_cursor_result(cls, session, statement, params, execution_options, bind_arguments, result): (source)
overrides sqlalchemy.orm.context.AbstractORMCompileState.orm_setup_cursor_result

Undocumented

def __init__(self, *arg, **kw): (source)
overrides sqlalchemy.sql.base.CompileState.__init__

Undocumented

attributes: Dict[Any, Any] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

compile_options: Union[Type[default_compile_options], default_compile_options] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

create_eager_joins: List[Tuple[Any, ...]] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

dedupe_columns: Set[ColumnElement[Any]] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

global_attributes: Dict[Any, Any] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

primary_columns: List[ColumnElement[Any]] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

secondary_columns: List[ColumnElement[Any]] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

select_statement: Union[Select[Any], FromStatement[Any]] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

statement: Union[Select[Any], FromStatement[Any]] = (source)
overrides sqlalchemy.sql.base.CompileState.statement
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

use_legacy_query_style: bool = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

@classmethod
def _column_naming_convention(cls, label_style: SelectLabelStyle, legacy: bool) -> _LabelConventionCallable: (source)

Undocumented

@classmethod
def _create_entities_collection(cls, query, legacy): (source)
overridden in sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

def _append_dedupe_col_collection(self, obj, col_collection): (source)

Undocumented

def _create_with_polymorphic_adapter(self, ext_info, selectable): (source)

given MapperEntity or ORMColumnEntity, setup polymorphic loading if called for by the Mapper. As of #8168 in 2.0.0rc1, polymorphic adapters, which greatly increase the complexity of the query creation process, are not used at all except in the quasi-legacy cases of with_polymorphic referring to an alias and/or subquery. This would apply to concrete polymorphic loading, and joined inheritance where a subquery is passed to with_polymorphic (which is completely unnecessary in modern use).

def _mapper_loads_polymorphically_with(self, mapper, adapter): (source)

Undocumented

_entities: List[_QueryEntity] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

_has_mapper_entities: bool = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

_label_convention: _LabelConventionCallable = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

_polymorphic_adapters: Dict[_InternalEntityType, ORMAdapter] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

_primary_entity: Optional[_QueryEntity] = (source)
overridden in sqlalchemy.orm.context.ORMFromStatementCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

@property
_lead_mapper_entities = (source)

return all _MapperEntity objects in the lead entities collection. Does **not** include entities that have been replaced by with_entities(), with_only_columns()