X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FOracle%2FGeneric.pm;h=be48f207a9868f4850100f50d9589e10ddaefe90;hb=6f5f880dacae5dcad72178f33916cce0e662a9f9;hp=57540cb275e2db6a949bb43fea3f719e8ebf38dc;hpb=c00243555c65c5df61de5578f3a19afb939dd212;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm index 57540cb..be48f20 100644 --- a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm +++ b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm @@ -2,6 +2,12 @@ package DBIx::Class::Storage::DBI::Oracle::Generic; use strict; use warnings; +use Scope::Guard (); +use Context::Preserve 'preserve_context'; +use Try::Tiny; +use namespace::clean; + +__PACKAGE__->sql_limit_dialect ('RowNum'); =head1 NAME @@ -9,8 +15,8 @@ DBIx::Class::Storage::DBI::Oracle::Generic - Oracle Support for DBIx::Class =head1 SYNOPSIS - # In your table classes - __PACKAGE__->load_components(qw/PK::Auto Core/); + # In your result (table) classes + use base 'DBIx::Class::Core'; __PACKAGE__->add_columns({ id => { sequence => 'mysequence', auto_nextval => 1 } }); __PACKAGE__->set_primary_key('id'); __PACKAGE__->sequence('mysequence'); @@ -42,8 +48,8 @@ DBIx::Class::Storage::DBI::Oracle::Generic - Oracle Support for DBIx::Class my $rs = $schema->resultset('Person')->search({}, { 'start_with' => { 'firstname' => 'foo', 'lastname' => 'bar' }, - 'connect_by' => { 'parentid' => 'prior persionid'}, - 'order_siblings_by' => 'firstname ASC', + 'connect_by' => { 'parentid' => { '-prior' => { -ident => 'personid' } }, + 'order_siblings_by' => { -asc => 'name' }, }; ); @@ -56,14 +62,15 @@ DBIx::Class::Storage::DBI::Oracle::Generic - Oracle Support for DBIx::Class # START WITH # firstname = 'foo' and lastname = 'bar' # CONNECT BY - # parentid = prior persionid + # parentid = prior personid # ORDER SIBLINGS BY # firstname ASC =head1 DESCRIPTION -This class implements autoincrements for Oracle and adds support for Oracle -specific hierarchical queries. +This class implements base Oracle support. The subclass +L is for C<(+)> joins in Oracle +versions before 9. =head1 METHODS @@ -72,7 +79,27 @@ specific hierarchical queries. use base qw/DBIx::Class::Storage::DBI/; use mro 'c3'; -__PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks::Oracle'); +__PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::Oracle'); + +sub deployment_statements { + my $self = shift;; + my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_; + + $sqltargs ||= {}; + my $quote_char = $self->schema->storage->sql_maker->quote_char; + $sqltargs->{quote_table_names} = $quote_char ? 1 : 0; + $sqltargs->{quote_field_names} = $quote_char ? 1 : 0; + + if ( + ! exists $sqltargs->{producer_args}{oracle_version} + and + my $dver = $self->_server_info->{dbms_version} + ) { + $sqltargs->{producer_args}{oracle_version} = $dver; + } + + $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest); +} sub _dbh_last_insert_id { my ($self, $dbh, $source, @columns) = @_; @@ -88,46 +115,110 @@ sub _dbh_last_insert_id { sub _dbh_get_autoinc_seq { my ($self, $dbh, $source, $col) = @_; - # look up the correct sequence automatically - my $sql = q{ - SELECT trigger_body FROM ALL_TRIGGERS t - WHERE t.table_name = ? - AND t.triggering_event = 'INSERT' - AND t.status = 'ENABLED' - }; + my $sql_maker = $self->sql_maker; + + my $source_name; + if ( ref $source->name eq 'SCALAR' ) { + $source_name = ${$source->name}; + } + else { + $source_name = $source->name; + } + $source_name = uc($source_name) unless $sql_maker->quote_char; # trigger_body is a LONG local $dbh->{LongReadLen} = 64 * 1024 if ($dbh->{LongReadLen} < 64 * 1024); - my $sth; + # disable default bindtype + local $sql_maker->{bindtype} = 'normal'; - my $source_name; - if ( ref $source->name ne 'SCALAR' ) { - $source_name = $source->name; - } - else { - $source_name = ${$source->name}; + # look up the correct sequence automatically + my ( $schema, $table ) = $source_name =~ /(\w+)\.(\w+)/; + my ($sql, @bind) = $sql_maker->select ( + 'ALL_TRIGGERS', + [qw/ trigger_body table_owner trigger_name /], + { + $schema ? (owner => $schema) : (), + table_name => $table || $source_name, + triggering_event => { -like => '%INSERT%' }, # this will also catch insert_or_update + trigger_type => { -like => '%BEFORE%' }, # we care only about 'before' triggers + status => 'ENABLED', + }, + ); + + # to find all the triggers that mention the column in question a simple + # regex grep since the trigger_body above is a LONG and hence not searchable + my @triggers = ( map + { my %inf; @inf{qw/body schema name/} = @$_; \%inf } + ( grep + { $_->[0] =~ /\:new\.$col/i } + @{ $dbh->selectall_arrayref( $sql, {}, @bind ) } + ) + ); + + # extract all sequence names mentioned in each trigger + for (@triggers) { + $_->{sequences} = [ $_->{body} =~ / ( "? [\.\w\"\-]+ "? ) \. nextval /xig ]; } - # check for fully-qualified name (eg. SCHEMA.TABLENAME) - if ( my ( $schema, $table ) = $source_name =~ /(\w+)\.(\w+)/ ) { - $sql = q{ - SELECT trigger_body FROM ALL_TRIGGERS t - WHERE t.owner = ? AND t.table_name = ? - AND t.triggering_event = 'INSERT' - AND t.status = 'ENABLED' - }; - $sth = $dbh->prepare($sql); - $sth->execute( uc($schema), uc($table) ); + my $chosen_trigger; + + # if only one trigger matched things are easy + if (@triggers == 1) { + + if ( @{$triggers[0]{sequences}} == 1 ) { + $chosen_trigger = $triggers[0]; + } + else { + $self->throw_exception( sprintf ( + "Unable to introspect trigger '%s' for column %s.%s (references multiple sequences). " + . "You need to specify the correct 'sequence' explicitly in '%s's column_info.", + $triggers[0]{name}, + $source_name, + $col, + $col, + ) ); + } } - else { - $sth = $dbh->prepare($sql); - $sth->execute( uc( $source_name ) ); + # got more than one matching trigger - see if we can narrow it down + elsif (@triggers > 1) { + + my @candidates = grep + { $_->{body} =~ / into \s+ \:new\.$col /xi } + @triggers + ; + + if (@candidates == 1 && @{$candidates[0]{sequences}} == 1) { + $chosen_trigger = $candidates[0]; + } + else { + $self->throw_exception( sprintf ( + "Unable to reliably select a BEFORE INSERT trigger for column %s.%s (possibilities: %s). " + . "You need to specify the correct 'sequence' explicitly in '%s's column_info.", + $source_name, + $col, + ( join ', ', map { "'$_->{name}'" } @triggers ), + $col, + ) ); + } } - while (my ($insert_trigger) = $sth->fetchrow_array) { - return uc($1) if $insert_trigger =~ m!(\w+)\.nextval!i; # col name goes here??? + + if ($chosen_trigger) { + my $seq_name = $chosen_trigger->{sequences}[0]; + + $seq_name = "$chosen_trigger->{schema}.$seq_name" + unless $seq_name =~ /\./; + + return $seq_name; } - $self->throw_exception("Unable to find a sequence INSERT trigger on table '" . $source->name . "'."); + + $self->throw_exception( sprintf ( + "No suitable BEFORE INSERT triggers found for column %s.%s. " + . "You need to specify the correct 'sequence' explicitly in '%s's column_info.", + $source_name, + $col, + $col, + )); } sub _sequence_fetch { @@ -142,46 +233,53 @@ sub _ping { my $dbh = $self->_dbh or return 0; local $dbh->{RaiseError} = 1; + local $dbh->{PrintError} = 0; - eval { - $dbh->do("select 1 from dual"); + return try { + $dbh->do('select 1 from dual'); + 1; + } catch { + 0; }; - - return $@ ? 0 : 1; } sub _dbh_execute { my $self = shift; my ($dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_; - my $wantarray = wantarray; - - my (@res, $exception, $retried); - - RETRY: { - do { - eval { - if ($wantarray) { - @res = $self->next::method(@_); - } else { - $res[0] = $self->next::method(@_); - } - }; - $exception = $@; - if ($exception =~ /ORA-01003/) { + my (@res, $tried); + my $wantarray = wantarray(); + my $next = $self->next::can; + do { + try { + my $exec = sub { $self->$next($dbh, $op, $extra_bind, $ident, $bind_attributes, @args) }; + + if (!defined $wantarray) { + $exec->(); + } + elsif (! $wantarray) { + $res[0] = $exec->(); + } + else { + @res = $exec->(); + } + + $tried++; + } + catch { + if (! $tried and $_ =~ /ORA-01003/) { # ORA-01003: no statement parsed (someone changed the table somehow, # invalidating your cursor.) my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args); delete $dbh->{CachedKids}{$sql}; - } else { - last RETRY; } - } while (not $retried++); - } - - $self->throw_exception($exception) if $exception; + else { + $self->throw_exception($_); + } + }; + } while (! $tried++); - wantarray ? @res : $res[0] + return $wantarray ? @res : $res[0]; } =head2 get_autoinc_seq @@ -196,19 +294,6 @@ sub get_autoinc_seq { $self->dbh_do('_dbh_get_autoinc_seq', $source, $col); } -=head2 columns_info_for - -This wraps the superclass version of this method to force table -names to uppercase - -=cut - -sub columns_info_for { - my ($self, $table) = @_; - - $self->next::method(uc($table)); -} - =head2 datetime_parser_type This sets the proper DateTime::Format module for use with @@ -224,10 +309,10 @@ Used as: on_connect_call => 'datetime_setup' -In L to set the session nls date, and -timestamp values for use with L and the -necessary environment variables for L, which is used -by it. +In L to set the session nls +date, and timestamp values for use with L +and the necessary environment variables for L, which +is used by it. Maximum allowable precision is used, unless the environment variables have already been set. @@ -255,11 +340,15 @@ sub connect_call_datetime_setup { my $timestamp_tz_format = $ENV{NLS_TIMESTAMP_TZ_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF TZHTZM'; - $self->_do_query("alter session set nls_date_format = '$date_format'"); $self->_do_query( -"alter session set nls_timestamp_format = '$timestamp_format'"); + "alter session set nls_date_format = '$date_format'" + ); + $self->_do_query( + "alter session set nls_timestamp_format = '$timestamp_format'" + ); $self->_do_query( -"alter session set nls_timestamp_tz_format='$timestamp_tz_format'"); + "alter session set nls_timestamp_tz_format='$timestamp_tz_format'" + ); } =head2 source_bind_attributes @@ -281,35 +370,42 @@ table with more than one LOB column. sub source_bind_attributes { - require DBD::Oracle; - my $self = shift; - my($source) = @_; + require DBD::Oracle; + my $self = shift; + my($source) = @_; + + my %bind_attributes; - my %bind_attributes; + foreach my $column ($source->columns) { + my $data_type = $source->column_info($column)->{data_type} || ''; + next unless $data_type; - foreach my $column ($source->columns) { - my $data_type = $source->column_info($column)->{data_type} || ''; - next unless $data_type; + my %column_bind_attrs = $self->bind_attribute_by_data_type($data_type); - my %column_bind_attrs = $self->bind_attribute_by_data_type($data_type); + if ($data_type =~ /^[BC]LOB$/i) { + if ($DBD::Oracle::VERSION eq '1.23') { + $self->throw_exception( +"BLOB/CLOB support in DBD::Oracle == 1.23 is broken, use an earlier or later ". +"version.\n\nSee: https://rt.cpan.org/Public/Bug/Display.html?id=46016\n" + ); + } - if ($data_type =~ /^[BC]LOB$/i) { - $column_bind_attrs{'ora_type'} = uc($data_type) eq 'CLOB' ? - DBD::Oracle::ORA_CLOB() : - DBD::Oracle::ORA_BLOB(); - $column_bind_attrs{'ora_field'} = $column; - } + $column_bind_attrs{'ora_type'} = uc($data_type) eq 'CLOB' + ? DBD::Oracle::ORA_CLOB() + : DBD::Oracle::ORA_BLOB() + ; + $column_bind_attrs{'ora_field'} = $column; + } - $bind_attributes{$column} = \%column_bind_attrs; - } + $bind_attributes{$column} = \%column_bind_attrs; + } - return \%bind_attributes; + return \%bind_attributes; } sub _svp_begin { - my ($self, $name) = @_; - - $self->_get_dbh->do("SAVEPOINT $name"); + my ($self, $name) = @_; + $self->_get_dbh->do("SAVEPOINT $name"); } # Oracle automatically releases a savepoint when you start another one with the @@ -317,33 +413,66 @@ sub _svp_begin { sub _svp_release { 1 } sub _svp_rollback { - my ($self, $name) = @_; + my ($self, $name) = @_; + $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name") +} + +=head2 relname_to_table_alias + +L uses L names as table aliases in +queries. - $self->_get_dbh->do("ROLLBACK TO SAVEPOINT $name") +Unfortunately, Oracle doesn't support identifiers over 30 chars in length, so +the L name is shortened and appended with half of an +MD5 hash. + +See L. + +=cut + +sub relname_to_table_alias { + my $self = shift; + my ($relname, $join_count) = @_; + + my $alias = $self->next::method(@_); + + return $self->sql_maker->_shorten_identifier($alias, [$relname]); } -sub _select_args { - my ($self, $ident, $select, $where, $attrs) = @_; +=head2 with_deferred_fk_checks - my $connect_by_args = {}; - if ( $attrs->{connect_by} || $attrs->{start_with} || $attrs->{order_siblings_by} ) { - $connect_by_args = { - connect_by => $attrs->{connect_by}, - start_with => $attrs->{start_with}, - order_siblings_by => $attrs->{order_siblings_by}, - } - } +Runs a coderef between: + + alter session set constraints = deferred + ... + alter session set constraints = immediate + +to defer foreign key checks. + +Constraints must be declared C for this to work. + +=cut + +sub with_deferred_fk_checks { + my ($self, $sub) = @_; + + my $txn_scope_guard = $self->txn_scope_guard; - my @rv = $self->next::method($ident, $select, $where, $attrs); + $self->_do_query('alter session set constraints = deferred'); - return (@rv, $connect_by_args); + my $sg = Scope::Guard->new(sub { + $self->_do_query('alter session set constraints = immediate'); + }); + + return + preserve_context { $sub->() } after => sub { $txn_scope_guard->commit }; } =head1 ATTRIBUTES Following additional attributes can be used in resultsets. -=head2 connect_by +=head2 connect_by or connect_by_nocycle =over 4 @@ -354,6 +483,7 @@ Following additional attributes can be used in resultsets. A hashref of conditions used to specify the relationship between parent rows and child rows of the hierarchy. + connect_by => { parentid => 'prior personid' } # adds a connect by statement to the query: @@ -363,6 +493,18 @@ and child rows of the hierarchy. # person me # CONNECT BY # parentid = prior persionid + + + connect_by_nocycle => { parentid => 'prior personid' } + + # adds a connect by statement to the query: + # SELECT + # me.persionid me.firstname, me.lastname, me.parentid + # FROM + # person me + # CONNECT BY NOCYCLE + # parentid = prior persionid + =head2 start_with