sqlalchemy.sql.compiler.DDLCompiler

class documentation

class DDLCompiler(Compiled): (source)

Known subclasses: sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.oracle.base.OracleDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

View In Hierarchy

Undocumented

Method __init__ Construct a new :class:`.Compiled` object.
Method construct_params Return the bind params for this compiled object.
Method create_table_constraints Undocumented
Method create_table_suffix Undocumented
Method define_constraint_cascades Undocumented
Method define_constraint_deferrability Undocumented
Method define_constraint_match Undocumented
Method define_constraint_remote_table Format the remote table clause of a CREATE CONSTRAINT clause.
Method get_column_default_string Undocumented
Method get_column_specification Undocumented
Method get_identity_options Undocumented
Method post_create_table Undocumented
Method render_default_string Undocumented
Method visit_add_constraint Undocumented
Method visit_check_constraint Undocumented
Method visit_column_check_constraint Undocumented
Method visit_computed_column Undocumented
Method visit_create_column Undocumented
Method visit_create_index Undocumented
Method visit_create_schema Undocumented
Method visit_create_sequence Undocumented
Method visit_create_table Undocumented
Method visit_ddl Undocumented
Method visit_drop_column_comment Undocumented
Method visit_drop_constraint Undocumented
Method visit_drop_constraint_comment Undocumented
Method visit_drop_index Undocumented
Method visit_drop_schema Undocumented
Method visit_drop_sequence Undocumented
Method visit_drop_table Undocumented
Method visit_drop_table_comment Undocumented
Method visit_drop_view Undocumented
Method visit_foreign_key_constraint Undocumented
Method visit_identity_column Undocumented
Method visit_primary_key_constraint Undocumented
Method visit_set_column_comment Undocumented
Method visit_set_constraint_comment Undocumented
Method visit_set_table_comment Undocumented
Method visit_table_or_column_check_constraint Undocumented
Method visit_unique_constraint Undocumented
Class Variable is_ddl Undocumented
Property sql_compiler Return a Compiled that is capable of processing SQL expressions.
Property type_compiler Undocumented
Method _prepared_index_name Undocumented
Method _verify_index_table Undocumented

Inherited from Compiled:

Method __init_subclass__ Undocumented
Method __str__ Return the string text of the generated SQL or DDL.
Method process Undocumented
Method visit_unsupported_compilation Undocumented
Class Variable cache_key The :class:`.CacheKey` that was generated ahead of creating this :class:`.Compiled` object.
Class Variable compile_state Optional :class:`.CompileState` object that maintains additional state used by the compiler.
Class Variable dml_compile_state Optional :class:`.CompileState` assigned at the same point that .isinsert, .isupdate, or .isdelete is assigned.
Class Variable is_sql Undocumented
Instance Variable can_execute Undocumented
Instance Variable dialect Undocumented
Instance Variable execution_options Undocumented
Instance Variable preparer Undocumented
Instance Variable schema_translate_map Execution options propagated from the statement. In some cases, sub-elements of the statement can modify these.
Instance Variable state description of the compiler's state
Instance Variable statement The statement to compile.
Instance Variable string The string representation of the ``statement``
Property params Return the bind params for this compiled object.
Class Method _init_compiler_cls Undocumented
Method _execute_on_connection Undocumented
Class Variable _cached_metadata Undocumented
Class Variable _result_columns Undocumented
Instance Variable _annotations Undocumented
Instance Variable _gen_time Generation time of this :class:`.Compiled`, used for reporting cache stats.
def __init__(self, dialect: Dialect, statement: ExecutableDDLElement, schema_translate_map: Optional[SchemaTranslateMapType] = ..., render_schema_translate: bool = ..., compile_kwargs: Mapping[str, Any] = ...): (source)
overrides sqlalchemy.sql.compiler.Compiled.__init__

Construct a new :class:`.Compiled` object. :param dialect: :class:`.Dialect` to compile against. :param statement: :class:`_expression.ClauseElement` to be compiled. :param schema_translate_map: dictionary of schema names to be translated when forming the resultant SQL .. versionadded:: 1.1 .. seealso:: :ref:`schema_translating` :param compile_kwargs: additional kwargs that will be passed to the initial call to :meth:`.Compiled.process`.

def construct_params(self, params: Optional[_CoreSingleExecuteParams] = None, extracted_parameters: Optional[Sequence[BindParameter[Any]]] = None, escape_names: bool = True) -> Optional[_MutableCoreSingleExecuteParams]: (source)
overrides sqlalchemy.sql.compiler.Compiled.construct_params

Return the bind params for this compiled object. :param params: a dict of string/object pairs whose values will override bind values compiled in to the statement.

def create_table_constraints(self, table, _include_foreign_key_constraints=None, **kw): (source)

Undocumented

def create_table_suffix(self, table): (source)

Undocumented

def define_constraint_cascades(self, constraint): (source)
overridden in sqlalchemy.dialects.oracle.base.OracleDDLCompiler

Undocumented

def define_constraint_deferrability(self, constraint): (source)

Undocumented

def define_constraint_match(self, constraint): (source)
overridden in sqlalchemy.dialects.mysql.base.MySQLDDLCompiler

Undocumented

def define_constraint_remote_table(self, constraint, table, preparer): (source)
overridden in sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Format the remote table clause of a CREATE CONSTRAINT clause.

def get_column_default_string(self, column): (source)

Undocumented

def get_column_specification(self, column, **kwargs): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def get_identity_options(self, identity_options): (source)
overridden in sqlalchemy.dialects.oracle.base.OracleDDLCompiler

Undocumented

def post_create_table(self, table): (source)
overridden in sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.oracle.base.OracleDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def render_default_string(self, default): (source)

Undocumented

def visit_add_constraint(self, create, **kw): (source)

Undocumented

def visit_check_constraint(self, constraint, **kw): (source)
overridden in sqlalchemy.dialects.postgresql.base.PGDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def visit_column_check_constraint(self, constraint, **kw): (source)
overridden in sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def visit_computed_column(self, generated, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.oracle.base.OracleDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler

Undocumented

def visit_create_column(self, create, first_pk=False, **kw): (source)

Undocumented

def visit_create_index(self, create, include_schema=False, include_table_schema=True, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.oracle.base.OracleDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def visit_create_schema(self, create, **kw): (source)

Undocumented

def visit_create_sequence(self, create, prefix=None, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler

Undocumented

def visit_create_table(self, create, **kw): (source)

Undocumented

def visit_ddl(self, ddl, **kwargs): (source)

Undocumented

def visit_drop_column_comment(self, drop, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler

Undocumented

def visit_drop_constraint(self, drop, **kw): (source)
overridden in sqlalchemy.dialects.mysql.base.MySQLDDLCompiler

Undocumented

def visit_drop_constraint_comment(self, drop, **kw): (source)
overridden in sqlalchemy.dialects.postgresql.base.PGDDLCompiler

Undocumented

def visit_drop_index(self, drop, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.postgresql.base.PGDDLCompiler

Undocumented

def visit_drop_schema(self, drop, **kw): (source)

Undocumented

def visit_drop_sequence(self, drop, **kw): (source)

Undocumented

def visit_drop_table(self, drop, **kw): (source)

Undocumented

def visit_drop_table_comment(self, drop, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.oracle.base.OracleDDLCompiler

Undocumented

def visit_drop_view(self, drop, **kw): (source)

Undocumented

def visit_foreign_key_constraint(self, constraint, **kw): (source)
overridden in sqlalchemy.dialects.postgresql.base.PGDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def visit_identity_column(self, identity, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.oracle.base.OracleDDLCompiler

Undocumented

def visit_primary_key_constraint(self, constraint, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

def visit_set_column_comment(self, create, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler

Undocumented

def visit_set_constraint_comment(self, create, **kw): (source)
overridden in sqlalchemy.dialects.postgresql.base.PGDDLCompiler

Undocumented

def visit_set_table_comment(self, create, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.mysql.base.MySQLDDLCompiler

Undocumented

def visit_table_or_column_check_constraint(self, constraint, **kw): (source)

Undocumented

def visit_unique_constraint(self, constraint, **kw): (source)
overridden in sqlalchemy.dialects.mssql.base.MSDDLCompiler, sqlalchemy.dialects.sqlite.base.SQLiteDDLCompiler

Undocumented

is_ddl: bool = (source)
overrides sqlalchemy.sql.compiler.Compiled.is_ddl

Undocumented

@util.memoized_property
sql_compiler = (source)
overrides sqlalchemy.sql.compiler.Compiled.sql_compiler

Return a Compiled that is capable of processing SQL expressions. If this compiler is one, it would likely just return 'self'.

@util.memoized_property
type_compiler = (source)

Undocumented

def _prepared_index_name(self, index, include_schema=False): (source)

Undocumented

def _verify_index_table(self, index): (source)

Undocumented