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 __PACKAGE__->mk_group_accessors('simple' =>
18 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
19 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
22 # the values for these accessors are picked out (and deleted) from
23 # the attribute hashref passed to connect_info
24 my @storage_options = qw/
25 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
26 disable_sth_caching unsafe auto_savepoint
28 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
31 # default cursor class, overridable in connect_info attributes
32 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
34 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
35 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 DBIx::Class::Storage::DBI - DBI storage handler
44 my $schema = MySchema->connect('dbi:SQLite:my.db');
46 $schema->storage->debug(1);
48 my @stuff = $schema->storage->dbh_do(
50 my ($storage, $dbh, @args) = @_;
51 $dbh->do("DROP TABLE authors");
56 $schema->resultset('Book')->search({
57 written_on => $schema->storage->datetime_parser(DateTime->now)
62 This class represents the connection to an RDBMS via L<DBI>. See
63 L<DBIx::Class::Storage> for general information. This pod only
64 documents DBI-specific methods and behaviors.
71 my $new = shift->next::method(@_);
73 $new->transaction_depth(0);
74 $new->_sql_maker_opts({});
75 $new->{savepoints} = [];
76 $new->{_in_dbh_do} = 0;
84 This method is normally called by L<DBIx::Class::Schema/connection>, which
85 encapsulates its argument list in an arrayref before passing them here.
87 The argument list may contain:
93 The same 4-element argument set one would normally pass to
94 L<DBI/connect>, optionally followed by
95 L<extra attributes|/DBIx::Class specific connection attributes>
96 recognized by DBIx::Class:
98 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
102 A single code reference which returns a connected
103 L<DBI database handle|DBI/connect> optionally followed by
104 L<extra attributes|/DBIx::Class specific connection attributes> recognized
107 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
111 A single hashref with all the attributes and the dsn/user/password
114 $connect_info_args = [{
122 $connect_info_args = [{
123 dbh_maker => sub { DBI->connect (...) },
128 This is particularly useful for L<Catalyst> based applications, allowing the
129 following config (L<Config::General> style):
134 dsn dbi:mysql:database=test
141 The C<dsn>/C<user>/C<password> combination can be substituted by the
142 C<dbh_maker> key whose value is a coderef that returns a connected
143 L<DBI database handle|DBI/connect>
147 Please note that the L<DBI> docs recommend that you always explicitly
148 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
149 recommends that it be set to I<1>, and that you perform transactions
150 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
151 to I<1> if you do not do explicitly set it to zero. This is the default
152 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
154 =head3 DBIx::Class specific connection attributes
156 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
157 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
158 the following connection options. These options can be mixed in with your other
159 L<DBI> connection attributes, or placed in a seperate hashref
160 (C<\%extra_attributes>) as shown above.
162 Every time C<connect_info> is invoked, any previous settings for
163 these options will be cleared before setting the new ones, regardless of
164 whether any options are specified in the new C<connect_info>.
171 Specifies things to do immediately after connecting or re-connecting to
172 the database. Its value may contain:
178 This contains one SQL statement to execute.
180 =item an array reference
182 This contains SQL statements to execute in order. Each element contains
183 a string or a code reference that returns a string.
185 =item a code reference
187 This contains some code to execute. Unlike code references within an
188 array reference, its return value is ignored.
192 =item on_disconnect_do
194 Takes arguments in the same form as L</on_connect_do> and executes them
195 immediately before disconnecting from the database.
197 Note, this only runs if you explicitly call L</disconnect> on the
200 =item on_connect_call
202 A more generalized form of L</on_connect_do> that calls the specified
203 C<connect_call_METHOD> methods in your storage driver.
205 on_connect_do => 'select 1'
209 on_connect_call => [ [ do_sql => 'select 1' ] ]
211 Its values may contain:
217 Will call the C<connect_call_METHOD> method.
219 =item a code reference
221 Will execute C<< $code->($storage) >>
223 =item an array reference
225 Each value can be a method name or code reference.
227 =item an array of arrays
229 For each array, the first item is taken to be the C<connect_call_> method name
230 or code reference, and the rest are parameters to it.
234 Some predefined storage methods you may use:
240 Executes a SQL string or a code reference that returns a SQL string. This is
241 what L</on_connect_do> and L</on_disconnect_do> use.
249 Will execute the scalar as SQL.
253 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
254 attributes hashref and bind values.
256 =item a code reference
258 Will execute C<< $code->($storage) >> and execute the return array refs as
265 Execute any statements necessary to initialize the database session to return
266 and accept datetime/timestamp values used with
267 L<DBIx::Class::InflateColumn::DateTime>.
269 Only necessary for some databases, see your specific storage driver for
270 implementation details.
274 =item on_disconnect_call
276 Takes arguments in the same form as L</on_connect_call> and executes them
277 immediately before disconnecting from the database.
279 Calls the C<disconnect_call_METHOD> methods as opposed to the
280 C<connect_call_METHOD> methods called by L</on_connect_call>.
282 Note, this only runs if you explicitly call L</disconnect> on the
285 =item disable_sth_caching
287 If set to a true value, this option will disable the caching of
288 statement handles via L<DBI/prepare_cached>.
292 Sets the limit dialect. This is useful for JDBC-bridge among others
293 where the remote SQL-dialect cannot be determined by the name of the
294 driver alone. See also L<SQL::Abstract::Limit>.
298 Specifies what characters to use to quote table and column names. If
299 you use this you will want to specify L</name_sep> as well.
301 C<quote_char> expects either a single character, in which case is it
302 is placed on either side of the table/column name, or an arrayref of length
303 2 in which case the table/column name is placed between the elements.
305 For example under MySQL you should use C<< quote_char => '`' >>, and for
306 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
310 This only needs to be used in conjunction with C<quote_char>, and is used to
311 specify the charecter that seperates elements (schemas, tables, columns) from
312 each other. In most cases this is simply a C<.>.
314 The consequences of not supplying this value is that L<SQL::Abstract>
315 will assume DBIx::Class' uses of aliases to be complete column
316 names. The output will look like I<"me.name"> when it should actually
321 This Storage driver normally installs its own C<HandleError>, sets
322 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
323 all database handles, including those supplied by a coderef. It does this
324 so that it can have consistent and useful error behavior.
326 If you set this option to a true value, Storage will not do its usual
327 modifications to the database handle's attributes, and instead relies on
328 the settings in your connect_info DBI options (or the values you set in
329 your connection coderef, in the case that you are connecting via coderef).
331 Note that your custom settings can cause Storage to malfunction,
332 especially if you set a C<HandleError> handler that suppresses exceptions
333 and/or disable C<RaiseError>.
337 If this option is true, L<DBIx::Class> will use savepoints when nesting
338 transactions, making it possible to recover from failure in the inner
339 transaction without having to abort all outer transactions.
343 Use this argument to supply a cursor class other than the default
344 L<DBIx::Class::Storage::DBI::Cursor>.
348 Some real-life examples of arguments to L</connect_info> and
349 L<DBIx::Class::Schema/connect>
351 # Simple SQLite connection
352 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
355 ->connect_info([ sub { DBI->connect(...) } ]);
357 # Connect via subref in hashref
359 dbh_maker => sub { DBI->connect(...) },
360 on_connect_do => 'alter session ...',
363 # A bit more complicated
370 { quote_char => q{"}, name_sep => q{.} },
374 # Equivalent to the previous example
380 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
384 # Same, but with hashref as argument
385 # See parse_connect_info for explanation
388 dsn => 'dbi:Pg:dbname=foo',
390 password => 'my_pg_password',
397 # Subref + DBIx::Class-specific connection options
400 sub { DBI->connect(...) },
404 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
405 disable_sth_caching => 1,
415 my ($self, $info_arg) = @_;
417 return $self->_connect_info if !$info_arg;
419 my @args = @$info_arg; # take a shallow copy for further mutilation
420 $self->_connect_info([@args]); # copy for _connect_info
423 # combine/pre-parse arguments depending on invocation style
426 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
427 %attrs = %{ $args[1] || {} };
430 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
431 %attrs = %{$args[0]};
433 if (my $code = delete $attrs{dbh_maker}) {
436 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
439 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
440 . "to the result of 'dbh_maker'",
442 join (', ', map { "'$_'" } (@ignored) ),
447 @args = delete @attrs{qw/dsn user password/};
450 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
452 % { $args[3] || {} },
453 % { $args[4] || {} },
455 @args = @args[0,1,2];
458 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
459 # the new set of options
460 $self->_sql_maker(undef);
461 $self->_sql_maker_opts({});
464 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
465 if(my $value = delete $attrs{$storage_opt}) {
466 $self->$storage_opt($value);
469 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
470 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
471 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
476 if (ref $args[0] eq 'CODE') {
477 # _connect() never looks past $args[0] in this case
481 %{ $self->_default_dbi_connect_attributes || {} },
486 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
487 $self->_connect_info;
490 sub _default_dbi_connect_attributes {
500 This method is deprecated in favour of setting via L</connect_info>.
504 =head2 on_disconnect_do
506 This method is deprecated in favour of setting via L</connect_info>.
510 sub _parse_connect_do {
511 my ($self, $type) = @_;
513 my $val = $self->$type;
514 return () if not defined $val;
519 push @res, [ 'do_sql', $val ];
520 } elsif (ref($val) eq 'CODE') {
522 } elsif (ref($val) eq 'ARRAY') {
523 push @res, map { [ 'do_sql', $_ ] } @$val;
525 $self->throw_exception("Invalid type for $type: ".ref($val));
533 Arguments: ($subref | $method_name), @extra_coderef_args?
535 Execute the given $subref or $method_name using the new exception-based
536 connection management.
538 The first two arguments will be the storage object that C<dbh_do> was called
539 on and a database handle to use. Any additional arguments will be passed
540 verbatim to the called subref as arguments 2 and onwards.
542 Using this (instead of $self->_dbh or $self->dbh) ensures correct
543 exception handling and reconnection (or failover in future subclasses).
545 Your subref should have no side-effects outside of the database, as
546 there is the potential for your subref to be partially double-executed
547 if the database connection was stale/dysfunctional.
551 my @stuff = $schema->storage->dbh_do(
553 my ($storage, $dbh, @cols) = @_;
554 my $cols = join(q{, }, @cols);
555 $dbh->selectrow_array("SELECT $cols FROM foo");
566 my $dbh = $self->_dbh;
568 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
569 || $self->{transaction_depth};
571 local $self->{_in_dbh_do} = 1;
574 my $want_array = wantarray;
577 $self->_verify_pid if $dbh;
579 $self->_populate_dbh;
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;
628 $self->_verify_pid if $self->_dbh;
629 $self->_populate_dbh if !$self->_dbh;
633 @result = $coderef->(@_);
635 elsif(defined $want_array) {
636 $result[0] = $coderef->(@_);
644 # ->connected might unset $@ - copy
646 if(!$exception) { return $want_array ? @result : $result[0] }
648 if($tried++ || $self->connected) {
649 eval { $self->txn_rollback };
650 my $rollback_exception = $@;
651 if($rollback_exception) {
652 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
653 $self->throw_exception($exception) # propagate nested rollback
654 if $rollback_exception =~ /$exception_class/;
656 $self->throw_exception(
657 "Transaction aborted: ${exception}. "
658 . "Rollback failed: ${rollback_exception}"
661 $self->throw_exception($exception)
664 # We were not connected, and was first try - reconnect and retry
666 carp "Retrying $coderef after catching disconnected exception: $exception"
667 if $ENV{DBIC_DBIRETRY_DEBUG};
668 $self->_populate_dbh;
674 Our C<disconnect> method also performs a rollback first if the
675 database is not in C<AutoCommit> mode.
685 push @actions, ( $self->on_disconnect_call || () );
686 push @actions, $self->_parse_connect_do ('on_disconnect_do');
688 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
690 $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->_populate_dbh unless $self->_dbh;
822 sub _sql_maker_args {
827 array_datatypes => 1,
828 limit_dialect => $self->_get_dbh,
829 %{$self->_sql_maker_opts}
835 unless ($self->_sql_maker) {
836 my $sql_maker_class = $self->sql_maker_class;
837 $self->ensure_class_loaded ($sql_maker_class);
838 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
840 return $self->_sql_maker;
848 my @info = @{$self->_dbi_connect_info || []};
849 $self->_dbh(undef); # in case ->connected failed we might get sent here
850 $self->_dbh($self->_connect(@info));
852 $self->_conn_pid($$);
853 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
855 $self->_determine_driver;
857 # Always set the transaction depth on connect, since
858 # there is no transaction in progress by definition
859 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
861 $self->_run_connection_actions unless $self->{_in_determine_driver};
864 sub _run_connection_actions {
868 push @actions, ( $self->on_connect_call || () );
869 push @actions, $self->_parse_connect_do ('on_connect_do');
871 $self->_do_connection_actions(connect_call_ => $_) for @actions;
874 sub _determine_driver {
877 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
878 my $started_unconnected = 0;
879 local $self->{_in_determine_driver} = 1;
881 if (ref($self) eq __PACKAGE__) {
883 if ($self->_dbh) { # we are connected
884 $driver = $self->_dbh->{Driver}{Name};
886 # if connect_info is a CODEREF, we have no choice but to connect
887 if (ref $self->_dbi_connect_info->[0] &&
888 Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
889 $self->_populate_dbh;
890 $driver = $self->_dbh->{Driver}{Name};
893 # try to use dsn to not require being connected, the driver may still
894 # force a connection in _rebless to determine version
895 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
896 $started_unconnected = 1;
900 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
901 if ($self->load_optional_class($storage_class)) {
902 mro::set_mro($storage_class, 'c3');
903 bless $self, $storage_class;
908 $self->_driver_determined(1);
910 $self->_run_connection_actions
911 if $started_unconnected && defined $self->_dbh;
915 sub _do_connection_actions {
917 my $method_prefix = shift;
920 if (not ref($call)) {
921 my $method = $method_prefix . $call;
923 } elsif (ref($call) eq 'CODE') {
925 } elsif (ref($call) eq 'ARRAY') {
926 if (ref($call->[0]) ne 'ARRAY') {
927 $self->_do_connection_actions($method_prefix, $_) for @$call;
929 $self->_do_connection_actions($method_prefix, @$_) for @$call;
932 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
938 sub connect_call_do_sql {
940 $self->_do_query(@_);
943 sub disconnect_call_do_sql {
945 $self->_do_query(@_);
948 # override in db-specific backend when necessary
949 sub connect_call_datetime_setup { 1 }
952 my ($self, $action) = @_;
954 if (ref $action eq 'CODE') {
955 $action = $action->($self);
956 $self->_do_query($_) foreach @$action;
959 # Most debuggers expect ($sql, @bind), so we need to exclude
960 # the attribute hash which is the second argument to $dbh->do
961 # furthermore the bind values are usually to be presented
962 # as named arrayref pairs, so wrap those here too
963 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
964 my $sql = shift @do_args;
965 my $attrs = shift @do_args;
966 my @bind = map { [ undef, $_ ] } @do_args;
968 $self->_query_start($sql, @bind);
969 $self->_dbh->do($sql, $attrs, @do_args);
970 $self->_query_end($sql, @bind);
977 my ($self, @info) = @_;
979 $self->throw_exception("You failed to provide any connection info")
982 my ($old_connect_via, $dbh);
984 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
985 $old_connect_via = $DBI::connect_via;
986 $DBI::connect_via = 'connect';
990 if(ref $info[0] eq 'CODE') {
994 $dbh = DBI->connect(@info);
997 if($dbh && !$self->unsafe) {
998 my $weak_self = $self;
999 Scalar::Util::weaken($weak_self);
1000 $dbh->{HandleError} = sub {
1002 $weak_self->throw_exception("DBI Exception: $_[0]");
1005 croak ("DBI Exception: $_[0]");
1008 $dbh->{ShowErrorStatement} = 1;
1009 $dbh->{RaiseError} = 1;
1010 $dbh->{PrintError} = 0;
1014 $DBI::connect_via = $old_connect_via if $old_connect_via;
1016 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1019 $self->_dbh_autocommit($dbh->{AutoCommit});
1025 my ($self, $name) = @_;
1027 $name = $self->_svp_generate_name
1028 unless defined $name;
1030 $self->throw_exception ("You can't use savepoints outside a transaction")
1031 if $self->{transaction_depth} == 0;
1033 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1034 unless $self->can('_svp_begin');
1036 push @{ $self->{savepoints} }, $name;
1038 $self->debugobj->svp_begin($name) if $self->debug;
1040 return $self->_svp_begin($name);
1044 my ($self, $name) = @_;
1046 $self->throw_exception ("You can't use savepoints outside a transaction")
1047 if $self->{transaction_depth} == 0;
1049 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1050 unless $self->can('_svp_release');
1052 if (defined $name) {
1053 $self->throw_exception ("Savepoint '$name' does not exist")
1054 unless grep { $_ eq $name } @{ $self->{savepoints} };
1056 # Dig through the stack until we find the one we are releasing. This keeps
1057 # the stack up to date.
1060 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1062 $name = pop @{ $self->{savepoints} };
1065 $self->debugobj->svp_release($name) if $self->debug;
1067 return $self->_svp_release($name);
1071 my ($self, $name) = @_;
1073 $self->throw_exception ("You can't use savepoints outside a transaction")
1074 if $self->{transaction_depth} == 0;
1076 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1077 unless $self->can('_svp_rollback');
1079 if (defined $name) {
1080 # If they passed us a name, verify that it exists in the stack
1081 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1082 $self->throw_exception("Savepoint '$name' does not exist!");
1085 # Dig through the stack until we find the one we are releasing. This keeps
1086 # the stack up to date.
1087 while(my $s = pop(@{ $self->{savepoints} })) {
1088 last if($s eq $name);
1090 # Add the savepoint back to the stack, as a rollback doesn't remove the
1091 # named savepoint, only everything after it.
1092 push(@{ $self->{savepoints} }, $name);
1094 # We'll assume they want to rollback to the last savepoint
1095 $name = $self->{savepoints}->[-1];
1098 $self->debugobj->svp_rollback($name) if $self->debug;
1100 return $self->_svp_rollback($name);
1103 sub _svp_generate_name {
1106 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1111 if($self->{transaction_depth} == 0) {
1112 $self->debugobj->txn_begin()
1115 # being here implies we have AutoCommit => 1
1116 # if the user is utilizing txn_do - good for
1117 # him, otherwise we need to ensure that the
1118 # $dbh is healthy on BEGIN
1119 my $dbh_method = $self->{_in_dbh_do} ? '_dbh' : 'dbh';
1120 $self->$dbh_method->begin_work;
1122 } elsif ($self->auto_savepoint) {
1125 $self->{transaction_depth}++;
1130 if ($self->{transaction_depth} == 1) {
1131 my $dbh = $self->_dbh;
1132 $self->debugobj->txn_commit()
1135 $self->{transaction_depth} = 0
1136 if $self->_dbh_autocommit;
1138 elsif($self->{transaction_depth} > 1) {
1139 $self->{transaction_depth}--;
1141 if $self->auto_savepoint;
1147 my $dbh = $self->_dbh;
1149 if ($self->{transaction_depth} == 1) {
1150 $self->debugobj->txn_rollback()
1152 $self->{transaction_depth} = 0
1153 if $self->_dbh_autocommit;
1156 elsif($self->{transaction_depth} > 1) {
1157 $self->{transaction_depth}--;
1158 if ($self->auto_savepoint) {
1159 $self->svp_rollback;
1164 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1169 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1170 $error =~ /$exception_class/ and $self->throw_exception($error);
1171 # ensure that a failed rollback resets the transaction depth
1172 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1173 $self->throw_exception($error);
1177 # This used to be the top-half of _execute. It was split out to make it
1178 # easier to override in NoBindVars without duping the rest. It takes up
1179 # all of _execute's args, and emits $sql, @bind.
1180 sub _prep_for_execute {
1181 my ($self, $op, $extra_bind, $ident, $args) = @_;
1183 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1184 $ident = $ident->from();
1187 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1190 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1192 return ($sql, \@bind);
1196 sub _fix_bind_params {
1197 my ($self, @bind) = @_;
1199 ### Turn @bind from something like this:
1200 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1202 ### ( "'1'", "'1'", "'3'" )
1205 if ( defined( $_ && $_->[1] ) ) {
1206 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1213 my ( $self, $sql, @bind ) = @_;
1215 if ( $self->debug ) {
1216 @bind = $self->_fix_bind_params(@bind);
1218 $self->debugobj->query_start( $sql, @bind );
1223 my ( $self, $sql, @bind ) = @_;
1225 if ( $self->debug ) {
1226 @bind = $self->_fix_bind_params(@bind);
1227 $self->debugobj->query_end( $sql, @bind );
1232 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1234 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1236 $self->_query_start( $sql, @$bind );
1238 my $sth = $self->sth($sql,$op);
1240 my $placeholder_index = 1;
1242 foreach my $bound (@$bind) {
1243 my $attributes = {};
1244 my($column_name, @data) = @$bound;
1246 if ($bind_attributes) {
1247 $attributes = $bind_attributes->{$column_name}
1248 if defined $bind_attributes->{$column_name};
1251 foreach my $data (@data) {
1252 my $ref = ref $data;
1253 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1255 $sth->bind_param($placeholder_index, $data, $attributes);
1256 $placeholder_index++;
1260 # Can this fail without throwing an exception anyways???
1261 my $rv = $sth->execute();
1262 $self->throw_exception($sth->errstr) if !$rv;
1264 $self->_query_end( $sql, @$bind );
1266 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1271 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1275 my ($self, $source, $to_insert) = @_;
1277 # redispatch to insert method of storage we reblessed into, if necessary
1278 if (not $self->_driver_determined) {
1279 $self->_determine_driver;
1280 goto $self->can('insert');
1283 my $ident = $source->from;
1284 my $bind_attributes = $self->source_bind_attributes($source);
1286 my $updated_cols = {};
1288 foreach my $col ( $source->columns ) {
1289 if ( !defined $to_insert->{$col} ) {
1290 my $col_info = $source->column_info($col);
1292 if ( $col_info->{auto_nextval} ) {
1293 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1295 $col_info->{sequence} ||
1296 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1302 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1304 return $updated_cols;
1307 ## Still not quite perfect, and EXPERIMENTAL
1308 ## Currently it is assumed that all values passed will be "normal", i.e. not
1309 ## scalar refs, or at least, all the same type as the first set, the statement is
1310 ## only prepped once.
1312 my ($self, $source, $cols, $data) = @_;
1314 # redispatch to insert_bulk method of storage we reblessed into, if necessary
1315 if (not $self->_driver_determined) {
1316 $self->_determine_driver;
1317 goto $self->can('insert_bulk');
1321 my $table = $source->from;
1322 @colvalues{@$cols} = (0..$#$cols);
1323 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1325 $self->_query_start( $sql, @bind );
1326 my $sth = $self->sth($sql);
1328 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1330 ## This must be an arrayref, else nothing works!
1331 my $tuple_status = [];
1333 ## Get the bind_attributes, if any exist
1334 my $bind_attributes = $self->source_bind_attributes($source);
1336 ## Bind the values and execute
1337 my $placeholder_index = 1;
1339 foreach my $bound (@bind) {
1341 my $attributes = {};
1342 my ($column_name, $data_index) = @$bound;
1344 if( $bind_attributes ) {
1345 $attributes = $bind_attributes->{$column_name}
1346 if defined $bind_attributes->{$column_name};
1349 my @data = map { $_->[$data_index] } @$data;
1351 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1352 $placeholder_index++;
1354 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1357 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1359 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1360 if ($i > $#$tuple_status);
1362 require Data::Dumper;
1363 local $Data::Dumper::Terse = 1;
1364 local $Data::Dumper::Indent = 1;
1365 local $Data::Dumper::Useqq = 1;
1366 local $Data::Dumper::Quotekeys = 0;
1368 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1369 $tuple_status->[$i][1],
1370 Data::Dumper::Dumper(
1371 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1375 $self->throw_exception($sth->errstr) if !$rv;
1377 $self->_query_end( $sql, @bind );
1378 return (wantarray ? ($rv, $sth, @bind) : $rv);
1382 my $self = shift @_;
1383 my $source = shift @_;
1384 $self->_determine_driver;
1385 my $bind_attributes = $self->source_bind_attributes($source);
1387 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1392 my $self = shift @_;
1393 my $source = shift @_;
1394 $self->_determine_driver;
1395 my $bind_attrs = $self->source_bind_attributes($source);
1397 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1400 # We were sent here because the $rs contains a complex search
1401 # which will require a subquery to select the correct rows
1402 # (i.e. joined or limited resultsets)
1404 # Genarating a single PK column subquery is trivial and supported
1405 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1406 # Look at _multipk_update_delete()
1407 sub _subq_update_delete {
1409 my ($rs, $op, $values) = @_;
1411 my $rsrc = $rs->result_source;
1413 # we already check this, but double check naively just in case. Should be removed soon
1414 my $sel = $rs->_resolved_attrs->{select};
1415 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1416 my @pcols = $rsrc->primary_columns;
1417 if (@$sel != @pcols) {
1418 $self->throw_exception (
1419 'Subquery update/delete can not be called on resultsets selecting a'
1420 .' number of columns different than the number of primary keys'
1427 $op eq 'update' ? $values : (),
1428 { $pcols[0] => { -in => $rs->as_query } },
1433 return $self->_multipk_update_delete (@_);
1437 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1438 # resultset update/delete involving subqueries. So by default resort
1439 # to simple (and inefficient) delete_all style per-row opearations,
1440 # while allowing specific storages to override this with a faster
1443 sub _multipk_update_delete {
1444 return shift->_per_row_update_delete (@_);
1447 # This is the default loop used to delete/update rows for multi PK
1448 # resultsets, and used by mysql exclusively (because it can't do anything
1451 # We do not use $row->$op style queries, because resultset update/delete
1452 # is not expected to cascade (this is what delete_all/update_all is for).
1454 # There should be no race conditions as the entire operation is rolled
1457 sub _per_row_update_delete {
1459 my ($rs, $op, $values) = @_;
1461 my $rsrc = $rs->result_source;
1462 my @pcols = $rsrc->primary_columns;
1464 my $guard = $self->txn_scope_guard;
1466 # emulate the return value of $sth->execute for non-selects
1467 my $row_cnt = '0E0';
1469 my $subrs_cur = $rs->cursor;
1470 while (my @pks = $subrs_cur->next) {
1473 for my $i (0.. $#pcols) {
1474 $cond->{$pcols[$i]} = $pks[$i];
1479 $op eq 'update' ? $values : (),
1494 # localization is neccessary as
1495 # 1) there is no infrastructure to pass this around before SQLA2
1496 # 2) _select_args sets it and _prep_for_execute consumes it
1497 my $sql_maker = $self->sql_maker;
1498 local $sql_maker->{_dbic_rs_attrs};
1500 return $self->_execute($self->_select_args(@_));
1503 sub _select_args_to_query {
1506 # localization is neccessary as
1507 # 1) there is no infrastructure to pass this around before SQLA2
1508 # 2) _select_args sets it and _prep_for_execute consumes it
1509 my $sql_maker = $self->sql_maker;
1510 local $sql_maker->{_dbic_rs_attrs};
1512 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1513 # = $self->_select_args($ident, $select, $cond, $attrs);
1514 my ($op, $bind, $ident, $bind_attrs, @args) =
1515 $self->_select_args(@_);
1517 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1518 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1519 $prepared_bind ||= [];
1522 ? ($sql, $prepared_bind, $bind_attrs)
1523 : \[ "($sql)", @$prepared_bind ]
1528 my ($self, $ident, $select, $where, $attrs) = @_;
1530 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1532 my $sql_maker = $self->sql_maker;
1533 $sql_maker->{_dbic_rs_attrs} = {
1539 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1544 # calculate bind_attrs before possible $ident mangling
1545 my $bind_attrs = {};
1546 for my $alias (keys %$alias2source) {
1547 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1548 for my $col (keys %$bindtypes) {
1550 my $fqcn = join ('.', $alias, $col);
1551 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1553 # Unqialified column names are nice, but at the same time can be
1554 # rather ambiguous. What we do here is basically go along with
1555 # the loop, adding an unqualified column slot to $bind_attrs,
1556 # alongside the fully qualified name. As soon as we encounter
1557 # another column by that name (which would imply another table)
1558 # we unset the unqualified slot and never add any info to it
1559 # to avoid erroneous type binding. If this happens the users
1560 # only choice will be to fully qualify his column name
1562 if (exists $bind_attrs->{$col}) {
1563 $bind_attrs->{$col} = {};
1566 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1573 $attrs->{software_limit}
1575 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1577 $attrs->{software_limit} = 1;
1580 $self->throw_exception("rows attribute must be positive if present")
1581 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1583 # MySQL actually recommends this approach. I cringe.
1584 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1589 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1590 # otherwise delegate the limiting to the storage, unless software limit was requested
1592 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1594 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1595 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1597 ($ident, $select, $where, $attrs)
1598 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1600 elsif (! $attrs->{software_limit} ) {
1601 push @limit, $attrs->{rows}, $attrs->{offset};
1605 # This would be the point to deflate anything found in $where
1606 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1607 # expect a row object. And all we have is a resultsource (it is trivial
1608 # to extract deflator coderefs via $alias2source above).
1610 # I don't see a way forward other than changing the way deflators are
1611 # invoked, and that's just bad...
1615 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1616 (qw/order_by group_by having/ )
1619 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1623 # This is the code producing joined subqueries like:
1624 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1626 sub _adjust_select_args_for_complex_prefetch {
1627 my ($self, $from, $select, $where, $attrs) = @_;
1629 $self->throw_exception ('Nothing to prefetch... how did we get here?!')
1630 if not @{$attrs->{_prefetch_select}};
1632 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1633 if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY');
1636 # generate inner/outer attribute lists, remove stuff that doesn't apply
1637 my $outer_attrs = { %$attrs };
1638 delete $outer_attrs->{$_} for qw/where bind rows offset group_by having/;
1640 my $inner_attrs = { %$attrs };
1641 delete $inner_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1644 # bring over all non-collapse-induced order_by into the inner query (if any)
1645 # the outer one will have to keep them all
1646 delete $inner_attrs->{order_by};
1647 if (my $ord_cnt = @{$outer_attrs->{order_by}} - @{$outer_attrs->{_collapse_order_by}} ) {
1648 $inner_attrs->{order_by} = [
1649 @{$outer_attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1654 # generate the inner/outer select lists
1655 # for inside we consider only stuff *not* brought in by the prefetch
1656 # on the outside we substitute any function for its alias
1657 my $outer_select = [ @$select ];
1658 my $inner_select = [];
1659 for my $i (0 .. ( @$outer_select - @{$outer_attrs->{_prefetch_select}} - 1) ) {
1660 my $sel = $outer_select->[$i];
1662 if (ref $sel eq 'HASH' ) {
1663 $sel->{-as} ||= $attrs->{as}[$i];
1664 $outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
1667 push @$inner_select, $sel;
1670 # normalize a copy of $from, so it will be easier to work with further
1671 # down (i.e. promote the initial hashref to an AoH)
1673 $from->[0] = [ $from->[0] ];
1674 my %original_join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1677 # decide which parts of the join will remain in either part of
1678 # the outer/inner query
1680 # First we compose a list of which aliases are used in restrictions
1681 # (i.e. conditions/order/grouping/etc). Since we do not have
1682 # introspectable SQLA, we fall back to ugly scanning of raw SQL for
1683 # WHERE, and for pieces of ORDER BY in order to determine which aliases
1684 # need to appear in the resulting sql.
1685 # It may not be very efficient, but it's a reasonable stop-gap
1686 # Also unqualified column names will not be considered, but more often
1687 # than not this is actually ok
1689 # In the same loop we enumerate part of the selection aliases, as
1690 # it requires the same sqla hack for the time being
1691 my ($restrict_aliases, $select_aliases, $prefetch_aliases);
1693 # produce stuff unquoted, so it can be scanned
1694 my $sql_maker = $self->sql_maker;
1695 local $sql_maker->{quote_char};
1696 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1699 my $non_prefetch_select_sql = $sql_maker->_recurse_fields ($inner_select);
1700 my $prefetch_select_sql = $sql_maker->_recurse_fields ($outer_attrs->{_prefetch_select});
1701 my $where_sql = $sql_maker->where ($where);
1702 my $group_by_sql = $sql_maker->_order_by({
1703 map { $_ => $inner_attrs->{$_} } qw/group_by having/
1705 my @non_prefetch_order_by_chunks = (map
1706 { ref $_ ? $_->[0] : $_ }
1707 $sql_maker->_order_by_chunks ($inner_attrs->{order_by})
1711 for my $alias (keys %original_join_info) {
1712 my $seen_re = qr/\b $alias $sep/x;
1714 for my $piece ($where_sql, $group_by_sql, @non_prefetch_order_by_chunks ) {
1715 if ($piece =~ $seen_re) {
1716 $restrict_aliases->{$alias} = 1;
1720 if ($non_prefetch_select_sql =~ $seen_re) {
1721 $select_aliases->{$alias} = 1;
1724 if ($prefetch_select_sql =~ $seen_re) {
1725 $prefetch_aliases->{$alias} = 1;
1731 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
1732 for my $j (values %original_join_info) {
1733 my $alias = $j->{-alias} or next;
1734 $restrict_aliases->{$alias} = 1 if (
1735 (not $j->{-join_type})
1737 ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
1741 # mark all join parents as mentioned
1742 # (e.g. join => { cds => 'tracks' } - tracks will need to bring cds too )
1743 for my $collection ($restrict_aliases, $select_aliases) {
1744 for my $alias (keys %$collection) {
1745 $collection->{$_} = 1
1746 for (@{ $original_join_info{$alias}{-join_path} || [] });
1750 # construct the inner $from for the subquery
1751 my %inner_joins = (map { %{$_ || {}} } ($restrict_aliases, $select_aliases) );
1753 for my $j (@$from) {
1754 push @inner_from, $j if $inner_joins{$j->[0]{-alias}};
1757 # if a multi-type join was needed in the subquery ("multi" is indicated by
1758 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1759 unless ($inner_attrs->{group_by}) {
1760 for my $alias (keys %inner_joins) {
1762 # the dot comes from some weirdness in collapse
1763 # remove after the rewrite
1764 if ($attrs->{collapse}{".$alias"}) {
1765 $inner_attrs->{group_by} ||= $inner_select;
1771 # demote the inner_from head
1772 $inner_from[0] = $inner_from[0][0];
1774 # generate the subquery
1775 my $subq = $self->_select_args_to_query (
1782 my $subq_joinspec = {
1783 -alias => $attrs->{alias},
1784 -source_handle => $inner_from[0]{-source_handle},
1785 $attrs->{alias} => $subq,
1788 # Generate the outer from - this is relatively easy (really just replace
1789 # the join slot with the subquery), with a major caveat - we can not
1790 # join anything that is non-selecting (not part of the prefetch), but at
1791 # the same time is a multi-type relationship, as it will explode the result.
1793 # There are two possibilities here
1794 # - either the join is non-restricting, in which case we simply throw it away
1795 # - it is part of the restrictions, in which case we need to collapse the outer
1796 # result by tackling yet another group_by to the outside of the query
1798 # so first generate the outer_from, up to the substitution point
1800 while (my $j = shift @$from) {
1801 if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
1806 last; # we'll take care of what's left in $from below
1809 push @outer_from, $j;
1813 # see what's left - throw away if not selecting/restricting
1814 # also throw in a group_by if restricting to guard against
1815 # cross-join explosions
1817 while (my $j = shift @$from) {
1818 my $alias = $j->[0]{-alias};
1820 if ($select_aliases->{$alias} || $prefetch_aliases->{$alias}) {
1821 push @outer_from, $j;
1823 elsif ($restrict_aliases->{$alias}) {
1824 push @outer_from, $j;
1826 # FIXME - this should be obviated by SQLA2, as I'll be able to
1827 # have restrict_inner and restrict_outer... or something to that
1828 # effect... I think...
1830 # FIXME2 - I can't find a clean way to determine if a particular join
1831 # is a multi - instead I am just treating everything as a potential
1832 # explosive join (ribasushi)
1834 # if (my $handle = $j->[0]{-source_handle}) {
1835 # my $rsrc = $handle->resolve;
1836 # ... need to bail out of the following if this is not a multi,
1837 # as it will be much easier on the db ...
1839 $outer_attrs->{group_by} ||= $outer_select;
1844 # demote the outer_from head
1845 $outer_from[0] = $outer_from[0][0];
1847 # This is totally horrific - the $where ends up in both the inner and outer query
1848 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1849 # then if where conditions apply to the *right* side of the prefetch, you may have
1850 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1851 # the outer select to exclude joins you didin't want in the first place
1853 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1854 return (\@outer_from, $outer_select, $where, $outer_attrs);
1857 sub _resolve_ident_sources {
1858 my ($self, $ident) = @_;
1860 my $alias2source = {};
1863 # the reason this is so contrived is that $ident may be a {from}
1864 # structure, specifying multiple tables to join
1865 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1866 # this is compat mode for insert/update/delete which do not deal with aliases
1867 $alias2source->{me} = $ident;
1870 elsif (ref $ident eq 'ARRAY') {
1874 if (ref $_ eq 'HASH') {
1876 $rs_alias = $tabinfo->{-alias};
1878 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1882 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1883 if ($tabinfo->{-source_handle});
1887 return ($alias2source, $rs_alias);
1890 # Takes $ident, \@column_names
1892 # returns { $column_name => \%column_info, ... }
1893 # also note: this adds -result_source => $rsrc to the column info
1896 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1897 sub _resolve_column_info {
1898 my ($self, $ident, $colnames) = @_;
1899 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1901 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1904 my (%return, %seen_cols);
1906 # compile a global list of column names, to be able to properly
1907 # disambiguate unqualified column names (if at all possible)
1908 for my $alias (keys %$alias2src) {
1909 my $rsrc = $alias2src->{$alias};
1910 for my $colname ($rsrc->columns) {
1911 push @{$seen_cols{$colname}}, $alias;
1916 foreach my $col (@$colnames) {
1917 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1920 # see if the column was seen exactly once (so we know which rsrc it came from)
1921 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1922 $alias = $seen_cols{$colname}[0];
1929 my $rsrc = $alias2src->{$alias};
1930 $return{$col} = $rsrc && {
1931 %{$rsrc->column_info($colname)},
1932 -result_source => $rsrc,
1933 -source_alias => $alias,
1940 # Returns a counting SELECT for a simple count
1941 # query. Abstracted so that a storage could override
1942 # this to { count => 'firstcol' } or whatever makes
1943 # sense as a performance optimization
1945 #my ($self, $source, $rs_attrs) = @_;
1946 return { count => '*' };
1949 # Returns a SELECT which will end up in the subselect
1950 # There may or may not be a group_by, as the subquery
1951 # might have been called to accomodate a limit
1953 # Most databases would be happy with whatever ends up
1954 # here, but some choke in various ways.
1956 sub _subq_count_select {
1957 my ($self, $source, $rs_attrs) = @_;
1958 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1960 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1961 return @pcols ? \@pcols : [ 1 ];
1965 sub source_bind_attributes {
1966 my ($self, $source) = @_;
1968 my $bind_attributes;
1969 foreach my $column ($source->columns) {
1971 my $data_type = $source->column_info($column)->{data_type} || '';
1972 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1976 return $bind_attributes;
1983 =item Arguments: $ident, $select, $condition, $attrs
1987 Handle a SQL select statement.
1993 my ($ident, $select, $condition, $attrs) = @_;
1994 return $self->cursor_class->new($self, \@_, $attrs);
1999 my ($rv, $sth, @bind) = $self->_select(@_);
2000 my @row = $sth->fetchrow_array;
2001 my @nextrow = $sth->fetchrow_array if @row;
2002 if(@row && @nextrow) {
2003 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2005 # Need to call finish() to work round broken DBDs
2014 =item Arguments: $sql
2018 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2023 my ($self, $dbh, $sql) = @_;
2025 # 3 is the if_active parameter which avoids active sth re-use
2026 my $sth = $self->disable_sth_caching
2027 ? $dbh->prepare($sql)
2028 : $dbh->prepare_cached($sql, {}, 3);
2030 # XXX You would think RaiseError would make this impossible,
2031 # but apparently that's not true :(
2032 $self->throw_exception($dbh->errstr) if !$sth;
2038 my ($self, $sql) = @_;
2039 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2042 sub _dbh_columns_info_for {
2043 my ($self, $dbh, $table) = @_;
2045 if ($dbh->can('column_info')) {
2048 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2049 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2051 while ( my $info = $sth->fetchrow_hashref() ){
2053 $column_info{data_type} = $info->{TYPE_NAME};
2054 $column_info{size} = $info->{COLUMN_SIZE};
2055 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2056 $column_info{default_value} = $info->{COLUMN_DEF};
2057 my $col_name = $info->{COLUMN_NAME};
2058 $col_name =~ s/^\"(.*)\"$/$1/;
2060 $result{$col_name} = \%column_info;
2063 return \%result if !$@ && scalar keys %result;
2067 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2069 my @columns = @{$sth->{NAME_lc}};
2070 for my $i ( 0 .. $#columns ){
2072 $column_info{data_type} = $sth->{TYPE}->[$i];
2073 $column_info{size} = $sth->{PRECISION}->[$i];
2074 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2076 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2077 $column_info{data_type} = $1;
2078 $column_info{size} = $2;
2081 $result{$columns[$i]} = \%column_info;
2085 foreach my $col (keys %result) {
2086 my $colinfo = $result{$col};
2087 my $type_num = $colinfo->{data_type};
2089 if(defined $type_num && $dbh->can('type_info')) {
2090 my $type_info = $dbh->type_info($type_num);
2091 $type_name = $type_info->{TYPE_NAME} if $type_info;
2092 $colinfo->{data_type} = $type_name if $type_name;
2099 sub columns_info_for {
2100 my ($self, $table) = @_;
2101 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2104 =head2 last_insert_id
2106 Return the row id of the last insert.
2110 sub _dbh_last_insert_id {
2111 # All Storage's need to register their own _dbh_last_insert_id
2112 # the old SQLite-based method was highly inappropriate
2115 my $class = ref $self;
2116 $self->throw_exception (<<EOE);
2118 No _dbh_last_insert_id() method found in $class.
2119 Since the method of obtaining the autoincrement id of the last insert
2120 operation varies greatly between different databases, this method must be
2121 individually implemented for every storage class.
2125 sub last_insert_id {
2127 $self->_dbh_last_insert_id ($self->_dbh, @_);
2130 =head2 _native_data_type
2134 =item Arguments: $type_name
2138 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2139 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2140 L<::Sybase|DBIx::Class::Storage::DBI::Sybase>.
2142 The default implementation returns C<undef>, implement in your Storage driver if
2143 you need this functionality.
2145 Should map types from other databases to the native RDBMS type, for example
2146 C<VARCHAR2> to C<VARCHAR>.
2148 Types with modifiers should map to the underlying data type. For example,
2149 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2151 Composite types should map to the container type, for example
2152 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2156 sub _native_data_type {
2157 #my ($self, $data_type) = @_;
2163 Returns the database driver name.
2170 if (not $self->_driver_determined) {
2171 $self->_determine_driver;
2172 goto $self->can ('sqlt_type');
2175 $self->_get_dbh->{Driver}->{Name};
2178 =head2 bind_attribute_by_data_type
2180 Given a datatype from column info, returns a database specific bind
2181 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2182 let the database planner just handle it.
2184 Generally only needed for special case column types, like bytea in postgres.
2188 sub bind_attribute_by_data_type {
2192 =head2 is_datatype_numeric
2194 Given a datatype from column_info, returns a boolean value indicating if
2195 the current RDBMS considers it a numeric value. This controls how
2196 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2197 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2198 be performed instead of the usual C<eq>.
2202 sub is_datatype_numeric {
2203 my ($self, $dt) = @_;
2205 return 0 unless $dt;
2207 return $dt =~ /^ (?:
2208 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2213 =head2 create_ddl_dir (EXPERIMENTAL)
2217 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2221 Creates a SQL file based on the Schema, for each of the specified
2222 database engines in C<\@databases> in the given directory.
2223 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2225 Given a previous version number, this will also create a file containing
2226 the ALTER TABLE statements to transform the previous schema into the
2227 current one. Note that these statements may contain C<DROP TABLE> or
2228 C<DROP COLUMN> statements that can potentially destroy data.
2230 The file names are created using the C<ddl_filename> method below, please
2231 override this method in your schema if you would like a different file
2232 name format. For the ALTER file, the same format is used, replacing
2233 $version in the name with "$preversion-$version".
2235 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2236 The most common value for this would be C<< { add_drop_table => 1 } >>
2237 to have the SQL produced include a C<DROP TABLE> statement for each table
2238 created. For quoting purposes supply C<quote_table_names> and
2239 C<quote_field_names>.
2241 If no arguments are passed, then the following default values are assumed:
2245 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2247 =item version - $schema->schema_version
2249 =item directory - './'
2251 =item preversion - <none>
2255 By default, C<\%sqlt_args> will have
2257 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2259 merged with the hash passed in. To disable any of those features, pass in a
2260 hashref like the following
2262 { ignore_constraint_names => 0, # ... other options }
2265 Note that this feature is currently EXPERIMENTAL and may not work correctly
2266 across all databases, or fully handle complex relationships.
2268 WARNING: Please check all SQL files created, before applying them.
2272 sub create_ddl_dir {
2273 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2275 if(!$dir || !-d $dir) {
2276 carp "No directory given, using ./\n";
2279 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2280 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2282 my $schema_version = $schema->schema_version || '1.x';
2283 $version ||= $schema_version;
2286 add_drop_table => 1,
2287 ignore_constraint_names => 1,
2288 ignore_index_names => 1,
2292 $self->throw_exception("Can't create a ddl file without SQL::Translator: " . $self->_sqlt_version_error)
2293 if !$self->_sqlt_version_ok;
2295 my $sqlt = SQL::Translator->new( $sqltargs );
2297 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2298 my $sqlt_schema = $sqlt->translate({ data => $schema })
2299 or $self->throw_exception ($sqlt->error);
2301 foreach my $db (@$databases) {
2303 $sqlt->{schema} = $sqlt_schema;
2304 $sqlt->producer($db);
2307 my $filename = $schema->ddl_filename($db, $version, $dir);
2308 if (-e $filename && ($version eq $schema_version )) {
2309 # if we are dumping the current version, overwrite the DDL
2310 carp "Overwriting existing DDL file - $filename";
2314 my $output = $sqlt->translate;
2316 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2319 if(!open($file, ">$filename")) {
2320 $self->throw_exception("Can't open $filename for writing ($!)");
2323 print $file $output;
2326 next unless ($preversion);
2328 require SQL::Translator::Diff;
2330 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2331 if(!-e $prefilename) {
2332 carp("No previous schema file found ($prefilename)");
2336 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2338 carp("Overwriting existing diff file - $difffile");
2344 my $t = SQL::Translator->new($sqltargs);
2349 or $self->throw_exception ($t->error);
2351 my $out = $t->translate( $prefilename )
2352 or $self->throw_exception ($t->error);
2354 $source_schema = $t->schema;
2356 $source_schema->name( $prefilename )
2357 unless ( $source_schema->name );
2360 # The "new" style of producers have sane normalization and can support
2361 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2362 # And we have to diff parsed SQL against parsed SQL.
2363 my $dest_schema = $sqlt_schema;
2365 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2366 my $t = SQL::Translator->new($sqltargs);
2371 or $self->throw_exception ($t->error);
2373 my $out = $t->translate( $filename )
2374 or $self->throw_exception ($t->error);
2376 $dest_schema = $t->schema;
2378 $dest_schema->name( $filename )
2379 unless $dest_schema->name;
2382 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2386 if(!open $file, ">$difffile") {
2387 $self->throw_exception("Can't write to $difffile ($!)");
2395 =head2 deployment_statements
2399 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2403 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2405 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2406 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2408 C<$directory> is used to return statements from files in a previously created
2409 L</create_ddl_dir> directory and is optional. The filenames are constructed
2410 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2412 If no C<$directory> is specified then the statements are constructed on the
2413 fly using L<SQL::Translator> and C<$version> is ignored.
2415 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2419 sub deployment_statements {
2420 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2421 $type ||= $self->sqlt_type;
2422 $version ||= $schema->schema_version || '1.x';
2424 my $filename = $schema->ddl_filename($type, $version, $dir);
2428 open($file, "<$filename")
2429 or $self->throw_exception("Can't open $filename ($!)");
2432 return join('', @rows);
2435 $self->throw_exception("Can't deploy without either SQL::Translator or a ddl_dir: " . $self->_sqlt_version_error )
2436 if !$self->_sqlt_version_ok;
2438 # sources needs to be a parser arg, but for simplicty allow at top level
2440 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2441 if exists $sqltargs->{sources};
2443 my $tr = SQL::Translator->new(
2444 producer => "SQL::Translator::Producer::${type}",
2446 parser => 'SQL::Translator::Parser::DBIx::Class',
2449 return $tr->translate;
2453 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2456 return if($line =~ /^--/);
2458 # next if($line =~ /^DROP/m);
2459 return if($line =~ /^BEGIN TRANSACTION/m);
2460 return if($line =~ /^COMMIT/m);
2461 return if $line =~ /^\s+$/; # skip whitespace only
2462 $self->_query_start($line);
2464 # do a dbh_do cycle here, as we need some error checking in
2465 # place (even though we will ignore errors)
2466 $self->dbh_do (sub { $_[1]->do($line) });
2469 carp qq{$@ (running "${line}")};
2471 $self->_query_end($line);
2473 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2474 if (@statements > 1) {
2475 foreach my $statement (@statements) {
2476 $deploy->( $statement );
2479 elsif (@statements == 1) {
2480 foreach my $line ( split(";\n", $statements[0])) {
2486 =head2 datetime_parser
2488 Returns the datetime parser class
2492 sub datetime_parser {
2494 return $self->{datetime_parser} ||= do {
2495 $self->_populate_dbh unless $self->_dbh;
2496 $self->build_datetime_parser(@_);
2500 =head2 datetime_parser_type
2502 Defines (returns) the datetime parser class - currently hardwired to
2503 L<DateTime::Format::MySQL>
2507 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2509 =head2 build_datetime_parser
2511 See L</datetime_parser>
2515 sub build_datetime_parser {
2517 my $type = $self->datetime_parser_type(@_);
2519 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2524 =head2 is_replicating
2526 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2527 replicate from a master database. Default is undef, which is the result
2528 returned by databases that don't support replication.
2532 sub is_replicating {
2537 =head2 lag_behind_master
2539 Returns a number that represents a certain amount of lag behind a master db
2540 when a given storage is replicating. The number is database dependent, but
2541 starts at zero and increases with the amount of lag. Default in undef
2545 sub lag_behind_master {
2551 $self->_verify_pid if $self->_dbh;
2553 # some databases need this to stop spewing warnings
2554 if (my $dbh = $self->_dbh) {
2555 eval { $dbh->disconnect };
2565 =head2 DBIx::Class and AutoCommit
2567 DBIx::Class can do some wonderful magic with handling exceptions,
2568 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2569 (the default) combined with C<txn_do> for transaction support.
2571 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2572 in an assumed transaction between commits, and you're telling us you'd
2573 like to manage that manually. A lot of the magic protections offered by
2574 this module will go away. We can't protect you from exceptions due to database
2575 disconnects because we don't know anything about how to restart your
2576 transactions. You're on your own for handling all sorts of exceptional
2577 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2583 Matt S. Trout <mst@shadowcatsystems.co.uk>
2585 Andy Grundman <andy@hybridized.org>
2589 You may distribute this code under the same terms as Perl itself.