psycopg2/doc/api/private/psycopg2.extras.DictConnection-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.extras.DictConnection</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.extras-module.html">Module&nbsp;extras</a> ::\r
  36         Class&nbsp;DictConnection\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.extras.DictConnection-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.extras.DictConnection-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 DictConnection</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="../private/psycopg2._psycopg.connection-class.html"><code>connection</code></a> --+\r
  52              |\r
  53             <strong class="uidshort">DictConnection</strong>\r
  54 </pre><br />\r
  55 \r
  56 <hr/>\r
  57 \r
  58 <p>A connection that uses DictCursor automatically.</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><a name="cursor"></a><span class="summary-sig"><span class="summary-sig-name">cursor</span>(<span class="summary-sig-arg">self</span>)</span></code>\r
  68 </td></tr>\r
  69 <tr bgcolor="#e8f0f8" class="group">\r
  70   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from connection</th></tr>\r
  71 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  72   <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
  73 <br />\r
  74 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</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._psycopg.connection-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class="summary-sig-arg">T</span>,\r
  77           <span class="summary-sig-arg">S</span>,\r
  78           <span class="summary-sig-vararg">...</span>)</span></code>\r
  79 <br />\r
  80 Return a new object with type S, a subtype of T...</td></tr>\r
  81 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  82   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
  83 <br />\r
  84 Return repr(x)...</td></tr>\r
  85 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  86   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.connection-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
  87 <br />\r
  88 Return str(x)...</td></tr>\r
  89 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  90   <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
  91 <br />\r
  92 Close the connection.</td></tr>\r
  93 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  94   <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
  95 <br />\r
  96 Commit all changes to database.</td></tr>\r
  97 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  98   <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
  99 <br />\r
 100 Roll back all changes done to database.</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._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
 103 <br />\r
 104 Set client encoding to <tt class="docutils literal"><span class="pre">encoding</span></tt>.</td></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="../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
 107 <br />\r
 108 Switch isolation level to <tt class="docutils literal"><span class="pre">level</span></tt>.</td></tr>\r
 109 <tr bgcolor="#e8f0f8" class="group">\r
 110   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>\r
 111 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 112   <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
 113 <br />\r
 114 x.__delattr__('name') &lt;==&gt; del x.name</td></tr>\r
 115 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 116   <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
 117 <br />\r
 118 x.__getattribute__('name') &lt;==&gt; x.name</td></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#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
 121 <br />\r
 122 Return hash(x)...</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#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 133 <br />\r
 134 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
 135 </table><br />\r
 136 \r
 137 \r
 138 <!-- =========== START OF PROPERTY SUMMARY =========== -->\r
 139 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 140 <tr bgcolor="#70b0f0" class="summary">\r
 141   <th colspan="2">Property Summary</th></tr>\r
 142 <tr bgcolor="#e8f0f8" class="group">\r
 143   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from connection</th></tr>\r
 144 <tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</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">&nbsp;</td>\r
 146   <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">&nbsp;</td>\r
 147   <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">&nbsp;</td>\r
 148   <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">&nbsp;</td>\r
 149   <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">&nbsp;</td>\r
 150   <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">&nbsp;</td>\r
 151   <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">&nbsp;</td>\r
 152   <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">&nbsp;</td>\r
 153   <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">&nbsp;</td>\r
 154   <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">&nbsp;</td>\r
 155   <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#notices"><code>notices</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 156   <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#notifies"><code>notifies</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 157   <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><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</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">&nbsp;</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">&nbsp;</td>\r
 160   <td><strong><a href="../private/psycopg2._psycopg.connection-class.html#Warning"><code>Warning</code></a></strong>: A database warning.</td></tr></table><br />\r
 161 \r
 162 \r
 163 <!-- =========== START OF METHOD DETAILS =========== -->\r
 164 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 165 <tr bgcolor="#70b0f0" class="details">\r
 166   <th colspan="2">Method Details</th></tr>\r
 167 </table>\r
 168 \r
 169 <a name="cursor"></a>\r
 170 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 171   <h3><span class="sig"><span class="sig-name">cursor</span>(<span class="sig-arg">self</span>)</span>\r
 172   </h3>\r
 173   <dl><dt></dt><dd>\r
 174     <dl><dt>Overrides:</dt>\r
 175       <dd><a href="../private/psycopg2._psycopg.connection-class.html#cursor"><code>psycopg2._psycopg.connection.cursor</code></a></dd>\r
 176     </dl>\r
 177   </dd></dl>\r
 178 </td></tr></table>\r
 179 <br />\r
 180 \r
 181 \r
 182 <!-- =========== START OF NAVBAR =========== -->\r
 183 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 184   <tr valign="middle">\r
 185     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
 186     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 187     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 188     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 189     <th class="navbar" width="100%"></th>\r
 190   </tr>\r
 191 </table>\r
 192 \r
 193 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 194   <tr>\r
 195     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:31 2006</td>\r
 196     <td align="right" class="footer">\r
 197       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 198     </td>\r
 199   </tr>\r
 200 </table>\r
 201 </body>\r
 202 </html>\r