summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/events.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-11-14 15:54:37 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2010-11-14 15:54:37 -0500
commit80d1aaa66113ba3770cb9b2ec2c97fed28fa465c (patch)
tree6cb6f5c463974cb5b1c960af0897f89a4f637d63 /lib/sqlalchemy/events.py
parent7513b46730d1b57a6b8addde8dfb4f83ee1e6cb4 (diff)
downloadsqlalchemy-80d1aaa66113ba3770cb9b2ec2c97fed28fa465c.tar.gz
- event documentation bonanza
Diffstat (limited to 'lib/sqlalchemy/events.py')
-rw-r--r--lib/sqlalchemy/events.py56
1 files changed, 52 insertions, 4 deletions
diff --git a/lib/sqlalchemy/events.py b/lib/sqlalchemy/events.py
index ca4959e61..a1313de63 100644
--- a/lib/sqlalchemy/events.py
+++ b/lib/sqlalchemy/events.py
@@ -52,16 +52,64 @@ class DDLEvents(event.Events):
"""
def on_before_create(self, target, connection, **kw):
- """ """
+ """Called before CREATE statments are emitted.
+
+ :param target: the :class:`.MetaData` or :class:`.Table`
+ object which is the target of the event.
+ :param connection: the :class:`.Connection` where the
+ CREATE statement or statements will be emitted.
+ :param \**kw: additional keyword arguments relevant
+ to the event. Currently this includes the ``tables``
+ argument in the case of a :class:`.MetaData` object,
+ which is the list of :class:`.Table` objects for which
+ CREATE will be emitted.
+
+ """
def on_after_create(self, target, connection, **kw):
- """ """
+ """Called after CREATE statments are emitted.
+
+ :param target: the :class:`.MetaData` or :class:`.Table`
+ object which is the target of the event.
+ :param connection: the :class:`.Connection` where the
+ CREATE statement or statements have been emitted.
+ :param \**kw: additional keyword arguments relevant
+ to the event. Currently this includes the ``tables``
+ argument in the case of a :class:`.MetaData` object,
+ which is the list of :class:`.Table` objects for which
+ CREATE has been emitted.
+
+ """
def on_before_drop(self, target, connection, **kw):
- """ """
+ """Called before DROP statments are emitted.
+
+ :param target: the :class:`.MetaData` or :class:`.Table`
+ object which is the target of the event.
+ :param connection: the :class:`.Connection` where the
+ DROP statement or statements will be emitted.
+ :param \**kw: additional keyword arguments relevant
+ to the event. Currently this includes the ``tables``
+ argument in the case of a :class:`.MetaData` object,
+ which is the list of :class:`.Table` objects for which
+ DROP will be emitted.
+
+ """
def on_after_drop(self, target, connection, **kw):
- """ """
+ """Called after DROP statments are emitted.
+
+ :param target: the :class:`.MetaData` or :class:`.Table`
+ object which is the target of the event.
+ :param connection: the :class:`.Connection` where the
+ DROP statement or statements have been emitted.
+ :param \**kw: additional keyword arguments relevant
+ to the event. Currently this includes the ``tables``
+ argument in the case of a :class:`.MetaData` object,
+ which is the list of :class:`.Table` objects for which
+ DROP has been emitted.
+
+ """
class PoolEvents(event.Events):