psycopg2/doc/api/private/psycopg2.pool.AbstractConnectionPool-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.AbstractConnectionPool</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;AbstractConnectionPool\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.AbstractConnectionPool-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.AbstractConnectionPool-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 AbstractConnectionPool</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         <strong class="uidshort">AbstractConnectionPool</strong>\r
  52 </pre><br />\r
  53 \r
  54 <dl><dt>Known Subclasses:</dt>\r
  55 <dd>\r
  56     <a href="psycopg2.pool.PersistentConnectionPool-class.html"><code>PersistentConnectionPool</code></a>,\r
  57     <a href="psycopg2.pool.SimpleConnectionPool-class.html"><code>SimpleConnectionPool</code></a>,\r
  58     <a href="psycopg2.pool.ThreadedConnectionPool-class.html"><code>ThreadedConnectionPool</code></a></dd></dl>\r
  59 \r
  60 <hr/>\r
  61 \r
  62 <p>Generic key-based pooling code.</p>\r
  63 <hr/>\r
  64 \r
  65 \r
  66 <!-- =========== START OF METHOD SUMMARY =========== -->\r
  67 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
  68 <tr bgcolor="#70b0f0" class="summary">\r
  69   <th colspan="2">Method Summary</th></tr>\r
  70 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  71   <td><code><span class="summary-sig"><a href="psycopg2.pool.AbstractConnectionPool-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-arg">self</span>,\r
  72           <span class="summary-sig-arg">minconn</span>,\r
  73           <span class="summary-sig-arg">maxconn</span>,\r
  74           <span class="summary-sig-vararg">*args</span>,\r
  75           <span class="summary-sig-kwarg">**kwargs</span>)</span></code>\r
  76 <br />\r
  77 Initialize the connection pool.</td></tr>\r
  78 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  79   <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
  80 <br />\r
  81 Close all connections.</td></tr>\r
  82 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  83   <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
  84           <span class="summary-sig-arg">key</span>)</span></code>\r
  85 <br />\r
  86 Create a new connection and assign it to 'key' if not None.</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="../private/psycopg2.pool.AbstractConnectionPool-class.html#_getconn" class="summary-sig-name"><code>_getconn</code></a>(<span class="summary-sig-arg">self</span>,\r
  89           <span class="summary-sig-arg">key</span>)</span></code>\r
  90 <br />\r
  91 Get a free connection and assign it to 'key' if not None.</td></tr>\r
  92 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  93   <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
  94 <br />\r
  95 Return a new unique key.</td></tr>\r
  96 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  97   <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
  98           <span class="summary-sig-arg">conn</span>,\r
  99           <span class="summary-sig-arg">key</span>,\r
 100           <span class="summary-sig-arg">close</span>)</span></code>\r
 101 <br />\r
 102 Put away a connection.</td></tr>\r
 103 <tr bgcolor="#e8f0f8" class="group">\r
 104   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>\r
 105 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 106   <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
 107 <br />\r
 108 x.__delattr__('name') &lt;==&gt; del x.name</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="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 111 <br />\r
 112 x.__getattribute__('name') &lt;==&gt; x.name</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="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
 115 <br />\r
 116 Return hash(x)...</td></tr>\r
 117 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 118   <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
 119           <span class="summary-sig-arg">S</span>,\r
 120           <span class="summary-sig-vararg">...</span>)</span></code>\r
 121 <br />\r
 122 Return a new object with type S, a subtype of T...</td></tr>\r
 123 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 124   <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
 125 <br />\r
 126 helper for pickle</td></tr>\r
 127 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 128   <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
 129 <br />\r
 130 helper for pickle</td></tr>\r
 131 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 132   <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
 133 <br />\r
 134 Return repr(x)...</td></tr>\r
 135 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 136   <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
 137 <br />\r
 138 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
 139 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 140   <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
 141 <br />\r
 142 Return str(x)...</td></tr>\r
 143 </table><br />\r
 144 \r
 145 \r
 146 <!-- =========== START OF METHOD DETAILS =========== -->\r
 147 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 148 <tr bgcolor="#70b0f0" class="details">\r
 149   <th colspan="2">Method Details</th></tr>\r
 150 </table>\r
 151 \r
 152 <a name="__init__"></a>\r
 153 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 154   <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,\r
 155           <span class="sig-arg">minconn</span>,\r
 156           <span class="sig-arg">maxconn</span>,\r
 157           <span class="sig-vararg">*args</span>,\r
 158           <span class="sig-kwarg">**kwargs</span>)</span>\r
 159     <br /><em class="fname">(Constructor)</em>\r
 160   </h3>\r
 161 <p>Initialize the connection pool.</p>\r
 162 <p>New 'minconn' connections are created immediately calling 'connfunc'\r
 163 with given parameters. The connection pool will support a maximum of\r
 164 about 'maxconn' connections.</p>\r
 165   <dl><dt></dt><dd>\r
 166     <dl><dt>Overrides:</dt>\r
 167       <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>\r
 168     </dl>\r
 169   </dd></dl>\r
 170 </td></tr></table>\r
 171 \r
 172 <a name="_closeall"></a>\r
 173 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 174   <h3><span class="sig"><span class="sig-name">_closeall</span>(<span class="sig-arg">self</span>)</span>\r
 175   </h3>\r
 176 <p>Close all connections.</p>\r
 177 <p>Note that this can lead to some code fail badly when trying to use\r
 178 an already closed connection. If you call .closeall() make sure\r
 179 your code can deal with it.</p>\r
 180   <dl><dt></dt><dd>\r
 181   </dd></dl>\r
 182 </td></tr></table>\r
 183 \r
 184 <a name="_connect"></a>\r
 185 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 186   <h3><span class="sig"><span class="sig-name">_connect</span>(<span class="sig-arg">self</span>,\r
 187           <span class="sig-arg">key</span>=<span class="sig-default">None</span>)</span>\r
 188   </h3>\r
 189 <p>Create a new connection and assign it to 'key' if not None.</p>\r
 190   <dl><dt></dt><dd>\r
 191   </dd></dl>\r
 192 </td></tr></table>\r
 193 \r
 194 <a name="_getconn"></a>\r
 195 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 196   <h3><span class="sig"><span class="sig-name">_getconn</span>(<span class="sig-arg">self</span>,\r
 197           <span class="sig-arg">key</span>=<span class="sig-default">None</span>)</span>\r
 198   </h3>\r
 199 <p>Get a free connection and assign it to 'key' if not None.</p>\r
 200   <dl><dt></dt><dd>\r
 201   </dd></dl>\r
 202 </td></tr></table>\r
 203 \r
 204 <a name="_getkey"></a>\r
 205 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 206   <h3><span class="sig"><span class="sig-name">_getkey</span>(<span class="sig-arg">self</span>)</span>\r
 207   </h3>\r
 208 <p>Return a new unique key.</p>\r
 209   <dl><dt></dt><dd>\r
 210   </dd></dl>\r
 211 </td></tr></table>\r
 212 \r
 213 <a name="_putconn"></a>\r
 214 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 215   <h3><span class="sig"><span class="sig-name">_putconn</span>(<span class="sig-arg">self</span>,\r
 216           <span class="sig-arg">conn</span>,\r
 217           <span class="sig-arg">key</span>=<span class="sig-default">None</span>,\r
 218           <span class="sig-arg">close</span>=<span class="sig-default">False</span>)</span>\r
 219   </h3>\r
 220 <p>Put away a connection.</p>\r
 221   <dl><dt></dt><dd>\r
 222   </dd></dl>\r
 223 </td></tr></table>\r
 224 <br />\r
 225 \r
 226 \r
 227 <!-- =========== START OF NAVBAR =========== -->\r
 228 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 229   <tr valign="middle">\r
 230     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
 231     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 232     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 233     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 234     <th class="navbar" width="100%"></th>\r
 235   </tr>\r
 236 </table>\r
 237 \r
 238 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 239   <tr>\r
 240     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006</td>\r
 241     <td align="right" class="footer">\r
 242       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 243     </td>\r
 244   </tr>\r
 245 </table>\r
 246 </body>\r
 247 </html>\r