psycopg2/doc/api/public/psycopg2.extras.DictCursor-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.DictCursor</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;DictCursor\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.extras.DictCursor-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.extras.DictCursor-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 DictCursor</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.cursor-class.html"><code>cursor</code></a> --+\r
  52              |\r
  53             <strong class="uidshort">DictCursor</strong>\r
  54 </pre><br />\r
  55 \r
  56 <hr/>\r
  57 \r
  58 <p>A cursor that keeps a list of column name -&gt; index mappings.</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="callproc"></a><span class="summary-sig"><span class="summary-sig-name">callproc</span>(<span class="summary-sig-arg">self</span>,\r
  68           <span class="summary-sig-arg">procname</span>,\r
  69           <span class="summary-sig-arg">vars</span>)</span></code>\r
  70 </td></tr>\r
  71 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  72   <td><code><a name="execute"></a><span class="summary-sig"><span class="summary-sig-name">execute</span>(<span class="summary-sig-arg">self</span>,\r
  73           <span class="summary-sig-arg">query</span>,\r
  74           <span class="summary-sig-arg">vars</span>,\r
  75           <span class="summary-sig-arg">async</span>)</span></code>\r
  76 </td></tr>\r
  77 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  78   <td><code><a name="fetchall"></a><span class="summary-sig"><span class="summary-sig-name">fetchall</span>(<span class="summary-sig-arg">self</span>)</span></code>\r
  79 </td></tr>\r
  80 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  81   <td><code><a name="fetchmany"></a><span class="summary-sig"><span class="summary-sig-name">fetchmany</span>(<span class="summary-sig-arg">self</span>,\r
  82           <span class="summary-sig-arg">size</span>)</span></code>\r
  83 </td></tr>\r
  84 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  85   <td><code><a name="fetchone"></a><span class="summary-sig"><span class="summary-sig-name">fetchone</span>(<span class="summary-sig-arg">self</span>)</span></code>\r
  86 </td></tr>\r
  87 <tr bgcolor="#e8f0f8" class="group">\r
  88   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></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="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
  91 <br />\r
  92 x.__delattr__('name') &lt;==&gt; del x.name</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="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
  95 <br />\r
  96 x.__getattribute__('name') &lt;==&gt; x.name</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="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>\r
  99 <br />\r
 100 Return hash(x)...</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="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 103 <br />\r
 104 helper for pickle</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="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
 107 <br />\r
 108 helper for pickle</td></tr>\r
 109 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 110   <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
 111 <br />\r
 112 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
 113 </table><br />\r
 114 \r
 115 \r
 116 <!-- =========== START OF METHOD DETAILS =========== -->\r
 117 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 118 <tr bgcolor="#70b0f0" class="details">\r
 119   <th colspan="2">Method Details</th></tr>\r
 120 </table>\r
 121 \r
 122 <a name="callproc"></a>\r
 123 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 124   <h3><span class="sig"><span class="sig-name">callproc</span>(<span class="sig-arg">self</span>,\r
 125           <span class="sig-arg">procname</span>,\r
 126           <span class="sig-arg">vars</span>=<span class="sig-default">None</span>)</span>\r
 127   </h3>\r
 128   <dl><dt></dt><dd>\r
 129     <dl><dt>Overrides:</dt>\r
 130       <dd><a href="../private/psycopg2._psycopg.cursor-class.html#callproc"><code>psycopg2._psycopg.cursor.callproc</code></a></dd>\r
 131     </dl>\r
 132   </dd></dl>\r
 133 </td></tr></table>\r
 134 \r
 135 <a name="execute"></a>\r
 136 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 137   <h3><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,\r
 138           <span class="sig-arg">query</span>,\r
 139           <span class="sig-arg">vars</span>=<span class="sig-default">None</span>,\r
 140           <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
 141   </h3>\r
 142   <dl><dt></dt><dd>\r
 143     <dl><dt>Overrides:</dt>\r
 144       <dd><a href="../private/psycopg2._psycopg.cursor-class.html#execute"><code>psycopg2._psycopg.cursor.execute</code></a></dd>\r
 145     </dl>\r
 146   </dd></dl>\r
 147 </td></tr></table>\r
 148 \r
 149 <a name="fetchall"></a>\r
 150 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 151   <h3><span class="sig"><span class="sig-name">fetchall</span>(<span class="sig-arg">self</span>)</span>\r
 152   </h3>\r
 153   <dl><dt></dt><dd>\r
 154     <dl><dt>Overrides:</dt>\r
 155       <dd><a href="../private/psycopg2._psycopg.cursor-class.html#fetchall"><code>psycopg2._psycopg.cursor.fetchall</code></a></dd>\r
 156     </dl>\r
 157   </dd></dl>\r
 158 </td></tr></table>\r
 159 \r
 160 <a name="fetchmany"></a>\r
 161 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 162   <h3><span class="sig"><span class="sig-name">fetchmany</span>(<span class="sig-arg">self</span>,\r
 163           <span class="sig-arg">size</span>=<span class="sig-default">None</span>)</span>\r
 164   </h3>\r
 165   <dl><dt></dt><dd>\r
 166     <dl><dt>Overrides:</dt>\r
 167       <dd><a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany"><code>psycopg2._psycopg.cursor.fetchmany</code></a></dd>\r
 168     </dl>\r
 169   </dd></dl>\r
 170 </td></tr></table>\r
 171 \r
 172 <a name="fetchone"></a>\r
 173 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 174   <h3><span class="sig"><span class="sig-name">fetchone</span>(<span class="sig-arg">self</span>)</span>\r
 175   </h3>\r
 176   <dl><dt></dt><dd>\r
 177     <dl><dt>Overrides:</dt>\r
 178       <dd><a href="../private/psycopg2._psycopg.cursor-class.html#fetchone"><code>psycopg2._psycopg.cursor.fetchone</code></a></dd>\r
 179     </dl>\r
 180   </dd></dl>\r
 181 </td></tr></table>\r
 182 <br />\r
 183 \r
 184 \r
 185 <!-- =========== START OF NAVBAR =========== -->\r
 186 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 187   <tr valign="middle">\r
 188     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
 189     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 190     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 191     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 192     <th class="navbar" width="100%"></th>\r
 193   </tr>\r
 194 </table>\r
 195 \r
 196 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 197   <tr>\r
 198     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:32 2006</td>\r
 199     <td align="right" class="footer">\r
 200       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 201     </td>\r
 202   </tr>\r
 203 </table>\r
 204 </body>\r
 205 </html>\r