psycopg2/doc/api/public/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">[<a href="../private/psycopg2.pool.AbstractConnectionPool-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</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 bgcolor="#e8f0f8" class="group">\r
  79   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>\r
  80 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  81   <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
  82 <br />\r
  83 x.__delattr__('name') &lt;==&gt; del x.name</td></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="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
  86 <br />\r
  87 x.__getattribute__('name') &lt;==&gt; x.name</td></tr>\r
  88 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  89   <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
  90 <br />\r
  91 Return hash(x)...</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="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class="summary-sig-arg">T</span>,\r
  94           <span class="summary-sig-arg">S</span>,\r
  95           <span class="summary-sig-vararg">...</span>)</span></code>\r
  96 <br />\r
  97 Return a new object with type S, a subtype of T...</td></tr>\r
  98 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  99   <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
 100 <br />\r
 101 helper for pickle</td></tr>\r
 102 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 103   <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
 104 <br />\r
 105 helper for pickle</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="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
 108 <br />\r
 109 Return repr(x)...</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="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 112 <br />\r
 113 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
 114 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 115   <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
 116 <br />\r
 117 Return str(x)...</td></tr>\r
 118 </table><br />\r
 119 \r
 120 \r
 121 <!-- =========== START OF METHOD DETAILS =========== -->\r
 122 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 123 <tr bgcolor="#70b0f0" class="details">\r
 124   <th colspan="2">Method Details</th></tr>\r
 125 </table>\r
 126 \r
 127 <a name="__init__"></a>\r
 128 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 129   <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,\r
 130           <span class="sig-arg">minconn</span>,\r
 131           <span class="sig-arg">maxconn</span>,\r
 132           <span class="sig-vararg">*args</span>,\r
 133           <span class="sig-kwarg">**kwargs</span>)</span>\r
 134     <br /><em class="fname">(Constructor)</em>\r
 135   </h3>\r
 136 <p>Initialize the connection pool.</p>\r
 137 <p>New 'minconn' connections are created immediately calling 'connfunc'\r
 138 with given parameters. The connection pool will support a maximum of\r
 139 about 'maxconn' connections.</p>\r
 140   <dl><dt></dt><dd>\r
 141     <dl><dt>Overrides:</dt>\r
 142       <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>\r
 143     </dl>\r
 144   </dd></dl>\r
 145 </td></tr></table>\r
 146 <br />\r
 147 \r
 148 \r
 149 <!-- =========== START OF NAVBAR =========== -->\r
 150 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 151   <tr valign="middle">\r
 152     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
 153     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 154     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 155     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 156     <th class="navbar" width="100%"></th>\r
 157   </tr>\r
 158 </table>\r
 159 \r
 160 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 161   <tr>\r
 162     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006</td>\r
 163     <td align="right" class="footer">\r
 164       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 165     </td>\r
 166   </tr>\r
 167 </table>\r
 168 </body>\r
 169 </html>\r