--- /dev/null
+<?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</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 bgcolor="#70b0f0" class="navselect"> Home </th>\r
+ <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>\r
+ <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>\r
+ <th class="navbar"> <a class="navbar" href="help.html">Help</a> </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
+ Package psycopg2\r
+ </span><br />\r
+ </td>\r
+ <td><table cellpadding="0" cellspacing="0">\r
+ <tr><td align="right"><span class="options">[show private | <a href="../public/psycopg2-module.html">hide private</a>]</span></td></tr>\r
+ <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="psycopg2-module.html" target="_top">no frames</a>]</span></td></tr>\r
+ </table></td>\r
+</tr></table>\r
+\r
+<!-- =========== START OF PACKAGE DESCRIPTION =========== -->\r
+<h2 class="package">Package psycopg2</h2>\r
+\r
+<p>A Python driver for PostgreSQL</p>\r
+<p>psycopg is a <a class="reference" href="http://www.postgresql.org/">PostgreSQL</a> database adapter for the <a class="reference" href="http://www.python.org/">Python</a> programming\r
+language. This is version 2, a complete rewrite of the original code to\r
+provide new-style classes for connection and cursor objects and other sweet\r
+candies. Like the original, psycopg 2 was written with the aim of being very\r
+small and fast, and stable as a rock.</p>\r
+<p>Homepage: <a class="reference" href="http://initd.org/projects/psycopg2">http://initd.org/projects/psycopg2</a></p>\r
+<hr/>\r
+\r
+<!-- =========== START OF SUBMODULES =========== -->\r
+<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
+<tr bgcolor="#70b0f0" class="details">\r
+ <th colspan="2">Submodules</th></tr>\r
+ <tr><td><ul>\r
+<li> <strong class="uidlink"><a href="psycopg2.extensions-module.html"><code>extensions</code></a></strong>: <em class="summary">psycopg extensions to the DBAPI-2.0</em></li>\r
+<li> <strong class="uidlink"><a href="psycopg2.extras-module.html"><code>extras</code></a></strong>: <em class="summary">Miscellaneous goodies for psycopg2</em></li>\r
+<li> <strong class="uidlink"><a href="psycopg2.pool-module.html"><code>pool</code></a></strong>: <em class="summary">Connection pooling for psycopg2</em></li>\r
+<li> <strong class="uidlink"><a href="psycopg2.psycopg1-module.html"><code>psycopg1</code></a></strong>: <em class="summary">psycopg 1.1.x compatibility module</em></li>\r
+<li> <strong class="uidlink"><a href="psycopg2.tz-module.html"><code>tz</code></a></strong>: <em class="summary">tzinfo implementations for psycopg2</em></li>\r
+<li> <strong class="uidlink"><a href="../private/psycopg2._psycopg-module.html"><code>_psycopg</code></a></strong>: <em class="summary">psycopg PostgreSQL driver</em></li>\r
+ </ul></td></tr>\r
+</table><br />\r
+\r
+\r
+<!-- =========== START OF EXCEPTIONS =========== -->\r
+<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
+<tr bgcolor="#70b0f0" class="summary">\r
+ <th colspan="2">Exceptions</th></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.DatabaseError-class.html"><code>DatabaseError</code></a></strong></td>\r
+ <td>Error related to the database engine.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.DataError-class.html"><code>DataError</code></a></strong></td>\r
+ <td>Error related to problems with the processed data.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.Error-class.html"><code>Error</code></a></strong></td>\r
+ <td>Base class for error exceptions.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.IntegrityError-class.html"><code>IntegrityError</code></a></strong></td>\r
+ <td>Error related to database integrity.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.InterfaceError-class.html"><code>InterfaceError</code></a></strong></td>\r
+ <td>Error related to the database interface.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.InternalError-class.html"><code>InternalError</code></a></strong></td>\r
+ <td>The database encountered an internal error.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.NotSupportedError-class.html"><code>NotSupportedError</code></a></strong></td>\r
+ <td>A not supported datbase API was called.</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.OperationalError-class.html"><code>OperationalError</code></a></strong></td>\r
+ <td>Error related to database operation (disconnect, memory allocation etc).</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.ProgrammingError-class.html"><code>ProgrammingError</code></a></strong></td>\r
+ <td>Error related to database programming (SQL error, table not found etc).</td></tr>\r
+<tr><td width="15%">\r
+ <strong><a href="psycopg2.Warning-class.html"><code>Warning</code></a></strong></td>\r
+ <td>A database warning.</td></tr>\r
+</table><br />\r
+\r
+\r
+<!-- =========== START OF FUNCTION 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">Function Summary</th></tr>\r
+<tr bgcolor="#e8f0f8" class="group">\r
+ <th colspan="2"> Connections creation</th></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype"><a href="../private/psycopg2._psycopg.connection-class.html" class="link"><code>extensions.connection</code></a></td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class="summary-sig-arg">dsn</span>,\r
+ <span class="summary-sig-vararg">...</span>)</span></code>\r
+<br />\r
+Create a new database connection.</td></tr>\r
+<tr bgcolor="#e8f0f8" class="group">\r
+ <th colspan="2"> Value objects constructors</th></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new binary object</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#Binary" class="summary-sig-name"><code>Binary</code></a>(<span class="summary-sig-arg">buffer</span>)</span></code>\r
+<br />\r
+Build an object capable to hold a bynary string value.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new date</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#Date" class="summary-sig-name"><code>Date</code></a>(<span class="summary-sig-arg">year</span>,\r
+ <span class="summary-sig-arg">month</span>,\r
+ <span class="summary-sig-arg">day</span>)</span></code>\r
+<br />\r
+Build an object holding a date value.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new date</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#DateFromTicks" class="summary-sig-name"><code>DateFromTicks</code></a>(<span class="summary-sig-arg">ticks</span>)</span></code>\r
+<br />\r
+Build an object holding a date value from the given ticks value.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new time</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#Time" class="summary-sig-name"><code>Time</code></a>(<span class="summary-sig-arg">hour</span>,\r
+ <span class="summary-sig-arg">minutes</span>,\r
+ <span class="summary-sig-arg">seconds</span>,\r
+ <span class="summary-sig-arg">tzinfo</span>)</span></code>\r
+<br />\r
+Build an object holding a time value.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new time</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#TimeFromTicks" class="summary-sig-name"><code>TimeFromTicks</code></a>(<span class="summary-sig-arg">ticks</span>)</span></code>\r
+<br />\r
+Build an object holding a time value from the given ticks value.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new timestamp</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#Timestamp" class="summary-sig-name"><code>Timestamp</code></a>(<span class="summary-sig-arg">year</span>,\r
+ <span class="summary-sig-arg">month</span>,\r
+ <span class="summary-sig-arg">day</span>,\r
+ <span class="summary-sig-arg">hour</span>,\r
+ <span class="summary-sig-arg">minutes</span>,\r
+ <span class="summary-sig-arg">seconds</span>,\r
+ <span class="summary-sig-arg">tzinfo</span>)</span></code>\r
+<br />\r
+Build an object holding a timestamp value.</td></tr>\r
+<tr><td align="right" valign="top" width="15%" class="rtype">new timestamp</td>\r
+ <td><code><span class="summary-sig"><a href="psycopg2-module.html#TimestampFromTicks" class="summary-sig-name"><code>TimestampFromTicks</code></a>(<span class="summary-sig-arg">ticks</span>)</span></code>\r
+<br />\r
+Build an object holding a timestamp value from the given ticks value.</td></tr>\r
+</table><br />\r
+\r
+\r
+<!-- =========== START OF FUNCTION 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">Function Details</th></tr>\r
+</table>\r
+\r
+<a name="connect"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">dsn</span>,\r
+ <span class="sig-vararg">...</span>)</span>\r
+ </h3>\r
+<p>Create a new database connection.</p>\r
+<p>This function supports two different but equivalent sets of arguments.\r
+A single data source name or <tt class="docutils literal"><span class="pre">dsn</span></tt> string can be used to specify the\r
+connection parameters, as follows:</p>\r
+<pre class="literal-block">\r
+psycopg2.connect("dbname=xxx user=xxx ...")\r
+</pre>\r
+<p>If <tt class="docutils literal"><span class="pre">dsn</span></tt> is not provided it is possible to pass the parameters as\r
+keyword arguments; e.g.:</p>\r
+<pre class="literal-block">\r
+psycopg2.connect(database='xxx', user='xxx', ...)\r
+</pre>\r
+<p>The full list of available parameters is:</p>\r
+<ul class="rst-simple">\r
+<li><tt class="docutils literal"><span class="pre">dbname</span></tt> -- database name (only in 'dsn')</li>\r
+<li><tt class="docutils literal"><span class="pre">database</span></tt> -- database name (only as keyword argument)</li>\r
+<li><tt class="docutils literal"><span class="pre">host</span></tt> -- host address (defaults to UNIX socket if not provided)</li>\r
+<li><tt class="docutils literal"><span class="pre">port</span></tt> -- port number (defaults to 5432 if not provided)</li>\r
+<li><tt class="docutils literal"><span class="pre">user</span></tt> -- user name used to authenticate</li>\r
+<li><tt class="docutils literal"><span class="pre">password</span></tt> -- password used to authenticate</li>\r
+<li><tt class="docutils literal"><span class="pre">sslmode</span></tt> -- SSL mode (see PostgreSQL documentation)</li>\r
+</ul>\r
+<p>If the <tt class="docutils literal"><span class="pre">connection_factory</span></tt> keyword argument is not provided this\r
+function always return an instance of the <code>connection</code> class.\r
+Else the given sub-class of <a href="../private/psycopg2._psycopg.connection-class.html" class="link"><code>extensions.connection</code></a> will be used to\r
+instantiate the connection object.</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+New database connection <br /><em> \r
+ (type=<a href="../private/psycopg2._psycopg.connection-class.html" class="link"><code>extensions.connection</code></a>)</em>\r
+ </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="Binary"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">Binary</span>(<span class="sig-arg">buffer</span>)</span>\r
+ </h3>\r
+<p>Build an object capable to hold a bynary string value.</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new binary object </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="Date"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">Date</span>(<span class="sig-arg">year</span>,\r
+ <span class="sig-arg">month</span>,\r
+ <span class="sig-arg">day</span>)</span>\r
+ </h3>\r
+<p>Build an object holding a date value.</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new date </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="DateFromTicks"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">DateFromTicks</span>(<span class="sig-arg">ticks</span>)</span>\r
+ </h3>\r
+<p>Build an object holding a date value from the given ticks value.</p>\r
+<p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new date </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="Time"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">Time</span>(<span class="sig-arg">hour</span>,\r
+ <span class="sig-arg">minutes</span>,\r
+ <span class="sig-arg">seconds</span>,\r
+ <span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>\r
+ </h3>\r
+<p>Build an object holding a time value.</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new time </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="TimeFromTicks"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">TimeFromTicks</span>(<span class="sig-arg">ticks</span>)</span>\r
+ </h3>\r
+<p>Build an object holding a time value from the given ticks value.</p>\r
+<p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new time </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="Timestamp"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">Timestamp</span>(<span class="sig-arg">year</span>,\r
+ <span class="sig-arg">month</span>,\r
+ <span class="sig-arg">day</span>,\r
+ <span class="sig-arg">hour</span>,\r
+ <span class="sig-arg">minutes</span>,\r
+ <span class="sig-arg">seconds</span>,\r
+ <span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>\r
+ </h3>\r
+<p>Build an object holding a timestamp value.</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new timestamp </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+\r
+<a name="TimestampFromTicks"></a>\r
+<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
+ <h3><span class="sig"><span class="sig-name">TimestampFromTicks</span>(<span class="sig-arg">ticks</span>)</span>\r
+ </h3>\r
+<p>Build an object holding a timestamp value from the given ticks value.</p>\r
+<p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>\r
+ <dl><dt></dt><dd>\r
+ <dl><dt>Returns:</dt>\r
+ <dd>\r
+new timestamp </dd>\r
+ </dl>\r
+ </dd></dl>\r
+</td></tr></table>\r
+<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 bgcolor="#70b0f0" class="navselect"> Home </th>\r
+ <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>\r
+ <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>\r
+ <th class="navbar"> <a class="navbar" href="help.html">Help</a> </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:35 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