summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/events.py
diff options
context:
space:
mode:
authorjonathan vanasco <jonathan@2xlp.com>2021-09-27 15:53:03 -0400
committerJonathan Vanasco <jonathan@2xlp.com>2021-09-27 21:30:25 +0000
commite40bd0b565dd52f45e25371a2b5fd199cff92b32 (patch)
treeefa991363ac7610d292a41357b82db48181eb39c /lib/sqlalchemy/sql/events.py
parent7f87cad26c1726565a200f85b7855bf8192e8df5 (diff)
downloadsqlalchemy-e40bd0b565dd52f45e25371a2b5fd199cff92b32.tar.gz
Fixes: #5151
document `listen=True` on `before_create` Change-Id: I0804ee073044d879eb0decafeb1b358741d69f02
Diffstat (limited to 'lib/sqlalchemy/sql/events.py')
-rw-r--r--lib/sqlalchemy/sql/events.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/sqlalchemy/sql/events.py b/lib/sqlalchemy/sql/events.py
index a6c5c8e28..db80b51e3 100644
--- a/lib/sqlalchemy/sql/events.py
+++ b/lib/sqlalchemy/sql/events.py
@@ -105,12 +105,17 @@ class DDLEvents(event.Events):
event, the checkfirst flag, and other
elements used by internal events.
- :func:`.event.listen` also accepts the ``propagate=True``
+ :func:`.event.listen` accepts the ``propagate=True``
modifier for this event; when True, the listener function will
be established for any copies made of the target object,
i.e. those copies that are generated when
:meth:`_schema.Table.to_metadata` is used.
+ :func:`.event.listen` accepts the ``insert=True``
+ modifier for this event; when True, the listener function will
+ be prepended to the internal list of events upon discovery, and execute
+ before registered listener functions that do not pass this argument.
+
"""
def after_create(self, target, connection, **kw):