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
6 <title>psycopg2</title>
\r
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
\r
8 <script type="text/javascript">
\r
10 function setFrame(url1, url2){
\r
11 parent.frames[1].location.href = url1;
\r
12 parent.frames[2].location.href = url2;
\r
17 <body bgcolor="white" text="black" link="blue" vlink="#204080"
\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"> Home </th>
\r
24 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
25 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
26 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
\r
27 <th class="navbar" width="100%"></th>
\r
30 <table width="100%" cellpadding="0" cellspacing="0">
\r
33 <span class="breadcrumbs">
\r
34 Package psycopg2
\r
37 <td><table cellpadding="0" cellspacing="0">
\r
38 <tr><td align="right"><span class="options">[show private | <a href="../public/psycopg2-module.html">hide private</a>]</span></td></tr>
\r
39 <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
43 <!-- =========== START OF PACKAGE DESCRIPTION =========== -->
\r
44 <h2 class="package">Package psycopg2</h2>
\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
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
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 <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
70 <!-- =========== START OF EXCEPTIONS =========== -->
\r
71 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
72 <tr bgcolor="#70b0f0" class="summary">
\r
73 <th colspan="2">Exceptions</th></tr>
\r
74 <tr><td width="15%">
\r
75 <strong><a href="psycopg2.DatabaseError-class.html"><code>DatabaseError</code></a></strong></td>
\r
76 <td>Error related to the database engine.</td></tr>
\r
77 <tr><td width="15%">
\r
78 <strong><a href="psycopg2.DataError-class.html"><code>DataError</code></a></strong></td>
\r
79 <td>Error related to problems with the processed data.</td></tr>
\r
80 <tr><td width="15%">
\r
81 <strong><a href="psycopg2.Error-class.html"><code>Error</code></a></strong></td>
\r
82 <td>Base class for error exceptions.</td></tr>
\r
83 <tr><td width="15%">
\r
84 <strong><a href="psycopg2.IntegrityError-class.html"><code>IntegrityError</code></a></strong></td>
\r
85 <td>Error related to database integrity.</td></tr>
\r
86 <tr><td width="15%">
\r
87 <strong><a href="psycopg2.InterfaceError-class.html"><code>InterfaceError</code></a></strong></td>
\r
88 <td>Error related to the database interface.</td></tr>
\r
89 <tr><td width="15%">
\r
90 <strong><a href="psycopg2.InternalError-class.html"><code>InternalError</code></a></strong></td>
\r
91 <td>The database encountered an internal error.</td></tr>
\r
92 <tr><td width="15%">
\r
93 <strong><a href="psycopg2.NotSupportedError-class.html"><code>NotSupportedError</code></a></strong></td>
\r
94 <td>A not supported datbase API was called.</td></tr>
\r
95 <tr><td width="15%">
\r
96 <strong><a href="psycopg2.OperationalError-class.html"><code>OperationalError</code></a></strong></td>
\r
97 <td>Error related to database operation (disconnect, memory allocation etc).</td></tr>
\r
98 <tr><td width="15%">
\r
99 <strong><a href="psycopg2.ProgrammingError-class.html"><code>ProgrammingError</code></a></strong></td>
\r
100 <td>Error related to database programming (SQL error, table not found etc).</td></tr>
\r
101 <tr><td width="15%">
\r
102 <strong><a href="psycopg2.Warning-class.html"><code>Warning</code></a></strong></td>
\r
103 <td>A database warning.</td></tr>
\r
107 <!-- =========== START OF FUNCTION SUMMARY =========== -->
\r
108 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
109 <tr bgcolor="#70b0f0" class="summary">
\r
110 <th colspan="2">Function Summary</th></tr>
\r
111 <tr bgcolor="#e8f0f8" class="group">
\r
112 <th colspan="2"> Connections creation</th></tr>
\r
113 <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
114 <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
115 <span class="summary-sig-vararg">...</span>)</span></code>
\r
117 Create a new database connection.</td></tr>
\r
118 <tr bgcolor="#e8f0f8" class="group">
\r
119 <th colspan="2"> Value objects constructors</th></tr>
\r
120 <tr><td align="right" valign="top" width="15%" class="rtype">new binary object</td>
\r
121 <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
123 Build an object capable to hold a bynary string value.</td></tr>
\r
124 <tr><td align="right" valign="top" width="15%" class="rtype">new date</td>
\r
125 <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
126 <span class="summary-sig-arg">month</span>,
\r
127 <span class="summary-sig-arg">day</span>)</span></code>
\r
129 Build an object holding a date value.</td></tr>
\r
130 <tr><td align="right" valign="top" width="15%" class="rtype">new date</td>
\r
131 <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
133 Build an object holding a date value from the given ticks value.</td></tr>
\r
134 <tr><td align="right" valign="top" width="15%" class="rtype">new time</td>
\r
135 <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
136 <span class="summary-sig-arg">minutes</span>,
\r
137 <span class="summary-sig-arg">seconds</span>,
\r
138 <span class="summary-sig-arg">tzinfo</span>)</span></code>
\r
140 Build an object holding a time value.</td></tr>
\r
141 <tr><td align="right" valign="top" width="15%" class="rtype">new time</td>
\r
142 <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
144 Build an object holding a time value from the given ticks value.</td></tr>
\r
145 <tr><td align="right" valign="top" width="15%" class="rtype">new timestamp</td>
\r
146 <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
147 <span class="summary-sig-arg">month</span>,
\r
148 <span class="summary-sig-arg">day</span>,
\r
149 <span class="summary-sig-arg">hour</span>,
\r
150 <span class="summary-sig-arg">minutes</span>,
\r
151 <span class="summary-sig-arg">seconds</span>,
\r
152 <span class="summary-sig-arg">tzinfo</span>)</span></code>
\r
154 Build an object holding a timestamp value.</td></tr>
\r
155 <tr><td align="right" valign="top" width="15%" class="rtype">new timestamp</td>
\r
156 <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
158 Build an object holding a timestamp value from the given ticks value.</td></tr>
\r
162 <!-- =========== START OF FUNCTION DETAILS =========== -->
\r
163 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
164 <tr bgcolor="#70b0f0" class="details">
\r
165 <th colspan="2">Function Details</th></tr>
\r
168 <a name="connect"></a>
\r
169 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
170 <h3><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">dsn</span>,
\r
171 <span class="sig-vararg">...</span>)</span>
\r
173 <p>Create a new database connection.</p>
\r
174 <p>This function supports two different but equivalent sets of arguments.
\r
175 A single data source name or <tt class="docutils literal"><span class="pre">dsn</span></tt> string can be used to specify the
\r
176 connection parameters, as follows:</p>
\r
177 <pre class="literal-block">
\r
178 psycopg2.connect("dbname=xxx user=xxx ...")
\r
180 <p>If <tt class="docutils literal"><span class="pre">dsn</span></tt> is not provided it is possible to pass the parameters as
\r
181 keyword arguments; e.g.:</p>
\r
182 <pre class="literal-block">
\r
183 psycopg2.connect(database='xxx', user='xxx', ...)
\r
185 <p>The full list of available parameters is:</p>
\r
186 <ul class="rst-simple">
\r
187 <li><tt class="docutils literal"><span class="pre">dbname</span></tt> -- database name (only in 'dsn')</li>
\r
188 <li><tt class="docutils literal"><span class="pre">database</span></tt> -- database name (only as keyword argument)</li>
\r
189 <li><tt class="docutils literal"><span class="pre">host</span></tt> -- host address (defaults to UNIX socket if not provided)</li>
\r
190 <li><tt class="docutils literal"><span class="pre">port</span></tt> -- port number (defaults to 5432 if not provided)</li>
\r
191 <li><tt class="docutils literal"><span class="pre">user</span></tt> -- user name used to authenticate</li>
\r
192 <li><tt class="docutils literal"><span class="pre">password</span></tt> -- password used to authenticate</li>
\r
193 <li><tt class="docutils literal"><span class="pre">sslmode</span></tt> -- SSL mode (see PostgreSQL documentation)</li>
\r
195 <p>If the <tt class="docutils literal"><span class="pre">connection_factory</span></tt> keyword argument is not provided this
\r
196 function always return an instance of the <code>connection</code> class.
\r
197 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
198 instantiate the connection object.</p>
\r
200 <dl><dt>Returns:</dt>
\r
202 New database connection <br /><em>
\r
203 (type=<a href="../private/psycopg2._psycopg.connection-class.html" class="link"><code>extensions.connection</code></a>)</em>
\r
209 <a name="Binary"></a>
\r
210 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
211 <h3><span class="sig"><span class="sig-name">Binary</span>(<span class="sig-arg">buffer</span>)</span>
\r
213 <p>Build an object capable to hold a bynary string value.</p>
\r
215 <dl><dt>Returns:</dt>
\r
217 new binary object </dd>
\r
222 <a name="Date"></a>
\r
223 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
224 <h3><span class="sig"><span class="sig-name">Date</span>(<span class="sig-arg">year</span>,
\r
225 <span class="sig-arg">month</span>,
\r
226 <span class="sig-arg">day</span>)</span>
\r
228 <p>Build an object holding a date value.</p>
\r
230 <dl><dt>Returns:</dt>
\r
237 <a name="DateFromTicks"></a>
\r
238 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
239 <h3><span class="sig"><span class="sig-name">DateFromTicks</span>(<span class="sig-arg">ticks</span>)</span>
\r
241 <p>Build an object holding a date value from the given ticks value.</p>
\r
242 <p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>
\r
244 <dl><dt>Returns:</dt>
\r
251 <a name="Time"></a>
\r
252 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
253 <h3><span class="sig"><span class="sig-name">Time</span>(<span class="sig-arg">hour</span>,
\r
254 <span class="sig-arg">minutes</span>,
\r
255 <span class="sig-arg">seconds</span>,
\r
256 <span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>
\r
258 <p>Build an object holding a time value.</p>
\r
260 <dl><dt>Returns:</dt>
\r
267 <a name="TimeFromTicks"></a>
\r
268 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
269 <h3><span class="sig"><span class="sig-name">TimeFromTicks</span>(<span class="sig-arg">ticks</span>)</span>
\r
271 <p>Build an object holding a time value from the given ticks value.</p>
\r
272 <p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>
\r
274 <dl><dt>Returns:</dt>
\r
281 <a name="Timestamp"></a>
\r
282 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
283 <h3><span class="sig"><span class="sig-name">Timestamp</span>(<span class="sig-arg">year</span>,
\r
284 <span class="sig-arg">month</span>,
\r
285 <span class="sig-arg">day</span>,
\r
286 <span class="sig-arg">hour</span>,
\r
287 <span class="sig-arg">minutes</span>,
\r
288 <span class="sig-arg">seconds</span>,
\r
289 <span class="sig-arg">tzinfo</span>=<span class="sig-default">None</span>)</span>
\r
291 <p>Build an object holding a timestamp value.</p>
\r
293 <dl><dt>Returns:</dt>
\r
295 new timestamp </dd>
\r
300 <a name="TimestampFromTicks"></a>
\r
301 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
302 <h3><span class="sig"><span class="sig-name">TimestampFromTicks</span>(<span class="sig-arg">ticks</span>)</span>
\r
304 <p>Build an object holding a timestamp value from the given ticks value.</p>
\r
305 <p>Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).</p>
\r
307 <dl><dt>Returns:</dt>
\r
309 new timestamp </dd>
\r
316 <!-- =========== START OF NAVBAR =========== -->
\r
317 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
\r
318 <tr valign="middle">
\r
319 <th bgcolor="#70b0f0" class="navselect"> Home </th>
\r
320 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
321 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
322 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
\r
323 <th class="navbar" width="100%"></th>
\r
327 <table border="0" cellpadding="0" cellspacing="0" width="100%">
\r
329 <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:35 2006</td>
\r
330 <td align="right" class="footer">
\r
331 <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
\r