1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
4 use base 'DBIx::Class::Storage';
8 use Carp::Clan qw/^DBIx::Class/;
10 use SQL::Abstract::Limit;
11 use DBIx::Class::Storage::DBI::Cursor;
12 use DBIx::Class::Storage::Statistics;
13 use Scalar::Util qw/blessed weaken/;
15 __PACKAGE__->mk_group_accessors('simple' =>
16 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts
17 _conn_pid _conn_tid disable_sth_caching on_connect_do
18 on_disconnect_do transaction_depth unsafe _dbh_autocommit
19 auto_savepoint savepoints/
22 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
24 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
25 __PACKAGE__->sql_maker_class('DBIC::SQL::Abstract');
29 package # Hide from PAUSE
30 DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
32 use base qw/SQL::Abstract::Limit/;
34 # This prevents the caching of $dbh in S::A::L, I believe
36 my $self = shift->SUPER::new(@_);
38 # If limit_dialect is a ref (like a $dbh), go ahead and replace
39 # it with what it resolves to:
40 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
41 if ref $self->{limit_dialect};
47 my ($self, $sql, $order, $rows, $offset ) = @_;
50 my $last = $rows + $offset;
51 my ( $order_by ) = $self->_order_by( $order );
56 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
61 WHERE ROW_NUM BETWEEN $offset AND $last
67 # While we're at it, this should make LIMIT queries more efficient,
68 # without digging into things too deeply
69 use Scalar::Util 'blessed';
71 my ($self, $syntax) = @_;
72 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
73 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
74 return 'RowNumberOver';
77 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
81 my ($self, $table, $fields, $where, $order, @rest) = @_;
82 $table = $self->_quote($table) unless ref($table);
83 local $self->{rownum_hack_count} = 1
84 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
85 @rest = (-1) unless defined $rest[0];
86 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
87 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
88 local $self->{having_bind} = [];
89 my ($sql, @ret) = $self->SUPER::select(
90 $table, $self->_recurse_fields($fields), $where, $order, @rest
95 $self->{for} eq 'update' ? ' FOR UPDATE' :
96 $self->{for} eq 'shared' ? ' FOR SHARE' :
101 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
107 $table = $self->_quote($table) unless ref($table);
108 $self->SUPER::insert($table, @_);
114 $table = $self->_quote($table) unless ref($table);
115 $self->SUPER::update($table, @_);
121 $table = $self->_quote($table) unless ref($table);
122 $self->SUPER::delete($table, @_);
128 return $_[1].$self->_order_by($_[2]);
130 return $self->SUPER::_emulate_limit(@_);
134 sub _recurse_fields {
135 my ($self, $fields, $params) = @_;
136 my $ref = ref $fields;
137 return $self->_quote($fields) unless $ref;
138 return $$fields if $ref eq 'SCALAR';
140 if ($ref eq 'ARRAY') {
141 return join(', ', map {
142 $self->_recurse_fields($_)
143 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
144 ? ' AS col'.$self->{rownum_hack_count}++
147 } elsif ($ref eq 'HASH') {
148 foreach my $func (keys %$fields) {
149 return $self->_sqlcase($func)
150 .'( '.$self->_recurse_fields($fields->{$func}).' )';
159 if (ref $_[0] eq 'HASH') {
160 if (defined $_[0]->{group_by}) {
161 $ret = $self->_sqlcase(' group by ')
162 .$self->_recurse_fields($_[0]->{group_by}, { no_rownum_hack => 1 });
164 if (defined $_[0]->{having}) {
166 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
167 push(@{$self->{having_bind}}, @extra);
168 $ret .= $self->_sqlcase(' having ').$frag;
170 if (defined $_[0]->{order_by}) {
171 $ret .= $self->_order_by($_[0]->{order_by});
173 } elsif (ref $_[0] eq 'SCALAR') {
174 $ret = $self->_sqlcase(' order by ').${ $_[0] };
175 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
176 my @order = @{+shift};
177 $ret = $self->_sqlcase(' order by ')
179 my $r = $self->_order_by($_, @_);
180 $r =~ s/^ ?ORDER BY //i;
184 $ret = $self->SUPER::_order_by(@_);
189 sub _order_directions {
190 my ($self, $order) = @_;
191 $order = $order->{order_by} if ref $order eq 'HASH';
192 return $self->SUPER::_order_directions($order);
196 my ($self, $from) = @_;
197 if (ref $from eq 'ARRAY') {
198 return $self->_recurse_from(@$from);
199 } elsif (ref $from eq 'HASH') {
200 return $self->_make_as($from);
202 return $from; # would love to quote here but _table ends up getting called
203 # twice during an ->select without a limit clause due to
204 # the way S::A::Limit->select works. should maybe consider
205 # bypassing this and doing S::A::select($self, ...) in
206 # our select method above. meantime, quoting shims have
207 # been added to select/insert/update/delete here
212 my ($self, $from, @join) = @_;
214 push(@sqlf, $self->_make_as($from));
215 foreach my $j (@join) {
218 # check whether a join type exists
219 my $join_clause = '';
220 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
221 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
222 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
224 $join_clause = ' JOIN ';
226 push(@sqlf, $join_clause);
228 if (ref $to eq 'ARRAY') {
229 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
231 push(@sqlf, $self->_make_as($to));
233 push(@sqlf, ' ON ', $self->_join_condition($on));
235 return join('', @sqlf);
239 my ($self, $from) = @_;
240 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
241 reverse each %{$self->_skip_options($from)});
245 my ($self, $hash) = @_;
247 $clean_hash->{$_} = $hash->{$_}
248 for grep {!/^-/} keys %$hash;
252 sub _join_condition {
253 my ($self, $cond) = @_;
254 if (ref $cond eq 'HASH') {
259 # XXX no throw_exception() in this package and croak() fails with strange results
260 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
261 if ref($v) ne 'SCALAR';
265 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
268 return scalar($self->_recurse_where(\%j));
269 } elsif (ref $cond eq 'ARRAY') {
270 return join(' OR ', map { $self->_join_condition($_) } @$cond);
272 die "Can't handle this yet!";
277 my ($self, $label) = @_;
278 return '' unless defined $label;
279 return "*" if $label eq '*';
280 return $label unless $self->{quote_char};
281 if(ref $self->{quote_char} eq "ARRAY"){
282 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
283 if !defined $self->{name_sep};
284 my $sep = $self->{name_sep};
285 return join($self->{name_sep},
286 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
287 split(/\Q$sep\E/,$label));
289 return $self->SUPER::_quote($label);
294 $self->{limit_dialect} = shift if @_;
295 return $self->{limit_dialect};
300 $self->{quote_char} = shift if @_;
301 return $self->{quote_char};
306 $self->{name_sep} = shift if @_;
307 return $self->{name_sep};
310 } # End of BEGIN block
314 DBIx::Class::Storage::DBI - DBI storage handler
320 This class represents the connection to an RDBMS via L<DBI>. See
321 L<DBIx::Class::Storage> for general information. This pod only
322 documents DBI-specific methods and behaviors.
329 my $new = shift->next::method(@_);
331 $new->transaction_depth(0);
332 $new->_sql_maker_opts({});
333 $new->{savepoints} = [];
334 $new->{_in_dbh_do} = 0;
335 $new->{_dbh_gen} = 0;
342 The arguments of C<connect_info> are always a single array reference.
344 This is normally accessed via L<DBIx::Class::Schema/connection>, which
345 encapsulates its argument list in an arrayref before calling
346 C<connect_info> here.
348 The arrayref can either contain the same set of arguments one would
349 normally pass to L<DBI/connect>, or a lone code reference which returns
350 a connected database handle. Please note that the L<DBI> docs
351 recommend that you always explicitly set C<AutoCommit> to either
352 C<0> or C<1>. L<DBIx::Class> further recommends that it be set
353 to C<1>, and that you perform transactions via our L</txn_do>
354 method. L<DBIx::Class> will set it to C<1> if you do not do explicitly
355 set it to zero. This is the default for most DBDs. See below for more
358 In either case, if the final argument in your connect_info happens
359 to be a hashref, C<connect_info> will look there for several
360 connection-specific options:
366 Specifies things to do immediately after connecting or re-connecting to
367 the database. Its value may contain:
371 =item an array reference
373 This contains SQL statements to execute in order. Each element contains
374 a string or a code reference that returns a string.
376 =item a code reference
378 This contains some code to execute. Unlike code references within an
379 array reference, its return value is ignored.
383 =item on_disconnect_do
385 Takes arguments in the same form as L<on_connect_do> and executes them
386 immediately before disconnecting from the database.
388 Note, this only runs if you explicitly call L<disconnect> on the
391 =item disable_sth_caching
393 If set to a true value, this option will disable the caching of
394 statement handles via L<DBI/prepare_cached>.
398 Sets the limit dialect. This is useful for JDBC-bridge among others
399 where the remote SQL-dialect cannot be determined by the name of the
404 Specifies what characters to use to quote table and column names. If
405 you use this you will want to specify L<name_sep> as well.
407 quote_char expects either a single character, in which case is it is placed
408 on either side of the table/column, or an arrayref of length 2 in which case the
409 table/column name is placed between the elements.
411 For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd
412 use C<quote_char =E<gt> [qw/[ ]/]>.
416 This only needs to be used in conjunction with L<quote_char>, and is used to
417 specify the charecter that seperates elements (schemas, tables, columns) from
418 each other. In most cases this is simply a C<.>.
422 This Storage driver normally installs its own C<HandleError>, sets
423 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
424 all database handles, including those supplied by a coderef. It does this
425 so that it can have consistent and useful error behavior.
427 If you set this option to a true value, Storage will not do its usual
428 modifications to the database handle's attributes, and instead relies on
429 the settings in your connect_info DBI options (or the values you set in
430 your connection coderef, in the case that you are connecting via coderef).
432 Note that your custom settings can cause Storage to malfunction,
433 especially if you set a C<HandleError> handler that suppresses exceptions
434 and/or disable C<RaiseError>.
438 If this option is true, L<DBIx::Class> will use savepoints when nesting
439 transactions, making it possible to recover from failure in the inner
440 transaction without having to abort all outer transactions.
444 These options can be mixed in with your other L<DBI> connection attributes,
445 or placed in a seperate hashref after all other normal L<DBI> connection
448 Every time C<connect_info> is invoked, any previous settings for
449 these options will be cleared before setting the new ones, regardless of
450 whether any options are specified in the new C<connect_info>.
452 Another Important Note:
454 DBIC can do some wonderful magic with handling exceptions,
455 disconnections, and transactions when you use C<< AutoCommit => 1 >>
456 combined with C<txn_do> for transaction support.
458 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
459 in an assumed transaction between commits, and you're telling us you'd
460 like to manage that manually. A lot of DBIC's magic protections
461 go away. We can't protect you from exceptions due to database
462 disconnects because we don't know anything about how to restart your
463 transactions. You're on your own for handling all sorts of exceptional
464 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
469 # Simple SQLite connection
470 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
473 ->connect_info([ sub { DBI->connect(...) } ]);
475 # A bit more complicated
482 { quote_char => q{"}, name_sep => q{.} },
486 # Equivalent to the previous example
492 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
496 # Subref + DBIC-specific connection options
499 sub { DBI->connect(...) },
503 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
504 disable_sth_caching => 1,
512 my ($self, $info_arg) = @_;
514 return $self->_connect_info if !$info_arg;
516 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
517 # the new set of options
518 $self->_sql_maker(undef);
519 $self->_sql_maker_opts({});
520 $self->_connect_info([@$info_arg]); # copy for _connect_info
522 my $dbi_info = [@$info_arg]; # copy for _dbi_connect_info
524 my $last_info = $dbi_info->[-1];
525 if(ref $last_info eq 'HASH') {
526 $last_info = { %$last_info }; # so delete is non-destructive
527 my @storage_option = qw(
528 on_connect_do on_disconnect_do disable_sth_caching unsafe cursor_class
531 for my $storage_opt (@storage_option) {
532 if(my $value = delete $last_info->{$storage_opt}) {
533 $self->$storage_opt($value);
536 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
537 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
538 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
541 # re-insert modified hashref
542 $dbi_info->[-1] = $last_info;
544 # Get rid of any trailing empty hashref
545 pop(@$dbi_info) if !keys %$last_info;
547 $self->_dbi_connect_info($dbi_info);
549 $self->_connect_info;
554 This method is deprecated in favor of setting via L</connect_info>.
558 Arguments: ($subref | $method_name), @extra_coderef_args?
560 Execute the given $subref or $method_name using the new exception-based
561 connection management.
563 The first two arguments will be the storage object that C<dbh_do> was called
564 on and a database handle to use. Any additional arguments will be passed
565 verbatim to the called subref as arguments 2 and onwards.
567 Using this (instead of $self->_dbh or $self->dbh) ensures correct
568 exception handling and reconnection (or failover in future subclasses).
570 Your subref should have no side-effects outside of the database, as
571 there is the potential for your subref to be partially double-executed
572 if the database connection was stale/dysfunctional.
576 my @stuff = $schema->storage->dbh_do(
578 my ($storage, $dbh, @cols) = @_;
579 my $cols = join(q{, }, @cols);
580 $dbh->selectrow_array("SELECT $cols FROM foo");
591 my $dbh = $self->_dbh;
593 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
594 || $self->{transaction_depth};
596 local $self->{_in_dbh_do} = 1;
599 my $want_array = wantarray;
602 $self->_verify_pid if $dbh;
604 $self->_populate_dbh;
609 @result = $self->$code($dbh, @_);
611 elsif(defined $want_array) {
612 $result[0] = $self->$code($dbh, @_);
615 $self->$code($dbh, @_);
620 if(!$exception) { return $want_array ? @result : $result[0] }
622 $self->throw_exception($exception) if $self->connected;
624 # We were not connected - reconnect and retry, but let any
625 # exception fall right through this time
626 $self->_populate_dbh;
627 $self->$code($self->_dbh, @_);
630 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
631 # It also informs dbh_do to bypass itself while under the direction of txn_do,
632 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
637 ref $coderef eq 'CODE' or $self->throw_exception
638 ('$coderef must be a CODE reference');
640 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
642 local $self->{_in_dbh_do} = 1;
645 my $want_array = wantarray;
650 $self->_verify_pid if $self->_dbh;
651 $self->_populate_dbh if !$self->_dbh;
655 @result = $coderef->(@_);
657 elsif(defined $want_array) {
658 $result[0] = $coderef->(@_);
667 if(!$exception) { return $want_array ? @result : $result[0] }
669 if($tried++ > 0 || $self->connected) {
670 eval { $self->txn_rollback };
671 my $rollback_exception = $@;
672 if($rollback_exception) {
673 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
674 $self->throw_exception($exception) # propagate nested rollback
675 if $rollback_exception =~ /$exception_class/;
677 $self->throw_exception(
678 "Transaction aborted: ${exception}. "
679 . "Rollback failed: ${rollback_exception}"
682 $self->throw_exception($exception)
685 # We were not connected, and was first try - reconnect and retry
687 $self->_populate_dbh;
693 Our C<disconnect> method also performs a rollback first if the
694 database is not in C<AutoCommit> mode.
701 if( $self->connected ) {
702 my $connection_do = $self->on_disconnect_do;
703 $self->_do_connection_actions($connection_do) if ref($connection_do);
705 $self->_dbh->rollback unless $self->_dbh_autocommit;
707 # SQLite is evil/brainded and must be DESTROYed without disconnecting: http://www.perlmonks.org/?node_id=666210
708 $self->_dbh->disconnect if $self->_dbh->get_info(17) ne 'SQLite';
715 =head2 with_deferred_fk_checks
719 =item Arguments: C<$coderef>
721 =item Return Value: The return value of $coderef
725 Storage specific method to run the code ref with FK checks deferred or
726 in MySQL's case disabled entirely.
730 # Storage subclasses should override this
731 sub with_deferred_fk_checks {
732 my ($self, $sub) = @_;
740 if(my $dbh = $self->_dbh) {
741 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
748 return 0 if !$self->_dbh;
750 return ($dbh->FETCH('Active') && $dbh->ping);
756 # handle pid changes correctly
757 # NOTE: assumes $self->_dbh is a valid $dbh
761 return if defined $self->_conn_pid && $self->_conn_pid == $$;
763 $self->_dbh->{InactiveDestroy} = 1;
770 sub ensure_connected {
773 unless ($self->connected) {
774 $self->_populate_dbh;
780 Returns the dbh - a data base handle of class L<DBI>.
787 $self->ensure_connected;
791 sub _sql_maker_args {
794 return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
799 unless ($self->_sql_maker) {
800 my $sql_maker_class = $self->sql_maker_class;
801 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
803 return $self->_sql_maker;
810 my @info = @{$self->_dbi_connect_info || []};
811 $self->_dbh($self->_connect(@info));
813 # Always set the transaction depth on connect, since
814 # there is no transaction in progress by definition
815 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
817 if(ref $self eq 'DBIx::Class::Storage::DBI') {
818 my $driver = $self->_dbh->{Driver}->{Name};
819 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
820 bless $self, "DBIx::Class::Storage::DBI::${driver}";
825 my $connection_do = $self->on_connect_do;
826 $self->_do_connection_actions($connection_do) if ref($connection_do);
828 $self->_conn_pid($$);
829 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
832 sub _do_connection_actions {
834 my $connection_do = shift;
836 if (ref $connection_do eq 'ARRAY') {
837 $self->_do_query($_) foreach @$connection_do;
839 elsif (ref $connection_do eq 'CODE') {
847 my ($self, $action) = @_;
849 if (ref $action eq 'CODE') {
850 $action = $action->($self);
851 $self->_do_query($_) foreach @$action;
854 my @to_run = (ref $action eq 'ARRAY') ? (@$action) : ($action);
855 $self->_query_start(@to_run);
856 $self->_dbh->do(@to_run);
857 $self->_query_end(@to_run);
864 my ($self, @info) = @_;
866 $self->throw_exception("You failed to provide any connection info")
869 my ($old_connect_via, $dbh);
871 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
872 $old_connect_via = $DBI::connect_via;
873 $DBI::connect_via = 'connect';
877 if(ref $info[0] eq 'CODE') {
881 $dbh = DBI->connect(@info);
884 if($dbh && !$self->unsafe) {
885 my $weak_self = $self;
887 $dbh->{HandleError} = sub {
888 $weak_self->throw_exception("DBI Exception: $_[0]")
890 $dbh->{ShowErrorStatement} = 1;
891 $dbh->{RaiseError} = 1;
892 $dbh->{PrintError} = 0;
896 $DBI::connect_via = $old_connect_via if $old_connect_via;
898 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
901 $self->_dbh_autocommit($dbh->{AutoCommit});
907 my ($self, $name) = @_;
909 $name = $self->_svp_generate_name
910 unless defined $name;
912 $self->throw_exception ("You can't use savepoints outside a transaction")
913 if $self->{transaction_depth} == 0;
915 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
916 unless $self->can('_svp_begin');
918 push @{ $self->{savepoints} }, $name;
920 $self->debugobj->svp_begin($name) if $self->debug;
922 return $self->_svp_begin($name);
926 my ($self, $name) = @_;
928 $self->throw_exception ("You can't use savepoints outside a transaction")
929 if $self->{transaction_depth} == 0;
931 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
932 unless $self->can('_svp_release');
935 $self->throw_exception ("Savepoint '$name' does not exist")
936 unless grep { $_ eq $name } @{ $self->{savepoints} };
938 # Dig through the stack until we find the one we are releasing. This keeps
939 # the stack up to date.
942 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
944 $name = pop @{ $self->{savepoints} };
947 $self->debugobj->svp_release($name) if $self->debug;
949 return $self->_svp_release($name);
953 my ($self, $name) = @_;
955 $self->throw_exception ("You can't use savepoints outside a transaction")
956 if $self->{transaction_depth} == 0;
958 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
959 unless $self->can('_svp_rollback');
962 # If they passed us a name, verify that it exists in the stack
963 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
964 $self->throw_exception("Savepoint '$name' does not exist!");
967 # Dig through the stack until we find the one we are releasing. This keeps
968 # the stack up to date.
969 while(my $s = pop(@{ $self->{savepoints} })) {
970 last if($s eq $name);
972 # Add the savepoint back to the stack, as a rollback doesn't remove the
973 # named savepoint, only everything after it.
974 push(@{ $self->{savepoints} }, $name);
976 # We'll assume they want to rollback to the last savepoint
977 $name = $self->{savepoints}->[-1];
980 $self->debugobj->svp_rollback($name) if $self->debug;
982 return $self->_svp_rollback($name);
985 sub _svp_generate_name {
988 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
993 $self->ensure_connected();
994 if($self->{transaction_depth} == 0) {
995 $self->debugobj->txn_begin()
997 # this isn't ->_dbh-> because
998 # we should reconnect on begin_work
999 # for AutoCommit users
1000 $self->dbh->begin_work;
1001 } elsif ($self->auto_savepoint) {
1004 $self->{transaction_depth}++;
1009 if ($self->{transaction_depth} == 1) {
1010 my $dbh = $self->_dbh;
1011 $self->debugobj->txn_commit()
1014 $self->{transaction_depth} = 0
1015 if $self->_dbh_autocommit;
1017 elsif($self->{transaction_depth} > 1) {
1018 $self->{transaction_depth}--;
1020 if $self->auto_savepoint;
1026 my $dbh = $self->_dbh;
1028 if ($self->{transaction_depth} == 1) {
1029 $self->debugobj->txn_rollback()
1031 $self->{transaction_depth} = 0
1032 if $self->_dbh_autocommit;
1035 elsif($self->{transaction_depth} > 1) {
1036 $self->{transaction_depth}--;
1037 if ($self->auto_savepoint) {
1038 $self->svp_rollback;
1043 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1048 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1049 $error =~ /$exception_class/ and $self->throw_exception($error);
1050 # ensure that a failed rollback resets the transaction depth
1051 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1052 $self->throw_exception($error);
1056 # This used to be the top-half of _execute. It was split out to make it
1057 # easier to override in NoBindVars without duping the rest. It takes up
1058 # all of _execute's args, and emits $sql, @bind.
1059 sub _prep_for_execute {
1060 my ($self, $op, $extra_bind, $ident, $args) = @_;
1062 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1064 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1067 return ($sql, \@bind);
1070 sub _fix_bind_params {
1071 my ($self, @bind) = @_;
1073 ### Turn @bind from something like this:
1074 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1076 ### ( "'1'", "'1'", "'3'" )
1079 if ( defined( $_ && $_->[1] ) ) {
1080 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1087 my ( $self, $sql, @bind ) = @_;
1089 if ( $self->debug ) {
1090 @bind = $self->_fix_bind_params(@bind);
1092 $self->debugobj->query_start( $sql, @bind );
1097 my ( $self, $sql, @bind ) = @_;
1099 if ( $self->debug ) {
1100 @bind = $self->_fix_bind_params(@bind);
1101 $self->debugobj->query_end( $sql, @bind );
1106 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1108 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1109 $ident = $ident->from();
1112 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1114 $self->_query_start( $sql, @$bind );
1116 my $sth = $self->sth($sql,$op);
1118 my $placeholder_index = 1;
1120 foreach my $bound (@$bind) {
1121 my $attributes = {};
1122 my($column_name, @data) = @$bound;
1124 if ($bind_attributes) {
1125 $attributes = $bind_attributes->{$column_name}
1126 if defined $bind_attributes->{$column_name};
1129 foreach my $data (@data) {
1130 $data = ref $data ? ''.$data : $data; # stringify args
1132 $sth->bind_param($placeholder_index, $data, $attributes);
1133 $placeholder_index++;
1137 # Can this fail without throwing an exception anyways???
1138 my $rv = $sth->execute();
1139 $self->throw_exception($sth->errstr) if !$rv;
1141 $self->_query_end( $sql, @$bind );
1143 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1148 $self->dbh_do('_dbh_execute', @_)
1152 my ($self, $source, $to_insert) = @_;
1154 my $ident = $source->from;
1155 my $bind_attributes = $self->source_bind_attributes($source);
1157 $self->ensure_connected;
1158 foreach my $col ( $source->columns ) {
1159 if ( !defined $to_insert->{$col} ) {
1160 my $col_info = $source->column_info($col);
1162 if ( $col_info->{auto_nextval} ) {
1163 $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1168 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1173 ## Still not quite perfect, and EXPERIMENTAL
1174 ## Currently it is assumed that all values passed will be "normal", i.e. not
1175 ## scalar refs, or at least, all the same type as the first set, the statement is
1176 ## only prepped once.
1178 my ($self, $source, $cols, $data) = @_;
1180 my $table = $source->from;
1181 @colvalues{@$cols} = (0..$#$cols);
1182 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1184 $self->_query_start( $sql, @bind );
1185 my $sth = $self->sth($sql);
1187 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1189 ## This must be an arrayref, else nothing works!
1191 my $tuple_status = [];
1194 ##print STDERR Dumper( $data, $sql, [@bind] );
1198 ## Get the bind_attributes, if any exist
1199 my $bind_attributes = $self->source_bind_attributes($source);
1201 ## Bind the values and execute
1202 my $placeholder_index = 1;
1204 foreach my $bound (@bind) {
1206 my $attributes = {};
1207 my ($column_name, $data_index) = @$bound;
1209 if( $bind_attributes ) {
1210 $attributes = $bind_attributes->{$column_name}
1211 if defined $bind_attributes->{$column_name};
1214 my @data = map { $_->[$data_index] } @$data;
1216 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1217 $placeholder_index++;
1219 my $rv = $sth->execute_array({ArrayTupleStatus => $tuple_status});
1220 $self->throw_exception($sth->errstr) if !$rv;
1222 $self->_query_end( $sql, @bind );
1223 return (wantarray ? ($rv, $sth, @bind) : $rv);
1227 my $self = shift @_;
1228 my $source = shift @_;
1229 my $bind_attributes = $self->source_bind_attributes($source);
1231 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1236 my $self = shift @_;
1237 my $source = shift @_;
1239 my $bind_attrs = {}; ## If ever it's needed...
1241 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1245 my ($self, $ident, $select, $condition, $attrs) = @_;
1246 my $order = $attrs->{order_by};
1248 if (ref $condition eq 'SCALAR') {
1249 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1252 my $for = delete $attrs->{for};
1253 my $sql_maker = $self->sql_maker;
1254 local $sql_maker->{for} = $for;
1256 if (exists $attrs->{group_by} || $attrs->{having}) {
1258 group_by => $attrs->{group_by},
1259 having => $attrs->{having},
1260 ($order ? (order_by => $order) : ())
1263 my $bind_attrs = {}; ## Future support
1264 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1265 if ($attrs->{software_limit} ||
1266 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1267 $attrs->{software_limit} = 1;
1269 $self->throw_exception("rows attribute must be positive if present")
1270 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1272 # MySQL actually recommends this approach. I cringe.
1273 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1274 push @args, $attrs->{rows}, $attrs->{offset};
1277 return $self->_execute(@args);
1280 sub source_bind_attributes {
1281 my ($self, $source) = @_;
1283 my $bind_attributes;
1284 foreach my $column ($source->columns) {
1286 my $data_type = $source->column_info($column)->{data_type} || '';
1287 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1291 return $bind_attributes;
1298 =item Arguments: $ident, $select, $condition, $attrs
1302 Handle a SQL select statement.
1308 my ($ident, $select, $condition, $attrs) = @_;
1309 return $self->cursor_class->new($self, \@_, $attrs);
1314 my ($rv, $sth, @bind) = $self->_select(@_);
1315 my @row = $sth->fetchrow_array;
1316 if(@row && $sth->fetchrow_array) {
1317 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1319 # Need to call finish() to work round broken DBDs
1328 =item Arguments: $sql
1332 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1337 my ($self, $dbh, $sql) = @_;
1339 # 3 is the if_active parameter which avoids active sth re-use
1340 my $sth = $self->disable_sth_caching
1341 ? $dbh->prepare($sql)
1342 : $dbh->prepare_cached($sql, {}, 3);
1344 # XXX You would think RaiseError would make this impossible,
1345 # but apparently that's not true :(
1346 $self->throw_exception($dbh->errstr) if !$sth;
1352 my ($self, $sql) = @_;
1353 $self->dbh_do('_dbh_sth', $sql);
1356 sub _dbh_columns_info_for {
1357 my ($self, $dbh, $table) = @_;
1359 if ($dbh->can('column_info')) {
1362 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1363 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1365 while ( my $info = $sth->fetchrow_hashref() ){
1367 $column_info{data_type} = $info->{TYPE_NAME};
1368 $column_info{size} = $info->{COLUMN_SIZE};
1369 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1370 $column_info{default_value} = $info->{COLUMN_DEF};
1371 my $col_name = $info->{COLUMN_NAME};
1372 $col_name =~ s/^\"(.*)\"$/$1/;
1374 $result{$col_name} = \%column_info;
1377 return \%result if !$@ && scalar keys %result;
1381 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1383 my @columns = @{$sth->{NAME_lc}};
1384 for my $i ( 0 .. $#columns ){
1386 $column_info{data_type} = $sth->{TYPE}->[$i];
1387 $column_info{size} = $sth->{PRECISION}->[$i];
1388 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1390 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1391 $column_info{data_type} = $1;
1392 $column_info{size} = $2;
1395 $result{$columns[$i]} = \%column_info;
1399 foreach my $col (keys %result) {
1400 my $colinfo = $result{$col};
1401 my $type_num = $colinfo->{data_type};
1403 if(defined $type_num && $dbh->can('type_info')) {
1404 my $type_info = $dbh->type_info($type_num);
1405 $type_name = $type_info->{TYPE_NAME} if $type_info;
1406 $colinfo->{data_type} = $type_name if $type_name;
1413 sub columns_info_for {
1414 my ($self, $table) = @_;
1415 $self->dbh_do('_dbh_columns_info_for', $table);
1418 =head2 last_insert_id
1420 Return the row id of the last insert.
1424 sub _dbh_last_insert_id {
1425 my ($self, $dbh, $source, $col) = @_;
1426 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1427 $dbh->func('last_insert_rowid');
1430 sub last_insert_id {
1432 $self->dbh_do('_dbh_last_insert_id', @_);
1437 Returns the database driver name.
1441 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1443 =head2 bind_attribute_by_data_type
1445 Given a datatype from column info, returns a database specific bind attribute for
1446 $dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1449 Generally only needed for special case column types, like bytea in postgres.
1453 sub bind_attribute_by_data_type {
1457 =head2 create_ddl_dir
1461 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1465 Creates a SQL file based on the Schema, for each of the specified
1466 database types, in the given directory.
1468 By default, C<\%sqlt_args> will have
1470 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1472 merged with the hash passed in. To disable any of those features, pass in a
1473 hashref like the following
1475 { ignore_constraint_names => 0, # ... other options }
1479 sub create_ddl_dir {
1480 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1482 if(!$dir || !-d $dir) {
1483 warn "No directory given, using ./\n";
1486 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1487 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1488 $version ||= $schema->VERSION || '1.x';
1490 add_drop_table => 1,
1491 ignore_constraint_names => 1,
1492 ignore_index_names => 1,
1496 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09: '}
1497 . $self->_check_sqlt_message . q{'})
1498 if !$self->_check_sqlt_version;
1500 my $sqlt = SQL::Translator->new( $sqltargs );
1502 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1503 my $sqlt_schema = $sqlt->translate({ data => $schema }) or die $sqlt->error;
1505 foreach my $db (@$databases) {
1507 $sqlt = $self->configure_sqlt($sqlt, $db);
1508 $sqlt->{schema} = $sqlt_schema;
1509 $sqlt->producer($db);
1512 my $filename = $schema->ddl_filename($db, $version, $dir);
1513 if (-e $filename && (!$version || ($version == $schema->schema_version()))) {
1514 # if we are dumping the current version, overwrite the DDL
1515 warn "Overwriting existing DDL file - $filename";
1519 my $output = $sqlt->translate;
1521 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1524 if(!open($file, ">$filename")) {
1525 $self->throw_exception("Can't open $filename for writing ($!)");
1528 print $file $output;
1531 next unless ($preversion);
1533 require SQL::Translator::Diff;
1535 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1536 if(!-e $prefilename) {
1537 warn("No previous schema file found ($prefilename)");
1541 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1543 warn("Overwriting existing diff file - $difffile");
1549 my $t = SQL::Translator->new($sqltargs);
1552 $t->parser( $db ) or die $t->error;
1553 $t = $self->configure_sqlt($t, $db);
1554 my $out = $t->translate( $prefilename ) or die $t->error;
1555 $source_schema = $t->schema;
1556 unless ( $source_schema->name ) {
1557 $source_schema->name( $prefilename );
1561 # The "new" style of producers have sane normalization and can support
1562 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1563 # And we have to diff parsed SQL against parsed SQL.
1564 my $dest_schema = $sqlt_schema;
1566 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1567 my $t = SQL::Translator->new($sqltargs);
1570 $t->parser( $db ) or die $t->error;
1571 $t = $self->configure_sqlt($t, $db);
1572 my $out = $t->translate( $filename ) or die $t->error;
1573 $dest_schema = $t->schema;
1574 $dest_schema->name( $filename )
1575 unless $dest_schema->name;
1578 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1582 if(!open $file, ">$difffile") {
1583 $self->throw_exception("Can't write to $difffile ($!)");
1591 sub configure_sqlt() {
1594 my $db = shift || $self->sqlt_type;
1595 if ($db eq 'PostgreSQL') {
1596 $tr->quote_table_names(0);
1597 $tr->quote_field_names(0);
1602 =head2 deployment_statements
1606 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1610 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1611 The database driver name is given by C<$type>, though the value from
1612 L</sqlt_type> is used if it is not specified.
1614 C<$directory> is used to return statements from files in a previously created
1615 L</create_ddl_dir> directory and is optional. The filenames are constructed
1616 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1618 If no C<$directory> is specified then the statements are constructed on the
1619 fly using L<SQL::Translator> and C<$version> is ignored.
1621 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1625 sub deployment_statements {
1626 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1627 # Need to be connected to get the correct sqlt_type
1628 $self->ensure_connected() unless $type;
1629 $type ||= $self->sqlt_type;
1630 $version ||= $schema->VERSION || '1.x';
1632 my $filename = $schema->ddl_filename($type, $dir, $version);
1636 open($file, "<$filename")
1637 or $self->throw_exception("Can't open $filename ($!)");
1640 return join('', @rows);
1643 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09: '}
1644 . $self->_check_sqlt_message . q{'})
1645 if !$self->_check_sqlt_version;
1647 require SQL::Translator::Parser::DBIx::Class;
1648 eval qq{use SQL::Translator::Producer::${type}};
1649 $self->throw_exception($@) if $@;
1651 # sources needs to be a parser arg, but for simplicty allow at top level
1653 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1654 if exists $sqltargs->{sources};
1656 my $tr = SQL::Translator->new(%$sqltargs);
1657 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1658 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1662 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1663 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1664 foreach my $line ( split(";\n", $statement)) {
1665 next if($line =~ /^--/);
1667 # next if($line =~ /^DROP/m);
1668 next if($line =~ /^BEGIN TRANSACTION/m);
1669 next if($line =~ /^COMMIT/m);
1670 next if $line =~ /^\s+$/; # skip whitespace only
1671 $self->_query_start($line);
1673 $self->dbh->do($line); # shouldn't be using ->dbh ?
1676 warn qq{$@ (running "${line}")};
1678 $self->_query_end($line);
1683 =head2 datetime_parser
1685 Returns the datetime parser class
1689 sub datetime_parser {
1691 return $self->{datetime_parser} ||= do {
1692 $self->ensure_connected;
1693 $self->build_datetime_parser(@_);
1697 =head2 datetime_parser_type
1699 Defines (returns) the datetime parser class - currently hardwired to
1700 L<DateTime::Format::MySQL>
1704 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1706 =head2 build_datetime_parser
1708 See L</datetime_parser>
1712 sub build_datetime_parser {
1714 my $type = $self->datetime_parser_type(@_);
1716 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1721 my $_check_sqlt_version; # private
1722 my $_check_sqlt_message; # private
1723 sub _check_sqlt_version {
1724 return $_check_sqlt_version if defined $_check_sqlt_version;
1725 eval 'use SQL::Translator "0.09"';
1726 $_check_sqlt_message = $@ || '';
1727 $_check_sqlt_version = !$@;
1730 sub _check_sqlt_message {
1731 _check_sqlt_version if !defined $_check_sqlt_message;
1732 $_check_sqlt_message;
1736 =head2 is_replicating
1738 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
1739 replicate from a master database. Default is undef, which is the result
1740 returned by databases that don't support replication.
1744 sub is_replicating {
1749 =head2 lag_behind_master
1751 Returns a number that represents a certain amount of lag behind a master db
1752 when a given storage is replicating. The number is database dependent, but
1753 starts at zero and increases with the amount of lag. Default in undef
1757 sub lag_behind_master {
1763 return if !$self->_dbh;
1772 The module defines a set of methods within the DBIC::SQL::Abstract
1773 namespace. These build on L<SQL::Abstract::Limit> to provide the
1774 SQL query functions.
1776 The following methods are extended:-
1790 See L</connect_info> for details.
1791 For setting, this method is deprecated in favor of L</connect_info>.
1795 See L</connect_info> for details.
1796 For setting, this method is deprecated in favor of L</connect_info>.
1800 See L</connect_info> for details.
1801 For setting, this method is deprecated in favor of L</connect_info>.
1807 Matt S. Trout <mst@shadowcatsystems.co.uk>
1809 Andy Grundman <andy@hybridized.org>
1813 You may distribute this code under the same terms as Perl itself.