b75ac8742dcc946efb4c3ca36fc53bc0db693631
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Storage / DBI.pm
1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
3
4 use strict;
5 use warnings;
6
7 use base 'DBIx::Class::Storage';
8 use mro 'c3';
9
10 use Carp::Clan qw/^DBIx::Class/;
11 use DBI;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
14 use Scalar::Util();
15 use List::Util();
16
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/
20 );
21
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
27 /;
28 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
29
30
31 # default cursor class, overridable in connect_info attributes
32 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
33
34 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
35 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
36
37
38 =head1 NAME
39
40 DBIx::Class::Storage::DBI - DBI storage handler
41
42 =head1 SYNOPSIS
43
44   my $schema = MySchema->connect('dbi:SQLite:my.db');
45
46   $schema->storage->debug(1);
47
48   my @stuff = $schema->storage->dbh_do(
49     sub {
50       my ($storage, $dbh, @args) = @_;
51       $dbh->do("DROP TABLE authors");
52     },
53     @column_list
54   );
55
56   $schema->resultset('Book')->search({
57      written_on => $schema->storage->datetime_parser(DateTime->now)
58   });
59
60 =head1 DESCRIPTION
61
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.
65
66 =head1 METHODS
67
68 =cut
69
70 sub new {
71   my $new = shift->next::method(@_);
72
73   $new->transaction_depth(0);
74   $new->_sql_maker_opts({});
75   $new->{savepoints} = [];
76   $new->{_in_dbh_do} = 0;
77   $new->{_dbh_gen} = 0;
78
79   $new;
80 }
81
82 =head2 connect_info
83
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.
86
87 The argument list may contain:
88
89 =over
90
91 =item *
92
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:
97
98   $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
99
100 =item *
101
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
105 by DBIx::Class:
106
107   $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
108
109 =item *
110
111 A single hashref with all the attributes and the dsn/user/password
112 mixed together:
113
114   $connect_info_args = [{
115     dsn => $dsn,
116     user => $user,
117     password => $pass,
118     %dbi_attributes,
119     %extra_attributes,
120   }];
121
122   $connect_info_args = [{
123     dbh_maker => sub { DBI->connect (...) },
124     %dbi_attributes,
125     %extra_attributes,
126   }];
127
128 This is particularly useful for L<Catalyst> based applications, allowing the
129 following config (L<Config::General> style):
130
131   <Model::DB>
132     schema_class   App::DB
133     <connect_info>
134       dsn          dbi:mysql:database=test
135       user         testuser
136       password     TestPass
137       AutoCommit   1
138     </connect_info>
139   </Model::DB>
140
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>
144
145 =back
146
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.
153
154 =head3 DBIx::Class specific connection attributes
155
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.
161
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>.
165
166
167 =over
168
169 =item on_connect_do
170
171 Specifies things to do immediately after connecting or re-connecting to
172 the database.  Its value may contain:
173
174 =over
175
176 =item a scalar
177
178 This contains one SQL statement to execute.
179
180 =item an array reference
181
182 This contains SQL statements to execute in order.  Each element contains
183 a string or a code reference that returns a string.
184
185 =item a code reference
186
187 This contains some code to execute.  Unlike code references within an
188 array reference, its return value is ignored.
189
190 =back
191
192 =item on_disconnect_do
193
194 Takes arguments in the same form as L</on_connect_do> and executes them
195 immediately before disconnecting from the database.
196
197 Note, this only runs if you explicitly call L</disconnect> on the
198 storage object.
199
200 =item on_connect_call
201
202 A more generalized form of L</on_connect_do> that calls the specified
203 C<connect_call_METHOD> methods in your storage driver.
204
205   on_connect_do => 'select 1'
206
207 is equivalent to:
208
209   on_connect_call => [ [ do_sql => 'select 1' ] ]
210
211 Its values may contain:
212
213 =over
214
215 =item a scalar
216
217 Will call the C<connect_call_METHOD> method.
218
219 =item a code reference
220
221 Will execute C<< $code->($storage) >>
222
223 =item an array reference
224
225 Each value can be a method name or code reference.
226
227 =item an array of arrays
228
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.
231
232 =back
233
234 Some predefined storage methods you may use:
235
236 =over
237
238 =item do_sql
239
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.
242
243 It can take:
244
245 =over
246
247 =item a scalar
248
249 Will execute the scalar as SQL.
250
251 =item an arrayref
252
253 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
254 attributes hashref and bind values.
255
256 =item a code reference
257
258 Will execute C<< $code->($storage) >> and execute the return array refs as
259 above.
260
261 =back
262
263 =item datetime_setup
264
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>.
268
269 Only necessary for some databases, see your specific storage driver for
270 implementation details.
271
272 =back
273
274 =item on_disconnect_call
275
276 Takes arguments in the same form as L</on_connect_call> and executes them
277 immediately before disconnecting from the database.
278
279 Calls the C<disconnect_call_METHOD> methods as opposed to the
280 C<connect_call_METHOD> methods called by L</on_connect_call>.
281
282 Note, this only runs if you explicitly call L</disconnect> on the
283 storage object.
284
285 =item disable_sth_caching
286
287 If set to a true value, this option will disable the caching of
288 statement handles via L<DBI/prepare_cached>.
289
290 =item limit_dialect
291
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>.
295
296 =item quote_char
297
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.
300
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.
304
305 For example under MySQL you should use C<< quote_char => '`' >>, and for
306 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
307
308 =item name_sep
309
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<.>.
313
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
317 be I<"me"."name">.
318
319 =item unsafe
320
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.
325
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).
330
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>.
334
335 =item auto_savepoint
336
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.
340
341 =item cursor_class
342
343 Use this argument to supply a cursor class other than the default
344 L<DBIx::Class::Storage::DBI::Cursor>.
345
346 =back
347
348 Some real-life examples of arguments to L</connect_info> and
349 L<DBIx::Class::Schema/connect>
350
351   # Simple SQLite connection
352   ->connect_info([ 'dbi:SQLite:./foo.db' ]);
353
354   # Connect via subref
355   ->connect_info([ sub { DBI->connect(...) } ]);
356
357   # Connect via subref in hashref
358   ->connect_info([{
359     dbh_maker => sub { DBI->connect(...) },
360     on_connect_do => 'alter session ...',
361   }]);
362
363   # A bit more complicated
364   ->connect_info(
365     [
366       'dbi:Pg:dbname=foo',
367       'postgres',
368       'my_pg_password',
369       { AutoCommit => 1 },
370       { quote_char => q{"}, name_sep => q{.} },
371     ]
372   );
373
374   # Equivalent to the previous example
375   ->connect_info(
376     [
377       'dbi:Pg:dbname=foo',
378       'postgres',
379       'my_pg_password',
380       { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
381     ]
382   );
383
384   # Same, but with hashref as argument
385   # See parse_connect_info for explanation
386   ->connect_info(
387     [{
388       dsn         => 'dbi:Pg:dbname=foo',
389       user        => 'postgres',
390       password    => 'my_pg_password',
391       AutoCommit  => 1,
392       quote_char  => q{"},
393       name_sep    => q{.},
394     }]
395   );
396
397   # Subref + DBIx::Class-specific connection options
398   ->connect_info(
399     [
400       sub { DBI->connect(...) },
401       {
402           quote_char => q{`},
403           name_sep => q{@},
404           on_connect_do => ['SET search_path TO myschema,otherschema,public'],
405           disable_sth_caching => 1,
406       },
407     ]
408   );
409
410
411
412 =cut
413
414 sub connect_info {
415   my ($self, $info_arg) = @_;
416
417   return $self->_connect_info if !$info_arg;
418
419   my @args = @$info_arg;  # take a shallow copy for further mutilation
420   $self->_connect_info([@args]); # copy for _connect_info
421
422
423   # combine/pre-parse arguments depending on invocation style
424
425   my %attrs;
426   if (ref $args[0] eq 'CODE') {     # coderef with optional \%extra_attributes
427     %attrs = %{ $args[1] || {} };
428     @args = $args[0];
429   }
430   elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
431     %attrs = %{$args[0]};
432     @args = ();
433     if (my $code = delete $attrs{dbh_maker}) {
434       @args = $code;
435
436       my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
437       if (@ignored) {
438         carp sprintf (
439             'Attribute(s) %s in connect_info were ignored, as they can not be applied '
440           . "to the result of 'dbh_maker'",
441
442           join (', ', map { "'$_'" } (@ignored) ),
443         );
444       }
445     }
446     else {
447       @args = delete @attrs{qw/dsn user password/};
448     }
449   }
450   else {                # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
451     %attrs = (
452       % { $args[3] || {} },
453       % { $args[4] || {} },
454     );
455     @args = @args[0,1,2];
456   }
457
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({});
462
463   if(keys %attrs) {
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);
467       }
468     }
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;
472       }
473     }
474   }
475
476   if (ref $args[0] eq 'CODE') {
477     # _connect() never looks past $args[0] in this case
478     %attrs = ()
479   } else {
480     %attrs = (
481       %{ $self->_default_dbi_connect_attributes || {} },
482       %attrs,
483     );
484   }
485
486   $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
487   $self->_connect_info;
488 }
489
490 sub _default_dbi_connect_attributes {
491   return {
492     AutoCommit => 1,
493     RaiseError => 1,
494     PrintError => 0,
495   };
496 }
497
498 =head2 on_connect_do
499
500 This method is deprecated in favour of setting via L</connect_info>.
501
502 =cut
503
504 =head2 on_disconnect_do
505
506 This method is deprecated in favour of setting via L</connect_info>.
507
508 =cut
509
510 sub _parse_connect_do {
511   my ($self, $type) = @_;
512
513   my $val = $self->$type;
514   return () if not defined $val;
515
516   my @res;
517
518   if (not ref($val)) {
519     push @res, [ 'do_sql', $val ];
520   } elsif (ref($val) eq 'CODE') {
521     push @res, $val;
522   } elsif (ref($val) eq 'ARRAY') {
523     push @res, map { [ 'do_sql', $_ ] } @$val;
524   } else {
525     $self->throw_exception("Invalid type for $type: ".ref($val));
526   }
527
528   return \@res;
529 }
530
531 =head2 dbh_do
532
533 Arguments: ($subref | $method_name), @extra_coderef_args?
534
535 Execute the given $subref or $method_name using the new exception-based
536 connection management.
537
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.
541
542 Using this (instead of $self->_dbh or $self->dbh) ensures correct
543 exception handling and reconnection (or failover in future subclasses).
544
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.
548
549 Example:
550
551   my @stuff = $schema->storage->dbh_do(
552     sub {
553       my ($storage, $dbh, @cols) = @_;
554       my $cols = join(q{, }, @cols);
555       $dbh->selectrow_array("SELECT $cols FROM foo");
556     },
557     @column_list
558   );
559
560 =cut
561
562 sub dbh_do {
563   my $self = shift;
564   my $code = shift;
565
566   my $dbh = $self->_get_dbh;
567
568   return $self->$code($dbh, @_) if $self->{_in_dbh_do}
569       || $self->{transaction_depth};
570
571   local $self->{_in_dbh_do} = 1;
572
573   my @result;
574   my $want_array = wantarray;
575
576   eval {
577
578     if($want_array) {
579         @result = $self->$code($dbh, @_);
580     }
581     elsif(defined $want_array) {
582         $result[0] = $self->$code($dbh, @_);
583     }
584     else {
585         $self->$code($dbh, @_);
586     }
587   };
588
589   # ->connected might unset $@ - copy
590   my $exception = $@;
591   if(!$exception) { return $want_array ? @result : $result[0] }
592
593   $self->throw_exception($exception) if $self->connected;
594
595   # We were not connected - reconnect and retry, but let any
596   #  exception fall right through this time
597   carp "Retrying $code after catching disconnected exception: $exception"
598     if $ENV{DBIC_DBIRETRY_DEBUG};
599   $self->_populate_dbh;
600   $self->$code($self->_dbh, @_);
601 }
602
603 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
604 # It also informs dbh_do to bypass itself while under the direction of txn_do,
605 #  via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
606 sub txn_do {
607   my $self = shift;
608   my $coderef = shift;
609
610   ref $coderef eq 'CODE' or $self->throw_exception
611     ('$coderef must be a CODE reference');
612
613   return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
614
615   local $self->{_in_dbh_do} = 1;
616
617   my @result;
618   my $want_array = wantarray;
619
620   my $tried = 0;
621   while(1) {
622     eval {
623       $self->_get_dbh;
624
625       $self->txn_begin;
626       if($want_array) {
627           @result = $coderef->(@_);
628       }
629       elsif(defined $want_array) {
630           $result[0] = $coderef->(@_);
631       }
632       else {
633           $coderef->(@_);
634       }
635       $self->txn_commit;
636     };
637
638     # ->connected might unset $@ - copy
639     my $exception = $@;
640     if(!$exception) { return $want_array ? @result : $result[0] }
641
642     if($tried++ || $self->connected) {
643       eval { $self->txn_rollback };
644       my $rollback_exception = $@;
645       if($rollback_exception) {
646         my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
647         $self->throw_exception($exception)  # propagate nested rollback
648           if $rollback_exception =~ /$exception_class/;
649
650         $self->throw_exception(
651           "Transaction aborted: ${exception}. "
652           . "Rollback failed: ${rollback_exception}"
653         );
654       }
655       $self->throw_exception($exception)
656     }
657
658     # We were not connected, and was first try - reconnect and retry
659     # via the while loop
660     carp "Retrying $coderef after catching disconnected exception: $exception"
661       if $ENV{DBIC_DBIRETRY_DEBUG};
662     $self->_populate_dbh;
663   }
664 }
665
666 =head2 disconnect
667
668 Our C<disconnect> method also performs a rollback first if the
669 database is not in C<AutoCommit> mode.
670
671 =cut
672
673 sub disconnect {
674   my ($self) = @_;
675
676   if( $self->_dbh ) {
677     my @actions;
678
679     push @actions, ( $self->on_disconnect_call || () );
680     push @actions, $self->_parse_connect_do ('on_disconnect_do');
681
682     $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
683
684     $self->_dbh_rollback unless $self->_dbh_autocommit;
685
686     $self->_dbh->disconnect;
687     $self->_dbh(undef);
688     $self->{_dbh_gen}++;
689   }
690 }
691
692 =head2 with_deferred_fk_checks
693
694 =over 4
695
696 =item Arguments: C<$coderef>
697
698 =item Return Value: The return value of $coderef
699
700 =back
701
702 Storage specific method to run the code ref with FK checks deferred or
703 in MySQL's case disabled entirely.
704
705 =cut
706
707 # Storage subclasses should override this
708 sub with_deferred_fk_checks {
709   my ($self, $sub) = @_;
710
711   $sub->();
712 }
713
714 =head2 connected
715
716 =over
717
718 =item Arguments: none
719
720 =item Return Value: 1|0
721
722 =back
723
724 Verifies that the the current database handle is active and ready to execute
725 an SQL statement (i.e. the connection did not get stale, server is still
726 answering, etc.) This method is used internally by L</dbh>.
727
728 =cut
729
730 sub connected {
731   my $self = shift;
732   return 0 unless $self->_seems_connected;
733
734   #be on the safe side
735   local $self->_dbh->{RaiseError} = 1;
736
737   return $self->_ping;
738 }
739
740 sub _seems_connected {
741   my $self = shift;
742
743   my $dbh = $self->_dbh
744     or return 0;
745
746   if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
747     $self->_dbh(undef);
748     $self->{_dbh_gen}++;
749     return 0;
750   }
751   else {
752     $self->_verify_pid;
753     return 0 if !$self->_dbh;
754   }
755
756   return $dbh->FETCH('Active');
757 }
758
759 sub _ping {
760   my $self = shift;
761
762   my $dbh = $self->_dbh or return 0;
763
764   return $dbh->ping;
765 }
766
767 # handle pid changes correctly
768 #  NOTE: assumes $self->_dbh is a valid $dbh
769 sub _verify_pid {
770   my ($self) = @_;
771
772   return if defined $self->_conn_pid && $self->_conn_pid == $$;
773
774   $self->_dbh->{InactiveDestroy} = 1;
775   $self->_dbh(undef);
776   $self->{_dbh_gen}++;
777
778   return;
779 }
780
781 sub ensure_connected {
782   my ($self) = @_;
783
784   unless ($self->connected) {
785     $self->_populate_dbh;
786   }
787 }
788
789 =head2 dbh
790
791 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
792 is guaranteed to be healthy by implicitly calling L</connected>, and if
793 necessary performing a reconnection before returning. Keep in mind that this
794 is very B<expensive> on some database engines. Consider using L<dbh_do>
795 instead.
796
797 =cut
798
799 sub dbh {
800   my ($self) = @_;
801
802   if (not $self->_dbh) {
803     $self->_populate_dbh;
804   } else {
805     $self->ensure_connected;
806   }
807   return $self->_dbh;
808 }
809
810 # this is the internal "get dbh or connect (don't check)" method
811 sub _get_dbh {
812   my $self = shift;
813   $self->_verify_pid if $self->_dbh;
814   $self->_populate_dbh unless $self->_dbh;
815   return $self->_dbh;
816 }
817
818 sub _sql_maker_args {
819     my ($self) = @_;
820
821     return (
822       bindtype=>'columns',
823       array_datatypes => 1,
824       limit_dialect => $self->_get_dbh,
825       %{$self->_sql_maker_opts}
826     );
827 }
828
829 sub sql_maker {
830   my ($self) = @_;
831   unless ($self->_sql_maker) {
832     my $sql_maker_class = $self->sql_maker_class;
833     $self->ensure_class_loaded ($sql_maker_class);
834     $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
835   }
836   return $self->_sql_maker;
837 }
838
839 # nothing to do by default
840 sub _rebless {}
841 sub _init {}
842
843 sub _populate_dbh {
844   my ($self) = @_;
845
846   my @info = @{$self->_dbi_connect_info || []};
847   $self->_dbh(undef); # in case ->connected failed we might get sent here
848   $self->_dbh($self->_connect(@info));
849
850   $self->_conn_pid($$);
851   $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
852
853   $self->_determine_driver;
854
855   # Always set the transaction depth on connect, since
856   #  there is no transaction in progress by definition
857   $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
858
859   $self->_run_connection_actions unless $self->{_in_determine_driver};
860 }
861
862 sub _run_connection_actions {
863   my $self = shift;
864   my @actions;
865
866   push @actions, ( $self->on_connect_call || () );
867   push @actions, $self->_parse_connect_do ('on_connect_do');
868
869   $self->_do_connection_actions(connect_call_ => $_) for @actions;
870 }
871
872 sub _determine_driver {
873   my ($self) = @_;
874
875   if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
876     my $started_unconnected = 0;
877     local $self->{_in_determine_driver} = 1;
878
879     if (ref($self) eq __PACKAGE__) {
880       my $driver;
881       if ($self->_dbh) { # we are connected
882         $driver = $self->_dbh->{Driver}{Name};
883       } else {
884         # if connect_info is a CODEREF, we have no choice but to connect
885         if (ref $self->_dbi_connect_info->[0] &&
886             Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
887           $self->_populate_dbh;
888           $driver = $self->_dbh->{Driver}{Name};
889         }
890         else {
891           # try to use dsn to not require being connected, the driver may still
892           # force a connection in _rebless to determine version
893           ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
894           $started_unconnected = 1;
895         }
896       }
897
898       my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
899       if ($self->load_optional_class($storage_class)) {
900         mro::set_mro($storage_class, 'c3');
901         bless $self, $storage_class;
902         $self->_rebless();
903       }
904     }
905
906     $self->_driver_determined(1);
907
908     $self->_init; # run driver-specific initializations
909
910     $self->_run_connection_actions
911         if $started_unconnected && defined $self->_dbh;
912   }
913 }
914
915 sub _do_connection_actions {
916   my $self          = shift;
917   my $method_prefix = shift;
918   my $call          = shift;
919
920   if (not ref($call)) {
921     my $method = $method_prefix . $call;
922     $self->$method(@_);
923   } elsif (ref($call) eq 'CODE') {
924     $self->$call(@_);
925   } elsif (ref($call) eq 'ARRAY') {
926     if (ref($call->[0]) ne 'ARRAY') {
927       $self->_do_connection_actions($method_prefix, $_) for @$call;
928     } else {
929       $self->_do_connection_actions($method_prefix, @$_) for @$call;
930     }
931   } else {
932     $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
933   }
934
935   return $self;
936 }
937
938 sub connect_call_do_sql {
939   my $self = shift;
940   $self->_do_query(@_);
941 }
942
943 sub disconnect_call_do_sql {
944   my $self = shift;
945   $self->_do_query(@_);
946 }
947
948 # override in db-specific backend when necessary
949 sub connect_call_datetime_setup { 1 }
950
951 sub _do_query {
952   my ($self, $action) = @_;
953
954   if (ref $action eq 'CODE') {
955     $action = $action->($self);
956     $self->_do_query($_) foreach @$action;
957   }
958   else {
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;
967
968     $self->_query_start($sql, @bind);
969     $self->_get_dbh->do($sql, $attrs, @do_args);
970     $self->_query_end($sql, @bind);
971   }
972
973   return $self;
974 }
975
976 sub _connect {
977   my ($self, @info) = @_;
978
979   $self->throw_exception("You failed to provide any connection info")
980     if !@info;
981
982   my ($old_connect_via, $dbh);
983
984   if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
985     $old_connect_via = $DBI::connect_via;
986     $DBI::connect_via = 'connect';
987   }
988
989   eval {
990     if(ref $info[0] eq 'CODE') {
991        $dbh = &{$info[0]}
992     }
993     else {
994        $dbh = DBI->connect(@info);
995     }
996
997     if($dbh && !$self->unsafe) {
998       my $weak_self = $self;
999       Scalar::Util::weaken($weak_self);
1000       $dbh->{HandleError} = sub {
1001           if ($weak_self) {
1002             $weak_self->throw_exception("DBI Exception: $_[0]");
1003           }
1004           else {
1005             croak ("DBI Exception: $_[0]");
1006           }
1007       };
1008       $dbh->{ShowErrorStatement} = 1;
1009       $dbh->{RaiseError} = 1;
1010       $dbh->{PrintError} = 0;
1011     }
1012   };
1013
1014   $DBI::connect_via = $old_connect_via if $old_connect_via;
1015
1016   $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1017     if !$dbh || $@;
1018
1019   $self->_dbh_autocommit($dbh->{AutoCommit});
1020
1021   $dbh;
1022 }
1023
1024 sub svp_begin {
1025   my ($self, $name) = @_;
1026
1027   $name = $self->_svp_generate_name
1028     unless defined $name;
1029
1030   $self->throw_exception ("You can't use savepoints outside a transaction")
1031     if $self->{transaction_depth} == 0;
1032
1033   $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1034     unless $self->can('_svp_begin');
1035
1036   push @{ $self->{savepoints} }, $name;
1037
1038   $self->debugobj->svp_begin($name) if $self->debug;
1039
1040   return $self->_svp_begin($name);
1041 }
1042
1043 sub svp_release {
1044   my ($self, $name) = @_;
1045
1046   $self->throw_exception ("You can't use savepoints outside a transaction")
1047     if $self->{transaction_depth} == 0;
1048
1049   $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1050     unless $self->can('_svp_release');
1051
1052   if (defined $name) {
1053     $self->throw_exception ("Savepoint '$name' does not exist")
1054       unless grep { $_ eq $name } @{ $self->{savepoints} };
1055
1056     # Dig through the stack until we find the one we are releasing.  This keeps
1057     # the stack up to date.
1058     my $svp;
1059
1060     do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1061   } else {
1062     $name = pop @{ $self->{savepoints} };
1063   }
1064
1065   $self->debugobj->svp_release($name) if $self->debug;
1066
1067   return $self->_svp_release($name);
1068 }
1069
1070 sub svp_rollback {
1071   my ($self, $name) = @_;
1072
1073   $self->throw_exception ("You can't use savepoints outside a transaction")
1074     if $self->{transaction_depth} == 0;
1075
1076   $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1077     unless $self->can('_svp_rollback');
1078
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!");
1083       }
1084
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);
1089       }
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);
1093   } else {
1094       # We'll assume they want to rollback to the last savepoint
1095       $name = $self->{savepoints}->[-1];
1096   }
1097
1098   $self->debugobj->svp_rollback($name) if $self->debug;
1099
1100   return $self->_svp_rollback($name);
1101 }
1102
1103 sub _svp_generate_name {
1104     my ($self) = @_;
1105
1106     return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1107 }
1108
1109 sub txn_begin {
1110   my $self = shift;
1111   if($self->{transaction_depth} == 0) {
1112     $self->debugobj->txn_begin()
1113       if $self->debug;
1114     $self->_dbh_begin_work;
1115   }
1116   elsif ($self->auto_savepoint) {
1117     $self->svp_begin;
1118   }
1119   $self->{transaction_depth}++;
1120 }
1121
1122 sub _dbh_begin_work {
1123   my $self = shift;
1124
1125   # if the user is utilizing txn_do - good for him, otherwise we need to
1126   # ensure that the $dbh is healthy on BEGIN.
1127   # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1128   # will be replaced by a failure of begin_work itself (which will be
1129   # then retried on reconnect)
1130   if ($self->{_in_dbh_do}) {
1131     $self->_dbh->begin_work;
1132   } else {
1133     $self->dbh_do(sub { $_[1]->begin_work });
1134   }
1135 }
1136
1137 sub txn_commit {
1138   my $self = shift;
1139   if ($self->{transaction_depth} == 1) {
1140     my $dbh = $self->_dbh;
1141     $self->debugobj->txn_commit()
1142       if ($self->debug);
1143     $self->_dbh_commit;
1144     $self->{transaction_depth} = 0
1145       if $self->_dbh_autocommit;
1146   }
1147   elsif($self->{transaction_depth} > 1) {
1148     $self->{transaction_depth}--;
1149     $self->svp_release
1150       if $self->auto_savepoint;
1151   }
1152 }
1153
1154 sub _dbh_commit {
1155   my $self = shift;
1156   $self->_dbh->commit;
1157 }
1158
1159 sub txn_rollback {
1160   my $self = shift;
1161   my $dbh = $self->_dbh;
1162   eval {
1163     if ($self->{transaction_depth} == 1) {
1164       $self->debugobj->txn_rollback()
1165         if ($self->debug);
1166       $self->{transaction_depth} = 0
1167         if $self->_dbh_autocommit;
1168       $self->_dbh_rollback;
1169     }
1170     elsif($self->{transaction_depth} > 1) {
1171       $self->{transaction_depth}--;
1172       if ($self->auto_savepoint) {
1173         $self->svp_rollback;
1174         $self->svp_release;
1175       }
1176     }
1177     else {
1178       die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1179     }
1180   };
1181   if ($@) {
1182     my $error = $@;
1183     my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1184     $error =~ /$exception_class/ and $self->throw_exception($error);
1185     # ensure that a failed rollback resets the transaction depth
1186     $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1187     $self->throw_exception($error);
1188   }
1189 }
1190
1191 sub _dbh_rollback {
1192   my $self = shift;
1193   $self->_dbh->rollback;
1194 }
1195
1196 # This used to be the top-half of _execute.  It was split out to make it
1197 #  easier to override in NoBindVars without duping the rest.  It takes up
1198 #  all of _execute's args, and emits $sql, @bind.
1199 sub _prep_for_execute {
1200   my ($self, $op, $extra_bind, $ident, $args) = @_;
1201
1202   if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1203     $ident = $ident->from();
1204   }
1205
1206   my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1207
1208   unshift(@bind,
1209     map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1210       if $extra_bind;
1211   return ($sql, \@bind);
1212 }
1213
1214
1215 sub _fix_bind_params {
1216     my ($self, @bind) = @_;
1217
1218     ### Turn @bind from something like this:
1219     ###   ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1220     ### to this:
1221     ###   ( "'1'", "'1'", "'3'" )
1222     return
1223         map {
1224             if ( defined( $_ && $_->[1] ) ) {
1225                 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1226             }
1227             else { q{'NULL'}; }
1228         } @bind;
1229 }
1230
1231 sub _query_start {
1232     my ( $self, $sql, @bind ) = @_;
1233
1234     if ( $self->debug ) {
1235         @bind = $self->_fix_bind_params(@bind);
1236
1237         $self->debugobj->query_start( $sql, @bind );
1238     }
1239 }
1240
1241 sub _query_end {
1242     my ( $self, $sql, @bind ) = @_;
1243
1244     if ( $self->debug ) {
1245         @bind = $self->_fix_bind_params(@bind);
1246         $self->debugobj->query_end( $sql, @bind );
1247     }
1248 }
1249
1250 sub _dbh_execute {
1251   my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1252
1253   my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1254
1255   $self->_query_start( $sql, @$bind );
1256
1257   my $sth = $self->sth($sql,$op);
1258
1259   my $placeholder_index = 1;
1260
1261   foreach my $bound (@$bind) {
1262     my $attributes = {};
1263     my($column_name, @data) = @$bound;
1264
1265     if ($bind_attributes) {
1266       $attributes = $bind_attributes->{$column_name}
1267       if defined $bind_attributes->{$column_name};
1268     }
1269
1270     foreach my $data (@data) {
1271       my $ref = ref $data;
1272       $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1273
1274       $sth->bind_param($placeholder_index, $data, $attributes);
1275       $placeholder_index++;
1276     }
1277   }
1278
1279   # Can this fail without throwing an exception anyways???
1280   my $rv = $sth->execute();
1281   $self->throw_exception($sth->errstr) if !$rv;
1282
1283   $self->_query_end( $sql, @$bind );
1284
1285   return (wantarray ? ($rv, $sth, @$bind) : $rv);
1286 }
1287
1288 sub _execute {
1289     my $self = shift;
1290     $self->dbh_do('_dbh_execute', @_);  # retry over disconnects
1291 }
1292
1293 sub insert {
1294   my ($self, $source, $to_insert) = @_;
1295
1296 # redispatch to insert method of storage we reblessed into, if necessary
1297   if (not $self->_driver_determined) {
1298     $self->_determine_driver;
1299     goto $self->can('insert');
1300   }
1301
1302   my $ident = $source->from;
1303   my $bind_attributes = $self->source_bind_attributes($source);
1304
1305   my $updated_cols = {};
1306
1307   foreach my $col ( $source->columns ) {
1308     if ( !defined $to_insert->{$col} ) {
1309       my $col_info = $source->column_info($col);
1310
1311       if ( $col_info->{auto_nextval} ) {
1312         $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1313           'nextval',
1314           $col_info->{sequence} ||
1315             $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1316         );
1317       }
1318     }
1319   }
1320
1321   $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1322
1323   return $updated_cols;
1324 }
1325
1326 ## Still not quite perfect, and EXPERIMENTAL
1327 ## Currently it is assumed that all values passed will be "normal", i.e. not
1328 ## scalar refs, or at least, all the same type as the first set, the statement is
1329 ## only prepped once.
1330 sub insert_bulk {
1331   my ($self, $source, $cols, $data) = @_;
1332
1333 # redispatch to insert_bulk method of storage we reblessed into, if necessary
1334   if (not $self->_driver_determined) {
1335     $self->_determine_driver;
1336     goto $self->can('insert_bulk');
1337   }
1338
1339   my %colvalues;
1340   my $table = $source->from;
1341   @colvalues{@$cols} = (0..$#$cols);
1342
1343   my ($sql, $bind) = $self->_prep_for_execute (
1344     'insert', undef, $source, [\%colvalues]
1345   );
1346   my @bind = @$bind
1347     or croak 'Cannot insert_bulk without support for placeholders';
1348
1349   $self->_query_start( $sql, @bind );
1350   my $sth = $self->sth($sql);
1351
1352 #  @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1353
1354   ## This must be an arrayref, else nothing works!
1355   my $tuple_status = [];
1356
1357   ## Get the bind_attributes, if any exist
1358   my $bind_attributes = $self->source_bind_attributes($source);
1359
1360   ## Bind the values and execute
1361   my $placeholder_index = 1;
1362
1363   foreach my $bound (@bind) {
1364
1365     my $attributes = {};
1366     my ($column_name, $data_index) = @$bound;
1367
1368     if( $bind_attributes ) {
1369       $attributes = $bind_attributes->{$column_name}
1370       if defined $bind_attributes->{$column_name};
1371     }
1372
1373     my @data = map { $_->[$data_index] } @$data;
1374
1375     $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1376     $placeholder_index++;
1377   }
1378   my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1379   $sth->finish;
1380   if (my $err = $@) {
1381     my $i = 0;
1382     ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1383
1384     $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1385       if ($i > $#$tuple_status);
1386
1387     require Data::Dumper;
1388     local $Data::Dumper::Terse = 1;
1389     local $Data::Dumper::Indent = 1;
1390     local $Data::Dumper::Useqq = 1;
1391     local $Data::Dumper::Quotekeys = 0;
1392     local $Data::Dumper::Sortkeys = 1;
1393
1394     $self->throw_exception(sprintf "%s for populate slice:\n%s",
1395       $tuple_status->[$i][1],
1396       Data::Dumper::Dumper(
1397         { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1398       ),
1399     );
1400   }
1401   $self->throw_exception($sth->errstr) if !$rv;
1402
1403   $self->_query_end( $sql, @bind );
1404   return (wantarray ? ($rv, $sth, @bind) : $rv);
1405 }
1406
1407 sub update {
1408   my ($self, $source, @args) = @_; 
1409
1410 # redispatch to update method of storage we reblessed into, if necessary
1411   if (not $self->_driver_determined) {
1412     $self->_determine_driver;
1413     goto $self->can('update');
1414   }
1415
1416   my $bind_attributes = $self->source_bind_attributes($source);
1417
1418   return $self->_execute('update' => [], $source, $bind_attributes, @args);
1419 }
1420
1421
1422 sub delete {
1423   my $self = shift @_;
1424   my $source = shift @_;
1425   $self->_determine_driver;
1426   my $bind_attrs = $self->source_bind_attributes($source);
1427
1428   return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1429 }
1430
1431 # We were sent here because the $rs contains a complex search
1432 # which will require a subquery to select the correct rows
1433 # (i.e. joined or limited resultsets)
1434 #
1435 # Genarating a single PK column subquery is trivial and supported
1436 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1437 # Look at _multipk_update_delete()
1438 sub _subq_update_delete {
1439   my $self = shift;
1440   my ($rs, $op, $values) = @_;
1441
1442   my $rsrc = $rs->result_source;
1443
1444   # we already check this, but double check naively just in case. Should be removed soon
1445   my $sel = $rs->_resolved_attrs->{select};
1446   $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1447   my @pcols = $rsrc->primary_columns;
1448   if (@$sel != @pcols) {
1449     $self->throw_exception (
1450       'Subquery update/delete can not be called on resultsets selecting a'
1451      .' number of columns different than the number of primary keys'
1452     );
1453   }
1454
1455   if (@pcols == 1) {
1456     return $self->$op (
1457       $rsrc,
1458       $op eq 'update' ? $values : (),
1459       { $pcols[0] => { -in => $rs->as_query } },
1460     );
1461   }
1462
1463   else {
1464     return $self->_multipk_update_delete (@_);
1465   }
1466 }
1467
1468 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1469 # resultset update/delete involving subqueries. So by default resort
1470 # to simple (and inefficient) delete_all style per-row opearations,
1471 # while allowing specific storages to override this with a faster
1472 # implementation.
1473 #
1474 sub _multipk_update_delete {
1475   return shift->_per_row_update_delete (@_);
1476 }
1477
1478 # This is the default loop used to delete/update rows for multi PK
1479 # resultsets, and used by mysql exclusively (because it can't do anything
1480 # else).
1481 #
1482 # We do not use $row->$op style queries, because resultset update/delete
1483 # is not expected to cascade (this is what delete_all/update_all is for).
1484 #
1485 # There should be no race conditions as the entire operation is rolled
1486 # in a transaction.
1487 #
1488 sub _per_row_update_delete {
1489   my $self = shift;
1490   my ($rs, $op, $values) = @_;
1491
1492   my $rsrc = $rs->result_source;
1493   my @pcols = $rsrc->primary_columns;
1494
1495   my $guard = $self->txn_scope_guard;
1496
1497   # emulate the return value of $sth->execute for non-selects
1498   my $row_cnt = '0E0';
1499
1500   my $subrs_cur = $rs->cursor;
1501   while (my @pks = $subrs_cur->next) {
1502
1503     my $cond;
1504     for my $i (0.. $#pcols) {
1505       $cond->{$pcols[$i]} = $pks[$i];
1506     }
1507
1508     $self->$op (
1509       $rsrc,
1510       $op eq 'update' ? $values : (),
1511       $cond,
1512     );
1513
1514     $row_cnt++;
1515   }
1516
1517   $guard->commit;
1518
1519   return $row_cnt;
1520 }
1521
1522 sub _select {
1523   my $self = shift;
1524
1525   # localization is neccessary as
1526   # 1) there is no infrastructure to pass this around before SQLA2
1527   # 2) _select_args sets it and _prep_for_execute consumes it
1528   my $sql_maker = $self->sql_maker;
1529   local $sql_maker->{_dbic_rs_attrs};
1530
1531   return $self->_execute($self->_select_args(@_));
1532 }
1533
1534 sub _select_args_to_query {
1535   my $self = shift;
1536
1537   # localization is neccessary as
1538   # 1) there is no infrastructure to pass this around before SQLA2
1539   # 2) _select_args sets it and _prep_for_execute consumes it
1540   my $sql_maker = $self->sql_maker;
1541   local $sql_maker->{_dbic_rs_attrs};
1542
1543   # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1544   #  = $self->_select_args($ident, $select, $cond, $attrs);
1545   my ($op, $bind, $ident, $bind_attrs, @args) =
1546     $self->_select_args(@_);
1547
1548   # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1549   my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1550   $prepared_bind ||= [];
1551
1552   return wantarray
1553     ? ($sql, $prepared_bind, $bind_attrs)
1554     : \[ "($sql)", @$prepared_bind ]
1555   ;
1556 }
1557
1558 sub _select_args {
1559   my ($self, $ident, $select, $where, $attrs) = @_;
1560
1561   my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1562
1563   my $sql_maker = $self->sql_maker;
1564   $sql_maker->{_dbic_rs_attrs} = {
1565     %$attrs,
1566     select => $select,
1567     from => $ident,
1568     where => $where,
1569     $rs_alias
1570       ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1571       : ()
1572     ,
1573   };
1574
1575   # calculate bind_attrs before possible $ident mangling
1576   my $bind_attrs = {};
1577   for my $alias (keys %$alias2source) {
1578     my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1579     for my $col (keys %$bindtypes) {
1580
1581       my $fqcn = join ('.', $alias, $col);
1582       $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1583
1584       # Unqialified column names are nice, but at the same time can be
1585       # rather ambiguous. What we do here is basically go along with
1586       # the loop, adding an unqualified column slot to $bind_attrs,
1587       # alongside the fully qualified name. As soon as we encounter
1588       # another column by that name (which would imply another table)
1589       # we unset the unqualified slot and never add any info to it
1590       # to avoid erroneous type binding. If this happens the users
1591       # only choice will be to fully qualify his column name
1592
1593       if (exists $bind_attrs->{$col}) {
1594         $bind_attrs->{$col} = {};
1595       }
1596       else {
1597         $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1598       }
1599     }
1600   }
1601
1602   # adjust limits
1603   if (
1604     $attrs->{software_limit}
1605       ||
1606     $sql_maker->_default_limit_syntax eq "GenericSubQ"
1607   ) {
1608     $attrs->{software_limit} = 1;
1609   }
1610   else {
1611     $self->throw_exception("rows attribute must be positive if present")
1612       if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1613
1614     # MySQL actually recommends this approach.  I cringe.
1615     $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1616   }
1617
1618   my @limit;
1619
1620   # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1621   # otherwise delegate the limiting to the storage, unless software limit was requested
1622   if (
1623     ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1624        ||
1625     ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1626       $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1627   ) {
1628     ($ident, $select, $where, $attrs)
1629       = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1630   }
1631   elsif (! $attrs->{software_limit} ) {
1632     push @limit, $attrs->{rows}, $attrs->{offset};
1633   }
1634
1635 ###
1636   # This would be the point to deflate anything found in $where
1637   # (and leave $attrs->{bind} intact). Problem is - inflators historically
1638   # expect a row object. And all we have is a resultsource (it is trivial
1639   # to extract deflator coderefs via $alias2source above).
1640   #
1641   # I don't see a way forward other than changing the way deflators are
1642   # invoked, and that's just bad...
1643 ###
1644
1645   my $order = { map
1646     { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : ()  }
1647     (qw/order_by group_by having/ )
1648   };
1649
1650   return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1651 }
1652
1653 #
1654 # This is the code producing joined subqueries like:
1655 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ... 
1656 #
1657 sub _adjust_select_args_for_complex_prefetch {
1658   my ($self, $from, $select, $where, $attrs) = @_;
1659
1660   $self->throw_exception ('Nothing to prefetch... how did we get here?!')
1661     if not @{$attrs->{_prefetch_select}};
1662
1663   $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1664     if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY');
1665
1666
1667   # generate inner/outer attribute lists, remove stuff that doesn't apply
1668   my $outer_attrs = { %$attrs };
1669   delete $outer_attrs->{$_} for qw/where bind rows offset group_by having/;
1670
1671   my $inner_attrs = { %$attrs };
1672   delete $inner_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1673
1674
1675   # bring over all non-collapse-induced order_by into the inner query (if any)
1676   # the outer one will have to keep them all
1677   delete $inner_attrs->{order_by};
1678   if (my $ord_cnt = @{$outer_attrs->{order_by}} - @{$outer_attrs->{_collapse_order_by}} ) {
1679     $inner_attrs->{order_by} = [
1680       @{$outer_attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1681     ];
1682   }
1683
1684
1685   # generate the inner/outer select lists
1686   # for inside we consider only stuff *not* brought in by the prefetch
1687   # on the outside we substitute any function for its alias
1688   my $outer_select = [ @$select ];
1689   my $inner_select = [];
1690   for my $i (0 .. ( @$outer_select - @{$outer_attrs->{_prefetch_select}} - 1) ) {
1691     my $sel = $outer_select->[$i];
1692
1693     if (ref $sel eq 'HASH' ) {
1694       $sel->{-as} ||= $attrs->{as}[$i];
1695       $outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
1696     }
1697
1698     push @$inner_select, $sel;
1699   }
1700
1701   # normalize a copy of $from, so it will be easier to work with further
1702   # down (i.e. promote the initial hashref to an AoH)
1703   $from = [ @$from ];
1704   $from->[0] = [ $from->[0] ];
1705   my %original_join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1706
1707
1708   # decide which parts of the join will remain in either part of
1709   # the outer/inner query
1710
1711   # First we compose a list of which aliases are used in restrictions
1712   # (i.e. conditions/order/grouping/etc). Since we do not have
1713   # introspectable SQLA, we fall back to ugly scanning of raw SQL for
1714   # WHERE, and for pieces of ORDER BY in order to determine which aliases
1715   # need to appear in the resulting sql.
1716   # It may not be very efficient, but it's a reasonable stop-gap
1717   # Also unqualified column names will not be considered, but more often
1718   # than not this is actually ok
1719   #
1720   # In the same loop we enumerate part of the selection aliases, as
1721   # it requires the same sqla hack for the time being
1722   my ($restrict_aliases, $select_aliases, $prefetch_aliases);
1723   {
1724     # produce stuff unquoted, so it can be scanned
1725     my $sql_maker = $self->sql_maker;
1726     local $sql_maker->{quote_char};
1727     my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1728     $sep = "\Q$sep\E";
1729
1730     my $non_prefetch_select_sql = $sql_maker->_recurse_fields ($inner_select);
1731     my $prefetch_select_sql = $sql_maker->_recurse_fields ($outer_attrs->{_prefetch_select});
1732     my $where_sql = $sql_maker->where ($where);
1733     my $group_by_sql = $sql_maker->_order_by({
1734       map { $_ => $inner_attrs->{$_} } qw/group_by having/
1735     });
1736     my @non_prefetch_order_by_chunks = (map
1737       { ref $_ ? $_->[0] : $_ }
1738       $sql_maker->_order_by_chunks ($inner_attrs->{order_by})
1739     );
1740
1741
1742     for my $alias (keys %original_join_info) {
1743       my $seen_re = qr/\b $alias $sep/x;
1744
1745       for my $piece ($where_sql, $group_by_sql, @non_prefetch_order_by_chunks ) {
1746         if ($piece =~ $seen_re) {
1747           $restrict_aliases->{$alias} = 1;
1748         }
1749       }
1750
1751       if ($non_prefetch_select_sql =~ $seen_re) {
1752           $select_aliases->{$alias} = 1;
1753       }
1754
1755       if ($prefetch_select_sql =~ $seen_re) {
1756           $prefetch_aliases->{$alias} = 1;
1757       }
1758
1759     }
1760   }
1761
1762   # Add any non-left joins to the restriction list (such joins are indeed restrictions)
1763   for my $j (values %original_join_info) {
1764     my $alias = $j->{-alias} or next;
1765     $restrict_aliases->{$alias} = 1 if (
1766       (not $j->{-join_type})
1767         or
1768       ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
1769     );
1770   }
1771
1772   # mark all join parents as mentioned
1773   # (e.g.  join => { cds => 'tracks' } - tracks will need to bring cds too )
1774   for my $collection ($restrict_aliases, $select_aliases) {
1775     for my $alias (keys %$collection) {
1776       $collection->{$_} = 1
1777         for (@{ $original_join_info{$alias}{-join_path} || [] });
1778     }
1779   }
1780
1781   # construct the inner $from for the subquery
1782   my %inner_joins = (map { %{$_ || {}} } ($restrict_aliases, $select_aliases) );
1783   my @inner_from;
1784   for my $j (@$from) {
1785     push @inner_from, $j if $inner_joins{$j->[0]{-alias}};
1786   }
1787
1788   # if a multi-type join was needed in the subquery ("multi" is indicated by
1789   # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1790   unless ($inner_attrs->{group_by}) {
1791     for my $alias (keys %inner_joins) {
1792
1793       # the dot comes from some weirdness in collapse
1794       # remove after the rewrite
1795       if ($attrs->{collapse}{".$alias"}) {
1796         $inner_attrs->{group_by} ||= $inner_select;
1797         last;
1798       }
1799     }
1800   }
1801
1802   # demote the inner_from head
1803   $inner_from[0] = $inner_from[0][0];
1804
1805   # generate the subquery
1806   my $subq = $self->_select_args_to_query (
1807     \@inner_from,
1808     $inner_select,
1809     $where,
1810     $inner_attrs,
1811   );
1812
1813   my $subq_joinspec = {
1814     -alias => $attrs->{alias},
1815     -source_handle => $inner_from[0]{-source_handle},
1816     $attrs->{alias} => $subq,
1817   };
1818
1819   # Generate the outer from - this is relatively easy (really just replace
1820   # the join slot with the subquery), with a major caveat - we can not
1821   # join anything that is non-selecting (not part of the prefetch), but at
1822   # the same time is a multi-type relationship, as it will explode the result.
1823   #
1824   # There are two possibilities here
1825   # - either the join is non-restricting, in which case we simply throw it away
1826   # - it is part of the restrictions, in which case we need to collapse the outer
1827   #   result by tackling yet another group_by to the outside of the query
1828
1829   # so first generate the outer_from, up to the substitution point
1830   my @outer_from;
1831   while (my $j = shift @$from) {
1832     if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
1833       push @outer_from, [
1834         $subq_joinspec,
1835         @{$j}[1 .. $#$j],
1836       ];
1837       last; # we'll take care of what's left in $from below
1838     }
1839     else {
1840       push @outer_from, $j;
1841     }
1842   }
1843
1844   # see what's left - throw away if not selecting/restricting
1845   # also throw in a group_by if restricting to guard against
1846   # cross-join explosions
1847   #
1848   while (my $j = shift @$from) {
1849     my $alias = $j->[0]{-alias};
1850
1851     if ($select_aliases->{$alias} || $prefetch_aliases->{$alias}) {
1852       push @outer_from, $j;
1853     }
1854     elsif ($restrict_aliases->{$alias}) {
1855       push @outer_from, $j;
1856
1857       # FIXME - this should be obviated by SQLA2, as I'll be able to 
1858       # have restrict_inner and restrict_outer... or something to that
1859       # effect... I think...
1860
1861       # FIXME2 - I can't find a clean way to determine if a particular join
1862       # is a multi - instead I am just treating everything as a potential
1863       # explosive join (ribasushi)
1864       #
1865       # if (my $handle = $j->[0]{-source_handle}) {
1866       #   my $rsrc = $handle->resolve;
1867       #   ... need to bail out of the following if this is not a multi,
1868       #       as it will be much easier on the db ...
1869
1870           $outer_attrs->{group_by} ||= $outer_select;
1871       # }
1872     }
1873   }
1874
1875   # demote the outer_from head
1876   $outer_from[0] = $outer_from[0][0];
1877
1878   # This is totally horrific - the $where ends up in both the inner and outer query
1879   # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1880   # then if where conditions apply to the *right* side of the prefetch, you may have
1881   # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1882   # the outer select to exclude joins you didin't want in the first place
1883   #
1884   # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1885   return (\@outer_from, $outer_select, $where, $outer_attrs);
1886 }
1887
1888 sub _resolve_ident_sources {
1889   my ($self, $ident) = @_;
1890
1891   my $alias2source = {};
1892   my $rs_alias;
1893
1894   # the reason this is so contrived is that $ident may be a {from}
1895   # structure, specifying multiple tables to join
1896   if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1897     # this is compat mode for insert/update/delete which do not deal with aliases
1898     $alias2source->{me} = $ident;
1899     $rs_alias = 'me';
1900   }
1901   elsif (ref $ident eq 'ARRAY') {
1902
1903     for (@$ident) {
1904       my $tabinfo;
1905       if (ref $_ eq 'HASH') {
1906         $tabinfo = $_;
1907         $rs_alias = $tabinfo->{-alias};
1908       }
1909       if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1910         $tabinfo = $_->[0];
1911       }
1912
1913       $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1914         if ($tabinfo->{-source_handle});
1915     }
1916   }
1917
1918   return ($alias2source, $rs_alias);
1919 }
1920
1921 # Takes $ident, \@column_names
1922 #
1923 # returns { $column_name => \%column_info, ... }
1924 # also note: this adds -result_source => $rsrc to the column info
1925 #
1926 # usage:
1927 #   my $col_sources = $self->_resolve_column_info($ident, @column_names);
1928 sub _resolve_column_info {
1929   my ($self, $ident, $colnames) = @_;
1930   my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1931
1932   my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1933   $sep = "\Q$sep\E";
1934
1935   my (%return, %seen_cols);
1936
1937   # compile a global list of column names, to be able to properly
1938   # disambiguate unqualified column names (if at all possible)
1939   for my $alias (keys %$alias2src) {
1940     my $rsrc = $alias2src->{$alias};
1941     for my $colname ($rsrc->columns) {
1942       push @{$seen_cols{$colname}}, $alias;
1943     }
1944   }
1945
1946   COLUMN:
1947   foreach my $col (@$colnames) {
1948     my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1949
1950     unless ($alias) {
1951       # see if the column was seen exactly once (so we know which rsrc it came from)
1952       if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1953         $alias = $seen_cols{$colname}[0];
1954       }
1955       else {
1956         next COLUMN;
1957       }
1958     }
1959
1960     my $rsrc = $alias2src->{$alias};
1961     $return{$col} = $rsrc && {
1962       %{$rsrc->column_info($colname)},
1963       -result_source => $rsrc,
1964       -source_alias => $alias,
1965     };
1966   }
1967
1968   return \%return;
1969 }
1970
1971 # Returns a counting SELECT for a simple count
1972 # query. Abstracted so that a storage could override
1973 # this to { count => 'firstcol' } or whatever makes
1974 # sense as a performance optimization
1975 sub _count_select {
1976   #my ($self, $source, $rs_attrs) = @_;
1977   return { count => '*' };
1978 }
1979
1980 # Returns a SELECT which will end up in the subselect
1981 # There may or may not be a group_by, as the subquery
1982 # might have been called to accomodate a limit
1983 #
1984 # Most databases would be happy with whatever ends up
1985 # here, but some choke in various ways.
1986 #
1987 sub _subq_count_select {
1988   my ($self, $source, $rs_attrs) = @_;
1989   return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1990
1991   my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1992   return @pcols ? \@pcols : [ 1 ];
1993 }
1994
1995 #
1996 # Returns an ordered list of column names before they are used
1997 # in a SELECT statement. By default simply returns the list
1998 # passed in.
1999 #
2000 # This may be overridden in a specific storage when there are
2001 # requirements such as moving BLOB columns to the end of the 
2002 # SELECT list.
2003 sub _order_select_columns {
2004   #my ($self, $source, $columns) = @_;
2005   return @{$_[2]};
2006 }
2007
2008 sub source_bind_attributes {
2009   my ($self, $source) = @_;
2010
2011   my $bind_attributes;
2012   foreach my $column ($source->columns) {
2013
2014     my $data_type = $source->column_info($column)->{data_type} || '';
2015     $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2016      if $data_type;
2017   }
2018
2019   return $bind_attributes;
2020 }
2021
2022 =head2 select
2023
2024 =over 4
2025
2026 =item Arguments: $ident, $select, $condition, $attrs
2027
2028 =back
2029
2030 Handle a SQL select statement.
2031
2032 =cut
2033
2034 sub select {
2035   my $self = shift;
2036   my ($ident, $select, $condition, $attrs) = @_;
2037   return $self->cursor_class->new($self, \@_, $attrs);
2038 }
2039
2040 sub select_single {
2041   my $self = shift;
2042   my ($rv, $sth, @bind) = $self->_select(@_);
2043   my @row = $sth->fetchrow_array;
2044   my @nextrow = $sth->fetchrow_array if @row;
2045   if(@row && @nextrow) {
2046     carp "Query returned more than one row.  SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2047   }
2048   # Need to call finish() to work round broken DBDs
2049   $sth->finish();
2050   return @row;
2051 }
2052
2053 =head2 sth
2054
2055 =over 4
2056
2057 =item Arguments: $sql
2058
2059 =back
2060
2061 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2062
2063 =cut
2064
2065 sub _dbh_sth {
2066   my ($self, $dbh, $sql) = @_;
2067
2068   # 3 is the if_active parameter which avoids active sth re-use
2069   my $sth = $self->disable_sth_caching
2070     ? $dbh->prepare($sql)
2071     : $dbh->prepare_cached($sql, {}, 3);
2072
2073   # XXX You would think RaiseError would make this impossible,
2074   #  but apparently that's not true :(
2075   $self->throw_exception($dbh->errstr) if !$sth;
2076
2077   $sth;
2078 }
2079
2080 sub sth {
2081   my ($self, $sql) = @_;
2082   $self->dbh_do('_dbh_sth', $sql);  # retry over disconnects
2083 }
2084
2085 sub _dbh_columns_info_for {
2086   my ($self, $dbh, $table) = @_;
2087
2088   if ($dbh->can('column_info')) {
2089     my %result;
2090     eval {
2091       my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2092       my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2093       $sth->execute();
2094       while ( my $info = $sth->fetchrow_hashref() ){
2095         my %column_info;
2096         $column_info{data_type}   = $info->{TYPE_NAME};
2097         $column_info{size}      = $info->{COLUMN_SIZE};
2098         $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
2099         $column_info{default_value} = $info->{COLUMN_DEF};
2100         my $col_name = $info->{COLUMN_NAME};
2101         $col_name =~ s/^\"(.*)\"$/$1/;
2102
2103         $result{$col_name} = \%column_info;
2104       }
2105     };
2106     return \%result if !$@ && scalar keys %result;
2107   }
2108
2109   my %result;
2110   my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2111   $sth->execute;
2112   my @columns = @{$sth->{NAME_lc}};
2113   for my $i ( 0 .. $#columns ){
2114     my %column_info;
2115     $column_info{data_type} = $sth->{TYPE}->[$i];
2116     $column_info{size} = $sth->{PRECISION}->[$i];
2117     $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2118
2119     if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2120       $column_info{data_type} = $1;
2121       $column_info{size}    = $2;
2122     }
2123
2124     $result{$columns[$i]} = \%column_info;
2125   }
2126   $sth->finish;
2127
2128   foreach my $col (keys %result) {
2129     my $colinfo = $result{$col};
2130     my $type_num = $colinfo->{data_type};
2131     my $type_name;
2132     if(defined $type_num && $dbh->can('type_info')) {
2133       my $type_info = $dbh->type_info($type_num);
2134       $type_name = $type_info->{TYPE_NAME} if $type_info;
2135       $colinfo->{data_type} = $type_name if $type_name;
2136     }
2137   }
2138
2139   return \%result;
2140 }
2141
2142 sub columns_info_for {
2143   my ($self, $table) = @_;
2144   $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2145 }
2146
2147 =head2 last_insert_id
2148
2149 Return the row id of the last insert.
2150
2151 =cut
2152
2153 sub _dbh_last_insert_id {
2154     # All Storage's need to register their own _dbh_last_insert_id
2155     # the old SQLite-based method was highly inappropriate
2156
2157     my $self = shift;
2158     my $class = ref $self;
2159     $self->throw_exception (<<EOE);
2160
2161 No _dbh_last_insert_id() method found in $class.
2162 Since the method of obtaining the autoincrement id of the last insert
2163 operation varies greatly between different databases, this method must be
2164 individually implemented for every storage class.
2165 EOE
2166 }
2167
2168 sub last_insert_id {
2169   my $self = shift;
2170   $self->_dbh_last_insert_id ($self->_dbh, @_);
2171 }
2172
2173 =head2 _native_data_type
2174
2175 =over 4
2176
2177 =item Arguments: $type_name
2178
2179 =back
2180
2181 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2182 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2183 L<::Sybase|DBIx::Class::Storage::DBI::Sybase>.
2184
2185 The default implementation returns C<undef>, implement in your Storage driver if
2186 you need this functionality.
2187
2188 Should map types from other databases to the native RDBMS type, for example
2189 C<VARCHAR2> to C<VARCHAR>.
2190
2191 Types with modifiers should map to the underlying data type. For example,
2192 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2193
2194 Composite types should map to the container type, for example
2195 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2196
2197 =cut
2198
2199 sub _native_data_type {
2200   #my ($self, $data_type) = @_;
2201   return undef
2202 }
2203
2204 # Check if placeholders are supported at all
2205 sub _placeholders_supported {
2206   my $self = shift;
2207   my $dbh  = $self->_get_dbh;
2208
2209   # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2210   # but it is inaccurate more often than not
2211   eval {
2212     local $dbh->{PrintError} = 0;
2213     local $dbh->{RaiseError} = 1;
2214     $dbh->do('select ?', {}, 1);
2215   };
2216   return $@ ? 0 : 1;
2217 }
2218
2219 # Check if placeholders bound to non-string types throw exceptions
2220 #
2221 sub _typeless_placeholders_supported {
2222   my $self = shift;
2223   my $dbh  = $self->_get_dbh;
2224
2225   eval {
2226     local $dbh->{PrintError} = 0;
2227     local $dbh->{RaiseError} = 1;
2228     # this specifically tests a bind that is NOT a string
2229     $dbh->do('select 1 where 1 = ?', {}, 1);
2230   };
2231   return $@ ? 0 : 1;
2232 }
2233
2234 =head2 sqlt_type
2235
2236 Returns the database driver name.
2237
2238 =cut
2239
2240 sub sqlt_type {
2241   my ($self) = @_;
2242
2243   if (not $self->_driver_determined) {
2244     $self->_determine_driver;
2245     goto $self->can ('sqlt_type');
2246   }
2247
2248   $self->_get_dbh->{Driver}->{Name};
2249 }
2250
2251 =head2 bind_attribute_by_data_type
2252
2253 Given a datatype from column info, returns a database specific bind
2254 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2255 let the database planner just handle it.
2256
2257 Generally only needed for special case column types, like bytea in postgres.
2258
2259 =cut
2260
2261 sub bind_attribute_by_data_type {
2262     return;
2263 }
2264
2265 =head2 is_datatype_numeric
2266
2267 Given a datatype from column_info, returns a boolean value indicating if
2268 the current RDBMS considers it a numeric value. This controls how
2269 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2270 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2271 be performed instead of the usual C<eq>.
2272
2273 =cut
2274
2275 sub is_datatype_numeric {
2276   my ($self, $dt) = @_;
2277
2278   return 0 unless $dt;
2279
2280   return $dt =~ /^ (?:
2281     numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2282   ) $/ix;
2283 }
2284
2285
2286 =head2 create_ddl_dir (EXPERIMENTAL)
2287
2288 =over 4
2289
2290 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2291
2292 =back
2293
2294 Creates a SQL file based on the Schema, for each of the specified
2295 database engines in C<\@databases> in the given directory.
2296 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2297
2298 Given a previous version number, this will also create a file containing
2299 the ALTER TABLE statements to transform the previous schema into the
2300 current one. Note that these statements may contain C<DROP TABLE> or
2301 C<DROP COLUMN> statements that can potentially destroy data.
2302
2303 The file names are created using the C<ddl_filename> method below, please
2304 override this method in your schema if you would like a different file
2305 name format. For the ALTER file, the same format is used, replacing
2306 $version in the name with "$preversion-$version".
2307
2308 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2309 The most common value for this would be C<< { add_drop_table => 1 } >>
2310 to have the SQL produced include a C<DROP TABLE> statement for each table
2311 created. For quoting purposes supply C<quote_table_names> and
2312 C<quote_field_names>.
2313
2314 If no arguments are passed, then the following default values are assumed:
2315
2316 =over 4
2317
2318 =item databases  - ['MySQL', 'SQLite', 'PostgreSQL']
2319
2320 =item version    - $schema->schema_version
2321
2322 =item directory  - './'
2323
2324 =item preversion - <none>
2325
2326 =back
2327
2328 By default, C<\%sqlt_args> will have
2329
2330  { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2331
2332 merged with the hash passed in. To disable any of those features, pass in a
2333 hashref like the following
2334
2335  { ignore_constraint_names => 0, # ... other options }
2336
2337
2338 Note that this feature is currently EXPERIMENTAL and may not work correctly
2339 across all databases, or fully handle complex relationships.
2340
2341 WARNING: Please check all SQL files created, before applying them.
2342
2343 =cut
2344
2345 sub create_ddl_dir {
2346   my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2347
2348   if(!$dir || !-d $dir) {
2349     carp "No directory given, using ./\n";
2350     $dir = "./";
2351   }
2352   $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2353   $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2354
2355   my $schema_version = $schema->schema_version || '1.x';
2356   $version ||= $schema_version;
2357
2358   $sqltargs = {
2359     add_drop_table => 1,
2360     ignore_constraint_names => 1,
2361     ignore_index_names => 1,
2362     %{$sqltargs || {}}
2363   };
2364
2365   $self->throw_exception("Can't create a ddl file without SQL::Translator: " . $self->_sqlt_version_error)
2366     if !$self->_sqlt_version_ok;
2367
2368   my $sqlt = SQL::Translator->new( $sqltargs );
2369
2370   $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2371   my $sqlt_schema = $sqlt->translate({ data => $schema })
2372     or $self->throw_exception ($sqlt->error);
2373
2374   foreach my $db (@$databases) {
2375     $sqlt->reset();
2376     $sqlt->{schema} = $sqlt_schema;
2377     $sqlt->producer($db);
2378
2379     my $file;
2380     my $filename = $schema->ddl_filename($db, $version, $dir);
2381     if (-e $filename && ($version eq $schema_version )) {
2382       # if we are dumping the current version, overwrite the DDL
2383       carp "Overwriting existing DDL file - $filename";
2384       unlink($filename);
2385     }
2386
2387     my $output = $sqlt->translate;
2388     if(!$output) {
2389       carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2390       next;
2391     }
2392     if(!open($file, ">$filename")) {
2393       $self->throw_exception("Can't open $filename for writing ($!)");
2394       next;
2395     }
2396     print $file $output;
2397     close($file);
2398
2399     next unless ($preversion);
2400
2401     require SQL::Translator::Diff;
2402
2403     my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2404     if(!-e $prefilename) {
2405       carp("No previous schema file found ($prefilename)");
2406       next;
2407     }
2408
2409     my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2410     if(-e $difffile) {
2411       carp("Overwriting existing diff file - $difffile");
2412       unlink($difffile);
2413     }
2414
2415     my $source_schema;
2416     {
2417       my $t = SQL::Translator->new($sqltargs);
2418       $t->debug( 0 );
2419       $t->trace( 0 );
2420
2421       $t->parser( $db )
2422         or $self->throw_exception ($t->error);
2423
2424       my $out = $t->translate( $prefilename )
2425         or $self->throw_exception ($t->error);
2426
2427       $source_schema = $t->schema;
2428
2429       $source_schema->name( $prefilename )
2430         unless ( $source_schema->name );
2431     }
2432
2433     # The "new" style of producers have sane normalization and can support
2434     # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2435     # And we have to diff parsed SQL against parsed SQL.
2436     my $dest_schema = $sqlt_schema;
2437
2438     unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2439       my $t = SQL::Translator->new($sqltargs);
2440       $t->debug( 0 );
2441       $t->trace( 0 );
2442
2443       $t->parser( $db )
2444         or $self->throw_exception ($t->error);
2445
2446       my $out = $t->translate( $filename )
2447         or $self->throw_exception ($t->error);
2448
2449       $dest_schema = $t->schema;
2450
2451       $dest_schema->name( $filename )
2452         unless $dest_schema->name;
2453     }
2454
2455     my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2456                                                   $dest_schema,   $db,
2457                                                   $sqltargs
2458                                                  );
2459     if(!open $file, ">$difffile") {
2460       $self->throw_exception("Can't write to $difffile ($!)");
2461       next;
2462     }
2463     print $file $diff;
2464     close($file);
2465   }
2466 }
2467
2468 =head2 deployment_statements
2469
2470 =over 4
2471
2472 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2473
2474 =back
2475
2476 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2477
2478 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2479 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2480
2481 C<$directory> is used to return statements from files in a previously created
2482 L</create_ddl_dir> directory and is optional. The filenames are constructed
2483 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2484
2485 If no C<$directory> is specified then the statements are constructed on the
2486 fly using L<SQL::Translator> and C<$version> is ignored.
2487
2488 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2489
2490 =cut
2491
2492 sub deployment_statements {
2493   my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2494   $type ||= $self->sqlt_type;
2495   $version ||= $schema->schema_version || '1.x';
2496   $dir ||= './';
2497   my $filename = $schema->ddl_filename($type, $version, $dir);
2498   if(-f $filename)
2499   {
2500       my $file;
2501       open($file, "<$filename")
2502         or $self->throw_exception("Can't open $filename ($!)");
2503       my @rows = <$file>;
2504       close($file);
2505       return join('', @rows);
2506   }
2507
2508   $self->throw_exception("Can't deploy without either SQL::Translator or a ddl_dir: " . $self->_sqlt_version_error )
2509     if !$self->_sqlt_version_ok;
2510
2511   # sources needs to be a parser arg, but for simplicty allow at top level
2512   # coming in
2513   $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2514       if exists $sqltargs->{sources};
2515
2516   my $tr = SQL::Translator->new(
2517     producer => "SQL::Translator::Producer::${type}",
2518     %$sqltargs,
2519     parser => 'SQL::Translator::Parser::DBIx::Class',
2520     data => $schema,
2521   );
2522   return $tr->translate;
2523 }
2524
2525 sub deploy {
2526   my ($self, $schema, $type, $sqltargs, $dir) = @_;
2527   my $deploy = sub {
2528     my $line = shift;
2529     return if($line =~ /^--/);
2530     return if(!$line);
2531     # next if($line =~ /^DROP/m);
2532     return if($line =~ /^BEGIN TRANSACTION/m);
2533     return if($line =~ /^COMMIT/m);
2534     return if $line =~ /^\s+$/; # skip whitespace only
2535     $self->_query_start($line);
2536     eval {
2537       # do a dbh_do cycle here, as we need some error checking in
2538       # place (even though we will ignore errors)
2539       $self->dbh_do (sub { $_[1]->do($line) });
2540     };
2541     if ($@) {
2542       carp qq{$@ (running "${line}")};
2543     }
2544     $self->_query_end($line);
2545   };
2546   my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2547   if (@statements > 1) {
2548     foreach my $statement (@statements) {
2549       $deploy->( $statement );
2550     }
2551   }
2552   elsif (@statements == 1) {
2553     foreach my $line ( split(";\n", $statements[0])) {
2554       $deploy->( $line );
2555     }
2556   }
2557 }
2558
2559 =head2 datetime_parser
2560
2561 Returns the datetime parser class
2562
2563 =cut
2564
2565 sub datetime_parser {
2566   my $self = shift;
2567   return $self->{datetime_parser} ||= do {
2568     $self->build_datetime_parser(@_);
2569   };
2570 }
2571
2572 =head2 datetime_parser_type
2573
2574 Defines (returns) the datetime parser class - currently hardwired to
2575 L<DateTime::Format::MySQL>
2576
2577 =cut
2578
2579 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2580
2581 =head2 build_datetime_parser
2582
2583 See L</datetime_parser>
2584
2585 =cut
2586
2587 sub build_datetime_parser {
2588   if (not $_[0]->_driver_determined) {
2589     $_[0]->_determine_driver;
2590     goto $_[0]->can('build_datetime_parser');
2591   }
2592
2593   my $self = shift;
2594   my $type = $self->datetime_parser_type(@_);
2595   $self->ensure_class_loaded ($type);
2596   return $type;
2597 }
2598
2599
2600 =head2 is_replicating
2601
2602 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2603 replicate from a master database.  Default is undef, which is the result
2604 returned by databases that don't support replication.
2605
2606 =cut
2607
2608 sub is_replicating {
2609     return;
2610
2611 }
2612
2613 =head2 lag_behind_master
2614
2615 Returns a number that represents a certain amount of lag behind a master db
2616 when a given storage is replicating.  The number is database dependent, but
2617 starts at zero and increases with the amount of lag. Default in undef
2618
2619 =cut
2620
2621 sub lag_behind_master {
2622     return;
2623 }
2624
2625 sub DESTROY {
2626   my $self = shift;
2627
2628   $self->_verify_pid if $self->_dbh;
2629
2630   # some databases need this to stop spewing warnings
2631   if (my $dbh = $self->_dbh) {
2632     local $@;
2633     eval { $dbh->disconnect };
2634   }
2635
2636   $self->_dbh(undef);
2637 }
2638
2639 1;
2640
2641 =head1 USAGE NOTES
2642
2643 =head2 DBIx::Class and AutoCommit
2644
2645 DBIx::Class can do some wonderful magic with handling exceptions,
2646 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2647 (the default) combined with C<txn_do> for transaction support.
2648
2649 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2650 in an assumed transaction between commits, and you're telling us you'd
2651 like to manage that manually.  A lot of the magic protections offered by
2652 this module will go away.  We can't protect you from exceptions due to database
2653 disconnects because we don't know anything about how to restart your
2654 transactions.  You're on your own for handling all sorts of exceptional
2655 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2656 be with raw DBI.
2657
2658
2659 =head1 AUTHORS
2660
2661 Matt S. Trout <mst@shadowcatsystems.co.uk>
2662
2663 Andy Grundman <andy@hybridized.org>
2664
2665 =head1 LICENSE
2666
2667 You may distribute this code under the same terms as Perl itself.
2668
2669 =cut