~ubuntu-branches/debian/jessie/sqlalchemy/jessie

« back to all changes in this revision

Viewing changes to doc/orm/extensions/instrumentation.html

  • Committer: Package Import Robot
  • Author(s): Piotr Ożarowski
  • Date: 2013-10-28 22:29:40 UTC
  • mto: (1.6.9)
  • mto: This revision was merged to the branch mainline in revision 35.
  • Revision ID: package-import@ubuntu.com-20131028222940-t6h277tm5kaiepk4
Tags: upstream-0.8.3
Import upstream version 0.8.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
    <script type="text/javascript">
21
21
      var DOCUMENTATION_OPTIONS = {
22
22
          URL_ROOT:    '../../',
23
 
          VERSION:     '0.8.2',
 
23
          VERSION:     '0.8.3',
24
24
          COLLAPSE_MODINDEX: false,
25
25
          FILE_SUFFIX: '.html'
26
26
      };
67
67
    </div>
68
68
 
69
69
    <div id="docs-version-header">
70
 
        Release: <span class="version-num">0.8.2</span> | Release Date: July 3, 2013
 
70
        Release: <span class="version-num">0.8.3</span> | Release Date: October 26, 2013
71
71
 
72
72
 
73
73
    </div>
160
160
</div>
161
161
<p>For examples of how the instrumentation extension is used,
162
162
see the example <a class="reference internal" href="../examples.html#examples-instrumentation"><em>Attribute Instrumentation</em></a>.</p>
163
 
<p class="versionchanged">
164
 
<span class="versionmodified">Changed in version 0.8: </span>The <tt class="xref py py-mod docutils literal"><span class="pre">sqlalchemy.orm.instrumentation</span></tt> was split out so
 
163
<div class="versionchanged">
 
164
<p><span>Changed in version 0.8: </span>The <tt class="xref py py-mod docutils literal"><span class="pre">sqlalchemy.orm.instrumentation</span></tt> was split out so
165
165
that all functionality having to do with non-standard
166
166
instrumentation was moved out to <a class="reference internal" href="#module-sqlalchemy.ext.instrumentation" title="sqlalchemy.ext.instrumentation"><tt class="xref py py-mod docutils literal"><span class="pre">sqlalchemy.ext.instrumentation</span></tt></a>.
167
167
When imported, the module installs itself within
170
170
<tt class="docutils literal"><span class="pre">__sa_instrumentation_manager__</span></tt> on mapped classes, as
171
171
well <tt class="xref py py-attr docutils literal"><span class="pre">instrumentation_finders</span></tt>
172
172
being used to determine class instrumentation resolution.</p>
 
173
</div>
173
174
<div class="section" id="api-reference">
174
175
<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2>
175
176
<dl class="data">
211
212
events, see <a class="reference internal" href="../events.html#sqlalchemy.orm.events.InstrumentationEvents" title="sqlalchemy.orm.events.InstrumentationEvents"><tt class="xref py py-class docutils literal"><span class="pre">InstrumentationEvents</span></tt></a>.</p>
212
213
<p>The API for this class should be considered as semi-stable,
213
214
and may change slightly with new releases.</p>
214
 
<p class="versionchanged">
215
 
<span class="versionmodified">Changed in version 0.8: </span><a class="reference internal" href="#sqlalchemy.ext.instrumentation.InstrumentationManager" title="sqlalchemy.ext.instrumentation.InstrumentationManager"><tt class="xref py py-class docutils literal"><span class="pre">InstrumentationManager</span></tt></a> was moved from
 
215
<div class="versionchanged">
 
216
<p><span>Changed in version 0.8: </span><a class="reference internal" href="#sqlalchemy.ext.instrumentation.InstrumentationManager" title="sqlalchemy.ext.instrumentation.InstrumentationManager"><tt class="xref py py-class docutils literal"><span class="pre">InstrumentationManager</span></tt></a> was moved from
216
217
<tt class="xref py py-mod docutils literal"><span class="pre">sqlalchemy.orm.instrumentation</span></tt> to
217
218
<a class="reference internal" href="#module-sqlalchemy.ext.instrumentation" title="sqlalchemy.ext.instrumentation"><tt class="xref py py-mod docutils literal"><span class="pre">sqlalchemy.ext.instrumentation</span></tt></a>.</p>
 
219
</div>
218
220
<dl class="method">
219
221
<dt id="sqlalchemy.ext.instrumentation.InstrumentationManager.dict_getter">
220
222
<tt class="descname">dict_getter</tt><big>(</big><em>class_</em><big>)</big><a class="headerlink" href="#sqlalchemy.ext.instrumentation.InstrumentationManager.dict_getter" title="Permalink to this definition">¶</a></dt>
299
301
 
300
302
<dl class="data">
301
303
<dt id="sqlalchemy.ext.instrumentation.instrumentation_finders">
302
 
<tt class="descclassname">sqlalchemy.ext.instrumentation.</tt><tt class="descname">instrumentation_finders</tt><em class="property"> = [&lt;function find_native_user_instrumentation_hook at 0x10b64b758&gt;]</em><a class="headerlink" href="#sqlalchemy.ext.instrumentation.instrumentation_finders" title="Permalink to this definition">¶</a></dt>
 
304
<tt class="descclassname">sqlalchemy.ext.instrumentation.</tt><tt class="descname">instrumentation_finders</tt><em class="property"> = [&lt;function find_native_user_instrumentation_hook at 0x10de79668&gt;]</em><a class="headerlink" href="#sqlalchemy.ext.instrumentation.instrumentation_finders" title="Permalink to this definition">¶</a></dt>
303
305
<dd><p>An extensible sequence of callables which return instrumentation
304
306
implementations</p>
305
307
<p>When a class is registered, each callable will be passed a class object.
319
321
<p>Extends <tt class="xref py py-class docutils literal"><span class="pre">InstrumentationFactory</span></tt> with additional
320
322
bookkeeping, to accommodate multiple types of
321
323
class managers.</p>
 
324
<table class="docutils field-list" frame="void" rules="none">
 
325
<col class="field-name" />
 
326
<col class="field-body" />
 
327
<tbody valign="top">
 
328
<tr class="field-odd field"><th class="field-name">Members :</th><td class="field-body"></td>
 
329
</tr>
 
330
</tbody>
 
331
</table>
322
332
</dd></dl>
323
333
 
324
334
</div>
336
346
 
337
347
    <div id="docs-copyright">
338
348
        &copy; <a href="../../copyright.html">Copyright</a> 2007-2013, the SQLAlchemy authors and contributors.
339
 
        Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
 
349
        Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.
340
350
    </div>
341
351
</div>
342
352