From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Tue, 21 Apr 2015 15:04:21 +0000 (-0400)
Subject: - add a warning to SingletonThreadPool that it isn't for general use
X-Git-Tag: rel_0_9_10~40
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f03a086e85298cbc29fadc0663b97b1fbd88317e;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

- add a warning to SingletonThreadPool that it isn't for general use

(cherry picked from commit 732fb99fc0afbeb69d684b2bfa6d0be6250919a3)
---

diff --git a/lib/sqlalchemy/pool.py b/lib/sqlalchemy/pool.py
index 65ef5e42bd..54cc13c75a 100644
--- a/lib/sqlalchemy/pool.py
+++ b/lib/sqlalchemy/pool.py
@@ -811,6 +811,19 @@ class SingletonThreadPool(Pool):
     Maintains one connection per each thread, never moving a connection to a
     thread other than the one which it was created in.
 
+    .. warning::  the :class:`.SingletonThreadPool` will call ``.close()``
+       on arbitrary connections that exist beyond the size setting of
+       ``pool_size``, e.g. if more unique **thread identities**
+       than what ``pool_size`` states are used.   This cleanup is
+       non-deterministic and not sensitive to whether or not the connections
+       linked to those thread identities are currently in use.
+
+       :class:`.SingletonThreadPool` may be improved in a future release,
+       however in its current status it is generally used only for test
+       scenarios using a SQLite ``:memory:`` database and is not recommended
+       for production use.
+
+
     Options are the same as those of :class:`.Pool`, as well as:
 
     :param pool_size: The number of threads in which to maintain connections