Classe « ExecutableDDLElement »

Informations générales

Héritage

        builtins.object
            Visitable
                CompilerElement
        builtins.object
            Visitable
        builtins.object
            HasTraverseInternals
                ExternallyTraversible
        builtins.object
            HasTraverseInternals
                HasCopyInternals
        builtins.object
            HasMemoized
        builtins.object
            HasCacheKey
                MemoizedHasCacheKey
builtins.object
    Visitable
builtins.object
    HasTraverseInternals
        ExternallyTraversible
            SupportsAnnotations
                SupportsWrappingAnnotations
                    ClauseElement
                        BaseDDLElement
            builtins.object
                SQLRole
                    StatementRole
                        Executable
            builtins.object
                SQLRole
                    StatementRole
                        DDLRole
                            ExecutableDDLElement

Définition

class ExecutableDDLElement(DDLRole, Executable, BaseDDLElement):

help(ExecutableDDLElement)

Base class for standalone executable DDL expression constructs.

This class is the base for the general purpose :class:`.DDL` class,
as well as the various create/drop clause constructs such as
:class:`.CreateTable`, :class:`.DropTable`, :class:`.AddConstraint`,
etc.

.. versionchanged:: 2.0  :class:`.ExecutableDDLElement` is renamed from
   :class:`.DDLElement`, which still exists for backwards compatibility.

:class:`.ExecutableDDLElement` integrates closely with SQLAlchemy events,
introduced in :ref:`event_toplevel`.  An instance of one is
itself an event receiving callable::

    event.listen(
        users,
        "after_create",
        AddConstraint(constraint).execute_if(dialect="postgresql"),
    )

.. seealso::

    :class:`.DDL`

    :class:`.DDLEvents`

    :ref:`event_toplevel`

    :ref:`schema_ddl_sequences`

Constructeur(s)

Signature du constructeur	Description
__init__(self, /, args, *kwargs)	Initialize self. See help(type(self)) for accurate signature. _{[extrait de __init__.__doc__]}

Liste des attributs statiques

Nom de l'attribut	Valeur
allows_lambda	False
description	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020D9F723AD0>
inherit_cache	None
is_clause_element	True
is_delete	False
is_dml	False
is_from_statement	False
is_insert	False
is_select	False
is_selectable	False
is_text	False
is_update	False
stringify_dialect	default
supports_execution	True
target	None
uses_inspection	False

Liste des propriétés

Nom de la propriété	Description
entity_namespace

Liste des opérateurs

Opérateurs hérités de la classe ClauseElement

__invert__

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__call__(self, target, bind, **kw)	Execute the DDL as a ddl_listener. _{[extrait de __call__.__doc__]}
against(self, target: 'SchemaItem') -> 'Self'	Return a copy of this :class:`_schema.ExecutableDDLElement` which _{[extrait de against.__doc__]}
execute_if(self, dialect: 'Optional[str]' = None, callable_: 'Optional[DDLIfCallable]' = None, state: 'Optional[Any]' = None) -> 'Self'	Return a callable that will execute this _{[extrait de execute_if.__doc__]}