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 transaction_depth _dbh_autocommit savepoints/
20 # the values for these accessors are picked out (and deleted) from
21 # the attribute hashref passed to connect_info
22 my @storage_options = qw/
23 on_connect_do on_disconnect_do disable_sth_caching unsafe auto_savepoint
25 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
28 # default cursor class, overridable in connect_info attributes
29 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
31 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
32 __PACKAGE__->sql_maker_class('DBIC::SQL::Abstract');
36 package # Hide from PAUSE
37 DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
39 use base qw/SQL::Abstract::Limit/;
41 # This prevents the caching of $dbh in S::A::L, I believe
43 my $self = shift->SUPER::new(@_);
45 # If limit_dialect is a ref (like a $dbh), go ahead and replace
46 # it with what it resolves to:
47 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
48 if ref $self->{limit_dialect};
53 # While we're at it, this should make LIMIT queries more efficient,
54 # without digging into things too deeply
55 use Scalar::Util 'blessed';
57 my ($self, $syntax) = @_;
58 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
59 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
60 return 'RowNumberOver';
63 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
67 my ($self, $table, $fields, $where, $order, @rest) = @_;
68 if (ref $table eq 'SCALAR') {
71 elsif (not ref $table) {
72 $table = $self->_quote($table);
74 local $self->{rownum_hack_count} = 1
75 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
76 @rest = (-1) unless defined $rest[0];
77 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
78 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
79 local $self->{having_bind} = [];
80 my ($sql, @ret) = $self->SUPER::select(
81 $table, $self->_recurse_fields($fields), $where, $order, @rest
86 $self->{for} eq 'update' ? ' FOR UPDATE' :
87 $self->{for} eq 'shared' ? ' FOR SHARE' :
92 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
98 $table = $self->_quote($table) unless ref($table);
99 $self->SUPER::insert($table, @_);
105 $table = $self->_quote($table) unless ref($table);
106 $self->SUPER::update($table, @_);
112 $table = $self->_quote($table) unless ref($table);
113 $self->SUPER::delete($table, @_);
119 return $_[1].$self->_order_by($_[2]);
121 return $self->SUPER::_emulate_limit(@_);
125 sub _recurse_fields {
126 my ($self, $fields, $params) = @_;
127 my $ref = ref $fields;
128 return $self->_quote($fields) unless $ref;
129 return $$fields if $ref eq 'SCALAR';
131 if ($ref eq 'ARRAY') {
132 return join(', ', map {
133 $self->_recurse_fields($_)
134 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
135 ? ' AS col'.$self->{rownum_hack_count}++
138 } elsif ($ref eq 'HASH') {
139 foreach my $func (keys %$fields) {
140 return $self->_sqlcase($func)
141 .'( '.$self->_recurse_fields($fields->{$func}).' )';
150 if (ref $_[0] eq 'HASH') {
151 if (defined $_[0]->{group_by}) {
152 $ret = $self->_sqlcase(' group by ')
153 .$self->_recurse_fields($_[0]->{group_by}, { no_rownum_hack => 1 });
155 if (defined $_[0]->{having}) {
157 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
158 push(@{$self->{having_bind}}, @extra);
159 $ret .= $self->_sqlcase(' having ').$frag;
161 if (defined $_[0]->{order_by}) {
162 $ret .= $self->_order_by($_[0]->{order_by});
164 if (grep { $_ =~ /^-(desc|asc)/i } keys %{$_[0]}) {
165 return $self->SUPER::_order_by($_[0]);
167 } elsif (ref $_[0] eq 'SCALAR') {
168 $ret = $self->_sqlcase(' order by ').${ $_[0] };
169 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
170 my @order = @{+shift};
171 $ret = $self->_sqlcase(' order by ')
173 my $r = $self->_order_by($_, @_);
174 $r =~ s/^ ?ORDER BY //i;
178 $ret = $self->SUPER::_order_by(@_);
183 sub _order_directions {
184 my ($self, $order) = @_;
185 $order = $order->{order_by} if ref $order eq 'HASH';
186 return $self->SUPER::_order_directions($order);
190 my ($self, $from) = @_;
191 if (ref $from eq 'ARRAY') {
192 return $self->_recurse_from(@$from);
193 } elsif (ref $from eq 'HASH') {
194 return $self->_make_as($from);
196 return $from; # would love to quote here but _table ends up getting called
197 # twice during an ->select without a limit clause due to
198 # the way S::A::Limit->select works. should maybe consider
199 # bypassing this and doing S::A::select($self, ...) in
200 # our select method above. meantime, quoting shims have
201 # been added to select/insert/update/delete here
206 my ($self, $from, @join) = @_;
208 push(@sqlf, $self->_make_as($from));
209 foreach my $j (@join) {
212 # check whether a join type exists
213 my $join_clause = '';
214 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
215 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
216 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
218 $join_clause = ' JOIN ';
220 push(@sqlf, $join_clause);
222 if (ref $to eq 'ARRAY') {
223 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
225 push(@sqlf, $self->_make_as($to));
227 push(@sqlf, ' ON ', $self->_join_condition($on));
229 return join('', @sqlf);
233 my ($self, $from) = @_;
234 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
235 reverse each %{$self->_skip_options($from)});
239 my ($self, $hash) = @_;
241 $clean_hash->{$_} = $hash->{$_}
242 for grep {!/^-/} keys %$hash;
246 sub _join_condition {
247 my ($self, $cond) = @_;
248 if (ref $cond eq 'HASH') {
253 # XXX no throw_exception() in this package and croak() fails with strange results
254 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
255 if ref($v) ne 'SCALAR';
259 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
262 return scalar($self->_recurse_where(\%j));
263 } elsif (ref $cond eq 'ARRAY') {
264 return join(' OR ', map { $self->_join_condition($_) } @$cond);
266 die "Can't handle this yet!";
271 my ($self, $label) = @_;
272 return '' unless defined $label;
273 return "*" if $label eq '*';
274 return $label unless $self->{quote_char};
275 if(ref $self->{quote_char} eq "ARRAY"){
276 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
277 if !defined $self->{name_sep};
278 my $sep = $self->{name_sep};
279 return join($self->{name_sep},
280 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
281 split(/\Q$sep\E/,$label));
283 return $self->SUPER::_quote($label);
288 $self->{limit_dialect} = shift if @_;
289 return $self->{limit_dialect};
294 $self->{quote_char} = shift if @_;
295 return $self->{quote_char};
300 $self->{name_sep} = shift if @_;
301 return $self->{name_sep};
304 } # End of BEGIN block
308 DBIx::Class::Storage::DBI - DBI storage handler
312 my $schema = MySchema->connect('dbi:SQLite:my.db');
314 $schema->storage->debug(1);
315 $schema->dbh_do("DROP TABLE authors");
317 $schema->resultset('Book')->search({
318 written_on => $schema->storage->datetime_parser(DateTime->now)
323 This class represents the connection to an RDBMS via L<DBI>. See
324 L<DBIx::Class::Storage> for general information. This pod only
325 documents DBI-specific methods and behaviors.
332 my $new = shift->next::method(@_);
334 $new->transaction_depth(0);
335 $new->_sql_maker_opts({});
336 $new->{savepoints} = [];
337 $new->{_in_dbh_do} = 0;
338 $new->{_dbh_gen} = 0;
345 This method is normally called by L<DBIx::Class::Schema/connection>, which
346 encapsulates its argument list in an arrayref before passing them here.
348 The argument list may contain:
354 The same 4-element argument set one would normally pass to
355 L<DBI/connect>, optionally followed by
356 L<extra attributes|/DBIx::Class specific connection attributes>
357 recognized by DBIx::Class:
359 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
363 A single code reference which returns a connected
364 L<DBI database handle|DBI/connect> optionally followed by
365 L<extra attributes|/DBIx::Class specific connection attributes> recognized
368 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
372 A single hashref with all the attributes and the dsn/user/password
375 $connect_info_args = [{
383 This is particularly useful for L<Catalyst> based applications, allowing the
384 following config (L<Config::General> style):
389 dsn dbi:mysql:database=test
398 Please note that the L<DBI> docs recommend that you always explicitly
399 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
400 recommends that it be set to I<1>, and that you perform transactions
401 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
402 to I<1> if you do not do explicitly set it to zero. This is the default
403 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
405 =head3 DBIx::Class specific connection attributes
407 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
408 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
409 the following connection options. These options can be mixed in with your other
410 L<DBI> connection attributes, or placed in a seperate hashref
411 (C<\%extra_attributes>) as shown above.
413 Every time C<connect_info> is invoked, any previous settings for
414 these options will be cleared before setting the new ones, regardless of
415 whether any options are specified in the new C<connect_info>.
422 Specifies things to do immediately after connecting or re-connecting to
423 the database. Its value may contain:
427 =item an array reference
429 This contains SQL statements to execute in order. Each element contains
430 a string or a code reference that returns a string.
432 =item a code reference
434 This contains some code to execute. Unlike code references within an
435 array reference, its return value is ignored.
439 =item on_disconnect_do
441 Takes arguments in the same form as L</on_connect_do> and executes them
442 immediately before disconnecting from the database.
444 Note, this only runs if you explicitly call L</disconnect> on the
447 =item disable_sth_caching
449 If set to a true value, this option will disable the caching of
450 statement handles via L<DBI/prepare_cached>.
454 Sets the limit dialect. This is useful for JDBC-bridge among others
455 where the remote SQL-dialect cannot be determined by the name of the
456 driver alone. See also L<SQL::Abstract::Limit>.
460 Specifies what characters to use to quote table and column names. If
461 you use this you will want to specify L</name_sep> as well.
463 C<quote_char> expects either a single character, in which case is it
464 is placed on either side of the table/column name, or an arrayref of length
465 2 in which case the table/column name is placed between the elements.
467 For example under MySQL you should use C<< quote_char => '`' >>, and for
468 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
472 This only needs to be used in conjunction with C<quote_char>, and is used to
473 specify the charecter that seperates elements (schemas, tables, columns) from
474 each other. In most cases this is simply a C<.>.
476 The consequences of not supplying this value is that L<SQL::Abstract>
477 will assume DBIx::Class' uses of aliases to be complete column
478 names. The output will look like I<"me.name"> when it should actually
483 This Storage driver normally installs its own C<HandleError>, sets
484 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
485 all database handles, including those supplied by a coderef. It does this
486 so that it can have consistent and useful error behavior.
488 If you set this option to a true value, Storage will not do its usual
489 modifications to the database handle's attributes, and instead relies on
490 the settings in your connect_info DBI options (or the values you set in
491 your connection coderef, in the case that you are connecting via coderef).
493 Note that your custom settings can cause Storage to malfunction,
494 especially if you set a C<HandleError> handler that suppresses exceptions
495 and/or disable C<RaiseError>.
499 If this option is true, L<DBIx::Class> will use savepoints when nesting
500 transactions, making it possible to recover from failure in the inner
501 transaction without having to abort all outer transactions.
505 Use this argument to supply a cursor class other than the default
506 L<DBIx::Class::Storage::DBI::Cursor>.
510 Some real-life examples of arguments to L</connect_info> and
511 L<DBIx::Class::Schema/connect>
513 # Simple SQLite connection
514 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
517 ->connect_info([ sub { DBI->connect(...) } ]);
519 # A bit more complicated
526 { quote_char => q{"}, name_sep => q{.} },
530 # Equivalent to the previous example
536 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
540 # Same, but with hashref as argument
541 # See parse_connect_info for explanation
544 dsn => 'dbi:Pg:dbname=foo',
546 password => 'my_pg_password',
553 # Subref + DBIx::Class-specific connection options
556 sub { DBI->connect(...) },
560 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
561 disable_sth_caching => 1,
571 my ($self, $info_arg) = @_;
573 return $self->_connect_info if !$info_arg;
575 my @args = @$info_arg; # take a shallow copy for further mutilation
576 $self->_connect_info([@args]); # copy for _connect_info
579 # combine/pre-parse arguments depending on invocation style
582 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
583 %attrs = %{ $args[1] || {} };
586 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
587 %attrs = %{$args[0]};
589 for (qw/password user dsn/) {
590 unshift @args, delete $attrs{$_};
593 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
595 % { $args[3] || {} },
596 % { $args[4] || {} },
598 @args = @args[0,1,2];
601 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
602 # the new set of options
603 $self->_sql_maker(undef);
604 $self->_sql_maker_opts({});
607 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
608 if(my $value = delete $attrs{$storage_opt}) {
609 $self->$storage_opt($value);
612 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
613 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
614 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
619 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
621 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
622 $self->_connect_info;
627 This method is deprecated in favour of setting via L</connect_info>.
632 Arguments: ($subref | $method_name), @extra_coderef_args?
634 Execute the given $subref or $method_name using the new exception-based
635 connection management.
637 The first two arguments will be the storage object that C<dbh_do> was called
638 on and a database handle to use. Any additional arguments will be passed
639 verbatim to the called subref as arguments 2 and onwards.
641 Using this (instead of $self->_dbh or $self->dbh) ensures correct
642 exception handling and reconnection (or failover in future subclasses).
644 Your subref should have no side-effects outside of the database, as
645 there is the potential for your subref to be partially double-executed
646 if the database connection was stale/dysfunctional.
650 my @stuff = $schema->storage->dbh_do(
652 my ($storage, $dbh, @cols) = @_;
653 my $cols = join(q{, }, @cols);
654 $dbh->selectrow_array("SELECT $cols FROM foo");
665 my $dbh = $self->_dbh;
667 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
668 || $self->{transaction_depth};
670 local $self->{_in_dbh_do} = 1;
673 my $want_array = wantarray;
676 $self->_verify_pid if $dbh;
678 $self->_populate_dbh;
683 @result = $self->$code($dbh, @_);
685 elsif(defined $want_array) {
686 $result[0] = $self->$code($dbh, @_);
689 $self->$code($dbh, @_);
694 if(!$exception) { return $want_array ? @result : $result[0] }
696 $self->throw_exception($exception) if $self->connected;
698 # We were not connected - reconnect and retry, but let any
699 # exception fall right through this time
700 $self->_populate_dbh;
701 $self->$code($self->_dbh, @_);
704 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
705 # It also informs dbh_do to bypass itself while under the direction of txn_do,
706 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
711 ref $coderef eq 'CODE' or $self->throw_exception
712 ('$coderef must be a CODE reference');
714 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
716 local $self->{_in_dbh_do} = 1;
719 my $want_array = wantarray;
724 $self->_verify_pid if $self->_dbh;
725 $self->_populate_dbh if !$self->_dbh;
729 @result = $coderef->(@_);
731 elsif(defined $want_array) {
732 $result[0] = $coderef->(@_);
741 if(!$exception) { return $want_array ? @result : $result[0] }
743 if($tried++ > 0 || $self->connected) {
744 eval { $self->txn_rollback };
745 my $rollback_exception = $@;
746 if($rollback_exception) {
747 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
748 $self->throw_exception($exception) # propagate nested rollback
749 if $rollback_exception =~ /$exception_class/;
751 $self->throw_exception(
752 "Transaction aborted: ${exception}. "
753 . "Rollback failed: ${rollback_exception}"
756 $self->throw_exception($exception)
759 # We were not connected, and was first try - reconnect and retry
761 $self->_populate_dbh;
767 Our C<disconnect> method also performs a rollback first if the
768 database is not in C<AutoCommit> mode.
775 if( $self->connected ) {
776 my $connection_do = $self->on_disconnect_do;
777 $self->_do_connection_actions($connection_do) if ref($connection_do);
779 $self->_dbh->rollback unless $self->_dbh_autocommit;
780 $self->_dbh->disconnect;
786 =head2 with_deferred_fk_checks
790 =item Arguments: C<$coderef>
792 =item Return Value: The return value of $coderef
796 Storage specific method to run the code ref with FK checks deferred or
797 in MySQL's case disabled entirely.
801 # Storage subclasses should override this
802 sub with_deferred_fk_checks {
803 my ($self, $sub) = @_;
811 if(my $dbh = $self->_dbh) {
812 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
819 return 0 if !$self->_dbh;
821 return ($dbh->FETCH('Active') && $dbh->ping);
827 # handle pid changes correctly
828 # NOTE: assumes $self->_dbh is a valid $dbh
832 return if defined $self->_conn_pid && $self->_conn_pid == $$;
834 $self->_dbh->{InactiveDestroy} = 1;
841 sub ensure_connected {
844 unless ($self->connected) {
845 $self->_populate_dbh;
851 Returns the dbh - a data base handle of class L<DBI>.
858 $self->ensure_connected;
862 sub _sql_maker_args {
865 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
870 unless ($self->_sql_maker) {
871 my $sql_maker_class = $self->sql_maker_class;
872 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
874 return $self->_sql_maker;
881 my @info = @{$self->_dbi_connect_info || []};
882 $self->_dbh($self->_connect(@info));
884 # Always set the transaction depth on connect, since
885 # there is no transaction in progress by definition
886 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
888 if(ref $self eq 'DBIx::Class::Storage::DBI') {
889 my $driver = $self->_dbh->{Driver}->{Name};
890 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
891 bless $self, "DBIx::Class::Storage::DBI::${driver}";
896 my $connection_do = $self->on_connect_do;
897 $self->_do_connection_actions($connection_do) if ref($connection_do);
899 $self->_conn_pid($$);
900 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
903 sub _do_connection_actions {
905 my $connection_do = shift;
907 if (ref $connection_do eq 'ARRAY') {
908 $self->_do_query($_) foreach @$connection_do;
910 elsif (ref $connection_do eq 'CODE') {
918 my ($self, $action) = @_;
920 if (ref $action eq 'CODE') {
921 $action = $action->($self);
922 $self->_do_query($_) foreach @$action;
925 my @to_run = (ref $action eq 'ARRAY') ? (@$action) : ($action);
926 $self->_query_start(@to_run);
927 $self->_dbh->do(@to_run);
928 $self->_query_end(@to_run);
935 my ($self, @info) = @_;
937 $self->throw_exception("You failed to provide any connection info")
940 my ($old_connect_via, $dbh);
942 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
943 $old_connect_via = $DBI::connect_via;
944 $DBI::connect_via = 'connect';
948 if(ref $info[0] eq 'CODE') {
952 $dbh = DBI->connect(@info);
955 if($dbh && !$self->unsafe) {
956 my $weak_self = $self;
958 $dbh->{HandleError} = sub {
960 $weak_self->throw_exception("DBI Exception: $_[0]");
963 croak ("DBI Exception: $_[0]");
966 $dbh->{ShowErrorStatement} = 1;
967 $dbh->{RaiseError} = 1;
968 $dbh->{PrintError} = 0;
972 $DBI::connect_via = $old_connect_via if $old_connect_via;
974 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
977 $self->_dbh_autocommit($dbh->{AutoCommit});
983 my ($self, $name) = @_;
985 $name = $self->_svp_generate_name
986 unless defined $name;
988 $self->throw_exception ("You can't use savepoints outside a transaction")
989 if $self->{transaction_depth} == 0;
991 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
992 unless $self->can('_svp_begin');
994 push @{ $self->{savepoints} }, $name;
996 $self->debugobj->svp_begin($name) if $self->debug;
998 return $self->_svp_begin($name);
1002 my ($self, $name) = @_;
1004 $self->throw_exception ("You can't use savepoints outside a transaction")
1005 if $self->{transaction_depth} == 0;
1007 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1008 unless $self->can('_svp_release');
1010 if (defined $name) {
1011 $self->throw_exception ("Savepoint '$name' does not exist")
1012 unless grep { $_ eq $name } @{ $self->{savepoints} };
1014 # Dig through the stack until we find the one we are releasing. This keeps
1015 # the stack up to date.
1018 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1020 $name = pop @{ $self->{savepoints} };
1023 $self->debugobj->svp_release($name) if $self->debug;
1025 return $self->_svp_release($name);
1029 my ($self, $name) = @_;
1031 $self->throw_exception ("You can't use savepoints outside a transaction")
1032 if $self->{transaction_depth} == 0;
1034 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1035 unless $self->can('_svp_rollback');
1037 if (defined $name) {
1038 # If they passed us a name, verify that it exists in the stack
1039 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1040 $self->throw_exception("Savepoint '$name' does not exist!");
1043 # Dig through the stack until we find the one we are releasing. This keeps
1044 # the stack up to date.
1045 while(my $s = pop(@{ $self->{savepoints} })) {
1046 last if($s eq $name);
1048 # Add the savepoint back to the stack, as a rollback doesn't remove the
1049 # named savepoint, only everything after it.
1050 push(@{ $self->{savepoints} }, $name);
1052 # We'll assume they want to rollback to the last savepoint
1053 $name = $self->{savepoints}->[-1];
1056 $self->debugobj->svp_rollback($name) if $self->debug;
1058 return $self->_svp_rollback($name);
1061 sub _svp_generate_name {
1064 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1069 $self->ensure_connected();
1070 if($self->{transaction_depth} == 0) {
1071 $self->debugobj->txn_begin()
1073 # this isn't ->_dbh-> because
1074 # we should reconnect on begin_work
1075 # for AutoCommit users
1076 $self->dbh->begin_work;
1077 } elsif ($self->auto_savepoint) {
1080 $self->{transaction_depth}++;
1085 if ($self->{transaction_depth} == 1) {
1086 my $dbh = $self->_dbh;
1087 $self->debugobj->txn_commit()
1090 $self->{transaction_depth} = 0
1091 if $self->_dbh_autocommit;
1093 elsif($self->{transaction_depth} > 1) {
1094 $self->{transaction_depth}--;
1096 if $self->auto_savepoint;
1102 my $dbh = $self->_dbh;
1104 if ($self->{transaction_depth} == 1) {
1105 $self->debugobj->txn_rollback()
1107 $self->{transaction_depth} = 0
1108 if $self->_dbh_autocommit;
1111 elsif($self->{transaction_depth} > 1) {
1112 $self->{transaction_depth}--;
1113 if ($self->auto_savepoint) {
1114 $self->svp_rollback;
1119 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1124 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1125 $error =~ /$exception_class/ and $self->throw_exception($error);
1126 # ensure that a failed rollback resets the transaction depth
1127 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1128 $self->throw_exception($error);
1132 # This used to be the top-half of _execute. It was split out to make it
1133 # easier to override in NoBindVars without duping the rest. It takes up
1134 # all of _execute's args, and emits $sql, @bind.
1135 sub _prep_for_execute {
1136 my ($self, $op, $extra_bind, $ident, $args) = @_;
1138 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1140 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1143 return ($sql, \@bind);
1146 sub _fix_bind_params {
1147 my ($self, @bind) = @_;
1149 ### Turn @bind from something like this:
1150 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1152 ### ( "'1'", "'1'", "'3'" )
1155 if ( defined( $_ && $_->[1] ) ) {
1156 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1163 my ( $self, $sql, @bind ) = @_;
1165 if ( $self->debug ) {
1166 @bind = $self->_fix_bind_params(@bind);
1168 $self->debugobj->query_start( $sql, @bind );
1173 my ( $self, $sql, @bind ) = @_;
1175 if ( $self->debug ) {
1176 @bind = $self->_fix_bind_params(@bind);
1177 $self->debugobj->query_end( $sql, @bind );
1182 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1184 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1185 $ident = $ident->from();
1188 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1190 $self->_query_start( $sql, @$bind );
1192 my $sth = $self->sth($sql,$op);
1194 my $placeholder_index = 1;
1196 foreach my $bound (@$bind) {
1197 my $attributes = {};
1198 my($column_name, @data) = @$bound;
1200 if ($bind_attributes) {
1201 $attributes = $bind_attributes->{$column_name}
1202 if defined $bind_attributes->{$column_name};
1205 foreach my $data (@data) {
1206 my $ref = ref $data;
1207 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1209 $sth->bind_param($placeholder_index, $data, $attributes);
1210 $placeholder_index++;
1214 # Can this fail without throwing an exception anyways???
1215 my $rv = $sth->execute();
1216 $self->throw_exception($sth->errstr) if !$rv;
1218 $self->_query_end( $sql, @$bind );
1220 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1225 $self->dbh_do('_dbh_execute', @_)
1229 my ($self, $source, $to_insert) = @_;
1231 my $ident = $source->from;
1232 my $bind_attributes = $self->source_bind_attributes($source);
1234 $self->ensure_connected;
1235 foreach my $col ( $source->columns ) {
1236 if ( !defined $to_insert->{$col} ) {
1237 my $col_info = $source->column_info($col);
1239 if ( $col_info->{auto_nextval} ) {
1240 $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1245 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1250 ## Still not quite perfect, and EXPERIMENTAL
1251 ## Currently it is assumed that all values passed will be "normal", i.e. not
1252 ## scalar refs, or at least, all the same type as the first set, the statement is
1253 ## only prepped once.
1255 my ($self, $source, $cols, $data) = @_;
1257 my $table = $source->from;
1258 @colvalues{@$cols} = (0..$#$cols);
1259 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1261 $self->_query_start( $sql, @bind );
1262 my $sth = $self->sth($sql);
1264 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1266 ## This must be an arrayref, else nothing works!
1268 my $tuple_status = [];
1271 ##print STDERR Dumper( $data, $sql, [@bind] );
1275 ## Get the bind_attributes, if any exist
1276 my $bind_attributes = $self->source_bind_attributes($source);
1278 ## Bind the values and execute
1279 my $placeholder_index = 1;
1281 foreach my $bound (@bind) {
1283 my $attributes = {};
1284 my ($column_name, $data_index) = @$bound;
1286 if( $bind_attributes ) {
1287 $attributes = $bind_attributes->{$column_name}
1288 if defined $bind_attributes->{$column_name};
1291 my @data = map { $_->[$data_index] } @$data;
1293 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1294 $placeholder_index++;
1296 my $rv = $sth->execute_array({ArrayTupleStatus => $tuple_status});
1297 $self->throw_exception($sth->errstr) if !$rv;
1299 $self->_query_end( $sql, @bind );
1300 return (wantarray ? ($rv, $sth, @bind) : $rv);
1304 my $self = shift @_;
1305 my $source = shift @_;
1306 my $bind_attributes = $self->source_bind_attributes($source);
1308 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1313 my $self = shift @_;
1314 my $source = shift @_;
1316 my $bind_attrs = {}; ## If ever it's needed...
1318 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1322 my ($self, $ident, $select, $condition, $attrs) = @_;
1323 my $order = $attrs->{order_by};
1325 if (ref $condition eq 'SCALAR') {
1326 my $unwrap = ${$condition};
1327 if ($unwrap =~ s/ORDER BY (.*)$//i) {
1329 $condition = \$unwrap;
1333 my $for = delete $attrs->{for};
1334 my $sql_maker = $self->sql_maker;
1335 local $sql_maker->{for} = $for;
1337 if (exists $attrs->{group_by} || $attrs->{having}) {
1339 group_by => $attrs->{group_by},
1340 having => $attrs->{having},
1341 ($order ? (order_by => $order) : ())
1344 my $bind_attrs = {}; ## Future support
1345 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1346 if ($attrs->{software_limit} ||
1347 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1348 $attrs->{software_limit} = 1;
1350 $self->throw_exception("rows attribute must be positive if present")
1351 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1353 # MySQL actually recommends this approach. I cringe.
1354 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1355 push @args, $attrs->{rows}, $attrs->{offset};
1358 return $self->_execute(@args);
1361 sub source_bind_attributes {
1362 my ($self, $source) = @_;
1364 my $bind_attributes;
1365 foreach my $column ($source->columns) {
1367 my $data_type = $source->column_info($column)->{data_type} || '';
1368 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1372 return $bind_attributes;
1379 =item Arguments: $ident, $select, $condition, $attrs
1383 Handle a SQL select statement.
1389 my ($ident, $select, $condition, $attrs) = @_;
1390 return $self->cursor_class->new($self, \@_, $attrs);
1395 my ($rv, $sth, @bind) = $self->_select(@_);
1396 my @row = $sth->fetchrow_array;
1397 my @nextrow = $sth->fetchrow_array if @row;
1398 if(@row && @nextrow) {
1399 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1401 # Need to call finish() to work round broken DBDs
1410 =item Arguments: $sql
1414 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1419 my ($self, $dbh, $sql) = @_;
1421 # 3 is the if_active parameter which avoids active sth re-use
1422 my $sth = $self->disable_sth_caching
1423 ? $dbh->prepare($sql)
1424 : $dbh->prepare_cached($sql, {}, 3);
1426 # XXX You would think RaiseError would make this impossible,
1427 # but apparently that's not true :(
1428 $self->throw_exception($dbh->errstr) if !$sth;
1434 my ($self, $sql) = @_;
1435 $self->dbh_do('_dbh_sth', $sql);
1438 sub _dbh_columns_info_for {
1439 my ($self, $dbh, $table) = @_;
1441 if ($dbh->can('column_info')) {
1444 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1445 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1447 while ( my $info = $sth->fetchrow_hashref() ){
1449 $column_info{data_type} = $info->{TYPE_NAME};
1450 $column_info{size} = $info->{COLUMN_SIZE};
1451 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1452 $column_info{default_value} = $info->{COLUMN_DEF};
1453 my $col_name = $info->{COLUMN_NAME};
1454 $col_name =~ s/^\"(.*)\"$/$1/;
1456 $result{$col_name} = \%column_info;
1459 return \%result if !$@ && scalar keys %result;
1463 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1465 my @columns = @{$sth->{NAME_lc}};
1466 for my $i ( 0 .. $#columns ){
1468 $column_info{data_type} = $sth->{TYPE}->[$i];
1469 $column_info{size} = $sth->{PRECISION}->[$i];
1470 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1472 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1473 $column_info{data_type} = $1;
1474 $column_info{size} = $2;
1477 $result{$columns[$i]} = \%column_info;
1481 foreach my $col (keys %result) {
1482 my $colinfo = $result{$col};
1483 my $type_num = $colinfo->{data_type};
1485 if(defined $type_num && $dbh->can('type_info')) {
1486 my $type_info = $dbh->type_info($type_num);
1487 $type_name = $type_info->{TYPE_NAME} if $type_info;
1488 $colinfo->{data_type} = $type_name if $type_name;
1495 sub columns_info_for {
1496 my ($self, $table) = @_;
1497 $self->dbh_do('_dbh_columns_info_for', $table);
1500 =head2 last_insert_id
1502 Return the row id of the last insert.
1506 sub _dbh_last_insert_id {
1507 my ($self, $dbh, $source, $col) = @_;
1508 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1509 $dbh->func('last_insert_rowid');
1512 sub last_insert_id {
1514 $self->dbh_do('_dbh_last_insert_id', @_);
1519 Returns the database driver name.
1523 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1525 =head2 bind_attribute_by_data_type
1527 Given a datatype from column info, returns a database specific bind
1528 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1529 let the database planner just handle it.
1531 Generally only needed for special case column types, like bytea in postgres.
1535 sub bind_attribute_by_data_type {
1539 =head2 create_ddl_dir
1543 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1547 Creates a SQL file based on the Schema, for each of the specified
1548 database types, in the given directory.
1550 By default, C<\%sqlt_args> will have
1552 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1554 merged with the hash passed in. To disable any of those features, pass in a
1555 hashref like the following
1557 { ignore_constraint_names => 0, # ... other options }
1561 sub create_ddl_dir {
1562 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1564 if(!$dir || !-d $dir) {
1565 warn "No directory given, using ./\n";
1568 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1569 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1571 my $schema_version = $schema->schema_version || '1.x';
1572 $version ||= $schema_version;
1575 add_drop_table => 1,
1576 ignore_constraint_names => 1,
1577 ignore_index_names => 1,
1581 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09: '}
1582 . $self->_check_sqlt_message . q{'})
1583 if !$self->_check_sqlt_version;
1585 my $sqlt = SQL::Translator->new( $sqltargs );
1587 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1588 my $sqlt_schema = $sqlt->translate({ data => $schema }) or die $sqlt->error;
1590 foreach my $db (@$databases) {
1592 $sqlt = $self->configure_sqlt($sqlt, $db);
1593 $sqlt->{schema} = $sqlt_schema;
1594 $sqlt->producer($db);
1597 my $filename = $schema->ddl_filename($db, $version, $dir);
1598 if (-e $filename && ($version eq $schema_version )) {
1599 # if we are dumping the current version, overwrite the DDL
1600 warn "Overwriting existing DDL file - $filename";
1604 my $output = $sqlt->translate;
1606 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1609 if(!open($file, ">$filename")) {
1610 $self->throw_exception("Can't open $filename for writing ($!)");
1613 print $file $output;
1616 next unless ($preversion);
1618 require SQL::Translator::Diff;
1620 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1621 if(!-e $prefilename) {
1622 warn("No previous schema file found ($prefilename)");
1626 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1628 warn("Overwriting existing diff file - $difffile");
1634 my $t = SQL::Translator->new($sqltargs);
1637 $t->parser( $db ) or die $t->error;
1638 $t = $self->configure_sqlt($t, $db);
1639 my $out = $t->translate( $prefilename ) or die $t->error;
1640 $source_schema = $t->schema;
1641 unless ( $source_schema->name ) {
1642 $source_schema->name( $prefilename );
1646 # The "new" style of producers have sane normalization and can support
1647 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1648 # And we have to diff parsed SQL against parsed SQL.
1649 my $dest_schema = $sqlt_schema;
1651 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1652 my $t = SQL::Translator->new($sqltargs);
1655 $t->parser( $db ) or die $t->error;
1656 $t = $self->configure_sqlt($t, $db);
1657 my $out = $t->translate( $filename ) or die $t->error;
1658 $dest_schema = $t->schema;
1659 $dest_schema->name( $filename )
1660 unless $dest_schema->name;
1663 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1667 if(!open $file, ">$difffile") {
1668 $self->throw_exception("Can't write to $difffile ($!)");
1676 sub configure_sqlt() {
1679 my $db = shift || $self->sqlt_type;
1680 if ($db eq 'PostgreSQL') {
1681 $tr->quote_table_names(0);
1682 $tr->quote_field_names(0);
1687 =head2 deployment_statements
1691 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1695 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1696 The database driver name is given by C<$type>, though the value from
1697 L</sqlt_type> is used if it is not specified.
1699 C<$directory> is used to return statements from files in a previously created
1700 L</create_ddl_dir> directory and is optional. The filenames are constructed
1701 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1703 If no C<$directory> is specified then the statements are constructed on the
1704 fly using L<SQL::Translator> and C<$version> is ignored.
1706 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1710 sub deployment_statements {
1711 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1712 # Need to be connected to get the correct sqlt_type
1713 $self->ensure_connected() unless $type;
1714 $type ||= $self->sqlt_type;
1715 $version ||= $schema->schema_version || '1.x';
1717 my $filename = $schema->ddl_filename($type, $dir, $version);
1721 open($file, "<$filename")
1722 or $self->throw_exception("Can't open $filename ($!)");
1725 return join('', @rows);
1728 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09: '}
1729 . $self->_check_sqlt_message . q{'})
1730 if !$self->_check_sqlt_version;
1732 require SQL::Translator::Parser::DBIx::Class;
1733 eval qq{use SQL::Translator::Producer::${type}};
1734 $self->throw_exception($@) if $@;
1736 # sources needs to be a parser arg, but for simplicty allow at top level
1738 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1739 if exists $sqltargs->{sources};
1741 my $tr = SQL::Translator->new(%$sqltargs);
1742 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1743 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1747 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1748 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1749 foreach my $line ( split(";\n", $statement)) {
1750 next if($line =~ /^--/);
1752 # next if($line =~ /^DROP/m);
1753 next if($line =~ /^BEGIN TRANSACTION/m);
1754 next if($line =~ /^COMMIT/m);
1755 next if $line =~ /^\s+$/; # skip whitespace only
1756 $self->_query_start($line);
1758 $self->dbh->do($line); # shouldn't be using ->dbh ?
1761 warn qq{$@ (running "${line}")};
1763 $self->_query_end($line);
1768 =head2 datetime_parser
1770 Returns the datetime parser class
1774 sub datetime_parser {
1776 return $self->{datetime_parser} ||= do {
1777 $self->ensure_connected;
1778 $self->build_datetime_parser(@_);
1782 =head2 datetime_parser_type
1784 Defines (returns) the datetime parser class - currently hardwired to
1785 L<DateTime::Format::MySQL>
1789 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1791 =head2 build_datetime_parser
1793 See L</datetime_parser>
1797 sub build_datetime_parser {
1799 my $type = $self->datetime_parser_type(@_);
1801 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1806 my $_check_sqlt_version; # private
1807 my $_check_sqlt_message; # private
1808 sub _check_sqlt_version {
1809 return $_check_sqlt_version if defined $_check_sqlt_version;
1810 eval 'use SQL::Translator "0.09"';
1811 $_check_sqlt_message = $@ || '';
1812 $_check_sqlt_version = !$@;
1815 sub _check_sqlt_message {
1816 _check_sqlt_version if !defined $_check_sqlt_message;
1817 $_check_sqlt_message;
1821 =head2 is_replicating
1823 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
1824 replicate from a master database. Default is undef, which is the result
1825 returned by databases that don't support replication.
1829 sub is_replicating {
1834 =head2 lag_behind_master
1836 Returns a number that represents a certain amount of lag behind a master db
1837 when a given storage is replicating. The number is database dependent, but
1838 starts at zero and increases with the amount of lag. Default in undef
1842 sub lag_behind_master {
1848 return if !$self->_dbh;
1857 =head2 DBIx::Class and AutoCommit
1859 DBIx::Class can do some wonderful magic with handling exceptions,
1860 disconnections, and transactions when you use C<< AutoCommit => 1 >>
1861 combined with C<txn_do> for transaction support.
1863 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
1864 in an assumed transaction between commits, and you're telling us you'd
1865 like to manage that manually. A lot of the magic protections offered by
1866 this module will go away. We can't protect you from exceptions due to database
1867 disconnects because we don't know anything about how to restart your
1868 transactions. You're on your own for handling all sorts of exceptional
1869 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
1875 The module defines a set of methods within the DBIC::SQL::Abstract
1876 namespace. These build on L<SQL::Abstract::Limit> to provide the
1877 SQL query functions.
1879 The following methods are extended:-
1893 See L</connect_info> for details.
1897 See L</connect_info> for details.
1901 See L</connect_info> for details.
1907 Matt S. Trout <mst@shadowcatsystems.co.uk>
1909 Andy Grundman <andy@hybridized.org>
1913 You may distribute this code under the same terms as Perl itself.