HackBase/python-cx_Oracle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweaked documentation in preparation for release of version 4.3.3.

Browse Source
This commit is contained in:
Anthony Tuininga 2007-10-02 02:50:53 +00:00
parent ea89e39983
commit ed13b8314d
21 changed files with 516 additions and 231 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
HISTORY.txt
View File

@ -1,3 +1,30 @@
Changes from 4.3.2 to 4.3.3
1) Added method ping() on connections which can be used to test whether or not
a connection is still active (available in Oracle 10g R2).
2) Added method cx_Oracle.clientversion() which returns a 5-tuple giving the
version of the client that is in use (available in Oracle 10g R2).
3) Added methods startup() and shutdown() on connections which can be used to
startup and shutdown databases (available in Oracle 10g R2).
4) Added support for Oracle 11g.
5) Added samples directory which contains a handful of scripts containing
sample code for more advanced techniques. More will follow in future
releases.
6) Prevent error "ORA-24333: zero iteration count" when calling executemany()
with zero rows as requested by Andreas Mock.
7) Added methods __enter__() and __exit__() on connections to support using
connections as context managers in Python 2.5 and higher. The context
managed is the transaction state. Upon exit the transaction is either
rolled back or committed depending on whether an exception took place or
not.
8) Make the search for the lib32 and lib64 directories automatic for all
platforms.
9) Tweak the setup configuration script to include all of the metadata and
allow for building the module within another setup configuration script
10) Include the Oracle version in addition to the Python version in the build
directories that are created and in the names of the binary packages that
are created.
11) Remove unnecessary dependency on win32api to build module on Windows.
Changes from 4.3.1 to 4.3.2
1) Added methods open(), close(), isopen() and getchunksize() in order to
improve performance of reading/writing LOB values in chunks.

12
LICENSE.txt
View File

@ -14,15 +14,15 @@ modification, are permitted provided that the following conditions are met:
notice, this list of conditions, and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of Colt Engineering nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
3. Neither the names of the copyright holders nor the names of any
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
DISCLAIMER:
THIS SOFTWARE IS PROVIDED BY COLT ENGINEERING AND CONTRIBUTORS *AS IS*
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS*
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COLT ENGINEERING
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
@ -32,3 +32,5 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
Computronix® is a registered trademark of Computronix (Canada) Ltd.

2
doc/build.sh
View File

@ -1,4 +1,4 @@
python /u01/svn/python/trunk/Doc/tools/mkhowto \
python /u01/svn/python/release25-maint/Doc/tools/mkhowto \
--html --dir ../html cx_Oracle.tex
rm -rf ../html/WARNINGS
rm -f ../html/index.dat

24
doc/cx_Oracle.tex
View File

@ -47,7 +47,7 @@ information on the Python database API specification.
\end{funcdesc}
\begin{funcdesc}{clientversion}{}
Return the version of the client library being used as a 5 tuple. The five
Return the version of the client library being used as a 5-tuple. The five
values are the major version, minor version, update number, patch number
and port update number.
@ -149,7 +149,7 @@ information on the Python database API specification.
Python time module for details).
\end{funcdesc}
\section{Constants}
\section{Constants}\label{constants}
\begin{datadesc}{apilevel}
String constant stating the supported DB API level. Currently '2.0'.
@ -208,7 +208,8 @@ information on the Python database API specification.
This constant is used in database shutdown to indicate that the instance can
be truly halted. This should only be done after the database has been shut
down in one of the other modes (except abort) and the database has been
closed and dismounted using the appropriate SQL commands.
closed and dismounted using the appropriate SQL commands. See the method
shutdown() in the section on connections (\ref{connobj}).
\strong{NOTE:} This attribute is an extension to the DB API definition.
\end{datadesc}
@ -440,7 +441,7 @@ information on the Python database API specification.
\strong{NOTE:} This attribute is an extension to the DB API definition.
\end{datadesc}
\section{Exceptions}
\section{Exceptions}\label{exceptions}
\begin{datadesc}{Warning}
Exception raised for important warnings and defined by the DB API but not
@ -498,6 +499,21 @@ information on the Python database API specification.
\strong{NOTE}: Any outstanding changes will be rolled back when the connection
object is destroyed or closed.
\begin{funcdesc}{__enter__}{}
The entry point for the connection as a context manager, a feature available
in Python 2.5 and higher. It returns itself.
\strong{NOTE:} This method is an extension to the DB API definition.
\end{funcdesc}
\begin{funcdesc}{__exit__}{}
The exit point for the connection as a context manager, a feature available
in Python 2.5 and higher. In the event of an exception, the transaction is
rolled back; otherwise, the transaction is committed.
\strong{NOTE:} This method is an extension to the DB API definition.
\end{funcdesc}
\begin{datadesc}{action}
This write-only attribute sets the action column in the v\$session table and
is only available in Oracle 10g.

14
doc/license.tex
View File

@ -1,4 +1,4 @@
\chapter{License}
\chapter{License}\label{license}
\centerline{\strong{LICENSE AGREEMENT FOR CX\_ORACLE \version}}
@ -21,16 +21,16 @@ modification, are permitted provided that the following conditions are met:
documentation and/or other materials provided with the distribution.
\item
Neither the name of Colt Engineering nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.
Neither the names of the copyright holders nor the names of any
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
\end{enumerate}
DISCLAIMER:
THIS SOFTWARE IS PROVIDED BY COLT ENGINEERING AND CONTRIBUTORS *AS IS*
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS*
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COLT ENGINEERING
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
@ -40,3 +40,5 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
Computronix (R) is a registered trademark of Computronix (Canada) Ltd.

14
html/about.html
View File

@ -6,7 +6,7 @@
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="node12.html" />
<link rel="prev" href="license.html" />
<link rel="parent" href="cx_Oracle.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
@ -18,7 +18,7 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8. License"
href="node12.html"><img src='previous.png'
href="license.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="cx_Oracle"
href="cx_Oracle.html"><img src='up.png'
@ -36,7 +36,7 @@
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node12.html">8. License</a>
<a class="sectref" rel="prev" href="license.html">8. License</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
</div>
@ -48,7 +48,7 @@
About this document ...</a>
</h1>
<strong>cx_Oracle</strong>,
April 18, 2007, Release 4.3.1
October 1, 2007, Release HEAD
<p> This document was generated using the <a
href="http://saftsack.fs.uni-bayreuth.de/~latex2ht/">
<strong>LaTeX</strong>2<tt>HTML</tt></a> translator.
@ -80,7 +80,7 @@ April 18, 2007, Release 4.3.1
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8. License"
href="node12.html"><img src='previous.png'
href="license.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="cx_Oracle"
href="cx_Oracle.html"><img src='up.png'
@ -98,13 +98,13 @@ April 18, 2007, Release 4.3.1
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node12.html">8. License</a>
<a class="sectref" rel="prev" href="license.html">8. License</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

141
html/connobj.html
View File

@ -20,7 +20,7 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="1.2 Exceptions"
href="node5.html"><img src='previous.png'
href="exceptions.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="cx_Oracle"
href="cx_Oracle.html"><img src='up.png'
@ -39,7 +39,7 @@
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node5.html">1.2 Exceptions</a>
<a class="sectref" rel="prev" href="exceptions.html">1.2 Exceptions</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
<b class="navlabel">Next:</b>
@ -59,7 +59,32 @@
object is destroyed or closed.
<p>
<dl><dt><b><tt id='l2h-58' xml:id='l2h-58'>action</tt></b></dt>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-66' xml:id='l2h-66' class="function">__enter__</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
The entry point for the connection as a context manager, a feature available
in Python 2.5 and higher. It returns itself.
<p>
<strong>NOTE:</strong> This method is an extension to the DB API definition.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-67' xml:id='l2h-67' class="function">__exit__</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
The exit point for the connection as a context manager, a feature available
in Python 2.5 and higher. In the event of an exception, the transaction is
rolled back; otherwise, the transaction is committed.
<p>
<strong>NOTE:</strong> This method is an extension to the DB API definition.
</dl>
<p>
<dl><dt><b><tt id='l2h-68' xml:id='l2h-68'>action</tt></b></dt>
<dd>
This write-only attribute sets the action column in the v$session table and
is only available in Oracle 10g.
@ -68,9 +93,18 @@ object is destroyed or closed.
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-69' xml:id='l2h-69'>autocommit</tt></b></dt>
<dd>
This read-write attribute determines whether autocommit mode is on or off.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-59' xml:id='l2h-59' class="function">begin</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-70' xml:id='l2h-70' class="function">begin</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
<dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
@ -93,7 +127,7 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-61' xml:id='l2h-61' class="function">cancel</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-72' xml:id='l2h-72' class="function">cancel</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Cancel a long-running transaction. This is only effective on non-Windows
@ -101,7 +135,7 @@ Note that in order to make use of global (distributed) transactions, the
</dl>
<p>
<dl><dt><b><tt id='l2h-62' xml:id='l2h-62'>clientinfo</tt></b></dt>
<dl><dt><b><tt id='l2h-73' xml:id='l2h-73'>clientinfo</tt></b></dt>
<dd>
This write-only attribute sets the client_info column in the v$session table
and is only available in Oracle 10g.
@ -112,7 +146,7 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-63' xml:id='l2h-63' class="function">close</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-74' xml:id='l2h-74' class="function">close</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Close the connection now, rather than whenever __del__ is called. The
@ -123,7 +157,7 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-64' xml:id='l2h-64' class="function">commit</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-75' xml:id='l2h-75' class="function">commit</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Commit any pending transactions to the database.
@ -131,14 +165,14 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-65' xml:id='l2h-65' class="function">cursor</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-76' xml:id='l2h-76' class="function">cursor</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return a new Cursor object (<a href="cursorobj.html#cursorobj">3</a>) using the connection.
</dl>
<p>
<dl><dt><b><tt id='l2h-66' xml:id='l2h-66'>dsn</tt></b></dt>
<dl><dt><b><tt id='l2h-77' xml:id='l2h-77'>dsn</tt></b></dt>
<dd>
This read-only attribute returns the TNS entry of the database to which a
connection has been established.
@ -148,7 +182,7 @@ Note that in order to make use of global (distributed) transactions, the
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-67' xml:id='l2h-67'>encoding</tt></b></dt>
<dl><dt><b><tt id='l2h-78' xml:id='l2h-78'>encoding</tt></b></dt>
<dd>
This read-only attribute returns the IANA character set name of the character
set in use by the Oracle client.
@ -158,7 +192,7 @@ Note that in order to make use of global (distributed) transactions, the
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-68' xml:id='l2h-68'>maxBytesPerCharacter</tt></b></dt>
<dl><dt><b><tt id='l2h-79' xml:id='l2h-79'>maxBytesPerCharacter</tt></b></dt>
<dd>
This read-only attribute returns the maximum number of bytes each character
can use for the client character set.
@ -168,7 +202,7 @@ Note that in order to make use of global (distributed) transactions, the
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-69' xml:id='l2h-69'>module</tt></b></dt>
<dl><dt><b><tt id='l2h-80' xml:id='l2h-80'>module</tt></b></dt>
<dd>
This write-only attribute sets the module column in the v$session table and
is only available in Oracle 10g.
@ -178,7 +212,7 @@ Note that in order to make use of global (distributed) transactions, the
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-70' xml:id='l2h-70'>nencoding</tt></b></dt>
<dl><dt><b><tt id='l2h-81' xml:id='l2h-81'>nencoding</tt></b></dt>
<dd>
This read-only attribute returns the IANA character set name of the national
character set in use by the Oracle client.
@ -188,7 +222,7 @@ Note that in order to make use of global (distributed) transactions, the
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-71' xml:id='l2h-71'>password</tt></b></dt>
<dl><dt><b><tt id='l2h-82' xml:id='l2h-82'>password</tt></b></dt>
<dd>
This read-only attribute returns the password of the user which established
the connection to the database.
@ -199,7 +233,19 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-72' xml:id='l2h-72' class="function">prepare</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-83' xml:id='l2h-83' class="function">ping</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Ping the server which can be used to test if the connection is still active.
<p>
<strong>NOTE:</strong> This method is an extension to the DB API definition and is
only available in Oracle 10g R2 and higher.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-84' xml:id='l2h-84' class="function">prepare</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Prepare the distributed (global) transaction for commit.
@ -210,7 +256,7 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-73' xml:id='l2h-73' class="function">register</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-85' xml:id='l2h-85' class="function">register</tt></b>(</nobr></td>
<td><var><var>code</var>, <var>when</var>, <var>function</var></var>)</td></tr></table></dt>
<dd>
Register the function as an OCI callback. The code is one of the function
@ -230,14 +276,59 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-74' xml:id='l2h-74' class="function">rollback</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-86' xml:id='l2h-86' class="function">rollback</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Rollback any pending transactions.
</dl>
<p>
<dl><dt><b><tt id='l2h-75' xml:id='l2h-75'>tnsentry</tt></b></dt>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-87' xml:id='l2h-87' class="function">shutdown</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>mode</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Shutdown the database. In order to do this the connection must connected as
SYSDBA or SYSOPER. First shutdown using one of the DBSHUTDOWN constants
defined in the constants (<a href="constants.html#constants">1.1</a>) section. Next issue the SQL
statements required to close the database ("alter database close normal")
and dismount the database ("alter database dismount") followed by a second
call to this method with the DBSHUTDOWN_FINAL mode.
<p>
<strong>NOTE:</strong> This method is an extension to the DB API definition and is
only available in Oracle 10g R2 and higher.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-88' xml:id='l2h-88' class="function">startup</tt></b>(</nobr></td>
<td><var><var>force=False</var>, <var>restrict=False</var></var>)</td></tr></table></dt>
<dd>
Startup the database. This is equivalent to the SQL*Plus command
"startup nomount". The connection must be connected as SYSDBA or SYSOPER with
the PRELIM_AUTH option specified for this to work. Once this method has
completed, connect again without the PRELIM_AUTH option and issue the
statements required to mount ("alter database mount") and open ("alter
database open") the database.
<p>
<strong>NOTE:</strong> This method is an extension to the DB API definition and is
only available in Oracle 10g R2 and higher.
</dl>
<p>
<dl><dt><b><tt id='l2h-89' xml:id='l2h-89'>stmtcachesize</tt></b></dt>
<dd>
This read-write attribute specifies the size of the statement cache. This
value can make a significant difference in performance (up to 100x) if you
have a small number of statements that you execute repeatedly.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-90' xml:id='l2h-90'>tnsentry</tt></b></dt>
<dd>
This read-only attribute returns the TNS entry of the database to which a
connection has been established.
@ -248,7 +339,7 @@ Note that in order to make use of global (distributed) transactions, the
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-76' xml:id='l2h-76' class="function">unregister</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-91' xml:id='l2h-91' class="function">unregister</tt></b>(</nobr></td>
<td><var><var>code</var>, <var>when</var></var>)</td></tr></table></dt>
<dd>
Unregister the function as an OCI callback. The code is one of the function
@ -261,7 +352,7 @@ Note that in order to make use of global (distributed) transactions, the
</dl>
<p>
<dl><dt><b><tt id='l2h-77' xml:id='l2h-77'>username</tt></b></dt>
<dl><dt><b><tt id='l2h-92' xml:id='l2h-92'>username</tt></b></dt>
<dd>
This read-only attribute returns the name of the user which established the
connection to the database.
@ -271,7 +362,7 @@ Note that in order to make use of global (distributed) transactions, the
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-78' xml:id='l2h-78'>version</tt></b></dt>
<dl><dt><b><tt id='l2h-93' xml:id='l2h-93'>version</tt></b></dt>
<dd>
This read-only attribute returns the version of the database to which a
connection has been established.
@ -288,7 +379,7 @@ Note that in order to make use of global (distributed) transactions, the
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="1.2 Exceptions"
href="node5.html"><img src='previous.png'
href="exceptions.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="cx_Oracle"
href="cx_Oracle.html"><img src='up.png'
@ -307,7 +398,7 @@ Note that in order to make use of global (distributed) transactions, the
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node5.html">1.2 Exceptions</a>
<a class="sectref" rel="prev" href="exceptions.html">1.2 Exceptions</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
<b class="navlabel">Next:</b>
@ -315,7 +406,7 @@ Note that in order to make use of global (distributed) transactions, the
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

169
html/node4.html → html/constants.html
View File

@ -6,10 +6,10 @@
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node5.html" />
<link rel="next" href="exceptions.html" />
<link rel="prev" href="module.html" />
<link rel="parent" href="module.html" />
<link rel="next" href="node5.html" />
<link rel="next" href="exceptions.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>1.1 Constants</title>
@ -26,7 +26,7 @@
href="module.html"><img src='up.png'
border='0' height='32' alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="1.2 Exceptions"
href="node5.html"><img src='next.png'
href="exceptions.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">cx_Oracle</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
@ -43,24 +43,25 @@
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module.html">1. Module Interface</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node5.html">1.2 Exceptions</a>
<a class="sectref" rel="next" href="exceptions.html">1.2 Exceptions</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->
<h1><a name="SECTION003100000000000000000">
1.1 Constants</a>
<h1><a name="SECTION003100000000000000000"></a><a name="constants"></a>
<br>
1.1 Constants
</h1>
<p>
<dl><dt><b><tt id='l2h-13' xml:id='l2h-13'>apilevel</tt></b></dt>
<dl><dt><b><tt id='l2h-14' xml:id='l2h-14'>apilevel</tt></b></dt>
<dd>
String constant stating the supported DB API level. Currently '2.0'.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-14' xml:id='l2h-14'>buildtime</tt></b></dt>
<dl><dt><b><tt id='l2h-15' xml:id='l2h-15'>buildtime</tt></b></dt>
<dd>
String constant stating the time when the binary was built.
@ -69,14 +70,14 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-15' xml:id='l2h-15'>BINARY</tt></b></dt>
<dl><dt><b><tt id='l2h-16' xml:id='l2h-16'>BINARY</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are binary
(in Oracle this is RAW columns).
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-16' xml:id='l2h-16'>BFILE</tt></b></dt>
<dl><dt><b><tt id='l2h-17' xml:id='l2h-17'>BFILE</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are BFILEs.
@ -85,7 +86,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-17' xml:id='l2h-17'>BLOB</tt></b></dt>
<dl><dt><b><tt id='l2h-18' xml:id='l2h-18'>BLOB</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are BLOBs.
@ -94,7 +95,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-18' xml:id='l2h-18'>CLOB</tt></b></dt>
<dl><dt><b><tt id='l2h-19' xml:id='l2h-19'>CLOB</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are CLOBs.
@ -103,7 +104,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-19' xml:id='l2h-19'>CURSOR</tt></b></dt>
<dl><dt><b><tt id='l2h-20' xml:id='l2h-20'>CURSOR</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are cursors
(in PL/SQL these are known as ref cursors).
@ -113,13 +114,71 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-20' xml:id='l2h-20'>DATETIME</tt></b></dt>
<dl><dt><b><tt id='l2h-21' xml:id='l2h-21'>DATETIME</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are dates.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-21' xml:id='l2h-21'>FIXED_CHAR</tt></b></dt>
<dl><dt><b><tt id='l2h-22' xml:id='l2h-22'>DBSHUTDOWN_ABORT</tt></b></dt>
<dd>
This constant is used in database shutdown to indicate that the program
should not wait for current calls to complete or for users to disconnect from
the database. Use only in unusual circumstances since database recovery may
be necessary upon next startup.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-23' xml:id='l2h-23'>DBSHUTDOWN_FINAL</tt></b></dt>
<dd>
This constant is used in database shutdown to indicate that the instance can
be truly halted. This should only be done after the database has been shut
down in one of the other modes (except abort) and the database has been
closed and dismounted using the appropriate SQL commands. See the method
shutdown() in the section on connections (<a href="connobj.html#connobj">2</a>).
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-24' xml:id='l2h-24'>DBSHUTDOWN_IMMEDIATE</tt></b></dt>
<dd>
This constant is used in database shutdown to indicate that all uncommitted
transactions should be rolled back and any connected users should be
disconnected.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-25' xml:id='l2h-25'>DBSHUTDOWN_TRANSACTIONAL</tt></b></dt>
<dd>
This constant is used in database shutdown to indicate that further
connections should be prohibited and no new transactions should be allowed.
It then waits for active transactions to complete.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-26' xml:id='l2h-26'>DBSHUTDOWN_TRANSACTIONAL_LOCAL</tt></b></dt>
<dd>
This constant is used in database shutdown to indicate that further
connections should be prohibited and no new transactions should be allowed.
It then waits for only local active transactions to complete.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-27' xml:id='l2h-27'>FIXED_CHAR</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are fixed
length strings (in Oracle this is CHAR columns); these behave differently
@ -131,7 +190,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-22' xml:id='l2h-22'>FNCODE_BINDBYNAME</tt></b></dt>
<dl><dt><b><tt id='l2h-28' xml:id='l2h-28'>FNCODE_BINDBYNAME</tt></b></dt>
<dd>
This constant is used to register callbacks on the OCIBindByName() function
of the OCI.
@ -141,7 +200,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-23' xml:id='l2h-23'>FNCODE_BINDBYPOS</tt></b></dt>
<dl><dt><b><tt id='l2h-29' xml:id='l2h-29'>FNCODE_BINDBYPOS</tt></b></dt>
<dd>
This constant is used to register callbacks on the OCIBindByPos() function
of the OCI.
@ -151,7 +210,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-24' xml:id='l2h-24'>FNCODE_DEFINEBYPOS</tt></b></dt>
<dl><dt><b><tt id='l2h-30' xml:id='l2h-30'>FNCODE_DEFINEBYPOS</tt></b></dt>
<dd>
This constant is used to register callbacks on the OCIDefineByPos() function
of the OCI.
@ -161,7 +220,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-25' xml:id='l2h-25'>FNCODE_STMTEXECUTE</tt></b></dt>
<dl><dt><b><tt id='l2h-31' xml:id='l2h-31'>FNCODE_STMTEXECUTE</tt></b></dt>
<dd>
This constant is used to register callbacks on the OCIStmtExecute() function
of the OCI.
@ -171,7 +230,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-26' xml:id='l2h-26'>FNCODE_STMTFETCH</tt></b></dt>
<dl><dt><b><tt id='l2h-32' xml:id='l2h-32'>FNCODE_STMTFETCH</tt></b></dt>
<dd>
This constant is used to register callbacks on the OCIStmtFetch() function
of the OCI.
@ -181,7 +240,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-27' xml:id='l2h-27'>FNCODE_STMTPREPARE</tt></b></dt>
<dl><dt><b><tt id='l2h-33' xml:id='l2h-33'>FNCODE_STMTPREPARE</tt></b></dt>
<dd>
This constant is used to register callbacks on the OCIStmtPrepare() function
of the OCI.
@ -191,7 +250,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-28' xml:id='l2h-28'>LOB</tt></b></dt>
<dl><dt><b><tt id='l2h-34' xml:id='l2h-34'>LOB</tt></b></dt>
<dd>
This type object is the Python type of BLOB and CLOB data that is returned
from cursors.
@ -201,7 +260,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-29' xml:id='l2h-29'>LONG_BINARY</tt></b></dt>
<dl><dt><b><tt id='l2h-35' xml:id='l2h-35'>LONG_BINARY</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are long
binary (in Oracle these are LONG RAW columns).
@ -211,7 +270,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-30' xml:id='l2h-30'>LONG_STRING</tt></b></dt>
<dl><dt><b><tt id='l2h-36' xml:id='l2h-36'>LONG_STRING</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are long
strings (in Oracle these are LONG columns).
@ -221,7 +280,17 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-31' xml:id='l2h-31'>NCLOB</tt></b></dt>
<dl><dt><b><tt id='l2h-37' xml:id='l2h-37'>NATIVE_FLOAT</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are of type
binary_double or binary_float and is only available in Oracle 10g.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-38' xml:id='l2h-38'>NCLOB</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are NCLOBs.
@ -230,13 +299,13 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-32' xml:id='l2h-32'>NUMBER</tt></b></dt>
<dl><dt><b><tt id='l2h-39' xml:id='l2h-39'>NUMBER</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are numbers.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-33' xml:id='l2h-33'>OBJECT</tt></b></dt>
<dl><dt><b><tt id='l2h-40' xml:id='l2h-40'>OBJECT</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are objects.
@ -245,20 +314,30 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-34' xml:id='l2h-34'>paramstyle</tt></b></dt>
<dl><dt><b><tt id='l2h-41' xml:id='l2h-41'>paramstyle</tt></b></dt>
<dd>
String constant stating the type of parameter marker formatting expected by
the interface. Currently 'named' as in 'where name = :name'.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-35' xml:id='l2h-35'>ROWID</tt></b></dt>
<dl><dt><b><tt id='l2h-42' xml:id='l2h-42'>ROWID</tt></b></dt>
<dd>
This type object is used to describe the pseudo column "rowid".
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-36' xml:id='l2h-36'>SPOOL_ATTRVAL_FORCEGET</tt></b></dt>
<dl><dt><b><tt id='l2h-43' xml:id='l2h-43'>PRELIM_AUTH</tt></b></dt>
<dd>
This constant is used to define the preliminary authentication mode required
for performing database startup and shutdown.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-44' xml:id='l2h-44'>SPOOL_ATTRVAL_FORCEGET</tt></b></dt>
<dd>
This constant is used to define the "get" mode on session pools and indicates
that a new connection will be returned if there are no free sessions
@ -269,7 +348,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-37' xml:id='l2h-37'>SPOOL_ATTRVAL_NOWAIT</tt></b></dt>
<dl><dt><b><tt id='l2h-45' xml:id='l2h-45'>SPOOL_ATTRVAL_NOWAIT</tt></b></dt>
<dd>
This constant is used to define the "get" mode on session pools and indicates
that an exception is raised if there are no free sessions available in the
@ -280,7 +359,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-38' xml:id='l2h-38'>SPOOL_ATTRVAL_WAIT</tt></b></dt>
<dl><dt><b><tt id='l2h-46' xml:id='l2h-46'>SPOOL_ATTRVAL_WAIT</tt></b></dt>
<dd>
This constant is used to define the "get" mode on session pools and indicates
that the acquisition of a connection waits until a session is freed if there
@ -291,14 +370,14 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-39' xml:id='l2h-39'>STRING</tt></b></dt>
<dl><dt><b><tt id='l2h-47' xml:id='l2h-47'>STRING</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are strings
(in Oracle this is VARCHAR2 columns).
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-40' xml:id='l2h-40'>SYSDBA</tt></b></dt>
<dl><dt><b><tt id='l2h-48' xml:id='l2h-48'>SYSDBA</tt></b></dt>
<dd>
Value to be passed to the connect() method which indicates that SYSDBA
access is to be acquired. See the Oracle documentation for more details.
@ -308,7 +387,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-41' xml:id='l2h-41'>SYSOPER</tt></b></dt>
<dl><dt><b><tt id='l2h-49' xml:id='l2h-49'>SYSOPER</tt></b></dt>
<dd>
Value to be passed to the connect() method which indicates that SYSOPER
access is to be acquired. See the Oracle documentation for more details.
@ -318,7 +397,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-42' xml:id='l2h-42'>threadsafety</tt></b></dt>
<dl><dt><b><tt id='l2h-50' xml:id='l2h-50'>threadsafety</tt></b></dt>
<dd>
Integer constant stating the level of thread safety that the interface
supports. Currently 2, which means that threads may share the module and
@ -333,7 +412,7 @@ Note that in order to make use of multiple threads in a program which intends
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-43' xml:id='l2h-43'>TIMESTAMP</tt></b></dt>
<dl><dt><b><tt id='l2h-51' xml:id='l2h-51'>TIMESTAMP</tt></b></dt>
<dd>
This type object is used to describe columns in a database that are
timestamps.
@ -344,7 +423,7 @@ Note that in order to make use of multiple threads in a program which intends
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-44' xml:id='l2h-44'>UCBTYPE_ENTRY</tt></b></dt>
<dl><dt><b><tt id='l2h-52' xml:id='l2h-52'>UCBTYPE_ENTRY</tt></b></dt>
<dd>
This constant is used to register callbacks on entry to the function
of the OCI. In other words, the callback will be called prior to the
@ -355,7 +434,7 @@ Note that in order to make use of multiple threads in a program which intends
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-45' xml:id='l2h-45'>UCBTYPE_EXIT</tt></b></dt>
<dl><dt><b><tt id='l2h-53' xml:id='l2h-53'>UCBTYPE_EXIT</tt></b></dt>
<dd>
This constant is used to register callbacks on exit from the function
of the OCI. In other words, the callback will be called after the execution
@ -366,7 +445,7 @@ Note that in order to make use of multiple threads in a program which intends
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-46' xml:id='l2h-46'>UCBTYPE_REPLACE</tt></b></dt>
<dl><dt><b><tt id='l2h-54' xml:id='l2h-54'>UCBTYPE_REPLACE</tt></b></dt>
<dd>
This constant is used to register callbacks that completely replace the
call to the OCI function.
@ -376,9 +455,9 @@ Note that in order to make use of multiple threads in a program which intends
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-47' xml:id='l2h-47'>version</tt></b></dt>
<dl><dt><b><tt id='l2h-55' xml:id='l2h-55'>version</tt></b></dt>
<dd>
String constant stating the version of the module. Currently '4.3.1'.
String constant stating the version of the module. Currently 'HEAD'.
<p>
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
@ -398,7 +477,7 @@ Note that in order to make use of multiple threads in a program which intends
href="module.html"><img src='up.png'
border='0' height='32' alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="1.2 Exceptions"
href="node5.html"><img src='next.png'
href="exceptions.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">cx_Oracle</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
@ -415,11 +494,11 @@ Note that in order to make use of multiple threads in a program which intends
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module.html">1. Module Interface</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node5.html">1.2 Exceptions</a>
<a class="sectref" rel="next" href="exceptions.html">1.2 Exceptions</a>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

8
html/contents.html
View File

@ -55,8 +55,8 @@ Contents</a>
<ul class="TofC">
<li><a href="module.html">1. Module Interface</a>
<ul>
<li><a href="node4.html">1.1 Constants</a>
<li><a href="node5.html">1.2 Exceptions</a>
<li><a href="constants.html">1.1 Constants</a>
<li><a href="exceptions.html">1.2 Exceptions</a>
</ul>
<li><a href="connobj.html">2. Connection Objects</a>
<li><a href="cursorobj.html">3. Cursor Objects</a>
@ -64,7 +64,7 @@ Contents</a>
<li><a href="sesspool.html">5. SessionPool Objects</a>
<li><a href="lobobj.html">6. LOB Objects</a>
<li><a href="dateobj.html">7. Date Objects</a>
<li><a href="node12.html">8. License</a>
<li><a href="license.html">8. License</a>
</ul>
<!--End of Table of Contents-->
<p>
@ -101,7 +101,7 @@ Contents</a>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

72
html/cursorobj.html
View File

@ -55,7 +55,7 @@
</h1>
<p>
<dl><dt><b><tt id='l2h-79' xml:id='l2h-79'>arraysize</tt></b></dt>
<dl><dt><b><tt id='l2h-94' xml:id='l2h-94'>arraysize</tt></b></dt>
<dd>
This read-write attribute specifies the number of rows to fetch at a time
internally and is the default number of rows to fetch with the fetchmany()
@ -65,7 +65,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-80' xml:id='l2h-80'>bindarraysize</tt></b></dt>
<dl><dt><b><tt id='l2h-95' xml:id='l2h-95'>bindarraysize</tt></b></dt>
<dd>
This read-write attribute specifies the number of rows to bind at a time and
is used when creating variables via setinputsizes() or var(). It defaults to
@ -77,7 +77,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-81' xml:id='l2h-81' class="function">arrayvar</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-96' xml:id='l2h-96' class="function">arrayvar</tt></b>(</nobr></td>
<td><var><var>dataType</var>, <var>value</var>, </var><big>[</big><var><var>size</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Create an array variable associated with the cursor of the given type and
@ -96,7 +96,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-82' xml:id='l2h-82' class="function">bindnames</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-97' xml:id='l2h-97' class="function">bindnames</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the list of bind variable names bound to the statement. Note that the
@ -108,7 +108,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-83' xml:id='l2h-83' class="function">callfunc</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-98' xml:id='l2h-98' class="function">callfunc</tt></b>(</nobr></td>
<td><var><var>name</var>, <var>returnType</var>,
</var><big>[</big><var><var>parameters=[]</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
@ -120,7 +120,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-84' xml:id='l2h-84' class="function">callproc</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-99' xml:id='l2h-99' class="function">callproc</tt></b>(</nobr></td>
<td><var><var>name</var>, </var><big>[</big><var><var>parameters=[]</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Call a procedure with the given name. The sequence of parameters must contain
@ -132,7 +132,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-85' xml:id='l2h-85' class="function">close</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-100' xml:id='l2h-100' class="function">close</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Close the cursor now, rather than whenever __del__ is called. The cursor will
@ -141,7 +141,7 @@
</dl>
<p>
<dl><dt><b><tt id='l2h-86' xml:id='l2h-86'>connection</tt></b></dt>
<dl><dt><b><tt id='l2h-101' xml:id='l2h-101'>connection</tt></b></dt>
<dd>
This read-only attribute returns a reference to the connection object on
which the cursor was created.
@ -152,7 +152,7 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-87' xml:id='l2h-87'>description</tt></b></dt>
<dl><dt><b><tt id='l2h-102' xml:id='l2h-102'>description</tt></b></dt>
<dd>
This read-only attribute is a sequence of 7-item sequences. Each of these
sequences contains information describing one result column: (name, type,
@ -166,7 +166,7 @@ The type will be one of the type objects defined at the module level.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-88' xml:id='l2h-88' class="function">execute</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-103' xml:id='l2h-103' class="function">execute</tt></b>(</nobr></td>
<td><var><var>statement</var>, </var><big>[</big><var><var>parameters</var></var><big>]</big><var>,
<var>**keywordParameters</var></var>)</td></tr></table></dt>
<dd>
@ -202,7 +202,7 @@ If the statement is a query, a list of variable objects (<a href="varobj.html#va
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-89' xml:id='l2h-89' class="function">executemany</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-104' xml:id='l2h-104' class="function">executemany</tt></b>(</nobr></td>
<td><var><var>statement</var>, <var>parameters</var></var>)</td></tr></table></dt>
<dd>
Prepare a statement for execution against a database and then execute it
@ -212,7 +212,7 @@ If the statement is a query, a list of variable objects (<a href="varobj.html#va
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-90' xml:id='l2h-90' class="function">executemanyprepared</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-105' xml:id='l2h-105' class="function">executemanyprepared</tt></b>(</nobr></td>
<td><var><var>numIters</var></var>)</td></tr></table></dt>
<dd>
Execute the previously prepared and bound statement the given number of
@ -227,7 +227,7 @@ If the statement is a query, a list of variable objects (<a href="varobj.html#va
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-91' xml:id='l2h-91' class="function">fetchall</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-106' xml:id='l2h-106' class="function">fetchall</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Fetch all (remaining) rows of a query result, returning them as a list of
@ -243,7 +243,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-92' xml:id='l2h-92' class="function">fetchmany</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-107' xml:id='l2h-107' class="function">fetchmany</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>numRows=cursor.arraysize</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Fetch the next set of rows of a query result, returning a list of tuples. An
@ -263,7 +263,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-93' xml:id='l2h-93' class="function">fetchone</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-108' xml:id='l2h-108' class="function">fetchone</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Fetch the next row of a query result set, returning a single tuple or None
@ -276,7 +276,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-94' xml:id='l2h-94' class="function">fetchraw</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-109' xml:id='l2h-109' class="function">fetchraw</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>numRows=cursor.arraysize</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Fetch the next set of rows of a query result into the internal buffers of the
@ -294,7 +294,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-95' xml:id='l2h-95' class="function">__iter__</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-110' xml:id='l2h-110' class="function">__iter__</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Returns the cursor itself to be used as an iterator.
@ -306,7 +306,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-96' xml:id='l2h-96' class="function">next</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-111' xml:id='l2h-111' class="function">next</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Fetch the next row of a query result set, using the same semantics as
@ -318,7 +318,7 @@ An exception is raised if the previous call to execute() did not produce any
</dl>
<p>
<dl><dt><b><tt id='l2h-97' xml:id='l2h-97'>numbersAsStrings</tt></b></dt>
<dl><dt><b><tt id='l2h-112' xml:id='l2h-112'>numbersAsStrings</tt></b></dt>
<dd>
This integer attribute defines whether or not numbers should be returned as
strings rather than integers or floating point numbers. This is useful to get
@ -332,7 +332,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-98' xml:id='l2h-98' class="function">parse</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-113' xml:id='l2h-113' class="function">parse</tt></b>(</nobr></td>
<td><var><var>statement</var></var>)</td></tr></table></dt>
<dd>
This can be used to parse a statement without actually executing it (this
@ -344,29 +344,43 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-99' xml:id='l2h-99' class="function">prepare</tt></b>(</nobr></td>
<td><var><var>statement</var></var>)</td></tr></table></dt>
<td><nobr><b><tt id='l2h-114' xml:id='l2h-114' class="function">prepare</tt></b>(</nobr></td>
<td><var><var>statement</var>, </var><big>[</big><var><var>tag</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
This can be used before a call to execute() to define the statement that will
be executed. When this is done, the prepare phase will not be performed when
the call to execute() is made with None or the same string object as the
statement.
statement. If specified (Oracle 9i and higher) the statement will be
returned to the statement cache with the given tag. See the Oracle
documentation for more information about the statement cache.
<p>
<strong>NOTE:</strong> The DB API definition does not define this method.
</dl>
<p>
<dl><dt><b><tt id='l2h-100' xml:id='l2h-100'>rowcount</tt></b></dt>
<dl><dt><b><tt id='l2h-115' xml:id='l2h-115'>rowcount</tt></b></dt>
<dd>
This read-only attribute specifies the number of rows that have currently
been fetched from the cursor (for select statements) or that have been
affected by the operation (for insert, update and delete statements).
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-116' xml:id='l2h-116'>rowfactory</tt></b></dt>
<dd>
This read-write attribute specifies a method to call for each row that is
retrieved from the database. Ordinarily a tuple is returned for each row but
if this attribute is set, the method is called with the argument tuple that
would normally be returned and the result of the method is returned instead.
<p>
<strong>NOTE:</strong> The DB API definition does not define this attribute.
</dd></dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-101' xml:id='l2h-101' class="function">setinputsizes</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-117' xml:id='l2h-117' class="function">setinputsizes</tt></b>(</nobr></td>
<td><var><var>*args</var>, <var>**keywordArgs</var></var>)</td></tr></table></dt>
<dd>
This can be used before a call to execute() to predefine memory areas for the
@ -380,7 +394,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-102' xml:id='l2h-102' class="function">setoutputsize</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-118' xml:id='l2h-118' class="function">setoutputsize</tt></b>(</nobr></td>
<td><var><var>size</var>, </var><big>[</big><var><var>column</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
This can be used before a call to execute() to predefine memory areas for the
@ -390,7 +404,7 @@ An exception is raised if the previous call to execute() did not produce any
</dl>
<p>
<dl><dt><b><tt id='l2h-103' xml:id='l2h-103'>statement</tt></b></dt>
<dl><dt><b><tt id='l2h-119' xml:id='l2h-119'>statement</tt></b></dt>
<dd>
This read-only attribute provides the string object that was previously
prepared with prepare() or executed with execute().
@ -401,7 +415,7 @@ An exception is raised if the previous call to execute() did not produce any
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-104' xml:id='l2h-104' class="function">var</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-120' xml:id='l2h-120' class="function">var</tt></b>(</nobr></td>
<td><var><var>dataType</var>, </var><big>[</big><var><var>size</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Create a variable associated with the cursor of the given type and size and
@ -451,7 +465,7 @@ An exception is raised if the previous call to execute() did not produce any
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

14
html/cx_Oracle.html
View File

@ -47,12 +47,12 @@
<h1>cx_Oracle</h1>
<p><b><font size="+2">Anthony Tuininga</font></b></p>
<p>
<strong>Computronix</strong>
<strong>Colt Engineering</strong>
<br>
Email: <span class="email">anthony.tuininga@gmail.com</span>
</p>
<p><strong>Release 4.3.1</strong><br />
<strong>April 18, 2007</strong></p>
<p><strong>Release HEAD</strong><br />
<strong>October 1, 2007</strong></p>
<p></p>
</div>
</div>
@ -69,8 +69,8 @@ Email: <span class="email">anthony.tuininga@gmail.com</span>
<li><a href="contents.html">Contents</a>
<li><a href="module.html">1. Module Interface</a>
<ul>
<li><a href="node4.html">1.1 Constants</a>
<li><a href="node5.html">1.2 Exceptions</a>
<li><a href="constants.html">1.1 Constants</a>
<li><a href="exceptions.html">1.2 Exceptions</a>
</ul>
<li><a href="connobj.html">2. Connection Objects</a>
<li><a href="cursorobj.html">3. Cursor Objects</a>
@ -78,7 +78,7 @@ Email: <span class="email">anthony.tuininga@gmail.com</span>
<li><a href="sesspool.html">5. SessionPool Objects</a>
<li><a href="lobobj.html">6. LOB Objects</a>
<li><a href="dateobj.html">7. Date Objects</a>
<li><a href="node12.html">8. License</a>
<li><a href="license.html">8. License</a>
<li><a href="about.html">About this document ...</a>
</ul>
<!--End of Table of Child-Links-->
@ -111,7 +111,7 @@ Email: <span class="email">anthony.tuininga@gmail.com</span>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

28
html/dateobj.html
View File

@ -6,10 +6,10 @@
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node12.html" />
<link rel="next" href="license.html" />
<link rel="prev" href="lobobj.html" />
<link rel="parent" href="cx_Oracle.html" />
<link rel="next" href="node12.html" />
<link rel="next" href="license.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>7. Date Objects</title>
@ -26,7 +26,7 @@
href="cx_Oracle.html"><img src='up.png'
border='0' height='32' alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="8. License"
href="node12.html"><img src='next.png'
href="license.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">cx_Oracle</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
@ -43,7 +43,7 @@
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node12.html">8. License</a>
<a class="sectref" rel="next" href="license.html">8. License</a>
</div>
<hr /></div>
</div>
@ -64,43 +64,43 @@ constructor methods (Date(), Time(), Timestamp()) are called.
standard library datetime module instead of these objects.
<p>
<dl><dt><b><tt id='l2h-130' xml:id='l2h-130'>year</tt></b></dt>
<dl><dt><b><tt id='l2h-150' xml:id='l2h-150'>year</tt></b></dt>
<dd>
This read-only attribute returns the year.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-131' xml:id='l2h-131'>month</tt></b></dt>
<dl><dt><b><tt id='l2h-151' xml:id='l2h-151'>month</tt></b></dt>
<dd>
This read-only attribute returns the month.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-132' xml:id='l2h-132'>day</tt></b></dt>
<dl><dt><b><tt id='l2h-152' xml:id='l2h-152'>day</tt></b></dt>
<dd>
This read-only attribute returns the day.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-133' xml:id='l2h-133'>hour</tt></b></dt>
<dl><dt><b><tt id='l2h-153' xml:id='l2h-153'>hour</tt></b></dt>
<dd>
This read-only attribute returns the hour.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-134' xml:id='l2h-134'>minute</tt></b></dt>
<dl><dt><b><tt id='l2h-154' xml:id='l2h-154'>minute</tt></b></dt>
<dd>
This read-only attribute returns the minute.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-135' xml:id='l2h-135'>second</tt></b></dt>
<dl><dt><b><tt id='l2h-155' xml:id='l2h-155'>second</tt></b></dt>
<dd>
This read-only attribute returns the second.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-136' xml:id='l2h-136'>fsecond</tt></b></dt>
<dl><dt><b><tt id='l2h-156' xml:id='l2h-156'>fsecond</tt></b></dt>
<dd>
This read-only attribute returns the fractional second.
</dd></dl>
@ -119,7 +119,7 @@ standard library datetime module instead of these objects.
href="cx_Oracle.html"><img src='up.png'
border='0' height='32' alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="8. License"
href="node12.html"><img src='next.png'
href="license.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">cx_Oracle</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
@ -136,11 +136,11 @@ standard library datetime module instead of these objects.
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node12.html">8. License</a>
<a class="sectref" rel="next" href="license.html">8. License</a>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

37
html/node5.html → html/exceptions.html
View File

@ -6,7 +6,7 @@
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="node4.html" />
<link rel="prev" href="constants.html" />
<link rel="parent" href="module.html" />
<link rel="next" href="connobj.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
@ -19,7 +19,7 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="1.1 Constants"
href="node4.html"><img src='previous.png'
href="constants.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="1. module Interface"
href="module.html"><img src='up.png'
@ -38,7 +38,7 @@
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node4.html">1.1 Constants</a>
<a class="sectref" rel="prev" href="constants.html">1.1 Constants</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module.html">1. Module Interface</a>
<b class="navlabel">Next:</b>
@ -48,19 +48,20 @@
</div>
<!--End of Navigation Panel-->
<h1><a name="SECTION003200000000000000000">
1.2 Exceptions</a>
<h1><a name="SECTION003200000000000000000"></a><a name="exceptions"></a>
<br>
1.2 Exceptions
</h1>
<p>
<dl><dt><b><tt id='l2h-48' xml:id='l2h-48'>Warning</tt></b></dt>
<dl><dt><b><tt id='l2h-56' xml:id='l2h-56'>Warning</tt></b></dt>
<dd>
Exception raised for important warnings and defined by the DB API but not
actually used by cx_Oracle.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-49' xml:id='l2h-49'>Error</tt></b></dt>
<dl><dt><b><tt id='l2h-57' xml:id='l2h-57'>Error</tt></b></dt>
<dd>
Exception that is the base class of all other exceptions defined by
cx_Oracle and is a subclass of the Python StandardError exception (defined in
@ -68,28 +69,28 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-50' xml:id='l2h-50'>InterfaceError</tt></b></dt>
<dl><dt><b><tt id='l2h-58' xml:id='l2h-58'>InterfaceError</tt></b></dt>
<dd>
Exception raised for errors that are related to the database interface rather
than the database itself. It is a subclass of Error.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-51' xml:id='l2h-51'>DatabaseError</tt></b></dt>
<dl><dt><b><tt id='l2h-59' xml:id='l2h-59'>DatabaseError</tt></b></dt>
<dd>
Exception raised for errors that are related to the database. It is a
subclass of Error.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-52' xml:id='l2h-52'>DataError</tt></b></dt>
<dl><dt><b><tt id='l2h-60' xml:id='l2h-60'>DataError</tt></b></dt>
<dd>
Exception raised for errors that are due to problems with the processed data.
It is a subclass of DatabaseError.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-53' xml:id='l2h-53'>OperationalError</tt></b></dt>
<dl><dt><b><tt id='l2h-61' xml:id='l2h-61'>OperationalError</tt></b></dt>
<dd>
Exception raised for errors that are related to the operation of the database
but are not necessarily under the control of the progammer. It is a
@ -97,27 +98,27 @@
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-54' xml:id='l2h-54'>IntegrityError</tt></b></dt>
<dl><dt><b><tt id='l2h-62' xml:id='l2h-62'>IntegrityError</tt></b></dt>
<dd>
Exception raised when the relational integrity of the database is affected.
It is a subclass of DatabaseError.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-55' xml:id='l2h-55'>InternalError</tt></b></dt>
<dl><dt><b><tt id='l2h-63' xml:id='l2h-63'>InternalError</tt></b></dt>
<dd>
Exception raised when the database encounters an internal error.
It is a subclass of DatabaseError.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-56' xml:id='l2h-56'>ProgrammingError</tt></b></dt>
<dl><dt><b><tt id='l2h-64' xml:id='l2h-64'>ProgrammingError</tt></b></dt>
<dd>
Exception raised for programming errors. It is a subclass of DatabaseError.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-57' xml:id='l2h-57'>NotSupportedError</tt></b></dt>
<dl><dt><b><tt id='l2h-65' xml:id='l2h-65'>NotSupportedError</tt></b></dt>
<dd>
Exception raised when a method or database API was used which is not
supported by the database. It is a subclass of DatabaseError.
@ -131,7 +132,7 @@
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="1.1 Constants"
href="node4.html"><img src='previous.png'
href="constants.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="1. module Interface"
href="module.html"><img src='up.png'
@ -150,7 +151,7 @@
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node4.html">1.1 Constants</a>
<a class="sectref" rel="prev" href="constants.html">1.1 Constants</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module.html">1. Module Interface</a>
<b class="navlabel">Next:</b>
@ -158,7 +159,7 @@
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

7
html/front.html
View File

@ -55,8 +55,9 @@ Front Matter
</h1>
<p>
Copyright © 2001-2007 Computronix.
All rights reserved.
Copyright © 2007 Colt Engineering. All rights reserved.
<br>
Copyright © 2001-2007 Computronix. All rights reserved.
<p>
See the end of this document for complete license and permissions
@ -112,7 +113,7 @@ information on the Python database API specification.
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

14
html/index.html
View File

@ -47,12 +47,12 @@
<h1>cx_Oracle</h1>
<p><b><font size="+2">Anthony Tuininga</font></b></p>
<p>
<strong>Computronix</strong>
<strong>Colt Engineering</strong>
<br>
Email: <span class="email">anthony.tuininga@gmail.com</span>
</p>
<p><strong>Release 4.3.1</strong><br />
<strong>April 18, 2007</strong></p>
<p><strong>Release HEAD</strong><br />
<strong>October 1, 2007</strong></p>
<p></p>
</div>
</div>
@ -69,8 +69,8 @@ Email: <span class="email">anthony.tuininga@gmail.com</span>
<li><a href="contents.html">Contents</a>
<li><a href="module.html">1. Module Interface</a>
<ul>
<li><a href="node4.html">1.1 Constants</a>
<li><a href="node5.html">1.2 Exceptions</a>
<li><a href="constants.html">1.1 Constants</a>
<li><a href="exceptions.html">1.2 Exceptions</a>
</ul>
<li><a href="connobj.html">2. Connection Objects</a>
<li><a href="cursorobj.html">3. Cursor Objects</a>
@ -78,7 +78,7 @@ Email: <span class="email">anthony.tuininga@gmail.com</span>
<li><a href="sesspool.html">5. SessionPool Objects</a>
<li><a href="lobobj.html">6. LOB Objects</a>
<li><a href="dateobj.html">7. Date Objects</a>
<li><a href="node12.html">8. License</a>
<li><a href="license.html">8. License</a>
<li><a href="about.html">About this document ...</a>
</ul>
<!--End of Table of Child-Links-->
@ -111,7 +111,7 @@ Email: <span class="email">anthony.tuininga@gmail.com</span>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

24
html/node12.html → html/license.html
View File

@ -49,15 +49,19 @@
</div>
<!--End of Navigation Panel-->
<h1><a name="SECTION0010000000000000000000">
8. License</a>
<h1><a name="SECTION0010000000000000000000"></a><a name="license"></a>
<br>
8. License
</h1>
<p>
<div class="centerline" id="par1465" align="CENTER">
<strong>LICENSE AGREEMENT FOR CX_ORACLE 4.3.1</strong></div>
<div class="centerline" id="par1666" align="CENTER">
<strong>LICENSE AGREEMENT FOR CX_ORACLE HEAD</strong></div>
<p>
Copyright © 2007, Colt Engineering, Edmonton, Alberta, Canada.
All rights reserved.
<br>
Copyright © 2001-2007, Computronix (Canada) Ltd., Edmonton, Alberta, Canada.
All rights reserved.
@ -79,18 +83,18 @@ modification, are permitted provided that the following conditions are met:
<p>
</li>
<li>Neither the name of Computronix nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.
<li>Neither the names of the copyright holders nor the names of any
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
</li>
</ol>
<p>
DISCLAIMER:
THIS SOFTWARE IS PROVIDED BY COMPUTRONIX AND CONTRIBUTORS *AS IS*
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS*
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COMPUTRONIX
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
@ -138,7 +142,7 @@ Computronix (R) is a registered trademark of Computronix (Canada) Ltd.
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

50
html/lobobj.html
View File

@ -69,7 +69,14 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-123' xml:id='l2h-123' class="function">fileexists</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-139' xml:id='l2h-139' class="function">close</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Close the LOB. Call this when writing is completed so that the indexes
associated with the LOB can be updated.
</dl>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-140' xml:id='l2h-140' class="function">fileexists</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return a boolean indicating if the file referenced by the BFILE type LOB
@ -78,7 +85,16 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-124' xml:id='l2h-124' class="function">getfilename</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-141' xml:id='l2h-141' class="function">getchunksize</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the chunk size for the internal LOB. Reading and writing to the LOB
in chunks of multiples of this size will improve performance.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-142' xml:id='l2h-142' class="function">getfilename</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return a two-tuple consisting of the directory alias and file name for a
@ -87,7 +103,25 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-125' xml:id='l2h-125' class="function">read</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-143' xml:id='l2h-143' class="function">isopen</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return a boolean indicating if the LOB is opened.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-144' xml:id='l2h-144' class="function">open</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Open the LOB for writing. This will improve performance when writing to a LOB
in chunks and there are functional or extensible indexes associated with the
LOB.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-145' xml:id='l2h-145' class="function">read</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>offset = 1</var>, </var><big>[</big><var><var>amount</var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return a portion (or all) of the data in the LOB object.
@ -95,7 +129,7 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-126' xml:id='l2h-126' class="function">setfilename</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-146' xml:id='l2h-146' class="function">setfilename</tt></b>(</nobr></td>
<td><var><var>dirAlias</var>, <var>name</var></var>)</td></tr></table></dt>
<dd>
Set the directory alias and name of the BFILE type LOB.
@ -103,7 +137,7 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-127' xml:id='l2h-127' class="function">size</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-147' xml:id='l2h-147' class="function">size</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Returns the size of the data in the LOB object.
@ -111,7 +145,7 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-128' xml:id='l2h-128' class="function">trim</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-148' xml:id='l2h-148' class="function">trim</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>newSize = 0</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Trim the LOB to the new size.
@ -119,7 +153,7 @@ a subsequent fetch is detected.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-129' xml:id='l2h-129' class="function">write</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-149' xml:id='l2h-149' class="function">write</tt></b>(</nobr></td>
<td><var><var>data</var>, </var><big>[</big><var><var>offset = 1</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Write the data to the LOB object at the given offset. Note that if you want
@ -161,7 +195,7 @@ a subsequent fetch is detected.
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

50
html/module.html
View File

@ -9,7 +9,7 @@
<link rel="next" href="connobj.html" />
<link rel="prev" href="contents.html" />
<link rel="parent" href="cx_Oracle.html" />
<link rel="next" href="node4.html" />
<link rel="next" href="constants.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>1. Module Interface</title>
@ -26,7 +26,7 @@
href="cx_Oracle.html"><img src='up.png'
border='0' height='32' alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="1.1 Constants"
href="node4.html"><img src='next.png'
href="constants.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">cx_Oracle</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
@ -43,7 +43,7 @@
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node4.html">1.1 Constants</a>
<a class="sectref" rel="next" href="constants.html">1.1 Constants</a>
</div>
<hr /></div>
</div>
@ -64,7 +64,21 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-2' xml:id='l2h-2' class="function">Connection</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-2' xml:id='l2h-2' class="function">clientversion</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the version of the client library being used as a 5-tuple. The five
values are the major version, minor version, update number, patch number
and port update number.
<p>
<strong>NOTE:</strong> This method is an extension to the DB API definition and is
only available in Oracle 10g Release 2 and higher.
</dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-3' xml:id='l2h-3' class="function">Connection</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>user</var>, <var>password</var>,
<var>dsn</var>, <var>mode</var>, <var>handle</var>, <var>pool</var>, <var>threaded</var>,
<var>twophase</var></var><big>]</big><var></var>)</td></tr></table></dt>
@ -99,7 +113,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-4' xml:id='l2h-4' class="function">Cursor</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-5' xml:id='l2h-5' class="function">Cursor</tt></b>(</nobr></td>
<td><var><var>connection</var></var>)</td></tr></table></dt>
<dd>
Constructor for creating a cursor. Return a new Cursor object
@ -111,7 +125,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-5' xml:id='l2h-5' class="function">Date</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-6' xml:id='l2h-6' class="function">Date</tt></b>(</nobr></td>
<td><var><var>year</var>, <var>month</var>, <var>day</var></var>)</td></tr></table></dt>
<dd>
Construct an object holding a date value.
@ -119,7 +133,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-6' xml:id='l2h-6' class="function">DateFromTicks</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-7' xml:id='l2h-7' class="function">DateFromTicks</tt></b>(</nobr></td>
<td><var><var>ticks</var></var>)</td></tr></table></dt>
<dd>
Construct an object holding a date value from the given ticks value (number
@ -129,7 +143,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-7' xml:id='l2h-7' class="function">makedsn</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-8' xml:id='l2h-8' class="function">makedsn</tt></b>(</nobr></td>
<td><var><var>host</var>, <var>port</var>, <var>sid</var></var>)</td></tr></table></dt>
<dd>
Return a string suitable for use as the dsn for the connect() method. This
@ -142,7 +156,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-8' xml:id='l2h-8' class="function">SessionPool</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-9' xml:id='l2h-9' class="function">SessionPool</tt></b>(</nobr></td>
<td><var><var>user</var>, <var>password</var>, <var>database</var>,
<var>min</var>, <var>max</var>, <var>increment</var>, </var><big>[</big><var><var>connectiontype</var>,
<var>threaded</var>, <var>getmode=cx_Oracle.SPOOL_ATTRVAL_NOWAIT</var></var><big>]</big><var></var>)</td></tr></table></dt>
@ -166,7 +180,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-9' xml:id='l2h-9' class="function">Time</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-10' xml:id='l2h-10' class="function">Time</tt></b>(</nobr></td>
<td><var><var>hour</var>, <var>minute</var>, <var>second</var></var>)</td></tr></table></dt>
<dd>
Construct an object holding a time value.
@ -174,7 +188,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-10' xml:id='l2h-10' class="function">TimeFromTicks</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-11' xml:id='l2h-11' class="function">TimeFromTicks</tt></b>(</nobr></td>
<td><var><var>ticks</var></var>)</td></tr></table></dt>
<dd>
Construct an object holding a time value from the given ticks value (number
@ -184,7 +198,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-11' xml:id='l2h-11' class="function">Timestamp</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-12' xml:id='l2h-12' class="function">Timestamp</tt></b>(</nobr></td>
<td><var><var>year</var>, <var>month</var>, <var>day</var>,
<var>hour</var>, <var>minute</var>, <var>second</var></var>)</td></tr></table></dt>
<dd>
@ -193,7 +207,7 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-12' xml:id='l2h-12' class="function">TimestampFromTicks</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-13' xml:id='l2h-13' class="function">TimestampFromTicks</tt></b>(</nobr></td>
<td><var><var>ticks</var></var>)</td></tr></table></dt>
<dd>
Construct an object holding a time stamp value from the given ticks value
@ -209,8 +223,8 @@
<a name="CHILD_LINKS"><strong>Subsections</strong></a>
<ul class="ChildLinks">
<li><a href="node4.html">1.1 Constants</a>
<li><a href="node5.html">1.2 Exceptions</a>
<li><a href="constants.html">1.1 Constants</a>
<li><a href="exceptions.html">1.2 Exceptions</a>
</ul>
<!--End of Table of Child-Links-->
</div>
@ -227,7 +241,7 @@
href="cx_Oracle.html"><img src='up.png'
border='0' height='32' alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="1.1 Constants"
href="node4.html"><img src='next.png'
href="constants.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">cx_Oracle</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
@ -244,11 +258,11 @@
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="cx_Oracle.html">cx_Oracle</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node4.html">1.1 Constants</a>
<a class="sectref" rel="next" href="constants.html">1.1 Constants</a>
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

BIN
html/pyfav.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 240 B

30
html/sesspool.html
View File

@ -60,7 +60,7 @@ Oracle 9i.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-109' xml:id='l2h-109' class="function">acquire</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-125' xml:id='l2h-125' class="function">acquire</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Acquire a connection from the session pool and return a connection
@ -68,14 +68,14 @@ Oracle 9i.
</dl>
<p>
<dl><dt><b><tt id='l2h-110' xml:id='l2h-110'>busy</tt></b></dt>
<dl><dt><b><tt id='l2h-126' xml:id='l2h-126'>busy</tt></b></dt>
<dd>
This read-only attribute returns the number of sessions currently acquired.
</dd></dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-111' xml:id='l2h-111' class="function">drop</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-127' xml:id='l2h-127' class="function">drop</tt></b>(</nobr></td>
<td><var><var>connection</var></var>)</td></tr></table></dt>
<dd>
Drop the connection from the pool which is useful if the connection is no
@ -83,28 +83,28 @@ Oracle 9i.
</dl>
<p>
<dl><dt><b><tt id='l2h-112' xml:id='l2h-112'>dsn</tt></b></dt>
<dl><dt><b><tt id='l2h-128' xml:id='l2h-128'>dsn</tt></b></dt>
<dd>
This read-only attribute returns the TNS entry of the database to which a
connection has been established.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-113' xml:id='l2h-113'>increment</tt></b></dt>
<dl><dt><b><tt id='l2h-129' xml:id='l2h-129'>increment</tt></b></dt>
<dd>
This read-only attribute returns the number of sessions that will be
established when additional sessions need to be created.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-114' xml:id='l2h-114'>max</tt></b></dt>
<dl><dt><b><tt id='l2h-130' xml:id='l2h-130'>max</tt></b></dt>
<dd>
This read-only attribute returns the maximum number of sessions that the
session pool can control.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-115' xml:id='l2h-115'>min</tt></b></dt>
<dl><dt><b><tt id='l2h-131' xml:id='l2h-131'>min</tt></b></dt>
<dd>
This read-only attribute returns the number of sessions with which the
session pool was created and the minimum number of sessions that will be
@ -112,21 +112,21 @@ Oracle 9i.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-116' xml:id='l2h-116'>name</tt></b></dt>
<dl><dt><b><tt id='l2h-132' xml:id='l2h-132'>name</tt></b></dt>
<dd>
This read-only attribute returns the name assigned to the session pool by
Oracle.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-117' xml:id='l2h-117'>opened</tt></b></dt>
<dl><dt><b><tt id='l2h-133' xml:id='l2h-133'>opened</tt></b></dt>
<dd>
This read-only attribute returns the number of sessions currently opened by
the session pool.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-118' xml:id='l2h-118'>password</tt></b></dt>
<dl><dt><b><tt id='l2h-134' xml:id='l2h-134'>password</tt></b></dt>
<dd>
This read-only attribute returns the password of the user which established
the connection to the database.
@ -134,7 +134,7 @@ Oracle 9i.
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-119' xml:id='l2h-119' class="function">release</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-135' xml:id='l2h-135' class="function">release</tt></b>(</nobr></td>
<td><var><var>connection</var></var>)</td></tr></table></dt>
<dd>
Release the connection back to the pool. This will be done automatically as
@ -142,7 +142,7 @@ Oracle 9i.
</dl>
<p>
<dl><dt><b><tt id='l2h-120' xml:id='l2h-120'>timeout</tt></b></dt>
<dl><dt><b><tt id='l2h-136' xml:id='l2h-136'>timeout</tt></b></dt>
<dd>
This read-write attribute indicates the time (in seconds) after which idle
sessions will be terminated in order to maintain an optimum number of open
@ -150,14 +150,14 @@ Oracle 9i.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-121' xml:id='l2h-121'>tnsentry</tt></b></dt>
<dl><dt><b><tt id='l2h-137' xml:id='l2h-137'>tnsentry</tt></b></dt>
<dd>
This read-only attribute returns the TNS entry of the database to which a
connection has been established.
</dd></dl>
<p>
<dl><dt><b><tt id='l2h-122' xml:id='l2h-122'>username</tt></b></dt>
<dl><dt><b><tt id='l2h-138' xml:id='l2h-138'>username</tt></b></dt>
<dd>
This read-only attribute returns the name of the user which established the
connection to the database.
@ -198,7 +198,7 @@ Oracle 9i.
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->

10
html/varobj.html
View File

@ -58,7 +58,7 @@
<strong>NOTE:</strong> The DB API definition does not define this object.
<p>
<dl><dt><b><tt id='l2h-105' xml:id='l2h-105'>allocelems</tt></b></dt>
<dl><dt><b><tt id='l2h-121' xml:id='l2h-121'>allocelems</tt></b></dt>
<dd>
This read-only attribute returns the number of elements allocated in an
array, or the number of scalar items that can be fetched into the variable.
@ -66,21 +66,21 @@
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-106' xml:id='l2h-106' class="function">getvalue</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-122' xml:id='l2h-122' class="function">getvalue</tt></b>(</nobr></td>
<td><var></var><big>[</big><var><var>pos=0</var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return the value at the given position in the variable.
</dl>
<p>
<dl><dt><b><tt id='l2h-107' xml:id='l2h-107'>maxlength</tt></b></dt>
<dl><dt><b><tt id='l2h-123' xml:id='l2h-123'>maxlength</tt></b></dt>
<dd>
This read-only attribute returns the maximum length of the variable.
</dd></dl>
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-108' xml:id='l2h-108' class="function">setvalue</tt></b>(</nobr></td>
<td><nobr><b><tt id='l2h-124' xml:id='l2h-124' class="function">setvalue</tt></b>(</nobr></td>
<td><var><var>pos</var>, <var>value</var></var>)</td></tr></table></dt>
<dd>
Set the value at the given position in the variable.
@ -121,7 +121,7 @@
</div>
</div>
<hr />
<span class="release-info">Release 4.3.1, documentation updated on April 18, 2007.</span>
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
</div>
<!--End of Navigation Panel-->