File: adodb-py-docs.htm

package info (click to toggle)
python-adodb 2.02b-1
links: PTS
area: main
in suites: lenny
size: 172 kB
ctags: 290
sloc: python: 1,143; makefile: 47
file content (1238 lines) | stat: -rw-r--r-- 49,616 bytes
<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns:st1="urn:schemas-microsoft-com:office:smarttags"
xmlns="http://www.w3.org/TR/REC-html40">

<head>
<meta http-equiv=Content-Type content="text/html; charset=iso-8859-1">
<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 11">
<meta name=Originator content="Microsoft Word 11">
<link rel=File-List href="adodb-py-docs_files/filelist.xml">
<title>ADOdb for Python</title>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
 name="State"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
 name="place"/>
<!--[if gte mso 9]><xml>
 <o:DocumentProperties>
  <o:Author>John Lim</o:Author>
  <o:LastAuthor>John Lim</o:LastAuthor>
  <o:Revision>3</o:Revision>
  <o:TotalTime>1</o:TotalTime>
  <o:Created>2007-05-21T09:51:00Z</o:Created>
  <o:LastSaved>2007-05-21T09:52:00Z</o:LastSaved>
  <o:Pages>1</o:Pages>
  <o:Words>2733</o:Words>
  <o:Characters>15580</o:Characters>
  <o:Company>Juris Technologies</o:Company>
  <o:Lines>129</o:Lines>
  <o:Paragraphs>36</o:Paragraphs>
  <o:CharactersWithSpaces>18277</o:CharactersWithSpaces>
  <o:Version>11.8132</o:Version>
 </o:DocumentProperties>
</xml><![endif]--><!--[if gte mso 9]><xml>
 <w:WordDocument>
  <w:GrammarState>Clean</w:GrammarState>
  <w:ValidateAgainstSchemas/>
  <w:SaveIfXMLInvalid>false</w:SaveIfXMLInvalid>
  <w:IgnoreMixedContent>false</w:IgnoreMixedContent>
  <w:AlwaysShowPlaceholderText>false</w:AlwaysShowPlaceholderText>
  <w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>
 </w:WordDocument>
</xml><![endif]--><!--[if gte mso 9]><xml>
 <w:LatentStyles DefLockedState="false" LatentStyleCount="156">
 </w:LatentStyles>
</xml><![endif]--><!--[if !mso]><object
 classid="clsid:38481807-CA0E-42D2-BF39-B33AF135CC4D" id=ieooui></object>
<style>
st1\:*{behavior:url(#ieooui) }
</style>
<![endif]-->
<style>
<!--
 /* Font Definitions */
 @font-face
	{font-family:Wingdings;
	panose-1:5 0 0 0 0 0 0 0 0 0;
	mso-font-charset:2;
	mso-generic-font-family:auto;
	mso-font-pitch:variable;
	mso-font-signature:0 268435456 0 0 -2147483648 0;}
 /* Style Definitions */
 p.MsoNormal, li.MsoNormal, div.MsoNormal
	{mso-style-parent:"";
	margin:0in;
	margin-bottom:.0001pt;
	mso-pagination:widow-orphan;
	font-size:12.0pt;
	font-family:"Times New Roman";
	mso-fareast-font-family:"Times New Roman";}
h1
	{mso-margin-top-alt:auto;
	margin-right:0in;
	mso-margin-bottom-alt:auto;
	margin-left:0in;
	mso-pagination:widow-orphan;
	mso-outline-level:1;
	font-size:24.0pt;
	font-family:"Times New Roman";
	font-weight:bold;}
p
	{font-size:12.0pt;
	font-family:"Times New Roman";
	mso-fareast-font-family:"Times New Roman";}
pre
	{margin-top:0in;
	margin-bottom:0in;
	margin-bottom:.0001pt;
	font-size:10.0pt;
	font-family:"Courier New";
	mso-fareast-font-family:"Times New Roman";}
span.GramE
	{mso-style-name:"";
	mso-gram-e:yes;}
@page Section1
	{size:8.5in 11.0in;
	margin:1.0in 1.25in 1.0in 1.25in;
	mso-header-margin:35.4pt;
	mso-footer-margin:35.4pt;
	mso-paper-source:0;}
div.Section1
	{page:Section1;}
 /* List Definitions */
 @list l0
	{mso-list-id:205025772;
	mso-list-template-ids:1898709602;}
@list l0:level1
	{mso-level-number-format:bullet;
	mso-level-text:\F0B7;
	mso-level-tab-stop:.5in;
	mso-level-number-position:left;
	text-indent:-.25in;
	mso-ansi-font-size:10.0pt;
	font-family:Symbol;}
ol
	{margin-bottom:0in;}
ul
	{margin-bottom:0in;}
-->
</style>
<!--[if gte mso 10]>
<style>
 /* Style Definitions */
 table.MsoNormalTable
	{mso-style-name:"Table Normal";
	mso-tstyle-rowband-size:0;
	mso-tstyle-colband-size:0;
	mso-style-noshow:yes;
	mso-style-parent:"";
	mso-padding-alt:0in 5.4pt 0in 5.4pt;
	mso-para-margin:0in;
	mso-para-margin-bottom:.0001pt;
	mso-pagination:widow-orphan;
	font-size:10.0pt;
	font-family:"Times New Roman";
	mso-ansi-language:#0400;
	mso-fareast-language:#0400;
	mso-bidi-language:#0400;}
</style>
<![endif]--><!--[if gte mso 9]><xml>
 <o:shapedefaults v:ext="edit" spidmax="2050"/>
</xml><![endif]--><!--[if gte mso 9]><xml>
 <o:shapelayout v:ext="edit">
  <o:idmap v:ext="edit" data="1"/>
 </o:shapelayout></xml><![endif]-->
</head>

<body lang=EN-US link=blue vlink=blue style='tab-interval:.5in'>

<div class=Section1>

<h1>ADOdb for Python</h1>

<p><span style='font-size:10.0pt'>(c) 2004-2007 John Lim (jlim#natsoft.com.my) <span
class=GramE>This</span> software is licensed under a BSD-style license. See
LICENSE.txt.</span></p>

<p><a href="#introduction">Introduction</a><br>
<a href="#databases">Databases Supported</a><br>
<a href="#help">Bug Reports and Help</a><br>
<a href="#install">Installation</a><br>
<a href="#tutorial">Tutorial</a><br>
<a href="#conn">Connection Examples</a><br>
<a href="#fn">Function Reference</a><br>
<a href="#err">Error Handling</a><br>
<a href="#bind">Bind Parameters</a><br>
<a href="#changelog">Changelog</a></p>

<h3><a name=introduction></a>Introduction</h3>

<p>ADOdb is a database abstraction library (modelled on Microsoft's database
API's). ADOdb was originally developed for PHP, and ported to Python. The
Python version implements a subset of the PHP version. ADOdb is licensed using
a BSD-style license. </p>

<p>Download: &nbsp;<a href="http://adodb.sourceforge.net/#pydownload">Python
version</a>&nbsp;&nbsp;<a href="http://adodb.sourceforge.net/#download">PHP
version</a></p>

<p>You might ask why Python needs a database abstraction library when Python
provides the official DB API. Unfortunately the DB API does not encapsulate
differences in the database implementations. For example, to select a limited
number of rows, say 10 rows, you would have to use very different SQL for
different databases:</p>

<table class=MsoNormalTable border=1 cellpadding=0 width="80%"
 style='width:80.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>MS SQL</p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>select top 10 from table</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>MySQL and PostgreSQL</p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>select * from table limit 10</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:2;mso-yfti-lastrow:yes'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Oracle</p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>select * from (select * from table) where rownum &lt;= 10</p>
  </td>
 </tr>
</table>

<p>These differences are handled by ADOdb (using <i>SelectLimit</i>), but not
by the Python DB API. Other important database differences transparently
handled by ADOdb include date-formating, associative arrays (records as
dictionaries) and LOB-handling.</p>

<p>This class library assumes you are using Python 2.3 or later. Internally it
uses the standard Python 2.3 datetime class.</p>

<h3><a name=databases></a>Databases Supported</h3>

<p>PHP bundles most database extensions in the official release. In Python,
most database extensions are not part of the official release. You have to
manually download and install the extensions yourself. The requirements are
listed below:</p>

<table class=MsoNormalTable border=1 cellpadding=0 width="95%"
 style='width:95.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Class</b></p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Requirements</b></p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Notes</b></p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>odbc</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Download <a
  href="http://www.python.org/windows/win32/odbc.html">PythonWin</a> extensio</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>No support for SelectLimit, UpdateBlob, UpdateBlobFile, Insert_ID,
  RecordCount and Affected_Rows.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:2;height:.25in'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>access</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>Requires mxodbc.</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>&nbsp;Only <span class=GramE>SelectLimit(</span> ) with no
  <i>offset</i> parameter supported. <span class=GramE>RecordCount(</span> )
  not supported.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:3;height:.25in'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>mssql</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>Requires mxodbc.</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>&nbsp;Only <span class=GramE>SelectLimit(</span> ) with no
  <i>offset</i> parameter supported. <span class=GramE>RecordCount(</span> )
  not supported.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:4'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>mysql</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Download <a
  href="http://sourceforge.net/projects/mysql-python">MySQL-python</a>
  extension</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>&nbsp;</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:5'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>mxodbc</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Superior <a
  href="http://www.egenix.com/files/python/mxODBC.html">odbc extension</a>.
  Licensing fee required for commercial us</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p><span class=GramE>SelectLimit(</span> ) not supported. <span class=GramE>RecordCount(</span>
  ) not supported.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:6'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>mxoracle</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Requires mxodbc. Connect to Oracle using ODBC.</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Only <span class=GramE>SelectLimit(</span> ) with no <i>offset</i>
  parameter supported. Requires Oracle client installed. <span class=GramE>RecordCount(</span>
  ) not supported. </p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:7'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>oci8</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Download <a
  href="http://www.computronix.com/utilities.shtml">cx_Oracle</a> extension.
  Also requires Oracle client to be installed.</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>Despite the name, it works with Oracle 8, 9 and later. <span class=GramE>SelectLimit(</span>
  ) does not support the <i>offset</i> parameter. <span class=GramE>RecordCount(</span>
  ) not supported.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:8'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>odbc</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Download <a
  href="http://www.python.org/windows/win32/odbc.html">PythonWin</a> extension</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p><span class=GramE>SelectLimit(</span> ) only works with Access,VFP and
  Microsoft SQL Server. The <i>offset</i> parameter is not supported.</p>
  <p>No support for UpdateBlob, UpdateBlobFile, Insert_ID, RecordCount and
  Affected_Rows.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:9'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>odbc_mssql</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Download <a
  href="http://www.python.org/windows/win32/odbc.html">PythonWin</a> extension</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>Same limitations as adodb_odbc extension, except that Insert_ID and
  Affected_Rows supported.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:10;height:.25in'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>postgres</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>Download <a href="http://initd.org/Software/psycopg">psycopg</a>
  extension</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>&nbsp;</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:11;height:.25in'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>vfp</p>
  </td>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>Requires mxodbc.</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt;height:.25in'>
  <p class=MsoNormal>&nbsp;</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:12;mso-yfti-lastrow:yes'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>sqlite</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Requires <a href="http://initd.org/tracker/pysqlite">pysqlite</a>
  or <a href="http://docs.python.org/dev/lib/module-sqlite3.html">sqlite3</a>.</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Contributed by Glenn Washburn.</p>
  </td>
 </tr>
</table>

<h3><a name=install></a>Installation</h3>

<p>Run from the command prompt:</p>

<p><span style='font-family:"Courier New"'>&gt; <span class=GramE>python</span>
setup.py install</span></p>

<p>This will perform the adodb package installation.</p>

<p>You will need to install database specific extensions to use ADOdb for
Python. </p>

<h3><a name=help></a>Bug Reports and Help</h3>

<p class=MsoNormal>To report bugs, discuss ADOdb, and ask for help, post to the
forums at: <a href="http://phplens.com/lens/lensforum/topics.php?id=4">http://phplens.com/lens/lensforum/topics.php?id=4</a>
</p>

<h3><a name=tutorial></a>Tutorial</h3>

<p>The easiest way to learn how to use ADOdb for python is with a few examples.
Here's one that contrasts PHP with Python. This example select some data from a
table, prints each row, then closes the connection.</p>

<table class=MsoNormalTable border=1 cellpadding=0 width="50%"
 style='width:50.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>PHP</p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Python</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1;mso-yfti-lastrow:yes'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'><pre>include &quot;adodb.inc.php&quot;;<br>
$conn = adodb.NewADOConnection(<span style='color:#660000'>'mysql'</span>);<br>
$conn-&gt;Connect(<span style='color:#660000'>'server','user','pwd','db'</span>);<br>
$rs = $conn-&gt;Execute(<span style='color:#660000'>'select * from table'</span>);<br>
  <br>
while (!$rs-&gt;EOF) {<br>
  <span style='mso-tab-count:1'> </span>print_r($rs-&gt;fields);<br>
  <span style='mso-tab-count:1'> </span>$rs-&gt;MoveNext();<br>
}<br>
$rs-&gt;Close();<br>
$conn-&gt;Close();<br>
  <span style='mso-tab-count:1'> </span></pre></td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'><pre>import adodb;<br>
conn = adodb.NewADOConnection(<span style='color:#660000'>'mysql'</span>)<br>
conn.Connect(<span style='color:#660000'>'server','user','pwd','db'</span>)<br>
cursor = conn.Execute(<span style='color:#660000'>'select * from table'</span>)<br>
  <br>
while not cursor.EOF:<br>
  <span style='mso-tab-count:1'> </span>print cursor.fields<br>
  <span style='mso-tab-count:1'> </span>cursor.MoveNext()<br>
  <br>
cursor.Close()<br>
conn.Close() </pre></td>
 </tr>
</table>

<p>First we create a database connection object, <i>conn</i>. Then we login to
the database using <span class=GramE>Connect(</span> ). We now call <span
class=GramE>Execute(</span> ) to compile and execute the given SQL. The will
return a recordset or cursor that will hold the current row in the <i>fields</i>
property. Fields are numerically indexed, starting at index zero. When we want
to move to the next record, we call <span class=GramE>MoveNext(</span> ) which
also updates the <i>fields</i> property. Lastly, we check to see whether there
are any more records left to process by monitoring the <i>EOF</i> property.</p>

<p>As you can see, the PHP and Python code is very similar. The main difference
is <span class=GramE>Execute(</span> ) returns a recordset in PHP, while a
cursor is returned in Python. A PHP recordset and Python cursor work
identically with SELECT statements. However Python cursors work differently
with INSERT/UPDATE/DELETE statements. You can see that below:</p>

<table class=MsoNormalTable border=1 cellpadding=0 width="50%"
 style='width:50.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>PHP</p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Python</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1;mso-yfti-lastrow:yes'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'><pre>$sql = &quot;update table set col='abc'&quot;;<br>
$rs = $conn-&gt;Execute($sql);<br>
$rows = $conn-&gt;Affected_Rows();</pre></td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'><pre>sql = &quot;update table set col='abc'&quot;<br>
cursor = conn.Execute($sql)<br>
rows = cursor.Affected_Rows()</pre></td>
 </tr>
</table>

<p>In PHP, Affected_<span class=GramE>Rows(</span> ) runs in the connection. In
Python, all information related to an <span class=GramE>Execute(</span> ) is
retrieved from the cursor. This is because Python is multi-threaded, so it is
no longer possible to store the affected_rows globally in the connection. Similarly,
Insert_<span class=GramE>ID(</span> ) is called from the cursor in Python.</p>

<p>We support the iterator protocol, which allows you to iterate through the
data using a for-loop:</p>

<pre><span class=GramE>cursor</span> = conn.Execute('select * from table')<br>
<b>for row in cursor:</b></pre><pre><span style='mso-tab-count:1'> </span><span
class=GramE>print</span> row</pre><pre><o:p>&nbsp;</o:p></pre><pre><o:p>&nbsp;</o:p></pre><pre><span
class=GramE><b>for</b></span><b> row in conn.Execute('select id from table'):</b></pre><pre><span
style='mso-tab-count:1'> </span><span class=GramE>dofunction(</span>row[0])</pre>

<p>And we support associative arrays (dictionaries), where the keys are the
field names: </p>

<pre>cursor = conn.Execute('select id,name from table')<br>
while not cursor.EOF:<br>
<span style='mso-tab-count:1'> </span><b>arr = cursor.GetRowAssoc(0)</b> # 0 is lower, 1 is upper-case<br>
<span style='mso-tab-count:1'> </span>print<span style='mso-spacerun:yes'> </span>'id=',arr['id'],' name=',arr['name']<br>
<span style='mso-tab-count:1'> </span>cursor.MoveNext()</pre>

<h3><a name=conn></a>Connection Examples</h3>

<pre># Oracle connection<br>
import adodb<br>
conn = adodb.NewADOConnection('oci8')<br>
conn.Connect('scott/tiger@tns')<br>
conn.Connect('tns', 'scott', 'tiger')<br>
<br>
# Oracle using connection string<br>
import adodb<br>
conn = adodb.NewADOConnection('oci8://scott:tiger@tns/')<br>
<br>
# MySQL<br>
import adodb<br>
conn = adodb.NewADOConnection('mysql')<br>
conn.Connect('server', 'user', 'pwd', 'db')<br>
<br>
# MySQL using connection string<br>
import adodb<br>
conn = adodb.NewADOConnection('mysql://user:pwd@server/db')<br>
<br>
# PostgreSQL<br>
import adodb<br>
conn = adodb.NewADOConnection('postgres')<br>
conn.Connect('server', 'user', 'pwd', 'db')<br>
conn.Connect('host=server user=user password=pwd dbname=db port=4341')<br>
<br>
# ODBC<br>
import adodb<br>
conn = adodb.NewADOConnection('access') # mxodbc required<br>
dsn = &quot;Driver={Microsoft Access Driver (*.mdb)};Dbq=d:\\inetpub\\adodb\\northwind.mdb;&quot;<br>
conn.Connect(dsn)<br>
<br>
# ODBC for mssql<br>
import adodb<br>
conn = adodb.NewADOConnection('mssql') # mxodbc required<br>
conn.Connect(&quot;Driver={SQL Server};Server=localhost;Database=northwind;&quot;)<br>
<br>
# sqlite<br>
import adodb<br>
conn = adodb.NewADOConnection('sqlite') # pysqlite required<br>
conn.Connect(database = &quot;c:\\sqlite\\mydata.db&quot;)</pre>

<p>Other drivers such as &quot;vfp&quot; for <span class=GramE>foxpro</span>
are included. </p>

<h3><a name=fn></a>Function Reference</h3>

<table class=MsoNormalTable border=1 cellpadding=0 width="80%"
 style='width:80.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><a name=connclass></a><b>Connection Class</b></p>
  </td>
  <td style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Description</b></p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Execute(sql, [params])</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Execute <i>sql</i>, returning a <i>cursor</i> object. The
  optional <i>params</i> is a dictionary that contains the bind variables. All
  blob fields are automatically and transparently retrieved for you. </p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:2'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>SelectLimit(sql, limit, [offset])</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Execute <i>sql</i>, retrieving only <i>limit</i> rows, an
  optional <i>offset</i> from the beginning of the recordset, returning a <i>cursor</i>
  object.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:3'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>UpdateBlob(table, field, blob,<br>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; whereclause, blobtype='BLOB')</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>Executes the equivalent following sql statement:</p>
  <p>UPDATE <i>table</i> SET <i>field</i> = <i>blob</i> WHERE <i>whereclause</i></p>
  <p>The blobtype field should be set to either 'BLOB' or 'CLOB'. Any special
  encoding required for the <i>blob </i>is applied transparently.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:4'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>UpdateBlobFile(table, field, filepath,<br>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; whereclause, blobtype='BLOB')</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>Loads the binary file <i>filepath</i> into <i>blob</i>. Then calls <span
  class=GramE>UpdateBlob(</span> ).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:5'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>ErrorMsg( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns last database error message. This function is not
  thread-safe. </p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:6'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>IsConnected( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns boolean indicating whether connected.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:7'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>qstr(str)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Quotes a varchar or char variable.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:8'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>quote(str)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Synonym for qstr( )</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:9'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetAll(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Execute sql and return 2-dimensional array of tuples, the
  data recordset.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:10'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetArray(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Synonym for <span class=GramE>GetAll(</span>sql).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:11'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetRow(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Execute sql and return first row of recordset as a tuple.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:12'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetOne(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Execute sql and return 1 element of first row of
  recordset.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:13'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetAssoc(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns a dictionary, with the first columns as the keys
  to the dictionary. If more than 2 columns are returned, then the dictionary <span
  class=GramE>values is</span> a tuple of the 2nd to last columns. If 2 columns
  are returned, then the 2nd column becomes the dictionary values. If one
  column is returned, then the values are set to None.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:14'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetDict(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Synonym for <span class=GramE>GetAssoc(</span>).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:15'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetCol(sql)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns the first column of each row as an array.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:16'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>MetaType(fieldtype)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns the ADOdb metatype of a native field type. </p>
  <ul type=disc>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>C</b>: character
       fields that fit into a text input field.</li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>X</b>: larger
       character fields that fit into a textarea.</li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>B</b>: Blobs, or
       Binary Large Objects. Typically images. </li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>D</b>: Date field</li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>T</b>: Timestamp
       field</li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>L</b>: Logical
       field (boolean or bit-field)</li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>I</b>:&nbsp;
       Integer field</li>
   <li class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:
       auto;mso-list:l0 level1 lfo1;tab-stops:list .5in'><b>N</b>: Numeric
       field. Includes autoincrement, numeric, floating point, real and
       integer. </li>
  </ul>
  </td>
 </tr>
 <tr style='mso-yfti-irow:17'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>MetaColumns(table)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns a 2-dimensional array containing information on
  the fields of a table. Each row contains [fieldname, fieldtype, maxlength].
  Maxlength can be -1, indicating that the maximum length is not known. </p>
  <p>Note that some databases return more information in each row. </p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:18'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>DBDate(datetime)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Given a Python 2.3 datetime object, convert into a date
  string acceptable to the database.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:19'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>DBTimeStamp(datetime)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Given a Python 2.3 datetime object, convert into a
  timestamp string acceptable to the database.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:20'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Date(field)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Converts a date returned by a select statement into a
  Python 2.3 datetime object</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:21'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>TimeStamp(field)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Converts a timestamp returned by a select statement into a
  Python 2.3 datetime object</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:22'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>BeginTrans( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>ADOdb defaults to auto-commit mode. Call <span
  class=GramE>BeginTrans(</span> ) to start a transaction. This might not be
  thread-safe.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:23'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>RollbackTrans( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Rollback transaction initiated by <span class=GramE>BeginTrans(</span>
  ).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:24'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>CommitTrans( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Commit transaction initiated by <span class=GramE>BeginTrans(</span>
  ).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:25'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Close( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Close database connection. This is optional, as the
  connection is closed when the object is freed.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:26'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Module( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns the DB module object.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:27'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><st1:State w:st="on"><st1:place w:st="on">Conn</st1:place></st1:State>(
  )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns DB connection object.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:28;mso-yfti-lastrow:yes'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>DriverInfo( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns the threadsafety, apilevel and paramstyle values</p>
  </td>
 </tr>
</table>

<p class=MsoNormal><o:p>&nbsp;</o:p></p>

<table class=MsoNormalTable border=1 cellpadding=0 width="80%"
 style='width:80.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Connection Class Properties</b></p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Description</b></p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>debug</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Set to 1 to output SQL generated to stdout. Set to 2 to
  output to stdout as HTML. Set to a filepath (a string) if you want the debug
  output to be logged into a file.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:2'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>getLOBs</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Boolean that determines whether LOBs (large data objects)
  are loaded automatically. Default is True, autoload. For best performance
  (especially for cursors with no LOBs), set this to False.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:3'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>sysDate</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>SQL to generate current date.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:4;mso-yfti-lastrow:yes'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>sysTimeStamp</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>SQL to generate current timestamp.</p>
  </td>
 </tr>
</table>

<p class=MsoNormal><o:p>&nbsp;</o:p></p>

<table class=MsoNormalTable border=1 cellpadding=0 width="80%"
 style='width:80.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><a name=cursorclass></a><b>Cursor Class Functions</b></p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Description</b></p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>RecordCount( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Number of rows returned by SELECT statement, or number of
  rows affected by INSERT/UPDATE/DELETE. Returns -1 if not supported.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:2'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Affected_Rows( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Synonym for <span class=GramE>RecordCount(</span> ).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:3'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>MoveNext( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Move to next row of recordset. Returns current EOF value.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:4'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>FetchRow( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Retrieves the current row of the recordset, <span
  class=GramE>then</span> moves to the next row. The row retrieved is returned
  as a tuple.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:5'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>GetRowAssoc(upper=1)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns the current row as a dictionary, with the key's
  being the field names. Setting <i>upper</i> = 0 will lower-case the keys.
  Setting <i>upper</i>=1 will upper-case the keys. Setting <i>upper</i> to any
  other value, and the keys will be left in the natural case.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:6'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Insert_ID( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns last insert id generated by an auto-incrementing
  field. Only supported by <i>mysql</i> and <i>odbc_mssql</i> drivers
  currently.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:7'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>FetchField(fieldoffset)</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p>Returns field information from a SELECT statement. The <i>fieldoffset</i> is
  zero-based, so to retrieve info on the 1st field use <span class=GramE>FetchField(</span>0).
  A tuple is returned, consisting of:</p>
  <p>(<span class=GramE>name</span>, type_code,display_size, internal_size,
  precision, scale,null_ok).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:8'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Close( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Close cursor. This is optional, as the cursor is closed
  when the object is freed.</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:9;mso-yfti-lastrow:yes'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Cursor( )</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Returns DB cursor object.</p>
  </td>
 </tr>
</table>

<p class=MsoNormal><o:p>&nbsp;</o:p></p>

<table class=MsoNormalTable border=1 cellpadding=0 width="80%"
 style='width:80.0%;mso-cellspacing:1.5pt'>
 <tr style='mso-yfti-irow:0;mso-yfti-firstrow:yes'>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Cursor Class Properties</b></p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal><b>Description</b></p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:1'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>fields</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>Property that holds the current row of the recordset as a
  tuple (or list).</p>
  </td>
 </tr>
 <tr style='mso-yfti-irow:2;mso-yfti-lastrow:yes'>
  <td nowrap valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>EOF</p>
  </td>
  <td valign=top style='padding:.75pt .75pt .75pt .75pt'>
  <p class=MsoNormal>When moving true the recordset, EOF is set to True after
  we pass the last row.</p>
  </td>
 </tr>
</table>

<h3><a name=err></a>Error Handling</h3>

<p>ADOdb for Python by default relies on the standard Python exception
mechanism. Here's how to capture an error:</p>

<pre><span class=GramE>try</span>:<br>
<span style='mso-tab-count:1'> </span>curs = conn.Execute('select * from badtable'); # table does not exist<br>
except:<br>
<span style='mso-tab-count:1'> </span>print sys.exc_info()[1]; # retrieve the error message returned by database</pre>

<p>Alternatively, you can use PHP style <span class=GramE>ErrorMsg(</span> ) by
setting the <i>connection.useExceptions</i> flag to True. <span class=GramE>ErrorMsg(</span>
) is not thread-safe.</p>

<pre>conn.useExceptions = False<br>
curs = <span class=GramE>conn.Execute(</span>'select * from badtable'); # table does not exist<br>
if curs == None: <br>
<span style='mso-tab-count:1'> </span>print conn.ErrorMsg()<br
style='mso-special-character:line-break'>
<![if !supportLineBreakNewLine]><br style='mso-special-character:line-break'>
<![endif]></pre>

<h3><a name=bind></a>Bind Parameters</h3>

<p>Python drivers do not use a consistent bind parameter convention. Here is a
brief summary of some drivers, obtained by running <span class=GramE>Connection.DriverInfo(</span>
), which outputs the following to the console: </p>

<pre>Driver<span style='mso-spacerun:yes'> </span>= mysql<br>
API Level<span style='mso-spacerun:yes'> </span>= 2.0<br>
Param Style<span style='mso-spacerun:yes'> </span>= format<br>
Thread Safety= 1<span style='mso-spacerun:yes'> </span>(0=none, 1=module, 2=connections, 3=cursors)<br>
<br>
Driver<span style='mso-spacerun:yes'> </span>= oci8<br>
API Level<span style='mso-spacerun:yes'> </span>= 2.0<br>
Param Style<span style='mso-spacerun:yes'> </span>= named<br>
Thread Safety= 2<span style='mso-spacerun:yes'> </span>(0=none, 1=module, 2=connections, 3=cursors)<br>
<br>
Driver<span style='mso-spacerun:yes'> </span>= postgres<br>
API Level<span style='mso-spacerun:yes'> </span>= 2.0<br>
Param Style<span style='mso-spacerun:yes'> </span>= pyformat<br>
Thread Safety= 2<span style='mso-spacerun:yes'> </span>(0=none, 1=module, 2=connections, 3=cursors)<br>
<br>
Driver <span style='mso-spacerun:yes'></span>= mssql (and all odbc drivers)<br>
API Level<span style='mso-spacerun:yes'> </span>= 2.0<br>
Param Style<span style='mso-spacerun:yes'> </span>= qmark</pre>

<p class=MsoNormal>The bind format you use is defined in Param Style. From the
Python DB API docs: </p>

<pre style='margin-bottom:12.0pt'><span style='mso-spacerun:yes'> </span><span
class=GramE>paramstyle</span><br>
<br>
<span style='mso-spacerun:yes'> </span>String constant stating the type of parameter marker<br>
<span style='mso-spacerun:yes'> </span>formatting expected by the interface. Possible values are<br>
<span style='mso-spacerun:yes'> </span>[2]:<br>
<br>
<span style='mso-spacerun:yes'> </span>'qmark'<span style='mso-spacerun:yes'> </span>Question mark style, <br>
<span style='mso-spacerun:yes'> </span>e.g. '...WHERE name=?'<br>
<span style='mso-spacerun:yes'> </span>'<span class=GramE>numeric</span>'<span style='mso-spacerun:yes'> </span>Numeric, positional style, <br>
<span style='mso-spacerun:yes'> </span><span style='mso-spacerun:yes'></span>e.g. '...WHERE name=:1'<br>
<span style='mso-spacerun:yes'> </span>'named'<span style='mso-spacerun:yes'> </span>Named style, <br>
<span style='mso-spacerun:yes'> </span>e.g. '...WHERE name=:name'<br>
<span style='mso-spacerun:yes'> </span>'format'<span style='mso-spacerun:yes'> </span>ANSI C printf format codes, <br>
<span style='mso-spacerun:yes'> </span>e.g. '...WHERE name=%s'<br>
<span style='mso-spacerun:yes'> </span>'pyformat'<span style='mso-spacerun:yes'> </span>Python extended format codes, <br>
<span style='mso-spacerun:yes'> </span>e.g. '...WHERE name=%(name)s'</pre>

<p>So for mysql: </p>

<pre><span style='mso-tab-count:1'> </span>cur_name = &quot;snake&quot;<br>
<span style='mso-tab-count:1'> </span>new_name = &quot;turtle&quot;<br>
<span style='mso-spacerun:yes'></span><span style='mso-tab-count:1'> </span>connection.Execute (&quot;UPDATE animal SET name = %s WHERE name = %s&quot;, (new_name, cur_name))</pre>

<p>For oci8, the <a
href="http://starship.python.net/crew/atuining/cx_Oracle/html/cursorobj.html">cx_oracle
docs</a> say: </p>

<blockquote style='margin-top:5.0pt;margin-bottom:5.0pt'>

<p>Parameters may be passed as a dictionary or sequence or as keyword
arguments. If the arguments are a dictionary, the values will be bound by name
and if the arguments are a sequence the values will be bound by position. </p>

</blockquote>

<p>For odbc, the paramstyle is qmark, eg. </p>

<pre><span style='mso-tab-count:1'> </span><span class=GramE>connection.Execute(</span>'select * from table where id=?',(100,));</pre>

<h3><a name=changelog></a>Change Log</h3>

<p>Todo: add support for sequences. Need to add SelectLimit support for mxodbc
derived classes.</p>

<p><i>2.02 21 May 2007</i></p>

<p><span class=GramE>Added sqlite3 support for python 2.5.</span> </p>

<p><span class=GramE>Fixed GetRow _fixblob bug in oci8.</span></p>

<p><span class=GramE><i>2.01 5 May 2006</i><br>
Added lastrowid support to sqlite.</span></p>

<p>A _fixblob error in oci8, <span class=GramE>row.read(</span> ) has been
patched.</p>

<p><span class=GramE>Odbc dsn generation problem, &quot;;&quot; not generated
correctly.</span> <span class=GramE>fixed</span>.</p>

<p><i>2.00 Nov 2005</i><br>
Added sqlite support, thanks to Glenn Washburn. Improved installation with
setup.py</p>

<p><i>1.13 6 May 2005</i></p>

<p><span class=GramE>Fixed oci8 blob bugs.</span> Also <span class=GramE>updateclob(</span>
) was not working.</p>

<p>Close calls <span class=GramE>close(</span> ) before freeing connectoin
object.</p>

<p><i>1.12<span class=GramE>&nbsp; 24</span> March 2005</i></p>

<p>Added mxoracle driver (mxodbc for oracle)<span class=GramE>..</span></p>

<p><span class=GramE>Fixed cursor iterator bug in mxodbc driver.</span></p>

<p><i>1.11 23 Feb 2005 </i></p>

<p>Fixed commit code for mysql driver. </p>

<p><i>1.10 21 Dec 2004</i> </p>

<p><span class=GramE>Added sysDate and sysTimeStamp to mysql driver.</span> </p>

<p>Added support for connection strings of the form <i>driver://user:pwd@server/database</i>
in NewADOConnection.</p>

<p><span class=GramE>DriverInfo(</span> ) now checks paramStyle before thread
safety, as some drivers do not implement thread safety. </p>

<p>MySQL insert_<span class=GramE>id(</span>) changed to lastrowid as insert_id()
deprecated. <span class=GramE>Thx Alex Verstraeten.</span> </p>

<p><span class=GramE>GetRow(</span>) now closes cursor. Thx Guoda Rugeviciute </p>

<p>Postgresql <span class=GramE>metacolumns(</span>) did not work - not a
tuple. <span class=GramE>Fixed.</span> <span class=GramE>Thx Simon Hedberg.</span>
</p>

<p><i>1.01 30 July 2004</i><br>
<span class=GramE>A</span> debugging print in oci8 was removed.</p>

<p><i>1.00 12 July 2004</i></p>

<p><span class=GramE>GetRowAssoc(</span>), upper = False not implemented
correctly. <span class=GramE>Fixed.</span> </p>

<p><span class=GramE>Tested with psyco.</span> Works fine. </p>

<p><i>0.90 15 Apr 2004</i></p>

<p><span class=GramE>Added ADONewConnection and NewADOConnection.</span> </p>

<p><span class=GramE>Added GetAssoc, GetDict, GetArray and GetCol.</span> </p>

<p><span class=GramE>Added mxodbc driver.</span> <span class=GramE>Also vfp,
access and mssql classes that inherit from mxodbc.</span> <span class=GramE>Tested
only on Windows.</span> </p>

<p>Added MetaColumns and MetaType support for Oracle, mxODBC, MySQL </p>

<p>Perform explicit close for Get* functions. </p>

<p><i>0.03 31 Jan 2004</i></p>

<p><span class=GramE>Implemented setup.py installer.</span> </p>

<p>Some postgres bugs fixed.</p>

<p><i>0.02 28 Jan 2004</i></p>

<p>Revised <span class=GramE>GetRowAssoc(</span> ).</p>

<p>Fixed use of false - should be False. </p>

<p><span class=GramE><i>0.01 25 Jan 2004</i><br>
First Release.</span> <span class=GramE>MySQL, Oracle, PostgreSQL, generic ODBC
and ODBC for MSSQL drivers.</span></p>

</div>

</body>

</html>