File: module-sqlobject.dbconnection.html

package info (click to toggle)
sqlobject 3.1.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 9,280 kB
  • ctags: 17,912
  • sloc: python: 16,713; sh: 18; makefile: 13
file content (288 lines) | stat: -rw-r--r-- 12,296 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

  <h1 class="pudge-member-page-heading">
    <tt>dbconnection</tt>
  </h1>
  <p class="pudge-member-parent-link">
    <small>
    The dbconnection module is accessible via the
    <a href="module-sqlobject.html">
      <tt>sqlobject</tt>
    </a> module.
    </small>
  </p>
  <div id="pudge-section-nav">
  <ul>
    <li>
      <a href="#attributes" class="pudge-section-link">
        Attributes (3)
      </a>
    </li><li>
      <a href="#functions" class="pudge-section-link">
        Functions (5)
      </a>
    </li><li>
      <a href="#classes" class="pudge-section-link">
        Classes (11)
      </a>
    </li><li>
      <span class="pudge-missing-section-link">
        Modules
      </span>
    </li>
    <li>
      <a href="module-sqlobject.dbconnection-index.html" class="pudge-section-link">
        Index
      </a>
    </li>
    <li>
      <a href="sqlobject/dbconnection.py.html" class="pudge-section-link">
        Source
      </a>
    </li>
  </ul>
  </div>
  <div style="clear: left"></div>
  <hr>
    <a name="attributes"></a>
    <h2>Attributes</h2>
    <div class="pudge-member name">
    <a name="PY2"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="module-sqlobject.dbconnection.html#PY2" class="pudge-obj-link">PY2</a></tt></h4>
    <div class="pudge-section rst">
      <pre>True</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="__package__"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="module-sqlobject.dbconnection.html#__package__" class="pudge-obj-link">__package__</a></tt></h4>
    <div class="pudge-section rst">
      <pre>'sqlobject'</pre>
    </div>
  </div><div class="pudge-member name">
    <a name="TheURIOpener"></a>
    <h4 class="pudge-member-name"><span class="prefix">a</span>
      <tt><a href="module-sqlobject.dbconnection.html#TheURIOpener" class="pudge-obj-link">TheURIOpener</a></tt></h4>
    <div class="pudge-section rst">
      <pre>&lt;sqlobject.dbconnection.ConnectionURIOpener object at 0xb672c94c></pre>
    </div>
  </div>
    <a name="functions"></a>
    <h2>Functions</h2>
    <div class="pudge-member routine ">
    <a name="makeDebugWriter"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="module-sqlobject.dbconnection.html#makeDebugWriter" class="pudge-obj-link">makeDebugWriter</a>(connection, loggerName, loglevel)</tt>
      <a href="sqlobject/dbconnection.py.html?f=61&amp;l=67#61" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="registerConnection"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="module-sqlobject.dbconnection.html#registerConnection" class="pudge-obj-link">registerConnection</a>(self, schemes, builder)</tt>
      <a href="sqlobject/dbconnection.py.html?f=1039&amp;l=1046#1039" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="registerConnectionInstance"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="module-sqlobject.dbconnection.html#registerConnectionInstance" class="pudge-obj-link">registerConnectionInstance</a>(self, inst)</tt>
      <a href="sqlobject/dbconnection.py.html?f=1047&amp;l=1057#1047" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="connectionForURI"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="module-sqlobject.dbconnection.html#connectionForURI" class="pudge-obj-link">connectionForURI</a>(self, uri, oldUri=False, **args)</tt>
      <a href="sqlobject/dbconnection.py.html?f=1058&amp;l=1081#1058" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div><div class="pudge-member routine ">
    <a name="dbConnectionForScheme"></a>
    <h4 class="pudge-member-name"><span class="prefix">f</span>
      <tt><a href="module-sqlobject.dbconnection.html#dbConnectionForScheme" class="pudge-obj-link">dbConnectionForScheme</a>(self, scheme)</tt>
      <a href="sqlobject/dbconnection.py.html?f=1082&amp;l=1088#1082" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    </div>
  </div>
    <a name="classes"></a>
    <h2>Classes</h2>
    <div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.ConsoleWriter.html" class="pudge-obj-link">ConsoleWriter</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=35&amp;l=49#35" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.ConsoleWriter.html#members">
          2 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.LogWriter.html" class="pudge-obj-link">LogWriter</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=51&amp;l=59#51" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.LogWriter.html#members">
          2 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.Boolean.html" class="pudge-obj-link">Boolean</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=69&amp;l=83#69" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      A bool class that also understands some special string keywords
    </p>
    <p>Understands: yes/no, true/false, on/off, 1/0, case ignored.</p>
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.Boolean.html#members">
          4 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.DBConnection.html" class="pudge-obj-link">DBConnection</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=85&amp;l=269#85" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.DBConnection.html#members">
          7 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.ConnWrapper.html" class="pudge-obj-link">ConnWrapper</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=271&amp;l=309#271" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      This represents a SQLObject class that is bound to a specific
connection (instances have a connection instance variable, but
classes are global, so this is binds the connection variable
lazily when a class method is accessed)
    </p>
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.ConnWrapper.html#members">
          5 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.ConnMethodWrapper.html" class="pudge-obj-link">ConnMethodWrapper</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=311&amp;l=327#311" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.ConnMethodWrapper.html#members">
          5 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.DBAPI.html" class="pudge-obj-link">DBAPI</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=329&amp;l=736#329" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      Subclass must define a 
    <cite>makeConnection()</cite>
   method, which
returns a newly-created connection object.
    </p>
    <p><tt class="docutils literal">queryInsertID</tt> must also be defined.</p>
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.DBAPI.html#members">
          35 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.Iteration.html" class="pudge-obj-link">Iteration</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=738&amp;l=785#738" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.Iteration.html#members">
          8 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.Transaction.html" class="pudge-obj-link">Transaction</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=787&amp;l=929#787" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.Transaction.html#members">
          15 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.ConnectionHub.html" class="pudge-obj-link">ConnectionHub</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=931&amp;l=1030#931" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
    <p class="pudge-member-blurb">
      This object serves as a hub for connections, so that you can pass
in a ConnectionHub to a SQLObject subclass as though it was a
connection, but actually bind a real database connection later.
You can also bind connections on a per-thread basis.
    </p>
    <p>You must hang onto the original ConnectionHub instance, as you
cannot retrieve it again from the class or instance.</p>
<p>To use the hub, do something like:</p>
<pre class="literal-block">
hub = ConnectionHub()
class MyClass(SQLObject):
    _connection = hub

hub.threadConnection = connectionFromURI('...')
</pre>
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.ConnectionHub.html#members">
          9 members</a>.
      </p>
    </div>
  </div><div class="pudge-member class ">
    <h4 class="pudge-member-name"><span class="prefix">C</span>
      <tt>
        <a href="class-sqlobject.dbconnection.ConnectionURIOpener.html" class="pudge-obj-link">ConnectionURIOpener</a>(...)</tt>
      <a href="sqlobject/dbconnection.py.html?f=1032&amp;l=1088#1032" class="pudge-member-view-source" title="View Source">...</a>
    </h4>
    <div class="pudge-section rst">
      <p class="note">
        This class contains <a href="class-sqlobject.dbconnection.ConnectionURIOpener.html#members">
          8 members</a>.
      </p>
    </div>
  </div>
  <p>
    <small>
    See 
    <a href="sqlobject/dbconnection.py.html" title="sqlobject/dbconnection.py:0">the source</a>
    for more information.
    </small>
  </p>