[Jc @ s d Z d d k Z d d k Z d d k Z d d k l Z l Z l Z l Z d d k l
Z
l Z d d k l
Z
l Z d d k l Z l Z d d k l Z d e i f d YZ d
e i f d YZ d e i f d
YZ d e i f d YZ d e i f d YZ d e i f d YZ d e i! f d YZ" d e i# e" f d YZ$ d e i% f d YZ& d e i' f d YZ( d e i) f d YZ* d e* f d YZ+ d e i, f d! YZ- h e e i 6e e i 6e e i 6e e i. 6e e i 6e e i 6e" e i! 6e* e i) 6e- e i, 6e& e i% 6e e i 6e( e i' 6Z/ h e" d" 6e$ d# 6e" d$ 6e d% 6e d& 6e d' 6e* d( 6e* d) 6e& d* 6e d+ 6e+ d, 6e d- 6e d. 6e& d/ 6Z0 d0 e
i1 f d1 YZ2 d2 e
i3 f d3 YZ4 d4 e i5 f d5 YZ6 d6 e
i7 f d7 YZ8 d8 e
i9 f d9 YZ: d: e
i; f d; YZ< d< e i= f d= YZ> d> e
i? f d? YZ@ e4 ZA e8 eA _B e: eA _C e< eA _D e@ eA _E e> eA _F e2 eA _G d S(@ s/ Support for the Oracle database.
Oracle version 8 through current (11g at the time of this writing) are supported.
Driver
------
The Oracle dialect uses the cx_oracle driver, available at
http://cx-oracle.sourceforge.net/ . The dialect has several behaviors
which are specifically tailored towards compatibility with this module.
Connecting
----------
Connecting with create_engine() uses the standard URL approach of
``oracle://user:pass@host:port/dbname[?key=value&key=value...]``. If dbname is present, the
host, port, and dbname tokens are converted to a TNS name using the cx_oracle
:func:`makedsn()` function. Otherwise, the host token is taken directly as a TNS name.
Additional arguments which may be specified either as query string arguments on the
URL, or as keyword arguments to :func:`~sqlalchemy.create_engine()` are:
* *allow_twophase* - enable two-phase transactions. Defaults to ``True``.
* *auto_convert_lobs* - defaults to True, see the section on LOB objects.
* *auto_setinputsizes* - the cx_oracle.setinputsizes() call is issued for all bind parameters.
This is required for LOB datatypes but can be disabled to reduce overhead. Defaults
to ``True``.
* *mode* - This is given the string value of SYSDBA or SYSOPER, or alternatively an
integer value. This value is only available as a URL query string argument.
* *threaded* - enable multithreaded access to cx_oracle connections. Defaults
to ``True``. Note that this is the opposite default of cx_oracle itself.
* *use_ansi* - Use ANSI JOIN constructs (see the section on Oracle 8). Defaults
to ``True``. If ``False``, Oracle-8 compatible constructs are used for joins.
* *optimize_limits* - defaults to ``False``. see the section on LIMIT/OFFSET.
Auto Increment Behavior
-----------------------
SQLAlchemy Table objects which include integer primary keys are usually assumed to have
"autoincrementing" behavior, meaning they can generate their own primary key values upon
INSERT. Since Oracle has no "autoincrement" feature, SQLAlchemy relies upon sequences
to produce these values. With the Oracle dialect, *a sequence must always be explicitly
specified to enable autoincrement*. This is divergent with the majority of documentation
examples which assume the usage of an autoincrement-capable database. To specify sequences,
use the sqlalchemy.schema.Sequence object which is passed to a Column construct::
t = Table('mytable', metadata,
Column('id', Integer, Sequence('id_seq'), primary_key=True),
Column(...), ...
)
This step is also required when using table reflection, i.e. autoload=True::
t = Table('mytable', metadata,
Column('id', Integer, Sequence('id_seq'), primary_key=True),
autoload=True
)
LOB Objects
-----------
cx_oracle presents some challenges when fetching LOB objects. A LOB object in a result set
is presented by cx_oracle as a cx_oracle.LOB object which has a read() method. By default,
SQLAlchemy converts these LOB objects into Python strings. This is for two reasons. First,
the LOB object requires an active cursor association, meaning if you were to fetch many rows
at once such that cx_oracle had to go back to the database and fetch a new batch of rows,
the LOB objects in the already-fetched rows are now unreadable and will raise an error.
SQLA "pre-reads" all LOBs so that their data is fetched before further rows are read.
The size of a "batch of rows" is controlled by the cursor.arraysize value, which SQLAlchemy
defaults to 50 (cx_oracle normally defaults this to one).
Secondly, the LOB object is not a standard DBAPI return value so SQLAlchemy seeks to
"normalize" the results to look more like other DBAPIs.
The conversion of LOB objects by this dialect is unique in SQLAlchemy in that it takes place
for all statement executions, even plain string-based statements for which SQLA has no awareness
of result typing. This is so that calls like fetchmany() and fetchall() can work in all cases
without raising cursor errors. The conversion of LOB in all cases, as well as the "prefetch"
of LOB objects, can be disabled using auto_convert_lobs=False.
LIMIT/OFFSET Support
--------------------
Oracle has no support for the LIMIT or OFFSET keywords. Whereas previous versions of SQLAlchemy
used the "ROW NUMBER OVER..." construct to simulate LIMIT/OFFSET, SQLAlchemy 0.5 now uses
a wrapped subquery approach in conjunction with ROWNUM. The exact methodology is taken from
http://www.oracle.com/technology/oramag/oracle/06-sep/o56asktom.html . Note that the
"FIRST ROWS()" optimization keyword mentioned is not used by default, as the user community felt
this was stepping into the bounds of optimization that is better left on the DBA side, but this
prefix can be added by enabling the optimize_limits=True flag on create_engine().
Two Phase Transaction Support
-----------------------------
Two Phase transactions are implemented using XA transactions. Success has been reported of them
working successfully but this should be regarded as an experimental feature.
Oracle 8 Compatibility
----------------------
When using Oracle 8, a "use_ansi=False" flag is available which converts all
JOIN phrases into the WHERE clause, and in the case of LEFT OUTER JOIN
makes use of Oracle's (+) operator.
Synonym/DBLINK Reflection
-------------------------
When using reflection with Table objects, the dialect can optionally search for tables
indicated by synonyms that reference DBLINK-ed tables by passing the flag
oracle_resolve_synonyms=True as a keyword argument to the Table construct. If DBLINK
is not in use this flag should be left off.
iN( t utilt sqlt schemat log( t defaultt base( t compilert visitors( t operatorst functions( t typest
OracleNumericc B s e Z d Z RS( c C s5 | i d j o d Sd h | i d 6| i d 6Sd S( Nt NUMERICs! NUMERIC(%(precision)s, %(scale)s)t precisiont scale( R
t NoneR ( t self( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt get_col_spec s ( t __name__t
__module__R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s t
OracleIntegerc B s e Z d Z RS( c C s d S( Nt INTEGER( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s t OracleSmallIntegerc B s e Z d Z RS( c C s d S( Nt SMALLINT( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s t
OracleDatec B s# e Z d Z d Z d Z RS( c C s d S( Nt DATE( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c C s d S( N( R ( R t dialect( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt bind_processor s c C s
d } | S( Nc S s& t | t i p | S| i Sd S( N( t
isinstancet datetimet date( t value( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt process s ( ( R R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt result_processor s ( R R R R R! ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s t OracleDateTimec B s e Z d Z d Z RS( c C s d S( NR ( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c C s
d } | S( Nc S sW | d j p t | t i o | St i | i | i | i | i | i | i Sd S( N( R R R t yeart montht dayt hourt minutet second( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( ( R R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR! s ( R R R R! ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR" s t OracleTimestampc B s# e Z d Z d Z d Z RS( c C s d S( Nt TIMESTAMP( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c C s | i S( N( R* ( R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt get_dbapi_type s c C s
d } | S( Nc S sW | d j p t | t i o | St i | i | i | i | i | i | i Sd S( N( R R R R# R$ R% R& R' R( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( ( R R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR! s ( R R R R+ R! ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR) s t OracleStringc B s e Z d Z RS( c C s d h | i d 6S( Ns VARCHAR(%(length)s)t length( R- ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR, s t OracleNVarcharc B s e Z d Z RS( c C s d h | i d 6S( Ns NVARCHAR2(%(length)s)R- ( R- ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR. s t
OracleTextc B s# e Z d Z d Z d Z RS( c C s | i S( N( t CLOB( R t dbapi( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR+ s c C s d S( NR0 ( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c sI t t | i | | i p S| i i f d } | S( Nc sP t | o& o | i S| i Sn o | S| Sd S( N( R t read( R ( t lobt
super_process( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( t superR/ R! t auto_convert_lobsR1 t LOB( R R R ( ( R3 R4 s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR! s
( R R R+ R R! ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR/ s t
OracleCharc B s e Z d Z RS( c C s d h | i d 6S( Ns CHAR(%(length)s)R- ( R- ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR8 s t OracleBinaryc B s, e Z d Z d Z d Z d Z RS( c C s | i S( N( t BLOB( R R1 ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR+ s c C s d S( NR: ( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c C s d S( N( R ( R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c s. | i p d S| i i f d } | S( Nc s# t | o | i S| Sd S( N( R R2 ( R ( R3 ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R6 R R1 R7 ( R R R ( ( R3 s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR! s
( R R R+ R R R! ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR9 s t OracleRawc B s e Z d Z RS( c C s d h | i d 6S( Ns RAW(%(length)s)R- ( R- ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR; s t
OracleBooleanc B s# e Z d Z d Z d Z RS( c C s d S( NR ( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s c C s
d } | S( Nc S s$ | d j o d S| o t p t S( N( R t Truet False( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR
s
( ( R R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR! s c C s
d } | S( Nc S sL | t j o d S| t j o d S| d j o d S| o t p t Sd S( Ni i ( R= R> R ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s
( ( R R R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s ( R R R R! R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR< s t VARCHAR2t NVARCHAR2t CHARR t DATETIMEt NUMBERR: t BFILER0 R* t RAWt FLOATs DOUBLE PRECISIONt LONGt OracleExecutionContextc B s# e Z d Z d Z d Z RS( c C s$ t t | i | i i o | i n | i d j o t | i d j o x | i i
D] } | i i
| } | i i | } | i d | } | i ov | i
i | i i | i i } t | d p
h | _ n | i i | | i | <| i | | i d | } | | j o+ t i | | t t | | | | q q W| i oH | i } | o t | } n d } | i i
| i | | i } n
| i } t d | i d | i
d | d | i d
| i } d | i j o | i d | d R R R R[ R R R R= R R R R t
ischema_namesR, t ret subt KeyErrorR t warnR t NULLTYPER t
DefaultClauseR t textt
append_columnt Columnt columnsR t tuplet primary_keyt addR` R t Tablet metadataRb t append_constraintt ForeignKeyConstraint(' R R^ t tablet include_columnst preparert resolve_synonymst actual_nameR R t synonymR` R t colnamet coltypeR- R
R R R t colargst fksR} t xt cons_namet cons_typet local_columnt remote_tablet
remote_columnt remote_ownert fkt ref_remote_namet ref_remote_ownert
ref_dblinkt ref_synonymt refspect tt _[2]R[ R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt reflecttable8 s C
&+
[
#'
"
Q
9!1>3
N( s dialectR (% R R R[ R= t supports_alterR> t supports_unicode_statementst max_identifier_lengtht supports_sane_rowcountt supports_sane_multi_rowcountt preexecute_pk_sequencest supports_pk_autoincrementt default_paramstyleRr R1 t classmethodR R R R R R R R R R R R R R R R R t connection_memoizeR R R ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRm m s@ )
*t _OuterJoinColumnc B s e Z d Z d Z RS( t outer_join_columnc C s
| | _ d S( N( Rj ( R Rj ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRr s ( R R t __visit_name__Rr ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR s t OracleCompilerc B s e Z d Z e i i i Z e i h d e i 6d e i
6 e i i i Z e i h d e i
6 d Z d Z d Z d Z d Z d Z d
Z e d Z d Z d
Z d Z d Z RS( s Oracle compiler modifies the lexical structure of Select
statements to work under non-ANSI configured Oracle databases, if
the use_ansi flag is False.
c C s d | | f S( s mod(%s, %s)( ( R t y( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt s c C s d | | f S( s CONTAINS (%s, %s)( ( R R" ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR# s t CURRENT_TIMESTAMPc O s& t t | i | | h | _ d S( N( R5 R! Rr t _OracleCompiler__wheres( R t argsR| ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRr s c C s d S( s Called when a ``SELECT`` statement has no froms, and no ``FROM`` clause is to be appended.
The Oracle compiler tacks a "FROM DUAL" to the statement.
s
FROM DUAL( ( R ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt default_from s c C s t | i d j S( Ni ( RN R ( R t func( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt apply_function_parens s c K sX | i i o t i i | | | S| i | i d t d | i | i d t Sd S( Nt asfroms , ( R Rs R t DefaultCompilert
visit_joinR t leftR= t right( R R R| ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR, s
c sM g f d } x( | D] } t i | h h | d 6 q Wt i S( Nc sW i o9 f d } i t i i h h | d 6 n i i d S( Nc ss | i t i j o\ | i i i j o t | i | _ qo | i i i j o t | i | _ qo n d S( N( t operatort
sql_operatorst eqR- R R. R ( t binary( R ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt visit_binary s
R2 ( t isouterR R t cloned_traverset onclause( R R3 ( R ( R s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR, s
*R ( R t traverseR t and_( R t fromsR, t f( ( R s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt _get_nonansi_join_whereclause s c C s | i | i d S( Ns (+)( R Rj ( R t vc( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt visit_outer_join_column s c C s | i i i | d S( Ns .nextval( R R t format_sequence( R t seq( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt visit_sequence s c K s[ | o= | i | i d | | d | i i | | i | i S| i | i | Sd S( sF Oracle doesn't like ``FROM table AS alias``. Is the AS standard SQL??R* t N( R t originalR t format_aliast
_anonymizeR[ ( R t aliasR* R| ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt visit_alias s =c C s d S( sN Need to determine how to get ``LIMIT``/``OFFSET`` into a ``UNION`` for Oracle.N( ( R t select( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt _TODO_visit_compound_select s c K s t | d d pW| i i p~ | i o) d | i d j o | i d d } n d } | i | } | i | } | o | i | } t | _ q n | i
d j p | i d j o| i } t | _ t
i g } | i D]
} | | q ~ } | i
o' | i i o | i d | i
} n t | _ t | _ | i
d j oJ | i
} | i d j o | | i 7} n | i t
i d | j n | i d j o
| } qf| i t
i d i d } t | _ t | _ t
i g }
| i D]! } | i d j o |
| qq~
} t | _ t | _ | i t
i d | i j | } qjn t | d t | d R R+ t visit_select( R RG R| t
existingfromsR9 t whereclauseR} R` t limitselectt max_rowR t offsetselect( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRY sN
-
; c C s d S( NR ( ( R RG ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt limit_clauseS s c C s/ | i d j o d St t | i | Sd S( Nt nowaits FOR UPDATE NOWAIT( t
for_updateR5 R! t for_update_clause( R RG ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRb V s ( R R t __doc__R R+ R t copyt updateR0 t modt match_opR t
sql_functionst nowRr R' R) R, R; R= R@ R> RF RH RY R_ Rb ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR! s,
G t OracleSchemaGeneratorc B s e Z d Z d Z RS( c K s | i i | } | d | i i | i i 7} | i | } | d j o | d | 7} n | i p | d 7} n | S( NRA s DEFAULT s NOT NULL( R t
format_columnRS RT R R t get_column_default_stringR R ( R Rj R| t colspecR ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt get_column_specification^ s #
c C s] | i p# | i i | i | i | i o+ | i d | i i | | i n d S( Ns CREATE SEQUENCE %s(
t
checkfirstR R R^ R[ R R R R> R ( R t sequence( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR@ i s . ( R R Rn R@ ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRj ] s t OracleSchemaDropperc B s e Z d Z RS( c C s\ | i p" | i i | i | i | i o+ | i d | i i | | i n d S( Ns DROP SEQUENCE %s(
Ro R R R^ R[ R R R R> R ( R Rp ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR@ o s - ( R R R@ ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRq n s t OracleDefaultRunnerc B s e Z d Z RS( c C s' | i d | i i i | d h S( Ns SELECT s .nextval FROM DUAL( t execute_stringR R R> ( R R? ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyR@ u s ( R R R@ ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRr t s t OracleIdentifierPreparerc B s e Z d Z RS( c C s1 t i d d | i } t t | i | | S( Ns ^_+R ( R R t identR5 Rt t format_savepoint( R t savepointR[ ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRv y s ( R R Rv ( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyRt x s (H Rc R R R t
sqlalchemyR R R R t sqlalchemy.engineR R t sqlalchemy.sqlR R R R0 R Rh R
R t NumericR t IntegerR t SmallintegerR t DateR t DateTimeR" R* R) t StringR, t UnicodeR. t TextR/ RA R8 t BinaryR9 R; t BooleanR< t FloatR R t DefaultExecutionContextRH Rq Rm t
ClauseElementR R+ R! t SchemaGeneratorRj t
SchemaDropperRq t
DefaultRunnerRr t IdentifierPreparerRt R t statement_compilert schemageneratort
schemadropperR t
defaultrunnert execution_ctx_cls( ( ( s? /usr/lib/python2.6/site-packages/sqlalchemy/databases/oracle.pyt | s~ $"
. K