From: Rafael Kitover Date: Thu, 11 Jun 2009 18:03:10 +0000 (+0000) Subject: on_connect_call implementation and set_datetime_format support for Oracle X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=d2a3958e111673a0fd1a8f3a6d81700e5d351140;p=dbsrgits%2FDBIx-Class-Historic.git on_connect_call implementation and set_datetime_format support for Oracle --- diff --git a/lib/DBIx/Class/Storage/DBI.pm b/lib/DBIx/Class/Storage/DBI.pm index f70384d..4b5974e 100644 --- a/lib/DBIx/Class/Storage/DBI.pm +++ b/lib/DBIx/Class/Storage/DBI.pm @@ -14,13 +14,14 @@ use List::Util(); __PACKAGE__->mk_group_accessors('simple' => qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts - _conn_pid _conn_tid transaction_depth _dbh_autocommit savepoints/ + _conn_pid _conn_tid transaction_depth _dbh_autocommit _on_connect_do + _on_disconnect_do savepoints/ ); # the values for these accessors are picked out (and deleted) from # the attribute hashref passed to connect_info my @storage_options = qw/ - on_connect_do on_disconnect_do disable_sth_caching unsafe auto_savepoint + on_connect_call on_disconnect_call disable_sth_caching unsafe auto_savepoint /; __PACKAGE__->mk_group_accessors('simple' => @storage_options); @@ -177,6 +178,68 @@ immediately before disconnecting from the database. Note, this only runs if you explicitly call L on the storage object. +=item on_connect_call + +A more generalized form of L that calls the specified +C methods in your storage driver. + + on_connect_do => 'select 1' + +is equivalent to: + + on_connect_call => [ [ do_sql => 'select 1' ] ] + +Its values may contain: + +=over + +=item a scalar + +Will call the C method. + +=item a code reference + +Will execute C<< $code->($storage) >> + +=item an array reference + +Each value can be a method name or code reference. + +=item an array of arrays + +For each array, the first item is taken to be the C method name +or code reference, and the rest are parameters to it. + +=back + +Some predefined storage methods you may use: + +=over + +=item do_sql + +Executes a SQL string or a code reference that returns a SQL string. This is +what L and L use. + +=item set_datetime_format + +Execute any statements necessary to initialize the database session to return +and accept datetime/timestamp values used with +L. + +=back + +=item on_disconnect_call + +Takes arguments in the same form as L and executes them +immediately before disconnecting from the database. + +Calls the C methods as opposed to the +C methods called by L. + +Note, this only runs if you explicitly call L on the +storage object. + =item disable_sth_caching If set to a true value, this option will disable the caching of @@ -347,6 +410,11 @@ sub connect_info { $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val; } } + for my $connect_do_opt (qw/on_connect_do on_disconnect_do/) { + if(my $opt_val = delete $attrs{$connect_do_opt}) { + $self->$connect_do_opt($opt_val); + } + } } %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case @@ -359,6 +427,54 @@ sub connect_info { This method is deprecated in favour of setting via L. +=cut + +sub on_connect_do { + my $self = shift; + $self->_setup_connect_do(on_connect_do => @_); +} + +=head2 on_disconnect_do + +This method is deprecated in favour of setting via L. + +=cut + +sub on_disconnect_do { + my $self = shift; + $self->_setup_connect_do(on_disconnect_do => @_); +} + +sub _setup_connect_do { + my ($self, $opt) = (shift, shift); + + my $accessor = "_$opt"; + + return $self->$accessor if not @_; + + my $val = shift; + + (my $call = $opt) =~ s/_do\z/_call/; + + if (ref($self->$call) ne 'ARRAY') { + $self->$call([ + defined $self->$call ? $self->$call : () + ]); + } + + if (not ref($val)) { + push @{ $self->$call }, [ 'do_sql', $val ]; + } elsif (ref($val) eq 'CODE') { + push @{ $self->$call }, $val; + } elsif (ref($val) eq 'ARRAY') { + push @{ $self->$call }, + map [ 'do_sql', $_ ], @$val; + } else { + $self->throw_exception("Invalid type for $opt ".ref($val)); + } + + $self->$accessor($val); +} =head2 dbh_do @@ -506,8 +622,9 @@ sub disconnect { my ($self) = @_; if( $self->connected ) { - my $connection_do = $self->on_disconnect_do; - $self->_do_connection_actions($connection_do) if ref($connection_do); + my $connection_call = $self->on_disconnect_call; + $self->_do_connection_actions(disconnect_call_ => $connection_call) + if $connection_call; $self->_dbh->rollback unless $self->_dbh_autocommit; $self->_dbh->disconnect; @@ -624,8 +741,9 @@ sub _populate_dbh { # there is no transaction in progress by definition $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1; - my $connection_do = $self->on_connect_do; - $self->_do_connection_actions($connection_do) if $connection_do; + my $connection_call = $self->on_connect_call; + $self->_do_connection_actions(connect_call_ => $connection_call) + if $connection_call; } sub _determine_driver { @@ -650,25 +768,41 @@ sub _determine_driver { } sub _do_connection_actions { - my $self = shift; - my $connection_do = shift; - - if (!ref $connection_do) { - $self->_do_query($connection_do); - } - elsif (ref $connection_do eq 'ARRAY') { - $self->_do_query($_) foreach @$connection_do; - } - elsif (ref $connection_do eq 'CODE') { - $connection_do->($self); - } - else { - $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref $connection_do) ); + my $self = shift; + my $method_prefix = shift; + my $call = shift; + + if (not ref($call)) { + my $method = $method_prefix . $call; + $self->$method(@_); + } elsif (ref($call) eq 'CODE') { + $self->$call(@_); + } elsif (ref($call) eq 'ARRAY') { + if (ref($call->[0]) ne 'ARRAY') { + $self->_do_connection_actions($method_prefix, $_) for @$call; + } else { + $self->_do_connection_actions($method_prefix, @$_) for @$call; + } + } else { + $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) ); } return $self; } +sub connect_call_do_sql { + my $self = shift; + $self->_do_query(@_); +} + +sub disconnect_call_do_sql { + my $self = shift; + $self->_do_query(@_); +} + +# override in db-specific backend when necessary +sub connect_call_set_datetime_format { 1 } + sub _do_query { my ($self, $action) = @_; diff --git a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm index 2021056..15f2a45 100644 --- a/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm +++ b/lib/DBIx/Class/Storage/DBI/Oracle/Generic.pm @@ -183,6 +183,39 @@ L. sub datetime_parser_type { return "DateTime::Format::Oracle"; } +=head2 connect_call_set_datetime_format + +Used as: + + on_connect_call => 'set_datetime_format' + +In L to set the session nls date, +and timestamp values for use with +L. As well as the necessary environment +variables for L. + +Maximum allowable precision is used. + +C is also initialized but is not currently used by +L. + +=cut + +sub connect_call_set_datetime_format { + my $self = shift; + my $dbh = $self->dbh; + + 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'; + + $dbh->do("alter session set nls_date_format = '$date_format'"); + $dbh->do("alter session set nls_timestamp_format = '$timestamp_format'"); + $dbh->do("alter session set nls_timestamp_tz_format = '$timestamp_tz_format'"); +} + sub _svp_begin { my ($self, $name) = @_; diff --git a/t/73oracle.t b/t/73oracle.t index 2e73050..0e250c2 100644 --- a/t/73oracle.t +++ b/t/73oracle.t @@ -32,6 +32,7 @@ use Test::Exception; use Test::More; use lib qw(t/lib); use DBICTest; +use DateTime; my ($dsn, $user, $pass) = @ENV{map { "DBICTEST_ORA_${_}" } qw/DSN USER PASS/}; @@ -40,10 +41,12 @@ plan skip_all => 'Set $ENV{DBICTEST_ORA_DSN}, _USER and _PASS to run this test. ' as well as following sequences: \'pkid1_seq\', \'pkid2_seq\' and \'nonpkid_seq\'' unless ($dsn && $user && $pass); -plan tests => 34; +plan tests => 36; DBICTest::Schema->load_classes('ArtistFQN'); -my $schema = DBICTest::Schema->connect($dsn, $user, $pass); +my $schema = DBICTest::Schema->connect($dsn, $user, $pass, { + on_connect_call => 'set_datetime_format' +}); my $dbh = $schema->storage->dbh; @@ -112,15 +115,22 @@ is($new->artistid, 1, "Oracle Auto-PK worked"); $new = $schema->resultset('ArtistFQN')->create( { name => 'bar' } ); is( $new->artistid, 2, "Oracle Auto-PK worked with fully-qualified tablename" ); -# test join with row count ambiguity +# test join with row count ambiguity, and DateTime inflation + +my $dt = DateTime->now; + my $cd = $schema->resultset('CD')->create({ cdid => 1, artist => 1, title => 'EP C', year => '2003' }); -my $track = $schema->resultset('Track')->create({ trackid => 1, cd => 1, position => 1, title => 'Track1' }); +my $track = $schema->resultset('Track')->create({ trackid => 1, cd => 1, + position => 1, title => 'Track1', last_updated_on => $dt }); my $tjoin = $schema->resultset('Track')->search({ 'me.title' => 'Track1'}, { join => 'cd', rows => 2 } ); -is($tjoin->next->title, 'Track1', "ambiguous column ok"); +ok(my $row = $tjoin->next); + +is($row->title, 'Track1', "ambiguous column ok"); +is($row->updated_date, $dt, "DateTime inflation/deflation ok"); # check count distinct with multiple columns my $other_track = $schema->resultset('Track')->create({ trackid => 2, cd => 1, position => 1, title => 'Track2' });