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 sub _rebless {}
 840
 841 sub _populate_dbh {
 842   my ($self) = @_;
 843
 844   my @info = @{$self->_dbi_connect_info || []};
 845   $self->_dbh(undef); # in case ->connected failed we might get sent here
 846   $self->_dbh($self->_connect(@info));
 847
 848   $self->_conn_pid($$);
 849   $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
 850
 851   $self->_determine_driver;
 852
 853   # Always set the transaction depth on connect, since
 854   #  there is no transaction in progress by definition
 855   $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
 856
 857   $self->_run_connection_actions unless $self->{_in_determine_driver};
 858 }
 859
 860 sub _run_connection_actions {
 861   my $self = shift;
 862   my @actions;
 863
 864   push @actions, ( $self->on_connect_call || () );
 865   push @actions, $self->_parse_connect_do ('on_connect_do');
 866
 867   $self->_do_connection_actions(connect_call_ => $_) for @actions;
 868 }
 869
 870 sub _determine_driver {
 871   my ($self) = @_;
 872
 873   if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
 874     my $started_unconnected = 0;
 875     local $self->{_in_determine_driver} = 1;
 876
 877     if (ref($self) eq __PACKAGE__) {
 878       my $driver;
 879       if ($self->_dbh) { # we are connected
 880         $driver = $self->_dbh->{Driver}{Name};
 881       } else {
 882         # if connect_info is a CODEREF, we have no choice but to connect
 883         if (ref $self->_dbi_connect_info->[0] &&
 884             Scalar::Util::reftype($self->_dbi_connect_info->[0]) eq 'CODE') {
 885           $self->_populate_dbh;
 886           $driver = $self->_dbh->{Driver}{Name};
 887         }
 888         else {
 889           # try to use dsn to not require being connected, the driver may still
 890           # force a connection in _rebless to determine version
 891           ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
 892           $started_unconnected = 1;
 893         }
 894       }
 895
 896       my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
 897       if ($self->load_optional_class($storage_class)) {
 898         mro::set_mro($storage_class, 'c3');
 899         bless $self, $storage_class;
 900         $self->_rebless();
 901       }
 902     }
 903
 904     $self->_driver_determined(1);
 905
 906     $self->_run_connection_actions
 907         if $started_unconnected && defined $self->_dbh;
 908   }
 909 }
 910
 911 sub _do_connection_actions {
 912   my $self          = shift;
 913   my $method_prefix = shift;
 914   my $call          = shift;
 915
 916   if (not ref($call)) {
 917     my $method = $method_prefix . $call;
 918     $self->$method(@_);
 919   } elsif (ref($call) eq 'CODE') {
 920     $self->$call(@_);
 921   } elsif (ref($call) eq 'ARRAY') {
 922     if (ref($call->[0]) ne 'ARRAY') {
 923       $self->_do_connection_actions($method_prefix, $_) for @$call;
 924     } else {
 925       $self->_do_connection_actions($method_prefix, @$_) for @$call;
 926     }
 927   } else {
 928     $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
 929   }
 930
 931   return $self;
 932 }
 933
 934 sub connect_call_do_sql {
 935   my $self = shift;
 936   $self->_do_query(@_);
 937 }
 938
 939 sub disconnect_call_do_sql {
 940   my $self = shift;
 941   $self->_do_query(@_);
 942 }
 943
 944 # override in db-specific backend when necessary
 945 sub connect_call_datetime_setup { 1 }
 946
 947 sub _do_query {
 948   my ($self, $action) = @_;
 949
 950   if (ref $action eq 'CODE') {
 951     $action = $action->($self);
 952     $self->_do_query($_) foreach @$action;
 953   }
 954   else {
 955     # Most debuggers expect ($sql, @bind), so we need to exclude
 956     # the attribute hash which is the second argument to $dbh->do
 957     # furthermore the bind values are usually to be presented
 958     # as named arrayref pairs, so wrap those here too
 959     my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
 960     my $sql = shift @do_args;
 961     my $attrs = shift @do_args;
 962     my @bind = map { [ undef, $_ ] } @do_args;
 963
 964     $self->_query_start($sql, @bind);
 965     $self->_get_dbh->do($sql, $attrs, @do_args);
 966     $self->_query_end($sql, @bind);
 967   }
 968
 969   return $self;
 970 }
 971
 972 sub _connect {
 973   my ($self, @info) = @_;
 974
 975   $self->throw_exception("You failed to provide any connection info")
 976     if !@info;
 977
 978   my ($old_connect_via, $dbh);
 979
 980   if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
 981     $old_connect_via = $DBI::connect_via;
 982     $DBI::connect_via = 'connect';
 983   }
 984
 985   eval {
 986     if(ref $info[0] eq 'CODE') {
 987        $dbh = &{$info[0]}
 988     }
 989     else {
 990        $dbh = DBI->connect(@info);
 991     }
 992
 993     if($dbh && !$self->unsafe) {
 994       my $weak_self = $self;
 995       Scalar::Util::weaken($weak_self);
 996       $dbh->{HandleError} = sub {
 997           if ($weak_self) {
 998             $weak_self->throw_exception("DBI Exception: $_[0]");
 999           }
1000           else {
1001             croak ("DBI Exception: $_[0]");
1002           }
1003       };
1004       $dbh->{ShowErrorStatement} = 1;
1005       $dbh->{RaiseError} = 1;
1006       $dbh->{PrintError} = 0;
1007     }
1008   };
1009
1010   $DBI::connect_via = $old_connect_via if $old_connect_via;
1011
1012   $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1013     if !$dbh || $@;
1014
1015   $self->_dbh_autocommit($dbh->{AutoCommit});
1016
1017   $dbh;
1018 }
1019
1020 sub svp_begin {
1021   my ($self, $name) = @_;
1022
1023   $name = $self->_svp_generate_name
1024     unless defined $name;
1025
1026   $self->throw_exception ("You can't use savepoints outside a transaction")
1027     if $self->{transaction_depth} == 0;
1028
1029   $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1030     unless $self->can('_svp_begin');
1031
1032   push @{ $self->{savepoints} }, $name;
1033
1034   $self->debugobj->svp_begin($name) if $self->debug;
1035
1036   return $self->_svp_begin($name);
1037 }
1038
1039 sub svp_release {
1040   my ($self, $name) = @_;
1041
1042   $self->throw_exception ("You can't use savepoints outside a transaction")
1043     if $self->{transaction_depth} == 0;
1044
1045   $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1046     unless $self->can('_svp_release');
1047
1048   if (defined $name) {
1049     $self->throw_exception ("Savepoint '$name' does not exist")
1050       unless grep { $_ eq $name } @{ $self->{savepoints} };
1051
1052     # Dig through the stack until we find the one we are releasing.  This keeps
1053     # the stack up to date.
1054     my $svp;
1055
1056     do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1057   } else {
1058     $name = pop @{ $self->{savepoints} };
1059   }
1060
1061   $self->debugobj->svp_release($name) if $self->debug;
1062
1063   return $self->_svp_release($name);
1064 }
1065
1066 sub svp_rollback {
1067   my ($self, $name) = @_;
1068
1069   $self->throw_exception ("You can't use savepoints outside a transaction")
1070     if $self->{transaction_depth} == 0;
1071
1072   $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1073     unless $self->can('_svp_rollback');
1074
1075   if (defined $name) {
1076       # If they passed us a name, verify that it exists in the stack
1077       unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1078           $self->throw_exception("Savepoint '$name' does not exist!");
1079       }
1080
1081       # Dig through the stack until we find the one we are releasing.  This keeps
1082       # the stack up to date.
1083       while(my $s = pop(@{ $self->{savepoints} })) {
1084           last if($s eq $name);
1085       }
1086       # Add the savepoint back to the stack, as a rollback doesn't remove the
1087       # named savepoint, only everything after it.
1088       push(@{ $self->{savepoints} }, $name);
1089   } else {
1090       # We'll assume they want to rollback to the last savepoint
1091       $name = $self->{savepoints}->[-1];
1092   }
1093
1094   $self->debugobj->svp_rollback($name) if $self->debug;
1095
1096   return $self->_svp_rollback($name);
1097 }
1098
1099 sub _svp_generate_name {
1100     my ($self) = @_;
1101
1102     return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1103 }
1104
1105 sub txn_begin {
1106   my $self = shift;
1107   if($self->{transaction_depth} == 0) {
1108     $self->debugobj->txn_begin()
1109       if $self->debug;
1110     $self->_dbh_begin_work;
1111   }
1112   elsif ($self->auto_savepoint) {
1113     $self->svp_begin;
1114   }
1115   $self->{transaction_depth}++;
1116 }
1117
1118 sub _dbh_begin_work {
1119   my $self = shift;
1120
1121   # if the user is utilizing txn_do - good for him, otherwise we need to
1122   # ensure that the $dbh is healthy on BEGIN.
1123   # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1124   # will be replaced by a failure of begin_work itself (which will be
1125   # then retried on reconnect)
1126   if ($self->{_in_dbh_do}) {
1127     $self->_dbh->begin_work;
1128   } else {
1129     $self->dbh_do(sub { $_[1]->begin_work });
1130   }
1131 }
1132
1133 sub txn_commit {
1134   my $self = shift;
1135   if ($self->{transaction_depth} == 1) {
1136     my $dbh = $self->_dbh;
1137     $self->debugobj->txn_commit()
1138       if ($self->debug);
1139     $self->_dbh_commit;
1140     $self->{transaction_depth} = 0
1141       if $self->_dbh_autocommit;
1142   }
1143   elsif($self->{transaction_depth} > 1) {
1144     $self->{transaction_depth}--;
1145     $self->svp_release
1146       if $self->auto_savepoint;
1147   }
1148 }
1149
1150 sub _dbh_commit {
1151   my $self = shift;
1152   $self->_dbh->commit;
1153 }
1154
1155 sub txn_rollback {
1156   my $self = shift;
1157   my $dbh = $self->_dbh;
1158   eval {
1159     if ($self->{transaction_depth} == 1) {
1160       $self->debugobj->txn_rollback()
1161         if ($self->debug);
1162       $self->{transaction_depth} = 0
1163         if $self->_dbh_autocommit;
1164       $self->_dbh_rollback;
1165     }
1166     elsif($self->{transaction_depth} > 1) {
1167       $self->{transaction_depth}--;
1168       if ($self->auto_savepoint) {
1169         $self->svp_rollback;
1170         $self->svp_release;
1171       }
1172     }
1173     else {
1174       die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1175     }
1176   };
1177   if ($@) {
1178     my $error = $@;
1179     my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1180     $error =~ /$exception_class/ and $self->throw_exception($error);
1181     # ensure that a failed rollback resets the transaction depth
1182     $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1183     $self->throw_exception($error);
1184   }
1185 }
1186
1187 sub _dbh_rollback {
1188   my $self = shift;
1189   $self->_dbh->rollback;
1190 }
1191
1192 # This used to be the top-half of _execute.  It was split out to make it
1193 #  easier to override in NoBindVars without duping the rest.  It takes up
1194 #  all of _execute's args, and emits $sql, @bind.
1195 sub _prep_for_execute {
1196   my ($self, $op, $extra_bind, $ident, $args) = @_;
1197
1198   if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1199     $ident = $ident->from();
1200   }
1201
1202   my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1203
1204   unshift(@bind,
1205     map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1206       if $extra_bind;
1207   return ($sql, \@bind);
1208 }
1209
1210
1211 sub _fix_bind_params {
1212     my ($self, @bind) = @_;
1213
1214     ### Turn @bind from something like this:
1215     ###   ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1216     ### to this:
1217     ###   ( "'1'", "'1'", "'3'" )
1218     return
1219         map {
1220             if ( defined( $_ && $_->[1] ) ) {
1221                 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1222             }
1223             else { q{'NULL'}; }
1224         } @bind;
1225 }
1226
1227 sub _query_start {
1228     my ( $self, $sql, @bind ) = @_;
1229
1230     if ( $self->debug ) {
1231         @bind = $self->_fix_bind_params(@bind);
1232
1233         $self->debugobj->query_start( $sql, @bind );
1234     }
1235 }
1236
1237 sub _query_end {
1238     my ( $self, $sql, @bind ) = @_;
1239
1240     if ( $self->debug ) {
1241         @bind = $self->_fix_bind_params(@bind);
1242         $self->debugobj->query_end( $sql, @bind );
1243     }
1244 }
1245
1246 sub _dbh_execute {
1247   my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1248
1249   my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1250
1251   $self->_query_start( $sql, @$bind );
1252
1253   my $sth = $self->sth($sql,$op);
1254
1255   my $placeholder_index = 1;
1256
1257   foreach my $bound (@$bind) {
1258     my $attributes = {};
1259     my($column_name, @data) = @$bound;
1260
1261     if ($bind_attributes) {
1262       $attributes = $bind_attributes->{$column_name}
1263       if defined $bind_attributes->{$column_name};
1264     }
1265
1266     foreach my $data (@data) {
1267       my $ref = ref $data;
1268       $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1269
1270       $sth->bind_param($placeholder_index, $data, $attributes);
1271       $placeholder_index++;
1272     }
1273   }
1274
1275   # Can this fail without throwing an exception anyways???
1276   my $rv = $sth->execute();
1277   $self->throw_exception($sth->errstr) if !$rv;
1278
1279   $self->_query_end( $sql, @$bind );
1280
1281   return (wantarray ? ($rv, $sth, @$bind) : $rv);
1282 }
1283
1284 sub _execute {
1285     my $self = shift;
1286     $self->dbh_do('_dbh_execute', @_);  # retry over disconnects
1287 }
1288
1289 sub insert {
1290   my ($self, $source, $to_insert) = @_;
1291
1292 # redispatch to insert method of storage we reblessed into, if necessary
1293   if (not $self->_driver_determined) {
1294     $self->_determine_driver;
1295     goto $self->can('insert');
1296   }
1297
1298   my $ident = $source->from;
1299   my $bind_attributes = $self->source_bind_attributes($source);
1300
1301   my $updated_cols = {};
1302
1303   foreach my $col ( $source->columns ) {
1304     if ( !defined $to_insert->{$col} ) {
1305       my $col_info = $source->column_info($col);
1306
1307       if ( $col_info->{auto_nextval} ) {
1308         $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1309           'nextval',
1310           $col_info->{sequence} ||
1311             $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1312         );
1313       }
1314     }
1315   }
1316
1317   $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1318
1319   return $updated_cols;
1320 }
1321
1322 ## Still not quite perfect, and EXPERIMENTAL
1323 ## Currently it is assumed that all values passed will be "normal", i.e. not
1324 ## scalar refs, or at least, all the same type as the first set, the statement is
1325 ## only prepped once.
1326 sub insert_bulk {
1327   my ($self, $source, $cols, $data) = @_;
1328
1329 # redispatch to insert_bulk method of storage we reblessed into, if necessary
1330   if (not $self->_driver_determined) {
1331     $self->_determine_driver;
1332     goto $self->can('insert_bulk');
1333   }
1334
1335   my %colvalues;
1336   my $table = $source->from;
1337   @colvalues{@$cols} = (0..$#$cols);
1338   my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1339
1340   $self->_query_start( $sql, @bind );
1341   my $sth = $self->sth($sql);
1342
1343 #  @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1344
1345   ## This must be an arrayref, else nothing works!
1346   my $tuple_status = [];
1347
1348   ## Get the bind_attributes, if any exist
1349   my $bind_attributes = $self->source_bind_attributes($source);
1350
1351   ## Bind the values and execute
1352   my $placeholder_index = 1;
1353
1354   foreach my $bound (@bind) {
1355
1356     my $attributes = {};
1357     my ($column_name, $data_index) = @$bound;
1358
1359     if( $bind_attributes ) {
1360       $attributes = $bind_attributes->{$column_name}
1361       if defined $bind_attributes->{$column_name};
1362     }
1363
1364     my @data = map { $_->[$data_index] } @$data;
1365
1366     $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1367     $placeholder_index++;
1368   }
1369   my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1370   if (my $err = $@) {
1371     my $i = 0;
1372     ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1373
1374     $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1375       if ($i > $#$tuple_status);
1376
1377     require Data::Dumper;
1378     local $Data::Dumper::Terse = 1;
1379     local $Data::Dumper::Indent = 1;
1380     local $Data::Dumper::Useqq = 1;
1381     local $Data::Dumper::Quotekeys = 0;
1382
1383     $self->throw_exception(sprintf "%s for populate slice:\n%s",
1384       $tuple_status->[$i][1],
1385       Data::Dumper::Dumper(
1386         { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1387       ),
1388     );
1389   }
1390   $self->throw_exception($sth->errstr) if !$rv;
1391
1392   $self->_query_end( $sql, @bind );
1393   return (wantarray ? ($rv, $sth, @bind) : $rv);
1394 }
1395
1396 sub update {
1397   my ($self, $source, @args) = @_;
1398
1399 # redispatch to update method of storage we reblessed into, if necessary
1400   if (not $self->_driver_determined) {
1401     $self->_determine_driver;
1402     goto $self->can('update');
1403   }
1404
1405   my $bind_attributes = $self->source_bind_attributes($source);
1406
1407   return $self->_execute('update' => [], $source, $bind_attributes, @args);
1408 }
1409
1410
1411 sub delete {
1412   my $self = shift @_;
1413   my $source = shift @_;
1414   $self->_determine_driver;
1415   my $bind_attrs = $self->source_bind_attributes($source);
1416
1417   return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1418 }
1419
1420 # We were sent here because the $rs contains a complex search
1421 # which will require a subquery to select the correct rows
1422 # (i.e. joined or limited resultsets)
1423 #
1424 # Genarating a single PK column subquery is trivial and supported
1425 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1426 # Look at _multipk_update_delete()
1427 sub _subq_update_delete {
1428   my $self = shift;
1429   my ($rs, $op, $values) = @_;
1430
1431   my $rsrc = $rs->result_source;
1432
1433   # we already check this, but double check naively just in case. Should be removed soon
1434   my $sel = $rs->_resolved_attrs->{select};
1435   $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1436   my @pcols = $rsrc->primary_columns;
1437   if (@$sel != @pcols) {
1438     $self->throw_exception (
1439       'Subquery update/delete can not be called on resultsets selecting a'
1440      .' number of columns different than the number of primary keys'
1441     );
1442   }
1443
1444   if (@pcols == 1) {
1445     return $self->$op (
1446       $rsrc,
1447       $op eq 'update' ? $values : (),
1448       { $pcols[0] => { -in => $rs->as_query } },
1449     );
1450   }
1451
1452   else {
1453     return $self->_multipk_update_delete (@_);
1454   }
1455 }
1456
1457 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1458 # resultset update/delete involving subqueries. So by default resort
1459 # to simple (and inefficient) delete_all style per-row opearations,
1460 # while allowing specific storages to override this with a faster
1461 # implementation.
1462 #
1463 sub _multipk_update_delete {
1464   return shift->_per_row_update_delete (@_);
1465 }
1466
1467 # This is the default loop used to delete/update rows for multi PK
1468 # resultsets, and used by mysql exclusively (because it can't do anything
1469 # else).
1470 #
1471 # We do not use $row->$op style queries, because resultset update/delete
1472 # is not expected to cascade (this is what delete_all/update_all is for).
1473 #
1474 # There should be no race conditions as the entire operation is rolled
1475 # in a transaction.
1476 #
1477 sub _per_row_update_delete {
1478   my $self = shift;
1479   my ($rs, $op, $values) = @_;
1480
1481   my $rsrc = $rs->result_source;
1482   my @pcols = $rsrc->primary_columns;
1483
1484   my $guard = $self->txn_scope_guard;
1485
1486   # emulate the return value of $sth->execute for non-selects
1487   my $row_cnt = '0E0';
1488
1489   my $subrs_cur = $rs->cursor;
1490   while (my @pks = $subrs_cur->next) {
1491
1492     my $cond;
1493     for my $i (0.. $#pcols) {
1494       $cond->{$pcols[$i]} = $pks[$i];
1495     }
1496
1497     $self->$op (
1498       $rsrc,
1499       $op eq 'update' ? $values : (),
1500       $cond,
1501     );
1502
1503     $row_cnt++;
1504   }
1505
1506   $guard->commit;
1507
1508   return $row_cnt;
1509 }
1510
1511 sub _select {
1512   my $self = shift;
1513
1514   # localization is neccessary as
1515   # 1) there is no infrastructure to pass this around before SQLA2
1516   # 2) _select_args sets it and _prep_for_execute consumes it
1517   my $sql_maker = $self->sql_maker;
1518   local $sql_maker->{_dbic_rs_attrs};
1519
1520   return $self->_execute($self->_select_args(@_));
1521 }
1522
1523 sub _select_args_to_query {
1524   my $self = shift;
1525
1526   # localization is neccessary as
1527   # 1) there is no infrastructure to pass this around before SQLA2
1528   # 2) _select_args sets it and _prep_for_execute consumes it
1529   my $sql_maker = $self->sql_maker;
1530   local $sql_maker->{_dbic_rs_attrs};
1531
1532   # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1533   #  = $self->_select_args($ident, $select, $cond, $attrs);
1534   my ($op, $bind, $ident, $bind_attrs, @args) =
1535     $self->_select_args(@_);
1536
1537   # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1538   my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1539   $prepared_bind ||= [];
1540
1541   return wantarray
1542     ? ($sql, $prepared_bind, $bind_attrs)
1543     : \[ "($sql)", @$prepared_bind ]
1544   ;
1545 }
1546
1547 sub _select_args {
1548   my ($self, $ident, $select, $where, $attrs) = @_;
1549
1550   my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1551
1552   my $sql_maker = $self->sql_maker;
1553   $sql_maker->{_dbic_rs_attrs} = {
1554     %$attrs,
1555     select => $select,
1556     from => $ident,
1557     where => $where,
1558     $rs_alias
1559       ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1560       : ()
1561     ,
1562   };
1563
1564   # calculate bind_attrs before possible $ident mangling
1565   my $bind_attrs = {};
1566   for my $alias (keys %$alias2source) {
1567     my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1568     for my $col (keys %$bindtypes) {
1569
1570       my $fqcn = join ('.', $alias, $col);
1571       $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1572
1573       # Unqialified column names are nice, but at the same time can be
1574       # rather ambiguous. What we do here is basically go along with
1575       # the loop, adding an unqualified column slot to $bind_attrs,
1576       # alongside the fully qualified name. As soon as we encounter
1577       # another column by that name (which would imply another table)
1578       # we unset the unqualified slot and never add any info to it
1579       # to avoid erroneous type binding. If this happens the users
1580       # only choice will be to fully qualify his column name
1581
1582       if (exists $bind_attrs->{$col}) {
1583         $bind_attrs->{$col} = {};
1584       }
1585       else {
1586         $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1587       }
1588     }
1589   }
1590
1591   # adjust limits
1592   if (
1593     $attrs->{software_limit}
1594       ||
1595     $sql_maker->_default_limit_syntax eq "GenericSubQ"
1596   ) {
1597     $attrs->{software_limit} = 1;
1598   }
1599   else {
1600     $self->throw_exception("rows attribute must be positive if present")
1601       if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1602
1603     # MySQL actually recommends this approach.  I cringe.
1604     $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1605   }
1606
1607   my @limit;
1608
1609   # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1610   # otherwise delegate the limiting to the storage, unless software limit was requested
1611   if (
1612     ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1613        ||
1614     ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1615       $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1616   ) {
1617     ($ident, $select, $where, $attrs)
1618       = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1619   }
1620   elsif (! $attrs->{software_limit} ) {
1621     push @limit, $attrs->{rows}, $attrs->{offset};
1622   }
1623
1624 ###
1625   # This would be the point to deflate anything found in $where
1626   # (and leave $attrs->{bind} intact). Problem is - inflators historically
1627   # expect a row object. And all we have is a resultsource (it is trivial
1628   # to extract deflator coderefs via $alias2source above).
1629   #
1630   # I don't see a way forward other than changing the way deflators are
1631   # invoked, and that's just bad...
1632 ###
1633
1634   my $order = { map
1635     { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : ()  }
1636     (qw/order_by group_by having/ )
1637   };
1638
1639   return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1640 }
1641
1642 #
1643 # This is the code producing joined subqueries like:
1644 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1645 #
1646 sub _adjust_select_args_for_complex_prefetch {
1647   my ($self, $from, $select, $where, $attrs) = @_;
1648
1649   $self->throw_exception ('Nothing to prefetch... how did we get here?!')
1650     if not @{$attrs->{_prefetch_select}};
1651
1652   $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1653     if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY');
1654
1655
1656   # generate inner/outer attribute lists, remove stuff that doesn't apply
1657   my $outer_attrs = { %$attrs };
1658   delete $outer_attrs->{$_} for qw/where bind rows offset group_by having/;
1659
1660   my $inner_attrs = { %$attrs };
1661   delete $inner_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1662
1663
1664   # bring over all non-collapse-induced order_by into the inner query (if any)
1665   # the outer one will have to keep them all
1666   delete $inner_attrs->{order_by};
1667   if (my $ord_cnt = @{$outer_attrs->{order_by}} - @{$outer_attrs->{_collapse_order_by}} ) {
1668     $inner_attrs->{order_by} = [
1669       @{$outer_attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1670     ];
1671   }
1672
1673
1674   # generate the inner/outer select lists
1675   # for inside we consider only stuff *not* brought in by the prefetch
1676   # on the outside we substitute any function for its alias
1677   my $outer_select = [ @$select ];
1678   my $inner_select = [];
1679   for my $i (0 .. ( @$outer_select - @{$outer_attrs->{_prefetch_select}} - 1) ) {
1680     my $sel = $outer_select->[$i];
1681
1682     if (ref $sel eq 'HASH' ) {
1683       $sel->{-as} ||= $attrs->{as}[$i];
1684       $outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
1685     }
1686
1687     push @$inner_select, $sel;
1688   }
1689
1690   # normalize a copy of $from, so it will be easier to work with further
1691   # down (i.e. promote the initial hashref to an AoH)
1692   $from = [ @$from ];
1693   $from->[0] = [ $from->[0] ];
1694   my %original_join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1695
1696
1697   # decide which parts of the join will remain in either part of
1698   # the outer/inner query
1699
1700   # First we compose a list of which aliases are used in restrictions
1701   # (i.e. conditions/order/grouping/etc). Since we do not have
1702   # introspectable SQLA, we fall back to ugly scanning of raw SQL for
1703   # WHERE, and for pieces of ORDER BY in order to determine which aliases
1704   # need to appear in the resulting sql.
1705   # It may not be very efficient, but it's a reasonable stop-gap
1706   # Also unqualified column names will not be considered, but more often
1707   # than not this is actually ok
1708   #
1709   # In the same loop we enumerate part of the selection aliases, as
1710   # it requires the same sqla hack for the time being
1711   my ($restrict_aliases, $select_aliases, $prefetch_aliases);
1712   {
1713     # produce stuff unquoted, so it can be scanned
1714     my $sql_maker = $self->sql_maker;
1715     local $sql_maker->{quote_char};
1716     my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1717     $sep = "\Q$sep\E";
1718
1719     my $non_prefetch_select_sql = $sql_maker->_recurse_fields ($inner_select);
1720     my $prefetch_select_sql = $sql_maker->_recurse_fields ($outer_attrs->{_prefetch_select});
1721     my $where_sql = $sql_maker->where ($where);
1722     my $group_by_sql = $sql_maker->_order_by({
1723       map { $_ => $inner_attrs->{$_} } qw/group_by having/
1724     });
1725     my @non_prefetch_order_by_chunks = (map
1726       { ref $_ ? $_->[0] : $_ }
1727       $sql_maker->_order_by_chunks ($inner_attrs->{order_by})
1728     );
1729
1730
1731     for my $alias (keys %original_join_info) {
1732       my $seen_re = qr/\b $alias $sep/x;
1733
1734       for my $piece ($where_sql, $group_by_sql, @non_prefetch_order_by_chunks ) {
1735         if ($piece =~ $seen_re) {
1736           $restrict_aliases->{$alias} = 1;
1737         }
1738       }
1739
1740       if ($non_prefetch_select_sql =~ $seen_re) {
1741           $select_aliases->{$alias} = 1;
1742       }
1743
1744       if ($prefetch_select_sql =~ $seen_re) {
1745           $prefetch_aliases->{$alias} = 1;
1746       }
1747
1748     }
1749   }
1750
1751   # Add any non-left joins to the restriction list (such joins are indeed restrictions)
1752   for my $j (values %original_join_info) {
1753     my $alias = $j->{-alias} or next;
1754     $restrict_aliases->{$alias} = 1 if (
1755       (not $j->{-join_type})
1756         or
1757       ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
1758     );
1759   }
1760
1761   # mark all join parents as mentioned
1762   # (e.g.  join => { cds => 'tracks' } - tracks will need to bring cds too )
1763   for my $collection ($restrict_aliases, $select_aliases) {
1764     for my $alias (keys %$collection) {
1765       $collection->{$_} = 1
1766         for (@{ $original_join_info{$alias}{-join_path} || [] });
1767     }
1768   }
1769
1770   # construct the inner $from for the subquery
1771   my %inner_joins = (map { %{$_ || {}} } ($restrict_aliases, $select_aliases) );
1772   my @inner_from;
1773   for my $j (@$from) {
1774     push @inner_from, $j if $inner_joins{$j->[0]{-alias}};
1775   }
1776
1777   # if a multi-type join was needed in the subquery ("multi" is indicated by
1778   # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1779   unless ($inner_attrs->{group_by}) {
1780     for my $alias (keys %inner_joins) {
1781
1782       # the dot comes from some weirdness in collapse
1783       # remove after the rewrite
1784       if ($attrs->{collapse}{".$alias"}) {
1785         $inner_attrs->{group_by} ||= $inner_select;
1786         last;
1787       }
1788     }
1789   }
1790
1791   # demote the inner_from head
1792   $inner_from[0] = $inner_from[0][0];
1793
1794   # generate the subquery
1795   my $subq = $self->_select_args_to_query (
1796     \@inner_from,
1797     $inner_select,
1798     $where,
1799     $inner_attrs,
1800   );
1801
1802   my $subq_joinspec = {
1803     -alias => $attrs->{alias},
1804     -source_handle => $inner_from[0]{-source_handle},
1805     $attrs->{alias} => $subq,
1806   };
1807
1808   # Generate the outer from - this is relatively easy (really just replace
1809   # the join slot with the subquery), with a major caveat - we can not
1810   # join anything that is non-selecting (not part of the prefetch), but at
1811   # the same time is a multi-type relationship, as it will explode the result.
1812   #
1813   # There are two possibilities here
1814   # - either the join is non-restricting, in which case we simply throw it away
1815   # - it is part of the restrictions, in which case we need to collapse the outer
1816   #   result by tackling yet another group_by to the outside of the query
1817
1818   # so first generate the outer_from, up to the substitution point
1819   my @outer_from;
1820   while (my $j = shift @$from) {
1821     if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
1822       push @outer_from, [
1823         $subq_joinspec,
1824         @{$j}[1 .. $#$j],
1825       ];
1826       last; # we'll take care of what's left in $from below
1827     }
1828     else {
1829       push @outer_from, $j;
1830     }
1831   }
1832
1833   # see what's left - throw away if not selecting/restricting
1834   # also throw in a group_by if restricting to guard against
1835   # cross-join explosions
1836   #
1837   while (my $j = shift @$from) {
1838     my $alias = $j->[0]{-alias};
1839
1840     if ($select_aliases->{$alias} || $prefetch_aliases->{$alias}) {
1841       push @outer_from, $j;
1842     }
1843     elsif ($restrict_aliases->{$alias}) {
1844       push @outer_from, $j;
1845
1846       # FIXME - this should be obviated by SQLA2, as I'll be able to
1847       # have restrict_inner and restrict_outer... or something to that
1848       # effect... I think...
1849
1850       # FIXME2 - I can't find a clean way to determine if a particular join
1851       # is a multi - instead I am just treating everything as a potential
1852       # explosive join (ribasushi)
1853       #
1854       # if (my $handle = $j->[0]{-source_handle}) {
1855       #   my $rsrc = $handle->resolve;
1856       #   ... need to bail out of the following if this is not a multi,
1857       #       as it will be much easier on the db ...
1858
1859           $outer_attrs->{group_by} ||= $outer_select;
1860       # }
1861     }
1862   }
1863
1864   # demote the outer_from head
1865   $outer_from[0] = $outer_from[0][0];
1866
1867   # This is totally horrific - the $where ends up in both the inner and outer query
1868   # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1869   # then if where conditions apply to the *right* side of the prefetch, you may have
1870   # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1871   # the outer select to exclude joins you didin't want in the first place
1872   #
1873   # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1874   return (\@outer_from, $outer_select, $where, $outer_attrs);
1875 }
1876
1877 sub _resolve_ident_sources {
1878   my ($self, $ident) = @_;
1879
1880   my $alias2source = {};
1881   my $rs_alias;
1882
1883   # the reason this is so contrived is that $ident may be a {from}
1884   # structure, specifying multiple tables to join
1885   if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1886     # this is compat mode for insert/update/delete which do not deal with aliases
1887     $alias2source->{me} = $ident;
1888     $rs_alias = 'me';
1889   }
1890   elsif (ref $ident eq 'ARRAY') {
1891
1892     for (@$ident) {
1893       my $tabinfo;
1894       if (ref $_ eq 'HASH') {
1895         $tabinfo = $_;
1896         $rs_alias = $tabinfo->{-alias};
1897       }
1898       if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1899         $tabinfo = $_->[0];
1900       }
1901
1902       $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1903         if ($tabinfo->{-source_handle});
1904     }
1905   }
1906
1907   return ($alias2source, $rs_alias);
1908 }
1909
1910 # Takes $ident, \@column_names
1911 #
1912 # returns { $column_name => \%column_info, ... }
1913 # also note: this adds -result_source => $rsrc to the column info
1914 #
1915 # usage:
1916 #   my $col_sources = $self->_resolve_column_info($ident, @column_names);
1917 sub _resolve_column_info {
1918   my ($self, $ident, $colnames) = @_;
1919   my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1920
1921   my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1922   $sep = "\Q$sep\E";
1923
1924   my (%return, %seen_cols);
1925
1926   # compile a global list of column names, to be able to properly
1927   # disambiguate unqualified column names (if at all possible)
1928   for my $alias (keys %$alias2src) {
1929     my $rsrc = $alias2src->{$alias};
1930     for my $colname ($rsrc->columns) {
1931       push @{$seen_cols{$colname}}, $alias;
1932     }
1933   }
1934
1935   COLUMN:
1936   foreach my $col (@$colnames) {
1937     my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1938
1939     unless ($alias) {
1940       # see if the column was seen exactly once (so we know which rsrc it came from)
1941       if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1942         $alias = $seen_cols{$colname}[0];
1943       }
1944       else {
1945         next COLUMN;
1946       }
1947     }
1948
1949     my $rsrc = $alias2src->{$alias};
1950     $return{$col} = $rsrc && {
1951       %{$rsrc->column_info($colname)},
1952       -result_source => $rsrc,
1953       -source_alias => $alias,
1954     };
1955   }
1956
1957   return \%return;
1958 }
1959
1960 # Returns a counting SELECT for a simple count
1961 # query. Abstracted so that a storage could override
1962 # this to { count => 'firstcol' } or whatever makes
1963 # sense as a performance optimization
1964 sub _count_select {
1965   #my ($self, $source, $rs_attrs) = @_;
1966   return { count => '*' };
1967 }
1968
1969 # Returns a SELECT which will end up in the subselect
1970 # There may or may not be a group_by, as the subquery
1971 # might have been called to accomodate a limit
1972 #
1973 # Most databases would be happy with whatever ends up
1974 # here, but some choke in various ways.
1975 #
1976 sub _subq_count_select {
1977   my ($self, $source, $rs_attrs) = @_;
1978   return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1979
1980   my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1981   return @pcols ? \@pcols : [ 1 ];
1982 }
1983
1984 #
1985 # Returns an ordered list of column names before they are used
1986 # in a SELECT statement. By default simply returns the list
1987 # passed in.
1988 #
1989 # This may be overridden in a specific storage when there are
1990 # requirements such as moving BLOB columns to the end of the
1991 # SELECT list.
1992 sub _order_select_columns {
1993   #my ($self, $source, $columns) = @_;
1994   return @{$_[2]};
1995 }
1996
1997 sub source_bind_attributes {
1998   my ($self, $source) = @_;
1999
2000   my $bind_attributes;
2001   foreach my $column ($source->columns) {
2002
2003     my $data_type = $source->column_info($column)->{data_type} || '';
2004     $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2005      if $data_type;
2006   }
2007
2008   return $bind_attributes;
2009 }
2010
2011 =head2 select
2012
2013 =over 4
2014
2015 =item Arguments: $ident, $select, $condition, $attrs
2016
2017 =back
2018
2019 Handle a SQL select statement.
2020
2021 =cut
2022
2023 sub select {
2024   my $self = shift;
2025   my ($ident, $select, $condition, $attrs) = @_;
2026   return $self->cursor_class->new($self, \@_, $attrs);
2027 }
2028
2029 sub select_single {
2030   my $self = shift;
2031   my ($rv, $sth, @bind) = $self->_select(@_);
2032   my @row = $sth->fetchrow_array;
2033   my @nextrow = $sth->fetchrow_array if @row;
2034   if(@row && @nextrow) {
2035     carp "Query returned more than one row.  SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2036   }
2037   # Need to call finish() to work round broken DBDs
2038   $sth->finish();
2039   return @row;
2040 }
2041
2042 =head2 sth
2043
2044 =over 4
2045
2046 =item Arguments: $sql
2047
2048 =back
2049
2050 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2051
2052 =cut
2053
2054 sub _dbh_sth {
2055   my ($self, $dbh, $sql) = @_;
2056
2057   # 3 is the if_active parameter which avoids active sth re-use
2058   my $sth = $self->disable_sth_caching
2059     ? $dbh->prepare($sql)
2060     : $dbh->prepare_cached($sql, {}, 3);
2061
2062   # XXX You would think RaiseError would make this impossible,
2063   #  but apparently that's not true :(
2064   $self->throw_exception($dbh->errstr) if !$sth;
2065
2066   $sth;
2067 }
2068
2069 sub sth {
2070   my ($self, $sql) = @_;
2071   $self->dbh_do('_dbh_sth', $sql);  # retry over disconnects
2072 }
2073
2074 sub _dbh_columns_info_for {
2075   my ($self, $dbh, $table) = @_;
2076
2077   if ($dbh->can('column_info')) {
2078     my %result;
2079     eval {
2080       my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2081       my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2082       $sth->execute();
2083       while ( my $info = $sth->fetchrow_hashref() ){
2084         my %column_info;
2085         $column_info{data_type}   = $info->{TYPE_NAME};
2086         $column_info{size}      = $info->{COLUMN_SIZE};
2087         $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
2088         $column_info{default_value} = $info->{COLUMN_DEF};
2089         my $col_name = $info->{COLUMN_NAME};
2090         $col_name =~ s/^\"(.*)\"$/$1/;
2091
2092         $result{$col_name} = \%column_info;
2093       }
2094     };
2095     return \%result if !$@ && scalar keys %result;
2096   }
2097
2098   my %result;
2099   my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2100   $sth->execute;
2101   my @columns = @{$sth->{NAME_lc}};
2102   for my $i ( 0 .. $#columns ){
2103     my %column_info;
2104     $column_info{data_type} = $sth->{TYPE}->[$i];
2105     $column_info{size} = $sth->{PRECISION}->[$i];
2106     $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2107
2108     if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2109       $column_info{data_type} = $1;
2110       $column_info{size}    = $2;
2111     }
2112
2113     $result{$columns[$i]} = \%column_info;
2114   }
2115   $sth->finish;
2116
2117   foreach my $col (keys %result) {
2118     my $colinfo = $result{$col};
2119     my $type_num = $colinfo->{data_type};
2120     my $type_name;
2121     if(defined $type_num && $dbh->can('type_info')) {
2122       my $type_info = $dbh->type_info($type_num);
2123       $type_name = $type_info->{TYPE_NAME} if $type_info;
2124       $colinfo->{data_type} = $type_name if $type_name;
2125     }
2126   }
2127
2128   return \%result;
2129 }
2130
2131 sub columns_info_for {
2132   my ($self, $table) = @_;
2133   $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2134 }
2135
2136 =head2 last_insert_id
2137
2138 Return the row id of the last insert.
2139
2140 =cut
2141
2142 sub _dbh_last_insert_id {
2143     # All Storage's need to register their own _dbh_last_insert_id
2144     # the old SQLite-based method was highly inappropriate
2145
2146     my $self = shift;
2147     my $class = ref $self;
2148     $self->throw_exception (<<EOE);
2149
2150 No _dbh_last_insert_id() method found in $class.
2151 Since the method of obtaining the autoincrement id of the last insert
2152 operation varies greatly between different databases, this method must be
2153 individually implemented for every storage class.
2154 EOE
2155 }
2156
2157 sub last_insert_id {
2158   my $self = shift;
2159   $self->_dbh_last_insert_id ($self->_dbh, @_);
2160 }
2161
2162 =head2 _native_data_type
2163
2164 =over 4
2165
2166 =item Arguments: $type_name
2167
2168 =back
2169
2170 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2171 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2172 L<::Sybase|DBIx::Class::Storage::DBI::Sybase>.
2173
2174 The default implementation returns C<undef>, implement in your Storage driver if
2175 you need this functionality.
2176
2177 Should map types from other databases to the native RDBMS type, for example
2178 C<VARCHAR2> to C<VARCHAR>.
2179
2180 Types with modifiers should map to the underlying data type. For example,
2181 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2182
2183 Composite types should map to the container type, for example
2184 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2185
2186 =cut
2187
2188 sub _native_data_type {
2189   #my ($self, $data_type) = @_;
2190   return undef
2191 }
2192
2193 # Check if placeholders are supported at all
2194 sub _placeholders_supported {
2195   my $self = shift;
2196   my $dbh  = $self->_get_dbh;
2197
2198   # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2199   # but it is inaccurate more often than not
2200   eval {
2201     local $dbh->{PrintError} = 0;
2202     local $dbh->{RaiseError} = 1;
2203     $dbh->do('select ?', {}, 1);
2204   };
2205   return $@ ? 0 : 1;
2206 }
2207
2208 # Check if placeholders bound to non-string types throw exceptions
2209 #
2210 sub _typeless_placeholders_supported {
2211   my $self = shift;
2212   my $dbh  = $self->_get_dbh;
2213
2214   eval {
2215     local $dbh->{PrintError} = 0;
2216     local $dbh->{RaiseError} = 1;
2217     # this specifically tests a bind that is NOT a string
2218     $dbh->do('select 1 where 1 = ?', {}, 1);
2219   };
2220   return $@ ? 0 : 1;
2221 }
2222
2223 =head2 sqlt_type
2224
2225 Returns the database driver name.
2226
2227 =cut
2228
2229 sub sqlt_type {
2230   my ($self) = @_;
2231
2232   if (not $self->_driver_determined) {
2233     $self->_determine_driver;
2234     goto $self->can ('sqlt_type');
2235   }
2236
2237   $self->_get_dbh->{Driver}->{Name};
2238 }
2239
2240 =head2 bind_attribute_by_data_type
2241
2242 Given a datatype from column info, returns a database specific bind
2243 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2244 let the database planner just handle it.
2245
2246 Generally only needed for special case column types, like bytea in postgres.
2247
2248 =cut
2249
2250 sub bind_attribute_by_data_type {
2251     return;
2252 }
2253
2254 =head2 is_datatype_numeric
2255
2256 Given a datatype from column_info, returns a boolean value indicating if
2257 the current RDBMS considers it a numeric value. This controls how
2258 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2259 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2260 be performed instead of the usual C<eq>.
2261
2262 =cut
2263
2264 sub is_datatype_numeric {
2265   my ($self, $dt) = @_;
2266
2267   return 0 unless $dt;
2268
2269   return $dt =~ /^ (?:
2270     numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2271   ) $/ix;
2272 }
2273
2274
2275 =head2 create_ddl_dir (EXPERIMENTAL)
2276
2277 =over 4
2278
2279 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2280
2281 =back
2282
2283 Creates a SQL file based on the Schema, for each of the specified
2284 database engines in C<\@databases> in the given directory.
2285 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2286
2287 Given a previous version number, this will also create a file containing
2288 the ALTER TABLE statements to transform the previous schema into the
2289 current one. Note that these statements may contain C<DROP TABLE> or
2290 C<DROP COLUMN> statements that can potentially destroy data.
2291
2292 The file names are created using the C<ddl_filename> method below, please
2293 override this method in your schema if you would like a different file
2294 name format. For the ALTER file, the same format is used, replacing
2295 $version in the name with "$preversion-$version".
2296
2297 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2298 The most common value for this would be C<< { add_drop_table => 1 } >>
2299 to have the SQL produced include a C<DROP TABLE> statement for each table
2300 created. For quoting purposes supply C<quote_table_names> and
2301 C<quote_field_names>.
2302
2303 If no arguments are passed, then the following default values are assumed:
2304
2305 =over 4
2306
2307 =item databases  - ['MySQL', 'SQLite', 'PostgreSQL']
2308
2309 =item version    - $schema->schema_version
2310
2311 =item directory  - './'
2312
2313 =item preversion - <none>
2314
2315 =back
2316
2317 By default, C<\%sqlt_args> will have
2318
2319  { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2320
2321 merged with the hash passed in. To disable any of those features, pass in a
2322 hashref like the following
2323
2324  { ignore_constraint_names => 0, # ... other options }
2325
2326
2327 Note that this feature is currently EXPERIMENTAL and may not work correctly
2328 across all databases, or fully handle complex relationships.
2329
2330 WARNING: Please check all SQL files created, before applying them.
2331
2332 =cut
2333
2334 sub create_ddl_dir {
2335   my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2336
2337   if(!$dir || !-d $dir) {
2338     carp "No directory given, using ./\n";
2339     $dir = "./";
2340   }
2341   $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2342   $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2343
2344   my $schema_version = $schema->schema_version || '1.x';
2345   $version ||= $schema_version;
2346
2347   $sqltargs = {
2348     add_drop_table => 1,
2349     ignore_constraint_names => 1,
2350     ignore_index_names => 1,
2351     %{$sqltargs || {}}
2352   };
2353
2354   $self->throw_exception("Can't create a ddl file without SQL::Translator: " . $self->_sqlt_version_error)
2355     if !$self->_sqlt_version_ok;
2356
2357   my $sqlt = SQL::Translator->new( $sqltargs );
2358
2359   $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2360   my $sqlt_schema = $sqlt->translate({ data => $schema })
2361     or $self->throw_exception ($sqlt->error);
2362
2363   foreach my $db (@$databases) {
2364     $sqlt->reset();
2365     $sqlt->{schema} = $sqlt_schema;
2366     $sqlt->producer($db);
2367
2368     my $file;
2369     my $filename = $schema->ddl_filename($db, $version, $dir);
2370     if (-e $filename && ($version eq $schema_version )) {
2371       # if we are dumping the current version, overwrite the DDL
2372       carp "Overwriting existing DDL file - $filename";
2373       unlink($filename);
2374     }
2375
2376     my $output = $sqlt->translate;
2377     if(!$output) {
2378       carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2379       next;
2380     }
2381     if(!open($file, ">$filename")) {
2382       $self->throw_exception("Can't open $filename for writing ($!)");
2383       next;
2384     }
2385     print $file $output;
2386     close($file);
2387
2388     next unless ($preversion);
2389
2390     require SQL::Translator::Diff;
2391
2392     my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2393     if(!-e $prefilename) {
2394       carp("No previous schema file found ($prefilename)");
2395       next;
2396     }
2397
2398     my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2399     if(-e $difffile) {
2400       carp("Overwriting existing diff file - $difffile");
2401       unlink($difffile);
2402     }
2403
2404     my $source_schema;
2405     {
2406       my $t = SQL::Translator->new($sqltargs);
2407       $t->debug( 0 );
2408       $t->trace( 0 );
2409
2410       $t->parser( $db )
2411         or $self->throw_exception ($t->error);
2412
2413       my $out = $t->translate( $prefilename )
2414         or $self->throw_exception ($t->error);
2415
2416       $source_schema = $t->schema;
2417
2418       $source_schema->name( $prefilename )
2419         unless ( $source_schema->name );
2420     }
2421
2422     # The "new" style of producers have sane normalization and can support
2423     # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2424     # And we have to diff parsed SQL against parsed SQL.
2425     my $dest_schema = $sqlt_schema;
2426
2427     unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2428       my $t = SQL::Translator->new($sqltargs);
2429       $t->debug( 0 );
2430       $t->trace( 0 );
2431
2432       $t->parser( $db )
2433         or $self->throw_exception ($t->error);
2434
2435       my $out = $t->translate( $filename )
2436         or $self->throw_exception ($t->error);
2437
2438       $dest_schema = $t->schema;
2439
2440       $dest_schema->name( $filename )
2441         unless $dest_schema->name;
2442     }
2443
2444     my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2445                                                   $dest_schema,   $db,
2446                                                   $sqltargs
2447                                                  );
2448     if(!open $file, ">$difffile") {
2449       $self->throw_exception("Can't write to $difffile ($!)");
2450       next;
2451     }
2452     print $file $diff;
2453     close($file);
2454   }
2455 }
2456
2457 =head2 deployment_statements
2458
2459 =over 4
2460
2461 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2462
2463 =back
2464
2465 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2466
2467 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2468 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2469
2470 C<$directory> is used to return statements from files in a previously created
2471 L</create_ddl_dir> directory and is optional. The filenames are constructed
2472 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2473
2474 If no C<$directory> is specified then the statements are constructed on the
2475 fly using L<SQL::Translator> and C<$version> is ignored.
2476
2477 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2478
2479 =cut
2480
2481 sub deployment_statements {
2482   my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2483   $type ||= $self->sqlt_type;
2484   $version ||= $schema->schema_version || '1.x';
2485   $dir ||= './';
2486   my $filename = $schema->ddl_filename($type, $version, $dir);
2487   if(-f $filename)
2488   {
2489       my $file;
2490       open($file, "<$filename")
2491         or $self->throw_exception("Can't open $filename ($!)");
2492       my @rows = <$file>;
2493       close($file);
2494       return join('', @rows);
2495   }
2496
2497   $self->throw_exception("Can't deploy without either SQL::Translator or a ddl_dir: " . $self->_sqlt_version_error )
2498     if !$self->_sqlt_version_ok;
2499
2500   # sources needs to be a parser arg, but for simplicty allow at top level
2501   # coming in
2502   $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2503       if exists $sqltargs->{sources};
2504
2505   my $tr = SQL::Translator->new(
2506     producer => "SQL::Translator::Producer::${type}",
2507     %$sqltargs,
2508     parser => 'SQL::Translator::Parser::DBIx::Class',
2509     data => $schema,
2510   );
2511   return $tr->translate;
2512 }
2513
2514 sub deploy {
2515   my ($self, $schema, $type, $sqltargs, $dir) = @_;
2516   my $deploy = sub {
2517     my $line = shift;
2518     return if($line =~ /^--/);
2519     return if(!$line);
2520     # next if($line =~ /^DROP/m);
2521     return if($line =~ /^BEGIN TRANSACTION/m);
2522     return if($line =~ /^COMMIT/m);
2523     return if $line =~ /^\s+$/; # skip whitespace only
2524     $self->_query_start($line);
2525     eval {
2526       # do a dbh_do cycle here, as we need some error checking in
2527       # place (even though we will ignore errors)
2528       $self->dbh_do (sub { $_[1]->do($line) });
2529     };
2530     if ($@) {
2531       carp qq{$@ (running "${line}")};
2532     }
2533     $self->_query_end($line);
2534   };
2535   my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2536   if (@statements > 1) {
2537     foreach my $statement (@statements) {
2538       $deploy->( $statement );
2539     }
2540   }
2541   elsif (@statements == 1) {
2542     foreach my $line ( split(";\n", $statements[0])) {
2543       $deploy->( $line );
2544     }
2545   }
2546 }
2547
2548 =head2 datetime_parser
2549
2550 Returns the datetime parser class
2551
2552 =cut
2553
2554 sub datetime_parser {
2555   my $self = shift;
2556   return $self->{datetime_parser} ||= do {
2557     $self->_populate_dbh unless $self->_dbh;
2558     $self->build_datetime_parser(@_);
2559   };
2560 }
2561
2562 =head2 datetime_parser_type
2563
2564 Defines (returns) the datetime parser class - currently hardwired to
2565 L<DateTime::Format::MySQL>
2566
2567 =cut
2568
2569 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2570
2571 =head2 build_datetime_parser
2572
2573 See L</datetime_parser>
2574
2575 =cut
2576
2577 sub build_datetime_parser {
2578   my $self = shift;
2579   my $type = $self->datetime_parser_type(@_);
2580   $self->ensure_class_loaded ($type);
2581   return $type;
2582 }
2583
2584
2585 =head2 is_replicating
2586
2587 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2588 replicate from a master database.  Default is undef, which is the result
2589 returned by databases that don't support replication.
2590
2591 =cut
2592
2593 sub is_replicating {
2594     return;
2595
2596 }
2597
2598 =head2 lag_behind_master
2599
2600 Returns a number that represents a certain amount of lag behind a master db
2601 when a given storage is replicating.  The number is database dependent, but
2602 starts at zero and increases with the amount of lag. Default in undef
2603
2604 =cut
2605
2606 sub lag_behind_master {
2607     return;
2608 }
2609
2610 sub DESTROY {
2611   my $self = shift;
2612   $self->_verify_pid if $self->_dbh;
2613
2614   # some databases need this to stop spewing warnings
2615   if (my $dbh = $self->_dbh) {
2616     eval { $dbh->disconnect };
2617   }
2618
2619   $self->_dbh(undef);
2620 }
2621
2622 1;
2623
2624 =head1 USAGE NOTES
2625
2626 =head2 DBIx::Class and AutoCommit
2627
2628 DBIx::Class can do some wonderful magic with handling exceptions,
2629 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2630 (the default) combined with C<txn_do> for transaction support.
2631
2632 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2633 in an assumed transaction between commits, and you're telling us you'd
2634 like to manage that manually.  A lot of the magic protections offered by
2635 this module will go away.  We can't protect you from exceptions due to database
2636 disconnects because we don't know anything about how to restart your
2637 transactions.  You're on your own for handling all sorts of exceptional
2638 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2639 be with raw DBI.
2640
2641
2642 =head1 AUTHORS
2643
2644 Matt S. Trout <mst@shadowcatsystems.co.uk>
2645
2646 Andy Grundman <andy@hybridized.org>
2647
2648 =head1 LICENSE
2649
2650 You may distribute this code under the same terms as Perl itself.
2651
2652 =cut