psycopg2/doc/api/private/psycopg2.pool.PersistentConnectionPool-class.html

   1 <?xml version="1.0" encoding="utf-8"?>\r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"\r
   3           "DTD/xhtml1-transitional.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   5 <head>\r
   6   <title>psycopg2.pool.PersistentConnectionPool</title>\r
   7   <link rel="stylesheet" href="epydoc.css" type="text/css" />\r
   8 <script type="text/javascript">\r
   9 <!--\r
  10 function setFrame(url1, url2){\r
  11     parent.frames[1].location.href = url1;\r
  12     parent.frames[2].location.href = url2;\r
  13 }\r
  14 -->\r
  15 </script>\r
  16 </head>\r
  17 <body bgcolor="white" text="black" link="blue" vlink="#204080"\r
  18       alink="#204080">\r
  19 \r
  20 <!-- =========== START OF NAVBAR =========== -->\r
  21 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
  22   <tr valign="middle">\r
  23     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
  24     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
  25     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
  26     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
  27     <th class="navbar" width="100%"></th>\r
  28   </tr>\r
  29 </table>\r
  30 <table width="100%" cellpadding="0" cellspacing="0">\r
  31   <tr valign="top">\r
  32     <td width="100%">\r
  33       <span class="breadcrumbs">\r
  34         <a href="psycopg2-module.html">Package&nbsp;psycopg2</a> ::\r
  35         <a href="psycopg2.pool-module.html">Module&nbsp;pool</a> ::\r
  36         Class&nbsp;PersistentConnectionPool\r
  37       </span><br />\r
  38     </td>\r
  39     <td><table cellpadding="0" cellspacing="0">\r
  40       <tr><td align="right"><span class="options">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/psycopg2.pool.PersistentConnectionPool-class.html">hide&nbsp;private</a>]</span></td></tr>\r
  41       <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a>&nbsp;|&nbsp;<a href="psycopg2.pool.PersistentConnectionPool-class.html" target="_top">no&nbsp;frames</a>]</span></td></tr>\r
  42     </table></td>\r
  43 </tr></table>\r
  44 \r
  45 <!-- =========== START OF CLASS DESCRIPTION =========== -->\r
  46 <h2 class="class">Type PersistentConnectionPool</h2>\r
  47 \r
  48 <pre class="base-tree">\r
  49             <a href="__builtin__.object-class.html"><code>object</code></a> --+    \r
  50                      |    \r
  51 <a href="psycopg2.pool.AbstractConnectionPool-class.html"><code>AbstractConnectionPool</code></a> --+\r
  52                          |\r
  53                         <strong class="uidshort">PersistentConnectionPool</strong>\r
  54 </pre><br />\r
  55 \r
  56 <hr/>\r
  57 \r
  58 <p>A pool that assigns persistent connections to different threads.</p>\r
  59 <p>Note that this connection pool generates by itself the required keys\r
  60 using the current thread id.  This means that untill a thread put away\r
  61 a connection it will always get the same connection object by successive\r
  62 .getconn() calls. This also means that a thread can't use more than one\r
  63 single connection from the pool.</p>\r
  64 <hr/>\r
  65 \r
  66 \r
  67 <!-- =========== START OF METHOD SUMMARY =========== -->\r
  68 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
  69 <tr bgcolor="#70b0f0" class="summary">\r
  70   <th colspan="2">Method Summary</th></tr>\r
  71 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  72   <td><code><span class="summary-sig"><a href="psycopg2.pool.PersistentConnectionPool-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-arg">self</span>,\r
  73           <span class="summary-sig-arg">minconn</span>,\r
  74           <span class="summary-sig-arg">maxconn</span>,\r
  75           <span class="summary-sig-vararg">*args</span>,\r
  76           <span class="summary-sig-kwarg">**kwargs</span>)</span></code>\r
  77 <br />\r
  78 Initialize the threading lock.</td></tr>\r
  79 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  80   <td><code><span class="summary-sig"><a href="psycopg2.pool.PersistentConnectionPool-class.html#closeall" class="summary-sig-name"><code>closeall</code></a>(<span class="summary-sig-arg">self</span>)</span></code>\r
  81 <br />\r
  82 Close all connections (even the one currently in use.)</td></tr>\r
  83 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  84   <td><code><span class="summary-sig"><a href="psycopg2.pool.PersistentConnectionPool-class.html#getconn" class="summary-sig-name"><code>getconn</code></a>(<span class="summary-sig-arg">self</span>)</span></code>\r
  85 <br />\r
  86 Generate thread id and return a connection.</td></tr>\r
  87 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  88   <td><code><span class="summary-sig"><a href="psycopg2.pool.PersistentConnectionPool-class.html#putconn" class="summary-sig-name"><code>putconn</code></a>(<span class="summary-sig-arg">self</span>,\r
  89           <span class="summary-sig-arg">conn</span>,\r
  90           <span class="summary-sig-arg">close</span>)</span></code>\r
  91 <br />\r
  92 Put away an unused connection.</td></tr>\r
  93 <tr bgcolor="#e8f0f8" class="group">\r
  94   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from AbstractConnectionPool</th></tr>\r
  95 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  96   <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_closeall" class="summary-sig-name"><code>_closeall</code></a>(<span class="summary-sig-arg">self</span>)</span></code>\r
  97 <br />\r
  98 Close all connections.</td></tr>\r
  99 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 100   <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_connect" class="summary-sig-name"><code>_connect</code></a>(<span class="summary-sig-arg">self</span>,\r
 101           <span class="summary-sig-arg">key</span>)</span></code>\r
 102 <br />\r
 103 Create a new connection and assign it to 'key' if not None.</td></tr>\r
 104 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 105   <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_getconn" class="summary-sig-name"><code>_getconn</code></a>(<span class="summary-sig-arg">self</span>,\r
 106           <span class="summary-sig-arg">key</span>)</span></code>\r
 107 <br />\r
 108 Get a free connection and assign it to 'key' if not None.</td></tr>\r
 109 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 110   <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_getkey" class="summary-sig-name"><code>_getkey</code></a>(<span class="summary-sig-arg">self</span>)</span></code>\r
 111 <br />\r
 112 Return a new unique key.</td></tr>\r
 113 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 114   <td><code><span class="summary-sig"><a href="../private/psycopg2.pool.AbstractConnectionPool-class.html#_putconn" class="summary-sig-name"><code>_putconn</code></a>(<span class="summary-sig-arg">self</span>,\r
 115           <span class="summary-sig-arg">conn</span>,\r
 116           <span class="summary-sig-arg">key</span>,\r
 117           <span class="summary-sig-arg">close</span>)</span></code>\r
 118 <br />\r
 119 Put away a connection.</td></tr>\r
 120 <tr bgcolor="#e8f0f8" class="group">\r
 121   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>\r
 122 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 123   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 124 <br />\r
 125 x.__delattr__('name') &lt;==&gt; del x.name</td></tr>\r
 126 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 127   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 128 <br />\r
 129 x.__getattribute__('name') &lt;==&gt; x.name</td></tr>\r
 130 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 131   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
 132 <br />\r
 133 Return hash(x)...</td></tr>\r
 134 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 135   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class="summary-sig-arg">T</span>,\r
 136           <span class="summary-sig-arg">S</span>,\r
 137           <span class="summary-sig-vararg">...</span>)</span></code>\r
 138 <br />\r
 139 Return a new object with type S, a subtype of T...</td></tr>\r
 140 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 141   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 142 <br />\r
 143 helper for pickle</td></tr>\r
 144 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 145   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 146 <br />\r
 147 helper for pickle</td></tr>\r
 148 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 149   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
 150 <br />\r
 151 Return repr(x)...</td></tr>\r
 152 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 153   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 154 <br />\r
 155 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
 156 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 157   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
 158 <br />\r
 159 Return str(x)...</td></tr>\r
 160 </table><br />\r
 161 \r
 162 \r
 163 <!-- =========== START OF METHOD DETAILS =========== -->\r
 164 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 165 <tr bgcolor="#70b0f0" class="details">\r
 166   <th colspan="2">Method Details</th></tr>\r
 167 </table>\r
 168 \r
 169 <a name="__init__"></a>\r
 170 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 171   <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,\r
 172           <span class="sig-arg">minconn</span>,\r
 173           <span class="sig-arg">maxconn</span>,\r
 174           <span class="sig-vararg">*args</span>,\r
 175           <span class="sig-kwarg">**kwargs</span>)</span>\r
 176     <br /><em class="fname">(Constructor)</em>\r
 177   </h3>\r
 178 <p>Initialize the threading lock.</p>\r
 179   <dl><dt></dt><dd>\r
 180     <dl><dt>Overrides:</dt>\r
 181       <dd><a href="psycopg2.pool.AbstractConnectionPool-class.html#__init__"><code>psycopg2.pool.AbstractConnectionPool.__init__</code></a></dd>\r
 182     </dl>\r
 183   </dd></dl>\r
 184 </td></tr></table>\r
 185 \r
 186 <a name="closeall"></a>\r
 187 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 188   <h3><span class="sig"><span class="sig-name">closeall</span>(<span class="sig-arg">self</span>)</span>\r
 189   </h3>\r
 190 <p>Close all connections (even the one currently in use.)</p>\r
 191   <dl><dt></dt><dd>\r
 192   </dd></dl>\r
 193 </td></tr></table>\r
 194 \r
 195 <a name="getconn"></a>\r
 196 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 197   <h3><span class="sig"><span class="sig-name">getconn</span>(<span class="sig-arg">self</span>)</span>\r
 198   </h3>\r
 199 <p>Generate thread id and return a connection.</p>\r
 200   <dl><dt></dt><dd>\r
 201   </dd></dl>\r
 202 </td></tr></table>\r
 203 \r
 204 <a name="putconn"></a>\r
 205 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 206   <h3><span class="sig"><span class="sig-name">putconn</span>(<span class="sig-arg">self</span>,\r
 207           <span class="sig-arg">conn</span>=<span class="sig-default">None</span>,\r
 208           <span class="sig-arg">close</span>=<span class="sig-default">False</span>)</span>\r
 209   </h3>\r
 210 <p>Put away an unused connection.</p>\r
 211   <dl><dt></dt><dd>\r
 212   </dd></dl>\r
 213 </td></tr></table>\r
 214 <br />\r
 215 \r
 216 \r
 217 <!-- =========== START OF NAVBAR =========== -->\r
 218 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 219   <tr valign="middle">\r
 220     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
 221     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 222     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 223     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 224     <th class="navbar" width="100%"></th>\r
 225   </tr>\r
 226 </table>\r
 227 \r
 228 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 229   <tr>\r
 230     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006</td>\r
 231     <td align="right" class="footer">\r
 232       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 233     </td>\r
 234   </tr>\r
 235 </table>\r
 236 </body>\r
 237 </html>\r