psycopg2/doc/api/public/psycopg2-module.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</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 bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Home&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         Package&nbsp;psycopg2\r
  35       </span><br />\r
  36     </td>\r
  37     <td><table cellpadding="0" cellspacing="0">\r
  38       <tr><td align="right"><span class="options">[<a href="../private/psycopg2-module.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</span></td></tr>\r
  39       <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a>&nbsp;|&nbsp;<a href="psycopg2-module.html" target="_top">no&nbsp;frames</a>]</span></td></tr>\r
  40     </table></td>\r
  41 </tr></table>\r
  42 \r
  43 <!-- =========== START OF PACKAGE DESCRIPTION =========== -->\r
  44 <h2 class="package">Package psycopg2</h2>\r
  45 \r
  46 <p>A Python driver for PostgreSQL</p>\r
  47 <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
  48 language. This is version 2, a complete rewrite of the original code to\r
  49 provide new-style classes for connection and cursor objects and other sweet\r
  50 candies. Like the original, psycopg 2 was written with the aim of being very\r
  51 small and fast, and stable as a rock.</p>\r
  52 <p>Homepage: <a class="reference" href="http://initd.org/projects/psycopg2">http://initd.org/projects/psycopg2</a></p>\r
  53 <hr/>\r
  54 \r
  55 <!-- =========== START OF SUBMODULES =========== -->\r
  56 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
  57 <tr bgcolor="#70b0f0" class="details">\r
  58   <th colspan="2">Submodules</th></tr>\r
  59   <tr><td><ul>\r
  60 <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
  61 <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
  62 <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
  63 <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
  64 <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
  65   </ul></td></tr>\r
  66 </table><br />\r
  67 \r
  68 \r
  69 <!-- =========== START OF EXCEPTIONS =========== -->\r
  70 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
  71 <tr bgcolor="#70b0f0" class="summary">\r
  72   <th colspan="2">Exceptions</th></tr>\r
  73 <tr><td width="15%">\r
  74   <strong><a href="psycopg2.DatabaseError-class.html"><code>DatabaseError</code></a></strong></td>\r
  75   <td>Error related to the database engine.</td></tr>\r
  76 <tr><td width="15%">\r
  77   <strong><a href="psycopg2.DataError-class.html"><code>DataError</code></a></strong></td>\r
  78   <td>Error related to problems with the processed data.</td></tr>\r
  79 <tr><td width="15%">\r
  80   <strong><a href="psycopg2.Error-class.html"><code>Error</code></a></strong></td>\r
  81   <td>Base class for error exceptions.</td></tr>\r
  82 <tr><td width="15%">\r
  83   <strong><a href="psycopg2.IntegrityError-class.html"><code>IntegrityError</code></a></strong></td>\r
  84   <td>Error related to database integrity.</td></tr>\r
  85 <tr><td width="15%">\r
  86   <strong><a href="psycopg2.InterfaceError-class.html"><code>InterfaceError</code></a></strong></td>\r
  87   <td>Error related to the database interface.</td></tr>\r
  88 <tr><td width="15%">\r
  89   <strong><a href="psycopg2.InternalError-class.html"><code>InternalError</code></a></strong></td>\r
  90   <td>The database encountered an internal error.</td></tr>\r
  91 <tr><td width="15%">\r
  92   <strong><a href="psycopg2.NotSupportedError-class.html"><code>NotSupportedError</code></a></strong></td>\r
  93   <td>A not supported datbase API was called.</td></tr>\r
  94 <tr><td width="15%">\r
  95   <strong><a href="psycopg2.OperationalError-class.html"><code>OperationalError</code></a></strong></td>\r
  96   <td>Error related to database operation (disconnect, memory allocation etc).</td></tr>\r
  97 <tr><td width="15%">\r
  98   <strong><a href="psycopg2.ProgrammingError-class.html"><code>ProgrammingError</code></a></strong></td>\r
  99   <td>Error related to database programming (SQL error, table not found etc).</td></tr>\r
 100 <tr><td width="15%">\r
 101   <strong><a href="psycopg2.Warning-class.html"><code>Warning</code></a></strong></td>\r
 102   <td>A database warning.</td></tr>\r
 103 </table><br />\r
 104 \r
 105 \r
 106 <!-- =========== START OF FUNCTION SUMMARY =========== -->\r
 107 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 108 <tr bgcolor="#70b0f0" class="summary">\r
 109   <th colspan="2">Function Summary</th></tr>\r
 110 <tr bgcolor="#e8f0f8" class="group">\r
 111   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Connections creation</th></tr>\r
 112 <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
 113   <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
 114           <span class="summary-sig-vararg">...</span>)</span></code>\r
 115 <br />\r
 116 Create a new database connection.</td></tr>\r
 117 <tr bgcolor="#e8f0f8" class="group">\r
 118   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Value objects constructors</th></tr>\r
 119 <tr><td align="right" valign="top" width="15%" class="rtype">new binary object</td>\r
 120   <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
 121 <br />\r
 122 Build an object capable to hold a bynary string value.</td></tr>\r
 123 <tr><td align="right" valign="top" width="15%" class="rtype">new date</td>\r
 124   <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
 125           <span class="summary-sig-arg">month</span>,\r
 126           <span class="summary-sig-arg">day</span>)</span></code>\r
 127 <br />\r
 128 Build an object holding a date value.</td></tr>\r
 129 <tr><td align="right" valign="top" width="15%" class="rtype">new date</td>\r
 130   <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
 131 <br />\r
 132 Build an object holding a date value from the given ticks value.</td></tr>\r
 133 <tr><td align="right" valign="top" width="15%" class="rtype">new time</td>\r
 134   <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
 135           <span class="summary-sig-arg">minutes</span>,\r
 136           <span class="summary-sig-arg">seconds</span>,\r
 137           <span class="summary-sig-arg">tzinfo</span>)</span></code>\r
 138 <br />\r
 139 Build an object holding a time value.</td></tr>\r
 140 <tr><td align="right" valign="top" width="15%" class="rtype">new time</td>\r
 141   <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
 142 <br />\r
 143 Build an object holding a time value from the given ticks value.</td></tr>\r
 144 <tr><td align="right" valign="top" width="15%" class="rtype">new timestamp</td>\r
 145   <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
 146           <span class="summary-sig-arg">month</span>,\r
 147           <span class="summary-sig-arg">day</span>,\r
 148           <span class="summary-sig-arg">hour</span>,\r
 149           <span class="summary-sig-arg">minutes</span>,\r
 150           <span class="summary-sig-arg">seconds</span>,\r
 151           <span class="summary-sig-arg">tzinfo</span>)</span></code>\r
 152 <br />\r
 153 Build an object holding a timestamp value.</td></tr>\r
 154 <tr><td align="right" valign="top" width="15%" class="rtype">new timestamp</td>\r
 155   <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
 156 <br />\r
 157 Build an object holding a timestamp value from the given ticks value.</td></tr>\r
 158 </table><br />\r
 159 \r
 160 \r
 161 <!-- =========== START OF FUNCTION DETAILS =========== -->\r
 162 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">\r
 163 <tr bgcolor="#70b0f0" class="details">\r
 164   <th colspan="2">Function Details</th></tr>\r
 165 </table>\r
 166 \r
 167 <a name="connect"></a>\r
 168 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 169   <h3><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">dsn</span>,\r
 170           <span class="sig-vararg">...</span>)</span>\r
 171   </h3>\r
 172 <p>Create a new database connection.</p>\r
 173 <p>This function supports two different but equivalent sets of arguments.\r
 174 A single data source name or <tt class="docutils literal"><span class="pre">dsn</span></tt> string can be used to specify the\r
 175 connection parameters, as follows:</p>\r
 176 <pre class="literal-block">\r
 177 psycopg2.connect(&quot;dbname=xxx user=xxx ...&quot;)\r
 178 </pre>\r
 179 <p>If <tt class="docutils literal"><span class="pre">dsn</span></tt> is not provided it is possible to pass the parameters as\r
 180 keyword arguments; e.g.:</p>\r
 181 <pre class="literal-block">\r
 182 psycopg2.connect(database='xxx', user='xxx', ...)\r
 183 </pre>\r
 184 <p>The full list of available parameters is:</p>\r
 185 <ul class="rst-simple">\r
 186 <li><tt class="docutils literal"><span class="pre">dbname</span></tt> -- database name (only in 'dsn')</li>\r
 187 <li><tt class="docutils literal"><span class="pre">database</span></tt> -- database name (only as keyword argument)</li>\r
 188 <li><tt class="docutils literal"><span class="pre">host</span></tt> -- host address (defaults to UNIX socket if not provided)</li>\r
 189 <li><tt class="docutils literal"><span class="pre">port</span></tt> -- port number (defaults to 5432 if not provided)</li>\r
 190 <li><tt class="docutils literal"><span class="pre">user</span></tt> -- user name used to authenticate</li>\r
 191 <li><tt class="docutils literal"><span class="pre">password</span></tt> -- password used to authenticate</li>\r
 192 <li><tt class="docutils literal"><span class="pre">sslmode</span></tt> -- SSL mode (see PostgreSQL documentation)</li>\r
 193 </ul>\r
 194 <p>If the <tt class="docutils literal"><span class="pre">connection_factory</span></tt> keyword argument is not provided this\r
 195 function always return an instance of the <code>connection</code> class.\r
 196 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
 197 instantiate the connection object.</p>\r
 198   <dl><dt></dt><dd>\r
 199     <dl><dt>Returns:</dt>\r
 200       <dd>\r
 201 New database connection        <br /><em>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
 202         (type=<a href="../private/psycopg2._psycopg.connection-class.html" class="link"><code>extensions.connection</code></a>)</em>\r
 203       </dd>\r
 204     </dl>\r
 205   </dd></dl>\r
 206 </td></tr></table>\r
 207 \r
 208 <a name="Binary"></a>\r
 209 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 210   <h3><span class="sig"><span class="sig-name">Binary</span>(<span class="sig-arg">buffer</span>)</span>\r
 211   </h3>\r
 212 <p>Build an object capable to hold a bynary string value.</p>\r
 213   <dl><dt></dt><dd>\r
 214     <dl><dt>Returns:</dt>\r
 215       <dd>\r
 216 new binary object      </dd>\r
 217     </dl>\r
 218   </dd></dl>\r
 219 </td></tr></table>\r
 220 \r
 221 <a name="Date"></a>\r
 222 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 223   <h3><span class="sig"><span class="sig-name">Date</span>(<span class="sig-arg">year</span>,\r
 224           <span class="sig-arg">month</span>,\r
 225           <span class="sig-arg">day</span>)</span>\r
 226   </h3>\r
 227 <p>Build an object holding a date value.</p>\r
 228   <dl><dt></dt><dd>\r
 229     <dl><dt>Returns:</dt>\r
 230       <dd>\r
 231 new date      </dd>\r
 232     </dl>\r
 233   </dd></dl>\r
 234 </td></tr></table>\r
 235 \r
 236 <a name="DateFromTicks"></a>\r
 237 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 238   <h3><span class="sig"><span class="sig-name">DateFromTicks</span>(<span class="sig-arg">ticks</span>)</span>\r
 239   </h3>\r
 240 <p>Build an object holding a date value from the given ticks value.</p>\r
 241 <p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>\r
 242   <dl><dt></dt><dd>\r
 243     <dl><dt>Returns:</dt>\r
 244       <dd>\r
 245 new date      </dd>\r
 246     </dl>\r
 247   </dd></dl>\r
 248 </td></tr></table>\r
 249 \r
 250 <a name="Time"></a>\r
 251 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 252   <h3><span class="sig"><span class="sig-name">Time</span>(<span class="sig-arg">hour</span>,\r
 253           <span class="sig-arg">minutes</span>,\r
 254           <span class="sig-arg">seconds</span>,\r
 255           <span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>\r
 256   </h3>\r
 257 <p>Build an object holding a time value.</p>\r
 258   <dl><dt></dt><dd>\r
 259     <dl><dt>Returns:</dt>\r
 260       <dd>\r
 261 new time      </dd>\r
 262     </dl>\r
 263   </dd></dl>\r
 264 </td></tr></table>\r
 265 \r
 266 <a name="TimeFromTicks"></a>\r
 267 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 268   <h3><span class="sig"><span class="sig-name">TimeFromTicks</span>(<span class="sig-arg">ticks</span>)</span>\r
 269   </h3>\r
 270 <p>Build an object holding a time value from the given ticks value.</p>\r
 271 <p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>\r
 272   <dl><dt></dt><dd>\r
 273     <dl><dt>Returns:</dt>\r
 274       <dd>\r
 275 new time      </dd>\r
 276     </dl>\r
 277   </dd></dl>\r
 278 </td></tr></table>\r
 279 \r
 280 <a name="Timestamp"></a>\r
 281 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 282   <h3><span class="sig"><span class="sig-name">Timestamp</span>(<span class="sig-arg">year</span>,\r
 283           <span class="sig-arg">month</span>,\r
 284           <span class="sig-arg">day</span>,\r
 285           <span class="sig-arg">hour</span>,\r
 286           <span class="sig-arg">minutes</span>,\r
 287           <span class="sig-arg">seconds</span>,\r
 288           <span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>\r
 289   </h3>\r
 290 <p>Build an object holding a timestamp value.</p>\r
 291   <dl><dt></dt><dd>\r
 292     <dl><dt>Returns:</dt>\r
 293       <dd>\r
 294 new timestamp      </dd>\r
 295     </dl>\r
 296   </dd></dl>\r
 297 </td></tr></table>\r
 298 \r
 299 <a name="TimestampFromTicks"></a>\r
 300 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>\r
 301   <h3><span class="sig"><span class="sig-name">TimestampFromTicks</span>(<span class="sig-arg">ticks</span>)</span>\r
 302   </h3>\r
 303 <p>Build an object holding a timestamp value from the given ticks value.</p>\r
 304 <p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>\r
 305   <dl><dt></dt><dd>\r
 306     <dl><dt>Returns:</dt>\r
 307       <dd>\r
 308 new timestamp      </dd>\r
 309     </dl>\r
 310   </dd></dl>\r
 311 </td></tr></table>\r
 312 <br />\r
 313 \r
 314 \r
 315 <!-- =========== START OF NAVBAR =========== -->\r
 316 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
 317   <tr valign="middle">\r
 318     <th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>\r
 319     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>\r
 320     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>\r
 321     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>\r
 322     <th class="navbar" width="100%"></th>\r
 323   </tr>\r
 324 </table>\r
 325 \r
 326 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
 327   <tr>\r
 328     <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:35 2006</td>\r
 329     <td align="right" class="footer">\r
 330       <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
 331     </td>\r
 332   </tr>\r
 333 </table>\r
 334 </body>\r
 335 </html>\r