507 lines
16 KiB
HTML
507 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<link rel="STYLESHEET" href="cx_Oracle.css" type='text/css' />
|
|
<link rel="first" href="cx_Oracle.html" title='cx_Oracle' />
|
|
<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="exceptions.html" />
|
|
<link rel="prev" href="module.html" />
|
|
<link rel="parent" href="module.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>
|
|
</head>
|
|
<body>
|
|
<div class="navigation">
|
|
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
|
|
<table align="center" width="100%" cellpadding="0" cellspacing="2">
|
|
<tr>
|
|
<td class='online-navigation'><a rel="prev" title="1. module Interface"
|
|
href="module.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'
|
|
border='0' height='32' alt='Up one Level' width='32' /></a></td>
|
|
<td class='online-navigation'><a rel="next" title="1.2 Exceptions"
|
|
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"
|
|
href="contents.html"><img src='contents.png'
|
|
border='0' height='32' alt='Contents' width='32' /></a></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
</tr></table>
|
|
<div class='online-navigation'>
|
|
<b class="navlabel">Previous:</b>
|
|
<a class="sectref" rel="prev" href="module.html">1. Module Interface</a>
|
|
<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="exceptions.html">1.2 Exceptions</a>
|
|
</div>
|
|
<hr /></div>
|
|
</div>
|
|
<!--End of Navigation Panel-->
|
|
|
|
<h1><a name="SECTION003100000000000000000"></a><a name="constants"></a>
|
|
<br>
|
|
1.1 Constants
|
|
</h1>
|
|
|
|
<p>
|
|
<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-15' xml:id='l2h-15'>buildtime</tt></b></dt>
|
|
<dd>
|
|
String constant stating the time when the binary was built.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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-17' xml:id='l2h-17'>BFILE</tt></b></dt>
|
|
<dd>
|
|
This type object is used to describe columns in a database that are BFILEs.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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).
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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-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
|
|
in Oracle than varchar2 so they are differentiated here even though the DB
|
|
API does not differentiate them.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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).
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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).
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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-40' xml:id='l2h-40'>OBJECT</tt></b></dt>
|
|
<dd>
|
|
This type object is used to describe columns in a database that are objects.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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-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-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
|
|
available in the pool.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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
|
|
pool.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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
|
|
are no free sessions available in the pool.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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-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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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
|
|
connections, but not cursors. Sharing means that a thread may use a resource
|
|
without wrapping it using a mutex semaphore to implement resource locking.
|
|
|
|
<p>
|
|
Note that in order to make use of multiple threads in a program which intends
|
|
to connect and disconnect in different threads, the threaded argument to the
|
|
Connection constructor must be a true value. See the comments on the
|
|
Connection constructor for more information (<a href="module.html#module">1</a>).
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition and
|
|
is only available in Oracle 9i.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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
|
|
execution of the OCI function.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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
|
|
of the OCI function.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
<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 'HEAD'.
|
|
|
|
<p>
|
|
<strong>NOTE:</strong> This attribute is an extension to the DB API definition.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
|
|
<div class="navigation">
|
|
<div class='online-navigation'>
|
|
<p></p><hr />
|
|
<table align="center" width="100%" cellpadding="0" cellspacing="2">
|
|
<tr>
|
|
<td class='online-navigation'><a rel="prev" title="1. module Interface"
|
|
href="module.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'
|
|
border='0' height='32' alt='Up one Level' width='32' /></a></td>
|
|
<td class='online-navigation'><a rel="next" title="1.2 Exceptions"
|
|
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"
|
|
href="contents.html"><img src='contents.png'
|
|
border='0' height='32' alt='Contents' width='32' /></a></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
</tr></table>
|
|
<div class='online-navigation'>
|
|
<b class="navlabel">Previous:</b>
|
|
<a class="sectref" rel="prev" href="module.html">1. Module Interface</a>
|
|
<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="exceptions.html">1.2 Exceptions</a>
|
|
</div>
|
|
</div>
|
|
<hr />
|
|
<span class="release-info">Release HEAD, documentation updated on October 1, 2007.</span>
|
|
</div>
|
|
<!--End of Navigation Panel-->
|
|
|
|
</body>
|
|
</html>
|