~ubuntu-branches/debian/sid/sqlalchemy/sid

« back to all changes in this revision

Viewing changes to doc/core/events.html

  • Committer: Package Import Robot
  • Author(s): Piotr Ożarowski
  • Date: 2014-06-27 20:17:13 UTC
  • mfrom: (1.4.28)
  • Revision ID: package-import@ubuntu.com-20140627201713-g6p1kq8q1qenztrv
Tags: 0.9.6-1
* New upstream release
* Remove Python 3.X build tag files, thanks to Matthias Urlichs for the
  patch (closes: #747852)
* python-fdb isn't in the Debian archive yet so default dialect for firebird://
  URLs is changed to obsolete kinterbasdb, thanks to Russell Stuart for the
  patch (closes: #752145)

Show diffs side-by-side

added added

removed removed

Lines of Context:
32
32
    <script type="text/javascript">
33
33
      var DOCUMENTATION_OPTIONS = {
34
34
          URL_ROOT:    '../',
35
 
          VERSION:     '0.9.4',
 
35
          VERSION:     '0.9.6',
36
36
          COLLAPSE_MODINDEX: false,
37
37
          FILE_SUFFIX: '.html'
38
38
      };
44
44
        <script type="text/javascript" src="../_static/doctools.js"></script>
45
45
    <!-- end iterate through sphinx environment script_files -->
46
46
 
 
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" />
69
70
 
70
71
 
71
72
 
 
73
 
72
74
<div id="docs-container">
73
75
 
74
76
 
75
77
 
76
78
 
 
79
 
 
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
 
84
    </div>
 
85
 
78
86
    <h1>SQLAlchemy 0.9 Documentation</h1>
79
87
 
80
 
    <div id="docs-search">
81
 
    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" />
86
 
    </form>
87
 
    </div>
88
 
 
89
 
    <div id="docs-version-header">
90
 
        Release: <span class="version-num">0.9.4</span> | Release Date: March 28, 2014
91
 
 
92
 
 
93
 
    </div>
94
 
 
95
 
</div>
96
 
 
97
 
<div id="docs-top-navigation">
98
 
    <div id="docs-top-page-control" class="docs-navigation-links">
 
88
</div>
 
89
</div>
 
90
 
 
91
<div id="docs-body-container">
 
92
 
 
93
    <div id="fixed-sidebar" class="withsidebar">
 
94
 
 
95
 
 
96
        <div id="docs-sidebar-popout">
 
97
            <h3><a href="../index.html">SQLAlchemy 0.9 Documentation</a></h3>
 
98
 
 
99
            <p id="sidebar-paginate">
 
100
                    <a href="index.html" title="SQLAlchemy Core">Up</a> |
 
101
 
 
102
                    <a href="event.html" title="Events">Prev</a> |
 
103
                    <a href="compiler.html" title="Custom SQL Constructs and Compilation Extension">Next</a>
 
104
            </p>
 
105
 
 
106
            <p id="sidebar-topnav">
 
107
                <a href="../index.html">Contents</a> |
 
108
                <a href="../genindex.html">Index</a>
 
109
            </p>
 
110
 
 
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" />
 
116
                </form>
 
117
            </div>
 
118
 
 
119
        </div>
 
120
 
 
121
        <div id="docs-sidebar">
 
122
 
 
123
        <h3><a href="#">            
 
124
                Core Events
 
125
            
 
126
        </a></h3>
99
127
        <ul>
100
 
            <li>Prev:
101
 
            <a href="event.html" title="previous chapter">Events</a>
102
 
            </li>
103
 
            <li>Next:
104
 
            <a href="compiler.html" title="next chapter">Custom SQL Constructs and Compilation Extension</a>
105
 
            </li>
106
 
 
107
 
        <li>
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
111
 
        </li>
112
 
        </ul>
113
 
    </div>
114
 
 
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>
118
 
        » 
119
 
                Core Events
120
 
            
121
 
 
122
 
        <h2>
123
 
            
124
 
                Core Events
125
 
            
126
 
        </h2>
127
 
    </div>
128
 
 
129
 
</div>
130
 
 
131
 
<div id="docs-body-container">
132
 
 
133
 
    <div id="docs-sidebar">
134
 
    <h3><a href="../index.html">Table of Contents</a></h3>
135
 
    <ul>
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>
142
134
</ul>
143
135
 
144
136
 
145
 
    <h4>Previous Topic</h4>
146
 
    <p>
147
 
    <a href="event.html" title="previous chapter">Events</a>
148
 
    </p>
149
 
    <h4>Next Topic</h4>
150
 
    <p>
151
 
    <a href="compiler.html" title="next chapter">Custom SQL Constructs and Compilation Extension</a>
152
 
    </p>
153
 
 
154
 
 
155
 
    <h4>Quick Search</h4>
156
 
    <p>
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" />
161
 
    </form>
162
 
    </p>
 
137
 
 
138
 
 
139
        </div>
163
140
 
164
141
    </div>
165
142
 
 
143
    
 
144
 
166
145
    <div id="docs-body" class="withsidebar" >
167
146
        
168
147
<div class="section" id="core-events">
178
157
</dd></dl>
179
158
 
180
159
<div class="versionadded">
181
 
<p><span>New in version 0.7: </span>The event system supercedes the previous system of &#8220;extension&#8221;, &#8220;listener&#8221;,
 
160
<p><span>New in version 0.7: </span>The event system supersedes the previous system of &#8220;extension&#8221;, &#8220;listener&#8221;,
182
161
and &#8220;proxy&#8221; classes.</p>
183
162
</div>
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" />
895
874
</div>
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&#8217;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>