sqlalchemy.sql.ddl.DDL

class documentation

class DDL(DDLElement):

A literal DDL statement.

Specifies literal SQL DDL to be executed by the database. DDL objects function as DDL event listeners, and can be subscribed to those events listed in .DDLEvents, using either _schema.Table or _schema.MetaData objects as targets. Basic templating support allows a single DDL instance to handle repetitive tasks for multiple tables.

Examples:

from sqlalchemy import event, DDL

tbl = Table('users', metadata, Column('uid', Integer))
event.listen(tbl, 'before_create', DDL('DROP TRIGGER users_trigger'))

spow = DDL('ALTER TABLE %(table)s SET secretpowers TRUE')
event.listen(tbl, 'after_create', spow.execute_if(dialect='somedb'))

drop_spow = DDL('ALTER TABLE users SET secretpowers FALSE')
connection.execute(drop_spow)

When operating on Table events, the following statement string substitutions are available:

%(table)s  - the Table name, with any required quoting applied
%(schema)s - the schema name, with any required quoting applied
%(fullname)s - the Table name including schema, quoted if needed

The DDL's "context", if any, will be combined with the standard substitutions noted above. Keys present in the context will override the standard substitutions.

Method	`__init__`	Create a DDL statement.
Method	`__repr__`	Undocumented
Class Variable	`__visit_name__`	Undocumented
Instance Variable	`_bind`	Undocumented
Instance Variable	`context`	Undocumented
Instance Variable	`statement`	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	`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	`__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	`_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	`stringify_dialect`	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.DDL.bind` argument is deprecated and will be removed in SQLAlchemy 2.0.'))
def __init__(self, statement, context=None, bind=None):

Create a DDL statement.

Parameters
statement	A string or unicode string to be executed. Statements will be processed with Python's string formatting operator. See the `context` argument and the `execute_at` method. A literal '%' in a statement must be escaped as '%%'. SQL bind parameters are not available in DDL statements.
context	Optional dictionary, defaults to None. These values will be available for use in string substitutions on the DDL statement.
bind	Optional. A `.Connectable`, used by default when `execute()` is invoked without a bind argument.