Skip to content

Commit 8c2f73c

Browse files
CitoCito
committed
Updated the docs for version 1.1.
1 parent 024ed8e commit 8c2f73c

5 files changed

Lines changed: 195 additions & 38 deletions

File tree

‎DBUtils/Docs/RelNotes-1.1.html‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<title>DBUtils 1.1 Release Notes</title>
5+
<link rel="stylesheet" href="Doc.css" type="text/css">
6+
</head>
7+
<body>
8+
<h1 class="header">DBUtils 1.1 Release Notes</h1>
9+
10+
<p>DBUtils 1.1 was released on August 14, 2011.</p>
11+
12+
<p>This is the seventh public release of DBUtils.</p>
13+
14+
<h2>Improvements:</h2>
15+
<ul>
16+
<li>The transparent reopening of connections is actually an undesired behavior
17+
if it happens during database transactions. In these cases, the transaction
18+
should fail and the error be reported back to the application instead of the
19+
rest of the transaction being executed in a new connection and therefore in
20+
a new transaction. Therefore DBUtils now allows suspending the transparent
21+
reopening during transactions. All you need to do is indicate the beginning
22+
of a transaction by calling the <tt>begin()</tt> method of the connection.
23+
DBUtils makes sure that this method always exists, even if the database driver
24+
does not support it.</li>
25+
<li>If the database driver supports a <tt>ping()</tt> method, then DBUtils
26+
can use it to check whether connections are alive instead of just trying
27+
to use the connection and reestablishing it in case it was dead. Since these
28+
checks are done at the expense of some performance, you have exact control
29+
when these are executed via the new <tt>ping</tt> parameter.</li>
30+
<li><tt>PooledDB</tt> has got another new parameter <tt>reset</tt> for
31+
controlling how connections are reset before being put back into the pool.</li>
32+
</ul>
33+
34+
<h2>Bugfixes:</h2>
35+
<ul>
36+
<li>Fixed propagation of error messages when the connection was lost.</li>
37+
<li>Fixed an issue with the <tt>setoutputsize()</tt> cursor method.</li>
38+
<li>Fixed some minor issues with the <tt>DBUtilsExample</tt> for Webware.</li>
39+
</ul>
40+
41+
<div class="footer">
42+
DBUtils (<a href="http://www.webwareforpython.org/DBUtils">www.webwareforpython.org/DBUtils</a>)
43+
</div>
44+
</body>
45+
</html>

‎DBUtils/Docs/UsersGuide.de.html‎

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6-
<meta name="generator" content="Docutils 0.8: http://docutils.sourceforge.net/" />
6+
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
77
<title>Benutzeranleitung für DBUtils</title>
88
<link rel="stylesheet" href="Doc.css" type="text/css" />
99
</head>
@@ -15,8 +15,8 @@ <h1 class="title">Benutzeranleitung für DBUtils</h1>
1515
<col class="docinfo-content" />
1616
<tbody valign="top">
1717
<tr><th class="docinfo-name">Version:</th>
18-
<td>1.0</td></tr>
19-
<tr class="field"><th class="docinfo-name">Released:</th><td class="field-body">11/29/08</td>
18+
<td>1.1</td></tr>
19+
<tr class="field"><th class="docinfo-name">Released:</th><td class="field-body">08/14/11</td>
2020
</tr>
2121
<tr class="field"><th class="docinfo-name">Translations:</th><td class="field-body"><a class="reference external" href="UsersGuide.html">English</a> German</td>
2222
</tr>
@@ -314,6 +314,12 @@ <h2>PersistentDB</h2>
314314
bei denen die Ausfallsicherung zum Tragen kommen soll, falls die Vorgabe
315315
(OperationalError, InternalError) nicht geeignet sein sollte</p>
316316
</li>
317+
<li><p class="first"><tt class="docutils literal">ping</tt>: mit diesem Parameter kann eingestellt werden, wann Verbindungen
318+
mit der <tt class="docutils literal">ping()</tt>-Methode geprüft werden, falls eine solche vorhanden ist
319+
(<tt class="docutils literal">0</tt> = <tt class="docutils literal">None</tt> = nie, <tt class="docutils literal">1</tt> = Standardwert = immer wenn neu angefragt,
320+
<tt class="docutils literal">2</tt> = vor Erzeugen eines Cursors, <tt class="docutils literal">4</tt> = vor dem Ausführen von Abfragen,
321+
<tt class="docutils literal">7</tt> = immer, und alle Bitkombinationen dieser Werte)</p>
322+
</li>
317323
<li><p class="first"><tt class="docutils literal">closeable</tt>: wenn dies auf <tt class="docutils literal">True</tt> gesetzt wird, dann wird das Schließen
318324
von Verbindungen erlaubt, normalerweise wird es jedoch ignoriert</p>
319325
</li>
@@ -350,10 +356,16 @@ <h2>PersistentDB</h2>
350356
Stattdessen wird die Verbindung automatisch dann geschlossen, wenn der Thread
351357
endet. Sie können dieses Verhalten ändern, indem Sie den Parameter namens
352358
<tt class="docutils literal">closeable</tt> setzen.</p>
353-
<p>Beachten Sie, dass das Holen einer Verbindung etwas beschleunigt werden kann,
354-
indem Sie den Parameter <tt class="docutils literal">threadlocal</tt> auf <tt class="docutils literal">threading.local</tt> setzen; dies
355-
könnte aber in einigen Umgebungen nicht funktionieren (es ist zum Beispiel
356-
bekannt, dass <tt class="docutils literal">mod_wsgi</tt> hier Probleme bereitet, da es Daten, die mit <tt class="docutils literal">threading.local</tt> gespeichert wurden, zwischen Requests löscht).</p>
359+
<p>Bitte beachten Sie, dass Transaktionen explizit durch Aufruf der Methode
360+
<tt class="docutils literal">begin()</tt> eingeleiten werden müssen. Hierdurch wird sichergestellt, dass
361+
das transparente Neueröffnen von Verbindungen bis zum Ende der Transaktion
362+
ausgesetzt wird, und dass die Verbindung zurückgerollt wird, before sie vom
363+
gleichen Thread erneut benutzt wird.</p>
364+
<p>Das Holen einer Verbindung kann etwas beschleunigt werden, indem man den
365+
Parameter <tt class="docutils literal">threadlocal</tt> auf <tt class="docutils literal">threading.local</tt> setzt; dies könnte aber in
366+
einigen Umgebungen nicht funktionieren (es ist zum Beispiel bekannt, dass
367+
<tt class="docutils literal">mod_wsgi</tt> hier Probleme bereitet, da es Daten, die mit <tt class="docutils literal">threading.local</tt>
368+
gespeichert wurden, zwischen Requests löscht).</p>
357369
</div>
358370
<div class="section" id="id2">
359371
<h2>PooledDB</h2>
@@ -397,10 +409,21 @@ <h2>PooledDB</h2>
397409
<li><p class="first"><tt class="docutils literal">setsession</tt>: eine optionale Liste von SQL-Befehlen zur Initialisierung
398410
der Datenbanksitzung, z.B. <tt class="docutils literal">[&quot;set datestyle to german&quot;, <span class="pre">...]</span></tt></p>
399411
</li>
412+
<li><p class="first"><tt class="docutils literal">reset</tt>: wie Verbindungen zurückgesetzt werden sollen, bevor sie wieder
413+
in den Verbindungspool zurückgegeben werden (<tt class="docutils literal">False</tt> oder <tt class="docutils literal">None</tt>
414+
um mit <tt class="docutils literal">begin()</tt> gestartete Transaktionen zurückzurollen, der Standardwert
415+
<tt class="docutils literal">True</tt> rollt sicherheitshalber mögliche Transaktionen immer zurück)</p>
416+
</li>
400417
<li><p class="first"><tt class="docutils literal">failures</tt>: eine optionale Exception-Klasse oder ein Tupel von Exceptions
401418
bei denen die Ausfallsicherung zum Tragen kommen soll, falls die Vorgabe
402419
(OperationalError, InternalError) nicht geeignet sein sollte</p>
403420
</li>
421+
<li><p class="first"><tt class="docutils literal">ping</tt>: mit diesem Parameter kann eingestellt werden, wann Verbindungen
422+
mit der <tt class="docutils literal">ping()</tt>-Methode geprüft werden, falls eine solche vorhanden ist
423+
(<tt class="docutils literal">0</tt> = <tt class="docutils literal">None</tt> = nie, <tt class="docutils literal">1</tt> = Standardwert = immer wenn neu angefragt,
424+
<tt class="docutils literal">2</tt> = vor Erzeugen eines Cursors, <tt class="docutils literal">4</tt> = vor dem Ausführen von Abfragen,
425+
<tt class="docutils literal">7</tt> = immer, und alle Bitkombinationen dieser Werte)</p>
426+
</li>
404427
<li><p class="first">Die als <tt class="docutils literal">creator</tt> angegebene Funktion oder die Funktion <tt class="docutils literal">connect</tt>
405428
des DB-API-2-Datenbankadapter-Moduls erhalten alle weiteren Parameter,
406429
wie <tt class="docutils literal">host</tt>, <tt class="docutils literal">database</tt>, <tt class="docutils literal">user</tt>, <tt class="docutils literal">password</tt> usw. Sie können einige
@@ -455,6 +478,12 @@ <h2>PooledDB</h2>
455478
cur.close() # oder del cur
456479
db.close() # oder del db
457480
</pre>
481+
<p>Bitte beachten Sie, dass Transaktionen explizit durch Aufruf der Methode
482+
<tt class="docutils literal">begin()</tt> eingeleiten werden müssen. Hierdurch wird sichergestellt,
483+
dass die Verbindung nicht mehr mit anderen Threads geteilt wird, dass das
484+
transparente Neueröffnen von Verbindungen bis zum Ende der Transaktion
485+
ausgesetzt wird, und dass die Verbindung zurückgerollt wird, bevor sie
486+
wieder an den Verbindungspool zurückgegeben wird.</p>
458487
</div>
459488
<div class="section" id="benutzung-in-webware-for-python">
460489
<h2>Benutzung in Webware for Python</h2>
@@ -556,15 +585,15 @@ <h1>Autoren</h1>
556585
<tr class="field"><th class="field-name">Beiträge:</th><td class="field-body">DBUtils benutzt Code, Anmerkungen und Vorschläge von
557586
Ian Bicking, Chuck Esterbrook (Webware for Python), Dan Green (DBTools),
558587
Jay Love, Michael Palmer, Tom Schwaller, Geoffrey Talvola,
559-
Warren Smith (DbConnectionPool), Ezio Vernacotola,
560-
Jehiah Czebotar, Matthew Harriger und Gregory Piñero.</td>
588+
Warren Smith (DbConnectionPool), Ezio Vernacotola, Jehiah Czebotar,
589+
Matthew Harriger, Gregory Piñero und Josef van Eenbergen.</td>
561590
</tr>
562591
</tbody>
563592
</table>
564593
</div>
565594
<div class="section" id="copyright-und-lizenz">
566595
<h1>Copyright und Lizenz</h1>
567-
<p>Copyright © 2005-2008 Christoph Zwerschke.
596+
<p>Copyright © 2005-2011 Christoph Zwerschke.
568597
Alle Rechte vorbehalten.</p>
569598
<p>DBUtils ist freie und quelloffene Software,
570599
lizenziert unter der <a class="reference external" href="http://www.opensource.org/licenses/osl-2.1.php">Open Software License version 2.1</a>.</p>

‎DBUtils/Docs/UsersGuide.de.txt‎

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Benutzeranleitung für DBUtils
22
+++++++++++++++++++++++++++++
33

4-
:Version: 1.0
5-
:Released: 11/29/08
4+
:Version: 1.1
5+
:Released: 08/14/11
66
:Translations: English_ German
77

88
.. _English: UsersGuide.html
@@ -275,6 +275,12 @@ Parameter angeben müssen:
275275
bei denen die Ausfallsicherung zum Tragen kommen soll, falls die Vorgabe
276276
(OperationalError, InternalError) nicht geeignet sein sollte
277277

278+
* ``ping``: mit diesem Parameter kann eingestellt werden, wann Verbindungen
279+
mit der ``ping()``-Methode geprüft werden, falls eine solche vorhanden ist
280+
(``0`` = ``None`` = nie, ``1`` = Standardwert = immer wenn neu angefragt,
281+
``2`` = vor Erzeugen eines Cursors, ``4`` = vor dem Ausführen von Abfragen,
282+
``7`` = immer, und alle Bitkombinationen dieser Werte)
283+
278284
* ``closeable``: wenn dies auf ``True`` gesetzt wird, dann wird das Schließen
279285
von Verbindungen erlaubt, normalerweise wird es jedoch ignoriert
280286

@@ -312,10 +318,17 @@ Stattdessen wird die Verbindung automatisch dann geschlossen, wenn der Thread
312318
endet. Sie können dieses Verhalten ändern, indem Sie den Parameter namens
313319
``closeable`` setzen.
314320

315-
Beachten Sie, dass das Holen einer Verbindung etwas beschleunigt werden kann,
316-
indem Sie den Parameter ``threadlocal`` auf ``threading.local`` setzen; dies
317-
könnte aber in einigen Umgebungen nicht funktionieren (es ist zum Beispiel
318-
bekannt, dass ``mod_wsgi`` hier Probleme bereitet, da es Daten, die mit ``threading.local`` gespeichert wurden, zwischen Requests löscht).
321+
Bitte beachten Sie, dass Transaktionen explizit durch Aufruf der Methode
322+
``begin()`` eingeleiten werden müssen. Hierdurch wird sichergestellt, dass
323+
das transparente Neueröffnen von Verbindungen bis zum Ende der Transaktion
324+
ausgesetzt wird, und dass die Verbindung zurückgerollt wird, before sie vom
325+
gleichen Thread erneut benutzt wird.
326+
327+
Das Holen einer Verbindung kann etwas beschleunigt werden, indem man den
328+
Parameter ``threadlocal`` auf ``threading.local`` setzt; dies könnte aber in
329+
einigen Umgebungen nicht funktionieren (es ist zum Beispiel bekannt, dass
330+
``mod_wsgi`` hier Probleme bereitet, da es Daten, die mit ``threading.local``
331+
gespeichert wurden, zwischen Requests löscht).
319332

320333
PooledDB
321334
--------
@@ -362,10 +375,21 @@ Parameter angeben müssen:
362375
* ``setsession``: eine optionale Liste von SQL-Befehlen zur Initialisierung
363376
der Datenbanksitzung, z.B. ``["set datestyle to german", ...]``
364377

378+
* ``reset``: wie Verbindungen zurückgesetzt werden sollen, bevor sie wieder
379+
in den Verbindungspool zurückgegeben werden (``False`` oder ``None``
380+
um mit ``begin()`` gestartete Transaktionen zurückzurollen, der Standardwert
381+
``True`` rollt sicherheitshalber mögliche Transaktionen immer zurück)
382+
365383
* ``failures``: eine optionale Exception-Klasse oder ein Tupel von Exceptions
366384
bei denen die Ausfallsicherung zum Tragen kommen soll, falls die Vorgabe
367385
(OperationalError, InternalError) nicht geeignet sein sollte
368386

387+
* ``ping``: mit diesem Parameter kann eingestellt werden, wann Verbindungen
388+
mit der ``ping()``-Methode geprüft werden, falls eine solche vorhanden ist
389+
(``0`` = ``None`` = nie, ``1`` = Standardwert = immer wenn neu angefragt,
390+
``2`` = vor Erzeugen eines Cursors, ``4`` = vor dem Ausführen von Abfragen,
391+
``7`` = immer, und alle Bitkombinationen dieser Werte)
392+
369393
* Die als ``creator`` angegebene Funktion oder die Funktion ``connect``
370394
des DB-API-2-Datenbankadapter-Moduls erhalten alle weiteren Parameter,
371395
wie ``host``, ``database``, ``user``, ``password`` usw. Sie können einige
@@ -421,6 +445,13 @@ sie gebraucht werden, etwa so::
421445
cur.close() # oder del cur
422446
db.close() # oder del db
423447

448+
Bitte beachten Sie, dass Transaktionen explizit durch Aufruf der Methode
449+
``begin()`` eingeleiten werden müssen. Hierdurch wird sichergestellt,
450+
dass die Verbindung nicht mehr mit anderen Threads geteilt wird, dass das
451+
transparente Neueröffnen von Verbindungen bis zum Ende der Transaktion
452+
ausgesetzt wird, und dass die Verbindung zurückgerollt wird, bevor sie
453+
wieder an den Verbindungspool zurückgegeben wird.
454+
424455
Benutzung in Webware for Python
425456
-------------------------------
426457
Wenn Sie DBUtils verwenden, um von Servlets des Web-Frameworks `Webware
@@ -542,14 +573,14 @@ Autoren
542573
:Beiträge: DBUtils benutzt Code, Anmerkungen und Vorschläge von
543574
Ian Bicking, Chuck Esterbrook (Webware for Python), Dan Green (DBTools),
544575
Jay Love, Michael Palmer, Tom Schwaller, Geoffrey Talvola,
545-
Warren Smith (DbConnectionPool), Ezio Vernacotola,
546-
Jehiah Czebotar, Matthew Harriger und Gregory Piñero.
576+
Warren Smith (DbConnectionPool), Ezio Vernacotola, Jehiah Czebotar,
577+
Matthew Harriger, Gregory Piñero und Josef van Eenbergen.
547578

548579

549580
Copyright und Lizenz
550581
====================
551582

552-
Copyright © 2005-2008 Christoph Zwerschke.
583+
Copyright © 2005-2011 Christoph Zwerschke.
553584
Alle Rechte vorbehalten.
554585

555586
DBUtils ist freie und quelloffene Software,

0 commit comments

Comments
 (0)