1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base 'DBIx::Class::Storage';
10 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
17 # what version of sqlt do we require if deploy() without a ddl_dir is invoked
18 # when changing also adjust the corresponding author_require in Makefile.PL
19 my $minimum_sqlt_version = '0.11002';
22 __PACKAGE__->mk_group_accessors('simple' =>
23 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
24 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
27 # the values for these accessors are picked out (and deleted) from
28 # the attribute hashref passed to connect_info
29 my @storage_options = qw/
30 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
31 disable_sth_caching unsafe auto_savepoint
33 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
36 # default cursor class, overridable in connect_info attributes
37 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
39 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
40 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
45 DBIx::Class::Storage::DBI - DBI storage handler
49 my $schema = MySchema->connect('dbi:SQLite:my.db');
51 $schema->storage->debug(1);
53 my @stuff = $schema->storage->dbh_do(
55 my ($storage, $dbh, @args) = @_;
56 $dbh->do("DROP TABLE authors");
61 $schema->resultset('Book')->search({
62 written_on => $schema->storage->datetime_parser(DateTime->now)
67 This class represents the connection to an RDBMS via L<DBI>. See
68 L<DBIx::Class::Storage> for general information. This pod only
69 documents DBI-specific methods and behaviors.
76 my $new = shift->next::method(@_);
78 $new->transaction_depth(0);
79 $new->_sql_maker_opts({});
80 $new->{savepoints} = [];
81 $new->{_in_dbh_do} = 0;
89 This method is normally called by L<DBIx::Class::Schema/connection>, which
90 encapsulates its argument list in an arrayref before passing them here.
92 The argument list may contain:
98 The same 4-element argument set one would normally pass to
99 L<DBI/connect>, optionally followed by
100 L<extra attributes|/DBIx::Class specific connection attributes>
101 recognized by DBIx::Class:
103 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
107 A single code reference which returns a connected
108 L<DBI database handle|DBI/connect> optionally followed by
109 L<extra attributes|/DBIx::Class specific connection attributes> recognized
112 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
116 A single hashref with all the attributes and the dsn/user/password
119 $connect_info_args = [{
127 $connect_info_args = [{
128 dbh_maker => sub { DBI->connect (...) },
133 This is particularly useful for L<Catalyst> based applications, allowing the
134 following config (L<Config::General> style):
139 dsn dbi:mysql:database=test
146 The C<dsn>/C<user>/C<password> combination can be substituted by the
147 C<dbh_maker> key whose value is a coderef that returns a connected
148 L<DBI database handle|DBI/connect>
152 Please note that the L<DBI> docs recommend that you always explicitly
153 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
154 recommends that it be set to I<1>, and that you perform transactions
155 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
156 to I<1> if you do not do explicitly set it to zero. This is the default
157 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
159 =head3 DBIx::Class specific connection attributes
161 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
162 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
163 the following connection options. These options can be mixed in with your other
164 L<DBI> connection attributes, or placed in a seperate hashref
165 (C<\%extra_attributes>) as shown above.
167 Every time C<connect_info> is invoked, any previous settings for
168 these options will be cleared before setting the new ones, regardless of
169 whether any options are specified in the new C<connect_info>.
176 Specifies things to do immediately after connecting or re-connecting to
177 the database. Its value may contain:
183 This contains one SQL statement to execute.
185 =item an array reference
187 This contains SQL statements to execute in order. Each element contains
188 a string or a code reference that returns a string.
190 =item a code reference
192 This contains some code to execute. Unlike code references within an
193 array reference, its return value is ignored.
197 =item on_disconnect_do
199 Takes arguments in the same form as L</on_connect_do> and executes them
200 immediately before disconnecting from the database.
202 Note, this only runs if you explicitly call L</disconnect> on the
205 =item on_connect_call
207 A more generalized form of L</on_connect_do> that calls the specified
208 C<connect_call_METHOD> methods in your storage driver.
210 on_connect_do => 'select 1'
214 on_connect_call => [ [ do_sql => 'select 1' ] ]
216 Its values may contain:
222 Will call the C<connect_call_METHOD> method.
224 =item a code reference
226 Will execute C<< $code->($storage) >>
228 =item an array reference
230 Each value can be a method name or code reference.
232 =item an array of arrays
234 For each array, the first item is taken to be the C<connect_call_> method name
235 or code reference, and the rest are parameters to it.
239 Some predefined storage methods you may use:
245 Executes a SQL string or a code reference that returns a SQL string. This is
246 what L</on_connect_do> and L</on_disconnect_do> use.
254 Will execute the scalar as SQL.
258 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
259 attributes hashref and bind values.
261 =item a code reference
263 Will execute C<< $code->($storage) >> and execute the return array refs as
270 Execute any statements necessary to initialize the database session to return
271 and accept datetime/timestamp values used with
272 L<DBIx::Class::InflateColumn::DateTime>.
274 Only necessary for some databases, see your specific storage driver for
275 implementation details.
279 =item on_disconnect_call
281 Takes arguments in the same form as L</on_connect_call> and executes them
282 immediately before disconnecting from the database.
284 Calls the C<disconnect_call_METHOD> methods as opposed to the
285 C<connect_call_METHOD> methods called by L</on_connect_call>.
287 Note, this only runs if you explicitly call L</disconnect> on the
290 =item disable_sth_caching
292 If set to a true value, this option will disable the caching of
293 statement handles via L<DBI/prepare_cached>.
297 Sets the limit dialect. This is useful for JDBC-bridge among others
298 where the remote SQL-dialect cannot be determined by the name of the
299 driver alone. See also L<SQL::Abstract::Limit>.
303 Specifies what characters to use to quote table and column names. If
304 you use this you will want to specify L</name_sep> as well.
306 C<quote_char> expects either a single character, in which case is it
307 is placed on either side of the table/column name, or an arrayref of length
308 2 in which case the table/column name is placed between the elements.
310 For example under MySQL you should use C<< quote_char => '`' >>, and for
311 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
315 This only needs to be used in conjunction with C<quote_char>, and is used to
316 specify the charecter that seperates elements (schemas, tables, columns) from
317 each other. In most cases this is simply a C<.>.
319 The consequences of not supplying this value is that L<SQL::Abstract>
320 will assume DBIx::Class' uses of aliases to be complete column
321 names. The output will look like I<"me.name"> when it should actually
326 This Storage driver normally installs its own C<HandleError>, sets
327 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
328 all database handles, including those supplied by a coderef. It does this
329 so that it can have consistent and useful error behavior.
331 If you set this option to a true value, Storage will not do its usual
332 modifications to the database handle's attributes, and instead relies on
333 the settings in your connect_info DBI options (or the values you set in
334 your connection coderef, in the case that you are connecting via coderef).
336 Note that your custom settings can cause Storage to malfunction,
337 especially if you set a C<HandleError> handler that suppresses exceptions
338 and/or disable C<RaiseError>.
342 If this option is true, L<DBIx::Class> will use savepoints when nesting
343 transactions, making it possible to recover from failure in the inner
344 transaction without having to abort all outer transactions.
348 Use this argument to supply a cursor class other than the default
349 L<DBIx::Class::Storage::DBI::Cursor>.
353 Some real-life examples of arguments to L</connect_info> and
354 L<DBIx::Class::Schema/connect>
356 # Simple SQLite connection
357 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
360 ->connect_info([ sub { DBI->connect(...) } ]);
362 # Connect via subref in hashref
364 dbh_maker => sub { DBI->connect(...) },
365 on_connect_do => 'alter session ...',
368 # A bit more complicated
375 { quote_char => q{"}, name_sep => q{.} },
379 # Equivalent to the previous example
385 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
389 # Same, but with hashref as argument
390 # See parse_connect_info for explanation
393 dsn => 'dbi:Pg:dbname=foo',
395 password => 'my_pg_password',
402 # Subref + DBIx::Class-specific connection options
405 sub { DBI->connect(...) },
409 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
410 disable_sth_caching => 1,
420 my ($self, $info_arg) = @_;
422 return $self->_connect_info if !$info_arg;
424 my @args = @$info_arg; # take a shallow copy for further mutilation
425 $self->_connect_info([@args]); # copy for _connect_info
428 # combine/pre-parse arguments depending on invocation style
431 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
432 %attrs = %{ $args[1] || {} };
435 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
436 %attrs = %{$args[0]};
438 if (my $code = delete $attrs{dbh_maker}) {
441 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
444 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
445 . "to the result of 'dbh_maker'",
447 join (', ', map { "'$_'" } (@ignored) ),
452 @args = delete @attrs{qw/dsn user password/};
455 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
457 % { $args[3] || {} },
458 % { $args[4] || {} },
460 @args = @args[0,1,2];
463 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
464 # the new set of options
465 $self->_sql_maker(undef);
466 $self->_sql_maker_opts({});
469 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
470 if(my $value = delete $attrs{$storage_opt}) {
471 $self->$storage_opt($value);
474 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
475 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
476 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
481 if (ref $args[0] eq 'CODE') {
482 # _connect() never looks past $args[0] in this case
486 %{ $self->_default_dbi_connect_attributes || {} },
491 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
492 $self->_connect_info;
495 sub _default_dbi_connect_attributes {
505 This method is deprecated in favour of setting via L</connect_info>.
509 =head2 on_disconnect_do
511 This method is deprecated in favour of setting via L</connect_info>.
515 sub _parse_connect_do {
516 my ($self, $type) = @_;
518 my $val = $self->$type;
519 return () if not defined $val;
524 push @res, [ 'do_sql', $val ];
525 } elsif (ref($val) eq 'CODE') {
527 } elsif (ref($val) eq 'ARRAY') {
528 push @res, map { [ 'do_sql', $_ ] } @$val;
530 $self->throw_exception("Invalid type for $type: ".ref($val));
538 Arguments: ($subref | $method_name), @extra_coderef_args?
540 Execute the given $subref or $method_name using the new exception-based
541 connection management.
543 The first two arguments will be the storage object that C<dbh_do> was called
544 on and a database handle to use. Any additional arguments will be passed
545 verbatim to the called subref as arguments 2 and onwards.
547 Using this (instead of $self->_dbh or $self->dbh) ensures correct
548 exception handling and reconnection (or failover in future subclasses).
550 Your subref should have no side-effects outside of the database, as
551 there is the potential for your subref to be partially double-executed
552 if the database connection was stale/dysfunctional.
556 my @stuff = $schema->storage->dbh_do(
558 my ($storage, $dbh, @cols) = @_;
559 my $cols = join(q{, }, @cols);
560 $dbh->selectrow_array("SELECT $cols FROM foo");
571 my $dbh = $self->_get_dbh;
573 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
574 || $self->{transaction_depth};
576 local $self->{_in_dbh_do} = 1;
579 my $want_array = wantarray;
584 @result = $self->$code($dbh, @_);
586 elsif(defined $want_array) {
587 $result[0] = $self->$code($dbh, @_);
590 $self->$code($dbh, @_);
594 # ->connected might unset $@ - copy
596 if(!$exception) { return $want_array ? @result : $result[0] }
598 $self->throw_exception($exception) if $self->connected;
600 # We were not connected - reconnect and retry, but let any
601 # exception fall right through this time
602 carp "Retrying $code after catching disconnected exception: $exception"
603 if $ENV{DBIC_DBIRETRY_DEBUG};
604 $self->_populate_dbh;
605 $self->$code($self->_dbh, @_);
608 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
609 # It also informs dbh_do to bypass itself while under the direction of txn_do,
610 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
615 ref $coderef eq 'CODE' or $self->throw_exception
616 ('$coderef must be a CODE reference');
618 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
620 local $self->{_in_dbh_do} = 1;
623 my $want_array = wantarray;
632 @result = $coderef->(@_);
634 elsif(defined $want_array) {
635 $result[0] = $coderef->(@_);
643 # ->connected might unset $@ - copy
645 if(!$exception) { return $want_array ? @result : $result[0] }
647 if($tried++ || $self->connected) {
648 eval { $self->txn_rollback };
649 my $rollback_exception = $@;
650 if($rollback_exception) {
651 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
652 $self->throw_exception($exception) # propagate nested rollback
653 if $rollback_exception =~ /$exception_class/;
655 $self->throw_exception(
656 "Transaction aborted: ${exception}. "
657 . "Rollback failed: ${rollback_exception}"
660 $self->throw_exception($exception)
663 # We were not connected, and was first try - reconnect and retry
665 carp "Retrying $coderef after catching disconnected exception: $exception"
666 if $ENV{DBIC_DBIRETRY_DEBUG};
667 $self->_populate_dbh;
673 Our C<disconnect> method also performs a rollback first if the
674 database is not in C<AutoCommit> mode.
684 push @actions, ( $self->on_disconnect_call || () );
685 push @actions, $self->_parse_connect_do ('on_disconnect_do');
687 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
689 $self->_dbh_rollback unless $self->_dbh_autocommit;
691 $self->_dbh->disconnect;
697 =head2 with_deferred_fk_checks
701 =item Arguments: C<$coderef>
703 =item Return Value: The return value of $coderef
707 Storage specific method to run the code ref with FK checks deferred or
708 in MySQL's case disabled entirely.
712 # Storage subclasses should override this
713 sub with_deferred_fk_checks {
714 my ($self, $sub) = @_;
723 =item Arguments: none
725 =item Return Value: 1|0
729 Verifies that the the current database handle is active and ready to execute
730 an SQL statement (i.e. the connection did not get stale, server is still
731 answering, etc.) This method is used internally by L</dbh>.
737 return 0 unless $self->_seems_connected;
740 local $self->_dbh->{RaiseError} = 1;
745 sub _seems_connected {
748 my $dbh = $self->_dbh
751 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
758 return 0 if !$self->_dbh;
761 return $dbh->FETCH('Active');
767 my $dbh = $self->_dbh or return 0;
772 # handle pid changes correctly
773 # NOTE: assumes $self->_dbh is a valid $dbh
777 return if defined $self->_conn_pid && $self->_conn_pid == $$;
779 $self->_dbh->{InactiveDestroy} = 1;
786 sub ensure_connected {
789 unless ($self->connected) {
790 $self->_populate_dbh;
796 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
797 is guaranteed to be healthy by implicitly calling L</connected>, and if
798 necessary performing a reconnection before returning. Keep in mind that this
799 is very B<expensive> on some database engines. Consider using L<dbh_do>
807 if (not $self->_dbh) {
808 $self->_populate_dbh;
810 $self->ensure_connected;
815 # this is the internal "get dbh or connect (don't check)" method
818 $self->_verify_pid if $self->_dbh;
819 $self->_populate_dbh unless $self->_dbh;
823 sub _sql_maker_args {
828 array_datatypes => 1,
829 limit_dialect => $self->_get_dbh,
830 %{$self->_sql_maker_opts}
836 unless ($self->_sql_maker) {
837 my $sql_maker_class = $self->sql_maker_class;
838 $self->ensure_class_loaded ($sql_maker_class);
839 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
841 return $self->_sql_maker;
844 # nothing to do by default
851 my @info = @{$self->_dbi_connect_info || []};
852 $self->_dbh(undef); # in case ->connected failed we might get sent here
853 $self->_dbh($self->_connect(@info));
855 $self->_conn_pid($$);
856 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
858 $self->_determine_driver;
860 # Always set the transaction depth on connect, since
861 # there is no transaction in progress by definition
862 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
864 $self->_run_connection_actions unless $self->{_in_determine_driver};
867 sub _run_connection_actions {
871 push @actions, ( $self->on_connect_call || () );
872 push @actions, $self->_parse_connect_do ('on_connect_do');
874 $self->_do_connection_actions(connect_call_ => $_) for @actions;
877 sub _determine_driver {
880 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
881 my $started_connected = 0;
882 local $self->{_in_determine_driver} = 1;
884 if (ref($self) eq __PACKAGE__) {
886 if ($self->_dbh) { # we are connected
887 $driver = $self->_dbh->{Driver}{Name};
888 $started_connected = 1;
890 # if connect_info is a CODEREF, we have no choice but to connect
891 if (ref $self->_dbi_connect_info->[0] &&
892 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
893 $self->_populate_dbh;
894 $driver = $self->_dbh->{Driver}{Name};
897 # try to use dsn to not require being connected, the driver may still
898 # force a connection in _rebless to determine version
899 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
903 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
904 if ($self->load_optional_class($storage_class)) {
905 mro::set_mro($storage_class, 'c3');
906 bless $self, $storage_class;
911 $self->_driver_determined(1);
913 $self->_init; # run driver-specific initializations
915 $self->_run_connection_actions
916 if !$started_connected && defined $self->_dbh;
920 sub _do_connection_actions {
922 my $method_prefix = shift;
925 if (not ref($call)) {
926 my $method = $method_prefix . $call;
928 } elsif (ref($call) eq 'CODE') {
930 } elsif (ref($call) eq 'ARRAY') {
931 if (ref($call->[0]) ne 'ARRAY') {
932 $self->_do_connection_actions($method_prefix, $_) for @$call;
934 $self->_do_connection_actions($method_prefix, @$_) for @$call;
937 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
943 sub connect_call_do_sql {
945 $self->_do_query(@_);
948 sub disconnect_call_do_sql {
950 $self->_do_query(@_);
953 # override in db-specific backend when necessary
954 sub connect_call_datetime_setup { 1 }
957 my ($self, $action) = @_;
959 if (ref $action eq 'CODE') {
960 $action = $action->($self);
961 $self->_do_query($_) foreach @$action;
964 # Most debuggers expect ($sql, @bind), so we need to exclude
965 # the attribute hash which is the second argument to $dbh->do
966 # furthermore the bind values are usually to be presented
967 # as named arrayref pairs, so wrap those here too
968 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
969 my $sql = shift @do_args;
970 my $attrs = shift @do_args;
971 my @bind = map { [ undef, $_ ] } @do_args;
973 $self->_query_start($sql, @bind);
974 $self->_get_dbh->do($sql, $attrs, @do_args);
975 $self->_query_end($sql, @bind);
982 my ($self, @info) = @_;
984 $self->throw_exception("You failed to provide any connection info")
987 my ($old_connect_via, $dbh);
989 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
990 $old_connect_via = $DBI::connect_via;
991 $DBI::connect_via = 'connect';
995 if(ref $info[0] eq 'CODE') {
999 $dbh = DBI->connect(@info);
1002 if($dbh && !$self->unsafe) {
1003 my $weak_self = $self;
1004 Scalar::Util::weaken($weak_self);
1005 $dbh->{HandleError} = sub {
1007 $weak_self->throw_exception("DBI Exception: $_[0]");
1010 # the handler may be invoked by something totally out of
1012 croak ("DBI Exception: $_[0]");
1015 $dbh->{ShowErrorStatement} = 1;
1016 $dbh->{RaiseError} = 1;
1017 $dbh->{PrintError} = 0;
1021 $DBI::connect_via = $old_connect_via if $old_connect_via;
1023 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1026 $self->_dbh_autocommit($dbh->{AutoCommit});
1032 my ($self, $name) = @_;
1034 $name = $self->_svp_generate_name
1035 unless defined $name;
1037 $self->throw_exception ("You can't use savepoints outside a transaction")
1038 if $self->{transaction_depth} == 0;
1040 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1041 unless $self->can('_svp_begin');
1043 push @{ $self->{savepoints} }, $name;
1045 $self->debugobj->svp_begin($name) if $self->debug;
1047 return $self->_svp_begin($name);
1051 my ($self, $name) = @_;
1053 $self->throw_exception ("You can't use savepoints outside a transaction")
1054 if $self->{transaction_depth} == 0;
1056 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1057 unless $self->can('_svp_release');
1059 if (defined $name) {
1060 $self->throw_exception ("Savepoint '$name' does not exist")
1061 unless grep { $_ eq $name } @{ $self->{savepoints} };
1063 # Dig through the stack until we find the one we are releasing. This keeps
1064 # the stack up to date.
1067 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1069 $name = pop @{ $self->{savepoints} };
1072 $self->debugobj->svp_release($name) if $self->debug;
1074 return $self->_svp_release($name);
1078 my ($self, $name) = @_;
1080 $self->throw_exception ("You can't use savepoints outside a transaction")
1081 if $self->{transaction_depth} == 0;
1083 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1084 unless $self->can('_svp_rollback');
1086 if (defined $name) {
1087 # If they passed us a name, verify that it exists in the stack
1088 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1089 $self->throw_exception("Savepoint '$name' does not exist!");
1092 # Dig through the stack until we find the one we are releasing. This keeps
1093 # the stack up to date.
1094 while(my $s = pop(@{ $self->{savepoints} })) {
1095 last if($s eq $name);
1097 # Add the savepoint back to the stack, as a rollback doesn't remove the
1098 # named savepoint, only everything after it.
1099 push(@{ $self->{savepoints} }, $name);
1101 # We'll assume they want to rollback to the last savepoint
1102 $name = $self->{savepoints}->[-1];
1105 $self->debugobj->svp_rollback($name) if $self->debug;
1107 return $self->_svp_rollback($name);
1110 sub _svp_generate_name {
1113 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1118 if($self->{transaction_depth} == 0) {
1119 $self->debugobj->txn_begin()
1121 $self->_dbh_begin_work;
1123 elsif ($self->auto_savepoint) {
1126 $self->{transaction_depth}++;
1129 sub _dbh_begin_work {
1132 # if the user is utilizing txn_do - good for him, otherwise we need to
1133 # ensure that the $dbh is healthy on BEGIN.
1134 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1135 # will be replaced by a failure of begin_work itself (which will be
1136 # then retried on reconnect)
1137 if ($self->{_in_dbh_do}) {
1138 $self->_dbh->begin_work;
1140 $self->dbh_do(sub { $_[1]->begin_work });
1146 if ($self->{transaction_depth} == 1) {
1147 my $dbh = $self->_dbh;
1148 $self->debugobj->txn_commit()
1151 $self->{transaction_depth} = 0
1152 if $self->_dbh_autocommit;
1154 elsif($self->{transaction_depth} > 1) {
1155 $self->{transaction_depth}--;
1157 if $self->auto_savepoint;
1163 $self->_dbh->commit;
1168 my $dbh = $self->_dbh;
1170 if ($self->{transaction_depth} == 1) {
1171 $self->debugobj->txn_rollback()
1173 $self->{transaction_depth} = 0
1174 if $self->_dbh_autocommit;
1175 $self->_dbh_rollback;
1177 elsif($self->{transaction_depth} > 1) {
1178 $self->{transaction_depth}--;
1179 if ($self->auto_savepoint) {
1180 $self->svp_rollback;
1185 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1190 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1191 $error =~ /$exception_class/ and $self->throw_exception($error);
1192 # ensure that a failed rollback resets the transaction depth
1193 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1194 $self->throw_exception($error);
1200 $self->_dbh->rollback;
1203 # This used to be the top-half of _execute. It was split out to make it
1204 # easier to override in NoBindVars without duping the rest. It takes up
1205 # all of _execute's args, and emits $sql, @bind.
1206 sub _prep_for_execute {
1207 my ($self, $op, $extra_bind, $ident, $args) = @_;
1209 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1210 $ident = $ident->from();
1213 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1216 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1218 return ($sql, \@bind);
1222 sub _fix_bind_params {
1223 my ($self, @bind) = @_;
1225 ### Turn @bind from something like this:
1226 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1228 ### ( "'1'", "'1'", "'3'" )
1231 if ( defined( $_ && $_->[1] ) ) {
1232 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1239 my ( $self, $sql, @bind ) = @_;
1241 if ( $self->debug ) {
1242 @bind = $self->_fix_bind_params(@bind);
1244 $self->debugobj->query_start( $sql, @bind );
1249 my ( $self, $sql, @bind ) = @_;
1251 if ( $self->debug ) {
1252 @bind = $self->_fix_bind_params(@bind);
1253 $self->debugobj->query_end( $sql, @bind );
1258 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1260 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1262 $self->_query_start( $sql, @$bind );
1264 my $sth = $self->sth($sql,$op);
1266 my $placeholder_index = 1;
1268 foreach my $bound (@$bind) {
1269 my $attributes = {};
1270 my($column_name, @data) = @$bound;
1272 if ($bind_attributes) {
1273 $attributes = $bind_attributes->{$column_name}
1274 if defined $bind_attributes->{$column_name};
1277 foreach my $data (@data) {
1278 my $ref = ref $data;
1279 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1281 $sth->bind_param($placeholder_index, $data, $attributes);
1282 $placeholder_index++;
1286 # Can this fail without throwing an exception anyways???
1287 my $rv = $sth->execute();
1288 $self->throw_exception($sth->errstr) if !$rv;
1290 $self->_query_end( $sql, @$bind );
1292 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1297 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1301 my ($self, $source, $to_insert) = @_;
1303 # redispatch to insert method of storage we reblessed into, if necessary
1304 if (not $self->_driver_determined) {
1305 $self->_determine_driver;
1306 goto $self->can('insert');
1309 my $ident = $source->from;
1310 my $bind_attributes = $self->source_bind_attributes($source);
1312 my $updated_cols = {};
1314 foreach my $col ( $source->columns ) {
1315 if ( !defined $to_insert->{$col} ) {
1316 my $col_info = $source->column_info($col);
1318 if ( $col_info->{auto_nextval} ) {
1319 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1321 $col_info->{sequence} ||
1322 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1328 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1330 return $updated_cols;
1333 ## Still not quite perfect, and EXPERIMENTAL
1334 ## Currently it is assumed that all values passed will be "normal", i.e. not
1335 ## scalar refs, or at least, all the same type as the first set, the statement is
1336 ## only prepped once.
1338 my ($self, $source, $cols, $data) = @_;
1340 # redispatch to insert_bulk method of storage we reblessed into, if necessary
1341 if (not $self->_driver_determined) {
1342 $self->_determine_driver;
1343 goto $self->can('insert_bulk');
1347 @colvalues{@$cols} = (0..$#$cols);
1349 # pass scalarref to SQLA for literal sql if it's the same in all slices
1350 for my $i (0..$#$cols) {
1351 my $first_val = $data->[0][$i];
1352 next unless ref $first_val eq 'SCALAR';
1354 $colvalues{ $cols->[$i] } = $first_val
1356 ref $_ eq 'SCALAR' && $$_ eq $$first_val
1357 } map $data->[$_][$i], (1..$#$data)) == (@$data - 1);
1360 my ($sql, $bind) = $self->_prep_for_execute (
1361 'insert', undef, $source, [\%colvalues]
1365 my $empty_bind = 1 if (not @bind) &&
1366 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1368 if ((not @bind) && (not $empty_bind)) {
1369 $self->throw_exception(
1370 'Cannot insert_bulk without support for placeholders'
1374 $self->_query_start( $sql, @bind );
1375 my $sth = $self->sth($sql);
1379 # bind_param_array doesn't work if there are no binds
1380 $self->_execute_array_empty( $sth, scalar @$data );
1383 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1384 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1388 $self->_query_end( $sql, @bind );
1390 return (wantarray ? ($rv, $sth, @bind) : $rv);
1393 sub _execute_array {
1394 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1396 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1398 ## This must be an arrayref, else nothing works!
1399 my $tuple_status = [];
1401 ## Get the bind_attributes, if any exist
1402 my $bind_attributes = $self->source_bind_attributes($source);
1404 ## Bind the values and execute
1405 my $placeholder_index = 1;
1407 foreach my $bound (@$bind) {
1409 my $attributes = {};
1410 my ($column_name, $data_index) = @$bound;
1412 if( $bind_attributes ) {
1413 $attributes = $bind_attributes->{$column_name}
1414 if defined $bind_attributes->{$column_name};
1417 my @data = map { $_->[$data_index] } @$data;
1419 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1420 $placeholder_index++;
1424 $self->_dbh_execute_array($sth, $tuple_status, @extra);
1426 my $err = $@ || $sth->errstr;
1428 # Statement must finish even if there was an exception.
1429 eval { $sth->finish };
1430 $err = $@ unless $err;
1434 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1436 $self->throw_exception("Unexpected populate error: $err")
1437 if ($i > $#$tuple_status);
1439 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1440 ($tuple_status->[$i][1] || $err),
1441 $self->_pretty_print ({
1442 map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols)
1447 $guard->commit if $guard;
1452 sub _dbh_execute_array {
1453 my ($self, $sth, $tuple_status, @extra) = @_;
1455 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1458 sub _execute_array_empty {
1459 my ($self, $sth, $count) = @_;
1461 my $guard = $self->txn_scope_guard unless $self->{transaction_depth} != 0;
1464 my $dbh = $self->_get_dbh;
1465 local $dbh->{RaiseError} = 1;
1466 local $dbh->{PrintError} = 0;
1468 $sth->execute foreach 1..$count;
1472 # Make sure statement is finished even if there was an exception.
1473 eval { $sth->finish };
1474 $exception = $@ unless $exception;
1476 $self->throw_exception($exception) if $exception;
1478 $guard->commit if $guard;
1484 my ($self, $source, @args) = @_;
1486 # redispatch to update method of storage we reblessed into, if necessary
1487 if (not $self->_driver_determined) {
1488 $self->_determine_driver;
1489 goto $self->can('update');
1492 my $bind_attributes = $self->source_bind_attributes($source);
1494 return $self->_execute('update' => [], $source, $bind_attributes, @args);
1499 my $self = shift @_;
1500 my $source = shift @_;
1501 $self->_determine_driver;
1502 my $bind_attrs = $self->source_bind_attributes($source);
1504 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1507 # We were sent here because the $rs contains a complex search
1508 # which will require a subquery to select the correct rows
1509 # (i.e. joined or limited resultsets)
1511 # Genarating a single PK column subquery is trivial and supported
1512 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1513 # Look at _multipk_update_delete()
1514 sub _subq_update_delete {
1516 my ($rs, $op, $values) = @_;
1518 my $rsrc = $rs->result_source;
1520 # we already check this, but double check naively just in case. Should be removed soon
1521 my $sel = $rs->_resolved_attrs->{select};
1522 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1523 my @pcols = $rsrc->primary_columns;
1524 if (@$sel != @pcols) {
1525 $self->throw_exception (
1526 'Subquery update/delete can not be called on resultsets selecting a'
1527 .' number of columns different than the number of primary keys'
1534 $op eq 'update' ? $values : (),
1535 { $pcols[0] => { -in => $rs->as_query } },
1540 return $self->_multipk_update_delete (@_);
1544 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1545 # resultset update/delete involving subqueries. So by default resort
1546 # to simple (and inefficient) delete_all style per-row opearations,
1547 # while allowing specific storages to override this with a faster
1550 sub _multipk_update_delete {
1551 return shift->_per_row_update_delete (@_);
1554 # This is the default loop used to delete/update rows for multi PK
1555 # resultsets, and used by mysql exclusively (because it can't do anything
1558 # We do not use $row->$op style queries, because resultset update/delete
1559 # is not expected to cascade (this is what delete_all/update_all is for).
1561 # There should be no race conditions as the entire operation is rolled
1564 sub _per_row_update_delete {
1566 my ($rs, $op, $values) = @_;
1568 my $rsrc = $rs->result_source;
1569 my @pcols = $rsrc->primary_columns;
1571 my $guard = $self->txn_scope_guard;
1573 # emulate the return value of $sth->execute for non-selects
1574 my $row_cnt = '0E0';
1576 my $subrs_cur = $rs->cursor;
1577 while (my @pks = $subrs_cur->next) {
1580 for my $i (0.. $#pcols) {
1581 $cond->{$pcols[$i]} = $pks[$i];
1586 $op eq 'update' ? $values : (),
1601 # localization is neccessary as
1602 # 1) there is no infrastructure to pass this around before SQLA2
1603 # 2) _select_args sets it and _prep_for_execute consumes it
1604 my $sql_maker = $self->sql_maker;
1605 local $sql_maker->{_dbic_rs_attrs};
1607 return $self->_execute($self->_select_args(@_));
1610 sub _select_args_to_query {
1613 # localization is neccessary as
1614 # 1) there is no infrastructure to pass this around before SQLA2
1615 # 2) _select_args sets it and _prep_for_execute consumes it
1616 my $sql_maker = $self->sql_maker;
1617 local $sql_maker->{_dbic_rs_attrs};
1619 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1620 # = $self->_select_args($ident, $select, $cond, $attrs);
1621 my ($op, $bind, $ident, $bind_attrs, @args) =
1622 $self->_select_args(@_);
1624 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1625 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1626 $prepared_bind ||= [];
1629 ? ($sql, $prepared_bind, $bind_attrs)
1630 : \[ "($sql)", @$prepared_bind ]
1635 my ($self, $ident, $select, $where, $attrs) = @_;
1637 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1639 my $sql_maker = $self->sql_maker;
1640 $sql_maker->{_dbic_rs_attrs} = {
1646 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1651 # calculate bind_attrs before possible $ident mangling
1652 my $bind_attrs = {};
1653 for my $alias (keys %$alias2source) {
1654 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1655 for my $col (keys %$bindtypes) {
1657 my $fqcn = join ('.', $alias, $col);
1658 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1660 # Unqialified column names are nice, but at the same time can be
1661 # rather ambiguous. What we do here is basically go along with
1662 # the loop, adding an unqualified column slot to $bind_attrs,
1663 # alongside the fully qualified name. As soon as we encounter
1664 # another column by that name (which would imply another table)
1665 # we unset the unqualified slot and never add any info to it
1666 # to avoid erroneous type binding. If this happens the users
1667 # only choice will be to fully qualify his column name
1669 if (exists $bind_attrs->{$col}) {
1670 $bind_attrs->{$col} = {};
1673 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1680 $attrs->{software_limit}
1682 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1684 $attrs->{software_limit} = 1;
1687 $self->throw_exception("rows attribute must be positive if present")
1688 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1690 # MySQL actually recommends this approach. I cringe.
1691 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1696 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1697 # otherwise delegate the limiting to the storage, unless software limit was requested
1699 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1701 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1702 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1704 ($ident, $select, $where, $attrs)
1705 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1707 elsif (! $attrs->{software_limit} ) {
1708 push @limit, $attrs->{rows}, $attrs->{offset};
1712 # This would be the point to deflate anything found in $where
1713 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1714 # expect a row object. And all we have is a resultsource (it is trivial
1715 # to extract deflator coderefs via $alias2source above).
1717 # I don't see a way forward other than changing the way deflators are
1718 # invoked, and that's just bad...
1722 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1723 (qw/order_by group_by having/ )
1726 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1730 # This is the code producing joined subqueries like:
1731 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1733 sub _adjust_select_args_for_complex_prefetch {
1734 my ($self, $from, $select, $where, $attrs) = @_;
1736 $self->throw_exception ('Nothing to prefetch... how did we get here?!')
1737 if not @{$attrs->{_prefetch_select}};
1739 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1740 if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY');
1743 # generate inner/outer attribute lists, remove stuff that doesn't apply
1744 my $outer_attrs = { %$attrs };
1745 delete $outer_attrs->{$_} for qw/where bind rows offset group_by having/;
1747 my $inner_attrs = { %$attrs };
1748 delete $inner_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1751 # bring over all non-collapse-induced order_by into the inner query (if any)
1752 # the outer one will have to keep them all
1753 delete $inner_attrs->{order_by};
1754 if (my $ord_cnt = @{$outer_attrs->{order_by}} - @{$outer_attrs->{_collapse_order_by}} ) {
1755 $inner_attrs->{order_by} = [
1756 @{$outer_attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1761 # generate the inner/outer select lists
1762 # for inside we consider only stuff *not* brought in by the prefetch
1763 # on the outside we substitute any function for its alias
1764 my $outer_select = [ @$select ];
1765 my $inner_select = [];
1766 for my $i (0 .. ( @$outer_select - @{$outer_attrs->{_prefetch_select}} - 1) ) {
1767 my $sel = $outer_select->[$i];
1769 if (ref $sel eq 'HASH' ) {
1770 $sel->{-as} ||= $attrs->{as}[$i];
1771 $outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
1774 push @$inner_select, $sel;
1777 # normalize a copy of $from, so it will be easier to work with further
1778 # down (i.e. promote the initial hashref to an AoH)
1780 $from->[0] = [ $from->[0] ];
1781 my %original_join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1784 # decide which parts of the join will remain in either part of
1785 # the outer/inner query
1787 # First we compose a list of which aliases are used in restrictions
1788 # (i.e. conditions/order/grouping/etc). Since we do not have
1789 # introspectable SQLA, we fall back to ugly scanning of raw SQL for
1790 # WHERE, and for pieces of ORDER BY in order to determine which aliases
1791 # need to appear in the resulting sql.
1792 # It may not be very efficient, but it's a reasonable stop-gap
1793 # Also unqualified column names will not be considered, but more often
1794 # than not this is actually ok
1796 # In the same loop we enumerate part of the selection aliases, as
1797 # it requires the same sqla hack for the time being
1798 my ($restrict_aliases, $select_aliases, $prefetch_aliases);
1800 # produce stuff unquoted, so it can be scanned
1801 my $sql_maker = $self->sql_maker;
1802 local $sql_maker->{quote_char};
1803 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1806 my $non_prefetch_select_sql = $sql_maker->_recurse_fields ($inner_select);
1807 my $prefetch_select_sql = $sql_maker->_recurse_fields ($outer_attrs->{_prefetch_select});
1808 my $where_sql = $sql_maker->where ($where);
1809 my $group_by_sql = $sql_maker->_order_by({
1810 map { $_ => $inner_attrs->{$_} } qw/group_by having/
1812 my @non_prefetch_order_by_chunks = (map
1813 { ref $_ ? $_->[0] : $_ }
1814 $sql_maker->_order_by_chunks ($inner_attrs->{order_by})
1818 for my $alias (keys %original_join_info) {
1819 my $seen_re = qr/\b $alias $sep/x;
1821 for my $piece ($where_sql, $group_by_sql, @non_prefetch_order_by_chunks ) {
1822 if ($piece =~ $seen_re) {
1823 $restrict_aliases->{$alias} = 1;
1827 if ($non_prefetch_select_sql =~ $seen_re) {
1828 $select_aliases->{$alias} = 1;
1831 if ($prefetch_select_sql =~ $seen_re) {
1832 $prefetch_aliases->{$alias} = 1;
1838 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
1839 for my $j (values %original_join_info) {
1840 my $alias = $j->{-alias} or next;
1841 $restrict_aliases->{$alias} = 1 if (
1842 (not $j->{-join_type})
1844 ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
1848 # mark all join parents as mentioned
1849 # (e.g. join => { cds => 'tracks' } - tracks will need to bring cds too )
1850 for my $collection ($restrict_aliases, $select_aliases) {
1851 for my $alias (keys %$collection) {
1852 $collection->{$_} = 1
1853 for (@{ $original_join_info{$alias}{-join_path} || [] });
1857 # construct the inner $from for the subquery
1858 my %inner_joins = (map { %{$_ || {}} } ($restrict_aliases, $select_aliases) );
1860 for my $j (@$from) {
1861 push @inner_from, $j if $inner_joins{$j->[0]{-alias}};
1864 # if a multi-type join was needed in the subquery ("multi" is indicated by
1865 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1866 unless ($inner_attrs->{group_by}) {
1867 for my $alias (keys %inner_joins) {
1869 # the dot comes from some weirdness in collapse
1870 # remove after the rewrite
1871 if ($attrs->{collapse}{".$alias"}) {
1872 $inner_attrs->{group_by} ||= $inner_select;
1878 # demote the inner_from head
1879 $inner_from[0] = $inner_from[0][0];
1881 # generate the subquery
1882 my $subq = $self->_select_args_to_query (
1889 my $subq_joinspec = {
1890 -alias => $attrs->{alias},
1891 -source_handle => $inner_from[0]{-source_handle},
1892 $attrs->{alias} => $subq,
1895 # Generate the outer from - this is relatively easy (really just replace
1896 # the join slot with the subquery), with a major caveat - we can not
1897 # join anything that is non-selecting (not part of the prefetch), but at
1898 # the same time is a multi-type relationship, as it will explode the result.
1900 # There are two possibilities here
1901 # - either the join is non-restricting, in which case we simply throw it away
1902 # - it is part of the restrictions, in which case we need to collapse the outer
1903 # result by tackling yet another group_by to the outside of the query
1905 # so first generate the outer_from, up to the substitution point
1907 while (my $j = shift @$from) {
1908 if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
1913 last; # we'll take care of what's left in $from below
1916 push @outer_from, $j;
1920 # see what's left - throw away if not selecting/restricting
1921 # also throw in a group_by if restricting to guard against
1922 # cross-join explosions
1924 while (my $j = shift @$from) {
1925 my $alias = $j->[0]{-alias};
1927 if ($select_aliases->{$alias} || $prefetch_aliases->{$alias}) {
1928 push @outer_from, $j;
1930 elsif ($restrict_aliases->{$alias}) {
1931 push @outer_from, $j;
1933 # FIXME - this should be obviated by SQLA2, as I'll be able to
1934 # have restrict_inner and restrict_outer... or something to that
1935 # effect... I think...
1937 # FIXME2 - I can't find a clean way to determine if a particular join
1938 # is a multi - instead I am just treating everything as a potential
1939 # explosive join (ribasushi)
1941 # if (my $handle = $j->[0]{-source_handle}) {
1942 # my $rsrc = $handle->resolve;
1943 # ... need to bail out of the following if this is not a multi,
1944 # as it will be much easier on the db ...
1946 $outer_attrs->{group_by} ||= $outer_select;
1951 # demote the outer_from head
1952 $outer_from[0] = $outer_from[0][0];
1954 # This is totally horrific - the $where ends up in both the inner and outer query
1955 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1956 # then if where conditions apply to the *right* side of the prefetch, you may have
1957 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1958 # the outer select to exclude joins you didin't want in the first place
1960 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1961 return (\@outer_from, $outer_select, $where, $outer_attrs);
1964 sub _resolve_ident_sources {
1965 my ($self, $ident) = @_;
1967 my $alias2source = {};
1970 # the reason this is so contrived is that $ident may be a {from}
1971 # structure, specifying multiple tables to join
1972 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1973 # this is compat mode for insert/update/delete which do not deal with aliases
1974 $alias2source->{me} = $ident;
1977 elsif (ref $ident eq 'ARRAY') {
1981 if (ref $_ eq 'HASH') {
1983 $rs_alias = $tabinfo->{-alias};
1985 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1989 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1990 if ($tabinfo->{-source_handle});
1994 return ($alias2source, $rs_alias);
1997 # Takes $ident, \@column_names
1999 # returns { $column_name => \%column_info, ... }
2000 # also note: this adds -result_source => $rsrc to the column info
2003 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
2004 sub _resolve_column_info {
2005 my ($self, $ident, $colnames) = @_;
2006 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
2008 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
2011 my (%return, %seen_cols);
2013 # compile a global list of column names, to be able to properly
2014 # disambiguate unqualified column names (if at all possible)
2015 for my $alias (keys %$alias2src) {
2016 my $rsrc = $alias2src->{$alias};
2017 for my $colname ($rsrc->columns) {
2018 push @{$seen_cols{$colname}}, $alias;
2023 foreach my $col (@$colnames) {
2024 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
2027 # see if the column was seen exactly once (so we know which rsrc it came from)
2028 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
2029 $alias = $seen_cols{$colname}[0];
2036 my $rsrc = $alias2src->{$alias};
2037 $return{$col} = $rsrc && {
2038 %{$rsrc->column_info($colname)},
2039 -result_source => $rsrc,
2040 -source_alias => $alias,
2047 # Returns a counting SELECT for a simple count
2048 # query. Abstracted so that a storage could override
2049 # this to { count => 'firstcol' } or whatever makes
2050 # sense as a performance optimization
2052 #my ($self, $source, $rs_attrs) = @_;
2053 return { count => '*' };
2056 # Returns a SELECT which will end up in the subselect
2057 # There may or may not be a group_by, as the subquery
2058 # might have been called to accomodate a limit
2060 # Most databases would be happy with whatever ends up
2061 # here, but some choke in various ways.
2063 sub _subq_count_select {
2064 my ($self, $source, $rs_attrs) = @_;
2065 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
2067 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
2068 return @pcols ? \@pcols : [ 1 ];
2071 sub source_bind_attributes {
2072 my ($self, $source) = @_;
2074 my $bind_attributes;
2075 foreach my $column ($source->columns) {
2077 my $data_type = $source->column_info($column)->{data_type} || '';
2078 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2082 return $bind_attributes;
2089 =item Arguments: $ident, $select, $condition, $attrs
2093 Handle a SQL select statement.
2099 my ($ident, $select, $condition, $attrs) = @_;
2100 return $self->cursor_class->new($self, \@_, $attrs);
2105 my ($rv, $sth, @bind) = $self->_select(@_);
2106 my @row = $sth->fetchrow_array;
2107 my @nextrow = $sth->fetchrow_array if @row;
2108 if(@row && @nextrow) {
2109 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2111 # Need to call finish() to work round broken DBDs
2120 =item Arguments: $sql
2124 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2129 my ($self, $dbh, $sql) = @_;
2131 # 3 is the if_active parameter which avoids active sth re-use
2132 my $sth = $self->disable_sth_caching
2133 ? $dbh->prepare($sql)
2134 : $dbh->prepare_cached($sql, {}, 3);
2136 # XXX You would think RaiseError would make this impossible,
2137 # but apparently that's not true :(
2138 $self->throw_exception($dbh->errstr) if !$sth;
2144 my ($self, $sql) = @_;
2145 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2148 sub _dbh_columns_info_for {
2149 my ($self, $dbh, $table) = @_;
2151 if ($dbh->can('column_info')) {
2154 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2155 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2157 while ( my $info = $sth->fetchrow_hashref() ){
2159 $column_info{data_type} = $info->{TYPE_NAME};
2160 $column_info{size} = $info->{COLUMN_SIZE};
2161 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2162 $column_info{default_value} = $info->{COLUMN_DEF};
2163 my $col_name = $info->{COLUMN_NAME};
2164 $col_name =~ s/^\"(.*)\"$/$1/;
2166 $result{$col_name} = \%column_info;
2169 return \%result if !$@ && scalar keys %result;
2173 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2175 my @columns = @{$sth->{NAME_lc}};
2176 for my $i ( 0 .. $#columns ){
2178 $column_info{data_type} = $sth->{TYPE}->[$i];
2179 $column_info{size} = $sth->{PRECISION}->[$i];
2180 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2182 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2183 $column_info{data_type} = $1;
2184 $column_info{size} = $2;
2187 $result{$columns[$i]} = \%column_info;
2191 foreach my $col (keys %result) {
2192 my $colinfo = $result{$col};
2193 my $type_num = $colinfo->{data_type};
2195 if(defined $type_num && $dbh->can('type_info')) {
2196 my $type_info = $dbh->type_info($type_num);
2197 $type_name = $type_info->{TYPE_NAME} if $type_info;
2198 $colinfo->{data_type} = $type_name if $type_name;
2205 sub columns_info_for {
2206 my ($self, $table) = @_;
2207 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2210 =head2 last_insert_id
2212 Return the row id of the last insert.
2216 sub _dbh_last_insert_id {
2217 # All Storage's need to register their own _dbh_last_insert_id
2218 # the old SQLite-based method was highly inappropriate
2221 my $class = ref $self;
2222 $self->throw_exception (<<EOE);
2224 No _dbh_last_insert_id() method found in $class.
2225 Since the method of obtaining the autoincrement id of the last insert
2226 operation varies greatly between different databases, this method must be
2227 individually implemented for every storage class.
2231 sub last_insert_id {
2233 $self->_dbh_last_insert_id ($self->_dbh, @_);
2236 =head2 _native_data_type
2240 =item Arguments: $type_name
2244 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2245 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2246 L<::Sybase|DBIx::Class::Storage::DBI::Sybase>.
2248 The default implementation returns C<undef>, implement in your Storage driver if
2249 you need this functionality.
2251 Should map types from other databases to the native RDBMS type, for example
2252 C<VARCHAR2> to C<VARCHAR>.
2254 Types with modifiers should map to the underlying data type. For example,
2255 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2257 Composite types should map to the container type, for example
2258 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2262 sub _native_data_type {
2263 #my ($self, $data_type) = @_;
2267 # Check if placeholders are supported at all
2268 sub _placeholders_supported {
2270 my $dbh = $self->_get_dbh;
2272 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2273 # but it is inaccurate more often than not
2275 local $dbh->{PrintError} = 0;
2276 local $dbh->{RaiseError} = 1;
2277 $dbh->do('select ?', {}, 1);
2282 # Check if placeholders bound to non-string types throw exceptions
2284 sub _typeless_placeholders_supported {
2286 my $dbh = $self->_get_dbh;
2289 local $dbh->{PrintError} = 0;
2290 local $dbh->{RaiseError} = 1;
2291 # this specifically tests a bind that is NOT a string
2292 $dbh->do('select 1 where 1 = ?', {}, 1);
2299 Returns the database driver name.
2306 if (not $self->_driver_determined) {
2307 $self->_determine_driver;
2308 goto $self->can ('sqlt_type');
2311 $self->_get_dbh->{Driver}->{Name};
2314 =head2 bind_attribute_by_data_type
2316 Given a datatype from column info, returns a database specific bind
2317 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2318 let the database planner just handle it.
2320 Generally only needed for special case column types, like bytea in postgres.
2324 sub bind_attribute_by_data_type {
2328 =head2 is_datatype_numeric
2330 Given a datatype from column_info, returns a boolean value indicating if
2331 the current RDBMS considers it a numeric value. This controls how
2332 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2333 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2334 be performed instead of the usual C<eq>.
2338 sub is_datatype_numeric {
2339 my ($self, $dt) = @_;
2341 return 0 unless $dt;
2343 return $dt =~ /^ (?:
2344 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2349 =head2 create_ddl_dir (EXPERIMENTAL)
2353 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2357 Creates a SQL file based on the Schema, for each of the specified
2358 database engines in C<\@databases> in the given directory.
2359 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2361 Given a previous version number, this will also create a file containing
2362 the ALTER TABLE statements to transform the previous schema into the
2363 current one. Note that these statements may contain C<DROP TABLE> or
2364 C<DROP COLUMN> statements that can potentially destroy data.
2366 The file names are created using the C<ddl_filename> method below, please
2367 override this method in your schema if you would like a different file
2368 name format. For the ALTER file, the same format is used, replacing
2369 $version in the name with "$preversion-$version".
2371 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2372 The most common value for this would be C<< { add_drop_table => 1 } >>
2373 to have the SQL produced include a C<DROP TABLE> statement for each table
2374 created. For quoting purposes supply C<quote_table_names> and
2375 C<quote_field_names>.
2377 If no arguments are passed, then the following default values are assumed:
2381 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2383 =item version - $schema->schema_version
2385 =item directory - './'
2387 =item preversion - <none>
2391 By default, C<\%sqlt_args> will have
2393 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2395 merged with the hash passed in. To disable any of those features, pass in a
2396 hashref like the following
2398 { ignore_constraint_names => 0, # ... other options }
2401 Note that this feature is currently EXPERIMENTAL and may not work correctly
2402 across all databases, or fully handle complex relationships.
2404 WARNING: Please check all SQL files created, before applying them.
2408 sub create_ddl_dir {
2409 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2411 if(!$dir || !-d $dir) {
2412 carp "No directory given, using ./\n";
2415 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2416 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2418 my $schema_version = $schema->schema_version || '1.x';
2419 $version ||= $schema_version;
2422 add_drop_table => 1,
2423 ignore_constraint_names => 1,
2424 ignore_index_names => 1,
2428 $self->throw_exception("Can't create a ddl file without SQL::Translator: " . $self->_sqlt_version_error)
2429 if !$self->_sqlt_version_ok;
2431 my $sqlt = SQL::Translator->new( $sqltargs );
2433 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2434 my $sqlt_schema = $sqlt->translate({ data => $schema })
2435 or $self->throw_exception ($sqlt->error);
2437 foreach my $db (@$databases) {
2439 $sqlt->{schema} = $sqlt_schema;
2440 $sqlt->producer($db);
2443 my $filename = $schema->ddl_filename($db, $version, $dir);
2444 if (-e $filename && ($version eq $schema_version )) {
2445 # if we are dumping the current version, overwrite the DDL
2446 carp "Overwriting existing DDL file - $filename";
2450 my $output = $sqlt->translate;
2452 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2455 if(!open($file, ">$filename")) {
2456 $self->throw_exception("Can't open $filename for writing ($!)");
2459 print $file $output;
2462 next unless ($preversion);
2464 require SQL::Translator::Diff;
2466 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2467 if(!-e $prefilename) {
2468 carp("No previous schema file found ($prefilename)");
2472 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2474 carp("Overwriting existing diff file - $difffile");
2480 my $t = SQL::Translator->new($sqltargs);
2485 or $self->throw_exception ($t->error);
2487 my $out = $t->translate( $prefilename )
2488 or $self->throw_exception ($t->error);
2490 $source_schema = $t->schema;
2492 $source_schema->name( $prefilename )
2493 unless ( $source_schema->name );
2496 # The "new" style of producers have sane normalization and can support
2497 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2498 # And we have to diff parsed SQL against parsed SQL.
2499 my $dest_schema = $sqlt_schema;
2501 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2502 my $t = SQL::Translator->new($sqltargs);
2507 or $self->throw_exception ($t->error);
2509 my $out = $t->translate( $filename )
2510 or $self->throw_exception ($t->error);
2512 $dest_schema = $t->schema;
2514 $dest_schema->name( $filename )
2515 unless $dest_schema->name;
2518 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2522 if(!open $file, ">$difffile") {
2523 $self->throw_exception("Can't write to $difffile ($!)");
2531 =head2 deployment_statements
2535 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2539 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2541 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2542 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2544 C<$directory> is used to return statements from files in a previously created
2545 L</create_ddl_dir> directory and is optional. The filenames are constructed
2546 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2548 If no C<$directory> is specified then the statements are constructed on the
2549 fly using L<SQL::Translator> and C<$version> is ignored.
2551 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2555 sub deployment_statements {
2556 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2557 $type ||= $self->sqlt_type;
2558 $version ||= $schema->schema_version || '1.x';
2560 my $filename = $schema->ddl_filename($type, $version, $dir);
2564 open($file, "<$filename")
2565 or $self->throw_exception("Can't open $filename ($!)");
2568 return join('', @rows);
2571 $self->throw_exception("Can't deploy without either SQL::Translator or a ddl_dir: " . $self->_sqlt_version_error )
2572 if !$self->_sqlt_version_ok;
2574 # sources needs to be a parser arg, but for simplicty allow at top level
2576 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2577 if exists $sqltargs->{sources};
2579 my $tr = SQL::Translator->new(
2580 producer => "SQL::Translator::Producer::${type}",
2582 parser => 'SQL::Translator::Parser::DBIx::Class',
2585 return $tr->translate;
2589 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2592 return if($line =~ /^--/);
2594 # next if($line =~ /^DROP/m);
2595 return if($line =~ /^BEGIN TRANSACTION/m);
2596 return if($line =~ /^COMMIT/m);
2597 return if $line =~ /^\s+$/; # skip whitespace only
2598 $self->_query_start($line);
2600 # do a dbh_do cycle here, as we need some error checking in
2601 # place (even though we will ignore errors)
2602 $self->dbh_do (sub { $_[1]->do($line) });
2605 carp qq{$@ (running "${line}")};
2607 $self->_query_end($line);
2609 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2610 if (@statements > 1) {
2611 foreach my $statement (@statements) {
2612 $deploy->( $statement );
2615 elsif (@statements == 1) {
2616 foreach my $line ( split(";\n", $statements[0])) {
2622 =head2 datetime_parser
2624 Returns the datetime parser class
2628 sub datetime_parser {
2630 return $self->{datetime_parser} ||= do {
2631 $self->build_datetime_parser(@_);
2635 =head2 datetime_parser_type
2637 Defines (returns) the datetime parser class - currently hardwired to
2638 L<DateTime::Format::MySQL>
2642 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2644 =head2 build_datetime_parser
2646 See L</datetime_parser>
2650 sub build_datetime_parser {
2651 if (not $_[0]->_driver_determined) {
2652 $_[0]->_determine_driver;
2653 goto $_[0]->can('build_datetime_parser');
2657 my $type = $self->datetime_parser_type(@_);
2658 $self->ensure_class_loaded ($type);
2663 =head2 is_replicating
2665 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2666 replicate from a master database. Default is undef, which is the result
2667 returned by databases that don't support replication.
2671 sub is_replicating {
2676 =head2 lag_behind_master
2678 Returns a number that represents a certain amount of lag behind a master db
2679 when a given storage is replicating. The number is database dependent, but
2680 starts at zero and increases with the amount of lag. Default in undef
2684 sub lag_behind_master {
2688 # SQLT version handling
2690 my $_sqlt_version_ok; # private
2691 my $_sqlt_version_error; # private
2693 sub _sqlt_version_ok {
2694 if (!defined $_sqlt_version_ok) {
2695 eval "use SQL::Translator $minimum_sqlt_version";
2697 $_sqlt_version_ok = 0;
2698 $_sqlt_version_error = $@;
2701 $_sqlt_version_ok = 1;
2704 return $_sqlt_version_ok;
2707 sub _sqlt_version_error {
2708 shift->_sqlt_version_ok unless defined $_sqlt_version_ok;
2709 return $_sqlt_version_error;
2712 sub _sqlt_minimum_version { $minimum_sqlt_version };
2718 $self->_verify_pid if $self->_dbh;
2720 # some databases need this to stop spewing warnings
2721 if (my $dbh = $self->_dbh) {
2723 eval { $dbh->disconnect };
2733 =head2 DBIx::Class and AutoCommit
2735 DBIx::Class can do some wonderful magic with handling exceptions,
2736 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2737 (the default) combined with C<txn_do> for transaction support.
2739 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2740 in an assumed transaction between commits, and you're telling us you'd
2741 like to manage that manually. A lot of the magic protections offered by
2742 this module will go away. We can't protect you from exceptions due to database
2743 disconnects because we don't know anything about how to restart your
2744 transactions. You're on your own for handling all sorts of exceptional
2745 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2751 Matt S. Trout <mst@shadowcatsystems.co.uk>
2753 Andy Grundman <andy@hybridized.org>
2757 You may distribute this code under the same terms as Perl itself.