1
<?xml version="1.0" encoding="utf-8"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>psycopg2.pool.PersistentConnectionPool</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript">
10
function setFrame(url1, url2){
11
parent.frames[1].location.href = url1;
12
parent.frames[2].location.href = url2;
17
<body bgcolor="white" text="black" link="blue" vlink="#204080"
20
<!-- =========== START OF NAVBAR =========== -->
21
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
23
<th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
24
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
25
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
26
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
27
<th class="navbar" width="100%"></th>
30
<table width="100%" cellpadding="0" cellspacing="0">
33
<span class="breadcrumbs">
34
<a href="psycopg2-module.html">Package psycopg2</a> ::
35
<a href="psycopg2.pool-module.html">Module pool</a> ::
36
Class PersistentConnectionPool
39
<td><table cellpadding="0" cellspacing="0">
40
<tr><td align="right"><span class="options">[<a href="../private/psycopg2.pool.PersistentConnectionPool-class.html">show private</a> | hide private]</span></td></tr>
41
<tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="psycopg2.pool.PersistentConnectionPool-class.html" target="_top">no frames</a>]</span></td></tr>
45
<!-- =========== START OF CLASS DESCRIPTION =========== -->
46
<h2 class="class">Type PersistentConnectionPool</h2>
48
<pre class="base-tree">
49
<a href="__builtin__.object-class.html"><code>object</code></a> --+
51
<a href="psycopg2.pool.AbstractConnectionPool-class.html"><code>AbstractConnectionPool</code></a> --+
53
<strong class="uidshort">PersistentConnectionPool</strong>
58
<p>A pool that assigns persistent connections to different threads.</p>
59
<p>Note that this connection pool generates by itself the required keys
60
using the current thread id. This means that untill a thread put away
61
a connection it will always get the same connection object by successive
62
.getconn() calls. This also means that a thread can't use more than one
63
single connection from the pool.</p>
67
<!-- =========== START OF METHOD SUMMARY =========== -->
68
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
69
<tr bgcolor="#70b0f0" class="summary">
70
<th colspan="2">Method Summary</th></tr>
71
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
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>,
73
<span class="summary-sig-arg">minconn</span>,
74
<span class="summary-sig-arg">maxconn</span>,
75
<span class="summary-sig-vararg">*args</span>,
76
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
78
Initialize the threading lock.</td></tr>
79
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
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>
82
Close all connections (even the one currently in use.)</td></tr>
83
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
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>
86
Generate thread id and return a connection.</td></tr>
87
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
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>,
89
<span class="summary-sig-arg">conn</span>,
90
<span class="summary-sig-arg">close</span>)</span></code>
92
Put away an unused connection.</td></tr>
93
<tr bgcolor="#e8f0f8" class="group">
94
<th colspan="2"> Inherited from object</th></tr>
95
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
96
<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>
98
x.__delattr__('name') <==> del x.name</td></tr>
99
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
100
<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>
102
x.__getattribute__('name') <==> x.name</td></tr>
103
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
104
<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>
106
Return hash(x)...</td></tr>
107
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
108
<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>,
109
<span class="summary-sig-arg">S</span>,
110
<span class="summary-sig-vararg">...</span>)</span></code>
112
Return a new object with type S, a subtype of T...</td></tr>
113
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
114
<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>
116
helper for pickle</td></tr>
117
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
118
<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>
120
helper for pickle</td></tr>
121
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
122
<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>
124
Return repr(x)...</td></tr>
125
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
126
<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>
128
x.__setattr__('name', value) <==> x.name = value</td></tr>
129
<tr><td align="right" valign="top" width="15%" class="rtype"> </td>
130
<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>
132
Return str(x)...</td></tr>
136
<!-- =========== START OF METHOD DETAILS =========== -->
137
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
138
<tr bgcolor="#70b0f0" class="details">
139
<th colspan="2">Method Details</th></tr>
142
<a name="__init__"></a>
143
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
144
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
145
<span class="sig-arg">minconn</span>,
146
<span class="sig-arg">maxconn</span>,
147
<span class="sig-vararg">*args</span>,
148
<span class="sig-kwarg">**kwargs</span>)</span>
149
<br /><em class="fname">(Constructor)</em>
151
<p>Initialize the threading lock.</p>
153
<dl><dt>Overrides:</dt>
154
<dd><a href="psycopg2.pool.AbstractConnectionPool-class.html#__init__"><code>psycopg2.pool.AbstractConnectionPool.__init__</code></a></dd>
159
<a name="closeall"></a>
160
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
161
<h3><span class="sig"><span class="sig-name">closeall</span>(<span class="sig-arg">self</span>)</span>
163
<p>Close all connections (even the one currently in use.)</p>
168
<a name="getconn"></a>
169
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
170
<h3><span class="sig"><span class="sig-name">getconn</span>(<span class="sig-arg">self</span>)</span>
172
<p>Generate thread id and return a connection.</p>
177
<a name="putconn"></a>
178
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
179
<h3><span class="sig"><span class="sig-name">putconn</span>(<span class="sig-arg">self</span>,
180
<span class="sig-arg">conn</span>=<span class="sig-default">None</span>,
181
<span class="sig-arg">close</span>=<span class="sig-default">False</span>)</span>
183
<p>Put away an unused connection.</p>
190
<!-- =========== START OF NAVBAR =========== -->
191
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
193
<th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
194
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
195
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
196
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
197
<th class="navbar" width="100%"></th>
201
<table border="0" cellpadding="0" cellspacing="0" width="100%">
203
<td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006</td>
204
<td align="right" class="footer">
205
<a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
added
removed
doc/api/public/psycopg2.pool.PersistentConnectionPool-class.html
