sqlalchemy.sql.ddl._CreateDropBase

class documentation

class _CreateDropBase(DDLElement):

Known subclasses: sqlalchemy.sql.ddl.AddConstraint, sqlalchemy.sql.ddl.CreateIndex, sqlalchemy.sql.ddl.CreateSchema, sqlalchemy.sql.ddl.CreateSequence, sqlalchemy.sql.ddl.CreateTable, sqlalchemy.sql.ddl.DropConstraint, sqlalchemy.sql.ddl.DropIndex, sqlalchemy.sql.ddl.DropSchema, sqlalchemy.sql.ddl.DropSequence, sqlalchemy.sql.ddl.DropTable, sqlalchemy.dialects.postgresql.CreateEnumType, sqlalchemy.dialects.postgresql.DropEnumType, sqlalchemy.sql.ddl._DropView, sqlalchemy.sql.ddl.DropColumnComment, sqlalchemy.sql.ddl.DropTableComment, sqlalchemy.sql.ddl.SetColumnComment, sqlalchemy.sql.ddl.SetTableComment

View In Hierarchy

Base class for DDL constructs that represent CREATE and DROP or equivalents.

The common theme of _CreateDropBase is a single element attribute which refers to the element to be created or dropped.

Method __init__ Undocumented
Method ​_create​_rule​_disable Allow disable of _create_rule using a callable.
Instance Variable element Undocumented
Instance Variable if​_exists Undocumented
Instance Variable if​_not​_exists Undocumented
Property stringify​_dialect Undocumented

Inherited from DDLElement:

Method __call__ Execute the DDL as a ddl_listener.
Method ​_execute​_on​_connection Undocumented
Method ​_generate Undocumented
Method ​_set​_bind Undocumented
Method ​_should​_execute Undocumented
Method against Return a copy of this _schema.DDLElement which will include the given target.
Method bind Returns the _engine.Engine or _engine.Connection to which this .Executable is bound, or None if none found.
Method execute Execute this DDL immediately.
Method execute​_if Return a callable that will execute this _ddl.DDLElement conditionally within an event handler.
Class Variable ​_execution​_options Undocumented
Class Variable on Undocumented
Instance Variable ​_bind Undocumented
Instance Variable callable​_ Undocumented
Instance Variable dialect Undocumented
Instance Variable state Undocumented
Instance Variable target Undocumented

Inherited from StatementRole (via DDLElement, DDLRole):

Class Variable ​_propagate​_attrs Undocumented
Class Variable ​_role​_name Undocumented

Inherited from SQLRole (via DDLElement, DDLRole, StatementRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from Executable (via DDLElement):

Method ​_add​_context​_option Add a context option to this statement.
Method ​_set​_compile​_options Assign the compile options to a new value.
Method ​_update​_compile​_options update the _compile_options with new keys.
Method execution​_options Set non-SQL options for the statement which take effect during execution.
Method get​_execution​_options Get the non-SQL options which will take effect during execution.
Method options Apply options to this statement.
Method scalar Compile and execute this .Executable, returning the result's scalar representation.
Class Variable ​_executable​_traverse​_internals Undocumented
Class Variable ​_with​_context​_options Undocumented
Class Variable ​_with​_options Undocumented
Class Variable is​_delete Undocumented
Class Variable is​_dml Undocumented
Class Variable is​_insert Undocumented
Class Variable is​_select Undocumented
Class Variable is​_text Undocumented
Class Variable is​_update Undocumented
Class Variable supports​_execution Undocumented
Instance Variable ​_compile​_options Undocumented
Property ​_effective​_plugin​_target Undocumented

Inherited from StatementRole (via DDLElement, Executable):

Class Variable ​_propagate​_attrs Undocumented
Class Variable ​_role​_name Undocumented

Inherited from SQLRole (via DDLElement, Executable, StatementRole):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from _DDLCompiles (via DDLElement):

Method ​_compile​_w​_cache Undocumented
Method ​_compiler Return a compiler appropriate for this ClauseElement, given a Dialect.
Class Variable ​_hierarchy​_supports​_caching disable cache warnings for all _DDLCompiles subclasses.

Inherited from ClauseElement (via DDLElement, _DDLCompiles):

Method compare Compare this _expression.ClauseElement to the given _expression.ClauseElement.
Method compile Compile this SQL expression.
Method params Return a copy with _expression.bindparam elements replaced.
Method self​_group Apply a 'grouping' to this _expression.ClauseElement.
Method unique​_params Return a copy with _expression.bindparam elements replaced.
Method __bool__ Undocumented
Method __getstate__ Undocumented
Method __invert__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method ​_clone Create a shallow copy of this ClauseElement.
Method ​_cloned​_set Return the set consisting all cloned ancestors of this ClauseElement.
Method ​_negate Undocumented
Method ​_negate​_in​_binary a hook to allow the right side of a binary expression to respond to a negation of the binary expression.
Method ​_replace​_params Undocumented
Method ​_set​_propagate​_attrs Undocumented
Method ​_ungroup Return this _expression.ClauseElement without any groupings.
Method ​_with​_binary​_element​_type in the context of binary expression, convert the type of this object to the one given.
Class Variable __visit​_name__ Undocumented
Class Variable ​_cache​_key​_traversal Undocumented
Class Variable ​_from​_objects Undocumented
Class Variable ​_is​_bind​_parameter Undocumented
Class Variable ​_is​_clause​_list Undocumented
Class Variable ​_is​_clone​_of Undocumented
Class Variable ​_is​_from​_clause Undocumented
Class Variable ​_is​_from​_container Undocumented
Class Variable ​_is​_immutable Undocumented
Class Variable ​_is​_lambda​_element Undocumented
Class Variable ​_is​_returns​_rows Undocumented
Class Variable ​_is​_select​_container Undocumented
Class Variable ​_is​_select​_statement Undocumented
Class Variable ​_is​_singleton​_constant Undocumented
Class Variable ​_is​_text​_clause Undocumented
Class Variable ​_is​_textual Undocumented
Class Variable ​_order​_by​_label​_element Undocumented
Class Variable description Undocumented
Class Variable is​_clause​_element Undocumented
Class Variable is​_selectable Undocumented
Class Variable supports​_execution Undocumented
Instance Variable ​_propagate​_attrs like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time.
Property ​_constructor return the 'constructor' for this ClauseElement.
Property entity​_namespace Undocumented

Inherited from SQLRole (via DDLElement, _DDLCompiles, ClauseElement):

Class Variable allows​_lambda Undocumented
Class Variable uses​_inspection Undocumented

Inherited from SupportsWrappingAnnotations (via DDLElement, _DDLCompiles, ClauseElement):

Method ​_annotate return a copy of this ClauseElement with annotations updated by the given dictionary.
Method ​_deannotate return a copy of this _expression.ClauseElement with annotations removed.
Method ​_with​_annotations return a copy of this ClauseElement with annotations replaced by the given dictionary.

Inherited from SupportsAnnotations (via DDLElement, _DDLCompiles, ClauseElement, SupportsWrappingAnnotations):

Property ​_annotations​_cache​_key Undocumented

Inherited from MemoizedHasCacheKey (via DDLElement, _DDLCompiles, ClauseElement):

Method ​_generate​_cache​_key return a cache key.

Inherited from HasCacheKey (via DDLElement, _DDLCompiles, ClauseElement, MemoizedHasCacheKey):

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.
Class Variable __slots__ Undocumented
Class Variable ​_is​_has​_cache​_key Undocumented

Inherited from HasCopyInternals (via DDLElement, _DDLCompiles, ClauseElement):

Method ​_copy​_internals Reassign internal elements to be clones of themselves.

Inherited from Traversible (via DDLElement, _DDLCompiles, ClauseElement):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented
@util.deprecated_params(bind=('2.0', 'The :paramref:`_ddl.DDLElement.bind` argument is deprecated and will be removed in SQLAlchemy 2.0.'))
def __init__(self, element, bind=None, if_exists=False, if_not_exists=False, _legacy_bind=None):
overridden in sqlalchemy.sql.ddl.AddConstraint, sqlalchemy.sql.ddl.CreateIndex, sqlalchemy.sql.ddl.CreateSchema, sqlalchemy.sql.ddl.CreateTable, sqlalchemy.sql.ddl.DropConstraint, sqlalchemy.sql.ddl.DropIndex, sqlalchemy.sql.ddl.DropSchema, sqlalchemy.sql.ddl.DropTable

Undocumented

def _create_rule_disable(self, compiler):

Allow disable of _create_rule using a callable.

Pass to _create_rule using util.portable_instancemethod(self._create_rule_disable) to retain serializability.

element =

Undocumented

if_exists =

Undocumented

if_not_exists =

Undocumented

@property
stringify_dialect =
overrides sqlalchemy.sql.expression.ClauseElement.stringify_dialect

Undocumented