File: api.html

package info (click to toggle)
python-sqlsoup 0.9.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 456 kB
  • ctags: 130
  • sloc: python: 679; makefile: 134
file content (345 lines) | stat: -rw-r--r-- 24,248 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>API Details &mdash; SQLSoup 0.9.0 documentation</title>
    
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.9.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="SQLSoup 0.9.0 documentation" href="index.html" />
    <link rel="prev" title="Tutorial" href="tutorial.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="tutorial.html" title="Tutorial"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">SQLSoup 0.9.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="api-details">
<h1>API Details<a class="headerlink" href="#api-details" title="Permalink to this headline">¶</a></h1>
<p>This section includes generated documentation for the <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a> object.</p>
<span class="target" id="module-sqlsoup"></span><dl class="class">
<dt id="sqlsoup.SQLSoup">
<em class="property">class </em><tt class="descclassname">sqlsoup.</tt><tt class="descname">SQLSoup</tt><big>(</big><em>engine_or_metadata</em>, <em>base=&lt;type 'object'&gt;</em>, <em>session=None</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent an ORM-wrapped database resource.</p>
<dl class="attribute">
<dt id="sqlsoup.SQLSoup.bind">
<tt class="descname">bind</tt><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.bind" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference external" href="http://www.sqlalchemy.org/docs/core/connections.html#sqlalchemy.engine.base.Engine" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.engine.base.Engine</span></tt></a> associated with this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.commit">
<tt class="descname">commit</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Commit the current transaction.</p>
<p>See <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/session.html#sqlalchemy.orm.session.Session.commit" title="(in SQLAlchemy v0.7)"><tt class="xref py py-meth docutils literal"><span class="pre">sqlalchemy.orm.session.Session.commit()</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.connection">
<tt class="descname">connection</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.connection" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the current <a class="reference external" href="http://www.sqlalchemy.org/docs/core/connections.html#sqlalchemy.engine.base.Connection" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.engine.base.Connection</span></tt></a> in use by the current transaction.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.delete">
<tt class="descname">delete</tt><big>(</big><em>instance</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Mark an instance as deleted.</p>
</dd></dl>

<dl class="attribute">
<dt id="sqlsoup.SQLSoup.engine">
<tt class="descname">engine</tt><a class="headerlink" href="#sqlsoup.SQLSoup.engine" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference external" href="http://www.sqlalchemy.org/docs/core/connections.html#sqlalchemy.engine.base.Engine" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.engine.base.Engine</span></tt></a> associated with this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.entity">
<tt class="descname">entity</tt><big>(</big><em>attr</em>, <em>schema=None</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.entity" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the named entity from this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>, or 
create if not present.</p>
<p>For more generalized mapping, see <a class="reference internal" href="#sqlsoup.SQLSoup.map_to" title="sqlsoup.SQLSoup.map_to"><tt class="xref py py-meth docutils literal"><span class="pre">map_to()</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.execute">
<tt class="descname">execute</tt><big>(</big><em>stmt</em>, <em>**params</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.execute" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute a SQL statement.</p>
<p>The statement may be a string SQL string,
an <a class="reference external" href="http://www.sqlalchemy.org/docs/core/expression_api.html#sqlalchemy.sql.expression.select" title="(in SQLAlchemy v0.7)"><tt class="xref py py-func docutils literal"><span class="pre">sqlalchemy.sql.expression.select()</span></tt></a> construct, or a 
<a class="reference external" href="http://www.sqlalchemy.org/docs/core/expression_api.html#sqlalchemy.sql.expression.text" title="(in SQLAlchemy v0.7)"><tt class="xref py py-func docutils literal"><span class="pre">sqlalchemy.sql.expression.text()</span></tt></a> 
construct.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.expunge">
<tt class="descname">expunge</tt><big>(</big><em>instance</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.expunge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.expunge" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove an instance from the <tt class="xref py py-class docutils literal"><span class="pre">Session</span></tt>.</p>
<p>See <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/session.html#sqlalchemy.orm.session.Session.expunge" title="(in SQLAlchemy v0.7)"><tt class="xref py py-meth docutils literal"><span class="pre">sqlalchemy.orm.session.Session.expunge()</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.expunge_all">
<tt class="descname">expunge_all</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.expunge_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.expunge_all" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear all objects from the current <tt class="xref py py-class docutils literal"><span class="pre">Session</span></tt>.</p>
<p>See <tt class="xref py py-meth docutils literal"><span class="pre">Session.expunge_all()</span></tt>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.flush">
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.flush" title="Permalink to this definition">¶</a></dt>
<dd><p>Flush pending changes to the database.</p>
<p>See <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/session.html#sqlalchemy.orm.session.Session.flush" title="(in SQLAlchemy v0.7)"><tt class="xref py py-meth docutils literal"><span class="pre">sqlalchemy.orm.session.Session.flush()</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.join">
<tt class="descname">join</tt><big>(</big><em>left</em>, <em>right</em>, <em>onclause=None</em>, <em>isouter=False</em>, <em>base=None</em>, <em>**mapper_args</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.join"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.join" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an <tt class="xref py py-func docutils literal"><span class="pre">expression.join()</span></tt> and map to it.</p>
<p>The class and its mapping are not cached and will
be discarded once dereferenced (as of 0.6.6).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>left</strong> &#8211; a mapped class or table object.</li>
<li><strong>right</strong> &#8211; a mapped class or table object.</li>
<li><strong>onclause</strong> &#8211; optional &#8220;ON&#8221; clause construct..</li>
<li><strong>isouter</strong> &#8211; if True, the join will be an OUTER join.</li>
<li><strong>base</strong> &#8211; a Python class which will be used as the
base for the mapped class. If <tt class="docutils literal"><span class="pre">None</span></tt>, the &#8220;base&#8221;
argument specified by this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>
instance&#8217;s constructor will be used, which defaults to
<tt class="docutils literal"><span class="pre">object</span></tt>.</li>
<li><strong>mapper_args</strong> &#8211; Dictionary of arguments which will
be passed directly to <tt class="xref py py-func docutils literal"><span class="pre">orm.mapper()</span></tt>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.map">
<tt class="descname">map</tt><big>(</big><em>selectable</em>, <em>base=None</em>, <em>**mapper_args</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.map" title="Permalink to this definition">¶</a></dt>
<dd><p>Map a selectable directly.</p>
<p>The class and its mapping are not cached and will
be discarded once dereferenced (as of 0.6.6).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>selectable</strong> &#8211; an <tt class="xref py py-func docutils literal"><span class="pre">expression.select()</span></tt> construct.</li>
<li><strong>base</strong> &#8211; a Python class which will be used as the
base for the mapped class. If <tt class="docutils literal"><span class="pre">None</span></tt>, the &#8220;base&#8221;
argument specified by this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>
instance&#8217;s constructor will be used, which defaults to
<tt class="docutils literal"><span class="pre">object</span></tt>.</li>
<li><strong>mapper_args</strong> &#8211; Dictionary of arguments which will
be passed directly to <tt class="xref py py-func docutils literal"><span class="pre">orm.mapper()</span></tt>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.map_to">
<tt class="descname">map_to</tt><big>(</big><em>attrname</em>, <em>tablename=None</em>, <em>selectable=None</em>, <em>schema=None</em>, <em>base=None</em>, <em>mapper_args=immutabledict({})</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.map_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.map_to" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure a mapping to the given attrname.</p>
<p>This is the &#8220;master&#8221; method that can be used to create any 
configuration.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>attrname</strong> &#8211; String attribute name which will be
established as an attribute on this :class:.`.SQLSoup`
instance.</li>
<li><strong>base</strong> &#8211; a Python class which will be used as the
base for the mapped class. If <tt class="docutils literal"><span class="pre">None</span></tt>, the &#8220;base&#8221;
argument specified by this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>
instance&#8217;s constructor will be used, which defaults to
<tt class="docutils literal"><span class="pre">object</span></tt>.</li>
<li><strong>mapper_args</strong> &#8211; Dictionary of arguments which will
be passed directly to <tt class="xref py py-func docutils literal"><span class="pre">orm.mapper()</span></tt>.</li>
<li><strong>tablename</strong> &#8211; String name of a <tt class="xref py py-class docutils literal"><span class="pre">Table</span></tt> to be
reflected. If a <tt class="xref py py-class docutils literal"><span class="pre">Table</span></tt> is already available,
use the <tt class="docutils literal"><span class="pre">selectable</span></tt> argument. This argument is
mutually exclusive versus the <tt class="docutils literal"><span class="pre">selectable</span></tt> argument.</li>
<li><strong>selectable</strong> &#8211; a <tt class="xref py py-class docutils literal"><span class="pre">Table</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">Join</span></tt>, or
<tt class="xref py py-class docutils literal"><span class="pre">Select</span></tt> object which will be mapped. This
argument is mutually exclusive versus the <tt class="docutils literal"><span class="pre">tablename</span></tt>
argument.</li>
<li><strong>schema</strong> &#8211; String schema name to use if the
<tt class="docutils literal"><span class="pre">tablename</span></tt> argument is present.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.rollback">
<tt class="descname">rollback</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.rollback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.rollback" title="Permalink to this definition">¶</a></dt>
<dd><p>Rollback the current transction.</p>
<p>See <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/session.html#sqlalchemy.orm.session.Session.rollback" title="(in SQLAlchemy v0.7)"><tt class="xref py py-meth docutils literal"><span class="pre">sqlalchemy.orm.session.Session.rollback()</span></tt></a>.</p>
</dd></dl>

<dl class="method">
<dt id="sqlsoup.SQLSoup.with_labels">
<tt class="descname">with_labels</tt><big>(</big><em>selectable</em>, <em>base=None</em>, <em>**mapper_args</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#SQLSoup.with_labels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SQLSoup.with_labels" title="Permalink to this definition">¶</a></dt>
<dd><p>Map a selectable directly, wrapping the 
selectable in a subquery with labels.</p>
<p>The class and its mapping are not cached and will
be discarded once dereferenced (as of 0.6.6).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>selectable</strong> &#8211; an <tt class="xref py py-func docutils literal"><span class="pre">expression.select()</span></tt> construct.</li>
<li><strong>base</strong> &#8211; a Python class which will be used as the
base for the mapped class. If <tt class="docutils literal"><span class="pre">None</span></tt>, the &#8220;base&#8221;
argument specified by this <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a>
instance&#8217;s constructor will be used, which defaults to
<tt class="docutils literal"><span class="pre">object</span></tt>.</li>
<li><strong>mapper_args</strong> &#8211; Dictionary of arguments which will
be passed directly to <tt class="xref py py-func docutils literal"><span class="pre">orm.mapper()</span></tt>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="sqlsoup.SelectableClassType">
<em class="property">class </em><tt class="descclassname">sqlsoup.</tt><tt class="descname">SelectableClassType</tt><a class="reference internal" href="_modules/sqlsoup.html#SelectableClassType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.SelectableClassType" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a SQLSoup mapping to a <a class="reference external" href="http://www.sqlalchemy.org/docs/core/expression_api.html#sqlalchemy.sql.expression.Selectable" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.sql.expression.Selectable</span></tt></a>
construct, such as a table or SELECT statement.</p>
</dd></dl>

<dl class="class">
<dt id="sqlsoup.TableClassType">
<em class="property">class </em><tt class="descclassname">sqlsoup.</tt><tt class="descname">TableClassType</tt><a class="reference internal" href="_modules/sqlsoup.html#TableClassType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.TableClassType" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a SQLSoup mapping to a <a class="reference external" href="http://www.sqlalchemy.org/docs/core/schema.html#sqlalchemy.schema.Table" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.schema.Table</span></tt></a>
construct.</p>
<p>This object is produced automatically when a table-name
attribute is accessed from a <a class="reference internal" href="#sqlsoup.SQLSoup" title="sqlsoup.SQLSoup"><tt class="xref py py-class docutils literal"><span class="pre">SQLSoup</span></tt></a> instance.</p>
<dl class="method">
<dt id="sqlsoup.TableClassType.relate">
<tt class="descname">relate</tt><big>(</big><em>propname</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/sqlsoup.html#TableClassType.relate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sqlsoup.TableClassType.relate" title="Permalink to this definition">¶</a></dt>
<dd><p>Produce a relationship between this mapped table and another
one.</p>
<p>This makes usage of SQLAlchemy&#8217;s <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/relationships.html#sqlalchemy.orm.relationship" title="(in SQLAlchemy v0.7)"><tt class="xref py py-func docutils literal"><span class="pre">sqlalchemy.orm.relationship()</span></tt></a>
construct.</p>
</dd></dl>

</dd></dl>

<dl class="data">
<dt id="sqlsoup.Session">
<tt class="descclassname">sqlsoup.</tt><tt class="descname">Session</tt><em class="property"> = &lt;sqlalchemy.orm.scoping.ScopedSession object at 0x101d32fd0&gt;</em><a class="headerlink" href="#sqlsoup.Session" title="Permalink to this definition">¶</a></dt>
<dd><p>SQLSoup&#8217;s default session registry.</p>
<p>This is an instance of <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/session.html#sqlalchemy.orm.scoping.ScopedSession" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.orm.scoping.ScopedSession</span></tt></a>,
and provides a new <a class="reference external" href="http://www.sqlalchemy.org/docs/orm/session.html#sqlalchemy.orm.session.Session" title="(in SQLAlchemy v0.7)"><tt class="xref py py-class docutils literal"><span class="pre">sqlalchemy.orm.session.Session</span></tt></a>
object for each application thread which refers to it.</p>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="tutorial.html"
                        title="previous chapter">Tutorial</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/api.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="tutorial.html" title="Tutorial"
             >previous</a> |</li>
        <li><a href="index.html">SQLSoup 0.9.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2005-2012, Jonathan Ellis, Mike Bayer.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
    </div>
  </body>
</html>