From ed13b8314def8a3461f976ea6d7a6e77ec75ebd0 Mon Sep 17 00:00:00 2001 From: Anthony Tuininga Date: Tue, 2 Oct 2007 02:50:53 +0000 Subject: [PATCH] Tweaked documentation in preparation for release of version 4.3.3. --- HISTORY.txt | 27 +++++ LICENSE.txt | 12 +- doc/build.sh | 2 +- doc/cx_Oracle.tex | 24 +++- doc/license.tex | 14 ++- html/about.html | 14 +-- html/connobj.html | 141 ++++++++++++++++++---- html/{node4.html => constants.html} | 169 ++++++++++++++++++++------- html/contents.html | 8 +- html/cursorobj.html | 72 +++++++----- html/cx_Oracle.html | 14 +-- html/dateobj.html | 28 ++--- html/{node5.html => exceptions.html} | 37 +++--- html/front.html | 7 +- html/index.html | 14 +-- html/{node12.html => license.html} | 24 ++-- html/lobobj.html | 50 ++++++-- html/module.html | 50 +++++--- html/pyfav.png | Bin 0 -> 240 bytes html/sesspool.html | 30 ++--- html/varobj.html | 10 +- 21 files changed, 516 insertions(+), 231 deletions(-) rename html/{node4.html => constants.html} (67%) rename html/{node5.html => exceptions.html} (82%) rename html/{node12.html => license.html} (87%) create mode 100644 html/pyfav.png diff --git a/HISTORY.txt b/HISTORY.txt index c1553de..0ee6c4e 100644 --- a/HISTORY.txt +++ b/HISTORY.txt @@ -1,3 +1,30 @@ +Changes from 4.3.2 to 4.3.3 + 1) Added method ping() on connections which can be used to test whether or not + a connection is still active (available in Oracle 10g R2). + 2) Added method cx_Oracle.clientversion() which returns a 5-tuple giving the + version of the client that is in use (available in Oracle 10g R2). + 3) Added methods startup() and shutdown() on connections which can be used to + startup and shutdown databases (available in Oracle 10g R2). + 4) Added support for Oracle 11g. + 5) Added samples directory which contains a handful of scripts containing + sample code for more advanced techniques. More will follow in future + releases. + 6) Prevent error "ORA-24333: zero iteration count" when calling executemany() + with zero rows as requested by Andreas Mock. + 7) Added methods __enter__() and __exit__() on connections to support using + connections as context managers in Python 2.5 and higher. The context + managed is the transaction state. Upon exit the transaction is either + rolled back or committed depending on whether an exception took place or + not. + 8) Make the search for the lib32 and lib64 directories automatic for all + platforms. + 9) Tweak the setup configuration script to include all of the metadata and + allow for building the module within another setup configuration script +10) Include the Oracle version in addition to the Python version in the build + directories that are created and in the names of the binary packages that + are created. +11) Remove unnecessary dependency on win32api to build module on Windows. + Changes from 4.3.1 to 4.3.2 1) Added methods open(), close(), isopen() and getchunksize() in order to improve performance of reading/writing LOB values in chunks. diff --git a/LICENSE.txt b/LICENSE.txt index 9d6acb1..6acafc3 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -14,15 +14,15 @@ modification, are permitted provided that the following conditions are met: notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution. - 3. Neither the name of Colt Engineering nor the names of its contributors - may be used to endorse or promote products derived from this software - without specific prior written permission. + 3. Neither the names of the copyright holders nor the names of any + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. DISCLAIMER: -THIS SOFTWARE IS PROVIDED BY COLT ENGINEERING AND CONTRIBUTORS *AS IS* +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A -PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COLT ENGINEERING +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF @@ -32,3 +32,5 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +Computronix® is a registered trademark of Computronix (Canada) Ltd. + diff --git a/doc/build.sh b/doc/build.sh index 63e94a7..2048c03 100644 --- a/doc/build.sh +++ b/doc/build.sh @@ -1,4 +1,4 @@ -python /u01/svn/python/trunk/Doc/tools/mkhowto \ +python /u01/svn/python/release25-maint/Doc/tools/mkhowto \ --html --dir ../html cx_Oracle.tex rm -rf ../html/WARNINGS rm -f ../html/index.dat diff --git a/doc/cx_Oracle.tex b/doc/cx_Oracle.tex index 54a5f76..36feac1 100644 --- a/doc/cx_Oracle.tex +++ b/doc/cx_Oracle.tex @@ -47,7 +47,7 @@ information on the Python database API specification. \end{funcdesc} \begin{funcdesc}{clientversion}{} - Return the version of the client library being used as a 5 tuple. The five + Return the version of the client library being used as a 5-tuple. The five values are the major version, minor version, update number, patch number and port update number. @@ -149,7 +149,7 @@ information on the Python database API specification. Python time module for details). \end{funcdesc} -\section{Constants} +\section{Constants}\label{constants} \begin{datadesc}{apilevel} String constant stating the supported DB API level. Currently '2.0'. @@ -208,7 +208,8 @@ information on the Python database API specification. This constant is used in database shutdown to indicate that the instance can be truly halted. This should only be done after the database has been shut down in one of the other modes (except abort) and the database has been - closed and dismounted using the appropriate SQL commands. + closed and dismounted using the appropriate SQL commands. See the method + shutdown() in the section on connections (\ref{connobj}). \strong{NOTE:} This attribute is an extension to the DB API definition. \end{datadesc} @@ -440,7 +441,7 @@ information on the Python database API specification. \strong{NOTE:} This attribute is an extension to the DB API definition. \end{datadesc} -\section{Exceptions} +\section{Exceptions}\label{exceptions} \begin{datadesc}{Warning} Exception raised for important warnings and defined by the DB API but not @@ -498,6 +499,21 @@ information on the Python database API specification. \strong{NOTE}: Any outstanding changes will be rolled back when the connection object is destroyed or closed. +\begin{funcdesc}{__enter__}{} + The entry point for the connection as a context manager, a feature available + in Python 2.5 and higher. It returns itself. + + \strong{NOTE:} This method is an extension to the DB API definition. +\end{funcdesc} + +\begin{funcdesc}{__exit__}{} + The exit point for the connection as a context manager, a feature available + in Python 2.5 and higher. In the event of an exception, the transaction is + rolled back; otherwise, the transaction is committed. + + \strong{NOTE:} This method is an extension to the DB API definition. +\end{funcdesc} + \begin{datadesc}{action} This write-only attribute sets the action column in the v\$session table and is only available in Oracle 10g. diff --git a/doc/license.tex b/doc/license.tex index ae42658..7e2eeda 100644 --- a/doc/license.tex +++ b/doc/license.tex @@ -1,4 +1,4 @@ -\chapter{License} +\chapter{License}\label{license} \centerline{\strong{LICENSE AGREEMENT FOR CX\_ORACLE \version}} @@ -21,16 +21,16 @@ modification, are permitted provided that the following conditions are met: documentation and/or other materials provided with the distribution. \item - Neither the name of Colt Engineering nor the names of its contributors may - be used to endorse or promote products derived from this software - without specific prior written permission. + Neither the names of the copyright holders nor the names of any + contributors may be used to endorse or promote products derived from this + software without specific prior written permission. \end{enumerate} DISCLAIMER: -THIS SOFTWARE IS PROVIDED BY COLT ENGINEERING AND CONTRIBUTORS *AS IS* +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A -PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COLT ENGINEERING +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF @@ -40,3 +40,5 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +Computronix (R) is a registered trademark of Computronix (Canada) Ltd. + diff --git a/html/about.html b/html/about.html index a62a95f..4f8897c 100644 --- a/html/about.html +++ b/html/about.html @@ -6,7 +6,7 @@ - + @@ -18,7 +18,7 @@
Previous: - + Up: cx_Oracle
@@ -48,7 +48,7 @@ About this document ... cx_Oracle, -April 18, 2007, Release 4.3.1 +October 1, 2007, Release HEAD

This document was generated using the LaTeX2HTML translator. @@ -80,7 +80,7 @@ April 18, 2007, Release 4.3.1

Previous: - + Up: cx_Oracle
-Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/connobj.html b/html/connobj.html index 6ac1059..66fb6bd 100644 --- a/html/connobj.html +++ b/html/connobj.html @@ -20,7 +20,7 @@
Previous: - + Up: cx_Oracle Next: @@ -59,7 +59,32 @@ object is destroyed or closed.

-

action
+
+ +
__enter__()
+
+ The entry point for the connection as a context manager, a feature available + in Python 2.5 and higher. It returns itself. + +

+NOTE: This method is an extension to the DB API definition. +

+ +

+

+ +
__exit__()
+
+ The exit point for the connection as a context manager, a feature available + in Python 2.5 and higher. In the event of an exception, the transaction is + rolled back; otherwise, the transaction is committed. + +

+NOTE: This method is an extension to the DB API definition. +

+ +

+

action
This write-only attribute sets the action column in the v$session table and is only available in Oracle 10g. @@ -68,9 +93,18 @@ object is destroyed or closed. NOTE: This attribute is an extension to the DB API definition.
+

+

autocommit
+
+ This read-write attribute determines whether autocommit mode is on or off. + +

+NOTE: This attribute is an extension to the DB API definition. +

+

- +
begin(begin( )
@@ -93,7 +127,7 @@ Note that in order to make use of global (distributed) transactions, the

- +
cancel(cancel( )
Cancel a long-running transaction. This is only effective on non-Windows @@ -101,7 +135,7 @@ Note that in order to make use of global (distributed) transactions, the

-

clientinfo
+
clientinfo
This write-only attribute sets the client_info column in the v$session table and is only available in Oracle 10g. @@ -112,7 +146,7 @@ Note that in order to make use of global (distributed) transactions, the

- +
close(close( )
Close the connection now, rather than whenever __del__ is called. The @@ -123,7 +157,7 @@ Note that in order to make use of global (distributed) transactions, the

- +
commit(commit( )
Commit any pending transactions to the database. @@ -131,14 +165,14 @@ Note that in order to make use of global (distributed) transactions, the

- +
cursor(cursor( )
Return a new Cursor object (3) using the connection.

-

dsn
+
dsn
This read-only attribute returns the TNS entry of the database to which a connection has been established. @@ -148,7 +182,7 @@ Note that in order to make use of global (distributed) transactions, the

-

encoding
+
encoding
This read-only attribute returns the IANA character set name of the character set in use by the Oracle client. @@ -158,7 +192,7 @@ Note that in order to make use of global (distributed) transactions, the

-

maxBytesPerCharacter
+
maxBytesPerCharacter
This read-only attribute returns the maximum number of bytes each character can use for the client character set. @@ -168,7 +202,7 @@ Note that in order to make use of global (distributed) transactions, the

-

module
+
module
This write-only attribute sets the module column in the v$session table and is only available in Oracle 10g. @@ -178,7 +212,7 @@ Note that in order to make use of global (distributed) transactions, the

-

nencoding
+
nencoding
This read-only attribute returns the IANA character set name of the national character set in use by the Oracle client. @@ -188,7 +222,7 @@ Note that in order to make use of global (distributed) transactions, the

-

password
+
password
This read-only attribute returns the password of the user which established the connection to the database. @@ -199,7 +233,19 @@ Note that in order to make use of global (distributed) transactions, the

- + +
prepare(ping()
+
+ Ping the server which can be used to test if the connection is still active. + +

+NOTE: This method is an extension to the DB API definition and is + only available in Oracle 10g R2 and higher. +

+ +

+

+
prepare( )
Prepare the distributed (global) transaction for commit. @@ -210,7 +256,7 @@ Note that in order to make use of global (distributed) transactions, the

- +
register(register( code, when, function)
Register the function as an OCI callback. The code is one of the function @@ -230,14 +276,59 @@ Note that in order to make use of global (distributed) transactions, the

- +
rollback(rollback( )
Rollback any pending transactions.

-

tnsentry
+
+ +
shutdown([mode])
+
+ Shutdown the database. In order to do this the connection must connected as + SYSDBA or SYSOPER. First shutdown using one of the DBSHUTDOWN constants + defined in the constants (1.1) section. Next issue the SQL + statements required to close the database ("alter database close normal") + and dismount the database ("alter database dismount") followed by a second + call to this method with the DBSHUTDOWN_FINAL mode. + +

+NOTE: This method is an extension to the DB API definition and is + only available in Oracle 10g R2 and higher. +

+ +

+

+ +
startup(force=False, restrict=False)
+
+ Startup the database. This is equivalent to the SQL*Plus command + "startup nomount". The connection must be connected as SYSDBA or SYSOPER with + the PRELIM_AUTH option specified for this to work. Once this method has + completed, connect again without the PRELIM_AUTH option and issue the + statements required to mount ("alter database mount") and open ("alter + database open") the database. + +

+NOTE: This method is an extension to the DB API definition and is + only available in Oracle 10g R2 and higher. +

+ +

+

stmtcachesize
+
+ This read-write attribute specifies the size of the statement cache. This + value can make a significant difference in performance (up to 100x) if you + have a small number of statements that you execute repeatedly. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

tnsentry
This read-only attribute returns the TNS entry of the database to which a connection has been established. @@ -248,7 +339,7 @@ Note that in order to make use of global (distributed) transactions, the

- +
unregister(unregister( code, when)
Unregister the function as an OCI callback. The code is one of the function @@ -261,7 +352,7 @@ Note that in order to make use of global (distributed) transactions, the

-

username
+
username
This read-only attribute returns the name of the user which established the connection to the database. @@ -271,7 +362,7 @@ Note that in order to make use of global (distributed) transactions, the

-

version
+
version
This read-only attribute returns the version of the database to which a connection has been established. @@ -288,7 +379,7 @@ Note that in order to make use of global (distributed) transactions, the
Previous: - + Up: cx_Oracle Next: @@ -315,7 +406,7 @@ Note that in order to make use of global (distributed) transactions, the
-Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/node4.html b/html/constants.html similarity index 67% rename from html/node4.html rename to html/constants.html index b732de7..28f989c 100644 --- a/html/node4.html +++ b/html/constants.html @@ -6,10 +6,10 @@ - + - + 1.1 Constants @@ -26,7 +26,7 @@ href="module.html">Up one Level cx_Oracle Up: 1. Module Interface Next: - +
-

-1.1 Constants +

+
+1.1 Constants

-

apilevel
+
apilevel
String constant stating the supported DB API level. Currently '2.0'.

-

buildtime
+
buildtime
String constant stating the time when the binary was built. @@ -69,14 +70,14 @@

-

BINARY
+
BINARY
This type object is used to describe columns in a database that are binary (in Oracle this is RAW columns).

-

BFILE
+
BFILE
This type object is used to describe columns in a database that are BFILEs. @@ -85,7 +86,7 @@

-

BLOB
+
BLOB
This type object is used to describe columns in a database that are BLOBs. @@ -94,7 +95,7 @@

-

CLOB
+
CLOB
This type object is used to describe columns in a database that are CLOBs. @@ -103,7 +104,7 @@

-

CURSOR
+
CURSOR
This type object is used to describe columns in a database that are cursors (in PL/SQL these are known as ref cursors). @@ -113,13 +114,71 @@

-

DATETIME
+
DATETIME
This type object is used to describe columns in a database that are dates.

-

FIXED_CHAR
+
DBSHUTDOWN_ABORT
+
+ 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. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

DBSHUTDOWN_FINAL
+
+ 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 (2). + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

DBSHUTDOWN_IMMEDIATE
+
+ This constant is used in database shutdown to indicate that all uncommitted + transactions should be rolled back and any connected users should be + disconnected. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

DBSHUTDOWN_TRANSACTIONAL
+
+ 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. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

DBSHUTDOWN_TRANSACTIONAL_LOCAL
+
+ 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. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

FIXED_CHAR
This type object is used to describe columns in a database that are fixed length strings (in Oracle this is CHAR columns); these behave differently @@ -131,7 +190,7 @@

-

FNCODE_BINDBYNAME
+
FNCODE_BINDBYNAME
This constant is used to register callbacks on the OCIBindByName() function of the OCI. @@ -141,7 +200,7 @@

-

FNCODE_BINDBYPOS
+
FNCODE_BINDBYPOS
This constant is used to register callbacks on the OCIBindByPos() function of the OCI. @@ -151,7 +210,7 @@

-

FNCODE_DEFINEBYPOS
+
FNCODE_DEFINEBYPOS
This constant is used to register callbacks on the OCIDefineByPos() function of the OCI. @@ -161,7 +220,7 @@

-

FNCODE_STMTEXECUTE
+
FNCODE_STMTEXECUTE
This constant is used to register callbacks on the OCIStmtExecute() function of the OCI. @@ -171,7 +230,7 @@

-

FNCODE_STMTFETCH
+
FNCODE_STMTFETCH
This constant is used to register callbacks on the OCIStmtFetch() function of the OCI. @@ -181,7 +240,7 @@

-

FNCODE_STMTPREPARE
+
FNCODE_STMTPREPARE
This constant is used to register callbacks on the OCIStmtPrepare() function of the OCI. @@ -191,7 +250,7 @@

-

LOB
+
LOB
This type object is the Python type of BLOB and CLOB data that is returned from cursors. @@ -201,7 +260,7 @@

-

LONG_BINARY
+
LONG_BINARY
This type object is used to describe columns in a database that are long binary (in Oracle these are LONG RAW columns). @@ -211,7 +270,7 @@

-

LONG_STRING
+
LONG_STRING
This type object is used to describe columns in a database that are long strings (in Oracle these are LONG columns). @@ -221,7 +280,17 @@

-

NCLOB
+
NATIVE_FLOAT
+
+ 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. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

NCLOB
This type object is used to describe columns in a database that are NCLOBs. @@ -230,13 +299,13 @@

-

NUMBER
+
NUMBER
This type object is used to describe columns in a database that are numbers.

-

OBJECT
+
OBJECT
This type object is used to describe columns in a database that are objects. @@ -245,20 +314,30 @@

-

paramstyle
+
paramstyle
String constant stating the type of parameter marker formatting expected by the interface. Currently 'named' as in 'where name = :name'.

-

ROWID
+
ROWID
This type object is used to describe the pseudo column "rowid".

-

SPOOL_ATTRVAL_FORCEGET
+
PRELIM_AUTH
+
+ This constant is used to define the preliminary authentication mode required + for performing database startup and shutdown. + +

+NOTE: This attribute is an extension to the DB API definition. +

+ +

+

SPOOL_ATTRVAL_FORCEGET
This constant is used to define the "get" mode on session pools and indicates that a new connection will be returned if there are no free sessions @@ -269,7 +348,7 @@

-

SPOOL_ATTRVAL_NOWAIT
+
SPOOL_ATTRVAL_NOWAIT
This constant is used to define the "get" mode on session pools and indicates that an exception is raised if there are no free sessions available in the @@ -280,7 +359,7 @@

-

SPOOL_ATTRVAL_WAIT
+
SPOOL_ATTRVAL_WAIT
This constant is used to define the "get" mode on session pools and indicates that the acquisition of a connection waits until a session is freed if there @@ -291,14 +370,14 @@

-

STRING
+
STRING
This type object is used to describe columns in a database that are strings (in Oracle this is VARCHAR2 columns).

-

SYSDBA
+
SYSDBA
Value to be passed to the connect() method which indicates that SYSDBA access is to be acquired. See the Oracle documentation for more details. @@ -308,7 +387,7 @@

-

SYSOPER
+
SYSOPER
Value to be passed to the connect() method which indicates that SYSOPER access is to be acquired. See the Oracle documentation for more details. @@ -318,7 +397,7 @@

-

threadsafety
+
threadsafety
Integer constant stating the level of thread safety that the interface supports. Currently 2, which means that threads may share the module and @@ -333,7 +412,7 @@ Note that in order to make use of multiple threads in a program which intends

-

TIMESTAMP
+
TIMESTAMP
This type object is used to describe columns in a database that are timestamps. @@ -344,7 +423,7 @@ Note that in order to make use of multiple threads in a program which intends

-

UCBTYPE_ENTRY
+
UCBTYPE_ENTRY
This constant is used to register callbacks on entry to the function of the OCI. In other words, the callback will be called prior to the @@ -355,7 +434,7 @@ Note that in order to make use of multiple threads in a program which intends

-

UCBTYPE_EXIT
+
UCBTYPE_EXIT
This constant is used to register callbacks on exit from the function of the OCI. In other words, the callback will be called after the execution @@ -366,7 +445,7 @@ Note that in order to make use of multiple threads in a program which intends

-

UCBTYPE_REPLACE
+
UCBTYPE_REPLACE
This constant is used to register callbacks that completely replace the call to the OCI function. @@ -376,9 +455,9 @@ Note that in order to make use of multiple threads in a program which intends

-

version
+
version
- String constant stating the version of the module. Currently '4.3.1'. + String constant stating the version of the module. Currently 'HEAD'.

NOTE: This attribute is an extension to the DB API definition. @@ -398,7 +477,7 @@ Note that in order to make use of multiple threads in a program which intends href="module.html">Up one Level cx_Oracle Up: 1. Module Interface Next: - +

-Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/contents.html b/html/contents.html index a235c44..08ede13 100644 --- a/html/contents.html +++ b/html/contents.html @@ -55,8 +55,8 @@ Contents

@@ -101,7 +101,7 @@ Contents

-Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/cursorobj.html b/html/cursorobj.html index 9752678..59ebd19 100644 --- a/html/cursorobj.html +++ b/html/cursorobj.html @@ -55,7 +55,7 @@

-

arraysize
+
arraysize
This read-write attribute specifies the number of rows to fetch at a time internally and is the default number of rows to fetch with the fetchmany() @@ -65,7 +65,7 @@

-

bindarraysize
+
bindarraysize
This read-write attribute specifies the number of rows to bind at a time and is used when creating variables via setinputsizes() or var(). It defaults to @@ -77,7 +77,7 @@

- +
arrayvar(arrayvar( dataType, value, [size])
Create an array variable associated with the cursor of the given type and @@ -96,7 +96,7 @@

- +
bindnames(bindnames( )
Return the list of bind variable names bound to the statement. Note that the @@ -108,7 +108,7 @@

- +
callfunc(callfunc( name, returnType, [parameters=[]])
@@ -120,7 +120,7 @@

- +
callproc(callproc( name, [parameters=[]])
Call a procedure with the given name. The sequence of parameters must contain @@ -132,7 +132,7 @@

- +
close(close( )
Close the cursor now, rather than whenever __del__ is called. The cursor will @@ -141,7 +141,7 @@

-

connection
+
connection
This read-only attribute returns a reference to the connection object on which the cursor was created. @@ -152,7 +152,7 @@

-

description
+
description
This read-only attribute is a sequence of 7-item sequences. Each of these sequences contains information describing one result column: (name, type, @@ -166,7 +166,7 @@ The type will be one of the type objects defined at the module level.

- +
execute(execute( statement, [parameters], **keywordParameters)
@@ -202,7 +202,7 @@ If the statement is a query, a list of variable objects ( - executemany( + executemany( statement, parameters)
Prepare a statement for execution against a database and then execute it @@ -212,7 +212,7 @@ If the statement is a query, a list of variable objects ( - executemanyprepared( + executemanyprepared( numIters)
Execute the previously prepared and bound statement the given number of @@ -227,7 +227,7 @@ If the statement is a query, a list of variable objects ( - fetchall( + fetchall( )
Fetch all (remaining) rows of a query result, returning them as a list of @@ -243,7 +243,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
fetchmany(fetchmany( [numRows=cursor.arraysize])
Fetch the next set of rows of a query result, returning a list of tuples. An @@ -263,7 +263,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
fetchone(fetchone( )
Fetch the next row of a query result set, returning a single tuple or None @@ -276,7 +276,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
fetchraw(fetchraw( [numRows=cursor.arraysize])
Fetch the next set of rows of a query result into the internal buffers of the @@ -294,7 +294,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
__iter__(__iter__( )
Returns the cursor itself to be used as an iterator. @@ -306,7 +306,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
next(next( )
Fetch the next row of a query result set, using the same semantics as @@ -318,7 +318,7 @@ An exception is raised if the previous call to execute() did not produce any

-

numbersAsStrings
+
numbersAsStrings
This integer attribute defines whether or not numbers should be returned as strings rather than integers or floating point numbers. This is useful to get @@ -332,7 +332,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
parse(parse( statement)
This can be used to parse a statement without actually executing it (this @@ -344,29 +344,43 @@ An exception is raised if the previous call to execute() did not produce any

- -
prepare(statement)
+ prepare( + statement, [tag])
This can be used before a call to execute() to define the statement that will be executed. When this is done, the prepare phase will not be performed when the call to execute() is made with None or the same string object as the - statement. + statement. If specified (Oracle 9i and higher) the statement will be + returned to the statement cache with the given tag. See the Oracle + documentation for more information about the statement cache.

NOTE: The DB API definition does not define this method.

-

rowcount
+
rowcount
This read-only attribute specifies the number of rows that have currently been fetched from the cursor (for select statements) or that have been affected by the operation (for insert, update and delete statements).
+

+

rowfactory
+
+ This read-write attribute specifies a method to call for each row that is + retrieved from the database. Ordinarily a tuple is returned for each row but + if this attribute is set, the method is called with the argument tuple that + would normally be returned and the result of the method is returned instead. + +

+NOTE: The DB API definition does not define this attribute. +

+

- +
setinputsizes(setinputsizes( *args, **keywordArgs)
This can be used before a call to execute() to predefine memory areas for the @@ -380,7 +394,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
setoutputsize(setoutputsize( size, [column])
This can be used before a call to execute() to predefine memory areas for the @@ -390,7 +404,7 @@ An exception is raised if the previous call to execute() did not produce any

-

statement
+
statement
This read-only attribute provides the string object that was previously prepared with prepare() or executed with execute(). @@ -401,7 +415,7 @@ An exception is raised if the previous call to execute() did not produce any

- +
var(var( dataType, [size])
Create a variable associated with the cursor of the given type and size and @@ -451,7 +465,7 @@ An exception is raised if the previous call to execute() did not produce any
-Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/cx_Oracle.html b/html/cx_Oracle.html index b518515..6c8db06 100644 --- a/html/cx_Oracle.html +++ b/html/cx_Oracle.html @@ -47,12 +47,12 @@

cx_Oracle

Anthony Tuininga

- Computronix + Colt Engineering
Email:

-

Release 4.3.1
-April 18, 2007

+

Release HEAD
+October 1, 2007

@@ -69,8 +69,8 @@ Email:
  • Contents
  • 1. Module Interface
  • 2. Connection Objects
  • 3. Cursor Objects @@ -78,7 +78,7 @@ Email:
  • 5. SessionPool Objects
  • 6. LOB Objects
  • 7. Date Objects -
  • 8. License +
  • 8. License
  • About this document ... @@ -111,7 +111,7 @@ Email:
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/dateobj.html b/html/dateobj.html index aca9888..c389f55 100644 --- a/html/dateobj.html +++ b/html/dateobj.html @@ -6,10 +6,10 @@ - + - + 7. Date Objects @@ -26,7 +26,7 @@ href="cx_Oracle.html">Up one Level cx_Oracle Up: cx_Oracle Next: - +
    @@ -64,43 +64,43 @@ constructor methods (Date(), Time(), Timestamp()) are called. standard library datetime module instead of these objects.

    -

    year
    +
    year
    This read-only attribute returns the year.

    -

    month
    +
    month
    This read-only attribute returns the month.

    -

    day
    +
    day
    This read-only attribute returns the day.

    -

    hour
    +
    hour
    This read-only attribute returns the hour.

    -

    minute
    +
    minute
    This read-only attribute returns the minute.

    -

    second
    +
    second
    This read-only attribute returns the second.

    -

    fsecond
    +
    fsecond
    This read-only attribute returns the fractional second.
    @@ -119,7 +119,7 @@ standard library datetime module instead of these objects. href="cx_Oracle.html">Up one Level cx_Oracle Up: cx_Oracle Next: - +
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/node5.html b/html/exceptions.html similarity index 82% rename from html/node5.html rename to html/exceptions.html index 77c90a5..b28522a 100644 --- a/html/node5.html +++ b/html/exceptions.html @@ -6,7 +6,7 @@ - + @@ -19,7 +19,7 @@
    Previous: - + Up: 1. Module Interface Next: @@ -48,19 +48,20 @@
    -

    -1.2 Exceptions +

    +
    +1.2 Exceptions

    -

    Warning
    +
    Warning
    Exception raised for important warnings and defined by the DB API but not actually used by cx_Oracle.

    -

    Error
    +
    Error
    Exception that is the base class of all other exceptions defined by cx_Oracle and is a subclass of the Python StandardError exception (defined in @@ -68,28 +69,28 @@

    -

    InterfaceError
    +
    InterfaceError
    Exception raised for errors that are related to the database interface rather than the database itself. It is a subclass of Error.

    -

    DatabaseError
    +
    DatabaseError
    Exception raised for errors that are related to the database. It is a subclass of Error.

    -

    DataError
    +
    DataError
    Exception raised for errors that are due to problems with the processed data. It is a subclass of DatabaseError.

    -

    OperationalError
    +
    OperationalError
    Exception raised for errors that are related to the operation of the database but are not necessarily under the control of the progammer. It is a @@ -97,27 +98,27 @@

    -

    IntegrityError
    +
    IntegrityError
    Exception raised when the relational integrity of the database is affected. It is a subclass of DatabaseError.

    -

    InternalError
    +
    InternalError
    Exception raised when the database encounters an internal error. It is a subclass of DatabaseError.

    -

    ProgrammingError
    +
    ProgrammingError
    Exception raised for programming errors. It is a subclass of DatabaseError.

    -

    NotSupportedError
    +
    NotSupportedError
    Exception raised when a method or database API was used which is not supported by the database. It is a subclass of DatabaseError. @@ -131,7 +132,7 @@
    Previous: - + Up: 1. Module Interface Next: @@ -158,7 +159,7 @@
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/front.html b/html/front.html index 369df8b..bb13e83 100644 --- a/html/front.html +++ b/html/front.html @@ -55,8 +55,9 @@ Front Matter

    -Copyright © 2001-2007 Computronix. -All rights reserved. +Copyright © 2007 Colt Engineering. All rights reserved. +
    +Copyright © 2001-2007 Computronix. All rights reserved.

    See the end of this document for complete license and permissions @@ -112,7 +113,7 @@ information on the Python database API specification.

    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/index.html b/html/index.html index b518515..6c8db06 100644 --- a/html/index.html +++ b/html/index.html @@ -47,12 +47,12 @@

    cx_Oracle

    Anthony Tuininga

    - Computronix + Colt Engineering
    Email:

    -

    Release 4.3.1
    -April 18, 2007

    +

    Release HEAD
    +October 1, 2007

    @@ -69,8 +69,8 @@ Email:
  • Contents
  • 1. Module Interface
  • 2. Connection Objects
  • 3. Cursor Objects @@ -78,7 +78,7 @@ Email:
  • 5. SessionPool Objects
  • 6. LOB Objects
  • 7. Date Objects -
  • 8. License +
  • 8. License
  • About this document ... @@ -111,7 +111,7 @@ Email:
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/node12.html b/html/license.html similarity index 87% rename from html/node12.html rename to html/license.html index d5fe273..813c08f 100644 --- a/html/node12.html +++ b/html/license.html @@ -49,15 +49,19 @@ -

    -8. License +

    +
    +8. License

    -

    -LICENSE AGREEMENT FOR CX_ORACLE 4.3.1
    +
    +LICENSE AGREEMENT FOR CX_ORACLE HEAD

    +Copyright © 2007, Colt Engineering, Edmonton, Alberta, Canada. +All rights reserved. +
    Copyright © 2001-2007, Computronix (Canada) Ltd., Edmonton, Alberta, Canada. All rights reserved. @@ -79,18 +83,18 @@ modification, are permitted provided that the following conditions are met:

    • -
  • Neither the name of Computronix nor the names of its contributors may - be used to endorse or promote products derived from this software - without specific prior written permission. +
  • Neither the names of the copyright holders nor the names of any + contributors may be used to endorse or promote products derived from this + software without specific prior written permission.

    • DISCLAIMER: -THIS SOFTWARE IS PROVIDED BY COMPUTRONIX AND CONTRIBUTORS *AS IS* +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A -PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COMPUTRONIX +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF @@ -138,7 +142,7 @@ Computronix (R) is a registered trademark of Computronix (Canada) Ltd.

    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/lobobj.html b/html/lobobj.html index 006368e..bcc1354 100644 --- a/html/lobobj.html +++ b/html/lobobj.html @@ -69,7 +69,14 @@ a subsequent fetch is detected.

    - + +
    fileexists(close()
    +
    + Close the LOB. Call this when writing is completed so that the indexes + associated with the LOB can be updated. +
    +
    +
    fileexists( )
    Return a boolean indicating if the file referenced by the BFILE type LOB @@ -78,7 +85,16 @@ a subsequent fetch is detected.

    - + +
    getfilename(getchunksize()
    +
    + Return the chunk size for the internal LOB. Reading and writing to the LOB + in chunks of multiples of this size will improve performance. +
    + +

    +

    +
    getfilename( )
    Return a two-tuple consisting of the directory alias and file name for a @@ -87,7 +103,25 @@ a subsequent fetch is detected.

    - + +
    read(isopen()
    +
    + Return a boolean indicating if the LOB is opened. +
    + +

    +

    + +
    open()
    +
    + Open the LOB for writing. This will improve performance when writing to a LOB + in chunks and there are functional or extensible indexes associated with the + LOB. +
    + +

    +

    +
    read( [offset = 1, [amount]])
    Return a portion (or all) of the data in the LOB object. @@ -95,7 +129,7 @@ a subsequent fetch is detected.

    - +
    setfilename(setfilename( dirAlias, name)
    Set the directory alias and name of the BFILE type LOB. @@ -103,7 +137,7 @@ a subsequent fetch is detected.

    - +
    size(size( )
    Returns the size of the data in the LOB object. @@ -111,7 +145,7 @@ a subsequent fetch is detected.

    - +
    trim(trim( [newSize = 0])
    Trim the LOB to the new size. @@ -119,7 +153,7 @@ a subsequent fetch is detected.

    - +
    write(write( data, [offset = 1])
    Write the data to the LOB object at the given offset. Note that if you want @@ -161,7 +195,7 @@ a subsequent fetch is detected.
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/module.html b/html/module.html index 11531a8..4e584df 100644 --- a/html/module.html +++ b/html/module.html @@ -9,7 +9,7 @@ - + 1. Module Interface @@ -26,7 +26,7 @@ href="cx_Oracle.html">Up one Level cx_Oracle Up: cx_Oracle Next: - +
    @@ -64,7 +64,21 @@

    - + +
    Connection(clientversion()
    +
    + Return the version of the client library being used as a 5-tuple. The five + values are the major version, minor version, update number, patch number + and port update number. + +

    +NOTE: This method is an extension to the DB API definition and is + only available in Oracle 10g Release 2 and higher. +

    + +

    +

    +
    Connection( [user, password, dsn, mode, handle, pool, threaded, twophase])
    @@ -99,7 +113,7 @@

    - +
    Cursor(Cursor( connection)
    Constructor for creating a cursor. Return a new Cursor object @@ -111,7 +125,7 @@

    - +
    Date(Date( year, month, day)
    Construct an object holding a date value. @@ -119,7 +133,7 @@

    - +
    DateFromTicks(DateFromTicks( ticks)
    Construct an object holding a date value from the given ticks value (number @@ -129,7 +143,7 @@

    - +
    makedsn(makedsn( host, port, sid)
    Return a string suitable for use as the dsn for the connect() method. This @@ -142,7 +156,7 @@

    - +
    SessionPool(SessionPool( user, password, database, min, max, increment, [connectiontype, threaded, getmode=cx_Oracle.SPOOL_ATTRVAL_NOWAIT])
    @@ -166,7 +180,7 @@

    - +
    Time(Time( hour, minute, second)
    Construct an object holding a time value. @@ -174,7 +188,7 @@

    - +
    TimeFromTicks(TimeFromTicks( ticks)
    Construct an object holding a time value from the given ticks value (number @@ -184,7 +198,7 @@

    - +
    Timestamp(Timestamp( year, month, day, hour, minute, second)
    @@ -193,7 +207,7 @@

    - +
    TimestampFromTicks(TimestampFromTicks( ticks)
    Construct an object holding a time stamp value from the given ticks value @@ -209,8 +223,8 @@ Subsections @@ -227,7 +241,7 @@ href="cx_Oracle.html">Up one Level cx_Oracle Up: cx_Oracle Next: - +
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/pyfav.png b/html/pyfav.png new file mode 100644 index 0000000000000000000000000000000000000000..d2d8669d512e9cb5d66fe86fe2a53c78049dd339 GIT binary patch literal 240 zcmeAS@N?(olHy`uVBq!ia0vp^d_c_4!VDzUtRA}qDbWC*5Z40-4lw)&LJ;`>pP``v zL~r>uOA1IcmIV0)GdMiEkp|)a-7k4}G(-65VXjv*Y^ReLV-HW+ZYc+Oz(6~DmhwQfhd;+y?lF;AZtPN-Jm zx+!dGK3{$3i>Qe<>0
    - +
    acquire(acquire( )
    Acquire a connection from the session pool and return a connection @@ -68,14 +68,14 @@ Oracle 9i.

    -

    busy
    +
    busy
    This read-only attribute returns the number of sessions currently acquired.

    - +
    drop(drop( connection)
    Drop the connection from the pool which is useful if the connection is no @@ -83,28 +83,28 @@ Oracle 9i.

    -

    dsn
    +
    dsn
    This read-only attribute returns the TNS entry of the database to which a connection has been established.

    -

    increment
    +
    increment
    This read-only attribute returns the number of sessions that will be established when additional sessions need to be created.

    -

    max
    +
    max
    This read-only attribute returns the maximum number of sessions that the session pool can control.

    -

    min
    +
    min
    This read-only attribute returns the number of sessions with which the session pool was created and the minimum number of sessions that will be @@ -112,21 +112,21 @@ Oracle 9i.

    -

    name
    +
    name
    This read-only attribute returns the name assigned to the session pool by Oracle.

    -

    opened
    +
    opened
    This read-only attribute returns the number of sessions currently opened by the session pool.

    -

    password
    +
    password
    This read-only attribute returns the password of the user which established the connection to the database. @@ -134,7 +134,7 @@ Oracle 9i.

    - +
    release(release( connection)
    Release the connection back to the pool. This will be done automatically as @@ -142,7 +142,7 @@ Oracle 9i.

    -

    timeout
    +
    timeout
    This read-write attribute indicates the time (in seconds) after which idle sessions will be terminated in order to maintain an optimum number of open @@ -150,14 +150,14 @@ Oracle 9i.

    -

    tnsentry
    +
    tnsentry
    This read-only attribute returns the TNS entry of the database to which a connection has been established.

    -

    username
    +
    username
    This read-only attribute returns the name of the user which established the connection to the database. @@ -198,7 +198,7 @@ Oracle 9i.
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007. diff --git a/html/varobj.html b/html/varobj.html index b45a710..a6e0f74 100644 --- a/html/varobj.html +++ b/html/varobj.html @@ -58,7 +58,7 @@ NOTE: The DB API definition does not define this object.

    -

    allocelems
    +
    allocelems
    This read-only attribute returns the number of elements allocated in an array, or the number of scalar items that can be fetched into the variable. @@ -66,21 +66,21 @@

    - +
    getvalue(getvalue( [pos=0])
    Return the value at the given position in the variable.

    -

    maxlength
    +
    maxlength
    This read-only attribute returns the maximum length of the variable.

    - +
    setvalue(setvalue( pos, value)
    Set the value at the given position in the variable. @@ -121,7 +121,7 @@
    -Release 4.3.1, documentation updated on April 18, 2007. +Release HEAD, documentation updated on October 1, 2007.