summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/ext/compiler.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-04-09 10:02:35 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2022-04-09 10:03:10 -0400
commit5e19643ea9db523742d5b9e00384e3d3c2ff9e8c (patch)
tree47a9f427f4e7a05e350d4c20418dcaab883cad30 /lib/sqlalchemy/ext/compiler.py
parent95c9b32a334c9f8337989a67394a6ccf004341e1 (diff)
downloadsqlalchemy-5e19643ea9db523742d5b9e00384e3d3c2ff9e8c.tar.gz
update DDL examples removing execute_if
Fixes: #7924 Change-Id: I684bf3720010ffe34dbdd39ec8c7e0c4af94e620 (cherry picked from commit 1eeded1687aef3132b2a1d5995321fb20b2b8dfc)
Diffstat (limited to 'lib/sqlalchemy/ext/compiler.py')
-rw-r--r--lib/sqlalchemy/ext/compiler.py19
1 files changed, 13 insertions, 6 deletions
diff --git a/lib/sqlalchemy/ext/compiler.py b/lib/sqlalchemy/ext/compiler.py
index b97b23e66..76b59ea6e 100644
--- a/lib/sqlalchemy/ext/compiler.py
+++ b/lib/sqlalchemy/ext/compiler.py
@@ -282,12 +282,19 @@ A synopsis is as follows:
raise TypeError("coalesce only supports two arguments on Oracle")
return "nvl(%s)" % compiler.process(element.clauses, **kw)
-* :class:`~sqlalchemy.schema.DDLElement` - The root of all DDL expressions,
- like CREATE TABLE, ALTER TABLE, etc. Compilation of ``DDLElement``
- subclasses is issued by a ``DDLCompiler`` instead of a ``SQLCompiler``.
- ``DDLElement`` also features ``Table`` and ``MetaData`` event hooks via the
- ``execute_at()`` method, allowing the construct to be invoked during CREATE
- TABLE and DROP TABLE sequences.
+* :class:`.DDLElement` - The root of all DDL expressions,
+ like CREATE TABLE, ALTER TABLE, etc. Compilation of :class:`.DDLElement`
+ subclasses is issued by a :class:`.DDLCompiler` instead of a
+ :class:`.SQLCompiler`. :class:`.DDLElement` can also be used as an event hook
+ in conjunction with event hooks like :meth:`.DDLEvents.before_create` and
+ :meth:`.DDLEvents.after_create`, allowing the construct to be invoked
+ automatically during CREATE TABLE and DROP TABLE sequences.
+
+ .. seealso::
+
+ :ref:`metadata_ddl_toplevel` - contains examples of associating
+ :class:`.DDL` objects (which are themselves :class:`.DDLElement`
+ instances) with :class:`.DDLEvents` event hooks.
* :class:`~sqlalchemy.sql.expression.Executable` - This is a mixin which
should be used with any expression class that represents a "standalone"