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