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};
54 my ($self, $sql, $order, $rows, $offset ) = @_;
57 my $last = $rows + $offset;
58 my ( $order_by ) = $self->_order_by( $order );
63 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
68 WHERE ROW_NUM BETWEEN $offset AND $last
74 # While we're at it, this should make LIMIT queries more efficient,
75 # without digging into things too deeply
76 use Scalar::Util 'blessed';
78 my ($self, $syntax) = @_;
79 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
80 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
81 return 'RowNumberOver';
84 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
88 my ($self, $table, $fields, $where, $order, @rest) = @_;
89 $table = $self->_quote($table) unless ref($table);
90 local $self->{rownum_hack_count} = 1
91 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
92 @rest = (-1) unless defined $rest[0];
93 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
94 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
95 local $self->{having_bind} = [];
96 my ($sql, @ret) = $self->SUPER::select(
97 $table, $self->_recurse_fields($fields), $where, $order, @rest
102 $self->{for} eq 'update' ? ' FOR UPDATE' :
103 $self->{for} eq 'shared' ? ' FOR SHARE' :
108 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
114 $table = $self->_quote($table) unless ref($table);
115 $self->SUPER::insert($table, @_);
121 $table = $self->_quote($table) unless ref($table);
122 $self->SUPER::update($table, @_);
128 $table = $self->_quote($table) unless ref($table);
129 $self->SUPER::delete($table, @_);
135 return $_[1].$self->_order_by($_[2]);
137 return $self->SUPER::_emulate_limit(@_);
141 sub _recurse_fields {
142 my ($self, $fields, $params) = @_;
143 my $ref = ref $fields;
144 return $self->_quote($fields) unless $ref;
145 return $$fields if $ref eq 'SCALAR';
147 if ($ref eq 'ARRAY') {
148 return join(', ', map {
149 $self->_recurse_fields($_)
150 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
151 ? ' AS col'.$self->{rownum_hack_count}++
154 } elsif ($ref eq 'HASH') {
155 foreach my $func (keys %$fields) {
156 return $self->_sqlcase($func)
157 .'( '.$self->_recurse_fields($fields->{$func}).' )';
166 if (ref $_[0] eq 'HASH') {
167 if (defined $_[0]->{group_by}) {
168 $ret = $self->_sqlcase(' group by ')
169 .$self->_recurse_fields($_[0]->{group_by}, { no_rownum_hack => 1 });
171 if (defined $_[0]->{having}) {
173 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
174 push(@{$self->{having_bind}}, @extra);
175 $ret .= $self->_sqlcase(' having ').$frag;
177 if (defined $_[0]->{order_by}) {
178 $ret .= $self->_order_by($_[0]->{order_by});
180 } elsif (ref $_[0] eq 'SCALAR') {
181 $ret = $self->_sqlcase(' order by ').${ $_[0] };
182 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
183 my @order = @{+shift};
184 $ret = $self->_sqlcase(' order by ')
186 my $r = $self->_order_by($_, @_);
187 $r =~ s/^ ?ORDER BY //i;
191 $ret = $self->SUPER::_order_by(@_);
196 sub _order_directions {
197 my ($self, $order) = @_;
198 $order = $order->{order_by} if ref $order eq 'HASH';
199 return $self->SUPER::_order_directions($order);
203 my ($self, $from) = @_;
204 if (ref $from eq 'ARRAY') {
205 return $self->_recurse_from(@$from);
206 } elsif (ref $from eq 'HASH') {
207 return $self->_make_as($from);
209 return $from; # would love to quote here but _table ends up getting called
210 # twice during an ->select without a limit clause due to
211 # the way S::A::Limit->select works. should maybe consider
212 # bypassing this and doing S::A::select($self, ...) in
213 # our select method above. meantime, quoting shims have
214 # been added to select/insert/update/delete here
219 my ($self, $from, @join) = @_;
221 push(@sqlf, $self->_make_as($from));
222 foreach my $j (@join) {
225 # check whether a join type exists
226 my $join_clause = '';
227 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
228 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
229 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
231 $join_clause = ' JOIN ';
233 push(@sqlf, $join_clause);
235 if (ref $to eq 'ARRAY') {
236 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
238 push(@sqlf, $self->_make_as($to));
240 push(@sqlf, ' ON (', $self->_join_condition($on), ')');
242 return join('', @sqlf);
246 my ($self, $from) = @_;
247 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
248 reverse each %{$self->_skip_options($from)});
252 my ($self, $hash) = @_;
254 $clean_hash->{$_} = $hash->{$_}
255 for grep {!/^-/} keys %$hash;
259 sub _join_condition {
260 my ($self, $cond) = @_;
261 if (ref $cond eq 'HASH') {
266 # XXX no throw_exception() in this package and croak() fails with strange results
267 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
268 if ref($v) ne 'SCALAR';
272 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
275 return scalar($self->_recurse_where(\%j));
276 } elsif (ref $cond eq 'ARRAY') {
277 return join(' OR ', map { $self->_join_condition($_) } @$cond);
279 die "Can't handle this yet!";
284 my ($self, $label) = @_;
285 return '' unless defined $label;
286 return "*" if $label eq '*';
287 return $label unless $self->{quote_char};
288 if(ref $self->{quote_char} eq "ARRAY"){
289 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
290 if !defined $self->{name_sep};
291 my $sep = $self->{name_sep};
292 return join($self->{name_sep},
293 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
294 split(/\Q$sep\E/,$label));
296 return $self->SUPER::_quote($label);
301 $self->{limit_dialect} = shift if @_;
302 return $self->{limit_dialect};
307 $self->{quote_char} = shift if @_;
308 return $self->{quote_char};
313 $self->{name_sep} = shift if @_;
314 return $self->{name_sep};
317 } # End of BEGIN block
321 DBIx::Class::Storage::DBI - DBI storage handler
325 my $schema = MySchema->connect('dbi:SQLite:my.db');
327 $schema->storage->debug(1);
328 $schema->dbh_do("DROP TABLE authors");
330 $schema->resultset('Book')->search({
331 written_on => $schema->storage->datetime_parser(DateTime->now)
336 This class represents the connection to an RDBMS via L<DBI>. See
337 L<DBIx::Class::Storage> for general information. This pod only
338 documents DBI-specific methods and behaviors.
345 my $new = shift->next::method(@_);
347 $new->transaction_depth(0);
348 $new->_sql_maker_opts({});
349 $new->{savepoints} = [];
350 $new->{_in_dbh_do} = 0;
351 $new->{_dbh_gen} = 0;
358 This method is normally called by L<DBIx::Class::Schema/connection>, which
359 encapsulates its argument list in an arrayref before passing them here.
361 The argument list may contain:
367 The same 4-element argument set one would normally pass to
368 L<DBI/connect>, optionally followed by
369 L<extra attributes|/DBIx::Class specific connection attributes>
370 recognized by DBIx::Class:
372 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
376 A single code reference which returns a connected
377 L<DBI database handle|DBI/connect> optionally followed by
378 L<extra attributes|/DBIx::Class specific connection attributes> recognized
381 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
385 A single hashref with all the attributes and the dsn/user/password
388 $connect_info_args = [{
396 This is particularly useful for L<Catalyst> based applications, allowing the
397 following config (L<Config::General> style):
402 dsn dbi:mysql:database=test
411 Please note that the L<DBI> docs recommend that you always explicitly
412 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
413 recommends that it be set to I<1>, and that you perform transactions
414 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
415 to I<1> if you do not do explicitly set it to zero. This is the default
416 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
418 =head3 DBIx::Class specific connection attributes
420 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
421 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
422 the following connection options. These options can be mixed in with your other
423 L<DBI> connection attributes, or placed in a seperate hashref
424 (C<\%extra_attributes>) as shown above.
426 Every time C<connect_info> is invoked, any previous settings for
427 these options will be cleared before setting the new ones, regardless of
428 whether any options are specified in the new C<connect_info>.
435 Specifies things to do immediately after connecting or re-connecting to
436 the database. Its value may contain:
440 =item an array reference
442 This contains SQL statements to execute in order. Each element contains
443 a string or a code reference that returns a string.
445 =item a code reference
447 This contains some code to execute. Unlike code references within an
448 array reference, its return value is ignored.
452 =item on_disconnect_do
454 Takes arguments in the same form as L</on_connect_do> and executes them
455 immediately before disconnecting from the database.
457 Note, this only runs if you explicitly call L</disconnect> on the
460 =item disable_sth_caching
462 If set to a true value, this option will disable the caching of
463 statement handles via L<DBI/prepare_cached>.
467 Sets the limit dialect. This is useful for JDBC-bridge among others
468 where the remote SQL-dialect cannot be determined by the name of the
469 driver alone. See also L<SQL::Abstract::Limit>.
473 Specifies what characters to use to quote table and column names. If
474 you use this you will want to specify L</name_sep> as well.
476 C<quote_char> expects either a single character, in which case is it
477 is placed on either side of the table/column name, or an arrayref of length
478 2 in which case the table/column name is placed between the elements.
480 For example under MySQL you should use C<< quote_char => '`' >>, and for
481 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
485 This only needs to be used in conjunction with C<quote_char>, and is used to
486 specify the charecter that seperates elements (schemas, tables, columns) from
487 each other. In most cases this is simply a C<.>.
489 The consequences of not supplying this value is that L<SQL::Abstract>
490 will assume DBIx::Class' uses of aliases to be complete column
491 names. The output will look like I<"me.name"> when it should actually
496 This Storage driver normally installs its own C<HandleError>, sets
497 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
498 all database handles, including those supplied by a coderef. It does this
499 so that it can have consistent and useful error behavior.
501 If you set this option to a true value, Storage will not do its usual
502 modifications to the database handle's attributes, and instead relies on
503 the settings in your connect_info DBI options (or the values you set in
504 your connection coderef, in the case that you are connecting via coderef).
506 Note that your custom settings can cause Storage to malfunction,
507 especially if you set a C<HandleError> handler that suppresses exceptions
508 and/or disable C<RaiseError>.
512 If this option is true, L<DBIx::Class> will use savepoints when nesting
513 transactions, making it possible to recover from failure in the inner
514 transaction without having to abort all outer transactions.
518 Use this argument to supply a cursor class other than the default
519 L<DBIx::Class::Storage::DBI::Cursor>.
523 Some real-life examples of arguments to L</connect_info> and
524 L<DBIx::Class::Schema/connect>
526 # Simple SQLite connection
527 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
530 ->connect_info([ sub { DBI->connect(...) } ]);
532 # A bit more complicated
539 { quote_char => q{"}, name_sep => q{.} },
543 # Equivalent to the previous example
549 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
553 # Same, but with hashref as argument
554 # See parse_connect_info for explanation
557 dsn => 'dbi:Pg:dbname=foo',
559 password => 'my_pg_password',
566 # Subref + DBIx::Class-specific connection options
569 sub { DBI->connect(...) },
573 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
574 disable_sth_caching => 1,
584 my ($self, $info_arg) = @_;
586 return $self->_connect_info if !$info_arg;
588 my @args = @$info_arg; # take a shallow copy for further mutilation
589 $self->_connect_info([@args]); # copy for _connect_info
592 # combine/pre-parse arguments depending on invocation style
595 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
596 %attrs = %{ $args[1] || {} };
599 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
600 %attrs = %{$args[0]};
602 for (qw/password user dsn/) {
603 unshift @args, delete $attrs{$_};
606 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
608 % { $args[3] || {} },
609 % { $args[4] || {} },
611 @args = @args[0,1,2];
614 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
615 # the new set of options
616 $self->_sql_maker(undef);
617 $self->_sql_maker_opts({});
620 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
621 if(my $value = delete $attrs{$storage_opt}) {
622 $self->$storage_opt($value);
625 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
626 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
627 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
632 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
634 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
635 $self->_connect_info;
640 This method is deprecated in favour of setting via L</connect_info>.
645 Arguments: ($subref | $method_name), @extra_coderef_args?
647 Execute the given $subref or $method_name using the new exception-based
648 connection management.
650 The first two arguments will be the storage object that C<dbh_do> was called
651 on and a database handle to use. Any additional arguments will be passed
652 verbatim to the called subref as arguments 2 and onwards.
654 Using this (instead of $self->_dbh or $self->dbh) ensures correct
655 exception handling and reconnection (or failover in future subclasses).
657 Your subref should have no side-effects outside of the database, as
658 there is the potential for your subref to be partially double-executed
659 if the database connection was stale/dysfunctional.
663 my @stuff = $schema->storage->dbh_do(
665 my ($storage, $dbh, @cols) = @_;
666 my $cols = join(q{, }, @cols);
667 $dbh->selectrow_array("SELECT $cols FROM foo");
678 my $dbh = $self->_dbh;
680 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
681 || $self->{transaction_depth};
683 local $self->{_in_dbh_do} = 1;
686 my $want_array = wantarray;
689 $self->_verify_pid if $dbh;
691 $self->_populate_dbh;
696 @result = $self->$code($dbh, @_);
698 elsif(defined $want_array) {
699 $result[0] = $self->$code($dbh, @_);
702 $self->$code($dbh, @_);
707 if(!$exception) { return $want_array ? @result : $result[0] }
709 $self->throw_exception($exception) if $self->connected;
711 # We were not connected - reconnect and retry, but let any
712 # exception fall right through this time
713 $self->_populate_dbh;
714 $self->$code($self->_dbh, @_);
717 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
718 # It also informs dbh_do to bypass itself while under the direction of txn_do,
719 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
724 ref $coderef eq 'CODE' or $self->throw_exception
725 ('$coderef must be a CODE reference');
727 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
729 local $self->{_in_dbh_do} = 1;
732 my $want_array = wantarray;
737 $self->_verify_pid if $self->_dbh;
738 $self->_populate_dbh if !$self->_dbh;
742 @result = $coderef->(@_);
744 elsif(defined $want_array) {
745 $result[0] = $coderef->(@_);
754 if(!$exception) { return $want_array ? @result : $result[0] }
756 if($tried++ > 0 || $self->connected) {
757 eval { $self->txn_rollback };
758 my $rollback_exception = $@;
759 if($rollback_exception) {
760 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
761 $self->throw_exception($exception) # propagate nested rollback
762 if $rollback_exception =~ /$exception_class/;
764 $self->throw_exception(
765 "Transaction aborted: ${exception}. "
766 . "Rollback failed: ${rollback_exception}"
769 $self->throw_exception($exception)
772 # We were not connected, and was first try - reconnect and retry
774 $self->_populate_dbh;
780 Our C<disconnect> method also performs a rollback first if the
781 database is not in C<AutoCommit> mode.
788 if( $self->connected ) {
789 my $connection_do = $self->on_disconnect_do;
790 $self->_do_connection_actions($connection_do) if ref($connection_do);
792 $self->_dbh->rollback unless $self->_dbh_autocommit;
793 $self->_dbh->disconnect;
799 =head2 with_deferred_fk_checks
803 =item Arguments: C<$coderef>
805 =item Return Value: The return value of $coderef
809 Storage specific method to run the code ref with FK checks deferred or
810 in MySQL's case disabled entirely.
814 # Storage subclasses should override this
815 sub with_deferred_fk_checks {
816 my ($self, $sub) = @_;
824 if(my $dbh = $self->_dbh) {
825 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
832 return 0 if !$self->_dbh;
834 return ($dbh->FETCH('Active') && $dbh->ping);
840 # handle pid changes correctly
841 # NOTE: assumes $self->_dbh is a valid $dbh
845 return if defined $self->_conn_pid && $self->_conn_pid == $$;
847 $self->_dbh->{InactiveDestroy} = 1;
854 sub ensure_connected {
857 unless ($self->connected) {
858 $self->_populate_dbh;
864 Returns the dbh - a data base handle of class L<DBI>.
871 $self->ensure_connected;
875 sub _sql_maker_args {
878 return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
883 unless ($self->_sql_maker) {
884 my $sql_maker_class = $self->sql_maker_class;
885 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
887 return $self->_sql_maker;
894 my @info = @{$self->_dbi_connect_info || []};
895 $self->_dbh($self->_connect(@info));
897 # Always set the transaction depth on connect, since
898 # there is no transaction in progress by definition
899 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
901 if(ref $self eq 'DBIx::Class::Storage::DBI') {
902 my $driver = $self->_dbh->{Driver}->{Name};
903 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
904 bless $self, "DBIx::Class::Storage::DBI::${driver}";
909 my $connection_do = $self->on_connect_do;
910 $self->_do_connection_actions($connection_do) if ref($connection_do);
912 $self->_conn_pid($$);
913 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
916 sub _do_connection_actions {
918 my $connection_do = shift;
920 if (ref $connection_do eq 'ARRAY') {
921 $self->_do_query($_) foreach @$connection_do;
923 elsif (ref $connection_do eq 'CODE') {
931 my ($self, $action) = @_;
933 if (ref $action eq 'CODE') {
934 $action = $action->($self);
935 $self->_do_query($_) foreach @$action;
938 my @to_run = (ref $action eq 'ARRAY') ? (@$action) : ($action);
939 $self->_query_start(@to_run);
940 $self->_dbh->do(@to_run);
941 $self->_query_end(@to_run);
948 my ($self, @info) = @_;
950 $self->throw_exception("You failed to provide any connection info")
953 my ($old_connect_via, $dbh);
955 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
956 $old_connect_via = $DBI::connect_via;
957 $DBI::connect_via = 'connect';
961 if(ref $info[0] eq 'CODE') {
965 $dbh = DBI->connect(@info);
968 if($dbh && !$self->unsafe) {
969 my $weak_self = $self;
971 $dbh->{HandleError} = sub {
973 $weak_self->throw_exception("DBI Exception: $_[0]");
976 croak ("DBI Exception: $_[0]");
979 $dbh->{ShowErrorStatement} = 1;
980 $dbh->{RaiseError} = 1;
981 $dbh->{PrintError} = 0;
985 $DBI::connect_via = $old_connect_via if $old_connect_via;
987 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
990 $self->_dbh_autocommit($dbh->{AutoCommit});
996 my ($self, $name) = @_;
998 $name = $self->_svp_generate_name
999 unless defined $name;
1001 $self->throw_exception ("You can't use savepoints outside a transaction")
1002 if $self->{transaction_depth} == 0;
1004 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1005 unless $self->can('_svp_begin');
1007 push @{ $self->{savepoints} }, $name;
1009 $self->debugobj->svp_begin($name) if $self->debug;
1011 return $self->_svp_begin($name);
1015 my ($self, $name) = @_;
1017 $self->throw_exception ("You can't use savepoints outside a transaction")
1018 if $self->{transaction_depth} == 0;
1020 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1021 unless $self->can('_svp_release');
1023 if (defined $name) {
1024 $self->throw_exception ("Savepoint '$name' does not exist")
1025 unless grep { $_ eq $name } @{ $self->{savepoints} };
1027 # Dig through the stack until we find the one we are releasing. This keeps
1028 # the stack up to date.
1031 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1033 $name = pop @{ $self->{savepoints} };
1036 $self->debugobj->svp_release($name) if $self->debug;
1038 return $self->_svp_release($name);
1042 my ($self, $name) = @_;
1044 $self->throw_exception ("You can't use savepoints outside a transaction")
1045 if $self->{transaction_depth} == 0;
1047 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1048 unless $self->can('_svp_rollback');
1050 if (defined $name) {
1051 # If they passed us a name, verify that it exists in the stack
1052 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1053 $self->throw_exception("Savepoint '$name' does not exist!");
1056 # Dig through the stack until we find the one we are releasing. This keeps
1057 # the stack up to date.
1058 while(my $s = pop(@{ $self->{savepoints} })) {
1059 last if($s eq $name);
1061 # Add the savepoint back to the stack, as a rollback doesn't remove the
1062 # named savepoint, only everything after it.
1063 push(@{ $self->{savepoints} }, $name);
1065 # We'll assume they want to rollback to the last savepoint
1066 $name = $self->{savepoints}->[-1];
1069 $self->debugobj->svp_rollback($name) if $self->debug;
1071 return $self->_svp_rollback($name);
1074 sub _svp_generate_name {
1077 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1082 $self->ensure_connected();
1083 if($self->{transaction_depth} == 0) {
1084 $self->debugobj->txn_begin()
1086 # this isn't ->_dbh-> because
1087 # we should reconnect on begin_work
1088 # for AutoCommit users
1089 $self->dbh->begin_work;
1090 } elsif ($self->auto_savepoint) {
1093 $self->{transaction_depth}++;
1098 if ($self->{transaction_depth} == 1) {
1099 my $dbh = $self->_dbh;
1100 $self->debugobj->txn_commit()
1103 $self->{transaction_depth} = 0
1104 if $self->_dbh_autocommit;
1106 elsif($self->{transaction_depth} > 1) {
1107 $self->{transaction_depth}--;
1109 if $self->auto_savepoint;
1115 my $dbh = $self->_dbh;
1117 if ($self->{transaction_depth} == 1) {
1118 $self->debugobj->txn_rollback()
1120 $self->{transaction_depth} = 0
1121 if $self->_dbh_autocommit;
1124 elsif($self->{transaction_depth} > 1) {
1125 $self->{transaction_depth}--;
1126 if ($self->auto_savepoint) {
1127 $self->svp_rollback;
1132 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1137 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1138 $error =~ /$exception_class/ and $self->throw_exception($error);
1139 # ensure that a failed rollback resets the transaction depth
1140 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1141 $self->throw_exception($error);
1145 # This used to be the top-half of _execute. It was split out to make it
1146 # easier to override in NoBindVars without duping the rest. It takes up
1147 # all of _execute's args, and emits $sql, @bind.
1148 sub _prep_for_execute {
1149 my ($self, $op, $extra_bind, $ident, $args) = @_;
1151 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1153 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1156 return ($sql, \@bind);
1159 sub _fix_bind_params {
1160 my ($self, @bind) = @_;
1162 ### Turn @bind from something like this:
1163 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1165 ### ( "'1'", "'1'", "'3'" )
1168 if ( defined( $_ && $_->[1] ) ) {
1169 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1176 my ( $self, $sql, @bind ) = @_;
1178 if ( $self->debug ) {
1179 @bind = $self->_fix_bind_params(@bind);
1181 $self->debugobj->query_start( $sql, @bind );
1186 my ( $self, $sql, @bind ) = @_;
1188 if ( $self->debug ) {
1189 @bind = $self->_fix_bind_params(@bind);
1190 $self->debugobj->query_end( $sql, @bind );
1195 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1197 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1198 $ident = $ident->from();
1201 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1203 $self->_query_start( $sql, @$bind );
1205 my $sth = $self->sth($sql,$op);
1207 my $placeholder_index = 1;
1209 foreach my $bound (@$bind) {
1210 my $attributes = {};
1211 my($column_name, @data) = @$bound;
1213 if ($bind_attributes) {
1214 $attributes = $bind_attributes->{$column_name}
1215 if defined $bind_attributes->{$column_name};
1218 foreach my $data (@data) {
1219 $data = ref $data ? ''.$data : $data; # stringify args
1221 $sth->bind_param($placeholder_index, $data, $attributes);
1222 $placeholder_index++;
1226 # Can this fail without throwing an exception anyways???
1227 my $rv = $sth->execute();
1228 $self->throw_exception($sth->errstr) if !$rv;
1230 $self->_query_end( $sql, @$bind );
1232 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1237 $self->dbh_do('_dbh_execute', @_)
1241 my ($self, $source, $to_insert) = @_;
1243 my $ident = $source->from;
1244 my $bind_attributes = $self->source_bind_attributes($source);
1246 $self->ensure_connected;
1247 foreach my $col ( $source->columns ) {
1248 if ( !defined $to_insert->{$col} ) {
1249 my $col_info = $source->column_info($col);
1251 if ( $col_info->{auto_nextval} ) {
1252 $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1257 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1262 ## Still not quite perfect, and EXPERIMENTAL
1263 ## Currently it is assumed that all values passed will be "normal", i.e. not
1264 ## scalar refs, or at least, all the same type as the first set, the statement is
1265 ## only prepped once.
1267 my ($self, $source, $cols, $data) = @_;
1269 my $table = $source->from;
1270 @colvalues{@$cols} = (0..$#$cols);
1271 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1273 $self->_query_start( $sql, @bind );
1274 my $sth = $self->sth($sql);
1276 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1278 ## This must be an arrayref, else nothing works!
1280 my $tuple_status = [];
1283 ##print STDERR Dumper( $data, $sql, [@bind] );
1287 ## Get the bind_attributes, if any exist
1288 my $bind_attributes = $self->source_bind_attributes($source);
1290 ## Bind the values and execute
1291 my $placeholder_index = 1;
1293 foreach my $bound (@bind) {
1295 my $attributes = {};
1296 my ($column_name, $data_index) = @$bound;
1298 if( $bind_attributes ) {
1299 $attributes = $bind_attributes->{$column_name}
1300 if defined $bind_attributes->{$column_name};
1303 my @data = map { $_->[$data_index] } @$data;
1305 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1306 $placeholder_index++;
1308 my $rv = $sth->execute_array({ArrayTupleStatus => $tuple_status});
1309 $self->throw_exception($sth->errstr) if !$rv;
1311 $self->_query_end( $sql, @bind );
1312 return (wantarray ? ($rv, $sth, @bind) : $rv);
1316 my $self = shift @_;
1317 my $source = shift @_;
1318 my $bind_attributes = $self->source_bind_attributes($source);
1320 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1325 my $self = shift @_;
1326 my $source = shift @_;
1328 my $bind_attrs = {}; ## If ever it's needed...
1330 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1334 my ($self, $ident, $select, $condition, $attrs) = @_;
1335 my $order = $attrs->{order_by};
1337 if (ref $condition eq 'SCALAR') {
1338 my $unwrap = ${$condition};
1339 if ($unwrap =~ s/ORDER BY (.*)$//i) {
1341 $condition = \$unwrap;
1345 my $for = delete $attrs->{for};
1346 my $sql_maker = $self->sql_maker;
1347 local $sql_maker->{for} = $for;
1349 if (exists $attrs->{group_by} || $attrs->{having}) {
1351 group_by => $attrs->{group_by},
1352 having => $attrs->{having},
1353 ($order ? (order_by => $order) : ())
1356 my $bind_attrs = {}; ## Future support
1357 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1358 if ($attrs->{software_limit} ||
1359 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1360 $attrs->{software_limit} = 1;
1362 $self->throw_exception("rows attribute must be positive if present")
1363 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1365 # MySQL actually recommends this approach. I cringe.
1366 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1367 push @args, $attrs->{rows}, $attrs->{offset};
1370 return $self->_execute(@args);
1373 sub source_bind_attributes {
1374 my ($self, $source) = @_;
1376 my $bind_attributes;
1377 foreach my $column ($source->columns) {
1379 my $data_type = $source->column_info($column)->{data_type} || '';
1380 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1384 return $bind_attributes;
1391 =item Arguments: $ident, $select, $condition, $attrs
1395 Handle a SQL select statement.
1401 my ($ident, $select, $condition, $attrs) = @_;
1402 return $self->cursor_class->new($self, \@_, $attrs);
1407 my ($rv, $sth, @bind) = $self->_select(@_);
1408 my @row = $sth->fetchrow_array;
1409 my @nextrow = $sth->fetchrow_array if @row;
1410 if(@row && @nextrow) {
1411 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1413 # Need to call finish() to work round broken DBDs
1422 =item Arguments: $sql
1426 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1431 my ($self, $dbh, $sql) = @_;
1433 # 3 is the if_active parameter which avoids active sth re-use
1434 my $sth = $self->disable_sth_caching
1435 ? $dbh->prepare($sql)
1436 : $dbh->prepare_cached($sql, {}, 3);
1438 # XXX You would think RaiseError would make this impossible,
1439 # but apparently that's not true :(
1440 $self->throw_exception($dbh->errstr) if !$sth;
1446 my ($self, $sql) = @_;
1447 $self->dbh_do('_dbh_sth', $sql);
1450 sub _dbh_columns_info_for {
1451 my ($self, $dbh, $table) = @_;
1453 if ($dbh->can('column_info')) {
1456 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1457 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1459 while ( my $info = $sth->fetchrow_hashref() ){
1461 $column_info{data_type} = $info->{TYPE_NAME};
1462 $column_info{size} = $info->{COLUMN_SIZE};
1463 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1464 $column_info{default_value} = $info->{COLUMN_DEF};
1465 my $col_name = $info->{COLUMN_NAME};
1466 $col_name =~ s/^\"(.*)\"$/$1/;
1468 $result{$col_name} = \%column_info;
1471 return \%result if !$@ && scalar keys %result;
1475 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1477 my @columns = @{$sth->{NAME_lc}};
1478 for my $i ( 0 .. $#columns ){
1480 $column_info{data_type} = $sth->{TYPE}->[$i];
1481 $column_info{size} = $sth->{PRECISION}->[$i];
1482 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1484 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1485 $column_info{data_type} = $1;
1486 $column_info{size} = $2;
1489 $result{$columns[$i]} = \%column_info;
1493 foreach my $col (keys %result) {
1494 my $colinfo = $result{$col};
1495 my $type_num = $colinfo->{data_type};
1497 if(defined $type_num && $dbh->can('type_info')) {
1498 my $type_info = $dbh->type_info($type_num);
1499 $type_name = $type_info->{TYPE_NAME} if $type_info;
1500 $colinfo->{data_type} = $type_name if $type_name;
1507 sub columns_info_for {
1508 my ($self, $table) = @_;
1509 $self->dbh_do('_dbh_columns_info_for', $table);
1512 =head2 last_insert_id
1514 Return the row id of the last insert.
1518 sub _dbh_last_insert_id {
1519 my ($self, $dbh, $source, $col) = @_;
1520 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1521 $dbh->func('last_insert_rowid');
1524 sub last_insert_id {
1526 $self->dbh_do('_dbh_last_insert_id', @_);
1531 Returns the database driver name.
1535 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1537 =head2 bind_attribute_by_data_type
1539 Given a datatype from column info, returns a database specific bind
1540 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1541 let the database planner just handle it.
1543 Generally only needed for special case column types, like bytea in postgres.
1547 sub bind_attribute_by_data_type {
1551 =head2 create_ddl_dir
1555 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1559 Creates a SQL file based on the Schema, for each of the specified
1560 database types, in the given directory.
1562 By default, C<\%sqlt_args> will have
1564 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1566 merged with the hash passed in. To disable any of those features, pass in a
1567 hashref like the following
1569 { ignore_constraint_names => 0, # ... other options }
1573 sub create_ddl_dir {
1574 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1576 if(!$dir || !-d $dir) {
1577 warn "No directory given, using ./\n";
1580 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1581 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1583 my $schema_version = $schema->schema_version || '1.x';
1584 $version ||= $schema_version;
1587 add_drop_table => 1,
1588 ignore_constraint_names => 1,
1589 ignore_index_names => 1,
1593 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09: '}
1594 . $self->_check_sqlt_message . q{'})
1595 if !$self->_check_sqlt_version;
1597 my $sqlt = SQL::Translator->new( $sqltargs );
1599 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1600 my $sqlt_schema = $sqlt->translate({ data => $schema }) or die $sqlt->error;
1602 foreach my $db (@$databases) {
1604 $sqlt = $self->configure_sqlt($sqlt, $db);
1605 $sqlt->{schema} = $sqlt_schema;
1606 $sqlt->producer($db);
1609 my $filename = $schema->ddl_filename($db, $version, $dir);
1610 if (-e $filename && ($version eq $schema_version )) {
1611 # if we are dumping the current version, overwrite the DDL
1612 warn "Overwriting existing DDL file - $filename";
1616 my $output = $sqlt->translate;
1618 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1621 if(!open($file, ">$filename")) {
1622 $self->throw_exception("Can't open $filename for writing ($!)");
1625 print $file $output;
1628 next unless ($preversion);
1630 require SQL::Translator::Diff;
1632 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1633 if(!-e $prefilename) {
1634 warn("No previous schema file found ($prefilename)");
1638 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1640 warn("Overwriting existing diff file - $difffile");
1646 my $t = SQL::Translator->new($sqltargs);
1649 $t->parser( $db ) or die $t->error;
1650 $t = $self->configure_sqlt($t, $db);
1651 my $out = $t->translate( $prefilename ) or die $t->error;
1652 $source_schema = $t->schema;
1653 unless ( $source_schema->name ) {
1654 $source_schema->name( $prefilename );
1658 # The "new" style of producers have sane normalization and can support
1659 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1660 # And we have to diff parsed SQL against parsed SQL.
1661 my $dest_schema = $sqlt_schema;
1663 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1664 my $t = SQL::Translator->new($sqltargs);
1667 $t->parser( $db ) or die $t->error;
1668 $t = $self->configure_sqlt($t, $db);
1669 my $out = $t->translate( $filename ) or die $t->error;
1670 $dest_schema = $t->schema;
1671 $dest_schema->name( $filename )
1672 unless $dest_schema->name;
1675 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1679 if(!open $file, ">$difffile") {
1680 $self->throw_exception("Can't write to $difffile ($!)");
1688 sub configure_sqlt() {
1691 my $db = shift || $self->sqlt_type;
1692 if ($db eq 'PostgreSQL') {
1693 $tr->quote_table_names(0);
1694 $tr->quote_field_names(0);
1699 =head2 deployment_statements
1703 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1707 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1708 The database driver name is given by C<$type>, though the value from
1709 L</sqlt_type> is used if it is not specified.
1711 C<$directory> is used to return statements from files in a previously created
1712 L</create_ddl_dir> directory and is optional. The filenames are constructed
1713 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1715 If no C<$directory> is specified then the statements are constructed on the
1716 fly using L<SQL::Translator> and C<$version> is ignored.
1718 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1722 sub deployment_statements {
1723 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1724 # Need to be connected to get the correct sqlt_type
1725 $self->ensure_connected() unless $type;
1726 $type ||= $self->sqlt_type;
1727 $version ||= $schema->schema_version || '1.x';
1729 my $filename = $schema->ddl_filename($type, $dir, $version);
1733 open($file, "<$filename")
1734 or $self->throw_exception("Can't open $filename ($!)");
1737 return join('', @rows);
1740 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09: '}
1741 . $self->_check_sqlt_message . q{'})
1742 if !$self->_check_sqlt_version;
1744 require SQL::Translator::Parser::DBIx::Class;
1745 eval qq{use SQL::Translator::Producer::${type}};
1746 $self->throw_exception($@) if $@;
1748 # sources needs to be a parser arg, but for simplicty allow at top level
1750 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1751 if exists $sqltargs->{sources};
1753 my $tr = SQL::Translator->new(%$sqltargs);
1754 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1755 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1759 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1760 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1761 foreach my $line ( split(";\n", $statement)) {
1762 next if($line =~ /^--/);
1764 # next if($line =~ /^DROP/m);
1765 next if($line =~ /^BEGIN TRANSACTION/m);
1766 next if($line =~ /^COMMIT/m);
1767 next if $line =~ /^\s+$/; # skip whitespace only
1768 $self->_query_start($line);
1770 $self->dbh->do($line); # shouldn't be using ->dbh ?
1773 warn qq{$@ (running "${line}")};
1775 $self->_query_end($line);
1780 =head2 datetime_parser
1782 Returns the datetime parser class
1786 sub datetime_parser {
1788 return $self->{datetime_parser} ||= do {
1789 $self->ensure_connected;
1790 $self->build_datetime_parser(@_);
1794 =head2 datetime_parser_type
1796 Defines (returns) the datetime parser class - currently hardwired to
1797 L<DateTime::Format::MySQL>
1801 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1803 =head2 build_datetime_parser
1805 See L</datetime_parser>
1809 sub build_datetime_parser {
1811 my $type = $self->datetime_parser_type(@_);
1813 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1818 my $_check_sqlt_version; # private
1819 my $_check_sqlt_message; # private
1820 sub _check_sqlt_version {
1821 return $_check_sqlt_version if defined $_check_sqlt_version;
1822 eval 'use SQL::Translator "0.09"';
1823 $_check_sqlt_message = $@ || '';
1824 $_check_sqlt_version = !$@;
1827 sub _check_sqlt_message {
1828 _check_sqlt_version if !defined $_check_sqlt_message;
1829 $_check_sqlt_message;
1833 =head2 is_replicating
1835 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
1836 replicate from a master database. Default is undef, which is the result
1837 returned by databases that don't support replication.
1841 sub is_replicating {
1846 =head2 lag_behind_master
1848 Returns a number that represents a certain amount of lag behind a master db
1849 when a given storage is replicating. The number is database dependent, but
1850 starts at zero and increases with the amount of lag. Default in undef
1854 sub lag_behind_master {
1860 return if !$self->_dbh;
1869 =head2 DBIx::Class and AutoCommit
1871 DBIx::Class can do some wonderful magic with handling exceptions,
1872 disconnections, and transactions when you use C<< AutoCommit => 1 >>
1873 combined with C<txn_do> for transaction support.
1875 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
1876 in an assumed transaction between commits, and you're telling us you'd
1877 like to manage that manually. A lot of the magic protections offered by
1878 this module will go away. We can't protect you from exceptions due to database
1879 disconnects because we don't know anything about how to restart your
1880 transactions. You're on your own for handling all sorts of exceptional
1881 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
1887 The module defines a set of methods within the DBIC::SQL::Abstract
1888 namespace. These build on L<SQL::Abstract::Limit> to provide the
1889 SQL query functions.
1891 The following methods are extended:-
1905 See L</connect_info> for details.
1909 See L</connect_info> for details.
1913 See L</connect_info> for details.
1919 Matt S. Trout <mst@shadowcatsystems.co.uk>
1921 Andy Grundman <andy@hybridized.org>
1925 You may distribute this code under the same terms as Perl itself.