psycopg2/doc/api/private/psycopg2._psycopg.cursor-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._psycopg.cursor</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="../private/psycopg2._psycopg-module.html">Module&nbsp;_psycopg</a> ::\r
  36         Class&nbsp;cursor\r
  37       </span><br />\r
  38     </td>\r
  39     <td><table cellpadding="0" cellspacing="0">\r
  40       <tr><td align="right"><span class="options">[<strong>show&nbsp;private</strong>&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="../private/psycopg2._psycopg.cursor-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 cursor</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">cursor</strong>\r
  52 </pre><br />\r
  53 \r
  54 <dl><dt>Known Subclasses:</dt>\r
  55 <dd>\r
  56     <a href="psycopg2.psycopg1.cursor-class.html"><code>cursor</code></a>,\r
  57     <a href="psycopg2.extras.DictCursor-class.html"><code>DictCursor</code></a></dd></dl>\r
  58 \r
  59 <hr/>\r
  60 \r
  61 <p>A database cursor.</p>\r
  62 <hr/>\r
  63 \r
  64 \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">&nbsp;</td>\r
  70   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>\r
  71 <br />\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">&nbsp;</td>\r
  74   <td><code><a name="__iter__"></a><span class="summary-sig"><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">x</span>)</span></code>\r
  75 <br />\r
  76 Return iter(x)...</td></tr>\r
  77 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  78   <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
  79           <span class="summary-sig-arg">S</span>,\r
  80           <span class="summary-sig-vararg">...</span>)</span></code>\r
  81 <br />\r
  82 Return a new object with type S, a subtype of T...</td></tr>\r
  83 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  84   <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
  85 <br />\r
  86 Return repr(x)...</td></tr>\r
  87 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  88   <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
  89 <br />\r
  90 Return str(x)...</td></tr>\r
  91 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
  92   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#callproc" class="summary-sig-name"><code>callproc</code></a>(<span class="summary-sig-arg">procname</span>,\r
  93           <span class="summary-sig-arg">parameters</span>,\r
  94           <span class="summary-sig-arg">async</span>)</span></code>\r
  95 <br />\r
  96 Execute stored procedure.</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.cursor-class.html#close" class="summary-sig-name"><code>close</code></a>()</span></code>\r
  99 <br />\r
 100 Close the cursor.</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.cursor-class.html#copy_from" class="summary-sig-name"><code>copy_from</code></a>(<span class="summary-sig-arg">file</span>,\r
 103           <span class="summary-sig-arg">table</span>,\r
 104           <span class="summary-sig-arg">sep</span>,\r
 105           <span class="summary-sig-arg">null</span>)</span></code>\r
 106 <br />\r
 107 Copy table from file.</td></tr>\r
 108 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 109   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#copy_to" class="summary-sig-name"><code>copy_to</code></a>(<span class="summary-sig-arg">file</span>,\r
 110           <span class="summary-sig-arg">table</span>,\r
 111           <span class="summary-sig-arg">sep</span>,\r
 112           <span class="summary-sig-arg">null</span>)</span></code>\r
 113 <br />\r
 114 Copy table to file.</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="../private/psycopg2._psycopg.cursor-class.html#execute" class="summary-sig-name"><code>execute</code></a>(<span class="summary-sig-arg">query</span>,\r
 117           <span class="summary-sig-arg">vars</span>,\r
 118           <span class="summary-sig-arg">async</span>)</span></code>\r
 119 <br />\r
 120 Execute query with bound vars.</td></tr>\r
 121 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 122   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#executemany" class="summary-sig-name"><code>executemany</code></a>(<span class="summary-sig-arg">query</span>,\r
 123           <span class="summary-sig-arg">vars_list</span>,\r
 124           <span class="summary-sig-arg">async</span>)</span></code>\r
 125 <br />\r
 126 Execute many queries with bound vars.</td></tr>\r
 127 <tr><td align="right" valign="top" width="15%" class="rtype">list of tuple</td>\r
 128   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#fetchall" class="summary-sig-name"><code>fetchall</code></a>()</span></code>\r
 129 <br />\r
 130 Return all the remaining rows of a query result set.</td></tr>\r
 131 <tr><td align="right" valign="top" width="15%" class="rtype">list of tuple</td>\r
 132   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany" class="summary-sig-name"><code>fetchmany</code></a>(<span class="summary-sig-arg">size</span>)</span></code>\r
 133 <br />\r
 134 Return the next <a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany" class="link"><code>size</code></a> rows of a query result set in the form of a list\r
 135 of tuples (by default) or using the sequence factory previously set in\r
 136 the <a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute.</td></tr>\r
 137 <tr><td align="right" valign="top" width="15%" class="rtype">tuple or None</td>\r
 138   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#fetchone" class="summary-sig-name"><code>fetchone</code></a>()</span></code>\r
 139 <br />\r
 140 Return the next row of a query result set in the form of a tuple (by\r
 141 default) or using the sequence factory previously set in the\r
 142 <a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute.</td></tr>\r
 143 <tr><td align="right" valign="top" width="15%" class="rtype">int</td>\r
 144   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#fileno" class="summary-sig-name"><code>fileno</code></a>()</span></code>\r
 145 <br />\r
 146 Return file descriptor associated to database connection.</td></tr>\r
 147 <tr><td align="right" valign="top" width="15%" class="rtype">bool</td>\r
 148   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#isready" class="summary-sig-name"><code>isready</code></a>()</span></code>\r
 149 <br />\r
 150 Return True if data is ready after an async query.</td></tr>\r
 151 <tr><td align="right" valign="top" width="15%" class="rtype">str</td>\r
 152   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#mogrify" class="summary-sig-name"><code>mogrify</code></a>(<span class="summary-sig-arg">query</span>,\r
 153           <span class="summary-sig-arg">vars</span>)</span></code>\r
 154 <br />\r
 155 Return query after vars binding.</td></tr>\r
 156 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 157   <td><code><a name="next"></a><span class="summary-sig"><span class="summary-sig-name">next</span>(<span class="summary-sig-arg">x</span>)</span></code>\r
 158 <br />\r
 159 Return the next value, or raise StopIteration...</td></tr>\r
 160 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 161   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#nextset" class="summary-sig-name"><code>nextset</code></a>()</span></code>\r
 162 <br />\r
 163 Skip to next set of data.</td></tr>\r
 164 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 165   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#scroll" class="summary-sig-name"><code>scroll</code></a>(<span class="summary-sig-arg">value</span>,\r
 166           <span class="summary-sig-arg">mode</span>)</span></code>\r
 167 <br />\r
 168 Scroll to new position according to mode.</td></tr>\r
 169 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 170   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#setinputsizes" class="summary-sig-name"><code>setinputsizes</code></a>(<span class="summary-sig-arg">sizes</span>)</span></code>\r
 171 <br />\r
 172 Set memory areas before execute.</td></tr>\r
 173 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 174   <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#setoutputsize" class="summary-sig-name"><code>setoutputsize</code></a>(<span class="summary-sig-arg">size</span>,\r
 175           <span class="summary-sig-arg">column</span>)</span></code>\r
 176 <br />\r
 177 Set column buffer size.</td></tr>\r
 178 <tr bgcolor="#e8f0f8" class="group">\r
 179   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>\r
 180 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 181   <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
 182 <br />\r
 183 x.__delattr__('name') &lt;==&gt; del x.name</td></tr>\r
 184 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 185   <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
 186 <br />\r
 187 x.__getattribute__('name') &lt;==&gt; x.name</td></tr>\r
 188 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 189   <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
 190 <br />\r
 191 Return hash(x)...</td></tr>\r
 192 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 193   <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
 194 <br />\r
 195 helper for pickle</td></tr>\r
 196 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 197   <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
 198 <br />\r
 199 helper for pickle</td></tr>\r
 200 <tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
 201   <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
 202 <br />\r
 203 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
 204 </table><br />\r
 205 \r
 206 \r
 207 <!-- =========== START OF PROPERTY SUMMARY =========== -->\r
 208 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 209 <tr bgcolor="#70b0f0" class="summary">\r
 210   <th colspan="2">Property Summary</th></tr>\r
 211 <tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 212   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#arraysize"><code>arraysize</code></a></strong>: Number of records <a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany" class="link"><code>fetchmany()</code></a> must fetch if not explicitely specified.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 213   <td><a name="binary_types"></a><strong><code>binary_types</code></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 214   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#connection"><code>connection</code></a></strong>: The connection where the cursor comes from.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 215   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#description"><code>description</code></a></strong>: Cursor description as defined in DBAPI-2.0.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 216   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#lastrowid"><code>lastrowid</code></a></strong>: The <tt class="docutils literal docutils literal docutils literal"><span class="pre">oid</span></tt> of the last row inserted by the cursor.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 217   <td><a name="name"></a><strong><code>name</code></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 218   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#query"><code>query</code></a></strong>: The last query text sent to the backend.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 219   <td><a name="row_factory"></a><strong><code>row_factory</code></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 220   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#rowcount"><code>rowcount</code></a></strong>: Number of rows read from the backend in the last command.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 221   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#rownumber"><code>rownumber</code></a></strong>: The current row position.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 222   <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#statusmessage"><code>statusmessage</code></a></strong>: The return message of the last command.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 223   <td><a name="string_types"></a><strong><code>string_types</code></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 224   <td><a name="typecaster"></a><strong><code>typecaster</code></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
 225   <td><a name="tzinfo_factory"></a><strong><code>tzinfo_factory</code></strong></td></tr></table><br />\r
 226 \r
 227 \r
 228 <!-- =========== START OF METHOD DETAILS =========== -->\r
 229 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 230 <tr bgcolor="#70b0f0" class="details">\r
 231   <th colspan="2">Method Details</th></tr>\r
 232 </table>\r
 233 \r
 234 <a name="__init__"></a>\r
 235 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 236   <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-vararg">...</span>)</span>\r
 237     <br /><em class="fname">(Constructor)</em>\r
 238   </h3>\r
 239 <p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p>\r
 240   <dl><dt></dt><dd>\r
 241     <dl><dt>Overrides:</dt>\r
 242       <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>\r
 243     </dl>\r
 244   </dd></dl>\r
 245 </td></tr></table>\r
 246 \r
 247 <a name="__iter__"></a>\r
 248 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 249   <h3><span class="sig"><span class="sig-name">__iter__</span>(<span class="sig-arg">x</span>)</span>\r
 250   </h3>\r
 251   <dl><dt></dt><dd>\r
 252     <dl><dt>Returns:</dt>\r
 253       <dd>\r
 254 <pre class="literalblock">\r
 255 iter(x)\r
 256 </pre>\r
 257       </dd>\r
 258     </dl>\r
 259   </dd></dl>\r
 260 </td></tr></table>\r
 261 \r
 262 <a name="__new__"></a>\r
 263 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 264   <h3><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,\r
 265           <span class="sig-arg">S</span>,\r
 266           <span class="sig-vararg">...</span>)</span>\r
 267   </h3>\r
 268   <dl><dt></dt><dd>\r
 269     <dl><dt>Returns:</dt>\r
 270       <dd>\r
 271 <pre class="literalblock">\r
 272 a new object with type S, a subtype of T\r
 273 </pre>\r
 274       </dd>\r
 275     </dl>\r
 276     <dl><dt>Overrides:</dt>\r
 277       <dd><a href="__builtin__.object-class.html#__new__"><code>__builtin__.object.__new__</code></a></dd>\r
 278     </dl>\r
 279   </dd></dl>\r
 280 </td></tr></table>\r
 281 \r
 282 <a name="__repr__"></a>\r
 283 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 284   <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>\r
 285     <br /><em class="fname">(Representation operator)</em>\r
 286   </h3>\r
 287   <dl><dt></dt><dd>\r
 288     <dl><dt>Returns:</dt>\r
 289       <dd>\r
 290 <pre class="literalblock">\r
 291 repr(x)\r
 292 </pre>\r
 293       </dd>\r
 294     </dl>\r
 295     <dl><dt>Overrides:</dt>\r
 296       <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd>\r
 297     </dl>\r
 298   </dd></dl>\r
 299 </td></tr></table>\r
 300 \r
 301 <a name="__str__"></a>\r
 302 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 303   <h3><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>\r
 304     <br /><em class="fname">(Informal representation operator)</em>\r
 305   </h3>\r
 306   <dl><dt></dt><dd>\r
 307     <dl><dt>Returns:</dt>\r
 308       <dd>\r
 309 <pre class="literalblock">\r
 310 str(x)\r
 311 </pre>\r
 312       </dd>\r
 313     </dl>\r
 314     <dl><dt>Overrides:</dt>\r
 315       <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd>\r
 316     </dl>\r
 317   </dd></dl>\r
 318 </td></tr></table>\r
 319 \r
 320 <a name="callproc"></a>\r
 321 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 322   <h3><span class="sig"><span class="sig-name">callproc</span>(<span class="sig-arg">procname</span>,\r
 323           <span class="sig-arg">parameters</span>=<span class="sig-default">None</span>,\r
 324           <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
 325   </h3>\r
 326 <p>Execute stored procedure.</p>\r
 327   <dl><dt></dt><dd>\r
 328   </dd></dl>\r
 329 </td></tr></table>\r
 330 \r
 331 <a name="close"></a>\r
 332 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 333   <h3><span class="sig"><span class="sig-name">close</span>()</span>\r
 334   </h3>\r
 335 <p>Close the cursor.</p>\r
 336   <dl><dt></dt><dd>\r
 337   </dd></dl>\r
 338 </td></tr></table>\r
 339 \r
 340 <a name="copy_from"></a>\r
 341 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 342   <h3><span class="sig"><span class="sig-name">copy_from</span>(<span class="sig-arg">file</span>,\r
 343           <span class="sig-arg">table</span>,\r
 344           <span class="sig-arg">sep</span>=<span class="sig-default">'\t'</span>,\r
 345           <span class="sig-arg">null</span>=<span class="sig-default">'\N'</span>)</span>\r
 346   </h3>\r
 347 <p>Copy table from file.</p>\r
 348   <dl><dt></dt><dd>\r
 349   </dd></dl>\r
 350 </td></tr></table>\r
 351 \r
 352 <a name="copy_to"></a>\r
 353 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 354   <h3><span class="sig"><span class="sig-name">copy_to</span>(<span class="sig-arg">file</span>,\r
 355           <span class="sig-arg">table</span>,\r
 356           <span class="sig-arg">sep</span>=<span class="sig-default">'\t'</span>,\r
 357           <span class="sig-arg">null</span>=<span class="sig-default">'\N'</span>)</span>\r
 358   </h3>\r
 359 <p>Copy table to file.</p>\r
 360   <dl><dt></dt><dd>\r
 361   </dd></dl>\r
 362 </td></tr></table>\r
 363 \r
 364 <a name="execute"></a>\r
 365 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 366   <h3><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">query</span>,\r
 367           <span class="sig-arg">vars</span>=<span class="sig-default">None</span>,\r
 368           <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
 369   </h3>\r
 370 <p>Execute query with bound vars.</p>\r
 371   <dl><dt></dt><dd>\r
 372   </dd></dl>\r
 373 </td></tr></table>\r
 374 \r
 375 <a name="executemany"></a>\r
 376 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 377   <h3><span class="sig"><span class="sig-name">executemany</span>(<span class="sig-arg">query</span>,\r
 378           <span class="sig-arg">vars_list</span>=<span class="sig-default">()</span>,\r
 379           <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
 380   </h3>\r
 381 <p>Execute many queries with bound vars.</p>\r
 382   <dl><dt></dt><dd>\r
 383   </dd></dl>\r
 384 </td></tr></table>\r
 385 \r
 386 <a name="fetchall"></a>\r
 387 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 388   <h3><span class="sig"><span class="sig-name">fetchall</span>()</span>\r
 389   </h3>\r
 390 <p>Return all the remaining rows of a query result set.</p>\r
 391 <p>Rows are returned in the form of a list of tuples (by default) or using\r
 392 the sequence factory previously set in the <a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute.\r
 393 Return <code>None</code> when no more data is available.</p>\r
 394   <dl><dt></dt><dd>\r
 395     <dl><dt>Returns:</dt>\r
 396       <dd>\r
 397 list of tuple      </dd>\r
 398     </dl>\r
 399   </dd></dl>\r
 400 </td></tr></table>\r
 401 \r
 402 <a name="fetchmany"></a>\r
 403 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 404   <h3><span class="sig"><span class="sig-name">fetchmany</span>(<span class="sig-arg">size</span>=<span class="sig-default">self.arraysize</span>)</span>\r
 405   </h3>\r
 406 <p>Return the next <a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany" class="link"><code>size</code></a> rows of a query result set in the form of a list\r
 407 of tuples (by default) or using the sequence factory previously set in\r
 408 the <a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute. Return <code>None</code> when no more data is available.</p>\r
 409   <dl><dt></dt><dd>\r
 410     <dl><dt>Returns:</dt>\r
 411       <dd>\r
 412 list of tuple      </dd>\r
 413     </dl>\r
 414   </dd></dl>\r
 415 </td></tr></table>\r
 416 \r
 417 <a name="fetchone"></a>\r
 418 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 419   <h3><span class="sig"><span class="sig-name">fetchone</span>()</span>\r
 420   </h3>\r
 421 <p>Return the next row of a query result set in the form of a tuple (by\r
 422 default) or using the sequence factory previously set in the\r
 423 <a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute. Return <code>None</code> when no more data is available.</p>\r
 424   <dl><dt></dt><dd>\r
 425     <dl><dt>Returns:</dt>\r
 426       <dd>\r
 427 tuple or None      </dd>\r
 428     </dl>\r
 429   </dd></dl>\r
 430 </td></tr></table>\r
 431 \r
 432 <a name="fileno"></a>\r
 433 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 434   <h3><span class="sig"><span class="sig-name">fileno</span>()</span>\r
 435   </h3>\r
 436 <p>Return file descriptor associated to database connection.</p>\r
 437   <dl><dt></dt><dd>\r
 438     <dl><dt>Returns:</dt>\r
 439       <dd>\r
 440 int      </dd>\r
 441     </dl>\r
 442   </dd></dl>\r
 443 </td></tr></table>\r
 444 \r
 445 <a name="isready"></a>\r
 446 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 447   <h3><span class="sig"><span class="sig-name">isready</span>()</span>\r
 448   </h3>\r
 449 <p>Return True if data is ready after an async query.</p>\r
 450   <dl><dt></dt><dd>\r
 451     <dl><dt>Returns:</dt>\r
 452       <dd>\r
 453 bool      </dd>\r
 454     </dl>\r
 455   </dd></dl>\r
 456 </td></tr></table>\r
 457 \r
 458 <a name="mogrify"></a>\r
 459 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 460   <h3><span class="sig"><span class="sig-name">mogrify</span>(<span class="sig-arg">query</span>,\r
 461           <span class="sig-arg">vars</span>=<span class="sig-default">None</span>)</span>\r
 462   </h3>\r
 463 <p>Return query after vars binding.</p>\r
 464   <dl><dt></dt><dd>\r
 465     <dl><dt>Returns:</dt>\r
 466       <dd>\r
 467 str      </dd>\r
 468     </dl>\r
 469   </dd></dl>\r
 470 </td></tr></table>\r
 471 \r
 472 <a name="next"></a>\r
 473 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 474   <h3><span class="sig"><span class="sig-name">next</span>(<span class="sig-arg">x</span>)</span>\r
 475   </h3>\r
 476   <dl><dt></dt><dd>\r
 477     <dl><dt>Returns:</dt>\r
 478       <dd>\r
 479 <pre class="literalblock">\r
 480 the next value, or raise StopIteration\r
 481 </pre>\r
 482       </dd>\r
 483     </dl>\r
 484   </dd></dl>\r
 485 </td></tr></table>\r
 486 \r
 487 <a name="nextset"></a>\r
 488 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 489   <h3><span class="sig"><span class="sig-name">nextset</span>()</span>\r
 490   </h3>\r
 491 <p>Skip to next set of data.</p>\r
 492 <p>This method is not supported (PostgreSQL does not have multiple data \r
 493 sets) and will raise a NotSupportedError exception.</p>\r
 494   <dl><dt></dt><dd>\r
 495   </dd></dl>\r
 496 </td></tr></table>\r
 497 \r
 498 <a name="scroll"></a>\r
 499 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 500   <h3><span class="sig"><span class="sig-name">scroll</span>(<span class="sig-arg">value</span>,\r
 501           <span class="sig-arg">mode</span>=<span class="sig-default">'relative'</span>)</span>\r
 502   </h3>\r
 503 <p>Scroll to new position according to mode.</p>\r
 504   <dl><dt></dt><dd>\r
 505   </dd></dl>\r
 506 </td></tr></table>\r
 507 \r
 508 <a name="setinputsizes"></a>\r
 509 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 510   <h3><span class="sig"><span class="sig-name">setinputsizes</span>(<span class="sig-arg">sizes</span>)</span>\r
 511   </h3>\r
 512 <p>Set memory areas before execute.</p>\r
 513 <p>This method currently does nothing but it is safe to call it.</p>\r
 514   <dl><dt></dt><dd>\r
 515   </dd></dl>\r
 516 </td></tr></table>\r
 517 \r
 518 <a name="setoutputsize"></a>\r
 519 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 520   <h3><span class="sig"><span class="sig-name">setoutputsize</span>(<span class="sig-arg">size</span>,\r
 521           <span class="sig-arg">column</span>=<span class="sig-default">None</span>)</span>\r
 522   </h3>\r
 523 <p>Set column buffer size.</p>\r
 524 <p>This method currently does nothing but it is safe to call it.</p>\r
 525   <dl><dt></dt><dd>\r
 526   </dd></dl>\r
 527 </td></tr></table>\r
 528 <br />\r
 529 \r
 530 \r
 531 <!-- =========== START OF PROPERTY DETAILS =========== -->\r
 532 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 533 <tr bgcolor="#70b0f0" class="details">\r
 534   <th colspan="2">Property Details</th></tr>\r
 535 </table>\r
 536 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 537 \r
 538 <a name="arraysize"></a>\r
 539 <h3>arraysize</h3>\r
 540 <p>Number of records <a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany" class="link"><code>fetchmany()</code></a> must fetch if not explicitely specified.</p>\r
 541 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 542 \r
 543 <a name="connection"></a>\r
 544 <h3>connection</h3>\r
 545 <p>The connection where the cursor comes from.</p>\r
 546 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 547 \r
 548 <a name="description"></a>\r
 549 <h3>description</h3>\r
 550 <p>Cursor description as defined in DBAPI-2.0.</p>\r
 551 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 552 \r
 553 <a name="lastrowid"></a>\r
 554 <h3>lastrowid</h3>\r
 555 <p>The <tt class="docutils literal docutils literal docutils literal docutils literal"><span class="pre">oid</span></tt> of the last row inserted by the cursor.</p>\r
 556 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 557 \r
 558 <a name="query"></a>\r
 559 <h3>query</h3>\r
 560 <p>The last query text sent to the backend.</p>\r
 561 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 562 \r
 563 <a name="rowcount"></a>\r
 564 <h3>rowcount</h3>\r
 565 <p>Number of rows read from the backend in the last command.</p>\r
 566 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 567 \r
 568 <a name="rownumber"></a>\r
 569 <h3>rownumber</h3>\r
 570 <p>The current row position.</p>\r
 571 </td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 572 \r
 573 <a name="statusmessage"></a>\r
 574 <h3>statusmessage</h3>\r
 575 <p>The return message of the last command.</p>\r
 576 </td></tr></table><br />\r
 577 \r
 578 \r
 579 <!-- =========== START OF NAVBAR =========== -->\r
 580 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 581   <tr valign="middle">\r
 582     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
 583     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 584     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 585     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 586     <th class="navbar" width="100%"></th>\r
 587   </tr>\r
 588 </table>\r
 589 \r
 590 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 591   <tr>\r
 592     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006</td>\r
 593     <td align="right" class="footer">\r
 594       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 595     </td>\r
 596   </tr>\r
 597 </table>\r
 598 </body>\r
 599 </html>\r