X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FOracle%2FGeneric.pm;h=b255e537c8ade48fd619f578218c89b6c2b1e6b1;hb=07cda1c5a7df6656772dfd65c488c19c15126168;hp=808e20f08562e06a7deff49c88425761663823d4;hpb=2e46b6eb92524b5b39b37791c122a1e2c2ee90b9;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 808e20f..b255e53 100644 --- a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm +++ b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm @@ -1,41 +1,111 @@ package DBIx::Class::Storage::DBI::Oracle::Generic; -# -*- mode: cperl; cperl-indent-level: 2 -*- 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 -DBIx::Class::Storage::DBI::Oracle - Automatic primary key class for Oracle +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'); + + # Somewhere in your Code + # add some data to a table with a hierarchical relationship + $schema->resultset('Person')->create ({ + firstname => 'foo', + lastname => 'bar', + children => [ + { + firstname => 'child1', + lastname => 'bar', + children => [ + { + firstname => 'grandchild', + lastname => 'bar', + } + ], + }, + { + firstname => 'child2', + lastname => 'bar', + }, + ], + }); + + # select from the hierarchical relationship + my $rs = $schema->resultset('Person')->search({}, + { + 'start_with' => { 'firstname' => 'foo', 'lastname' => 'bar' }, + 'connect_by' => { 'parentid' => { '-prior' => { -ident => 'personid' } }, + 'order_siblings_by' => { -asc => 'name' }, + }; + ); + + # this will select the whole tree starting from person "foo bar", creating + # following query: + # SELECT + # me.persionid me.firstname, me.lastname, me.parentid + # FROM + # person me + # START WITH + # firstname = 'foo' and lastname = 'bar' + # CONNECT BY + # parentid = prior personid + # ORDER SIBLINGS BY + # firstname ASC =head1 DESCRIPTION -This class implements autoincrements for Oracle. +This class implements base Oracle support. The subclass +L is for C<(+)> joins in Oracle +versions before 9. =head1 METHODS =cut -use Carp::Clan qw/^DBIx::Class/; +use base qw/DBIx::Class::Storage::DBI/; +use mro 'c3'; + +__PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker::Oracle'); -use base qw/DBIx::Class::Storage::DBI::MultiDistinctEmulation/; +sub deployment_statements { + my $self = shift;; + my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_; -# __PACKAGE__->load_components(qw/PK::Auto/); + $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) = @_; my @ids = (); foreach my $col (@columns) { my $seq = ($source->column_info($col)->{sequence} ||= $self->get_autoinc_seq($source,$col)); - my $id = $self->_sequence_fetch( 'currval', $seq ); + my $id = $self->_sequence_fetch( 'CURRVAL', $seq ); push @ids, $id; } return @ids; @@ -44,51 +114,183 @@ 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 ($ql, $qr) = map { $_ ? (quotemeta $_) : '' } $sql_maker->_quote_chars; + + my $source_name; + if ( ref $source->name eq 'SCALAR' ) { + $source_name = ${$source->name}; + + # the ALL_TRIGGERS match further on is case sensitive - thus uppercase + # stuff unless it is already quoted + $source_name = uc ($source_name) if $source_name !~ /\"/; + } + else { + $source_name = $source->name; + $source_name = uc($source_name) unless $ql; + } # trigger_body is a LONG - $dbh->{LongReadLen} = 64 * 1024 if ($dbh->{LongReadLen} < 64 * 1024); + local $dbh->{LongReadLen} = 64 * 1024 if ($dbh->{LongReadLen} < 64 * 1024); - my $sth = $dbh->prepare($sql); - $sth->execute( uc($source->name) ); - while (my ($insert_trigger) = $sth->fetchrow_array) { - return uc($1) if $insert_trigger =~ m!(\w+)\.nextval!i; # col name goes here??? + # disable default bindtype + local $sql_maker->{bindtype} = 'normal'; + + + # look up the correct sequence automatically + my ( $schema, $table ) = $source_name =~ /( (?:${ql})? \w+ (?:${qr})? ) \. ( (?:${ql})? \w+ (?:${qr})? )/x; + 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\.${ql}${col}${qr} | \:new\.$col/xi } + @{ $dbh->selectall_arrayref( $sql, {}, @bind ) } + ) + ); + + # extract all sequence names mentioned in each trigger + for (@triggers) { + $_->{sequences} = [ $_->{body} =~ / ( "? [\.\w\"\-]+ "? ) \. nextval /xig ]; } - $self->throw_exception("Unable to find a sequence INSERT trigger on table '" . $source->name . "'."); -} -=head2 insert + my $chosen_trigger; -Fetch nextval from sequence and handle insert statement. + # if only one trigger matched things are easy + if (@triggers == 1) { -=cut + 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, + ) ); + } + } + # got more than one matching trigger - see if we can narrow it down + elsif (@triggers > 1) { -sub insert { - my ( $self, $source, $to_insert ) = @_; - foreach my $col ( $source->columns ) { - if ( !defined $to_insert->{$col} ) { - my $col_info = $source->column_info($col); + my @candidates = grep + { $_->{body} =~ / into \s+ \:new\.$col /xi } + @triggers + ; - if ( $col_info->{auto_nextval} ) { - $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) ); - } + 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, + ) ); } } - $self->next::method( $source, $to_insert ); + + if ($chosen_trigger) { + my $seq_name = $chosen_trigger->{sequences}[0]; + + $seq_name = "$chosen_trigger->{schema}.$seq_name" + unless $seq_name =~ /\./; + + return \$seq_name if $seq_name =~ /\"/; # may already be quoted in-trigger + return $seq_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 { my ( $self, $type, $seq ) = @_; - my ($id) = $self->dbh->selectrow_array("SELECT ${seq}.${type} FROM DUAL"); + + # use the maker to leverage quoting settings + my $sql_maker = $self->sql_maker; + my ($id) = $self->_get_dbh->selectrow_array ($sql_maker->select('DUAL', [ ref $seq ? \"$$seq.$type" : "$seq.$type" ] ) ); return $id; } +sub _ping { + my $self = shift; + + my $dbh = $self->_dbh or return 0; + + local $dbh->{RaiseError} = 1; + local $dbh->{PrintError} = 0; + + return try { + $dbh->do('select 1 from dual'); + 1; + } catch { + 0; + }; +} + +sub _dbh_execute { + my $self = shift; + my ($dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_; + + 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 { + $self->throw_exception($_); + } + }; + } while (! $tried++); + + return $wantarray ? @res : $res[0]; +} + =head2 get_autoinc_seq Returns the sequence name for an autoincrement column @@ -97,37 +299,271 @@ Returns the sequence name for an autoincrement column sub get_autoinc_seq { my ($self, $source, $col) = @_; - - $self->dbh_do($self->can('_dbh_get_autoinc_seq'), $source, $col); + + $self->dbh_do('_dbh_get_autoinc_seq', $source, $col); } -=head2 columns_info_for +=head2 datetime_parser_type -This wraps the superclass version of this method to force table -names to uppercase +This sets the proper DateTime::Format module for use with +L. =cut -sub columns_info_for { - my ($self, $table) = @_; +sub datetime_parser_type { return "DateTime::Format::Oracle"; } + +=head2 connect_call_datetime_setup + +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. + +Maximum allowable precision is used, unless the environment variables have +already been set. + +These are the defaults used: + + $ENV{NLS_DATE_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS'; + $ENV{NLS_TIMESTAMP_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF'; + $ENV{NLS_TIMESTAMP_TZ_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF TZHTZM'; + +To get more than second precision with L +for your timestamps, use something like this: - $self->next::method(uc($table)); + use Time::HiRes 'time'; + my $ts = DateTime->from_epoch(epoch => time); + +=cut + +sub connect_call_datetime_setup { + my $self = shift; + + my $date_format = $ENV{NLS_DATE_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS'; + my $timestamp_format = $ENV{NLS_TIMESTAMP_FORMAT} ||= + 'YYYY-MM-DD HH24:MI:SS.FF'; + 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'" + ); + $self->_do_query( + "alter session set nls_timestamp_tz_format='$timestamp_tz_format'" + ); } -=head2 datetime_parser_type +=head2 source_bind_attributes -This sets the proper DateTime::Format module for use with -L. +Handle LOB types in Oracle. Under a certain size (4k?), you can get away +with the driver assuming your input is the deprecated LONG type if you +encode it as a hex string. That ain't gonna fly at larger values, where +you'll discover you have to do what this does. + +This method had to be overridden because we need to set ora_field to the +actual column, and that isn't passed to the call (provided by Storage) to +bind_attribute_by_data_type. + +According to L, the ora_field isn't always necessary, but +adding it doesn't hurt, and will save your bacon if you're modifying a +table with more than one LOB column. =cut -sub datetime_parser_type { return "DateTime::Format::Oracle"; } +sub source_bind_attributes +{ + require DBD::Oracle; + my $self = shift; + my($source) = @_; + + my %bind_attributes; + + foreach my $column ($source->columns) { + my $data_type = $source->column_info($column)->{data_type} + or next; + + 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" + ); + } + + $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; + } + + return \%bind_attributes; +} + +sub _svp_begin { + my ($self, $name) = @_; + $self->_get_dbh->do("SAVEPOINT $name"); +} + +# Oracle automatically releases a savepoint when you start another one with the +# same name. +sub _svp_release { 1 } + +sub _svp_rollback { + 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. + +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]); +} + +=head2 with_deferred_fk_checks + +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; + + $self->_do_query('alter session set constraints = deferred'); + + 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 or connect_by_nocycle + +=over 4 + +=item Value: \%connect_by + +=back + +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: + # SELECT + # me.persionid me.firstname, me.lastname, me.parentid + # FROM + # 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 + +=over 4 + +=item Value: \%condition + +=back + +A hashref of conditions which specify the root row(s) of the hierarchy. + +It uses the same syntax as L + + start_with => { firstname => 'Foo', lastname => 'Bar' } + + # SELECT + # me.persionid me.firstname, me.lastname, me.parentid + # FROM + # person me + # START WITH + # firstname = 'foo' and lastname = 'bar' + # CONNECT BY + # parentid = prior persionid + +=head2 order_siblings_by + +=over 4 + +=item Value: ($order_siblings_by | \@order_siblings_by) + +=back + +Which column(s) to order the siblings by. + +It uses the same syntax as L + + 'order_siblings_by' => 'firstname ASC' -=head1 AUTHORS + # SELECT + # me.persionid me.firstname, me.lastname, me.parentid + # FROM + # person me + # CONNECT BY + # parentid = prior persionid + # ORDER SIBLINGS BY + # firstname ASC -Andy Grundman +=head1 AUTHOR -Scott Connelly +See L. =head1 LICENSE