sqlalchemy.sql.base.CompileState

class documentation

class CompileState: (source)

Known subclasses: sqlalchemy.orm.context.AbstractORMCompileState, sqlalchemy.sql.dml.DMLState, sqlalchemy.sql.selectable.CompoundSelectState, sqlalchemy.sql.selectable.SelectState

View In Hierarchy

Produces additional object state necessary for a statement to be compiled. the :class:`.CompileState` class is at the base of classes that assemble state for a particular statement object that is then used by the compiler. This process is essentially an extension of the process that the SQLCompiler.visit_XYZ() method takes, however there is an emphasis on converting raw user intent into more organized structures rather than producing string output. The top-level :class:`.CompileState` for the statement being executed is also accessible when the execution context works with invoking the statement and collecting results. The production of :class:`.CompileState` is specific to the compiler, such as within the :meth:`.SQLCompiler.visit_insert`, :meth:`.SQLCompiler.visit_select` etc. methods. These methods are also responsible for associating the :class:`.CompileState` with the :class:`.SQLCompiler` itself, if the statement is the "toplevel" statement, i.e. the outermost SQL statement that's actually being executed. There can be other :class:`.CompileState` objects that are not the toplevel, such as when a SELECT subquery or CTE-nested INSERT/UPDATE/DELETE is generated. .. versionadded:: 1.4

Class Method create_for_statement Undocumented
Class Method get_plugin_class Undocumented
Class Method plugin_for Undocumented
Method __init__ Undocumented
Class Variable __slots__ Undocumented
Class Variable plugins Undocumented
Instance Variable statement Undocumented
Class Method _get_plugin_class_for_plugin Undocumented
Class Variable _ambiguous_table_name_map Undocumented
@classmethod
def create_for_statement(cls, statement, compiler, **kw): (source)
overridden in sqlalchemy.orm.bulk_persistence.BulkORMDelete, sqlalchemy.orm.bulk_persistence.BulkORMInsert, sqlalchemy.orm.bulk_persistence.BulkORMUpdate, sqlalchemy.orm.context.AbstractORMCompileState, sqlalchemy.orm.context.ORMSelectCompileState

Undocumented

@classmethod
def get_plugin_class(cls, statement: Executable) -> Optional[Type[CompileState]]: (source)
overridden in sqlalchemy.sql.dml.DMLState, sqlalchemy.sql.selectable.SelectState

Undocumented

@classmethod
def plugin_for(cls, plugin_name: str, visit_name: str) -> Callable[[_Fn], _Fn]: (source)

Undocumented

def __init__(self, statement, compiler, **kw): (source)
overridden in sqlalchemy.orm.context.ORMCompileState, sqlalchemy.sql.dml.DMLState, sqlalchemy.sql.selectable.SelectState

Undocumented

__slots__: tuple[str, ...] = (source)
overridden in sqlalchemy.sql.selectable.SelectState

Undocumented

plugins: Dict[Tuple[str, str], Type[CompileState]] = (source)

Undocumented

statement = (source)
overridden in sqlalchemy.orm.bulk_persistence.BulkORMDelete, sqlalchemy.orm.bulk_persistence.BulkORMInsert, sqlalchemy.orm.bulk_persistence.BulkORMUpdate, sqlalchemy.orm.context.ORMCompileState, sqlalchemy.sql.dml.DMLState, sqlalchemy.sql.selectable.SelectState

Undocumented

@classmethod
def _get_plugin_class_for_plugin(cls, statement: Executable, plugin_name: str) -> Optional[Type[CompileState]]: (source)

Undocumented

_ambiguous_table_name_map: Optional[_AmbiguousTableNameMap] = (source)
overridden in sqlalchemy.sql.selectable.SelectState

Undocumented