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