sqlalchemy.sql.ddl.DDL

class documentation

class DDL(ExecutableDDLElement): (source)

View In Hierarchy

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 :class:`.DDLEvents`, using either :class:`_schema.Table` or :class:`_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 context Undocumented
Instance Variable statement Undocumented

Inherited from ExecutableDDLElement:

Method __call__ Execute the DDL as a ddl_listener.
Method against Return a copy of this :class:`_schema.ExecutableDDLElement` which will include the given target.
Method execute_if Return a callable that will execute this :class:`_ddl.ExecutableDDLElement` conditionally within an event handler.
Instance Variable target Undocumented
Method _execute_on_connection Undocumented
Method _generate Undocumented
Method _invoke_with Undocumented
Method _should_execute Undocumented
Instance Variable _ddl_if Undocumented

Inherited from DDLRole (via ExecutableDDLElement):

Class Variable __slots__ Undocumented

Inherited from Executable (via ExecutableDDLElement, DDLRole):

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.
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
Method _add_context_option Add a context option to this statement.
Method _compile_w_cache Undocumented
Method _execute_on_scalar Undocumented
Method _set_compile_options Assign the compile options to a new value.
Method _update_compile_options update the _compile_options with new keys.
Class Variable _executable_traverse_internals Undocumented
Class Variable _is_default_generator Undocumented
Class Variable _with_context_options Undocumented
Class Variable _with_options Undocumented
Instance Variable _compile_options Undocumented
Instance Variable _execution_options Undocumented
Property _all_selected_columns Undocumented
Property _effective_plugin_target Undocumented

Inherited from StatementRole (via ExecutableDDLElement, DDLRole, Executable):

Class Variable _role_name Undocumented
Property _propagate_attrs Undocumented

Inherited from SQLRole (via ExecutableDDLElement, DDLRole, Executable, StatementRole):

Class Variable allows_lambda Undocumented
Class Variable uses_inspection Undocumented

Inherited from BaseDDLElement (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole):

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 ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement):

Method __bool__ Undocumented
Method __getstate__ Undocumented
Method __invert__ Undocumented
Method compare Compare this :class:`_expression.ClauseElement` to the given :class:`_expression.ClauseElement`.
Method get_children Return immediate child :class:`.visitors.HasTraverseInternals` elements of this :class:`.visitors.HasTraverseInternals`.
Method params Return a copy with :func:`_expression.bindparam` elements replaced.
Method self_group Apply a 'grouping' to this :class:`_expression.ClauseElement`.
Method unique_params Return a copy with :func:`_expression.bindparam` elements replaced.
Class Variable is_clause_element Undocumented
Class Variable is_selectable Undocumented
Class Variable negation_clause Undocumented
Property description Undocumented
Property entity_namespace 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 :class:`_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 _gen_static_annotations_cache_key Undocumented
Class Variable _is_bind_parameter Undocumented
Class Variable _is_clause_list Undocumented
Class Variable _is_clone_of Undocumented
Class Variable _is_column_element Undocumented
Class Variable _is_from_clause Undocumented
Class Variable _is_from_container Undocumented
Class Variable _is_immutable Undocumented
Class Variable _is_keyed_column_element Undocumented
Class Variable _is_lambda_element Undocumented
Class Variable _is_returns_rows Undocumented
Class Variable _is_select_base Undocumented
Class Variable _is_select_container Undocumented
Class Variable _is_select_statement Undocumented
Class Variable _is_singleton_constant Undocumented
Class Variable _is_star Undocumented
Class Variable _is_table Undocumented
Class Variable _is_text_clause Undocumented
Class Variable _is_textual Undocumented
Property _constructor return the 'constructor' for this ClauseElement.
Property _from_objects Undocumented
Property _order_by_label_element Undocumented

Inherited from SupportsWrappingAnnotations (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement):

Method _annotate return a copy of this ClauseElement with annotations updated by the given dictionary.
Method _deannotate return a copy of this :class:`_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 ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations):

Class Variable proxy_set Undocumented
Method _gen_annotations_cache_key Undocumented
Property _annotations_cache_key Undocumented

Inherited from MemoizedHasCacheKey (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations):

Method _generate_cache_key return a cache key.

Inherited from HasCacheKey (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey):

Class Variable inherit_cache Indicate if this :class:`.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 _generated_cache_key_traversal Undocumented
Class Variable _is_has_cache_key Undocumented

Inherited from HasCopyInternals (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey):

Method _copy_internals Reassign internal elements to be clones of themselves.

Inherited from HasTraverseInternals (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible):

Class Variable _traverse_internals Undocumented

Inherited from CompilerElement (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible, HasTraverseInternals):

Method __str__ Undocumented
Method compile Compile this SQL expression.
Class Variable stringify_dialect Undocumented

Inherited from Visitable (via ExecutableDDLElement, DDLRole, Executable, StatementRole, SQLRole, BaseDDLElement, ClauseElement, SupportsWrappingAnnotations, SupportsAnnotations, MemoizedHasCacheKey, HasCacheKey, HasCopyInternals, ExternallyTraversible, HasTraverseInternals, CompilerElement):

Method __class_getitem__ Undocumented
Method __init_subclass__ Undocumented
Class Method _generate_compiler_dispatch Undocumented
Method _compiler_dispatch Undocumented
Class Variable _original_compiler_dispatch Undocumented
def __init__(self, statement, context=None): (source)

Create a DDL statement. :param statement: A string or unicode string to be executed. Statements will be processed with Python's string formatting operator using a fixed set of string substitutions, as well as additional substitutions provided by the optional :paramref:`.DDL.context` parameter. A literal '%' in a statement must be escaped as '%%'. SQL bind parameters are not available in DDL statements. :param context: Optional dictionary, defaults to None. These values will be available for use in string substitutions on the DDL statement. .. seealso:: :class:`.DDLEvents` :ref:`event_toplevel`

def __repr__(self): (source)
overrides sqlalchemy.sql.elements.ClauseElement.__repr__

Undocumented

__visit_name__: str = (source)
overrides sqlalchemy.sql.base.Executable.__visit_name__

Undocumented

context = (source)

Undocumented

statement = (source)

Undocumented