[svn:dbd-oracle] r14847 - dbd-oracle/trunk
[email protected] Wed, 11 May 2011 01:03:09 -0700 (PDT)
| Newsgroups | perl.dbd.oracle.changes |
|---|---|
| Message-ID | <[email protected]> |
Author: mjevans
Date: Wed May 11 01:03:09 2011
New Revision: 14847
Modified:
dbd-oracle/trunk/Oracle.pm
Log:
Remove trailing white space from Oracle.pm
Modified: dbd-oracle/trunk/Oracle.pm
==============================================================================
--- dbd-oracle/trunk/Oracle.pm (original)
+++ dbd-oracle/trunk/Oracle.pm Wed May 11 01:03:09 2011
@@ -25,15 +25,15 @@
ORA_VARCHAR2 ORA_STRING ORA_NUMBER ORA_LONG ORA_ROWID ORA_DATE
ORA_RAW ORA_LONGRAW ORA_CHAR ORA_CHARZ ORA_MLSLABEL ORA_XMLTYPE
ORA_CLOB ORA_BLOB ORA_RSET ORA_VARCHAR2_TABLE ORA_NUMBER_TABLE
- SQLT_INT SQLT_FLT ORA_OCI SQLT_CHR SQLT_BIN
+ SQLT_INT SQLT_FLT ORA_OCI SQLT_CHR SQLT_BIN
) ],
ora_session_modes => [ qw( ORA_SYSDBA ORA_SYSOPER ) ],
- ora_fetch_orient => [ qw( OCI_FETCH_NEXT OCI_FETCH_CURRENT OCI_FETCH_FIRST
- OCI_FETCH_LAST OCI_FETCH_PRIOR OCI_FETCH_ABSOLUTE
+ ora_fetch_orient => [ qw( OCI_FETCH_NEXT OCI_FETCH_CURRENT OCI_FETCH_FIRST
+ OCI_FETCH_LAST OCI_FETCH_PRIOR OCI_FETCH_ABSOLUTE
OCI_FETCH_RELATIVE)],
ora_exe_modes => [ qw( OCI_STMT_SCROLLABLE_READONLY)],
ora_fail_over => [ qw( OCI_FO_END OCI_FO_ABORT OCI_FO_REAUTH OCI_FO_BEGIN
- OCI_FO_ERROR OCI_FO_NONE OCI_FO_SESSION OCI_FO_SELECT
+ OCI_FO_ERROR OCI_FO_NONE OCI_FO_SESSION OCI_FO_SELECT
OCI_FO_TXNAL)],
);
@EXPORT_OK = qw(OCI_FETCH_NEXT OCI_FETCH_CURRENT OCI_FETCH_FIRST OCI_FETCH_LAST OCI_FETCH_PRIOR
@@ -52,7 +52,7 @@
sub CLONE {
$drh = undef ;
}
-
+
sub driver{
return $drh if $drh;
my($class, $attr) = @_;
@@ -87,7 +87,7 @@
DBD::Oracle::st->install_method("ora_stmt_type_name");
DBD::Oracle::st->install_method("ora_stmt_type");
$drh;
-
+
}
@@ -196,12 +196,12 @@
if ((exists $dbname{SERVER}) and ($dbname{SERVER} eq "POOLED")) {
$attr->{ora_drcp}=1;
}
-
+
# extract main attributes for connect_data portion
my @connect_data_attr = qw(SID INSTANCE_NAME SERVER SERVICE_NAME );
my %connect_data = map { ($_ => delete $dbname{$_}) }
grep { exists $dbname{$_} } @connect_data_attr;
-
+
my $connect_data = join "", map { "($_=$connect_data{$_})" } keys %connect_data;
return $drh->DBI::set_err(-1,
"Can't connect using this syntax without specifying a HOST and one of @connect_data_attr")
@@ -232,15 +232,15 @@
$user = '' if not defined $user;
(my $user_only = $user) =~ s:/.*::;
-
+
if (substr($dbname,-7,7) eq ':POOLED'){
$dbname=substr($dbname,0,-7);
$attr->{ora_drcp} = 1;
}
- elsif ($ENV{ORA_DRCP}){
+ elsif ($ENV{ORA_DRCP}){
$attr->{ora_drcp} = 1;
}
-
+
my ($dbh, $dbh_inner) = DBI::_new_dbh($drh, {
'Name' => $dbname,
'dbi_imp_data' => $attr->{dbi_imp_data},
@@ -250,13 +250,13 @@
# Call Oracle OCI logon func in Oracle.xs file
# and populate internal handle data.
-
-
+
+
if (exists $ENV{ORA_DRCP_CLASS}) {
$attr->{ora_drcp_class} = $ENV{ORA_DRCP_CLASS}
}
if($attr->{ora_drcp_class}){
- # if using ora_drcp_class it cannot contain more than 1024 bytes
+ # if using ora_drcp_class it cannot contain more than 1024 bytes
# and cannot contain a *
if (index($attr->{ora_drcp_class},'*') !=-1){
Carp::croak("ora_drcp_class cannot contain a '*'!");
@@ -274,7 +274,7 @@
if (exists $ENV{ORA_DRCP_INCR}) {
$attr->{ora_drcp_incr} = $ENV{ORA_DRCP_INCR}
}
-
+
{
local @SIG{ @{ $attr->{ora_connect_with_default_signals} } }
if $attr->{ora_connect_with_default_signals};
@@ -294,9 +294,9 @@
$dbh->{'ora_ncs_buff_mtpl'}= $ENV{ORA_DBD_NCS_BUFFER};
}
$dbh;
-
+
}
-
+
sub private_attribute_info {
return { ora_home_key=>undef};
}
@@ -307,7 +307,7 @@
{ package DBD::Oracle::db; # ====== DATABASE ======
use strict;
use DBI qw(:sql_types);
-
+
sub prepare {
my($dbh, $statement, @attribs)= @_;
@@ -331,7 +331,7 @@
#then the cost came out of the operating budget
#not the capital ...
- sub ping {
+ sub ping {
my($dbh) = @_;
local $@;
my $ok = 0;
@@ -384,10 +384,10 @@
ora_taf => undef,
ora_taf_function => undef,
ora_taf_sleep => undef,
-
+
};
}
-
+
sub table_info {
my($dbh, $CatVal, $SchVal, $TblVal, $TypVal) = @_;
@@ -499,7 +499,7 @@
if (ref $catalog eq 'HASH') {
($schema, $table) = @$catalog{'TABLE_SCHEM','TABLE_NAME'};
$catalog = undef;
- }
+ }
my $SQL = <<'SQL';
SELECT *
FROM
@@ -793,7 +793,7 @@
40, # column size
"TIMESTAMP'", # literal prefix
"'", # literal suffix
- "precision", # create params
+ "precision", # create params
1, # nullable
0, # case sensitive
3, # searchable
@@ -801,14 +801,14 @@
0, # fixed prec scale
0, # auto unique value
undef, # local type name
- 0, # minimum scale
+ 0, # minimum scale
6, # maximum scale
- SQL_TIMESTAMP, # sql data type
+ SQL_TIMESTAMP, # sql data type
5, # sql datetime sub
undef, # num prec radix
undef, # interval precision
],
- [ "INTERVAL DAY TO SECOND", # type name
+ [ "INTERVAL DAY TO SECOND", # type name
SQL_INTERVAL_DAY_TO_SECOND, # data type
22, # column size '+00 11:12:10.222222200'
"INTERVAL'", # literal prefix
@@ -821,14 +821,14 @@
0, # fixed prec scale
0, # auto unique value
undef, # local type name
- 0, # minimum scale
- 9, # maximum scale
- SQL_INTERVAL, # sql data type
+ 0, # minimum scale
+ 9, # maximum scale
+ SQL_INTERVAL, # sql data type
10, # sql datetime sub
undef, # num prec radix
undef, # interval precision
],
- [ "INTERVAL YEAR TO MONTH", # type name
+ [ "INTERVAL YEAR TO MONTH", # type name
SQL_INTERVAL_YEAR_TO_MONTH, # data type
13, # column size '+012345678-01'
"INTERVAL'", # literal prefix
@@ -841,15 +841,15 @@
0, # fixed prec scale
0, # auto unique value
undef, # local type name
- 0, # minimum scale
- 9, # maximum scale
- SQL_INTERVAL, # sql data type
+ 0, # minimum scale
+ 9, # maximum scale
+ SQL_INTERVAL, # sql data type
7, # sql datetime sub
undef, # num prec radix
undef, # interval precision
]
];
-
+
return $type_info_all;
}
@@ -890,7 +890,7 @@
my $version = join ".", @{ ora_server_version($dbh) }[0..1];
my $len = 32767;
if ($version < 10.2){
- $len = 400;
+ $len = 400;
}
# line can be greater that 255 (e.g. 7 byte date is expanded on output)
$sth->bind_param_inout(':l', \$line, $len, { ora_type => 1 });
@@ -915,7 +915,7 @@
return 1;
}
-
+
sub dbms_msgpipe_get {
my $dbh = shift;
my $sth = $dbh->prepare_cached(q{
@@ -1000,23 +1000,23 @@
my ($p_id, $value_array,$maxlen, $attr) = @_;
return $sth->set_err($DBI::stderr, "Value for parameter $p_id must be an arrayref, not a ".ref($value_array))
if defined $value_array and ref $value_array and ref $value_array ne 'ARRAY';
-
+
return $sth->set_err($DBI::stderr, "Can't use named placeholder '$p_id' for non-driver supported bind_param_inout_array")
unless DBI::looks_like_number($p_id); # because we rely on execute(@ary) here
-
+
return $sth->set_err($DBI::stderr, "Placeholder '$p_id' is out of range")
if $p_id <= 0; # can't easily/reliably test for too big
-
+
# get/create arrayref to hold params
my $hash_of_arrays = $sth->{ParamArrays} ||= { };
-
+
$$hash_of_arrays{$p_id} = $value_array;
return ora_bind_param_inout_array($sth, $p_id, $value_array,$maxlen, $attr);
1;
}
-
-
+
+
sub execute_for_fetch {
my ($sth, $fetch_tuple_sub, $tuple_status) = @_;
my $row_count = 0;
@@ -1029,7 +1029,7 @@
@$tuple_status = ();
$tuple_batch_status = [ ];
}
-
+
my $finished;
while (1) {
my @tuple_batch;
@@ -1039,38 +1039,38 @@
}
last unless @tuple_batch;
-
+
my $res = ora_execute_array($sth,
\@tuple_batch,
scalar(@tuple_batch),
$tuple_batch_status,
$err_count );
-
+
if(defined($res)) { #no error
$row_count += $res;
} else {
$row_count = undef;
}
-
+
$tuple_count+=@$tuple_batch_status;
push @$tuple_status, @$tuple_batch_status
if defined($tuple_status);
-
- last if !$finished;
-
+
+ last if !$finished;
+
}
#error check here
return $sth->set_err($DBI::stderr, "executing $tuple_count generated $err_count errors")
if $err_count;
-
+
if (!wantarray) {
return $tuple_count;
}
return ($tuple_count, defined $row_count ? $row_count : undef);
-
-
-
+
+
+
}
sub private_attribute_info {
@@ -1109,19 +1109,19 @@
=head1 DESCRIPTION
DBD::Oracle is a Perl module which works with the DBI module to provide
-access to Oracle databases.
+access to Oracle databases.
=head1 Which version DBD::Oracle is for me?
From version 1.25 onwards DBD::Oracle will only support Oracle clients 9.2 or greater as well
-support for ProC connections was dropped in 1.29. This is especially so with the many new functions
+support for ProC connections was dropped in 1.29. This is especially so with the many new functions
being introduced in 10g and 11g.
If you are still stuck with an older version of Oracle or its client you might want to look at the table below.
+---------------------+-----------------------------------------------------+
- | | Oracle Version |
+ | | Oracle Version |
+---------------------+----+-------------+---------+------+--------+--------+
| DBD::Oracle Version | <8 | 8.0.3~8.0.6 | 8iR1~R2 | 8iR3 | 9i | 9.2~11 |
+---------------------+----+-------------+---------+------+--------+--------+
@@ -1140,10 +1140,10 @@
| 1.25+ | N | N | N | N | N | Y |
+---------------------+----+-------------+---------+------+--------+--------+
-As there are dozens and dozens of different versions of Oracle's clients I did not bother to list any of them, just the
-major release versions of Oracle that are out there.
+As there are dozens and dozens of different versions of Oracle's clients I did not bother to list any of them, just the
+major release versions of Oracle that are out there.
-Note that one can still connect to any Oracle version with the older DBD::Oracle versions the only problem you will
+Note that one can still connect to any Oracle version with the older DBD::Oracle versions the only problem you will
have is that some of the newer OCI and Oracle features available in later DBD::Oracle releases will not be available to you.
So to make a short story a little longer;
@@ -1153,22 +1153,22 @@
2) If you have to use an Oracle 7 client then DBD::Oracle 1.17 should work
3) Same thing for 8 up to R2, use 1.17, if you are lucky and have the right patch-set you might
go with 1.18.
- 4) For 8iR3 you can use any of the DBD::Oracle versions up to 1.21. Again this depends on your
+ 4) For 8iR3 you can use any of the DBD::Oracle versions up to 1.21. Again this depends on your
patch-set, If you run into trouble go with 1.19
5) After 9.2 you can use any version you want.
- 6) For you Luddites out there ORAPERL still works and is still included but not updated or
+ 6) For you Luddites out there ORAPERL still works and is still included but not updated or
supported anymore and will be removed in 1.29.
- 7) It seems that the 10g client can only connect to 9 and 11 DBs while the 9 can go back to 7
+ 7) It seems that the 10g client can only connect to 9 and 11 DBs while the 9 can go back to 7
and even get to 10. I am not sure what the 11g client can connect to.
-
+
=head1 CONNECTING TO ORACLE
This is a topic which often causes problems. Mainly due to Oracle's many
and sometimes complex ways of specifying and connecting to databases.
James Taylor and Lane Sharman have contributed much of the text in
-this section. Unfortunately it is only really relative for connecting into older Oracle (<9) versions.
-Most of this stuff is well out of date but it will be left in for now.
+this section. Unfortunately it is only really relative for connecting into older Oracle (<9) versions.
+Most of this stuff is well out of date but it will be left in for now.
See the next section L</CONNECTING TO ORACLE II> for some more up to date connection hints.
=head2 Connecting without environment variables or tnsnames.ora file
@@ -1187,7 +1187,7 @@
=head2 Oracle Environment Variables
Oracle typically no longer needs two environment variables to specify default
-connections: ORACLE_SID and TWO_TASK.
+connections: ORACLE_SID and TWO_TASK.
ORACLE_SID is really unnecessary to set since TWO_TASK provides the
same functionality in addition to allowing remote connections.
@@ -1215,8 +1215,8 @@
will use the info stored in the SQL*Net v2 F<tnsnames.ora>
configuration file for local or remote connections.
-Support for 'T:' syntax of Oracle SQL*Net V1 is only supported on older 7 clients and
-I have my doubts it will even work if the DB or client has been patched and I know it
+Support for 'T:' syntax of Oracle SQL*Net V1 is only supported on older 7 clients and
+I have my doubts it will even work if the DB or client has been patched and I know it
will not work on any later clients.
The ORACLE_HOME environment variable should be set correctly.
@@ -1311,40 +1311,40 @@
=head1 CONNECTING TO ORACLE II
-If you are reading this it is assumed that DBD::Oracle has been successfully installed on you PERL instance and
+If you are reading this it is assumed that DBD::Oracle has been successfully installed on you PERL instance and
you are having some problems connecting to Oracle.
First off you will have to tell DBD::Oracle where the binaries reside for the Oracle client it was compiled against.
This is the case when you encounter a
- DBI connect('','system',...) failed: ERROR OCIEnvNlsCreate.
-
-error in Linux or in Windows when you get
+ DBI connect('','system',...) failed: ERROR OCIEnvNlsCreate.
+
+error in Linux or in Windows when you get
OCI.DLL not found
-
-The solution to this problem in the case of Linux is to ensure your 'ORACLE_HOME' environment variable points to the correct directory.
+
+The solution to this problem in the case of Linux is to ensure your 'ORACLE_HOME' environment variable points to the correct directory.
export ORACLE_HOME=/app/oracle/product/xx.x.x
-For Windows solution is to add this value to you PATH
+For Windows solution is to add this value to you PATH
PATH=c:\app\oracle\product\xx.x.x;%PATH%
-
+
If you get past this stage and get a
- ORA-12154: TNS:could not resolve the connect identifier specified
-
-error then the most likely cause is DBD::ORACLE cannot find your .ORA (TNSNAMES.ORA, LISTENER.ORA, SQLNET.ORA) files. This can be solved by setting the
+ ORA-12154: TNS:could not resolve the connect identifier specified
+
+error then the most likely cause is DBD::ORACLE cannot find your .ORA (TNSNAMES.ORA, LISTENER.ORA, SQLNET.ORA) files. This can be solved by setting the
TNS_ADMIN environment variable to the directory where these files can be found.
If you get to this stage and you then either one of the following errors;
ORA-12560: TNS:protocol adapter error
- ORA-12162: TNS:net service name is incorrectly specified
+ ORA-12162: TNS:net service name is incorrectly specified
-usually means that DBD::Oracle can find the listener but the it cannot connect to the DB because the listener cannot find the DB you asked for.
+usually means that DBD::Oracle can find the listener but the it cannot connect to the DB because the listener cannot find the DB you asked for.
=head2 Connection Examples Using DBD::Oracle
@@ -1363,13 +1363,13 @@
Given this TNS entry;
- DB.TEST =
- (DESCRIPTION =
+ DB.TEST =
+ (DESCRIPTION =
(ADDRESS =
(PROTOCOL = TCP)
(HOST = xxx.xxx.xxx.xx)
- (PORT = 1523))
- (CONNECT_DATA = (SID = DB) )
+ (PORT = 1523))
+ (CONNECT_DATA = (SID = DB) )
)
and this code
@@ -1377,9 +1377,9 @@
BEGIN {
$ENV{ORACLE_SID} = 'DB';
}
-
+
$dbh = DBI->connect('dbi:Oracle:','username/password','');
-
+
you will be able to connect to DB. Note this may not work for Windows.
TWO_TASK works the same way except it should override the value in ORACLE_SID so this
@@ -1387,30 +1387,30 @@
BEGIN {
$ENV{ORACLE_SID} = 'DB';
$ENV{TWO_TASK} = 'DB.TEST';
-
+
}
-
+
$dbh = DBI->connect('dbi:Oracle:','username/password','');
-
+
will work as well. Note this may not work for Windows.
=head2 Oracle DRCP
DBD::Oracle now supports DRCP (Database Resident Connection Pool) so if you have an 11.2 database and the DRCP is turned on
-you can now direct all of your connections to it simply adding ':POOLED' to the SID or setting a connection attribute of ora_drcp, or
-set the SERVER=POOLED when using a TNSENTRY style connection or even by setting an environment variable ORA_DRCP.
+you can now direct all of your connections to it simply adding ':POOLED' to the SID or setting a connection attribute of ora_drcp, or
+set the SERVER=POOLED when using a TNSENTRY style connection or even by setting an environment variable ORA_DRCP.
All of which are demonstrated below;
$dbh = DBI->connect('dbi:Oracle:DB:POOLED','username','password')
$dbh = DBI->connect('dbi:Oracle:','username@DB:POOLED','password')
-
+
$dbh = DBI->connect('dbi:Oracle:DB','username','password',{ora_drcp=>1})
-
+
$dbh = DBI->connect('dbi:Oracle:DB','username','password',{ora_drcp=>1,
ora_drcp_class=>'my_app',
ora_drcp_min =>10})
-
+
$dbh = DBI->connect('dbi:Oracle:host=foobar;sid=ORCL;port=1521;SERVER=POOLED', 'scott/tiger', '')
$dbh = DBI->connect('dbi:Oracle:', q{scott/tiger@(DESCRIPTION=
@@ -1418,51 +1418,51 @@
(CONNECT_DATA=(SID=ORCL)(SERVER=POOLED)))}, "")
if ORA_DRCP environment var is set the just this
-
+
$dbh = DBI->connect('dbi:Oracle:DB','username','password')
-
+
You can find a white paper on setting up DRCP and its advantages here http://www.oracle.com/technology/tech/oci/pdf/oracledrcp11g.pdf
At this point in time this is just the first crack at DRCP and DBD::Oracle so the mechanics or its implementation are subject to change.
=head2 TAF (Transparent Application Failover)
-Transparent Application Failover (TAF) is a longstanding default feature in OCI that allows for clients to automatically reconnect to
+Transparent Application Failover (TAF) is a longstanding default feature in OCI that allows for clients to automatically reconnect to
an instance in the event of a failure of the instance. The reconnect happens automatically from within the OCI (Oracle Call Interface) library.
-DBD::Oracle now supports a callback function that will fire when a TAF event takes place. The main use of the callback is to give the
-oppertunity for the program to inform the user that a failover is taking place.
+DBD::Oracle now supports a callback function that will fire when a TAF event takes place. The main use of the callback is to give the
+oppertunity for the program to inform the user that a failover is taking place.
-You will have to set up TAF on your instance before you can use this callback. You can test your instance to see if you can use TAF callback with
+You will have to set up TAF on your instance before you can use this callback. You can test your instance to see if you can use TAF callback with
$dbh->ora_can_taf();
-
+
If you try to set up a callback without it being enable DBD::Oracle will croak.
It is outside the scope of this documents to go through all of the possiable TAF situations you might want to set up. Below is the simplest of examples;
-The TNS entry for the instace has had the following added to the CONNECT_DATA portion
+The TNS entry for the instace has had the following added to the CONNECT_DATA portion
(FAILOVER_MODE=
- (TYPE=select)
+ (TYPE=select)
(METHOD=basic)
(RETRIES=10)
(DELAY=10))
-You will also have to create your on perl function that will be called from the client. You can name it anything you want and it will allways have
-two parameters, the failover event value and the failover type. You can also set a sleep value in case of failover error and the oci client will sleep
+You will also have to create your on perl function that will be called from the client. You can name it anything you want and it will allways have
+two parameters, the failover event value and the failover type. You can also set a sleep value in case of failover error and the oci client will sleep
for the entered seconds before it attempts another event.
use DBD::Oracle(qw(:ora_fail_over));
- #import the ora_fail_over constancts
-
+ #import the ora_fail_over constancts
+
#set up TAF on the conection
my $dbh = DBI->connect('dbi:Oracle:XE','hr','hr',{ora_taf=>1,taf_sleep=>5,ora_taf_function=>'handle_taft'});
-
- #create the perl TAF event function
-
+
+ #create the perl TAF event function
+
sub handle_taf {
my ($fo_event,$fo_type) = @_;
if ($fo_event == OCI_FO_BEGIN){
-
+
print(" Instance Unavailable Please stand by!! \n");
printf(" Your TAF type is %s \n",
(($fo_type==OCI_FO_NONE) ? "NONE"
@@ -1487,7 +1487,7 @@
}
else {
printf(" Bad Failover Event: %d.\n", $fo_event);
-
+
}
return 0;
}
@@ -1601,9 +1601,9 @@
=item :ora_types
ORA_VARCHAR2 ORA_STRING ORA_NUMBER ORA_LONG ORA_ROWID ORA_DATE ORA_RAW
- ORA_LONGRAW ORA_CHAR ORA_CHARZ ORA_MLSLABEL ORA_XMLTYPE ORA_CLOB ORA_BLOB
- ORA_RSET ORA_VARCHAR2_TABLE ORA_NUMBER_TABLE SQLT_INT SQLT_FLT ORA_OCI
- SQLT_CHR SQLT_BIN
+ ORA_LONGRAW ORA_CHAR ORA_CHARZ ORA_MLSLABEL ORA_XMLTYPE ORA_CLOB ORA_BLOB
+ ORA_RSET ORA_VARCHAR2_TABLE ORA_NUMBER_TABLE SQLT_INT SQLT_FLT ORA_OCI
+ SQLT_CHR SQLT_BIN
=over 4
@@ -1646,17 +1646,17 @@
=item :ora_fetch_orient
OCI_FETCH_CURRENT OCI_FETCH_NEXT OCI_FETCH_FIRST OCI_FETCH_LAST
- OCI_FETCH_PRIOR OCI_FETCH_ABSOLUTE OCI_FETCH_RELATIVE
+ OCI_FETCH_PRIOR OCI_FETCH_ABSOLUTE OCI_FETCH_RELATIVE
These constants are used to set the orientation of a fetch on a scrollable cursor.
=item :ora_exe_modes
- OCI_STMT_SCROLLABLE_READONLY
+ OCI_STMT_SCROLLABLE_READONLY
=item :ora_fail_over
- OCI_FO_END OCI_FO_ABORT OCI_FO_REAUTH OCI_FO_BEGIN OCI_FO_ERROR
+ OCI_FO_END OCI_FO_ABORT OCI_FO_REAUTH OCI_FO_BEGIN OCI_FO_ERROR
OCI_FO_NONE OCI_FO_SESSION OCI_FO_SELECT OCI_FO_TXNAL
=back
@@ -1670,10 +1670,10 @@
=item ora_ncs_buff_mtpl
You can now customize the size of the buffer when selecting LOBs with
-the built in AUTO Lob. The default value is 4 which should is actually excessive
-for most situations but is needed for backward compatibility.
-If you not converting between a NCS on the DB and the Client then you might
-want to set this to 1 to free up memory.
+the built in AUTO Lob. The default value is 4 which should is actually excessive
+for most situations but is needed for backward compatibility.
+If you not converting between a NCS on the DB and the Client then you might
+want to set this to 1 to free up memory.
For convenience I have added support for a 'ORA_DBD_NCS_BUFFER'
environment variable that you can use at the OS level to set this
@@ -1684,16 +1684,16 @@
=item ora_drcp
If you have an 11.2 or greater database your can utilize the DRCP by setting
-this attribute to 1 at connect time.
+this attribute to 1 at connect time.
For convenience I have added support for a 'ORA_DRCP'
environment variable that you can use at the OS level to set this
-value.
+value.
=item ora_drcp_class
If you are using DRCP, you can set a CONNECTION_CLASS for your pools as well.
-As sessions from a DRCP cannot be shared by users, you can use this
+As sessions from a DRCP cannot be shared by users, you can use this
setting to identify the same user across different applications. OCI will ensure that
session belonging to a 'class' are not shared outside the class'.
@@ -1708,7 +1708,7 @@
The default value is '4' and any value above '0' is valid.
-Generally, it should be set to the number of concurrent statements the application is planning
+Generally, it should be set to the number of concurrent statements the application is planning
or expecting to run.
This value can be set at the environment level with 'ORA_DRCP_MIN'.
@@ -1716,8 +1716,8 @@
=item ora_drcp_max
Is an optional value that specifies the maximum number of sessions that can be open at one time.
-Once reached no more session can be opened until one becomes free. The default value
-is '40' and any value above '1' is valid. You should not set this value lower than ora_drcp_min as
+Once reached no more session can be opened until one becomes free. The default value
+is '40' and any value above '1' is valid. You should not set this value lower than ora_drcp_min as
that will just waste resources.
This value can be set at the environment level with 'ORA_DRCP_MAX'.
@@ -1743,7 +1743,7 @@
sub taf_event{
my ($event,$type)=@_;
-
+
print "My TAF event=$event\n";
print "My TAF type=$type\n";
return;
@@ -1797,16 +1797,16 @@
monitoring and performance tuning purposes. For example:
my $dbh = DBI->connect($dsn, $user, $passwd, { ora_module_name => $0 });
-
- $dbh{ora_module_name} = $y;
+
+ $dbh{ora_module_name} = $y;
=item ora_driver_name
For 11g and later you can now set the name of the driver layer using OCI.
PERL, PERL5, ApachePerl so on. Names starting with "ORA" are reserved. You
can enter up to 8 characters. If none is enter then this will default to
-DBDOxxxx where xxxx is the current version number. This value can be
-retrieved on the server side using V$SESSION_CONNECT_INFO or
+DBDOxxxx where xxxx is the current version number. This value can be
+retrieved on the server side using V$SESSION_CONNECT_INFO or
GV$SESSION_CONNECT_INFO
@@ -1817,7 +1817,7 @@
=item ora_client_info
When passed in on the connection attributes it can specify any info you want
-onto the session up to 64 bytes. This value can be
+onto the session up to 64 bytes. This value can be
retrieved on the server side using V$SESSION view.
my $dbh = DBI->connect($dsn, $user, $passwd, { ora_client_info => 'Remote2' });
@@ -1826,12 +1826,12 @@
=item ora_client_identifier
-When passed in on the connection attributes it specifies the user identifier
+When passed in on the connection attributes it specifies the user identifier
in the session handle. Most useful for web app as it can pass in the session
-user name which might be different than the connection user name. Can be up
+user name which might be different than the connection user name. Can be up
to 64 bytes long do not to include the password for security reasons and the
-first character of the identifier should not be ':'. This value can be
-retrieved on the server side using V$SESSION view.
+first character of the identifier should not be ':'. This value can be
+retrieved on the server side using V$SESSION view.
my $dbh = DBI->connect($dsn, $user, $passwd, { ora_client_identifier => $some_web_user });
@@ -1839,17 +1839,17 @@
=item ora_action
-You can set this value to anything you want up to 32 bytes. This value can be
+You can set this value to anything you want up to 32 bytes. This value can be
retrieved on the server side using V$SESSION view.
my $dbh = DBI->connect($dsn, $user, $passwd, { ora_action => "Login"});
-
+
$dbh{ora_action} = "New Long Query 22";
=item ora_dbh_share
Needs at least Perl 5.8.0 compiled with ithreads. Allows to share database
-connections between threads. The first connect will make the connection,
+connections between threads. The first connect will make the connection,
all following calls to connect with the same ora_dbh_share attribute
will use the same database connection. The value must be a reference
to a already shared scalar which is initialized to an empty string.
@@ -1896,7 +1896,7 @@
$dbh->{ora_verbose} =6;
-In both cases the DBD::Oracle trace level to 6, which is this level that will trace most of the calls to OCI.
+In both cases the DBD::Oracle trace level to 6, which is this level that will trace most of the calls to OCI.
=item ora_oci_success_warn
@@ -1906,7 +1906,7 @@
$dbh->{ora_oci_success_warn} =1;
-=item ora_objects
+=item ora_objects
Use this value to enable extended embedded oracle objects mode. In extended:
@@ -1914,13 +1914,13 @@
=item 1
-Embedded objects are returned as <DBD::Oracle::Object> instance (including type-name etc.) instead of simple ARRAY.
+Embedded objects are returned as <DBD::Oracle::Object> instance (including type-name etc.) instead of simple ARRAY.
=item 2
-Determine object type for each instance. All object attributes are returned (not only super-type's attributes).
+Determine object type for each instance. All object attributes are returned (not only super-type's attributes).
-=back
+=back
$dbh->{ora_objects} = 1;
@@ -1958,13 +1958,13 @@
For example:
use DBD::Oracle qw(:ora_types);
-
+
$SQL="select username from all_users where username = ?";
#username is a char(8)
$sth=$dbh->prepare($SQL)";
$sth->bind_param(1,'bloggs',{ ora_type => ORA_CHAR});
-Will pad bloggs out to 8 characters and return the username.
+Will pad bloggs out to 8 characters and return the username.
=back
@@ -1996,9 +1996,9 @@
Sometimes the Oracle client seems to change some of the signal handlers
of the process during the connect phase. For instance, some users have
-observed Perl's default C<$SIG{INT}> handler being ignored after
-connecting to an Oracle database. If this causes problems in your
-application, set this attribute to an array reference of signals you
+observed Perl's default C<$SIG{INT}> handler being ignored after
+connecting to an Oracle database. If this causes problems in your
+application, set this attribute to an array reference of signals you
would like to be localized during the connect process. Once the connect
is complete, the signal handlers should be returned to their previous state.
@@ -2030,7 +2030,7 @@
2 (old V7), 7 (V7), and 8 (V8).
All other values have the same effect as 1.
-=item ora_auto_lob
+=item ora_auto_lob
If true (the default), fetching retrieves the contents of the CLOB or
BLOB column in most circumstances. If false, fetching retrieves the
@@ -2057,8 +2057,8 @@
=item ora_piece_size
-This is the max piece size for the L</Piecewise Fetch with Callback> and L</Piecewise Fetch with Polling> methods, in chars for CLOBS,
-and bytes for BLOBS.
+This is the max piece size for the L</Piecewise Fetch with Callback> and L</Piecewise Fetch with Polling> methods, in chars for CLOBS,
+and bytes for BLOBS.
=item ora_check_sql
@@ -2087,7 +2087,7 @@
=item ora_row_cache_off
-By default DBD::Oracle will use a row cache when fetching to cut down the number of round
+By default DBD::Oracle will use a row cache when fetching to cut down the number of round
trips to the server. If you do not want to use an array fetch set this value to any value other than 0;
See L</Prefetching Rows> for more details.
@@ -2122,7 +2122,7 @@
Potentially useful values when DBD::Oracle was built using OCI 7 and later:
ORA_VARCHAR2, ORA_STRING, ORA_LONG, ORA_RAW, ORA_LONGRAW,
- ORA_CHAR, ORA_MLSLABEL, ORA_RSET
+ ORA_CHAR, ORA_MLSLABEL, ORA_RSET
Additional values when DBD::Oracle was built using OCI 8 and later:
@@ -2130,7 +2130,7 @@
Additional values when DBD::Oracle was built using OCI 9.2 and later:
- SQLT_CHR, SQLT_BIN
+ SQLT_CHR, SQLT_BIN
See L</Binding Cursors> for the correct way to use ORA_RSET.
@@ -2152,12 +2152,12 @@
=item ora_csid
-Specify the I<integer> OCI_ATTR_CHARSET_ID for the bind value.
+Specify the I<integer> OCI_ATTR_CHARSET_ID for the bind value.
Character set names can't be used currently.
=item ora_maxdata_size
-Specify the integer OCI_ATTR_MAXDATA_SIZE for the bind value.
+Specify the integer OCI_ATTR_MAXDATA_SIZE for the bind value.
May be needed if a character set conversion from client to server
causes the data to use more space and so fail with a truncation error.
@@ -2193,62 +2193,62 @@
Set L</ora_check_sql> to 0 in prepare() to enable this behaviour.
-=head1 Prefetching & Row Caching
+=head1 Prefetching & Row Caching
-DBD::Oracle now supports both Server pre-fetch and Client side row caching. By default both
+DBD::Oracle now supports both Server pre-fetch and Client side row caching. By default both
are turned on to give optimum performance. Most of the time one can just let DBD::Oracle
-figure out the best optimization.
+figure out the best optimization.
=head2 Row Caching
-Row caching occurs on the client side and the object of it is to cut down the number of round
+Row caching occurs on the client side and the object of it is to cut down the number of round
trips made to the server when fetching rows. At each fetch a set number of rows will be retrieved
-from the server and stored locally. Further calls the server are made only when the end of the
+from the server and stored locally. Further calls the server are made only when the end of the
local buffer(cache) is reached.
-Rows up to the specified top level row
-count C<RowCacheSize> are fetched if it occupies no more than the specified memory usage limit.
+Rows up to the specified top level row
+count C<RowCacheSize> are fetched if it occupies no more than the specified memory usage limit.
The default value is 0, which means that memory size is not included in computing the number of rows to prefetch. If
-the C<RowCacheSize> value is set to a negative number then the positive value of RowCacheSize is used
+the C<RowCacheSize> value is set to a negative number then the positive value of RowCacheSize is used
to compute the number of rows to prefetch.
By default C<RowCacheSize> is automatically set. If you want to totally turn off prefetching set this to 1.
-For any SQL statement that contains a LOB, Long or Object Type Row Caching will be turned off. However server side
+For any SQL statement that contains a LOB, Long or Object Type Row Caching will be turned off. However server side
caching still works. If you are only selecting a LOB Locator then Row Caching will still work.
=head2 Row Prefetching
-Row prefetching occurs on the server side and uses the DBI database handle attribute C<RowCacheSize> and or the
-Prepare Attribute 'ora_prefetch_memory'. Tweaking these values may yield improved performance.
+Row prefetching occurs on the server side and uses the DBI database handle attribute C<RowCacheSize> and or the
+Prepare Attribute 'ora_prefetch_memory'. Tweaking these values may yield improved performance.
$dbh->{RowCacheSize} = 100;
$sth=$dbh->prepare($SQL,{ora_exe_mode=>OCI_STMT_SCROLLABLE_READONLY,ora_prefetch_memory=>10000});
-
+
In the above example 10 rows will be prefetched up to a maximum of 10000 bytes of data. The Oracle® Call Interface Programmer's Guide,
-suggests a good row cache value for a scrollable cursor is about 20% of expected size of the record set.
+suggests a good row cache value for a scrollable cursor is about 20% of expected size of the record set.
-The prefetch settings tell the DBD::Oracle to grab x rows (or x-bytes) when it needs to get new rows. This happens on the first
+The prefetch settings tell the DBD::Oracle to grab x rows (or x-bytes) when it needs to get new rows. This happens on the first
fetch that sets the current_positon to any value other than 0. In the above example if we do a OCI_FETCH_FIRST the first 10 rows are
loaded into the buffer and DBD::Oracle will not have to go back to the server for more rows. When record 11 is fetched DBD::Oracle
-fetches and returns this row and the next 9 rows are loaded into the buffer. In this case if you fetch backwards from 10 to 1
+fetches and returns this row and the next 9 rows are loaded into the buffer. In this case if you fetch backwards from 10 to 1
no server round trips are made.
With large record sets it is best not to attempt to go to the last record as this may take some time, A large buffer size might even slow down
the fetch. If you must get the number of rows in a large record set you might try using an few large OCI_FETCH_ABSOLUTEs and then an OCI_FETCH_LAST,
-this might save some time. So if you had a record set of 10000 rows and you set the buffer to 5000 and did a OCI_FETCH_LAST one would fetch the first 5000 rows into the buffer then the next 5000 rows.
-If one requires only the first few rows there is no need to set a large prefetch value.
+this might save some time. So if you had a record set of 10000 rows and you set the buffer to 5000 and did a OCI_FETCH_LAST one would fetch the first 5000 rows into the buffer then the next 5000 rows.
+If one requires only the first few rows there is no need to set a large prefetch value.
-If the ora_prefetch_memory less than 1 or not present then memory size is not included in computing the
+If the ora_prefetch_memory less than 1 or not present then memory size is not included in computing the
number of rows to prefetch otherwise the number of rows will be limited to memory size. Likewise if the RowCacheSize is less than 1 it
-is not included in the computing of the prefetch rows.
+is not included in the computing of the prefetch rows.
=head1 Spaces & Padding
=head2 Trailing Spaces
Please note that only the Oracle OCI 8 strips trailing spaces from VARCHAR placeholder
-values and uses Nonpadded Comparison Semantics with the result.
+values and uses Nonpadded Comparison Semantics with the result.
This causes trouble if the spaces are needed for
comparison with a CHAR value or to prevent the value from
becoming '' which Oracle treats as NULL.
@@ -2256,7 +2256,7 @@
Comparison Semantics in Oracle's SQL Reference or Server
SQL Reference for more details.
-To preserve trailing spaces in placeholder values for Oracle clients that use OCI 8,
+To preserve trailing spaces in placeholder values for Oracle clients that use OCI 8,
either change the default placeholder type with L</ora_ph_type> or the placeholder
type for a particular call to L<DBI/bind> or L<DBI/bind_param_inout>
with L</ora_type> or C<TYPE>.
@@ -2273,8 +2273,8 @@
=head2 Padded Char Fields
Oracle Clients after OCI 9.2 will automatically pad CHAR placeholder values to the size of the CHAR.
-As the default placeholder type value in DBD::Oracle is ORA_VARCHAR2 to access this behaviour you will
-have to change the default placeholder type with L</ora_ph_type> or placeholder
+As the default placeholder type value in DBD::Oracle is ORA_VARCHAR2 to access this behaviour you will
+have to change the default placeholder type with L</ora_ph_type> or placeholder
type for a particular call with L<DBI/bind> or L<DBI/bind_param_inout>
with L</ORA_CHAR>.
@@ -2393,7 +2393,7 @@
See L</table_info()> for more detailed information.
It is possible with Oracle to make the names of the various DB objects (table,column,index etc)
-case sensitive.
+case sensitive.
alter table bloggind add ("Bla_BLA" NUMBER)
@@ -2440,8 +2440,8 @@
UTF8 => valid for NCHAR columns (CSID=871), deprecated
AL32UTF8 => valid for NCHAR and CHAR columns (CSID=873)
-When you create an Oracle database, you must specify the DATABASE
-character set (used for DDL, DML and CHAR datatypes) and the NATIONAL
+When you create an Oracle database, you must specify the DATABASE
+character set (used for DDL, DML and CHAR datatypes) and the NATIONAL
character set (used for NCHAR and NCLOB types).
The character sets used in your database can be found using:
@@ -2561,26 +2561,26 @@
If the C<ora_csform> attribute is given to bind_param() then that
determines if the value should be assumed to be in the default
-(NLS_LANG) or NCHAR (NLS_NCHAR) client character set.
+(NLS_LANG) or NCHAR (NLS_NCHAR) client character set.
use DBD::Oracle qw( SQLCS_IMPLICIT SQLCS_NCHAR );
...
- $sth->bind_param(1, $value, { ora_csform => SQLCS_NCHAR });
+ $sth->bind_param(1, $value, { ora_csform => SQLCS_NCHAR });
or
$dbh->{ora_ph_csform} = SQLCS_NCHAR; # default for all future placeholders
-Binding with bind_param_array and execute_array is also UTF-8 compatible in the same way. If you attempt to
+Binding with bind_param_array and execute_array is also UTF-8 compatible in the same way. If you attempt to
insert UTF-8 data into a non UTF-8 Oracle instance or with an non UTF-8 NCHAR or NVARCHAR the insert
-will still happen but a error code of 0 will be returned with the following warning;
-
- DBD Oracle Warning: You have mixed utf8 and non-utf8 in an array bind in parameter#1. This may result in corrupt data.
+will still happen but a error code of 0 will be returned with the following warning;
+
+ DBD Oracle Warning: You have mixed utf8 and non-utf8 in an array bind in parameter#1. This may result in corrupt data.
The Query charset id=1, name=US7ASCII
The warning will report the parameter number and the NCHAR setting that the query is running.
-
+
B<Sending Data using SQL>
Oracle assumes the SQL statement is in the default client character
@@ -2623,11 +2623,11 @@
print "Result: cc=",$cc,"\n",
"\tarr=",Data::Dumper::Dumper(\@arr),"\n";
-N.B.
+N.B.
Take careful note that we use '\\@arr' here because the 'bind_param_inout'
- will only take a reference to a scalar.
-
+ will only take a reference to a scalar.
+
=over
=item ORA_VARCHAR2_TABLE
@@ -2640,7 +2640,7 @@
maximum rows, that can be passed to Oracle and back to you. In this
example we send array with 1 element with length=3, but allocate space for 100
Oracle array entries with maximum length 10 of each. So, you can get no more
-than 100 array entries with length <= 10.
+than 100 array entries with length <= 10.
If you set I<max_len> to zero, maximum array entry length is calculated
as maximum length of entry of array bound. If 0 < I<max_len> < length( $some_element ),
@@ -2680,15 +2680,15 @@
:mytable := tbl;
END;
';
-
+
$sth=$dbh->prepare( $statement );
-
+
if( ! defined($sth) ){
die "Prepare error: ",$dbh->errstr,"\n";
}
-
+
@arr=( 1,"2E0","3.5" );
-
+
# note, that ora_internal_type defaults to SQLT_FLT for ORA_NUMBER_TABLE .
if( not $sth->bind_param_inout(":mytable", \\@arr, 10, {
ora_type => ORA_NUMBER_TABLE,
@@ -2701,7 +2701,7 @@
if( not $sth->bind_param_inout(":cc", \$cc, 100 ) ){
die "bind :cc error: ",$dbh->errstr,"\n";
}
-
+
if( not $sth->execute() ){
die "Execute failed: ",$dbh->errstr,"\n";
}
@@ -3017,12 +3017,12 @@
Avoid using the "SQL Call" statement with DBD:Oracle as you might find that
DBD::Oracle will not raise an exception in some case. Specifically if you use
-"SQL Call" to run a procedure all "No data found" exceptions will be quietly
+"SQL Call" to run a procedure all "No data found" exceptions will be quietly
ignored and returned as null. According to Oracle support this is part of the same
mechanism where;
select (select * from dual where 0=1) from dual
-
+
returns a null value rather than an exception.
=head1 Private database handle functions
@@ -3163,7 +3163,7 @@
3 = Both character sets are Unicode encodings.
-=head2 ora_can_taf
+=head2 ora_can_taf
Returns true if the current connection supports TAF events. False if otherise.
@@ -3182,19 +3182,19 @@
=head1 Scrollable Cursors
Oracle supports the concept of a 'Scrollable Cursor' which is defined as a 'Result Set' where
-the rows can be fetched either sequentially or non-sequentially. One can fetch rows forward,
+the rows can be fetched either sequentially or non-sequentially. One can fetch rows forward,
backwards, from any given position or the n-th row from the current position in the result set.
Rows are numbered sequentially starting at one and client-side caching of the partial or entire result set
can improve performance by limiting round trips to the server.
Oracle does not support DML type operations with scrollable cursors so you are limited
-to simple 'Select' operations only. As well you can not use this functionality with remote
-mapped queries or if the LONG datatype is part of the select list.
+to simple 'Select' operations only. As well you can not use this functionality with remote
+mapped queries or if the LONG datatype is part of the select list.
-However, LOBSs, CLOBSs, and BLOBs do work as do all the regular bind, and fetch methods.
+However, LOBSs, CLOBSs, and BLOBs do work as do all the regular bind, and fetch methods.
-Only use scrollable cursors if you really have a good reason to. They do use up considerable
+Only use scrollable cursors if you really have a good reason to. They do use up considerable
more server and client resources and have poorer response times than non-scrolling cursors.
@@ -3203,14 +3203,14 @@
To enable this functionality you must first import the 'Fetch Orientation' and the 'Execution Mode' constants by using;
use DBD::Oracle qw(:ora_fetch_orient :ora_exe_modes);
-
+
Next you will have to tell DBD::Oracle that you will be using scrolling by setting the ora_exe_mode attribute on the
statement handle to 'OCI_STMT_SCROLLABLE_READONLY' with the prepare method;
$sth=$dbh->prepare($SQL,{ora_exe_mode=>OCI_STMT_SCROLLABLE_READONLY});
When the statement is executed you will then be able to use 'ora_fetch_scroll' method to get a row
-or you can still use any of the other fetch methods but with a poorer response time than if you used a
+or you can still use any of the other fetch methods but with a poorer response time than if you used a
non-scrolling cursor. As well scrollable cursors are compatible with any applicable bind methods.
@@ -3223,20 +3223,20 @@
=item ora_scroll_position
$position = $sth->ora_scroll_position();
-
+
This method returns the current position (row number) attribute of the result set. Prior to the first fetch this value is 0. This is the only time
this value will be 0 after the first fetch the value will be set, so you can use this value to test if any rows have been fetched.
-The minimum value will always be 1 after the first fetch. The maximum value will always be the total number of rows in the record set.
+The minimum value will always be 1 after the first fetch. The maximum value will always be the total number of rows in the record set.
=item ora_fetch_scroll
@ary = $sth->ora_fetch_scroll($fetch_orient,$fetch_offset);
-Works the same as fetchrow_array method however, one passes in a 'Fetch Orientation' constant and a fetch_offset
-value which will then determine the row that will be fetched. It returns the row as a list containing the field values.
+Works the same as fetchrow_array method however, one passes in a 'Fetch Orientation' constant and a fetch_offset
+value which will then determine the row that will be fetched. It returns the row as a list containing the field values.
Null fields are returned as undef values in the list.
-The valid orientation constant and fetch offset values combination are detailed below
+The valid orientation constant and fetch offset values combination are detailed below
OCI_FETCH_CURRENT, fetches the current row, the fetch offset value is ignored.
OCI_FETCH_NEXT, fetches the next row from the current position, the fetch offset value
@@ -3246,7 +3246,7 @@
OCI_FETCH_PRIOR, fetches the previous row from the current position, the fetch offset
value is ignored.
OCI_FETCH_ABSOLUTE, fetches the row that is specified by the fetch offset value.
- OCI_FETCH_RELATIVE, fetches the row relative from the current position as specified by the
+ OCI_FETCH_RELATIVE, fetches the row relative from the current position as specified by the
fetch offset value.
OCI_FETCH_ABSOLUTE, and a fetch offset value of 1 is equivalent to a OCI_FETCH_FIRST.
@@ -3261,23 +3261,23 @@
OCI_FETCH_CURRENT, has no effect on the current_positon attribute.
OCI_FETCH_NEXT, increments current_positon attribute by 1
OCI_FETCH_NEXT, when at the last row in the record set does not change current_positon
- attribute, it is equivalent to a OCI_FETCH_CURRENT
+ attribute, it is equivalent to a OCI_FETCH_CURRENT
OCI_FETCH_FIRST, sets the current_positon attribute to 1.
- OCI_FETCH_LAST, sets the current_positon attribute to the total number of rows in the
+ OCI_FETCH_LAST, sets the current_positon attribute to the total number of rows in the
record set.
OCI_FETCH_PRIOR, decrements current_positon attribute by 1.
- OCI_FETCH_PRIOR, when at the first row in the record set does not change current_positon
+ OCI_FETCH_PRIOR, when at the first row in the record set does not change current_positon
attribute, it is equivalent to a OCI_FETCH_CURRENT.
-
+
OCI_FETCH_ABSOLUTE, sets the current_positon attribute to the fetch offset value.
- OCI_FETCH_ABSOLUTE, and a fetch offset value that is less than 1 does not change
+ OCI_FETCH_ABSOLUTE, and a fetch offset value that is less than 1 does not change
current_positon attribute, it is equivalent to a OCI_FETCH_CURRENT.
OCI_FETCH_ABSOLUTE, and a fetch offset value that is greater than the number of records in
- the record set, does not change current_positon attribute, it is
+ the record set, does not change current_positon attribute, it is
equivalent to a OCI_FETCH_CURRENT.
- OCI_FETCH_RELATIVE, sets the current_positon attribute to (current_positon attribute +
+ OCI_FETCH_RELATIVE, sets the current_positon attribute to (current_positon attribute +
fetch offset value).
- OCI_FETCH_RELATIVE, and a fetch offset value that makes the current position less than 1,
+ OCI_FETCH_RELATIVE, and a fetch offset value that makes the current position less than 1,
does not change fetch offset value so it is equivalent to a OCI_FETCH_CURRENT.
OCI_FETCH_RELATIVE, and a fetch offset value that makes it greater than the number of records
in the record set, does not change fetch offset value so it is equivalent
@@ -3291,12 +3291,12 @@
attribute to the total number of rows in the record set.
OCI_FETCH_NEXT, equivalent to a OCI_FETCH_FIRST.
OCI_FETCH_PRIOR, equivalent to a OCI_FETCH_CURRENT.
-
- OCI_FETCH_ABSOLUTE, and a fetch offset value that is less than 1 is equivalent to a
+
+ OCI_FETCH_ABSOLUTE, and a fetch offset value that is less than 1 is equivalent to a
OCI_FETCH_CURRENT.
- OCI_FETCH_ABSOLUTE, and a fetch offset value that is greater than the number of
+ OCI_FETCH_ABSOLUTE, and a fetch offset value that is greater than the number of
records in the record set is equivalent to a OCI_FETCH_CURRENT.
- OCI_FETCH_RELATIVE, and a fetch offset value that is less than 1 is equivalent
+ OCI_FETCH_RELATIVE, and a fetch offset value that is less than 1 is equivalent
to a OCI_FETCH_CURRENT.
OCI_FETCH_RELATIVE, and a fetch offset value that makes it greater than the number
of records in the record set, is equivalent to a OCI_FETCH_CURRENT.
@@ -3330,7 +3330,7 @@
print "current scroll position=".$sth->ora_scroll_position()."\n";
The current_positon attribute to will be 20 after this snippet. This is also a way to get the number of rows in the record set, however,
-if the record set is large this could take some time.
+if the record set is large this could take some time.
=item Fetching the Current Row
@@ -3410,14 +3410,14 @@
print "id=".$value->[0].", First Name=".$value->[1].", Last Name=".$value->[2]."\n";
print "current scroll position=".$sth->ora_scroll_position()."\n";
-The current_positon attribute will be 6 after this snippet.
+The current_positon attribute will be 6 after this snippet.
=item Use Finish
$sth->finish();
When using scrollable cursors it is required that you use the $sth->finish() method when you are done with the cursor as this type of
-cursor has to be explicitly cancelled on the server. If you do not do this you may cause resource problems on your database.
+cursor has to be explicitly cancelled on the server. If you do not do this you may cause resource problems on your database.
=back
@@ -3426,16 +3426,16 @@
The key to working with LOBs (CLOB, BLOBs) is to remember the value of an Oracle LOB column is not the content of the LOB. It's a
'LOB Locator' which, after being selected or inserted needs extra processing to read or write the content of the LOB. There are also legacy LONG types (LONG, LONG RAW, VARCHAR2)
which are presently deprecated by Oracle but are still in use. These LONG types do not utilize a 'LOB Locator' and also are more limited in
-functionality than CLOB or BLOB fields.
+functionality than CLOB or BLOB fields.
-DBD::Oracle now offers three interfaces to LOB and LONG data,
+DBD::Oracle now offers three interfaces to LOB and LONG data,
=over
=item L</Data Interface for Persistent LOBs>
-With this interface DBD::Oracle handles your data directly utilizing regular OCI calls, Oracle itself takes care of the LOB Locator operations in the case of
-BLOBs and CLOBs treating them exactly as if they were the same as the legacy LONG or LONG RAW types.
+With this interface DBD::Oracle handles your data directly utilizing regular OCI calls, Oracle itself takes care of the LOB Locator operations in the case of
+BLOBs and CLOBs treating them exactly as if they were the same as the legacy LONG or LONG RAW types.
=item L</Data Interface for LOB Locators>
@@ -3445,9 +3445,9 @@
This allows the user direct access to the LOB Locator methods, so you have to take case of the LOB Locator operations yourself.
-=back
+=back
-Generally speaking the interface that you will chose will be dependent on what end you are trying to achieve. All have their benefits and
+Generally speaking the interface that you will chose will be dependent on what end you are trying to achieve. All have their benefits and
drawbacks.
One point to remember when working with LOBs (CLOBs, BLOBs) is if your LOB column can be in one of three states;
@@ -3457,15 +3457,15 @@
=item NULL
The table cell is created, but the cell holds no locator or value.
-If your LOB field is in this state then there is no LOB Locator that DBD::Oracle can work so if your encounter a
+If your LOB field is in this state then there is no LOB Locator that DBD::Oracle can work so if your encounter a
DBD::Oracle::db::ora_lob_read: locator is not of type OCILobLocatorPtr
-
-error when working with a LOB.
+
+error when working with a LOB.
You can correct this by using an SQL UPDATE statement to reset the LOB column to a non-NULL (or empty LOB) value with either EMPTY_BLOB or EMPTY_CLOB as in this example;
- UPDATE lob_example
+ UPDATE lob_example
SET bindata=EMPTY_BLOB()
WHERE bindata IS NULL.
@@ -3481,18 +3481,18 @@
=head2 Data Interface for Persistent LOBs
-This is the original interface for LONG and LONG RAW datatypes and from Oracle 9iR1 and later the OCI API was extended to work directly with the other LOB datatypes.
-In other words you can treat all LOB type data (BLOB, CLOB) as if it was a LONG, LONG RAW, or VARCHAR2. So you can perform INSERT, UPDATE, fetch, bind, and define operations on LOBs using the same techniques
+This is the original interface for LONG and LONG RAW datatypes and from Oracle 9iR1 and later the OCI API was extended to work directly with the other LOB datatypes.
+In other words you can treat all LOB type data (BLOB, CLOB) as if it was a LONG, LONG RAW, or VARCHAR2. So you can perform INSERT, UPDATE, fetch, bind, and define operations on LOBs using the same techniques
you would use on other datatypes that store character or binary data. In some cases there are fewer round trips to the server as no 'LOB Locators' are
-used, normally one can get an entire LOB is a single round trip.
+used, normally one can get an entire LOB is a single round trip.
=head3 Simple Fetch for LONGs and LONG RAWs
-As the name implies this is the simplest way to use this interface. DBD::Oracle just attempts to get your LONG datatypes as a single large piece.
+As the name implies this is the simplest way to use this interface. DBD::Oracle just attempts to get your LONG datatypes as a single large piece.
There are no special settings, simply set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected size of the LONG or LONG RAW.
If the size of the LONG or LONG RAW exceeds the 'LongReadLen' DBD::Oracle will return a 'ORA-24345: A Truncation' error. To stop this set the database handle's 'LongTruncOk' attribute to '1'.
The maximum value of 'LongReadLen' seems to be dependent on the physical memory limits of the box that Oracle is running on. You have most likely reached this limit if you run into
-an 'ORA-01062: unable to allocate memory for define buffer' error. One solution is to set the size of 'LongReadLen' to a lower value.
+an 'ORA-01062: unable to allocate memory for define buffer' error. One solution is to set the size of 'LongReadLen' to a lower value.
For example give this table;
@@ -3514,17 +3514,17 @@
Will select out all of the long1 fields in the table as long as they are all under 2MB in length. A value in long1 longer than this will throw an error. Adding this line;
$dbh->{LongTruncOk}=1;
-
-before the execute will return all the long1 fields but they will be truncated at 2MBs.
+
+before the execute will return all the long1 fields but they will be truncated at 2MBs.
=head3 Using ora_ncs_buff_mtpl
When getting CLOBs and NCLOBs in or out of Oracle, the Server will translate from the Server's NCharSet to the
-Client's. If they happen to be the same or at least compatible then all of these actions are a 1 char to 1 char bases.
-Thus if you set your LongReadLen buffer to 10_000_000 you will get up to 10_000_000 char.
+Client's. If they happen to be the same or at least compatible then all of these actions are a 1 char to 1 char bases.
+Thus if you set your LongReadLen buffer to 10_000_000 you will get up to 10_000_000 char.
-However if the Server has to translate from one NCharSet to another it will use bytes for conversion. The buffer
-value is set to 4 * LONG_READ_LEN which was very wasteful as you might only be asking for 10_000_000 bytes
+However if the Server has to translate from one NCharSet to another it will use bytes for conversion. The buffer
+value is set to 4 * LONG_READ_LEN which was very wasteful as you might only be asking for 10_000_000 bytes
but you were actually using 40_000_000 bytes of buffer under the hood. You would still get 10_000_000 bytes
(maybe less characters though) but you are using allot more memory that you need.
@@ -3537,8 +3537,8 @@
If the error is not captured then you may get at some random point later on, usually at a finish() or disconnect() or even a fetch() this error;
ORA-03127: no new operations allowed until the active operation ends
-
-This is one of the more obscure ORA errors (have some fun and report it to Meta-Link they will scratch their heads for hours)
+
+This is one of the more obscure ORA errors (have some fun and report it to Meta-Link they will scratch their heads for hours)
If you get this, simply increment the ora_ncs_buff_mtpl by one until it goes away.
@@ -3546,7 +3546,7 @@
You can tune this value by setting ora_oci_success_warn which will display the following
- OCILobRead field 2 of 3 SUCCESS: csform 1 (SQLCS_IMPLICIT), LOBlen 10240(characters), LongReadLen
+ OCILobRead field 2 of 3 SUCCESS: csform 1 (SQLCS_IMPLICIT), LOBlen 10240(characters), LongReadLen
20(characters), BufLen 80(characters), Got 28(characters)
In the case above the query Got 28 characters (well really only 20 characters of 28 bytes) so we could use ora_ncs_buff_mtpl=>2 (20*2=40) thus saving 40bytes of memory.
@@ -3555,9 +3555,9 @@
=head3 Simple Fetch for CLOBs and BLOBs
To use this interface for CLOBs and LOBs datatypes set the 'ora_pers_lob' attribute of the statement handle to '1' with the prepare method, as well
-set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected size of the LOB. If the size of the LOB exceeds
+set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected size of the LOB. If the size of the LOB exceeds
the 'LongReadLen' DBD::Oracle will return a 'ORA-24345: A Truncation' error. To stop this set the database handle's 'LongTruncOk' attribute to '1'.
-The maximum value of 'LongReadLen' seems to be dependent on the physical memory limits of the box that Oracle is running on in the same way that LONGs and LONG RAWs are.
+The maximum value of 'LongReadLen' seems to be dependent on the physical memory limits of the box that Oracle is running on in the same way that LONGs and LONG RAWs are.
For CLOBs and NCLOBs the limit is 64k chars if there is no truncation, this is an internal OCI limit complain to them if you want it changed. However if you CLOB is longer than this
and also larger than the 'LongReadLen' than the 'LongReadLen' in chars is returned.
@@ -3567,9 +3567,9 @@
For example give this table;
CREATE TABLE test_lob (id NUMBER,
- clob1 CLOB,
- clob2 CLOB,
- blob1 BLOB,
+ clob1 CLOB,
+ clob2 CLOB,
+ blob1 BLOB,
blob2 BLOB)
this code;
@@ -3589,17 +3589,17 @@
Will select out all of the LOBs in the table as long as they are all under 2MB in length. Longer lobs will throw an error. Adding this line;
$dbh->{LongTruncOk}=1;
-
-before the execute will return all the lobs but they will be truncated at 2MBs.
+
+before the execute will return all the lobs but they will be truncated at 2MBs.
=head3 Piecewise Fetch with Callback
-With a piecewise callback fetch DBD::Oracle sets up a function that will 'callback' to the DB during the fetch and gets your LOB (LONG, LONG RAW, CLOB, BLOB) piece by piece.
+With a piecewise callback fetch DBD::Oracle sets up a function that will 'callback' to the DB during the fetch and gets your LOB (LONG, LONG RAW, CLOB, BLOB) piece by piece.
To use this interface set the 'ora_clbk_lob' attribute of the statement handle to '1' with the prepare method. Next set the 'ora_piece_size' to the size of the piece that
-you want to return on the callback. Finally set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected
-size of the LOB. Like the L</Simple Fetch for LONGs and LONG RAWs> and L</Simple Fetch for CLOBs and BLOBs> the if the size of the LOB exceeds the is 'LongReadLen' you can use the 'LongTruncOk' attribute to truncate the LOB
-or set the 'LongReadLen' to a higher value. With this interface the value of 'ora_piece_size' seems to be constrained by the same memory limit as found on
-the Simple Fetch interface. If you encounter an 'ORA-01062' error try setting the value of 'ora_piece_size' to a smaller value. The value for 'LongReadLen' is
+you want to return on the callback. Finally set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected
+size of the LOB. Like the L</Simple Fetch for LONGs and LONG RAWs> and L</Simple Fetch for CLOBs and BLOBs> the if the size of the LOB exceeds the is 'LongReadLen' you can use the 'LongTruncOk' attribute to truncate the LOB
+or set the 'LongReadLen' to a higher value. With this interface the value of 'ora_piece_size' seems to be constrained by the same memory limit as found on
+the Simple Fetch interface. If you encounter an 'ORA-01062' error try setting the value of 'ora_piece_size' to a smaller value. The value for 'LongReadLen' is
dependent on the version and settings of the Oracle DB you are using. In theory it ranges from 8GBs
in 9iR1 up to 128 terabytes with 11g but you will also be limited by the physical memory of your PERL instance.
@@ -3617,7 +3617,7 @@
print "blob2=".$blob2."\n";
}
-Will select out all of the LOBs in the table as long as they are all under 20MB in length. If the LOB is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
+Will select out all of the LOBs in the table as long as they are all under 20MB in length. If the LOB is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
maximum of 4 pieces (4*5MB=20MB). Like the Simple Fetch examples Lobs longer than 20MB will throw an error.
Using the table from the first example (LONG) this code;
@@ -3631,17 +3631,17 @@
print "long=".$long."\n";
}
-Will select all of the long1 fields from table as long as they are is under 20MB in length. If the long1 filed is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
+Will select all of the long1 fields from table as long as they are is under 20MB in length. If the long1 filed is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
maximum of 4 pieces (4*5MB=20MB). Like the other examples long1 fields longer than 20MB will throw an error.
=head3 Piecewise Fetch with Polling
With a polling piecewise fetch DBD::Oracle iterates (Polls) over the LOB during the fetch getting your LOB (LONG, LONG RAW, CLOB, BLOB) piece by piece. To use this interface set the 'ora_piece_lob'
attribute of the statement handle to '1' with the prepare method. Next set the 'ora_piece_size' to the size of the piece that
-you want to return on the callback. Finally set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected
-size of the LOB. Like the L</Piecewise Fetch with Callback> and Simple Fetches if the size of the LOB exceeds the is 'LongReadLen' you can use the 'LongTruncOk' attribute to truncate the LOB
-or set the 'LongReadLen' to a higher value. With this interface the value of 'ora_piece_size' seems to be constrained by the same memory limit as found on
-the L</Piecewise Fetch with Callback>.
+you want to return on the callback. Finally set the database handle's 'LongReadLen' attribute to a value that will be the larger than the expected
+size of the LOB. Like the L</Piecewise Fetch with Callback> and Simple Fetches if the size of the LOB exceeds the is 'LongReadLen' you can use the 'LongTruncOk' attribute to truncate the LOB
+or set the 'LongReadLen' to a higher value. With this interface the value of 'ora_piece_size' seems to be constrained by the same memory limit as found on
+the L</Piecewise Fetch with Callback>.
Using the table from the example above this code;
@@ -3657,7 +3657,7 @@
print "blob2=".$blob2."\n";
}
-Will select out all of the LOBs in the table as long as they are all under 20MB in length. If the LOB is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
+Will select out all of the LOBs in the table as long as they are all under 20MB in length. If the LOB is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
maximum of 4 pieces (4*5MB=20MB). Like the other fetch methods LOBs longer than 20MB will throw an error.
Finally with this code;
@@ -3670,13 +3670,13 @@
print "p_id=".$p_id."\n";
print "long=".$long."\n";
}
-
-Will select all of the long1 fields from table as long as they are is under 20MB in length. If the long1 field is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
+
+Will select all of the long1 fields from table as long as they are is under 20MB in length. If the long1 field is longer than 5MB (ora_piece_size) DBD::Oracle will fetch it in at least 2 pieces to a
maximum of 4 pieces (4*5MB=20MB). Like the other examples long1 fields longer than 20MB will throw an error.
=head3 Binding for Updates and Inserts for CLOBs and BLOBs
-To bind for updates and inserts all that is required to use this interface is to set the statement handle's prepare method
+To bind for updates and inserts all that is required to use this interface is to set the statement handle's prepare method
'ora_type' attribute to 'SQLT_CHR' in the case of CLOBs and NCLOBs or 'SQLT_BIN' in the case of BLOBs as in this example for an insert;
my $in_clob = "<document>\n";
@@ -3692,7 +3692,7 @@
$sth->bind_param(4,$in_blob,{ora_type=>SQLT_BIN});
$sth->bind_param(5,$in_blob,{ora_type=>SQLT_BIN});
$sth->execute();
-
+
So far the only limit reached with this form of insert is the LOBs must be under 2GB in size.
=head3 Support for Remote LOBs;
@@ -3700,7 +3700,7 @@
Starting with Oracle 10gR2 the interface for Persistent LOBs was expanded to support remote LOBs (access over a dblink). Given a database called 'lob_test' that has a 'LINK' defined like this;
CREATE DATABASE LINK link_test CONNECT TO test_lobs IDENTIFIED BY tester USING 'lob_test';
-
+
to a remote database called 'test_lobs', the following code will work;
$dbh = DBI->connect('dbi:Oracle:','test@lob_test','test');
@@ -3715,7 +3715,7 @@
print "blob1=".$blob2."\n";
print "blob2=".$blob2."\n";
}
-
+
Below are the limitations of Remote LOBs;
=over
@@ -3724,36 +3724,36 @@
so the following returns an error:
- SELECT t1.lobcol,
- a2.lobcol
- FROM t1,
+ SELECT t1.lobcol,
+ a2.lobcol
+ FROM t1,
t2.lobcol@dbs2 a2 W
WHERE LENGTH(t1.lobcol) = LENGTH(a2.lobcol);
-
+
as does:
- SELECT t1.lobcol
+ SELECT t1.lobcol
FROM t1@dbs1
UNION ALL
- SELECT t2.lobcol
+ SELECT t2.lobcol
FROM t2@dbs2;
=item DDL commands are not supported;
so the following returns an error:
- CREATE VIEW v AS SELECT lob_col FROM tab@dbs;
+ CREATE VIEW v AS SELECT lob_col FROM tab@dbs;
-=item Only binds and defines for data going into remote persistent LOBs are supported.
+=item Only binds and defines for data going into remote persistent LOBs are supported.
-so that parameter passing in PL/SQL where CHAR data is bound or defined for remote LOBs is not allowed .
+so that parameter passing in PL/SQL where CHAR data is bound or defined for remote LOBs is not allowed .
These statements all produce errors:
SELECT foo() FROM table1@dbs2;
-
+
SELECT foo()@dbs INTO char_val FROM DUAL;
-
+
SELECT XMLType().getclobval FROM table1@dbs2;
=item If the remote object is a view such as
@@ -3781,7 +3781,7 @@
=head3 Simple Usage
-When fetching LOBs with this interface a 'LOB Locator' is created then used to get the lob with the LongReadLen and LongTruncOk attributes.
+When fetching LOBs with this interface a 'LOB Locator' is created then used to get the lob with the LongReadLen and LongTruncOk attributes.
The value for 'LongReadLen' is dependent on the version and settings of the Oracle DB you are using. In theory it ranges from 8GBs
in 9iR1 up to 128 terabytes with 11g but you will also be limited by the physical memory of your PERL instance.
@@ -3827,17 +3827,17 @@
LOB Locators can be passed to PL/SQL calls by binding them to placeholders
with the proper C<ora_type>. If L</ora_auto_lob> is true, output LOB
-parameters will be automatically returned as strings.
+parameters will be automatically returned as strings.
If the Oracle driver has support for temporary LOBs (Oracle 9i and higher),
-strings can be bound to input LOB placeholders and will be automatically
+strings can be bound to input LOB placeholders and will be automatically
converted to LOBs.
Example:
# Build a large XML document, bind it as a CLOB,
# extract elements through PL/SQL and return as a CLOB
- # $dbh is a connected database handle
+ # $dbh is a connected database handle
# output will be large
local $dbh->{LongReadLen} = 1_000_000;
@@ -3847,8 +3847,8 @@
$in_clob .= "</document>\n";
my $out_clob;
-
-
+
+
my $sth = $dbh->prepare(<<PLSQL_END);
-- extract 'value' nodes
DECLARE
@@ -3858,7 +3858,7 @@
END;
PLSQL_END
-
+
# :in param will be converted to a temp lob
# :out parameter will be returned as a string.
@@ -3866,23 +3866,23 @@
$sth->bind_param_inout( ':out', \$out_clob, 0, { ora_type => ORA_CLOB } );
$sth->execute;
-If you ever get an
+If you ever get an
ORA-01691 unable to extend lob segment sss.ggg by nnn in tablespace ttt
-error, while attempting to insert a LOB, this means the Oracle user has insufficient space for LOB you are trying to insert.
+error, while attempting to insert a LOB, this means the Oracle user has insufficient space for LOB you are trying to insert.
One solution it to use "alter database datafile 'sss.ggg' resize Mnnn" to increase the available memory for LOBs.
=head2 Persistent & Locator Interface Caveats
Now that one has the option of using the Persistent or the Locator interface for LOBs the questions arises
-which one to use. For starters, if you want to access LOBs over a dblink you will have to use the Persistent
+which one to use. For starters, if you want to access LOBs over a dblink you will have to use the Persistent
interface so that choice is simple. The question of which one to use after that is a little more tricky.
-It basically boils down to a choice between LOB size and speed.
+It basically boils down to a choice between LOB size and speed.
-The Callback and Polling piecewise fetches are very very slow
-when compared to the Simple and the Locator fetches but they can handle very large blocks of data. Given a situation where a
-large LOB is to be read the Locator fetch may time out while either of the piecewise fetches may not.
+The Callback and Polling piecewise fetches are very very slow
+when compared to the Simple and the Locator fetches but they can handle very large blocks of data. Given a situation where a
+large LOB is to be read the Locator fetch may time out while either of the piecewise fetches may not.
With the Simple fetch you are limited by physical memory of your server but it runs a little faster than the Locator, as there are fewer round trips
to the server. So if you have small LOBs and need to save a little bandwidth this is the one to use. It you are going after large LOBs then the Locator interface is the one to use.
@@ -3896,10 +3896,10 @@
1) Piecewise, polling and callback binds for INSERT and UPDATE operations.
2) Piecewise array binds for SELECT, INSERT and UPDATE operations.
-
+
Most of the time you should just use the L</Locator Data Interface> as this is in one that has the best combination of speed and size.
-All this being said if you are doing some critical programming I would use the L</Data Interface for LOB Locators> as this gives you very
+All this being said if you are doing some critical programming I would use the L</Data Interface for LOB Locators> as this gives you very
fine grain control of your LOBs, of course the code for this will be somewhat more involved.
=head2 Data Interface for LOB Locators
@@ -3958,7 +3958,7 @@
$is_init = $dbh->ora_lob_is_init($lob_locator);
-Returns true(1) if the Lob Locator is initialized false(0) if it is not, or 'undef'
+Returns true(1) if the Lob Locator is initialized false(0) if it is not, or 'undef'
if there is an error.
Uses the Oracle OCILobLocatorIsInit function.
@@ -4143,15 +4143,15 @@
the select statement does not require the "FOR UPDATE"
clause.
-A word of caution when using the data returned from an ora_lob_read in a conditional statement.
+A word of caution when using the data returned from an ora_lob_read in a conditional statement.
for example if the code below;
while( my $data = $dbh->ora_lob_read( $char_locator, $offset, $chunk_size ) ) {
print STDOUT $data;
$offset += $chunk_size;
}
-
-was used with a chunk size of 4096 against a blob that requires more than 1 chunk to return
+
+was used with a chunk size of 4096 against a blob that requires more than 1 chunk to return
the data and the last chunk is one byte long and contains a zero (ASCII 48) you will miss this last byte
as $data will contain 0 which PERL will see as false and not print it out.
@@ -4210,7 +4210,7 @@
Here's an alternative form using a function that returns a cursor.
This example uses the pre-defined weak (or generic) REF CURSOR type
-SYS_REFCURSOR. This is an Oracle 9 feature.
+SYS_REFCURSOR. This is an Oracle 9 feature.
# Create the function that returns a cursor
$dbh->do(q{
@@ -4366,10 +4366,10 @@
foreach my $id (@out_values){
print 'returned id='.$id.'\n';
}
-
-Which will return all the ids into @out_values.
-Note:
+Which will return all the ids into @out_values.
+
+Note:
1) This will only work for numbered (?) placeholders,
@@ -4497,7 +4497,7 @@
=head1 Timezones
If TWO_TASK isn't set, Oracle uses the TZ variable from the local environment.
-
+
If TWO_TASK IS set, Oracle uses the TZ variable of the listener process
running on the server.
@@ -4511,14 +4511,14 @@
was the 6th of the new month. I had the dba start up a listener with
TZ=X+144. (144 hours = 6 days)"]
-=head1 Object & Collection Data Types
+=head1 Object & Collection Data Types
-Oracle databases allow for the creation of object oriented like user-defined types.
-There are two types of objects, Embedded--an object stored in a column of a regular table
-and REF--an object that uses the REF retrieval mechanism.
+Oracle databases allow for the creation of object oriented like user-defined types.
+There are two types of objects, Embedded--an object stored in a column of a regular table
+and REF--an object that uses the REF retrieval mechanism.
DBD::Oracle supports only the 'selection' of embedded objects of the following types OBJECT, VARRAY
-and TABLE in any combination. Support is seamless and recursive, meaning you
+and TABLE in any combination. Support is seamless and recursive, meaning you
need only supply a simple SQL statement to get all the values in an embedded object.
You can either get the values as an array of scalars or they can be returned into a DBD::Oracle::Object.
@@ -4526,11 +4526,11 @@
Array example, given this type and table;
CREATE OR REPLACE TYPE "PHONE_NUMBERS" as varray(10) of varchar(30);
-
- CREATE TABLE "CONTACT"
- ( "COMPANYNAME" VARCHAR2(40),
- "ADDRESS" VARCHAR2(100),
- "PHONE_NUMBERS" "PHONE_NUMBERS"
+
+ CREATE TABLE "CONTACT"
+ ( "COMPANYNAME" VARCHAR2(40),
+ "ADDRESS" VARCHAR2(100),
+ "PHONE_NUMBERS" "PHONE_NUMBERS"
)
The code to access all the data in the table could be something like this;
@@ -4541,7 +4541,7 @@
print "Company: ".$company."\n";
print "Address: ".$address."\n";
print "Phone #: ";
-
+
foreach my $items (@$phone){
print $items.", ";
}
@@ -4550,7 +4550,7 @@
Note that values in PHONE_NUMBERS are returned as an array reference '@$phone'.
-As stated before DBD::Oracle will automatically drill into the embedded object and extract
+As stated before DBD::Oracle will automatically drill into the embedded object and extract
all of the data as reference arrays of scalars. The example below has OBJECT type embedded in a TABLE type embedded in an
SQL TABLE;
@@ -4562,7 +4562,7 @@
CREATE OR REPLACE TYPE STUDENTS_T AS TABLE OF STUDENT;
- CREATE TABLE GROUPS(
+ CREATE TABLE GROUPS(
GRP_ID NUMBER(4),
GRP_NAME VARCHAR2(10),
STUDENTS STUDENTS_T)
@@ -4581,7 +4581,7 @@
print "Marks:";
foreach my $grades (@$student->[1]){
foreach my $marks (@$grades){
- print $marks.",";
+ print $marks.",";
}
}
print "\n";
@@ -4601,47 +4601,47 @@
);
CREATE TABLE people (id INTEGER, obj Person);
-
+
INSERT INTO people VALUES (1, Person('Black', 25));
INSERT INTO people VALUES (2, Employee('Smith', 44, 5000));
The following code will access the data;
$dbh{'ora_objects'} =>1;
-
+
$sth = $dbh->prepare("select * from people order by id");
$sth->execute();
-
+
# object are fetched as instance of DBD::Oracle::Object
my ($id1, $obj1) = $sth->fetchrow();
my ($id2, $obj2) = $sth->fetchrow();
-
+
# get full type-name of object
print $obj1->type_name."44\n"; # 'TEST.PERSON' is printed
print $obj2->type_name."4\n"; # 'TEST.EMPLOYEE' is printed
-
- # get attribute NAME from object
+
+ # get attribute NAME from object
print $obj1->attr('NAME')."3\n"; # 'Black' is printed
print $obj2->attr('NAME')."3\n"; # 'Smith' is printed
-
+
# get all atributes as hash reference
my $h1 = $obj1->attr; # returns {'NAME' => 'Black', 'AGE' => 25}
my $h2 = $obj2->attr; # returns {'NAME' => 'Smith', 'AGE' => 44,
# 'SALARY' => 5000 }
-
+
# get all attributes (names and values) as array
my @a1 = $obj1->attributes; # returns ('NAME', 'Black', 'AGE', 25)
my @a2 = $obj2->attributes; # returns ('NAME', 'Smith', 'AGE', 44,
# 'SALARY', 5000 )
-
-So far DBD::Oracle has been tested on a table with 20 embedded Objects, Varrays and Tables
+
+So far DBD::Oracle has been tested on a table with 20 embedded Objects, Varrays and Tables
nested to 10 levels.
Any NULL values found in the embedded object will be returned as 'undef'.
=head1 Support for Insert of XMLType (ORA_XMLTYPE)
-Inserting large XML data sets into tables with XMLType fields is now supported by DBD::Oracle. The only special
+Inserting large XML data sets into tables with XMLType fields is now supported by DBD::Oracle. The only special
requirement is the use of bind_param() with an attribute hash parameter that specifies ora_type as ORA_XMLTYPE. For
example with a table like this;
@@ -4658,16 +4658,16 @@
<Author>T. Bunce</Author>
<Author>Alligator Descartes</Author>
</Authors>
-
+
</Book>
<Book id=10000>...
</Books>';
my $sth =$dbh-> prepare($SQL);
- $sth-> bind_param("p_xml", $xml, { ora_type => ORA_XMLTYPE });
+ $sth-> bind_param("p_xml", $xml, { ora_type => ORA_XMLTYPE });
$sth-> execute();
-
-In the above case we will assume that $xml has 10000 Book nodes and is over 32k in size and is well formed XML.
-This will also work for XML that is smaller than 32k as well. Attempting to insert malformed XML will cause an error.
+
+In the above case we will assume that $xml has 10000 Book nodes and is over 32k in size and is well formed XML.
+This will also work for XML that is smaller than 32k as well. Attempting to insert malformed XML will cause an error.
=head1 Oracle Related Links
@@ -4768,7 +4768,7 @@
After making your changes you can generate a patch file, but before
you do, make sure your source is still upto date using:
- svn update
+ svn update
If you get any conflicts reported you'll need to fix them first.
Then generate the patch file from within the C<trunk> directory using: