Merge from trunk
[plcapi.git] / trunk / psycopg2 / doc / api / private / psycopg2._psycopg.cursor-class.html
diff --git a/trunk/psycopg2/doc/api/private/psycopg2._psycopg.cursor-class.html b/trunk/psycopg2/doc/api/private/psycopg2._psycopg.cursor-class.html
new file mode 100644 (file)
index 0000000..d3947aa
--- /dev/null
@@ -0,0 +1,599 @@
+<?xml version="1.0" encoding="utf-8"?>\r
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"\r
+          "DTD/xhtml1-transitional.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
+<head>\r
+  <title>psycopg2._psycopg.cursor</title>\r
+  <link rel="stylesheet" href="epydoc.css" type="text/css" />\r
+<script type="text/javascript">\r
+<!--\r
+function setFrame(url1, url2){\r
+    parent.frames[1].location.href = url1;\r
+    parent.frames[2].location.href = url2;\r
+}\r
+-->\r
+</script>\r
+</head>\r
+<body bgcolor="white" text="black" link="blue" vlink="#204080"\r
+      alink="#204080">\r
+\r
+<!-- =========== START OF NAVBAR =========== -->\r
+<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
+  <tr valign="middle">\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar" width="100%"></th>\r
+  </tr>\r
+</table>\r
+<table width="100%" cellpadding="0" cellspacing="0">\r
+  <tr valign="top">\r
+    <td width="100%">\r
+      <span class="breadcrumbs">\r
+        <a href="psycopg2-module.html">Package&nbsp;psycopg2</a> ::\r
+        <a href="../private/psycopg2._psycopg-module.html">Module&nbsp;_psycopg</a> ::\r
+        Class&nbsp;cursor\r
+      </span><br />\r
+    </td>\r
+    <td><table cellpadding="0" cellspacing="0">\r
+      <tr><td align="right"><span class="options">[<strong>show&nbsp;private</strong>&nbsp;|&nbsp;hide&nbsp;private]</span></td></tr>\r
+      <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
+    </table></td>\r
+</tr></table>\r
+\r
+<!-- =========== START OF CLASS DESCRIPTION =========== -->\r
+<h2 class="class">Type cursor</h2>\r
+\r
+<pre class="base-tree">\r
+<a href="__builtin__.object-class.html"><code>object</code></a> --+\r
+         |\r
+        <strong class="uidshort">cursor</strong>\r
+</pre><br />\r
+\r
+<dl><dt>Known Subclasses:</dt>\r
+<dd>\r
+    <a href="psycopg2.psycopg1.cursor-class.html"><code>cursor</code></a>,\r
+    <a href="psycopg2.extras.DictCursor-class.html"><code>DictCursor</code></a></dd></dl>\r
+\r
+<hr/>\r
+\r
+<p>A database cursor.</p>\r
+<hr/>\r
+\r
+\r
+<!-- =========== START OF METHOD SUMMARY =========== -->\r
+<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
+<tr bgcolor="#70b0f0" class="summary">\r
+  <th colspan="2">Method Summary</th></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Return iter(x)...</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">S</span>,\r
+          <span class="summary-sig-vararg">...</span>)</span></code>\r
+<br />\r
+Return a new object with type S, a subtype of T...</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Return repr(x)...</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Return str(x)...</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">parameters</span>,\r
+          <span class="summary-sig-arg">async</span>)</span></code>\r
+<br />\r
+Execute stored procedure.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Close the cursor.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">table</span>,\r
+          <span class="summary-sig-arg">sep</span>,\r
+          <span class="summary-sig-arg">null</span>)</span></code>\r
+<br />\r
+Copy table from file.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">table</span>,\r
+          <span class="summary-sig-arg">sep</span>,\r
+          <span class="summary-sig-arg">null</span>)</span></code>\r
+<br />\r
+Copy table to file.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">vars</span>,\r
+          <span class="summary-sig-arg">async</span>)</span></code>\r
+<br />\r
+Execute query with bound vars.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">vars_list</span>,\r
+          <span class="summary-sig-arg">async</span>)</span></code>\r
+<br />\r
+Execute many queries with bound vars.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">list of tuple</td>\r
+  <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
+<br />\r
+Return all the remaining rows of a query result set.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">list of tuple</td>\r
+  <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
+<br />\r
+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
+of tuples (by default) or using the sequence factory previously set in\r
+the <a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">tuple or None</td>\r
+  <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
+<br />\r
+Return the next row of a query result set in the form of a tuple (by\r
+default) or using the sequence factory previously set in the\r
+<a href="../private/psycopg2._psycopg.cursor-class.html#row_factory" class="link"><code>row_factory</code></a> attribute.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">int</td>\r
+  <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
+<br />\r
+Return file descriptor associated to database connection.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">bool</td>\r
+  <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
+<br />\r
+Return True if data is ready after an async query.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">str</td>\r
+  <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
+          <span class="summary-sig-arg">vars</span>)</span></code>\r
+<br />\r
+Return query after vars binding.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Return the next value, or raise StopIteration...</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Skip to next set of data.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">mode</span>)</span></code>\r
+<br />\r
+Scroll to new position according to mode.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Set memory areas before execute.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+          <span class="summary-sig-arg">column</span>)</span></code>\r
+<br />\r
+Set column buffer size.</td></tr>\r
+<tr bgcolor="#e8f0f8" class="group">\r
+  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+x.__delattr__('name') &lt;==&gt; del x.name</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+x.__getattribute__('name') &lt;==&gt; x.name</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+Return hash(x)...</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+helper for pickle</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+helper for pickle</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>\r
+  <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
+<br />\r
+x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>\r
+</table><br />\r
+\r
+\r
+<!-- =========== START OF PROPERTY SUMMARY =========== -->\r
+<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
+<tr bgcolor="#70b0f0" class="summary">\r
+  <th colspan="2">Property Summary</th></tr>\r
+<tr><td align="right" valign="top" width="15%" class="ptype">&nbsp;</td>\r
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <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
+  <td><a name="tzinfo_factory"></a><strong><code>tzinfo_factory</code></strong></td></tr></table><br />\r
+\r
+\r
+<!-- =========== START OF METHOD DETAILS =========== -->\r
+<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
+<tr bgcolor="#70b0f0" class="details">\r
+  <th colspan="2">Method Details</th></tr>\r
+</table>\r
+\r
+<a name="__init__"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-vararg">...</span>)</span>\r
+    <br /><em class="fname">(Constructor)</em>\r
+  </h3>\r
+<p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Overrides:</dt>\r
+      <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="__iter__"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">__iter__</span>(<span class="sig-arg">x</span>)</span>\r
+  </h3>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+<pre class="literalblock">\r
+iter(x)\r
+</pre>\r
+      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="__new__"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,\r
+          <span class="sig-arg">S</span>,\r
+          <span class="sig-vararg">...</span>)</span>\r
+  </h3>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+<pre class="literalblock">\r
+a new object with type S, a subtype of T\r
+</pre>\r
+      </dd>\r
+    </dl>\r
+    <dl><dt>Overrides:</dt>\r
+      <dd><a href="__builtin__.object-class.html#__new__"><code>__builtin__.object.__new__</code></a></dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="__repr__"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>\r
+    <br /><em class="fname">(Representation operator)</em>\r
+  </h3>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+<pre class="literalblock">\r
+repr(x)\r
+</pre>\r
+      </dd>\r
+    </dl>\r
+    <dl><dt>Overrides:</dt>\r
+      <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="__str__"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>\r
+    <br /><em class="fname">(Informal representation operator)</em>\r
+  </h3>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+<pre class="literalblock">\r
+str(x)\r
+</pre>\r
+      </dd>\r
+    </dl>\r
+    <dl><dt>Overrides:</dt>\r
+      <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="callproc"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">callproc</span>(<span class="sig-arg">procname</span>,\r
+          <span class="sig-arg">parameters</span>=<span class="sig-default">None</span>,\r
+          <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
+  </h3>\r
+<p>Execute stored procedure.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="close"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">close</span>()</span>\r
+  </h3>\r
+<p>Close the cursor.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="copy_from"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">copy_from</span>(<span class="sig-arg">file</span>,\r
+          <span class="sig-arg">table</span>,\r
+          <span class="sig-arg">sep</span>=<span class="sig-default">'\t'</span>,\r
+          <span class="sig-arg">null</span>=<span class="sig-default">'\N'</span>)</span>\r
+  </h3>\r
+<p>Copy table from file.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="copy_to"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">copy_to</span>(<span class="sig-arg">file</span>,\r
+          <span class="sig-arg">table</span>,\r
+          <span class="sig-arg">sep</span>=<span class="sig-default">'\t'</span>,\r
+          <span class="sig-arg">null</span>=<span class="sig-default">'\N'</span>)</span>\r
+  </h3>\r
+<p>Copy table to file.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="execute"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">query</span>,\r
+          <span class="sig-arg">vars</span>=<span class="sig-default">None</span>,\r
+          <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
+  </h3>\r
+<p>Execute query with bound vars.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="executemany"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">executemany</span>(<span class="sig-arg">query</span>,\r
+          <span class="sig-arg">vars_list</span>=<span class="sig-default">()</span>,\r
+          <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>\r
+  </h3>\r
+<p>Execute many queries with bound vars.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="fetchall"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">fetchall</span>()</span>\r
+  </h3>\r
+<p>Return all the remaining rows of a query result set.</p>\r
+<p>Rows are returned in the form of a list of tuples (by default) or using\r
+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
+Return <code>None</code> when no more data is available.</p>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+list of tuple      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="fetchmany"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <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
+  </h3>\r
+<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
+of tuples (by default) or using the sequence factory previously set in\r
+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
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+list of tuple      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="fetchone"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">fetchone</span>()</span>\r
+  </h3>\r
+<p>Return the next row of a query result set in the form of a tuple (by\r
+default) or using the sequence factory previously set in the\r
+<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
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+tuple or None      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="fileno"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">fileno</span>()</span>\r
+  </h3>\r
+<p>Return file descriptor associated to database connection.</p>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+int      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="isready"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">isready</span>()</span>\r
+  </h3>\r
+<p>Return True if data is ready after an async query.</p>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+bool      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="mogrify"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">mogrify</span>(<span class="sig-arg">query</span>,\r
+          <span class="sig-arg">vars</span>=<span class="sig-default">None</span>)</span>\r
+  </h3>\r
+<p>Return query after vars binding.</p>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+str      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="next"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">next</span>(<span class="sig-arg">x</span>)</span>\r
+  </h3>\r
+  <dl><dt></dt><dd>\r
+    <dl><dt>Returns:</dt>\r
+      <dd>\r
+<pre class="literalblock">\r
+the next value, or raise StopIteration\r
+</pre>\r
+      </dd>\r
+    </dl>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="nextset"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">nextset</span>()</span>\r
+  </h3>\r
+<p>Skip to next set of data.</p>\r
+<p>This method is not supported (PostgreSQL does not have multiple data \r
+sets) and will raise a NotSupportedError exception.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="scroll"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">scroll</span>(<span class="sig-arg">value</span>,\r
+          <span class="sig-arg">mode</span>=<span class="sig-default">'relative'</span>)</span>\r
+  </h3>\r
+<p>Scroll to new position according to mode.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="setinputsizes"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">setinputsizes</span>(<span class="sig-arg">sizes</span>)</span>\r
+  </h3>\r
+<p>Set memory areas before execute.</p>\r
+<p>This method currently does nothing but it is safe to call it.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="setoutputsize"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+  <h3><span class="sig"><span class="sig-name">setoutputsize</span>(<span class="sig-arg">size</span>,\r
+          <span class="sig-arg">column</span>=<span class="sig-default">None</span>)</span>\r
+  </h3>\r
+<p>Set column buffer size.</p>\r
+<p>This method currently does nothing but it is safe to call it.</p>\r
+  <dl><dt></dt><dd>\r
+  </dd></dl>\r
+</td></tr></table>\r
+<br />\r
+\r
+\r
+<!-- =========== START OF PROPERTY DETAILS =========== -->\r
+<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
+<tr bgcolor="#70b0f0" class="details">\r
+  <th colspan="2">Property Details</th></tr>\r
+</table>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="arraysize"></a>\r
+<h3>arraysize</h3>\r
+<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
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="connection"></a>\r
+<h3>connection</h3>\r
+<p>The connection where the cursor comes from.</p>\r
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="description"></a>\r
+<h3>description</h3>\r
+<p>Cursor description as defined in DBAPI-2.0.</p>\r
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="lastrowid"></a>\r
+<h3>lastrowid</h3>\r
+<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
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="query"></a>\r
+<h3>query</h3>\r
+<p>The last query text sent to the backend.</p>\r
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="rowcount"></a>\r
+<h3>rowcount</h3>\r
+<p>Number of rows read from the backend in the last command.</p>\r
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="rownumber"></a>\r
+<h3>rownumber</h3>\r
+<p>The current row position.</p>\r
+</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+\r
+<a name="statusmessage"></a>\r
+<h3>statusmessage</h3>\r
+<p>The return message of the last command.</p>\r
+</td></tr></table><br />\r
+\r
+\r
+<!-- =========== START OF NAVBAR =========== -->\r
+<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
+  <tr valign="middle">\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="psycopg2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
+    <th class="navbar" width="100%"></th>\r
+  </tr>\r
+</table>\r
+\r
+<table border="0" cellpadding="0" cellspacing="0" width="100%">\r
+  <tr>\r
+    <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006</td>\r
+    <td align="right" class="footer">\r
+      <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
+    </td>\r
+  </tr>\r
+</table>\r
+</body>\r
+</html>\r