.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DBIx::SearchBuilder::Handle::Oracle 3pm"
.TH DBIx::SearchBuilder::Handle::Oracle 3pm "2016-08-07" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
.Vb 1
\&  DBIx::SearchBuilder::Handle::Oracle \- An oracle specific Handle object
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a subclass of DBIx::SearchBuilder::Handle that 
compensates for some of the idiosyncrasies of Oracle.
.SH "METHODS"
.IX Header "METHODS"
.SS "Connect \s-1PARAMHASH:\s0 Driver, Database, Host, User, Password"
.IX Subsection "Connect PARAMHASH: Driver, Database, Host, User, Password"
Takes a paramhash and connects to your \s-1DBI\s0 datasource.
.SS "BuildDSN"
.IX Subsection "BuildDSN"
Customized version of \*(L"BuildDSN\*(R" in DBIx::SearchBuilder::Handle method.
.PP
Takes additional argument \s-1SID.\s0 Database argument used unless \s-1SID\s0 provided.
Two forms of \s-1DSN\s0 are generated depending on whether Host defined or not:
.PP
.Vb 2
\&    dbi:Oracle:sid=<SID>;host=...[;port=...]
\&    dbi:Oracle:<SID>
.Ve
.PP
Read details in documentation for DBD::Oracle module.
.SS "Insert"
.IX Subsection "Insert"
Takes a table name as the first argument and assumes that the rest of the arguments
are an array of key-value pairs to be inserted.
.SS "InsertFromSelect"
.IX Subsection "InsertFromSelect"
Customization of \*(L"InsertFromSelect\*(R" in DBIx::SearchBuilder::Handle.
.PP
Unlike other DBs Oracle needs:
.IP "\(bu" 4
id generated from sequences for every new record.
.IP "\(bu" 4
query wrapping in parens.
.PP
\&\fB\s-1NOTE\s0\fR that on Oracle there is a limitation on the query. Every
column in the result should have unique name or alias, for example the
following query would generate \*(L"\s-1ORA\-00918:\s0 column ambiguously defined\*(R"
error:
.PP
.Vb 1
\&    SELECT g.id, u.id FROM ...
.Ve
.PP
Solve with aliases:
.PP
.Vb 1
\&    SELECT g.id AS group_id, u.id AS user_id FROM ...
.Ve
.SS "KnowsBLOBs"
.IX Subsection "KnowsBLOBs"
Returns 1 if the current database supports inserts of BLOBs automatically.      
Returns undef if the current database must be informed of BLOBs for inserts.
.SS "BLOBParams \s-1FIELD_NAME FIELD_TYPE\s0"
.IX Subsection "BLOBParams FIELD_NAME FIELD_TYPE"
Returns a hash ref for the bind_param call to identify \s-1BLOB\s0 types used by 
the current database for a particular column type.
The current Oracle implementation only supports \s-1ORA_CLOB\s0 types (112).
.SS "ApplyLimits \s-1STATEMENTREF ROWS_PER_PAGE FIRST_ROW\s0"
.IX Subsection "ApplyLimits STATEMENTREF ROWS_PER_PAGE FIRST_ROW"
takes an \s-1SQL SELECT\s0 statement and massages it to return \s-1ROWS_PER_PAGE\s0 starting with \s-1FIRST_ROW\s0;
.SS "DistinctQuery \s-1STATEMENTREF\s0"
.IX Subsection "DistinctQuery STATEMENTREF"
takes an incomplete \s-1SQL SELECT\s0 statement and massages it to return a \s-1DISTINCT\s0 result set.
.SS "BinarySafeBLOBs"
.IX Subsection "BinarySafeBLOBs"
Return undef, as Oracle doesn't support binary-safe \s-1CLOBS\s0
.SS "DatabaseVersion"
.IX Subsection "DatabaseVersion"
Returns value of \s-1ORA_OCI\s0 constant, see \*(L"Constants\*(R" in \s-1DBI\s0.
.SS "SimpleDateTimeFunctions"
.IX Subsection "SimpleDateTimeFunctions"
Returns hash reference with specific date time functions of this
database for \*(L"DateTimeFunction\*(R" in DBIx::SearchBuilder::Handle.
.SS "ConvertTimezoneFunction"
.IX Subsection "ConvertTimezoneFunction"
Custom implementation of \*(L"ConvertTimezoneFunction\*(R" in DBIx::SearchBuilder::Handle.
.PP
Use the following query to get list of timezones:
.PP
.Vb 1
\&    SELECT tzname FROM v$timezone_names;
.Ve
.PP
Read Oracle's docs about timezone files:
.PP
.Vb 1
\&    http://download.oracle.com/docs/cd/B14117_01/server.101/b10749/ch4datetime.htm#i1006667
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Jesse Vincent, jesse@fsck.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1), DBIx::SearchBuilder