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
6 <title>psycopg2._psycopg.connection</title>
\r
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
\r
8 <script type="text/javascript">
\r
10 function setFrame(url1, url2){
\r
11 parent.frames[1].location.href = url1;
\r
12 parent.frames[2].location.href = url2;
\r
17 <body bgcolor="white" text="black" link="blue" vlink="#204080"
\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"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
\r
24 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
25 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
26 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
\r
27 <th class="navbar" width="100%"></th>
\r
30 <table width="100%" cellpadding="0" cellspacing="0">
\r
33 <span class="breadcrumbs">
\r
34 <a href="psycopg2-module.html">Package psycopg2</a> ::
\r
35 <a href="../private/psycopg2._psycopg-module.html">Module _psycopg</a> ::
\r
36 Class connection
\r
39 <td><table cellpadding="0" cellspacing="0">
\r
40 <tr><td align="right"><span class="options">[<strong>show private</strong> | hide private]</span></td></tr>
\r
41 <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="../private/psycopg2._psycopg.connection-class.html" target="_top">no frames</a>]</span></td></tr>
\r
45 <!-- =========== START OF CLASS DESCRIPTION =========== -->
\r
46 <h2 class="class">Type connection</h2>
\r
48 <pre class="base-tree">
\r
49 <a href="__builtin__.object-class.html"><code>object</code></a> --+
\r
51 <strong class="uidshort">connection</strong>
\r
54 <dl><dt>Known Subclasses:</dt>
\r
56 <a href="psycopg2.psycopg1.connection-class.html"><code>connection</code></a>,
\r
57 <a href="psycopg2.extras.DictConnection-class.html"><code>DictConnection</code></a></dd></dl>
\r
61 <p>connection(dsn, ...) -> new connection object</p>
\r
65 <!-- =========== START OF METHOD SUMMARY =========== -->
\r
66 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
67 <tr bgcolor="#70b0f0" class="summary">
\r
68 <th colspan="2">Method Summary</th></tr>
\r
69 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
70 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
72 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td></tr>
\r
73 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
74 <td><code><a name="__new__"></a><span class="summary-sig"><span class="summary-sig-name">__new__</span>(<span class="summary-sig-arg">T</span>,
\r
75 <span class="summary-sig-arg">S</span>,
\r
76 <span class="summary-sig-vararg">...</span>)</span></code>
\r
78 Return a new object with type S, a subtype of T...</td></tr>
\r
79 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
80 <td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">x</span>)</span></code>
\r
82 Return repr(x)...</td></tr>
\r
83 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
84 <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class="summary-sig-arg">x</span>)</span></code>
\r
86 Return str(x)...</td></tr>
\r
87 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
88 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#close" class="summary-sig-name"><code>close</code></a>()</span></code>
\r
90 Close the connection.</td></tr>
\r
91 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
92 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#commit" class="summary-sig-name"><code>commit</code></a>()</span></code>
\r
94 Commit all changes to database.</td></tr>
\r
95 <tr><td align="right" valign="top" width="15%" class="rtype"><a href="../private/psycopg2._psycopg.cursor-class.html" class="link"><code>extensions.cursor</code></a></td>
\r
96 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#cursor" class="summary-sig-name"><code>cursor</code></a>(<span class="summary-sig-arg">cursor_factory</span>)</span></code>
\r
98 new cursor</td></tr>
\r
99 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
100 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#rollback" class="summary-sig-name"><code>rollback</code></a>()</span></code>
\r
102 Roll back all changes done to database.</td></tr>
\r
103 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
104 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#set_client_encoding" class="summary-sig-name"><code>set_client_encoding</code></a>(<span class="summary-sig-arg">encoding</span>)</span></code>
\r
106 Set client encoding to <tt class="docutils literal docutils literal"><span class="pre">encoding</span></tt>.</td></tr>
\r
107 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
108 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#set_isolation_level" class="summary-sig-name"><code>set_isolation_level</code></a>(<span class="summary-sig-arg">level</span>)</span></code>
\r
110 Switch isolation level to <tt class="docutils literal docutils literal"><span class="pre">level</span></tt>.</td></tr>
\r
111 <tr bgcolor="#e8f0f8" class="group">
\r
112 <th colspan="2"> Inherited from object</th></tr>
\r
113 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
114 <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
116 x.__delattr__('name') <==> del x.name</td></tr>
\r
117 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
118 <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
120 x.__getattribute__('name') <==> x.name</td></tr>
\r
121 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
122 <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
124 Return hash(x)...</td></tr>
\r
125 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
126 <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
128 helper for pickle</td></tr>
\r
129 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
130 <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
132 helper for pickle</td></tr>
\r
133 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
134 <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
136 x.__setattr__('name', value) <==> x.name = value</td></tr>
\r
140 <!-- =========== START OF PROPERTY SUMMARY =========== -->
\r
141 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
142 <tr bgcolor="#70b0f0" class="summary">
\r
143 <th colspan="2">Property Summary</th></tr>
\r
144 <tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
145 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#closed"><code>closed</code></a></strong>: True if the connection is closed.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
146 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#dsn"><code>dsn</code></a></strong>: The current connection string.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
147 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#encoding"><code>encoding</code></a></strong>: The current client encoding.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
148 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#isolation_level"><code>isolation_level</code></a></strong>: The current isolation level.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
149 <td><a name="notices"></a><strong><code>notices</code></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
150 <td><a name="notifies"></a><strong><code>notifies</code></strong></td></tr><tr bgcolor="#e8f0f8" class="group">
\r
151 <th colspan="2"> DBAPI-2.0 errors</th></tr>
\r
152 <tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
153 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#Error"><code>Error</code></a></strong>: Base class for error exceptions.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
154 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#Warning"><code>Warning</code></a></strong>: A database warning.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
155 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#InterfaceError"><code>InterfaceError</code></a></strong>: Error related to the database interface.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
156 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#DatabaseError"><code>DatabaseError</code></a></strong>: Error related to the database engine.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
157 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#InternalError"><code>InternalError</code></a></strong>: The database encountered an internal error.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
158 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#OperationalError"><code>OperationalError</code></a></strong>: Error related to database operation (disconnect, memory allocation etc).</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
159 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#ProgrammingError"><code>ProgrammingError</code></a></strong>: Error related to database programming (SQL error, table not found etc).</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
160 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#IntegrityError"><code>IntegrityError</code></a></strong>: Error related to database integrity.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
161 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#DataError"><code>DataError</code></a></strong>: Error related to problems with the processed data.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
162 <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#NotSupportedError"><code>NotSupportedError</code></a></strong>: A not supported datbase API was called.</td></tr></table><br />
\r
165 <!-- =========== START OF METHOD DETAILS =========== -->
\r
166 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
167 <tr bgcolor="#70b0f0" class="details">
\r
168 <th colspan="2">Method Details</th></tr>
\r
171 <a name="__init__"></a>
\r
172 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
173 <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-vararg">...</span>)</span>
\r
174 <br /><em class="fname">(Constructor)</em>
\r
176 <p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p>
\r
178 <dl><dt>Overrides:</dt>
\r
179 <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
\r
184 <a name="__new__"></a>
\r
185 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
186 <h3><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
\r
187 <span class="sig-arg">S</span>,
\r
188 <span class="sig-vararg">...</span>)</span>
\r
191 <dl><dt>Returns:</dt>
\r
193 <pre class="literalblock">
\r
194 a new object with type S, a subtype of T
\r
198 <dl><dt>Overrides:</dt>
\r
199 <dd><a href="__builtin__.object-class.html#__new__"><code>__builtin__.object.__new__</code></a></dd>
\r
204 <a name="__repr__"></a>
\r
205 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
206 <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
\r
207 <br /><em class="fname">(Representation operator)</em>
\r
210 <dl><dt>Returns:</dt>
\r
212 <pre class="literalblock">
\r
217 <dl><dt>Overrides:</dt>
\r
218 <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd>
\r
223 <a name="__str__"></a>
\r
224 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
225 <h3><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
\r
226 <br /><em class="fname">(Informal representation operator)</em>
\r
229 <dl><dt>Returns:</dt>
\r
231 <pre class="literalblock">
\r
236 <dl><dt>Overrides:</dt>
\r
237 <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd>
\r
242 <a name="close"></a>
\r
243 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
244 <h3><span class="sig"><span class="sig-name">close</span>()</span>
\r
246 <p>Close the connection.</p>
\r
251 <a name="commit"></a>
\r
252 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
253 <h3><span class="sig"><span class="sig-name">commit</span>()</span>
\r
255 <p>Commit all changes to database.</p>
\r
260 <a name="cursor"></a>
\r
261 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
262 <h3><span class="sig"><span class="sig-name">cursor</span>(<span class="sig-arg">cursor_factory</span>=<span class="sig-default">extensions.cursor</span>)</span>
\r
265 <p>Return a new cursor.</p>
\r
266 <p>The <tt class="docutils literal"><span class="pre">cursor_factory</span></tt> argument can be used to
\r
267 create non-standard cursors by passing a class different from the
\r
268 default. Note that the new class <em>should</em> be a sub-class of
\r
269 <a href="../private/psycopg2._psycopg.cursor-class.html" class="link"><code>extensions.cursor</code></a>.</p>
\r
271 <dl><dt>Returns:</dt>
\r
273 <a href="../private/psycopg2._psycopg.cursor-class.html" class="link"><code>extensions.cursor</code></a> </dd>
\r
278 <a name="rollback"></a>
\r
279 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
280 <h3><span class="sig"><span class="sig-name">rollback</span>()</span>
\r
282 <p>Roll back all changes done to database.</p>
\r
287 <a name="set_client_encoding"></a>
\r
288 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
289 <h3><span class="sig"><span class="sig-name">set_client_encoding</span>(<span class="sig-arg">encoding</span>)</span>
\r
291 <p>Set client encoding to <tt class="docutils literal docutils literal docutils literal"><span class="pre">encoding</span></tt>.</p>
\r
296 <a name="set_isolation_level"></a>
\r
297 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
298 <h3><span class="sig"><span class="sig-name">set_isolation_level</span>(<span class="sig-arg">level</span>)</span>
\r
300 <p>Switch isolation level to <tt class="docutils literal docutils literal docutils literal"><span class="pre">level</span></tt>.</p>
\r
307 <!-- =========== START OF PROPERTY DETAILS =========== -->
\r
308 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
309 <tr bgcolor="#70b0f0" class="details">
\r
310 <th colspan="2">Property Details</th></tr>
\r
312 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
314 <a name="Error"></a>
\r
316 <p>Base class for error exceptions.</p>
\r
317 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
319 <a name="Warning"></a>
\r
321 <p>A database warning.</p>
\r
322 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
324 <a name="InterfaceError"></a>
\r
325 <h3>InterfaceError</h3>
\r
326 <p>Error related to the database interface.</p>
\r
327 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
329 <a name="DatabaseError"></a>
\r
330 <h3>DatabaseError</h3>
\r
331 <p>Error related to the database engine.</p>
\r
332 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
334 <a name="InternalError"></a>
\r
335 <h3>InternalError</h3>
\r
336 <p>The database encountered an internal error.</p>
\r
337 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
339 <a name="OperationalError"></a>
\r
340 <h3>OperationalError</h3>
\r
341 <p>Error related to database operation (disconnect, memory allocation etc).</p>
\r
342 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
344 <a name="ProgrammingError"></a>
\r
345 <h3>ProgrammingError</h3>
\r
346 <p>Error related to database programming (SQL error, table not found etc).</p>
\r
347 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
349 <a name="IntegrityError"></a>
\r
350 <h3>IntegrityError</h3>
\r
351 <p>Error related to database integrity.</p>
\r
352 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
354 <a name="DataError"></a>
\r
356 <p>Error related to problems with the processed data.</p>
\r
357 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
359 <a name="NotSupportedError"></a>
\r
360 <h3>NotSupportedError</h3>
\r
361 <p>A not supported datbase API was called.</p>
\r
362 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
364 <a name="closed"></a>
\r
366 <p>True if the connection is closed.</p>
\r
367 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
371 <p>The current connection string.</p>
\r
372 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
374 <a name="encoding"></a>
\r
376 <p>The current client encoding.</p>
\r
377 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
379 <a name="isolation_level"></a>
\r
380 <h3>isolation_level</h3>
\r
381 <p>The current isolation level.</p>
\r
382 </td></tr></table><br />
\r
385 <!-- =========== START OF NAVBAR =========== -->
\r
386 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
\r
387 <tr valign="middle">
\r
388 <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
\r
389 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
390 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
391 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
\r
392 <th class="navbar" width="100%"></th>
\r
396 <table border="0" cellpadding="0" cellspacing="0" width="100%">
\r
398 <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:31 2006</td>
\r
399 <td align="right" class="footer">
\r
400 <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
\r