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

Preparing to release version 5.0.

Browse Source
This commit is contained in:
Anthony Tuininga 2008-12-11 21:01:18 +00:00
parent 278b0ecf2a
commit e123e93576
19 changed files with 613 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/conf.py
View File

@ -40,9 +40,9 @@ copyright = '2008, Anthony Tuininga'
# other places throughout the built documents.
#
# The short X.Y version.
version = '4.4'
version = '5.0'
# The full version, including alpha/beta/rc tags.
release = '4.4'
release = '5.0'
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:

57
doc/connection.rst
View File

@ -74,6 +74,20 @@ Connection Object
Cancel a long-running transaction. This is only effective on non-Windows
platforms.
.. note::
This method is an extension to the DB API definition.
.. method:: Connection.changepassword(oldpassword, newpassword)
Change the password of the logon. This method also modifies the attribute
:data:`Connection.password` upon successful completion.
.. note::
This method is an extension to the DB API definition.
.. attribute:: Connection.clientinfo
@ -98,6 +112,15 @@ Connection Object
Commit any pending transactions to the database.
.. attribute:: Connection.current_schema
This read-write attribute sets the current schema attribute for the session.
.. note::
This attribute is an extension to the DB API definition.
.. method:: Connection.cursor()
Return a new Cursor object (:ref:`cursorobj`) using the connection.
@ -118,6 +141,21 @@ Connection Object
This read-only attribute returns the IANA character set name of the
character set in use by the Oracle client.
.. note::
This attribute is an extension to the DB API definition and is only
available in Python 2.x when not built in unicode mode.
.. attribute:: Connection.inputtypehandler
This read-write attribute specifies a method called for each value that is
bound to a statement executed on any cursor associated with this connection.
The method signature is handler(cursor, value, arraysize) and the return
value is expected to be a variable object or None in which case a default
variable object will be created. If this attribute is None, the default
behavior will take place for all values bound to statements.
.. note::
This attribute is an extension to the DB API definition.
@ -148,6 +186,21 @@ Connection Object
This read-only attribute returns the IANA character set name of the national
character set in use by the Oracle client.
.. note::
This attribute is an extension to the DB API definition and is only
available in Python 2.x when not built in unicode mode.
.. attribute:: Connection.outputtypehandler
This read-write attribute specifies a method called for each value that is
to be fetched from any cursor associated with this connection. The method
signature is handler(cursor, name, defaultType, length, precision, scale)
and the return value is expected to be a variable object or None in which
case a default variable object will be created. If this attribute is None,
the default behavior will take place for all values fetched from cursors.
.. note::
This attribute is an extension to the DB API definition.
@ -175,7 +228,9 @@ Connection Object
.. method:: Connection.prepare()
Prepare the distributed (global) transaction for commit.
Prepare the distributed (global) transaction for commit. Return a boolean
indicating if a transaction was actually prepared in order to avoid the
error ORA-24756 (transaction does not exist).
.. note::

52
doc/cursor.rst
View File

@ -230,6 +230,21 @@ Cursor Object
The DB API definition does not define this attribute.
.. attribute:: Cursor.inputtypehandler
This read-write attribute specifies a method called for each value that is
bound to a statement executed on the cursor and overrides the attribute with
the same name on the connection if specified. The method signature is
handler(cursor, value, arraysize) and the return value is expected to be a
variable object or None in which case a default variable object will be
created. If this attribute is None, the value of the attribute with the same
name on the connection is used.
.. note::
This attribute is an extension to the DB API definition.
.. method:: Cursor.__iter__()
Returns the cursor itself to be used as an iterator.
@ -264,6 +279,20 @@ Cursor Object
The DB API definition does not define this attribute.
.. attribute:: Cursor.outputtypehandler
This read-write attribute specifies a method called for each value that is
to be fetched from this cursor. The method signature is
handler(cursor, name, defaultType, length, precision, scale) and the return
value is expected to be a variable object or None in which case a default
variable object will be created. If this attribute is None, the value of
the attribute with the same name on the connection is used instead.
.. note::
This attribute is an extension to the DB API definition.
.. method:: Cursor.parse(statement)
This can be used to parse a statement without actually executing it (this
@ -336,15 +365,22 @@ Cursor Object
The DB API definition does not define this attribute.
.. method:: Cursor.var(dataType, [size])
.. method:: Cursor.var(dataType, [size, arraysize, inconverter, outconverter])
Create a variable associated with the cursor of the given type and size and
return a variable object (:ref:`varobj`). If the size is not specified and
the type is a string or binary, 4000 bytes (maximum allowable by Oracle) is
allocated; if the size is not specified and the type is a long string or
long binary, 128KB is allocated. This method was designed for use with
PL/SQL in/out variables where the length or type cannot be determined
automatically from the Python object passed in.
Create a variable associated with the cursor of the given type and
characteristics and return a variable object (:ref:`varobj`). If the size is
not specified and the type is a string or binary, 4000 bytes (maximum
allowable by Oracle) is allocated; if the size is not specified and the type
is a long string or long binary, 128KB is allocated. If the arraysize is not
specified, the bind array size (usually 1) is used. The inconverter and
outconverter specify methods used for converting values to/from the
database. More information can be found in the section on variable objects.
This method was designed for use with PL/SQL in/out variables where the
length or type cannot be determined automatically from the Python object
passed in or for use in input and output type handlers defined on cursors
or connections.
.. note::

113
doc/module.rst
View File

@ -23,30 +23,58 @@ Module Interface
available in Oracle 10g Release 2 and higher.
.. function:: Connection([user, password, dsn, mode, handle, pool, threaded, twophase])
connect([user, password, dsn, mode, handle, pool, threaded, twophase])
.. function:: Connection([user, password, dsn, mode, handle, pool, threaded, twophase, events, cclass, purity, newpassword])
connect([user, password, dsn, mode, handle, pool, threaded, twophase, events, cclass, purity, newpassword])
Constructor for creating a connection to the database. Return a Connection
object (:ref:`connobj`). All arguments are optional and can be specified as
keyword parameters. The dsn (data source name) is the TNS entry (from the
Oracle names server or tnsnames.ora file) or is a string like the one
returned from makedsn(). If only one parameter is passed, a connect string
is assumed which is to be of the format ``user/password@dsn``, the same
format accepted by Oracle applications such as SQL\*Plus. If the mode is
specified, it must be one of :data:`SYSDBA` or :data:`SYSOPER` which are
defined at the module level; otherwise it defaults to the normal mode of
connecting. If the handle is specified, it must be of type OCISvcCtx\* and
is only of use when embedding Python in an application (like PowerBuilder)
which has already made the connection. The pool is only valid in Oracle 9i
and is a session pool object (:ref:`sesspool`) which is the equivalent of
calling pool.acquire(). The threaded attribute is expected to be a boolean
expression which indicates whether or not Oracle should use the mode
OCI_THREADED to wrap accesses to connections with a mutex. Doing so in
single threaded applications imposes a performance penalty of about 10-15%
which is why the default is False. The twophase attribute is expected to be
a boolean expression which indicates whether or not the attributes should be
set on the connection object to allow for two phase commit. The default for
this value is also False because of bugs in Oracle prior to Oracle 10g.
keyword parameters.
The dsn (data source name) is the TNS entry (from the Oracle names server or
tnsnames.ora file) or is a string like the one returned from makedsn(). If
only one parameter is passed, a connect string is assumed which is to be of
the format ``user/password@dsn``, the same format accepted by Oracle
applications such as SQL\*Plus.
If the mode is specified, it must be one of :data:`SYSDBA` or
:data:`SYSOPER` which are defined at the module level; otherwise it defaults
to the normal mode of connecting.
If the handle is specified, it must be of type OCISvcCtx\* and is only of
use when embedding Python in an application (like PowerBuilder) which has
already made the connection.
The pool argument is expected to be a session pool object (:ref:`sesspool`)
and the use of this argument is the equivalent of calling pool.acquire().
The threaded argument is expected to be a boolean expression which
indicates whether or not Oracle should use the mode OCI_THREADED to wrap
accesses to connections with a mutex. Doing so in single threaded
applications imposes a performance penalty of about 10-15% which is why the
default is False.
The twophase argument is expected to be a boolean expression which
indicates whether or not the attributes should be set on the connection
object to allow for two phase commit. The default for this value is also
False because of bugs in Oracle prior to Oracle 10g.
The events argument is expected to be a boolean expression which indicates
whether or not to initialize Oracle in events mode (only available in Oracle
11g and higher).
The cclass argument is expected to be a string and defines the connection
class for database resident connection pooling (DRCP) in Oracle 11g and
higher.
The purity argument is expected to be one of :data:`ATTR_PURITY_NEW` (the
session must be new without any prior session state),
:data:`ATTR_PURITY_NEW` (the session may have been used before) or
:data:`ATTR_PURITY_DEFAULT` (the default behavior which is defined by Oracle
in its documentation). This argument is only relevant in Oracle 11g and
higher.
The newpassword argument is expected to be a string if specified and sets
the password for the logon during the connection process.
.. function:: Cursor(connection)
@ -138,6 +166,39 @@ Constants
String constant stating the supported DB API level. Currently '2.0'.
.. data:: ATTR_PURITY_DEFAULT
This constant is used when using database resident connection pooling (DRCP)
and specifies that the purity of the session is the default value used by
Oracle (see Oracle's documentation for more information).
.. note::
This attribute is an extension to the DB API definition.
.. data:: ATTR_PURITY_NEW
This constant is used when using database resident connection pooling (DRCP)
and specifies that the session acquired from the pool should be new and not
have any prior session state.
.. note::
This attribute is an extension to the DB API definition.
.. data:: ATTR_PURITY_SELF
This constant is used when using database resident connection pooling (DRCP)
and specifies that the session acquired from the pool need not be new and
may have prior session state.
.. note::
This attribute is an extension to the DB API definition.
.. data:: buildtime
String constant stating the time when the binary was built.
@ -326,6 +387,16 @@ Constants
This attribute is an extension to the DB API definition.
.. data:: INTERVAL
This type object is used to describe columns in a database that are of type
interval day to second.
.. note::
This attribute is an extension to the DB API definition.
.. data:: LOB
This type object is the Python type of :data:`BLOB` and :data:`CLOB` data

16
doc/variable.rst
View File

@ -21,11 +21,27 @@ Variable Objects
Return the value at the given position in the variable.
.. attribute:: Variable.inconverter
This read-write attribute specifies the method used to convert data from
Python to the Oracle database. The method signature is converter(value)
and the expected return value is the value to bind to the database. If this
attribute is None, the value is bound directly without any conversion.
.. attribute:: Variable.maxlength
This read-only attribute returns the maximum length of the variable.
.. attribute:: Variable.outconverter
This read-write attribute specifies the method used to convert data from
from the Oracle to Python. The method signature is converter(value)
and the expected return value is the value to return to Python. If this
attribute is None, the value is returned directly without any conversion.
.. method:: Variable.setvalue(pos, value)
Set the value at the given position in the variable.

82
html/connection.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Connection Object &mdash; cx_Oracle v4.4 documentation</title>
<title>Connection Object &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="Cursor Object" href="cursor.html" />
<link rel="prev" title="Module Interface" href="module.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="cursor.html" title="Cursor Object" accesskey="N">next</a> |</li>
<li class="right"><a href="module.html" title="Module Interface" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -111,8 +111,24 @@ the comments on the Connection constructor for more information
<dl class="method">
<dt id="Connection.cancel">
<!--#Connection.cancel#--><tt class="descclassname">Connection.</tt><tt class="descname">cancel</tt><big>(</big><big>)</big><a class="headerlink" href="#Connection.cancel" title="Permalink to this definition"></a></dt>
<dd>Cancel a long-running transaction. This is only effective on non-Windows
platforms.</dd></dl>
<dd><p>Cancel a long-running transaction. This is only effective on non-Windows
platforms.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This method is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="Connection.changepassword">
<!--#Connection.changepassword#--><tt class="descclassname">Connection.</tt><tt class="descname">changepassword</tt><big>(</big><em>oldpassword</em>, <em>newpassword</em><big>)</big><a class="headerlink" href="#Connection.changepassword" title="Permalink to this definition"></a></dt>
<dd><p>Change the password of the logon. This method also modifies the attribute
<a title="Connection.password" class="reference" href="#Connection.password"><tt class="xref docutils literal"><span class="pre">Connection.password</span></tt></a> upon successful completion.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This method is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Connection.clientinfo">
@ -138,6 +154,16 @@ applies to any cursor objects trying to use the connection.</dd></dl>
<!--#Connection.commit#--><tt class="descclassname">Connection.</tt><tt class="descname">commit</tt><big>(</big><big>)</big><a class="headerlink" href="#Connection.commit" title="Permalink to this definition"></a></dt>
<dd>Commit any pending transactions to the database.</dd></dl>
<dl class="attribute">
<dt id="Connection.current_schema">
<!--#Connection.current_schema#--><tt class="descclassname">Connection.</tt><tt class="descname">current_schema</tt><a class="headerlink" href="#Connection.current_schema" title="Permalink to this definition"></a></dt>
<dd><p>This read-write attribute sets the current schema attribute for the session.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="Connection.cursor">
<!--#Connection.cursor#--><tt class="descclassname">Connection.</tt><tt class="descname">cursor</tt><big>(</big><big>)</big><a class="headerlink" href="#Connection.cursor" title="Permalink to this definition"></a></dt>
@ -161,6 +187,22 @@ connection has been established.</p>
character set in use by the Oracle client.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition and is only
available in Python 2.x when not built in unicode mode.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Connection.inputtypehandler">
<!--#Connection.inputtypehandler#--><tt class="descclassname">Connection.</tt><tt class="descname">inputtypehandler</tt><a class="headerlink" href="#Connection.inputtypehandler" title="Permalink to this definition"></a></dt>
<dd><p>This read-write attribute specifies a method called for each value that is
bound to a statement executed on any cursor associated with this connection.
The method signature is handler(cursor, value, arraysize) and the return
value is expected to be a variable object or None in which case a default
variable object will be created. If this attribute is None, the default
behavior will take place for all values bound to statements.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
@ -190,6 +232,22 @@ is only available in Oracle 10g.</p>
character set in use by the Oracle client.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition and is only
available in Python 2.x when not built in unicode mode.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Connection.outputtypehandler">
<!--#Connection.outputtypehandler#--><tt class="descclassname">Connection.</tt><tt class="descname">outputtypehandler</tt><a class="headerlink" href="#Connection.outputtypehandler" title="Permalink to this definition"></a></dt>
<dd><p>This read-write attribute specifies a method called for each value that is
to be fetched from any cursor associated with this connection. The method
signature is handler(cursor, name, defaultType, length, precision, scale)
and the return value is expected to be a variable object or None in which
case a default variable object will be created. If this attribute is None,
the default behavior will take place for all values fetched from cursors.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
@ -197,8 +255,8 @@ character set in use by the Oracle client.</p>
<dl class="attribute">
<dt id="Connection.password">
<!--#Connection.password#--><tt class="descclassname">Connection.</tt><tt class="descname">password</tt><a class="headerlink" href="#Connection.password" title="Permalink to this definition"></a></dt>
<dd><p>This read-only attribute returns the password of the user which established
the connection to the database.</p>
<dd><p>This read-write attribute initially contains the password of the user which
established the connection to the database.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
@ -219,7 +277,9 @@ available in Oracle 10g R2 and higher.</p>
<dl class="method">
<dt id="Connection.prepare">
<!--#Connection.prepare#--><tt class="descclassname">Connection.</tt><tt class="descname">prepare</tt><big>(</big><big>)</big><a class="headerlink" href="#Connection.prepare" title="Permalink to this definition"></a></dt>
<dd><p>Prepare the distributed (global) transaction for commit.</p>
<dd><p>Prepare the distributed (global) transaction for commit. Return a boolean
indicating if a transaction was actually prepared in order to avoid the
error ORA-24756 (transaction does not exist).</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This method is an extension to the DB API definition.</p>
@ -370,12 +430,12 @@ connection has been established.</p>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="cursor.html" title="Cursor Object" accesskey="N">next</a> |</li>
<li class="right"><a href="module.html" title="Module Interface" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

93
html/cursor.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Cursor Object &mdash; cx_Oracle v4.4 documentation</title>
<title>Cursor Object &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="Variable Objects" href="variable.html" />
<link rel="prev" title="Connection Object" href="connection.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="variable.html" title="Variable Objects" accesskey="N">next</a> |</li>
<li class="right"><a href="connection.html" title="Connection Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -92,6 +92,19 @@ statement must have been prepared first.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Cursor.bindvars">
<!--#Cursor.bindvars#--><tt class="descclassname">Cursor.</tt><tt class="descname">bindvars</tt><a class="headerlink" href="#Cursor.bindvars" title="Permalink to this definition"></a></dt>
<dd><p>This read-only attribute specifies the bind variables used for the last
execute. The value will be either a list or a dictionary depending on
whether binding was done by position or name. Care should be taken when
referencing this attribute. In particular, elements should not be removed.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The DB API definition does not define this attribute.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="Cursor.callfunc">
<!--#Cursor.callfunc#--><tt class="descclassname">Cursor.</tt><tt class="descname">callfunc</tt><big>(</big><em>name</em>, <em>returnType</em><span class="optional">[</span>, <em>parameters=</em><span class="optional">[</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#Cursor.callfunc" title="Permalink to this definition"></a></dt>
@ -155,7 +168,9 @@ sequence the values will be bound by position.</p>
same string object is passed in again, the cursor will execute that
statement again without performing a prepare or rebinding and redefining.
This is most effective for algorithms where the same statement is used, but
different parameters are bound to it (many times).</p>
different parameters are bound to it (many times). Note that parameters that
are not passed in during subsequent executions will retain the value passed
in during the last execution that contained them.</p>
<p>For maximum efficiency when reusing an statement, it is best to use the
setinputsizes() method to specify the parameter types and sizes ahead of
time; in particular, None is assumed to be a string of length 1 so any
@ -239,6 +254,34 @@ result set or no call was issued yet.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Cursor.fetchvars">
<!--#Cursor.fetchvars#--><tt class="descclassname">Cursor.</tt><tt class="descname">fetchvars</tt><a class="headerlink" href="#Cursor.fetchvars" title="Permalink to this definition"></a></dt>
<dd><p>This read-only attribute specifies the list of variables created for the
last query that was executed on the cursor. Care should be taken when
referencing this attribute. In particular, elements should not be removed.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The DB API definition does not define this attribute.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Cursor.inputtypehandler">
<!--#Cursor.inputtypehandler#--><tt class="descclassname">Cursor.</tt><tt class="descname">inputtypehandler</tt><a class="headerlink" href="#Cursor.inputtypehandler" title="Permalink to this definition"></a></dt>
<dd><p>This read-write attribute specifies a method called for each value that is
bound to a statement executed on the cursor and overrides the attribute with
the same name on the connection if specified. The method signature is
handler(cursor, value, arraysize) and the return value is expected to be a
variable object or None in which case a default variable object will be
created. If this attribute is None, the value of the attribute with the same
name on the connection is used.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="Cursor.__iter__">
<!--#Cursor.__iter__#--><tt class="descclassname">Cursor.</tt><tt class="descname">__iter__</tt><big>(</big><big>)</big><a class="headerlink" href="#Cursor.__iter__" title="Permalink to this definition"></a></dt>
@ -276,6 +319,21 @@ the SQL being executed.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Cursor.outputtypehandler">
<!--#Cursor.outputtypehandler#--><tt class="descclassname">Cursor.</tt><tt class="descname">outputtypehandler</tt><a class="headerlink" href="#Cursor.outputtypehandler" title="Permalink to this definition"></a></dt>
<dd><p>This read-write attribute specifies a method called for each value that is
to be fetched from this cursor. The method signature is
handler(cursor, name, defaultType, length, precision, scale) and the return
value is expected to be a variable object or None in which case a default
variable object will be created. If this attribute is None, the value of
the attribute with the same name on the connection is used instead.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="Cursor.parse">
<!--#Cursor.parse#--><tt class="descclassname">Cursor.</tt><tt class="descname">parse</tt><big>(</big><em>statement</em><big>)</big><a class="headerlink" href="#Cursor.parse" title="Permalink to this definition"></a></dt>
@ -354,14 +412,19 @@ prepared with prepare() or executed with execute().</p>
<dl class="method">
<dt id="Cursor.var">
<!--#Cursor.var#--><tt class="descclassname">Cursor.</tt><tt class="descname">var</tt><big>(</big><em>dataType</em><span class="optional">[</span>, <em>size</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Cursor.var" title="Permalink to this definition"></a></dt>
<dd><p>Create a variable associated with the cursor of the given type and size and
return a variable object (<a class="reference" href="variable.html#varobj"><em>Variable Objects</em></a>). If the size is not specified and
the type is a string or binary, 4000 bytes (maximum allowable by Oracle) is
allocated; if the size is not specified and the type is a long string or
long binary, 128KB is allocated. This method was designed for use with
PL/SQL in/out variables where the length or type cannot be determined
automatically from the Python object passed in.</p>
<!--#Cursor.var#--><tt class="descclassname">Cursor.</tt><tt class="descname">var</tt><big>(</big><em>dataType</em><span class="optional">[</span>, <em>size</em>, <em>arraysize</em>, <em>inconverter</em>, <em>outconverter</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Cursor.var" title="Permalink to this definition"></a></dt>
<dd><p>Create a variable associated with the cursor of the given type and
characteristics and return a variable object (<a class="reference" href="variable.html#varobj"><em>Variable Objects</em></a>). If the size is
not specified and the type is a string or binary, 4000 bytes (maximum
allowable by Oracle) is allocated; if the size is not specified and the type
is a long string or long binary, 128KB is allocated. If the arraysize is not
specified, the bind array size (usually 1) is used. The inconverter and
outconverter specify methods used for converting values to/from the
database. More information can be found in the section on variable objects.</p>
<p>This method was designed for use with PL/SQL in/out variables where the
length or type cannot be determined automatically from the Python object
passed in or for use in input and output type handlers defined on cursors
or connections.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The DB API definition does not define this method.</p>
@ -397,12 +460,12 @@ automatically from the Python object passed in.</p>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="variable.html" title="Variable Objects" accesskey="N">next</a> |</li>
<li class="right"><a href="connection.html" title="Connection Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

12
html/date.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Date Object &mdash; cx_Oracle v4.4 documentation</title>
<title>Date Object &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="License" href="license.html" />
<link rel="prev" title="LOB Objects" href="lob.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="license.html" title="License" accesskey="N">next</a> |</li>
<li class="right"><a href="lob.html" title="LOB Objects" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -115,12 +115,12 @@ standard library datetime module instead of these objects.</p>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="license.html" title="License" accesskey="N">next</a> |</li>
<li class="right"><a href="lob.html" title="LOB Objects" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

52
html/genindex.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; cx_Oracle v4.4 documentation</title>
<title>Index &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -25,7 +25,7 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -57,9 +57,12 @@
<dt><a href="session_pool.html#SessionPool.acquire">acquire() (SessionPool method)</a></dt>
<dt><a href="connection.html#Connection.action">action (Connection attribute)</a></dt>
<dt><a href="variable.html#Variable.allocelems">allocelems (Variable attribute)</a></dt>
<dt><a href="module.html#cx_Oracle.apilevel">apilevel (in module cx_Oracle)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="module.html#cx_Oracle.apilevel">apilevel (in module cx_Oracle)</a></dt>
<dt><a href="cursor.html#Cursor.arraysize">arraysize (Cursor attribute)</a></dt>
<dt><a href="cursor.html#Cursor.arrayvar">arrayvar() (Cursor method)</a></dt>
<dt><a href="cursor.html#Cursor.arrayvar">arrayvar() (Cursor method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="module.html#cx_Oracle.ATTR_PURITY_DEFAULT">ATTR_PURITY_DEFAULT (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.ATTR_PURITY_NEW">ATTR_PURITY_NEW (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.ATTR_PURITY_SELF">ATTR_PURITY_SELF (in module cx_Oracle)</a></dt>
<dt><a href="connection.html#Connection.autocommit">autocommit (Connection attribute)</a></dt>
</dl></td></tr></table>
@ -71,8 +74,9 @@
<dt><a href="module.html#cx_Oracle.BFILE">BFILE (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.BINARY">BINARY (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.Binary">Binary() (in module cx_Oracle)</a></dt>
<dt><a href="cursor.html#Cursor.bindarraysize">bindarraysize (Cursor attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="cursor.html#Cursor.bindnames">bindnames() (Cursor method)</a></dt>
<dt><a href="cursor.html#Cursor.bindarraysize">bindarraysize (Cursor attribute)</a></dt>
<dt><a href="cursor.html#Cursor.bindnames">bindnames() (Cursor method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="cursor.html#Cursor.bindvars">bindvars (Cursor attribute)</a></dt>
<dt><a href="module.html#cx_Oracle.BLOB">BLOB (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.buildtime">buildtime (in module cx_Oracle)</a></dt>
<dt><a href="session_pool.html#SessionPool.busy">busy (SessionPool attribute)</a></dt>
@ -85,6 +89,7 @@
<dt><a href="cursor.html#Cursor.callfunc">callfunc() (Cursor method)</a></dt>
<dt><a href="cursor.html#Cursor.callproc">callproc() (Cursor method)</a></dt>
<dt><a href="connection.html#Connection.cancel">cancel() (Connection method)</a></dt>
<dt><a href="connection.html#Connection.changepassword">changepassword() (Connection method)</a></dt>
<dt><a href="connection.html#Connection.clientinfo">clientinfo (Connection attribute)</a></dt>
<dt><a href="module.html#cx_Oracle.clientversion">clientversion() (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.CLOB">CLOB (in module cx_Oracle)</a></dt>
@ -93,10 +98,13 @@
<dt><a href="cursor.html#Cursor.close">(Cursor method)</a></dt>
<dt><a href="lob.html#LOB.close">(LOB method)</a></dt>
</dl></dd>
<dt><a href="module.html#cx_Oracle._Error.code">code (cx_Oracle._Error attribute)</a></dt>
<dt><a href="connection.html#Connection.commit">commit() (Connection method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="module.html#cx_Oracle.connect">connect() (in module cx_Oracle)</a></dt>
<dt><a href="cursor.html#Cursor.connection">connection() (Cursor method)</a></dt>
<dt><a href="module.html#cx_Oracle.Connection">Connection() (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle._Error.context">context (cx_Oracle._Error attribute)</a></dt>
<dt><a href="connection.html#Connection.current_schema">current_schema (Connection attribute)</a></dt>
<dt><a href="module.html#cx_Oracle.CURSOR">CURSOR (in module cx_Oracle)</a></dt>
<dt><a href="connection.html#Connection.cursor">cursor() (Connection method)</a></dt>
<dt><a href="module.html#cx_Oracle.Cursor">Cursor() (in module cx_Oracle)</a></dt>
@ -145,6 +153,7 @@
<dt><a href="cursor.html#Cursor.fetchmany">fetchmany() (Cursor method)</a></dt>
<dt><a href="cursor.html#Cursor.fetchone">fetchone() (Cursor method)</a></dt>
<dt><a href="cursor.html#Cursor.fetchraw">fetchraw() (Cursor method)</a></dt>
<dt><a href="cursor.html#Cursor.fetchvars">fetchvars (Cursor attribute)</a></dt>
<dt><a href="lob.html#LOB.fileexists">fileexists() (LOB method)</a></dt>
<dt><a href="module.html#cx_Oracle.FIXED_CHAR">FIXED_CHAR (in module cx_Oracle)</a></dt>
<dt><a href="module.html#cx_Oracle.FNCODE_BINDBYNAME">FNCODE_BINDBYNAME (in module cx_Oracle)</a></dt></dl></td><td width="33%" valign="top"><dl>
@ -169,6 +178,7 @@
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="session_pool.html#SessionPool.homogeneous">homogeneous (SessionPool attribute)</a></dt>
<dt><a href="date.html#Date.hour">hour (Date attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
@ -176,10 +186,16 @@
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="variable.html#Variable.inconverter">inconverter (Variable attribute)</a></dt>
<dt><a href="session_pool.html#SessionPool.increment">increment (SessionPool attribute)</a></dt>
<dt><a href="module.html#cx_Oracle.IntegrityError">IntegrityError</a></dt>
<dt><a href="module.html#cx_Oracle.InterfaceError">InterfaceError</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="connection.html#Connection.inputtypehandler">inputtypehandler (Connection attribute)</a></dt>
<dd><dl>
<dt><a href="cursor.html#Cursor.inputtypehandler">(Cursor attribute)</a></dt>
</dl></dd>
<dt><a href="module.html#cx_Oracle.IntegrityError">IntegrityError</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="module.html#cx_Oracle.InterfaceError">InterfaceError</a></dt>
<dt><a href="module.html#cx_Oracle.InternalError">InternalError</a></dt>
<dt><a href="module.html#cx_Oracle.INTERVAL">INTERVAL (in module cx_Oracle)</a></dt>
<dt><a href="lob.html#LOB.isopen">isopen() (LOB method)</a></dt>
</dl></td></tr></table>
@ -200,7 +216,8 @@
<dt><a href="session_pool.html#SessionPool.max">max (SessionPool attribute)</a></dt>
<dt><a href="connection.html#Connection.maxBytesPerCharacter">maxBytesPerCharacter (Connection attribute)</a></dt>
<dt><a href="variable.html#Variable.maxlength">maxlength (Variable attribute)</a></dt>
<dt><a href="session_pool.html#SessionPool.min">min (SessionPool attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="module.html#cx_Oracle._Error.message">message (cx_Oracle._Error attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="session_pool.html#SessionPool.min">min (SessionPool attribute)</a></dt>
<dt><a href="date.html#Date.minute">minute (Date attribute)</a></dt>
<dt><a href="connection.html#Connection.module">module (Connection attribute)</a></dt>
<dt><a href="date.html#Date.month">month (Date attribute)</a></dt>
@ -226,8 +243,13 @@
<dt><a href="module.html#cx_Oracle.OBJECT">OBJECT (in module cx_Oracle)</a></dt>
<dt><a href="lob.html#LOB.open">open() (LOB method)</a></dt>
<dt><a href="session_pool.html#SessionPool.opened">opened (SessionPool attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="module.html#cx_Oracle.OperationalError">OperationalError</a></dt>
<dt><a href="session_pool.html#SessionPool.opened">opened (SessionPool attribute)</a></dt>
<dt><a href="module.html#cx_Oracle.OperationalError">OperationalError</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="variable.html#Variable.outconverter">outconverter (Variable attribute)</a></dt>
<dt><a href="connection.html#Connection.outputtypehandler">outputtypehandler (Connection attribute)</a></dt>
<dd><dl>
<dt><a href="cursor.html#Cursor.outputtypehandler">(Cursor attribute)</a></dt>
</dl></dd>
</dl></td></tr></table>
<h2 id="P">P</h2>
@ -365,12 +387,12 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

15
html/index.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>cx_Oracle &mdash; cx_Oracle v4.4 documentation</title>
<title>cx_Oracle &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="" />
</head>
<body>
<div class="related">
@ -25,7 +25,7 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -42,7 +42,7 @@
<tbody valign="top">
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Anthony Tuininga</td>
</tr>
<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 06, 2008</td>
<tr class="field"><th class="field-name">Date:</th><td class="field-body">December 11, 2008</td>
</tr>
</tbody>
</table>
@ -64,6 +64,7 @@ for more information on the Python database API specification.</p>
<li><a class="reference" href="module.html">Module Interface</a><ul>
<li><a class="reference" href="module.html#id1">Constants</a></li>
<li><a class="reference" href="module.html#id2">Exceptions</a></li>
<li><a class="reference" href="module.html#exception-handling">Exception handling</a></li>
</ul>
</li>
</ul>
@ -122,12 +123,12 @@ for more information on the Python database API specification.</p>
<ul>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

12
html/license.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>License &mdash; cx_Oracle v4.4 documentation</title>
<title>License &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="cx_Oracle" href="index.html" />
<link rel="prev" title="Date Object" href="date.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="index.html" title="cx_Oracle" accesskey="N">next</a> |</li>
<li class="right"><a href="date.html" title="Date Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -97,12 +97,12 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="index.html" title="cx_Oracle" accesskey="N">next</a> |</li>
<li class="right"><a href="date.html" title="Date Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

12
html/lob.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>LOB Objects &mdash; cx_Oracle v4.4 documentation</title>
<title>LOB Objects &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="Date Object" href="date.html" />
<link rel="prev" title="SessionPool Object" href="session_pool.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="date.html" title="Date Object" accesskey="N">next</a> |</li>
<li class="right"><a href="session_pool.html" title="SessionPool Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -146,12 +146,12 @@ to make the LOB value smaller, you must use the trim() function.</dd></dl>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="date.html" title="Date Object" accesskey="N">next</a> |</li>
<li class="right"><a href="session_pool.html" title="SessionPool Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

12
html/modindex.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Global Module Index &mdash; cx_Oracle v4.4 documentation</title>
<title>Global Module Index &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -25,7 +25,7 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -67,12 +67,12 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

172
html/module.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Module Interface &mdash; cx_Oracle v4.4 documentation</title>
<title>Module Interface &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="Connection Object" href="connection.html" />
<link rel="prev" title="cx_Oracle" href="index.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="connection.html" title="Connection Object" accesskey="N">next</a> |</li>
<li class="right"><a href="index.html" title="cx_Oracle" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -60,30 +60,49 @@ available in Oracle 10g Release 2 and higher.</p>
<dl class="function">
<dt id="cx_Oracle.Connection">
<!--#cx_Oracle.Connection#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">Connection</tt><big>(</big><span class="optional">[</span><em>user</em>, <em>password</em>, <em>dsn</em>, <em>mode</em>, <em>handle</em>, <em>pool</em>, <em>threaded</em>, <em>twophase</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#cx_Oracle.Connection" title="Permalink to this definition"></a></dt>
<!--#cx_Oracle.Connection#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">Connection</tt><big>(</big><span class="optional">[</span><em>user</em>, <em>password</em>, <em>dsn</em>, <em>mode</em>, <em>handle</em>, <em>pool</em>, <em>threaded</em>, <em>twophase</em>, <em>events</em>, <em>cclass</em>, <em>purity</em>, <em>newpassword</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#cx_Oracle.Connection" title="Permalink to this definition"></a></dt>
<dt id="cx_Oracle.connect">
<tt class="descclassname">cx_Oracle.</tt><tt class="descname">connect</tt><big>(</big><span class="optional">[</span><em>user</em>, <em>password</em>, <em>dsn</em>, <em>mode</em>, <em>handle</em>, <em>pool</em>, <em>threaded</em>, <em>twophase</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#cx_Oracle.connect" title="Permalink to this definition"></a></dt>
<dd>Constructor for creating a connection to the database. Return a Connection
<tt class="descclassname">cx_Oracle.</tt><tt class="descname">connect</tt><big>(</big><span class="optional">[</span><em>user</em>, <em>password</em>, <em>dsn</em>, <em>mode</em>, <em>handle</em>, <em>pool</em>, <em>threaded</em>, <em>twophase</em>, <em>events</em>, <em>cclass</em>, <em>purity</em>, <em>newpassword</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#cx_Oracle.connect" title="Permalink to this definition"></a></dt>
<dd><p>Constructor for creating a connection to the database. Return a Connection
object (<a class="reference" href="connection.html#connobj"><em>Connection Object</em></a>). All arguments are optional and can be specified as
keyword parameters. The dsn (data source name) is the TNS entry (from the
Oracle names server or tnsnames.ora file) or is a string like the one
returned from makedsn(). If only one parameter is passed, a connect string
is assumed which is to be of the format <tt class="docutils literal"><span class="pre">user/password&#64;dsn</span></tt>, the same
format accepted by Oracle applications such as SQL*Plus. If the mode is
specified, it must be one of <a title="cx_Oracle.SYSDBA" class="reference" href="#cx_Oracle.SYSDBA"><tt class="xref docutils literal"><span class="pre">SYSDBA</span></tt></a> or <a title="cx_Oracle.SYSOPER" class="reference" href="#cx_Oracle.SYSOPER"><tt class="xref docutils literal"><span class="pre">SYSOPER</span></tt></a> which are
defined at the module level; otherwise it defaults to the normal mode of
connecting. If the handle is specified, it must be of type OCISvcCtx* and
is only of use when embedding Python in an application (like PowerBuilder)
which has already made the connection. The pool is only valid in Oracle 9i
and is a session pool object (<a class="reference" href="session_pool.html#sesspool"><em>SessionPool Object</em></a>) which is the equivalent of
calling pool.acquire(). The threaded attribute is expected to be a boolean
expression which indicates whether or not Oracle should use the mode
OCI_THREADED to wrap accesses to connections with a mutex. Doing so in
single threaded applications imposes a performance penalty of about 10-15%
which is why the default is False. The twophase attribute is expected to be
a boolean expression which indicates whether or not the attributes should be
set on the connection object to allow for two phase commit. The default for
this value is also False because of bugs in Oracle prior to Oracle 10g.</dd></dl>
keyword parameters.</p>
<p>The dsn (data source name) is the TNS entry (from the Oracle names server or
tnsnames.ora file) or is a string like the one returned from makedsn(). If
only one parameter is passed, a connect string is assumed which is to be of
the format <tt class="docutils literal"><span class="pre">user/password&#64;dsn</span></tt>, the same format accepted by Oracle
applications such as SQL*Plus.</p>
<p>If the mode is specified, it must be one of <a title="cx_Oracle.SYSDBA" class="reference" href="#cx_Oracle.SYSDBA"><tt class="xref docutils literal"><span class="pre">SYSDBA</span></tt></a> or
<a title="cx_Oracle.SYSOPER" class="reference" href="#cx_Oracle.SYSOPER"><tt class="xref docutils literal"><span class="pre">SYSOPER</span></tt></a> which are defined at the module level; otherwise it defaults
to the normal mode of connecting.</p>
<p>If the handle is specified, it must be of type OCISvcCtx* and is only of
use when embedding Python in an application (like PowerBuilder) which has
already made the connection.</p>
<p>The pool argument is expected to be a session pool object (<a class="reference" href="session_pool.html#sesspool"><em>SessionPool Object</em></a>)
and the use of this argument is the equivalent of calling pool.acquire().</p>
<p>The threaded argument is expected to be a boolean expression which
indicates whether or not Oracle should use the mode OCI_THREADED to wrap
accesses to connections with a mutex. Doing so in single threaded
applications imposes a performance penalty of about 10-15% which is why the
default is False.</p>
<p>The twophase argument is expected to be a boolean expression which
indicates whether or not the attributes should be set on the connection
object to allow for two phase commit. The default for this value is also
False because of bugs in Oracle prior to Oracle 10g.</p>
<p>The events argument is expected to be a boolean expression which indicates
whether or not to initialize Oracle in events mode (only available in Oracle
11g and higher).</p>
<p>The cclass argument is expected to be a string and defines the connection
class for database resident connection pooling (DRCP) in Oracle 11g and
higher.</p>
<p>The purity argument is expected to be one of <a title="cx_Oracle.ATTR_PURITY_NEW" class="reference" href="#cx_Oracle.ATTR_PURITY_NEW"><tt class="xref docutils literal"><span class="pre">ATTR_PURITY_NEW</span></tt></a> (the
session must be new without any prior session state),
<a title="cx_Oracle.ATTR_PURITY_NEW" class="reference" href="#cx_Oracle.ATTR_PURITY_NEW"><tt class="xref docutils literal"><span class="pre">ATTR_PURITY_NEW</span></tt></a> (the session may have been used before) or
<a title="cx_Oracle.ATTR_PURITY_DEFAULT" class="reference" href="#cx_Oracle.ATTR_PURITY_DEFAULT"><tt class="xref docutils literal"><span class="pre">ATTR_PURITY_DEFAULT</span></tt></a> (the default behavior which is defined by Oracle
in its documentation). This argument is only relevant in Oracle 11g and
higher.</p>
<p>The newpassword argument is expected to be a string if specified and sets
the password for the logon during the connection process.</p>
</dd></dl>
<dl class="function">
<dt id="cx_Oracle.Cursor">
@ -122,7 +141,7 @@ server or defined in the tnsnames.ora file.</p>
<dl class="function">
<dt id="cx_Oracle.SessionPool">
<!--#cx_Oracle.SessionPool#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">SessionPool</tt><big>(</big><em>user</em>, <em>password</em>, <em>database</em>, <em>min</em>, <em>max</em>, <em>increment</em><span class="optional">[</span>, <em>connectiontype</em>, <em>threaded</em>, <em>getmode=cx_Oracle.SPOOL_ATTRVAL_NOWAIT</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#cx_Oracle.SessionPool" title="Permalink to this definition"></a></dt>
<!--#cx_Oracle.SessionPool#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">SessionPool</tt><big>(</big><em>user</em>, <em>password</em>, <em>database</em>, <em>min</em>, <em>max</em>, <em>increment</em><span class="optional">[</span>, <em>connectiontype</em>, <em>threaded</em>, <em>getmode=cx_Oracle.SPOOL_ATTRVAL_NOWAIT</em>, <em>homogeneous=True</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#cx_Oracle.SessionPool" title="Permalink to this definition"></a></dt>
<dd><p>Create a session pool (see Oracle 9i documentation for more information) and
return a session pool object (<a class="reference" href="session_pool.html#sesspool"><em>SessionPool Object</em></a>). This allows for very fast
connections to the database and is of primary use in a server where the same
@ -172,6 +191,42 @@ Python time module for details).</dd></dl>
<!--#cx_Oracle.apilevel#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">apilevel</tt><a class="headerlink" href="#cx_Oracle.apilevel" title="Permalink to this definition"></a></dt>
<dd>String constant stating the supported DB API level. Currently &#8216;2.0&#8217;.</dd></dl>
<dl class="data">
<dt id="cx_Oracle.ATTR_PURITY_DEFAULT">
<!--#cx_Oracle.ATTR_PURITY_DEFAULT#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">ATTR_PURITY_DEFAULT</tt><a class="headerlink" href="#cx_Oracle.ATTR_PURITY_DEFAULT" title="Permalink to this definition"></a></dt>
<dd><p>This constant is used when using database resident connection pooling (DRCP)
and specifies that the purity of the session is the default value used by
Oracle (see Oracle&#8217;s documentation for more information).</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="data">
<dt id="cx_Oracle.ATTR_PURITY_NEW">
<!--#cx_Oracle.ATTR_PURITY_NEW#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">ATTR_PURITY_NEW</tt><a class="headerlink" href="#cx_Oracle.ATTR_PURITY_NEW" title="Permalink to this definition"></a></dt>
<dd><p>This constant is used when using database resident connection pooling (DRCP)
and specifies that the session acquired from the pool should be new and not
have any prior session state.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="data">
<dt id="cx_Oracle.ATTR_PURITY_SELF">
<!--#cx_Oracle.ATTR_PURITY_SELF#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">ATTR_PURITY_SELF</tt><a class="headerlink" href="#cx_Oracle.ATTR_PURITY_SELF" title="Permalink to this definition"></a></dt>
<dd><p>This constant is used when using database resident connection pooling (DRCP)
and specifies that the session acquired from the pool need not be new and
may have prior session state.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="data">
<dt id="cx_Oracle.buildtime">
<!--#cx_Oracle.buildtime#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">buildtime</tt><a class="headerlink" href="#cx_Oracle.buildtime" title="Permalink to this definition"></a></dt>
@ -377,6 +432,17 @@ of the OCI.</p>
</div>
</dd></dl>
<dl class="data">
<dt id="cx_Oracle.INTERVAL">
<!--#cx_Oracle.INTERVAL#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">INTERVAL</tt><a class="headerlink" href="#cx_Oracle.INTERVAL" title="Permalink to this definition"></a></dt>
<dd><p>This type object is used to describe columns in a database that are of type
interval day to second.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
</div>
</dd></dl>
<dl class="data">
<dt id="cx_Oracle.LOB">
<!--#cx_Oracle.LOB#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">LOB</tt><a class="headerlink" href="#cx_Oracle.LOB" title="Permalink to this definition"></a></dt>
@ -596,7 +662,7 @@ to the OCI function.</p>
<dl class="data">
<dt id="cx_Oracle.version">
<!--#cx_Oracle.version#--><tt class="descclassname">cx_Oracle.</tt><tt class="descname">version</tt><a class="headerlink" href="#cx_Oracle.version" title="Permalink to this definition"></a></dt>
<dd><p>String constant stating the version of the module. Currently &#8216;4.4&#8216;.</p>
<dd><p>String constant stating the version of the module. Currently &#8216;5.0&#8216;.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This attribute is an extension to the DB API definition.</p>
@ -667,6 +733,51 @@ subclass of DatabaseError.</dd></dl>
<dd>Exception raised when a method or database API was used which is not
supported by the database. It is a subclass of DatabaseError.</dd></dl>
</div>
<div class="section">
<h2 id="exception-handling">Exception handling<a class="headerlink" href="#exception-handling" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>PEP 249 (Python Database API Specification v2.0) says the following about
exception values:</p>
<blockquote>
[...] The values of these exceptions are not defined. They should
give the user a fairly good idea of what went wrong, though. [...]</blockquote>
<p class="last">With cx_Oracle every exception object has exactly one argument in the
<tt class="docutils literal"><span class="pre">args</span></tt> tuple. This argument is a <tt class="docutils literal"><span class="pre">cx_Oracle._Error</span></tt> object which has
the following three read-only attributes.</p>
</div>
<dl class="attribute">
<dt id="cx_Oracle._Error.code">
<!--#cx_Oracle._Error.code#--><tt class="descclassname">_Error.</tt><tt class="descname">code</tt><a class="headerlink" href="#cx_Oracle._Error.code" title="Permalink to this definition"></a></dt>
<dd>Integer attribute representing the Oracle error number (ORA-XXXXX).</dd></dl>
<dl class="attribute">
<dt id="cx_Oracle._Error.message">
<!--#cx_Oracle._Error.message#--><tt class="descclassname">_Error.</tt><tt class="descname">message</tt><a class="headerlink" href="#cx_Oracle._Error.message" title="Permalink to this definition"></a></dt>
<dd>String attribute representing the Oracle message of the error. This
message is localized by the environment of the Oracle connection.</dd></dl>
<dl class="attribute">
<dt id="cx_Oracle._Error.context">
<!--#cx_Oracle._Error.context#--><tt class="descclassname">_Error.</tt><tt class="descname">context</tt><a class="headerlink" href="#cx_Oracle._Error.context" title="Permalink to this definition"></a></dt>
<dd>String attribute representing the context in which the exception was
raised..</dd></dl>
<p>This allows you to use the exceptions for example in the following way:</p>
<div class="highlight"><pre><span class="k">import</span> <span class="nn">sys</span>
<span class="k">import</span> <span class="nn">cx_Oracle</span>
<span class="n">connection</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="s">&quot;user/pw@tns&quot;</span><span class="p">)</span>
<span class="n">cursor</span> <span class="o">=</span> <span class="n">connection</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">&quot;select 1 / 0 from dual&quot;</span><span class="p">)</span>
<span class="k">except</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">DatabaseError</span><span class="p">,</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">error</span><span class="p">,</span> <span class="o">=</span> <span class="n">exc</span><span class="o">.</span><span class="n">args</span>
<span class="k">print</span> <span class="o">&gt;&gt;</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s">&quot;Oracle-Error-Code:&quot;</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">code</span>
<span class="k">print</span> <span class="o">&gt;&gt;</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s">&quot;Oracle-Error-Message:&quot;</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">message</span>
</pre></div>
</div>
</div>
@ -681,6 +792,7 @@ supported by the database. It is a subclass of DatabaseError.</dd></dl>
<li><a class="reference" href="">Module Interface</a><ul>
<li><a class="reference" href="#id1">Constants</a></li>
<li><a class="reference" href="#id2">Exceptions</a></li>
<li><a class="reference" href="#exception-handling">Exception handling</a></li>
</ul>
</li>
</ul>
@ -706,12 +818,12 @@ supported by the database. It is a subclass of DatabaseError.</dd></dl>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="connection.html" title="Connection Object" accesskey="N">next</a> |</li>
<li class="right"><a href="index.html" title="cx_Oracle" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

12
html/search.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; cx_Oracle v4.4 documentation</title>
<title>Search &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<script type="text/javascript" src="_static/searchtools.js"></script>
</head>
@ -27,7 +27,7 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -65,12 +65,12 @@
<ul>
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

2
html/searchindex.json
View File

File diff suppressed because one or more lines are too long

19
html/session_pool.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>SessionPool Object &mdash; cx_Oracle v4.4 documentation</title>
<title>SessionPool Object &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="LOB Objects" href="lob.html" />
<link rel="prev" title="Variable Objects" href="variable.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="lob.html" title="LOB Objects" accesskey="N">next</a> |</li>
<li class="right"><a href="variable.html" title="Variable Objects" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -67,6 +67,13 @@ longer usable (such as when the session is killed).</dd></dl>
<dd>This read-only attribute returns the TNS entry of the database to which a
connection has been established.</dd></dl>
<dl class="attribute">
<dt id="SessionPool.homogeneous">
<!--#SessionPool.homogeneous#--><tt class="descclassname">SessionPool.</tt><tt class="descname">homogeneous</tt><a class="headerlink" href="#SessionPool.homogeneous" title="Permalink to this definition"></a></dt>
<dd>This read-write boolean attribute indicates whether the pool is considered
homogeneous or not. If the pool is not homogeneous different authentication
can be used for each connection acquired from the pool.</dd></dl>
<dl class="attribute">
<dt id="SessionPool.increment">
<!--#SessionPool.increment#--><tt class="descclassname">SessionPool.</tt><tt class="descname">increment</tt><a class="headerlink" href="#SessionPool.increment" title="Permalink to this definition"></a></dt>
@ -158,12 +165,12 @@ connection to the database.</dd></dl>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="lob.html" title="LOB Objects" accesskey="N">next</a> |</li>
<li class="right"><a href="variable.html" title="Variable Objects" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

28
html/variable.html
View File

@ -2,13 +2,13 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Variable Objects &mdash; cx_Oracle v4.4 documentation</title>
<title>Variable Objects &mdash; cx_Oracle v5.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.4'
VERSION: '5.0'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
@ -17,7 +17,7 @@
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="cx_Oracle v4.4 documentation" href="index.html" />
<link rel="top" title="cx_Oracle v5.0 documentation" href="index.html" />
<link rel="next" title="SessionPool Object" href="session_pool.html" />
<link rel="prev" title="Cursor Object" href="cursor.html" />
</head>
@ -29,7 +29,7 @@
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="session_pool.html" title="SessionPool Object" accesskey="N">next</a> |</li>
<li class="right"><a href="cursor.html" title="Cursor Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
@ -55,11 +55,27 @@ array, or the number of scalar items that can be fetched into the variable.</dd>
<!--#Variable.getvalue#--><tt class="descclassname">Variable.</tt><tt class="descname">getvalue</tt><big>(</big><span class="optional">[</span><em>pos=0</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Variable.getvalue" title="Permalink to this definition"></a></dt>
<dd>Return the value at the given position in the variable.</dd></dl>
<dl class="attribute">
<dt id="Variable.inconverter">
<!--#Variable.inconverter#--><tt class="descclassname">Variable.</tt><tt class="descname">inconverter</tt><a class="headerlink" href="#Variable.inconverter" title="Permalink to this definition"></a></dt>
<dd>This read-write attribute specifies the method used to convert data from
Python to the Oracle database. The method signature is converter(value)
and the expected return value is the value to bind to the database. If this
attribute is None, the value is bound directly without any conversion.</dd></dl>
<dl class="attribute">
<dt id="Variable.maxlength">
<!--#Variable.maxlength#--><tt class="descclassname">Variable.</tt><tt class="descname">maxlength</tt><a class="headerlink" href="#Variable.maxlength" title="Permalink to this definition"></a></dt>
<dd>This read-only attribute returns the maximum length of the variable.</dd></dl>
<dl class="attribute">
<dt id="Variable.outconverter">
<!--#Variable.outconverter#--><tt class="descclassname">Variable.</tt><tt class="descname">outconverter</tt><a class="headerlink" href="#Variable.outconverter" title="Permalink to this definition"></a></dt>
<dd>This read-write attribute specifies the method used to convert data from
from the Oracle to Python. The method signature is converter(value)
and the expected return value is the value to return to Python. If this
attribute is None, the value is returned directly without any conversion.</dd></dl>
<dl class="method">
<dt id="Variable.setvalue">
<!--#Variable.setvalue#--><tt class="descclassname">Variable.</tt><tt class="descname">setvalue</tt><big>(</big><em>pos</em>, <em>value</em><big>)</big><a class="headerlink" href="#Variable.setvalue" title="Permalink to this definition"></a></dt>
@ -94,12 +110,12 @@ array, or the number of scalar items that can be fetched into the variable.</dd>
<li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right"><a href="session_pool.html" title="SessionPool Object" accesskey="N">next</a> |</li>
<li class="right"><a href="cursor.html" title="Cursor Object" accesskey="P">previous</a> |</li>
<li><a href="index.html">cx_Oracle v4.4 documentation</a> &raquo;</li>
<li><a href="index.html">cx_Oracle v5.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2008, Anthony Tuininga.
Last updated on Jun 06, 2008.
Last updated on Dec 11, 2008.
</div>
</body>
</html>

2
setup.py
View File

@ -35,7 +35,7 @@ except:
from distutils.extension import Extension
# define build constants
BUILD_VERSION = "5.0a1"
BUILD_VERSION = "5.0"
# define the list of files to be included as documentation for Windows
dataFiles = None