sqlalchemy.sql.compiler.DDLCompiler

class documentation

class DDLCompiler(Compiled):

Known subclasses: sqlalchemy.databases.firebird.FBDDLCompiler, sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.mysql.MySQLDDLCompiler, sqlalchemy.databases.oracle.OracleDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler, sqlalchemy.databases.sybase.SybaseDDLCompiler

View In Hierarchy

Undocumented

Method	`construct_params`	Return the bind params for this compiled object.
Method	`define_constraint_remote_table`	Format the remote table clause of a CREATE CONSTRAINT clause.
Method	`_prepared_index_name`	Undocumented
Method	`_verify_index_table`	Undocumented
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	`get_column_default_string`	Undocumented
Method	`get_column_specification`	Undocumented
Method	`get_identity_options`	Undocumented
Method	`post_create_table`	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_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_table_comment`	Undocumented
Method	`visit_table_or_column_check_constraint`	Undocumented
Method	`visit_unique_constraint`	Undocumented
Property	`sql_compiler`	Return a Compiled that is capable of processing SQL expressions.
Property	`type_compiler`	Undocumented

Inherited from Compiled:

Method	`__init__`	Construct a new `.Compiled` object.
Method	`__str__`	Return the string text of the generated SQL or DDL.
Method	`_execute_on_connection`	Undocumented
Method	`process`	Undocumented
Method	`visit_unsupported_compilation`	Undocumented
Class Variable	`_cached_metadata`	Undocumented
Class Variable	`_result_columns`	Undocumented
Class Variable	`cache_key`	Undocumented
Class Variable	`compile_state`	Optional `.CompileState` object that maintains additional state used by the compiler.
Instance Variable	`_annotations`	Undocumented
Instance Variable	`_gen_time`	Undocumented
Instance Variable	`can_execute`	Undocumented
Instance Variable	`dialect`	Undocumented
Instance Variable	`execution_options`	Undocumented
Instance Variable	`preparer`	Undocumented
Instance Variable	`schema_translate_map`	Undocumented
Instance Variable	`statement`	Undocumented
Instance Variable	`string`	Undocumented
Property	`params`	Return the bind params for this compiled object.

def construct_params(self, params=None, extracted_parameters=None):

overrides sqlalchemy.sql.compiler.Compiled.construct_params

Return the bind params for this compiled object.

Parameters
params	a dict of string/object pairs whose values will override bind values compiled in to the statement.
extracted_parameters	Undocumented

def define_constraint_remote_table(self, constraint, table, preparer):

overridden in sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Format the remote table clause of a CREATE CONSTRAINT clause.

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

Undocumented

def _verify_index_table(self, index):

Undocumented

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

Undocumented

def create_table_suffix(self, table):

Undocumented

def define_constraint_cascades(self, constraint):

overridden in sqlalchemy.databases.oracle.OracleDDLCompiler

Undocumented

def define_constraint_deferrability(self, constraint):

Undocumented

def define_constraint_match(self, constraint):

overridden in sqlalchemy.databases.mysql.MySQLDDLCompiler

Undocumented

def get_column_default_string(self, column):

Undocumented

def get_column_specification(self, column, **kwargs):

overridden in sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.mysql.MySQLDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler, sqlalchemy.databases.sybase.SybaseDDLCompiler

Undocumented

def get_identity_options(self, identity_options):

overridden in sqlalchemy.databases.oracle.OracleDDLCompiler

Undocumented

def post_create_table(self, table):

overridden in sqlalchemy.databases.mysql.MySQLDDLCompiler, sqlalchemy.databases.oracle.OracleDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

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

Undocumented

def visit_check_constraint(self, constraint, **kw):

overridden in sqlalchemy.databases.postgresql.PGDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

def visit_column_check_constraint(self, constraint, **kw):

overridden in sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

def visit_computed_column(self, generated, **kw):

overridden in sqlalchemy.databases.firebird.FBDDLCompiler, sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.oracle.OracleDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler

Undocumented

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

Undocumented

def visit_create_index(self, create, include_schema=False, include_table_schema=True, **kw):

overridden in sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.mysql.MySQLDDLCompiler, sqlalchemy.databases.oracle.OracleDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

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

Undocumented

def visit_create_sequence(self, create, prefix=None, **kw):

overridden in sqlalchemy.databases.firebird.FBDDLCompiler, sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler

Undocumented

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

Undocumented

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

Undocumented

def visit_drop_column_comment(self, drop, **kw):

Undocumented

def visit_drop_constraint(self, drop, **kw):

overridden in sqlalchemy.databases.mysql.MySQLDDLCompiler

Undocumented

def visit_drop_index(self, drop, **kw):

Undocumented

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

Undocumented

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

overridden in sqlalchemy.databases.firebird.FBDDLCompiler

Undocumented

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

Undocumented

def visit_drop_table_comment(self, drop, **kw):

overridden in sqlalchemy.databases.mysql.MySQLDDLCompiler, sqlalchemy.databases.oracle.OracleDDLCompiler, sqlalchemy.databases.postgresql.PGDDLCompiler

Undocumented

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

Undocumented

def visit_foreign_key_constraint(self, constraint, **kw):

overridden in sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

def visit_identity_column(self, identity, **kw):

overridden in sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.oracle.OracleDDLCompiler

Undocumented

def visit_primary_key_constraint(self, constraint, **kw):

overridden in sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.mysql.MySQLDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

def visit_set_column_comment(self, create, **kw):

overridden in sqlalchemy.databases.mysql.MySQLDDLCompiler

Undocumented

def visit_set_table_comment(self, create, **kw):

overridden in sqlalchemy.databases.mysql.MySQLDDLCompiler

Undocumented

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

Undocumented

def visit_unique_constraint(self, constraint, **kw):

overridden in sqlalchemy.databases.mssql.MSDDLCompiler, sqlalchemy.databases.sqlite.SQLiteDDLCompiler

Undocumented

@util.memoized_property
sql_compiler =

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 =

Undocumented