44
44
<script type="text/javascript" src="../_static/doctools.js"></script>
45
45
<!-- end iterate through sphinx environment script_files -->
47
<script type="text/javascript" src="../_static/detectmobile.js"></script>
47
48
<script type="text/javascript" src="../_static/init.js"></script>
48
49
<link rel="index" title="Index" href="../genindex.html" />
49
50
<link rel="search" title="Search" href="../search.html" />
72
74
<div id="docs-container">
80
<div id="docs-top-navigation-container" class="body-background">
77
81
<div id="docs-header">
82
<div id="docs-version-header">
83
Release: <span class="version-num">0.9.6</span> | Release Date: June 23, 2014
78
86
<h1>SQLAlchemy 0.9 Documentation</h1>
80
<div id="docs-search">
82
<form class="search" action="../search.html" method="get">
83
<input type="text" name="q" size="18" /> <input type="submit" value="Search" />
84
<input type="hidden" name="check_keywords" value="yes" />
85
<input type="hidden" name="area" value="default" />
89
<div id="docs-version-header">
90
Release: <span class="version-num">0.9.4</span> | Release Date: March 28, 2014
97
<div id="docs-top-navigation">
98
<div id="docs-top-page-control" class="docs-navigation-links">
91
<div id="docs-body-container">
93
<div id="fixed-sidebar" class="withsidebar">
96
<div id="docs-sidebar-popout">
97
<h3><a href="../index.html">SQLAlchemy 0.9 Documentation</a></h3>
99
<p id="sidebar-paginate">
100
<a href="index.html" title="SQLAlchemy Core">Up</a> |
102
<a href="event.html" title="Events">Prev</a> |
103
<a href="compiler.html" title="Custom SQL Constructs and Compilation Extension">Next</a>
106
<p id="sidebar-topnav">
107
<a href="../index.html">Contents</a> |
108
<a href="../genindex.html">Index</a>
111
<div id="sidebar-search">
112
<form class="search" action="../search.html" method="get">
113
<input type="text" name="q" size="12" /> <input type="submit" value="Search" />
114
<input type="hidden" name="check_keywords" value="yes" />
115
<input type="hidden" name="area" value="default" />
121
<div id="docs-sidebar">
101
<a href="event.html" title="previous chapter">Events</a>
104
<a href="compiler.html" title="next chapter">Custom SQL Constructs and Compilation Extension</a>
108
<a href="../contents.html">Table of Contents</a> |
109
<a href="../genindex.html">Index</a>
110
| <a href="../_sources/core/events.txt">view source
115
<div id="docs-navigation-banner">
116
<a href="../index.html">SQLAlchemy 0.9 Documentation</a>
117
» <a href="index.html" title="SQLAlchemy Core">SQLAlchemy Core</a>
131
<div id="docs-body-container">
133
<div id="docs-sidebar">
134
<h3><a href="../index.html">Table of Contents</a></h3>
136
128
<li><a class="reference internal" href="#">Core Events</a><ul>
137
129
<li><a class="reference internal" href="#connection-pool-events">Connection Pool Events</a></li>
138
130
<li><a class="reference internal" href="#sql-execution-and-connection-events">SQL Execution and Connection Events</a></li>
145
<h4>Previous Topic</h4>
147
<a href="event.html" title="previous chapter">Events</a>
151
<a href="compiler.html" title="next chapter">Custom SQL Constructs and Compilation Extension</a>
155
<h4>Quick Search</h4>
157
<form class="search" action="../search.html" method="get">
158
<input type="text" name="q" size="18" /> <input type="submit" value="Search" />
159
<input type="hidden" name="check_keywords" value="yes" />
160
<input type="hidden" name="area" value="default" />
166
145
<div id="docs-body" class="withsidebar" >
168
147
<div class="section" id="core-events">
180
159
<div class="versionadded">
181
<p><span>New in version 0.7: </span>The event system supercedes the previous system of “extension”, “listener”,
160
<p><span>New in version 0.7: </span>The event system supersedes the previous system of “extension”, “listener”,
182
161
and “proxy” classes.</p>
184
163
<div class="section" id="connection-pool-events">
429
408
be controlled, including disabled, using the <tt class="docutils literal"><span class="pre">reset_on_return</span></tt>
430
409
pool argument.</p>
431
410
<p>The <a class="reference internal" href="#sqlalchemy.events.PoolEvents.reset" title="sqlalchemy.events.PoolEvents.reset"><tt class="xref py py-meth docutils literal"><span class="pre">PoolEvents.reset()</span></tt></a> event is usually followed by the
432
the <a class="reference internal" href="#sqlalchemy.events.PoolEvents.checkin" title="sqlalchemy.events.PoolEvents.checkin"><tt class="xref py py-meth docutils literal"><span class="pre">PoolEvents.checkin()</span></tt></a> event is called, except in those
411
<a class="reference internal" href="#sqlalchemy.events.PoolEvents.checkin" title="sqlalchemy.events.PoolEvents.checkin"><tt class="xref py py-meth docutils literal"><span class="pre">PoolEvents.checkin()</span></tt></a> event is called, except in those
433
412
cases where the connection is discarded immediately after reset.</p>
434
413
<table class="docutils field-list" frame="void" rules="none">
435
414
<col class="field-name" />
896
875
<p>This event is called with the DBAPI exception instance
897
876
received from the DBAPI itself, <em>before</em> SQLAlchemy wraps the
898
exception with it’s own exception wrappers, and before any
877
exception with its own exception wrappers, and before any
899
878
other operations are performed on the DBAPI cursor; the
900
879
existing transaction remains in effect as well as any state
901
880
on the cursor.</p>
1450
1429
<dl class="method">
1451
1430
<dt id="sqlalchemy.events.DDLEvents.after_create">
1452
1431
<tt class="descname">after_create</tt><big>(</big><em>target</em>, <em>connection</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.after_create" title="Permalink to this definition">¶</a></dt>
1453
<dd><p>Called after CREATE statments are emitted.</p>
1432
<dd><p>Called after CREATE statements are emitted.</p>
1454
1433
<div class="event-signatures container">
1455
1434
<p>Example argument forms:</p>
1456
1435
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">event</span>
1488
1467
<dl class="method">
1489
1468
<dt id="sqlalchemy.events.DDLEvents.after_drop">
1490
1469
<tt class="descname">after_drop</tt><big>(</big><em>target</em>, <em>connection</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.after_drop" title="Permalink to this definition">¶</a></dt>
1491
<dd><p>Called after DROP statments are emitted.</p>
1470
<dd><p>Called after DROP statements are emitted.</p>
1492
1471
<div class="event-signatures container">
1493
1472
<p>Example argument forms:</p>
1494
1473
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">event</span>
1569
1548
<dl class="method">
1570
1549
<dt id="sqlalchemy.events.DDLEvents.before_create">
1571
1550
<tt class="descname">before_create</tt><big>(</big><em>target</em>, <em>connection</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.before_create" title="Permalink to this definition">¶</a></dt>
1572
<dd><p>Called before CREATE statments are emitted.</p>
1551
<dd><p>Called before CREATE statements are emitted.</p>
1573
1552
<div class="event-signatures container">
1574
1553
<p>Example argument forms:</p>
1575
1554
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">event</span>
1607
1586
<dl class="method">
1608
1587
<dt id="sqlalchemy.events.DDLEvents.before_drop">
1609
1588
<tt class="descname">before_drop</tt><big>(</big><em>target</em>, <em>connection</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.before_drop" title="Permalink to this definition">¶</a></dt>
1610
<dd><p>Called before DROP statments are emitted.</p>
1589
<dd><p>Called before DROP statements are emitted.</p>
1611
1590
<div class="event-signatures container">
1612
1591
<p>Example argument forms:</p>
1613
1592
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">event</span>