1 package DBIx::Class::Storage::DBI::Oracle::Generic;
5 use base qw/DBIx::Class::Storage::DBI/;
9 use Context::Preserve 'preserve_context';
11 use List::Util 'first';
14 __PACKAGE__->sql_limit_dialect ('RowNum');
15 __PACKAGE__->sql_quote_char ('"');
16 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::Oracle');
17 __PACKAGE__->datetime_parser_type('DateTime::Format::Oracle');
19 sub __cache_queries_with_max_lob_parts { 2 }
23 DBIx::Class::Storage::DBI::Oracle::Generic - Oracle Support for DBIx::Class
27 # In your result (table) classes
28 use base 'DBIx::Class::Core';
29 __PACKAGE__->add_columns({ id => { sequence => 'mysequence', auto_nextval => 1 } });
30 __PACKAGE__->set_primary_key('id');
32 # Somewhere in your Code
33 # add some data to a table with a hierarchical relationship
34 $schema->resultset('Person')->create ({
39 firstname => 'child1',
43 firstname => 'grandchild',
49 firstname => 'child2',
55 # select from the hierarchical relationship
56 my $rs = $schema->resultset('Person')->search({},
58 'start_with' => { 'firstname' => 'foo', 'lastname' => 'bar' },
59 'connect_by' => { 'parentid' => { '-prior' => { -ident => 'personid' } },
60 'order_siblings_by' => { -asc => 'name' },
64 # this will select the whole tree starting from person "foo bar", creating
67 # me.persionid me.firstname, me.lastname, me.parentid
71 # firstname = 'foo' and lastname = 'bar'
73 # parentid = prior personid
79 This class implements base Oracle support. The subclass
80 L<DBIx::Class::Storage::DBI::Oracle::WhereJoins> is for C<(+)> joins in Oracle
87 sub _determine_supports_insert_returning {
90 # TODO find out which version supports the RETURNING syntax
91 # 8i has it and earlier docs are a 404 on oracle.com
94 if $self->_server_info->{normalized_dbms_version} >= 8.001;
99 __PACKAGE__->_use_insert_returning_bound (1);
101 sub deployment_statements {
103 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
106 my $quote_char = $self->schema->storage->sql_maker->quote_char;
107 $sqltargs->{quote_table_names} = $quote_char ? 1 : 0;
108 $sqltargs->{quote_field_names} = $quote_char ? 1 : 0;
111 ! exists $sqltargs->{producer_args}{oracle_version}
113 my $dver = $self->_server_info->{dbms_version}
115 $sqltargs->{producer_args}{oracle_version} = $dver;
118 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
121 sub _dbh_last_insert_id {
122 my ($self, $dbh, $source, @columns) = @_;
124 foreach my $col (@columns) {
125 my $seq = ($source->column_info($col)->{sequence} ||= $self->get_autoinc_seq($source,$col));
126 my $id = $self->_sequence_fetch( 'CURRVAL', $seq );
132 sub _dbh_get_autoinc_seq {
133 my ($self, $dbh, $source, $col) = @_;
135 my $sql_maker = $self->sql_maker;
136 my ($ql, $qr) = map { $_ ? (quotemeta $_) : '' } $sql_maker->_quote_chars;
139 if ( ref $source->name eq 'SCALAR' ) {
140 $source_name = ${$source->name};
142 # the ALL_TRIGGERS match further on is case sensitive - thus uppercase
143 # stuff unless it is already quoted
144 $source_name = uc ($source_name) if $source_name !~ /\"/;
147 $source_name = $source->name;
148 $source_name = uc($source_name) unless $ql;
151 # trigger_body is a LONG
152 local $dbh->{LongReadLen} = 64 * 1024 if ($dbh->{LongReadLen} < 64 * 1024);
154 # disable default bindtype
155 local $sql_maker->{bindtype} = 'normal';
157 # look up the correct sequence automatically
158 my ( $schema, $table ) = $source_name =~ /( (?:${ql})? \w+ (?:${qr})? ) \. ( (?:${ql})? \w+ (?:${qr})? )/x;
160 # if no explicit schema was requested - use the default schema (which in the case of Oracle is the db user)
161 $schema ||= \'= USER';
163 my ($sql, @bind) = $sql_maker->select (
165 [qw/TRIGGER_BODY TABLE_OWNER TRIGGER_NAME/],
168 TABLE_NAME => $table || $source_name,
169 TRIGGERING_EVENT => { -like => '%INSERT%' }, # this will also catch insert_or_update
170 TRIGGER_TYPE => { -like => '%BEFORE%' }, # we care only about 'before' triggers
175 # to find all the triggers that mention the column in question a simple
176 # regex grep since the trigger_body above is a LONG and hence not searchable
179 { my %inf; @inf{qw/body schema name/} = @$_; \%inf }
181 { $_->[0] =~ /\:new\.${ql}${col}${qr} | \:new\.$col/xi }
182 @{ $dbh->selectall_arrayref( $sql, {}, @bind ) }
186 # extract all sequence names mentioned in each trigger, throw away
187 # triggers without apparent sequences
189 my @seqs = $_->{body} =~ / ( [\.\w\"\-]+ ) \. nextval /xig;
191 ? { %$_, sequences => \@seqs }
198 # if only one trigger matched things are easy
199 if (@triggers == 1) {
201 if ( @{$triggers[0]{sequences}} == 1 ) {
202 $chosen_trigger = $triggers[0];
205 $self->throw_exception( sprintf (
206 "Unable to introspect trigger '%s' for column %s.%s (references multiple sequences). "
207 . "You need to specify the correct 'sequence' explicitly in '%s's column_info.",
215 # got more than one matching trigger - see if we can narrow it down
216 elsif (@triggers > 1) {
218 my @candidates = grep
219 { $_->{body} =~ / into \s+ \:new\.$col /xi }
223 if (@candidates == 1 && @{$candidates[0]{sequences}} == 1) {
224 $chosen_trigger = $candidates[0];
227 $self->throw_exception( sprintf (
228 "Unable to reliably select a BEFORE INSERT trigger for column %s.%s (possibilities: %s). "
229 . "You need to specify the correct 'sequence' explicitly in '%s's column_info.",
232 ( join ', ', map { "'$_->{name}'" } @triggers ),
238 if ($chosen_trigger) {
239 my $seq_name = $chosen_trigger->{sequences}[0];
241 $seq_name = "$chosen_trigger->{schema}.$seq_name"
242 unless $seq_name =~ /\./;
244 return \$seq_name if $seq_name =~ /\"/; # may already be quoted in-trigger
248 $self->throw_exception( sprintf (
249 "No suitable BEFORE INSERT triggers found for column %s.%s. "
250 . "You need to specify the correct 'sequence' explicitly in '%s's column_info.",
257 sub _sequence_fetch {
258 my ( $self, $type, $seq ) = @_;
260 # use the maker to leverage quoting settings
261 my $sth = $self->_dbh->prepare_cached(
262 $self->sql_maker->select('DUAL', [ ref $seq ? \"$$seq.$type" : "$seq.$type" ] )
265 my ($id) = $sth->fetchrow_array;
273 my $dbh = $self->_dbh or return 0;
275 local $dbh->{RaiseError} = 1;
276 local $dbh->{PrintError} = 0;
279 $dbh->do('select 1 from dual');
287 my ($self, $dbh, $sql, @args) = @_;
290 my $want = wantarray;
291 my $next = $self->next::can;
295 # Turn off sth caching for multi-part LOBs. See _prep_for_execute above.
296 local $self->{disable_sth_caching} = 1
298 ($_->[0]{_ora_lob_autosplit_part}||0)
299 > (__cache_queries_with_max_lob_parts-1)
302 $self->$next($dbh, $sql, @args)
305 if (!defined $want) {
318 if (! $tried and $_ =~ /ORA-01003/) {
319 # ORA-01003: no statement parsed (someone changed the table somehow,
320 # invalidating your cursor.)
321 delete $dbh->{CachedKids}{$sql};
324 $self->throw_exception($_);
327 } while (! $tried++);
329 return wantarray ? @res : $res[0];
332 sub _dbh_execute_array {
333 #my ($self, $sth, $tuple_status, @extra) = @_;
335 # DBD::Oracle warns loudly on partial execute_array failures
336 local $_[1]->{PrintWarn} = 0;
338 shift->next::method(@_);
341 =head2 get_autoinc_seq
343 Returns the sequence name for an autoincrement column
347 sub get_autoinc_seq {
348 my ($self, $source, $col) = @_;
350 $self->dbh_do('_dbh_get_autoinc_seq', $source, $col);
353 =head2 datetime_parser_type
355 This sets the proper DateTime::Format module for use with
356 L<DBIx::Class::InflateColumn::DateTime>.
358 =head2 connect_call_datetime_setup
362 on_connect_call => 'datetime_setup'
364 In L<connect_info|DBIx::Class::Storage::DBI/connect_info> to set the session nls
365 date, and timestamp values for use with L<DBIx::Class::InflateColumn::DateTime>
366 and the necessary environment variables for L<DateTime::Format::Oracle>, which
369 Maximum allowable precision is used, unless the environment variables have
372 These are the defaults used:
374 $ENV{NLS_DATE_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS';
375 $ENV{NLS_TIMESTAMP_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF';
376 $ENV{NLS_TIMESTAMP_TZ_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF TZHTZM';
378 To get more than second precision with L<DBIx::Class::InflateColumn::DateTime>
379 for your timestamps, use something like this:
381 use Time::HiRes 'time';
382 my $ts = DateTime->from_epoch(epoch => time);
386 sub connect_call_datetime_setup {
389 my $date_format = $ENV{NLS_DATE_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS';
390 my $timestamp_format = $ENV{NLS_TIMESTAMP_FORMAT} ||=
391 'YYYY-MM-DD HH24:MI:SS.FF';
392 my $timestamp_tz_format = $ENV{NLS_TIMESTAMP_TZ_FORMAT} ||=
393 'YYYY-MM-DD HH24:MI:SS.FF TZHTZM';
396 "alter session set nls_date_format = '$date_format'"
399 "alter session set nls_timestamp_format = '$timestamp_format'"
402 "alter session set nls_timestamp_tz_format='$timestamp_tz_format'"
406 ### Note originally by Ron "Quinn" Straight <quinnfazigu@gmail.org>
407 ### http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/DBIx-Class.git;a=commitdiff;h=5db2758de644d53e07cd3e05f0e9037bf40116fc
409 # Handle LOB types in Oracle. Under a certain size (4k?), you can get away
410 # with the driver assuming your input is the deprecated LONG type if you
411 # encode it as a hex string. That ain't gonna fly at larger values, where
412 # you'll discover you have to do what this does.
414 # This method had to be overridden because we need to set ora_field to the
415 # actual column, and that isn't passed to the call (provided by Storage) to
416 # bind_attribute_by_data_type.
418 # According to L<DBD::Oracle>, the ora_field isn't always necessary, but
419 # adding it doesn't hurt, and will save your bacon if you're modifying a
420 # table with more than one LOB column.
422 sub _dbi_attrs_for_bind {
423 my ($self, $ident, $bind) = @_;
425 my $attrs = $self->next::method($ident, $bind);
427 for my $i (0 .. $#$attrs) {
428 if (keys %{$attrs->[$i]||{}} and my $col = $bind->[$i][0]{dbic_colname}) {
429 $attrs->[$i]{ora_field} = $col;
436 sub bind_attribute_by_data_type {
437 my ($self, $dt) = @_;
439 if ($self->_is_lob_type($dt)) {
441 # this is a hot-ish codepath, store an escape-flag in the DBD namespace, so that
442 # things like Class::Unload work (unlikely but possible)
443 unless ($DBD::Oracle::__DBIC_DBD_VERSION_CHECK_OK__) {
445 # no earlier - no later
446 if ($DBD::Oracle::VERSION eq '1.23') {
447 $self->throw_exception(
448 "BLOB/CLOB support in DBD::Oracle == 1.23 is broken, use an earlier or later ".
449 "version (https://rt.cpan.org/Public/Bug/Display.html?id=46016)"
453 $DBD::Oracle::__DBIC_DBD_VERSION_CHECK_OK__ = 1;
457 ora_type => $self->_is_text_lob_type($dt)
458 ? DBD::Oracle::ORA_CLOB()
459 : DBD::Oracle::ORA_BLOB()
467 # Handle blob columns in WHERE.
469 # For equality comparisons:
471 # We split data intended for comparing to a LOB into 2000 character chunks and
472 # compare them using dbms_lob.substr on the LOB column.
474 # We turn off DBD::Oracle LOB binds for these partial LOB comparisons by passing
475 # dbd_attrs => undef, because these are regular varchar2 comparisons and
476 # otherwise the query will fail.
478 # Since the most common comparison size is likely to be under 4000 characters
479 # (TEXT comparisons previously deployed to other RDBMSes) we disable
480 # prepare_cached for queries with more than two part comparisons to a LOB
481 # column. This is done in _dbh_execute (above) which was previously overridden
482 # to gracefully recover from an Oracle error. This is to be careful to not
483 # exhaust your application's open cursor limit.
486 # http://itcareershift.com/blog1/2011/02/21/oracle-max-number-of-open-cursors-complete-reference-for-the-new-oracle-dba/
487 # on the open_cursor limit.
489 # For everything else:
491 # We assume that everything that is not a LOB comparison, will most likely be a
492 # LIKE query or some sort of function invocation. This may prove to be a naive
493 # assumption in the future, but for now it should cover the two most likely
494 # things users would want to do with a BLOB or CLOB, an equality test or a LIKE
497 # For these expressions, the bind must NOT have the attributes of a LOB bind for
498 # DBD::Oracle, otherwise the query will fail. This is done by passing
499 # dbd_attrs => undef.
501 sub _prep_for_execute {
505 return $self->next::method(@_)
508 my ($sql, $bind) = $self->next::method(@_);
510 my $lob_bind_indices = { map {
512 $bind->[$_][0]{sqlt_datatype}
514 $self->_is_lob_type($bind->[$_][0]{sqlt_datatype})
516 } ( 0 .. $#$bind ) };
518 return ($sql, $bind) unless %$lob_bind_indices;
520 my ($final_sql, @final_binds);
521 if ($op eq 'update') {
522 $self->throw_exception('Update with complex WHERE clauses currently not supported')
523 if $sql =~ /\bWHERE\b .+ \bWHERE\b/xs;
526 ($final_sql, $where_sql) = $sql =~ /^ (.+?) ( \bWHERE\b .+) /xs;
528 if (my $set_bind_count = $final_sql =~ y/?//) {
530 delete $lob_bind_indices->{$_} for (0 .. ($set_bind_count - 1));
532 # bail if only the update part contains blobs
533 return ($sql, $bind) unless %$lob_bind_indices;
535 @final_binds = splice @$bind, 0, $set_bind_count;
536 $lob_bind_indices = { map
537 { $_ - $set_bind_count => $lob_bind_indices->{$_} }
538 keys %$lob_bind_indices
542 # if we got that far - assume the where SQL is all we got
543 # (the first part is already shoved into $final_sql)
546 elsif ($op ne 'select' and $op ne 'delete') {
547 $self->throw_exception("Unsupported \$op: $op");
550 my @sql_parts = split /\?/, $sql;
552 my $col_equality_re = qr/ (?<=\s) ([\w."]+) (\s*=\s*) $/x;
554 for my $b_idx (0 .. $#$bind) {
555 my $bound = $bind->[$b_idx];
558 $lob_bind_indices->{$b_idx}
560 my ($col, $eq) = $sql_parts[0] =~ $col_equality_re
562 my $data = $bound->[1];
564 $data = "$data" if ref $data;
566 my @parts = unpack '(a2000)*', $data;
570 for my $idx (0..$#parts) {
571 push @sql_frag, sprintf (
572 'UTL_RAW.CAST_TO_VARCHAR2(RAWTOHEX(DBMS_LOB.SUBSTR(%s, 2000, %d))) = ?',
573 $col, ($idx*2000 + 1),
577 my $sql_frag = '( ' . (join ' AND ', @sql_frag) . ' )';
579 $sql_parts[0] =~ s/$col_equality_re/$sql_frag/;
581 $final_sql .= shift @sql_parts;
583 for my $idx (0..$#parts) {
587 _ora_lob_autosplit_part => $idx,
595 $final_sql .= shift(@sql_parts) . '?';
596 push @final_binds, $lob_bind_indices->{$b_idx}
608 if (@sql_parts > 1) {
609 carp "There are more placeholders than binds, this should not happen!";
610 @sql_parts = join ('?', @sql_parts);
613 $final_sql .= $sql_parts[0];
615 return ($final_sql, \@final_binds);
620 sub _exec_svp_begin {
621 my ($self, $name) = @_;
622 $self->_dbh->do("SAVEPOINT $name");
625 # Oracle automatically releases a savepoint when you start another one with the
627 sub _exec_svp_release { 1 }
629 sub _exec_svp_rollback {
630 my ($self, $name) = @_;
631 $self->_dbh->do("ROLLBACK TO SAVEPOINT $name")
634 =head2 relname_to_table_alias
636 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
639 Unfortunately, Oracle doesn't support identifiers over 30 chars in length, so
640 the L<DBIx::Class::Relationship> name is shortened and appended with half of an
643 See L<DBIx::Class::Storage/"relname_to_table_alias">.
647 sub relname_to_table_alias {
649 my ($relname, $join_count) = @_;
651 my $alias = $self->next::method(@_);
653 # we need to shorten here in addition to the shortening in SQLA itself,
654 # since the final relnames are a crucial for the join optimizer
655 return $self->sql_maker->_shorten_identifier($alias);
658 =head2 with_deferred_fk_checks
660 Runs a coderef between:
662 alter session set constraints = deferred
664 alter session set constraints = immediate
666 to defer foreign key checks.
668 Constraints must be declared C<DEFERRABLE> for this to work.
672 sub with_deferred_fk_checks {
673 my ($self, $sub) = @_;
675 my $txn_scope_guard = $self->txn_scope_guard;
677 $self->_do_query('alter session set constraints = deferred');
679 my $sg = Scope::Guard->new(sub {
680 $self->_do_query('alter session set constraints = immediate');
684 preserve_context { $sub->() } after => sub { $txn_scope_guard->commit };
689 Following additional attributes can be used in resultsets.
691 =head2 connect_by or connect_by_nocycle
695 =item Value: \%connect_by
699 A hashref of conditions used to specify the relationship between parent rows
700 and child rows of the hierarchy.
703 connect_by => { parentid => 'prior personid' }
705 # adds a connect by statement to the query:
707 # me.persionid me.firstname, me.lastname, me.parentid
711 # parentid = prior persionid
714 connect_by_nocycle => { parentid => 'prior personid' }
716 # adds a connect by statement to the query:
718 # me.persionid me.firstname, me.lastname, me.parentid
722 # parentid = prior persionid
729 =item Value: \%condition
733 A hashref of conditions which specify the root row(s) of the hierarchy.
735 It uses the same syntax as L<DBIx::Class::ResultSet/search>
737 start_with => { firstname => 'Foo', lastname => 'Bar' }
740 # me.persionid me.firstname, me.lastname, me.parentid
744 # firstname = 'foo' and lastname = 'bar'
746 # parentid = prior persionid
748 =head2 order_siblings_by
752 =item Value: ($order_siblings_by | \@order_siblings_by)
756 Which column(s) to order the siblings by.
758 It uses the same syntax as L<DBIx::Class::ResultSet/order_by>
760 'order_siblings_by' => 'firstname ASC'
763 # me.persionid me.firstname, me.lastname, me.parentid
767 # parentid = prior persionid
773 See L<DBIx::Class/AUTHOR> and L<DBIx::Class/CONTRIBUTORS>.
777 You may distribute this code under the same terms as Perl itself.