1 package DBIx::Class::Storage::DBI::Oracle::Generic;
8 DBIx::Class::Storage::DBI::Oracle::Generic - Automatic primary key class for Oracle
12 # In your table classes
13 __PACKAGE__->load_components(qw/PK::Auto Core/);
14 __PACKAGE__->add_columns({ id => { sequence => 'mysequence', auto_nextval => 1 } });
15 __PACKAGE__->set_primary_key('id');
16 __PACKAGE__->sequence('mysequence');
20 This class implements autoincrements for Oracle.
26 use base qw/DBIx::Class::Storage::DBI/;
27 use Carp::Clan qw/^DBIx::Class/;
29 # For ORA_BLOB => 113, ORA_CLOB => 112
30 use DBD::Oracle qw( :ora_types );
32 sub _dbh_last_insert_id {
33 my ($self, $dbh, $source, @columns) = @_;
35 foreach my $col (@columns) {
36 my $seq = ($source->column_info($col)->{sequence} ||= $self->get_autoinc_seq($source,$col));
37 my $id = $self->_sequence_fetch( 'currval', $seq );
43 sub _dbh_get_autoinc_seq {
44 my ($self, $dbh, $source, $col) = @_;
46 # look up the correct sequence automatically
48 SELECT trigger_body FROM ALL_TRIGGERS t
49 WHERE t.table_name = ?
50 AND t.triggering_event = 'INSERT'
51 AND t.status = 'ENABLED'
54 # trigger_body is a LONG
55 $dbh->{LongReadLen} = 64 * 1024 if ($dbh->{LongReadLen} < 64 * 1024);
59 # check for fully-qualified name (eg. SCHEMA.TABLENAME)
60 if ( my ( $schema, $table ) = $source->name =~ /(\w+)\.(\w+)/ ) {
62 SELECT trigger_body FROM ALL_TRIGGERS t
63 WHERE t.owner = ? AND t.table_name = ?
64 AND t.triggering_event = 'INSERT'
65 AND t.status = 'ENABLED'
67 $sth = $dbh->prepare($sql);
68 $sth->execute( uc($schema), uc($table) );
71 $sth = $dbh->prepare($sql);
72 $sth->execute( uc( $source->name ) );
74 while (my ($insert_trigger) = $sth->fetchrow_array) {
75 return uc($1) if $insert_trigger =~ m!(\w+)\.nextval!i; # col name goes here???
77 $self->throw_exception("Unable to find a sequence INSERT trigger on table '" . $source->name . "'.");
81 my ( $self, $type, $seq ) = @_;
82 my ($id) = $self->dbh->selectrow_array("SELECT ${seq}.${type} FROM DUAL");
88 Returns true if we have an open (and working) database connection, false if it is not (yet)
89 open (or does not work). (Executes a simple SELECT to make sure it works.)
91 The reason this is needed is that L<DBD::Oracle>'s ping() does not do a real
92 OCIPing but just gets the server version, which doesn't help if someone killed
100 if (not $self->next::method(@_)) {
103 my $dbh = $self->_dbh;
105 local $dbh->{RaiseError} = 1;
108 $dbh->do("select 1 from dual");
117 my ($dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
119 my $wantarray = wantarray;
121 my (@res, $exception, $retried);
127 @res = $self->next::method(@_);
129 $res[0] = $self->next::method(@_);
133 if ($exception =~ /ORA-01003/) {
134 # ORA-01003: no statement parsed (someone changed the table somehow,
135 # invalidating your cursor.)
136 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
137 delete $dbh->{CachedKids}{$sql};
141 } while (not $retried++);
144 $self->throw_exception($exception) if $exception;
146 wantarray ? @res : $res[0]
149 =head2 get_autoinc_seq
151 Returns the sequence name for an autoincrement column
155 sub get_autoinc_seq {
156 my ($self, $source, $col) = @_;
158 $self->dbh_do('_dbh_get_autoinc_seq', $source, $col);
161 =head2 columns_info_for
163 This wraps the superclass version of this method to force table
168 sub columns_info_for {
169 my ($self, $table) = @_;
171 $self->next::method(uc($table));
174 =head2 datetime_parser_type
176 This sets the proper DateTime::Format module for use with
177 L<DBIx::Class::InflateColumn::DateTime>.
181 sub datetime_parser_type { return "DateTime::Format::Oracle"; }
183 =head2 connect_call_datetime_setup
187 on_connect_call => 'datetime_setup'
189 In L<DBIx::Class::Storage::DBI/connect_info> to set the session nls date, and
190 timestamp values for use with L<DBIx::Class::InflateColumn::DateTime> and the
191 necessary environment variables for L<DateTime::Format::Oracle>, which is used
194 Maximum allowable precision is used, unless the environment variables have
197 These are the defaults used:
199 $ENV{NLS_DATE_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS';
200 $ENV{NLS_TIMESTAMP_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF';
201 $ENV{NLS_TIMESTAMP_TZ_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS.FF TZHTZM';
203 To get more than second precision with L<DBIx::Class::InflateColumn::DateTime>
204 for your timestamps, use something like this:
206 use Time::HiRes 'time';
207 my $ts = DateTime->from_epoch(epoch => time);
211 sub connect_call_datetime_setup {
213 my $dbh = $self->dbh;
215 my $date_format = $ENV{NLS_DATE_FORMAT} ||= 'YYYY-MM-DD HH24:MI:SS';
216 my $timestamp_format = $ENV{NLS_TIMESTAMP_FORMAT} ||=
217 'YYYY-MM-DD HH24:MI:SS.FF';
218 my $timestamp_tz_format = $ENV{NLS_TIMESTAMP_TZ_FORMAT} ||=
219 'YYYY-MM-DD HH24:MI:SS.FF TZHTZM';
221 $dbh->do("alter session set nls_date_format = '$date_format'");
222 $dbh->do("alter session set nls_timestamp_format = '$timestamp_format'");
223 $dbh->do("alter session set nls_timestamp_tz_format='$timestamp_tz_format'");
227 my ($self, $name) = @_;
229 $self->dbh->do("SAVEPOINT $name");
232 =head2 source_bind_attributes
234 Handle LOB types in Oracle. Under a certain size (4k?), you can get away
235 with the driver assuming your input is the deprecated LONG type if you
236 encode it as a hex string. That ain't gonna fly at larger values, where
237 you'll discover you have to do what this does.
239 This method had to be overridden because we need to set ora_field to the
240 actual column, and that isn't passed to the call (provided by Storage) to
241 bind_attribute_by_data_type.
243 According to L<DBD::Oracle>, the ora_field isn't always necessary, but
244 adding it doesn't hurt, and will save your bacon if you're modifying a
245 table with more than one LOB column.
249 sub source_bind_attributes
256 foreach my $column ($source->columns) {
257 my $data_type = $source->column_info($column)->{data_type} || '';
258 next unless $data_type;
260 my %column_bind_attrs = $self->bind_attribute_by_data_type($data_type);
262 if ($data_type =~ /^[BC]LOB$/i) {
263 $column_bind_attrs{'ora_type'}
264 = uc($data_type) eq 'CLOB' ? ORA_CLOB : ORA_BLOB;
265 $column_bind_attrs{'ora_field'} = $column;
268 $bind_attributes{$column} = \%column_bind_attrs;
271 return \%bind_attributes;
274 # Oracle automatically releases a savepoint when you start another one with the
276 sub _svp_release { 1 }
279 my ($self, $name) = @_;
281 $self->dbh->do("ROLLBACK TO SAVEPOINT $name")
286 Andy Grundman <andy@hybridized.org>
288 Scott Connelly <scottsweep@yahoo.com>
292 You may distribute this code under the same terms as Perl itself.