SimplePooledDB - a very simple DB-API 2 database connection pool.
 
Implements a pool of threadsafe cached DB-API 2 connections
to a database which are transparently reused.
 
This should result in a speedup for persistent applications
such as the "Webware for Python" AppServer.
 
For more information on the DB-API 2, see:
    http://www.python.org/peps/pep-0249.html
For more information on Webware for Python, see:
    http://www.webwareforpython.org
 
Measures are taken to make the pool of connections threadsafe
regardless of whether the DB-API 2 module used is threadsafe
on the connection level (threadsafety > 1) or not. It must only
be threadsafe on the module level (threadsafety = 1). If the
DB-API 2 module is threadsafe, the connections will be shared
between threads (keep this in mind if you use transactions).
 
Usage:
 
The idea behind SimplePooledDB is that it's completely transparent.
After you have established your connection pool, stating the
DB-API 2 module to be used, the number of connections
to be cached in the pool and the connection parameters, e.g.
 
    import pgdb # import used DB-API 2 module
    from DBUtils.SimplePooledDB import PooledDB
    dbpool = PooledDB(pgdb, 5, host=..., database=..., user=..., ...)
 
you can demand database connections from that pool,
 
    db = dbpool.connection()
 
and use them just as if they were ordinary DB-API 2 connections.
It's really just a proxy class.
 
db.close() will return the connection to the pool, it will not
actually close it. This is so your existing code works nicely.
 
Ideas for improvement:
 
* Do not create the maximum number of connections on startup
already, but only a certain number and the rest on demand.
* Detect and transparently reset "bad" connections.
* Connections should have some sort of maximum usage limit
after which they should be automatically closed and reopened.
* Prefer or enforce thread-affinity for the connections,
allowing for both sharable and non-sharable connections.
 
Please note that these and other ideas have been already
implemented in in PooledDB, a more sophisticated version
of SimplePooledDB. You might also consider using PersistentDB
instead for thread-affine persistent database connections.
SimplePooledDB may still serve as a very simple reference
and example implementation for developers.
 
 
Copyright, credits and license:
 
* Contributed as MiscUtils/DBPool for Webware for Python
  by Dan Green, December 2000
* Thread safety bug found by Tom Schwaller
* Fixes by Geoff Talvola (thread safety in _threadsafe_getConnection())
* Clean up by Chuck Esterbrook
* Fix unthreadsafe functions which were leaking, Jay Love
* Eli Green's webware-discuss comments were lifted for additional docs
* Clean-up and detailed commenting, rename and move to DBUtils
  by Christoph Zwerschke in September 2005
 
Licensed under the Open Software License version 2.1.

Classes
		PooledDB PooledDBConnection exceptions.Exception(exceptions.BaseException) PooledDBError NotSupportedError   class NotSupportedError(PooledDBError)     DB-API module not supported by PooledDB.     Method resolution order: NotSupportedError PooledDBError exceptions.Exception exceptions.BaseException __builtin__.object Data descriptors inherited from PooledDBError: __weakref__ list of weak references to the object (if defined) Methods inherited from exceptions.Exception: __init__(...) x.__init__(...) initializes x; see x.__class__.__doc__ for signature Data and other attributes inherited from exceptions.Exception: __new__ = <built-in method __new__ of type object> T.__new__(S, ...) -> a new object with type S, a subtype of T Methods inherited from exceptions.BaseException: __delattr__(...) x.__delattr__('name') <==> del x.name __getattribute__(...) x.__getattribute__('name') <==> x.name __getitem__(...) x.__getitem__(y) <==> x[y] __getslice__(...) x.__getslice__(i, j) <==> x[i:j]   Use of negative indices is not supported. __reduce__(...) __repr__(...) x.__repr__() <==> repr(x) __setattr__(...) x.__setattr__('name', value) <==> x.name = value __setstate__(...) __str__(...) x.__str__() <==> str(x) __unicode__(...) Data descriptors inherited from exceptions.BaseException: __dict__ args message   class PooledDB     A very simple database connection pool.   After you have created the connection pool, you can get connections using getConnection().     Methods defined here: __init__(self, dbapi, maxconnections, *args, **kwargs) Set up the database connection pool.   dbapi: the DB-API 2 compliant module you want to use maxconnections: the number of connections cached in the pool args, kwargs: the parameters that shall be used to establish     the database connections using connect() Data and other attributes defined here: version = '1.1'   class PooledDBConnection     A proxy class for pooled database connections.   You don't normally deal with this class directly, but use PooledDB to get new connections.     Methods defined here: __del__(self) __getattr__(self, name) __init__(self, pool, con) close(self) Close the pooled connection.   class PooledDBError(exceptions.Exception)     General PooledDB error.     Method resolution order: PooledDBError exceptions.Exception exceptions.BaseException __builtin__.object Data descriptors defined here: __weakref__ list of weak references to the object (if defined) Methods inherited from exceptions.Exception: __init__(...) x.__init__(...) initializes x; see x.__class__.__doc__ for signature Data and other attributes inherited from exceptions.Exception: __new__ = <built-in method __new__ of type object> T.__new__(S, ...) -> a new object with type S, a subtype of T Methods inherited from exceptions.BaseException: __delattr__(...) x.__delattr__('name') <==> del x.name __getattribute__(...) x.__getattribute__('name') <==> x.name __getitem__(...) x.__getitem__(y) <==> x[y] __getslice__(...) x.__getslice__(i, j) <==> x[i:j]   Use of negative indices is not supported. __reduce__(...) __repr__(...) x.__repr__() <==> repr(x) __setattr__(...) x.__setattr__('name', value) <==> x.name = value __setstate__(...) __str__(...) x.__str__() <==> str(x) __unicode__(...) Data descriptors inherited from exceptions.BaseException: __dict__ args message

Data
		__date__ = '$Date: 2011-08-14 13:57:11 +0200 (So, 14. Aug 2011) $' __revision__ = '$Rev: 8218 $' __version__ = '1.1'