X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FDBI%2FOracle%2FGeneric.pm;h=3d463ba0bb819bcde04a85ee80ba21b7f48ec570;hb=ab4f4e4cdbe2eee3b6230d03f152942e96fb24f9;hp=92a920a75a898c5ad26e9ad7708ad2798edf4793;hpb=5db2758de644d53e07cd3e05f0e9037bf40116fc;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 92a920a..3d463ba 100644 --- a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm +++ b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm @@ -1,37 +1,105 @@ 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::Generic - 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' => \'persionid' }, + '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 persionid + # 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 DBD::Oracle qw( :ora_types ); -#use constant ORA_BLOB => 113; ## ORA_CLOB is 112 +sub deployment_statements { + my $self = shift;; + my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_; -use base qw/DBIx::Class::Storage::DBI::MultiDistinctEmulation/; + $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; -# __PACKAGE__->load_components(qw/PK::Auto/); + 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) = @_; @@ -47,110 +115,111 @@ 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' - }; - - # trigger_body is a LONG - $dbh->{LongReadLen} = 64 * 1024 if ($dbh->{LongReadLen} < 64 * 1024); - - my $sth; + my $sql_maker = $self->sql_maker; - # 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 $source_name; + if ( ref $source->name eq 'SCALAR' ) { + $source_name = ${$source->name}; } else { - $sth = $dbh->prepare($sql); - $sth->execute( uc( $source->name ) ); + $source_name = $source->name; } - while (my ($insert_trigger) = $sth->fetchrow_array) { - return uc($1) if $insert_trigger =~ m!(\w+)\.nextval!i; # col name goes here??? + $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); + + # disable default bindtype + local $sql_maker->{bindtype} = 'normal'; + + # look up the correct sequence automatically + my ( $schema, $table ) = $source_name =~ /(\w+)\.(\w+)/; + my ($sql, @bind) = $sql_maker->select ( + 'ALL_TRIGGERS', + ['trigger_body', 'table_owner'], + { + $schema ? (owner => $schema) : (), + table_name => $table || $source_name, + triggering_event => { -like => '%INSERT%' }, + status => 'ENABLED', + }, + ); + my $sth = $dbh->prepare($sql); + $sth->execute (@bind); + + while (my ($insert_trigger, $schema) = $sth->fetchrow_array) { + my ($seq_name) = $insert_trigger =~ m/("?[.\w"]+"?)\.nextval .+ into \s+ :new\.$col/xmsi; + + next unless $seq_name; + + if ($seq_name !~ /\./) { + $seq_name = join '.' => $schema, $seq_name; + } + + return $seq_name; } - $self->throw_exception("Unable to find a sequence INSERT trigger on table '" . $source->name . "'."); + $self->throw_exception("Unable to find a sequence %INSERT% trigger on table '$source_name'."); } sub _sequence_fetch { my ( $self, $type, $seq ) = @_; - my ($id) = $self->dbh->selectrow_array("SELECT ${seq}.${type} FROM DUAL"); + my ($id) = $self->_get_dbh->selectrow_array("SELECT ${seq}.${type} FROM DUAL"); return $id; } -=head2 connected - -Returns true if we have an open (and working) database connection, false if it is not (yet) -open (or does not work). (Executes a simple SELECT to make sure it works.) - -The reason this is needed is that L's ping() does not do a real -OCIPing but just gets the server version, which doesn't help if someone killed -your session. - -=cut - -sub connected { +sub _ping { my $self = shift; - if (not $self->SUPER::connected(@_)) { - return 0; - } - else { - my $dbh = $self->_dbh; + my $dbh = $self->_dbh or return 0; - local $dbh->{RaiseError} = 1; + local $dbh->{RaiseError} = 1; + local $dbh->{PrintError} = 0; - eval { - my $ping_sth = $dbh->prepare_cached("select 1 from dual"); - $ping_sth->execute; - $ping_sth->finish; - }; - - return $@ ? 0 : 1; - } + 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 $wantarray = wantarray; - - my (@res, $exception, $retried); - - RETRY: { - do { - eval { - if ($wantarray) { - @res = $self->SUPER::_dbh_execute(@_); - } else { - $res[0] = $self->SUPER::_dbh_execute(@_); - } - }; - $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 @@ -161,36 +230,65 @@ Returns the sequence name for an autoincrement column sub get_autoinc_seq { my ($self, $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 - $self->next::method(uc($table)); -} +Used as: -=head2 datetime_parser_type + on_connect_call => 'datetime_setup' -This sets the proper DateTime::Format module for use with -L. +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: + + use Time::HiRes 'time'; + my $ts = DateTime->from_epoch(epoch => time); =cut -sub datetime_parser_type { return "DateTime::Format::Oracle"; } +sub connect_call_datetime_setup { + my $self = shift; -sub _svp_begin { - my ($self, $name) = @_; - - $self->dbh->do("SAVEPOINT $name"); + 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 source_bind_attributes @@ -210,29 +308,44 @@ table with more than one LOB column. =cut -sub source_bind_attributes +sub source_bind_attributes { - 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) { - $column_bind_attrs{'ora_type'} - = uc($data_type) eq 'CLOB' ? ORA_CLOB : ORA_BLOB; - $column_bind_attrs{'ora_field'} = $column; - } + 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; + } - $bind_attributes{$column} = \%column_bind_attrs; - } + return \%bind_attributes; +} - 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 @@ -240,16 +353,148 @@ sub source_bind_attributes 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. + +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'); + }); - $self->dbh->do("ROLLBACK TO SAVEPOINT $name") + return + preserve_context { $sub->() } after => sub { $txn_scope_guard->commit }; } -=head1 AUTHORS +=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' + + # 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