default column_info_from_storage to zero in -current
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Storage / DBI.pm
CommitLineData
8b445e33 1package DBIx::Class::Storage::DBI;
e673f011 2# -*- mode: cperl; cperl-indent-level: 2 -*-
8b445e33 3
a62cf8d4 4use base 'DBIx::Class::Storage';
5
20a2c954 6use strict;
7use warnings;
8b445e33 8use DBI;
aeaf3ce2 9use SQL::Abstract::Limit;
28927b50 10use DBIx::Class::Storage::DBI::Cursor;
4c248161 11use DBIx::Class::Storage::Statistics;
92b858c9 12use IO::File;
046ad905 13
14__PACKAGE__->mk_group_accessors(
15 'simple' =>
16 qw/_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid _conn_tid
17 cursor on_connect_do transaction_depth/
18);
19
bd7efd39 20BEGIN {
21
cb5f2eea 22package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
bd7efd39 23
24use base qw/SQL::Abstract::Limit/;
25
2cc3a7be 26# This prevents the caching of $dbh in S::A::L, I believe
27sub new {
28 my $self = shift->SUPER::new(@_);
29
30 # If limit_dialect is a ref (like a $dbh), go ahead and replace
31 # it with what it resolves to:
32 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
33 if ref $self->{limit_dialect};
34
35 $self;
36}
37
260129d8 38sub _RowNumberOver {
39 my ($self, $sql, $order, $rows, $offset ) = @_;
40
41 $offset += 1;
42 my $last = $rows + $offset;
43 my ( $order_by ) = $self->_order_by( $order );
44
45 $sql = <<"";
46SELECT * FROM
47(
48 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
49 $sql
50 $order_by
51 ) Q1
52) Q2
53WHERE ROW_NUM BETWEEN $offset AND $last
54
55 return $sql;
56}
57
58
2cc3a7be 59# While we're at it, this should make LIMIT queries more efficient,
60# without digging into things too deeply
61sub _find_syntax {
62 my ($self, $syntax) = @_;
e4cc8257 63 my $dbhname = ref $syntax eq 'HASH' ? $syntax->{Driver}{Name} : '';
260129d8 64 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
65 return 'RowNumberOver';
66 }
67
2cc3a7be 68 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
69}
70
54540863 71sub select {
72 my ($self, $table, $fields, $where, $order, @rest) = @_;
6346a152 73 $table = $self->_quote($table) unless ref($table);
eac29141 74 local $self->{rownum_hack_count} = 1
75 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
54540863 76 @rest = (-1) unless defined $rest[0];
0823196c 77 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
78 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
8839560b 79 local $self->{having_bind} = [];
bc0c9800 80 my ($sql, @ret) = $self->SUPER::select(
81 $table, $self->_recurse_fields($fields), $where, $order, @rest
82 );
8839560b 83 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
54540863 84}
85
6346a152 86sub insert {
87 my $self = shift;
88 my $table = shift;
89 $table = $self->_quote($table) unless ref($table);
90 $self->SUPER::insert($table, @_);
91}
92
93sub update {
94 my $self = shift;
95 my $table = shift;
96 $table = $self->_quote($table) unless ref($table);
97 $self->SUPER::update($table, @_);
98}
99
100sub delete {
101 my $self = shift;
102 my $table = shift;
103 $table = $self->_quote($table) unless ref($table);
104 $self->SUPER::delete($table, @_);
105}
106
54540863 107sub _emulate_limit {
108 my $self = shift;
109 if ($_[3] == -1) {
110 return $_[1].$self->_order_by($_[2]);
111 } else {
112 return $self->SUPER::_emulate_limit(@_);
113 }
114}
115
116sub _recurse_fields {
117 my ($self, $fields) = @_;
118 my $ref = ref $fields;
119 return $self->_quote($fields) unless $ref;
120 return $$fields if $ref eq 'SCALAR';
121
122 if ($ref eq 'ARRAY') {
eac29141 123 return join(', ', map {
124 $self->_recurse_fields($_)
125 .(exists $self->{rownum_hack_count}
126 ? ' AS col'.$self->{rownum_hack_count}++
127 : '')
128 } @$fields);
54540863 129 } elsif ($ref eq 'HASH') {
130 foreach my $func (keys %$fields) {
131 return $self->_sqlcase($func)
132 .'( '.$self->_recurse_fields($fields->{$func}).' )';
133 }
134 }
135}
136
137sub _order_by {
138 my $self = shift;
139 my $ret = '';
8839560b 140 my @extra;
54540863 141 if (ref $_[0] eq 'HASH') {
142 if (defined $_[0]->{group_by}) {
143 $ret = $self->_sqlcase(' group by ')
144 .$self->_recurse_fields($_[0]->{group_by});
145 }
8839560b 146 if (defined $_[0]->{having}) {
147 my $frag;
148 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
149 push(@{$self->{having_bind}}, @extra);
150 $ret .= $self->_sqlcase(' having ').$frag;
151 }
54540863 152 if (defined $_[0]->{order_by}) {
7ce5cbe7 153 $ret .= $self->_order_by($_[0]->{order_by});
54540863 154 }
d09c569a 155 } elsif (ref $_[0] eq 'SCALAR') {
e535069e 156 $ret = $self->_sqlcase(' order by ').${ $_[0] };
d09c569a 157 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
158 my @order = @{+shift};
159 $ret = $self->_sqlcase(' order by ')
160 .join(', ', map {
161 my $r = $self->_order_by($_, @_);
162 $r =~ s/^ ?ORDER BY //i;
163 $r;
164 } @order);
54540863 165 } else {
166 $ret = $self->SUPER::_order_by(@_);
167 }
168 return $ret;
169}
170
f48dd03f 171sub _order_directions {
172 my ($self, $order) = @_;
173 $order = $order->{order_by} if ref $order eq 'HASH';
174 return $self->SUPER::_order_directions($order);
175}
176
2a816814 177sub _table {
bd7efd39 178 my ($self, $from) = @_;
179 if (ref $from eq 'ARRAY') {
180 return $self->_recurse_from(@$from);
181 } elsif (ref $from eq 'HASH') {
182 return $self->_make_as($from);
183 } else {
6346a152 184 return $from; # would love to quote here but _table ends up getting called
185 # twice during an ->select without a limit clause due to
186 # the way S::A::Limit->select works. should maybe consider
187 # bypassing this and doing S::A::select($self, ...) in
188 # our select method above. meantime, quoting shims have
189 # been added to select/insert/update/delete here
bd7efd39 190 }
191}
192
193sub _recurse_from {
194 my ($self, $from, @join) = @_;
195 my @sqlf;
196 push(@sqlf, $self->_make_as($from));
197 foreach my $j (@join) {
198 my ($to, $on) = @$j;
73856587 199
54540863 200 # check whether a join type exists
201 my $join_clause = '';
ca7b9fdf 202 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
203 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
204 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
54540863 205 } else {
206 $join_clause = ' JOIN ';
207 }
73856587 208 push(@sqlf, $join_clause);
209
bd7efd39 210 if (ref $to eq 'ARRAY') {
211 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
212 } else {
96cdbbab 213 push(@sqlf, $self->_make_as($to));
bd7efd39 214 }
215 push(@sqlf, ' ON ', $self->_join_condition($on));
216 }
217 return join('', @sqlf);
218}
219
220sub _make_as {
221 my ($self, $from) = @_;
54540863 222 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
bc0c9800 223 reverse each %{$self->_skip_options($from)});
73856587 224}
225
226sub _skip_options {
54540863 227 my ($self, $hash) = @_;
228 my $clean_hash = {};
229 $clean_hash->{$_} = $hash->{$_}
230 for grep {!/^-/} keys %$hash;
231 return $clean_hash;
bd7efd39 232}
233
234sub _join_condition {
235 my ($self, $cond) = @_;
5efe4c79 236 if (ref $cond eq 'HASH') {
237 my %j;
bc0c9800 238 for (keys %$cond) {
239 my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x;
240 };
5efe4c79 241 return $self->_recurse_where(\%j);
242 } elsif (ref $cond eq 'ARRAY') {
243 return join(' OR ', map { $self->_join_condition($_) } @$cond);
244 } else {
245 die "Can't handle this yet!";
246 }
bd7efd39 247}
248
2a816814 249sub _quote {
250 my ($self, $label) = @_;
251 return '' unless defined $label;
3b24f6ea 252 return "*" if $label eq '*';
41728a6e 253 return $label unless $self->{quote_char};
3b24f6ea 254 if(ref $self->{quote_char} eq "ARRAY"){
255 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
256 if !defined $self->{name_sep};
257 my $sep = $self->{name_sep};
258 return join($self->{name_sep},
259 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
260 split(/\Q$sep\E/,$label));
261 }
2a816814 262 return $self->SUPER::_quote($label);
263}
264
7be93b07 265sub limit_dialect {
266 my $self = shift;
267 $self->{limit_dialect} = shift if @_;
268 return $self->{limit_dialect};
269}
270
2437a1e3 271sub quote_char {
272 my $self = shift;
273 $self->{quote_char} = shift if @_;
274 return $self->{quote_char};
275}
276
277sub name_sep {
278 my $self = shift;
279 $self->{name_sep} = shift if @_;
280 return $self->{name_sep};
281}
282
bd7efd39 283} # End of BEGIN block
284
b327f988 285=head1 NAME
286
287DBIx::Class::Storage::DBI - DBI storage handler
288
289=head1 SYNOPSIS
290
291=head1 DESCRIPTION
292
046ad905 293This class represents the connection to an RDBMS via L<DBI>. See
294L<DBIx::Class::Storage> for general information. This pod only
295documents DBI-specific methods and behaviors.
b327f988 296
297=head1 METHODS
298
9b83fccd 299=cut
300
8b445e33 301sub new {
046ad905 302 my $new = shift->next::method(@_);
82cc0386 303
28927b50 304 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
d79f59b9 305 $new->transaction_depth(0);
2cc3a7be 306 $new->_sql_maker_opts({});
82cc0386 307
046ad905 308 $new;
1c339d71 309}
310
1b45b01e 311=head2 connect_info
312
bb4f246d 313The arguments of C<connect_info> are always a single array reference.
1b45b01e 314
bb4f246d 315This is normally accessed via L<DBIx::Class::Schema/connection>, which
316encapsulates its argument list in an arrayref before calling
317C<connect_info> here.
1b45b01e 318
bb4f246d 319The arrayref can either contain the same set of arguments one would
320normally pass to L<DBI/connect>, or a lone code reference which returns
321a connected database handle.
d7c4c15c 322
2cc3a7be 323In either case, if the final argument in your connect_info happens
324to be a hashref, C<connect_info> will look there for several
325connection-specific options:
326
327=over 4
328
329=item on_connect_do
330
331This can be set to an arrayref of literal sql statements, which will
332be executed immediately after making the connection to the database
333every time we [re-]connect.
334
335=item limit_dialect
336
337Sets the limit dialect. This is useful for JDBC-bridge among others
338where the remote SQL-dialect cannot be determined by the name of the
339driver alone.
340
341=item quote_char
d7c4c15c 342
2cc3a7be 343Specifies what characters to use to quote table and column names. If
344you use this you will want to specify L<name_sep> as well.
345
346quote_char expects either a single character, in which case is it is placed
347on either side of the table/column, or an arrayref of length 2 in which case the
348table/column name is placed between the elements.
349
350For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd
351use C<quote_char =E<gt> [qw/[ ]/]>.
352
353=item name_sep
354
355This only needs to be used in conjunction with L<quote_char>, and is used to
356specify the charecter that seperates elements (schemas, tables, columns) from
357each other. In most cases this is simply a C<.>.
358
359=back
360
361These options can be mixed in with your other L<DBI> connection attributes,
362or placed in a seperate hashref after all other normal L<DBI> connection
363arguments.
364
365Every time C<connect_info> is invoked, any previous settings for
366these options will be cleared before setting the new ones, regardless of
367whether any options are specified in the new C<connect_info>.
368
f5de3933 369Important note: DBIC expects the returned database handle provided by
370a subref argument to have RaiseError set on it. If it doesn't, things
371might not work very well, YMMV. If you don't use a subref, DBIC will
372force this setting for you anyways. Setting HandleError to anything
373other than simple exception object wrapper might cause problems too.
374
2cc3a7be 375Examples:
376
377 # Simple SQLite connection
bb4f246d 378 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
6789ebe3 379
2cc3a7be 380 # Connect via subref
bb4f246d 381 ->connect_info([ sub { DBI->connect(...) } ]);
6789ebe3 382
2cc3a7be 383 # A bit more complicated
bb4f246d 384 ->connect_info(
385 [
386 'dbi:Pg:dbname=foo',
387 'postgres',
388 'my_pg_password',
389 { AutoCommit => 0 },
2cc3a7be 390 { quote_char => q{"}, name_sep => q{.} },
391 ]
392 );
393
394 # Equivalent to the previous example
395 ->connect_info(
396 [
397 'dbi:Pg:dbname=foo',
398 'postgres',
399 'my_pg_password',
400 { AutoCommit => 0, quote_char => q{"}, name_sep => q{.} },
bb4f246d 401 ]
402 );
6789ebe3 403
2cc3a7be 404 # Subref + DBIC-specific connection options
bb4f246d 405 ->connect_info(
406 [
407 sub { DBI->connect(...) },
2cc3a7be 408 {
409 quote_char => q{`},
410 name_sep => q{@},
411 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
412 },
bb4f246d 413 ]
414 );
6789ebe3 415
004d31fb 416=cut
417
046ad905 418sub connect_info {
419 my ($self, $info_arg) = @_;
4c248161 420
046ad905 421 return $self->_connect_info if !$info_arg;
4c248161 422
046ad905 423 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
424 # the new set of options
425 $self->_sql_maker(undef);
426 $self->_sql_maker_opts({});
486ad69b 427
046ad905 428 my $info = [ @$info_arg ]; # copy because we can alter it
429 my $last_info = $info->[-1];
430 if(ref $last_info eq 'HASH') {
431 if(my $on_connect_do = delete $last_info->{on_connect_do}) {
432 $self->on_connect_do($on_connect_do);
433 }
434 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
435 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
436 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
437 }
438 }
486ad69b 439
046ad905 440 # Get rid of any trailing empty hashref
441 pop(@$info) if !keys %$last_info;
442 }
d7c4c15c 443
046ad905 444 $self->_connect_info($info);
445}
004d31fb 446
046ad905 447=head2 on_connect_do
4c248161 448
046ad905 449This method is deprecated in favor of setting via L</connect_info>.
486ad69b 450
f11383c2 451=head2 dbh_do
452
046ad905 453Arguments: $subref, @extra_coderef_args?
454
d4f16b21 455Execute the given subref using the new exception-based connection management.
046ad905 456
d4f16b21 457The first two arguments will be the storage object that C<dbh_do> was called
458on and a database handle to use. Any additional arguments will be passed
459verbatim to the called subref as arguments 2 and onwards.
460
461Using this (instead of $self->_dbh or $self->dbh) ensures correct
462exception handling and reconnection (or failover in future subclasses).
463
464Your subref should have no side-effects outside of the database, as
465there is the potential for your subref to be partially double-executed
466if the database connection was stale/dysfunctional.
046ad905 467
56769f7c 468Example:
f11383c2 469
56769f7c 470 my @stuff = $schema->storage->dbh_do(
471 sub {
d4f16b21 472 my ($storage, $dbh, @cols) = @_;
473 my $cols = join(q{, }, @cols);
474 $dbh->selectrow_array("SELECT $cols FROM foo");
046ad905 475 },
476 @column_list
56769f7c 477 );
f11383c2 478
479=cut
480
481sub dbh_do {
046ad905 482 my $self = shift;
aa27edf7 483 my $coderef = shift;
484
d4f16b21 485 return $coderef->($self, $self->_dbh, @_) if $self->{_in_txn_do};
aa27edf7 486
487 ref $coderef eq 'CODE' or $self->throw_exception
488 ('$coderef must be a CODE reference');
f11383c2 489
490 my @result;
491 my $want_array = wantarray;
492
493 eval {
56769f7c 494 $self->_verify_pid if $self->_dbh;
f11383c2 495 $self->_populate_dbh if !$self->_dbh;
f11383c2 496 if($want_array) {
d4f16b21 497 @result = $coderef->($self, $self->_dbh, @_);
f11383c2 498 }
56769f7c 499 elsif(defined $want_array) {
d4f16b21 500 $result[0] = $coderef->($self, $self->_dbh, @_);
f11383c2 501 }
56769f7c 502 else {
d4f16b21 503 $coderef->($self, $self->_dbh, @_);
56769f7c 504 }
f11383c2 505 };
56769f7c 506
aa27edf7 507 my $exception = $@;
508 if(!$exception) { return $want_array ? @result : $result[0] }
509
510 $self->throw_exception($exception) if $self->connected;
511
512 # We were not connected - reconnect and retry, but let any
513 # exception fall right through this time
514 $self->_populate_dbh;
d4f16b21 515 $coderef->($self, $self->_dbh, @_);
aa27edf7 516}
517
518# This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
519# It also informs dbh_do to bypass itself while under the direction of txn_do,
520# via $self->{_in_txn_do} (this saves some redundant eval and errorcheck, etc)
521sub txn_do {
522 my $self = shift;
523 my $coderef = shift;
524
525 ref $coderef eq 'CODE' or $self->throw_exception
526 ('$coderef must be a CODE reference');
527
528 local $self->{_in_txn_do} = 1;
f11383c2 529
aa27edf7 530 my @result;
531 my $want_array = wantarray;
532
d4f16b21 533 my $tried = 0;
534 while(1) {
535 eval {
536 $self->_verify_pid if $self->_dbh;
537 $self->_populate_dbh if !$self->_dbh;
aa27edf7 538
d4f16b21 539 $self->txn_begin;
540 if($want_array) {
541 @result = $coderef->(@_);
542 }
543 elsif(defined $want_array) {
544 $result[0] = $coderef->(@_);
545 }
546 else {
547 $coderef->(@_);
548 }
549 $self->txn_commit;
550 };
aa27edf7 551
d4f16b21 552 my $exception = $@;
553 if(!$exception) { return $want_array ? @result : $result[0] }
554
555 if($tried++ > 0 || $self->connected) {
556 eval { $self->txn_rollback };
557 my $rollback_exception = $@;
558 if($rollback_exception) {
559 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
560 $self->throw_exception($exception) # propagate nested rollback
561 if $rollback_exception =~ /$exception_class/;
562
563 $self->throw_exception(
564 "Transaction aborted: ${exception}. "
565 . "Rollback failed: ${rollback_exception}"
566 );
567 }
568 $self->throw_exception($exception)
aa27edf7 569 }
56769f7c 570
d4f16b21 571 # We were not connected, and was first try - reconnect and retry
572 # via the while loop
573 $self->_populate_dbh;
574 }
f11383c2 575}
576
9b83fccd 577=head2 disconnect
578
046ad905 579Our C<disconnect> method also performs a rollback first if the
9b83fccd 580database is not in C<AutoCommit> mode.
581
582=cut
583
412db1f4 584sub disconnect {
585 my ($self) = @_;
586
92925617 587 if( $self->connected ) {
588 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
589 $self->_dbh->disconnect;
590 $self->_dbh(undef);
591 }
412db1f4 592}
593
f11383c2 594sub connected {
595 my ($self) = @_;
412db1f4 596
1346e22d 597 if(my $dbh = $self->_dbh) {
598 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
1346e22d 599 return $self->_dbh(undef);
600 }
56769f7c 601 else {
602 $self->_verify_pid;
603 }
1346e22d 604 return ($dbh->FETCH('Active') && $dbh->ping);
605 }
606
607 return 0;
412db1f4 608}
609
f11383c2 610# handle pid changes correctly
56769f7c 611# NOTE: assumes $self->_dbh is a valid $dbh
f11383c2 612sub _verify_pid {
613 my ($self) = @_;
614
56769f7c 615 return if $self->_conn_pid == $$;
f11383c2 616
f11383c2 617 $self->_dbh->{InactiveDestroy} = 1;
d3abf3fe 618 $self->_dbh(undef);
f11383c2 619
620 return;
621}
622
412db1f4 623sub ensure_connected {
624 my ($self) = @_;
625
626 unless ($self->connected) {
8b445e33 627 $self->_populate_dbh;
628 }
412db1f4 629}
630
c235bbae 631=head2 dbh
632
633Returns the dbh - a data base handle of class L<DBI>.
634
635=cut
636
412db1f4 637sub dbh {
638 my ($self) = @_;
639
640 $self->ensure_connected;
8b445e33 641 return $self->_dbh;
642}
643
f1f56aad 644sub _sql_maker_args {
645 my ($self) = @_;
646
2cc3a7be 647 return ( limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
f1f56aad 648}
649
48c69e7c 650sub sql_maker {
651 my ($self) = @_;
fdc1c3d0 652 unless ($self->_sql_maker) {
f1f56aad 653 $self->_sql_maker(new DBIC::SQL::Abstract( $self->_sql_maker_args ));
48c69e7c 654 }
655 return $self->_sql_maker;
656}
657
8b445e33 658sub _populate_dbh {
659 my ($self) = @_;
1b45b01e 660 my @info = @{$self->_connect_info || []};
8b445e33 661 $self->_dbh($self->_connect(@info));
2fd24e78 662
663 if(ref $self eq 'DBIx::Class::Storage::DBI') {
664 my $driver = $self->_dbh->{Driver}->{Name};
efe6365b 665 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
2fd24e78 666 bless $self, "DBIx::Class::Storage::DBI::${driver}";
667 $self->_rebless() if $self->can('_rebless');
668 }
843f8ecd 669 }
2fd24e78 670
d7c4c15c 671 # if on-connect sql statements are given execute them
672 foreach my $sql_statement (@{$self->on_connect_do || []}) {
4c248161 673 $self->debugobj->query_start($sql_statement) if $self->debug();
d7c4c15c 674 $self->_dbh->do($sql_statement);
4c248161 675 $self->debugobj->query_end($sql_statement) if $self->debug();
d7c4c15c 676 }
5ef3e508 677
1346e22d 678 $self->_conn_pid($$);
679 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
8b445e33 680}
681
682sub _connect {
683 my ($self, @info) = @_;
5ef3e508 684
9d31f7dc 685 $self->throw_exception("You failed to provide any connection info")
686 if !@info;
687
90ec6cad 688 my ($old_connect_via, $dbh);
689
5ef3e508 690 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
90ec6cad 691 $old_connect_via = $DBI::connect_via;
5ef3e508 692 $DBI::connect_via = 'connect';
5ef3e508 693 }
694
75db246c 695 eval {
f5de3933 696 if(ref $info[0] eq 'CODE') {
697 $dbh = &{$info[0]}
698 }
699 else {
700 $dbh = DBI->connect(@info);
701 $dbh->{RaiseError} = 1;
702 $dbh->{PrintError} = 0;
703 }
75db246c 704 };
90ec6cad 705
706 $DBI::connect_via = $old_connect_via if $old_connect_via;
707
75db246c 708 if (!$dbh || $@) {
709 $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
710 }
90ec6cad 711
e571e823 712 $dbh;
8b445e33 713}
714
d4f16b21 715sub _dbh_txn_begin {
716 my ($self, $dbh) = @_;
d32d82f9 717 if ($dbh->{AutoCommit}) {
718 $self->debugobj->txn_begin()
719 if ($self->debug);
720 $dbh->begin_work;
721 }
722}
723
8091aa91 724sub txn_begin {
d79f59b9 725 my $self = shift;
d4f16b21 726 $self->dbh_do($self->can('_dbh_txn_begin'))
d32d82f9 727 if $self->{transaction_depth}++ == 0;
728}
729
d4f16b21 730sub _dbh_txn_commit {
731 my ($self, $dbh) = @_;
d32d82f9 732 if ($self->{transaction_depth} == 0) {
733 unless ($dbh->{AutoCommit}) {
734 $self->debugobj->txn_commit()
735 if ($self->debug);
736 $dbh->commit;
737 }
738 }
739 else {
740 if (--$self->{transaction_depth} == 0) {
741 $self->debugobj->txn_commit()
742 if ($self->debug);
743 $dbh->commit;
744 }
986e4fca 745 }
8091aa91 746}
8b445e33 747
8091aa91 748sub txn_commit {
d79f59b9 749 my $self = shift;
d4f16b21 750 $self->dbh_do($self->can('_dbh_txn_commit'));
d32d82f9 751}
752
d4f16b21 753sub _dbh_txn_rollback {
754 my ($self, $dbh) = @_;
d32d82f9 755 if ($self->{transaction_depth} == 0) {
756 unless ($dbh->{AutoCommit}) {
757 $self->debugobj->txn_rollback()
758 if ($self->debug);
759 $dbh->rollback;
760 }
761 }
762 else {
763 if (--$self->{transaction_depth} == 0) {
764 $self->debugobj->txn_rollback()
765 if ($self->debug);
766 $dbh->rollback;
986e4fca 767 }
f11383c2 768 else {
d32d82f9 769 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
986e4fca 770 }
d32d82f9 771 }
8091aa91 772}
773
8091aa91 774sub txn_rollback {
d79f59b9 775 my $self = shift;
d4f16b21 776
777 eval { $self->dbh_do($self->can('_dbh_txn_rollback')) };
a62cf8d4 778 if ($@) {
779 my $error = $@;
780 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
781 $error =~ /$exception_class/ and $self->throw_exception($error);
782 $self->{transaction_depth} = 0; # ensure that a failed rollback
783 $self->throw_exception($error); # resets the transaction depth
8091aa91 784 }
785}
8b445e33 786
b7151206 787# This used to be the top-half of _execute. It was split out to make it
788# easier to override in NoBindVars without duping the rest. It takes up
789# all of _execute's args, and emits $sql, @bind.
790sub _prep_for_execute {
223b8fe3 791 my ($self, $op, $extra_bind, $ident, @args) = @_;
b7151206 792
223b8fe3 793 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
944f30bf 794 unshift(@bind, @$extra_bind) if $extra_bind;
b7151206 795 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
796
797 return ($sql, @bind);
798}
799
800sub _execute {
801 my $self = shift;
802
803 my ($sql, @bind) = $self->_prep_for_execute(@_);
804
f59ffc79 805 if ($self->debug) {
e673f011 806 my @debug_bind = map { defined $_ ? qq{'$_'} : q{'NULL'} } @bind;
4c248161 807 $self->debugobj->query_start($sql, @debug_bind);
f59ffc79 808 }
b7151206 809
810 my $sth = eval { $self->sth($sql) };
75db246c 811
812 if (!$sth || $@) {
ec0ff6f6 813 $self->throw_exception(
814 'no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql"
815 );
75db246c 816 }
b7151206 817
701da8c4 818 my $rv;
75d07914 819 if ($sth) {
4c248161 820 my $time = time();
95dad7e2 821 $rv = eval { $sth->execute(@bind) };
822
823 if ($@ || !$rv) {
824 $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
825 }
75d07914 826 } else {
1c339d71 827 $self->throw_exception("'$sql' did not generate a statement.");
701da8c4 828 }
4c248161 829 if ($self->debug) {
830 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
831 $self->debugobj->query_end($sql, @debug_bind);
832 }
223b8fe3 833 return (wantarray ? ($rv, $sth, @bind) : $rv);
834}
835
8b445e33 836sub insert {
837 my ($self, $ident, $to_insert) = @_;
bc0c9800 838 $self->throw_exception(
839 "Couldn't insert ".join(', ',
840 map "$_ => $to_insert->{$_}", keys %$to_insert
841 )." into ${ident}"
842 ) unless ($self->_execute('insert' => [], $ident, $to_insert));
8b445e33 843 return $to_insert;
844}
845
846sub update {
223b8fe3 847 return shift->_execute('update' => [], @_);
8b445e33 848}
849
850sub delete {
223b8fe3 851 return shift->_execute('delete' => [], @_);
8b445e33 852}
853
de705b51 854sub _select {
8b445e33 855 my ($self, $ident, $select, $condition, $attrs) = @_;
223b8fe3 856 my $order = $attrs->{order_by};
857 if (ref $condition eq 'SCALAR') {
858 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
859 }
8839560b 860 if (exists $attrs->{group_by} || $attrs->{having}) {
bc0c9800 861 $order = {
862 group_by => $attrs->{group_by},
863 having => $attrs->{having},
864 ($order ? (order_by => $order) : ())
865 };
54540863 866 }
5c91499f 867 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
9229f20a 868 if ($attrs->{software_limit} ||
869 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
870 $attrs->{software_limit} = 1;
5c91499f 871 } else {
0823196c 872 $self->throw_exception("rows attribute must be positive if present")
873 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
5c91499f 874 push @args, $attrs->{rows}, $attrs->{offset};
875 }
de705b51 876 return $self->_execute(@args);
877}
878
9b83fccd 879=head2 select
880
d3b0e369 881=over 4
882
883=item Arguments: $ident, $select, $condition, $attrs
884
885=back
886
9b83fccd 887Handle a SQL select statement.
888
889=cut
890
de705b51 891sub select {
892 my $self = shift;
893 my ($ident, $select, $condition, $attrs) = @_;
cb5f2eea 894 return $self->cursor->new($self, \@_, $attrs);
8b445e33 895}
896
1a14aa3f 897sub select_single {
de705b51 898 my $self = shift;
899 my ($rv, $sth, @bind) = $self->_select(@_);
6157db4f 900 my @row = $sth->fetchrow_array;
a3eaff0e 901 # Need to call finish() to work round broken DBDs
6157db4f 902 $sth->finish();
903 return @row;
1a14aa3f 904}
905
9b83fccd 906=head2 sth
907
d3b0e369 908=over 4
909
910=item Arguments: $sql
911
912=back
913
9b83fccd 914Returns a L<DBI> sth (statement handle) for the supplied SQL.
915
916=cut
917
d4f16b21 918sub _dbh_sth {
919 my ($self, $dbh, $sql) = @_;
d32d82f9 920 # 3 is the if_active parameter which avoids active sth re-use
921 $dbh->prepare_cached($sql, {}, 3);
922}
923
8b445e33 924sub sth {
cb5f2eea 925 my ($self, $sql) = @_;
d4f16b21 926 $self->dbh_do($self->can('_dbh_sth'), $sql);
8b445e33 927}
928
d4f16b21 929sub _dbh_columns_info_for {
930 my ($self, $dbh, $table) = @_;
a32e8402 931
d32d82f9 932 if ($dbh->can('column_info')) {
a953d8d9 933 my %result;
d32d82f9 934 eval {
935 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
936 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
937 $sth->execute();
938 while ( my $info = $sth->fetchrow_hashref() ){
939 my %column_info;
940 $column_info{data_type} = $info->{TYPE_NAME};
941 $column_info{size} = $info->{COLUMN_SIZE};
942 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
943 $column_info{default_value} = $info->{COLUMN_DEF};
944 my $col_name = $info->{COLUMN_NAME};
945 $col_name =~ s/^\"(.*)\"$/$1/;
946
947 $result{$col_name} = \%column_info;
0d67fe74 948 }
d32d82f9 949 };
093fc7a6 950 return \%result if !$@ && scalar keys %result;
d32d82f9 951 }
0d67fe74 952
d32d82f9 953 my %result;
954 my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
955 $sth->execute;
956 my @columns = @{$sth->{NAME_lc}};
957 for my $i ( 0 .. $#columns ){
958 my %column_info;
959 my $type_num = $sth->{TYPE}->[$i];
960 my $type_name;
961 if(defined $type_num && $dbh->can('type_info')) {
962 my $type_info = $dbh->type_info($type_num);
963 $type_name = $type_info->{TYPE_NAME} if $type_info;
964 }
965 $column_info{data_type} = $type_name ? $type_name : $type_num;
966 $column_info{size} = $sth->{PRECISION}->[$i];
967 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
0d67fe74 968
d32d82f9 969 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
970 $column_info{data_type} = $1;
971 $column_info{size} = $2;
0d67fe74 972 }
973
d32d82f9 974 $result{$columns[$i]} = \%column_info;
975 }
976
977 return \%result;
978}
979
980sub columns_info_for {
981 my ($self, $table) = @_;
d4f16b21 982 $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
a953d8d9 983}
984
9b83fccd 985=head2 last_insert_id
986
987Return the row id of the last insert.
988
989=cut
990
d4f16b21 991sub _dbh_last_insert_id {
992 my ($self, $dbh, $source, $col) = @_;
993 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
994 $dbh->func('last_insert_rowid');
995}
996
843f8ecd 997sub last_insert_id {
d4f16b21 998 my $self = shift;
999 $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
843f8ecd 1000}
1001
9b83fccd 1002=head2 sqlt_type
1003
1004Returns the database driver name.
1005
1006=cut
1007
d4f16b21 1008sub sqlt_type { shift->dbh->{Driver}->{Name} }
1c339d71 1009
9b83fccd 1010=head2 create_ddl_dir (EXPERIMENTAL)
1011
1012=over 4
1013
1014=item Arguments: $schema \@databases, $version, $directory, $sqlt_args
1015
1016=back
1017
d3b0e369 1018Creates a SQL file based on the Schema, for each of the specified
9b83fccd 1019database types, in the given directory.
1020
1021Note that this feature is currently EXPERIMENTAL and may not work correctly
1022across all databases, or fully handle complex relationships.
1023
1024=cut
1025
e673f011 1026sub create_ddl_dir
1027{
1028 my ($self, $schema, $databases, $version, $dir, $sqltargs) = @_;
1029
1030 if(!$dir || !-d $dir)
1031 {
1032 warn "No directory given, using ./\n";
1033 $dir = "./";
1034 }
1035 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1036 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1037 $version ||= $schema->VERSION || '1.x';
9e7b9292 1038 $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
e673f011 1039
1c339d71 1040 eval "use SQL::Translator";
1041 $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
e673f011 1042
9e7b9292 1043 my $sqlt = SQL::Translator->new($sqltargs);
e673f011 1044 foreach my $db (@$databases)
1045 {
1046 $sqlt->reset();
1047 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1048# $sqlt->parser_args({'DBIx::Class' => $schema);
1049 $sqlt->data($schema);
1050 $sqlt->producer($db);
1051
1052 my $file;
1053 my $filename = $schema->ddl_filename($db, $dir, $version);
1054 if(-e $filename)
1055 {
1056 $self->throw_exception("$filename already exists, skipping $db");
1057 next;
1058 }
1059 open($file, ">$filename")
1060 or $self->throw_exception("Can't open $filename for writing ($!)");
1061 my $output = $sqlt->translate;
1062#use Data::Dumper;
1063# print join(":", keys %{$schema->source_registrations});
1064# print Dumper($sqlt->schema);
1065 if(!$output)
1066 {
1067 $self->throw_exception("Failed to translate to $db. (" . $sqlt->error . ")");
1068 next;
1069 }
1070 print $file $output;
1071 close($file);
1072 }
1073
1074}
1075
9b83fccd 1076=head2 deployment_statements
1077
d3b0e369 1078=over 4
1079
1080=item Arguments: $schema, $type, $version, $directory, $sqlt_args
1081
1082=back
1083
1084Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1085The database driver name is given by C<$type>, though the value from
1086L</sqlt_type> is used if it is not specified.
1087
1088C<$directory> is used to return statements from files in a previously created
1089L</create_ddl_dir> directory and is optional. The filenames are constructed
1090from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1091
1092If no C<$directory> is specified then the statements are constructed on the
1093fly using L<SQL::Translator> and C<$version> is ignored.
1094
1095See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
9b83fccd 1096
1097=cut
1098
e673f011 1099sub deployment_statements {
1100 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
915919c5 1101 # Need to be connected to get the correct sqlt_type
c377d939 1102 $self->ensure_connected() unless $type;
e673f011 1103 $type ||= $self->sqlt_type;
1104 $version ||= $schema->VERSION || '1.x';
1105 $dir ||= './';
0382d607 1106 eval "use SQL::Translator";
1107 if(!$@)
1108 {
1109 eval "use SQL::Translator::Parser::DBIx::Class;";
1110 $self->throw_exception($@) if $@;
1111 eval "use SQL::Translator::Producer::${type};";
1112 $self->throw_exception($@) if $@;
1113 my $tr = SQL::Translator->new(%$sqltargs);
1114 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1115 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1116 }
e673f011 1117
1118 my $filename = $schema->ddl_filename($type, $dir, $version);
1119 if(!-f $filename)
1120 {
0382d607 1121# $schema->create_ddl_dir([ $type ], $version, $dir, $sqltargs);
1122 $self->throw_exception("No SQL::Translator, and no Schema file found, aborting deploy");
1123 return;
e673f011 1124 }
1125 my $file;
1126 open($file, "<$filename")
1127 or $self->throw_exception("Can't open $filename ($!)");
1128 my @rows = <$file>;
1129 close($file);
1130
1131 return join('', @rows);
1132
1c339d71 1133}
843f8ecd 1134
1c339d71 1135sub deploy {
260129d8 1136 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1137 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
e4fe9ba3 1138 for ( split(";\n", $statement)) {
e673f011 1139 next if($_ =~ /^--/);
1140 next if(!$_);
1141# next if($_ =~ /^DROP/m);
1142 next if($_ =~ /^BEGIN TRANSACTION/m);
1143 next if($_ =~ /^COMMIT/m);
b489f68a 1144 next if $_ =~ /^\s+$/; # skip whitespace only
bdea30e3 1145 $self->debugobj->query_start($_) if $self->debug;
f11383c2 1146 $self->dbh->do($_) or warn "SQL was:\n $_"; # XXX exceptions?
4c248161 1147 $self->debugobj->query_end($_) if $self->debug;
e4fe9ba3 1148 }
75d07914 1149 }
1c339d71 1150}
843f8ecd 1151
9b83fccd 1152=head2 datetime_parser
1153
1154Returns the datetime parser class
1155
1156=cut
1157
f86fcf0d 1158sub datetime_parser {
1159 my $self = shift;
1160 return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1161}
1162
9b83fccd 1163=head2 datetime_parser_type
1164
1165Defines (returns) the datetime parser class - currently hardwired to
1166L<DateTime::Format::MySQL>
1167
1168=cut
1169
f86fcf0d 1170sub datetime_parser_type { "DateTime::Format::MySQL"; }
1171
9b83fccd 1172=head2 build_datetime_parser
1173
1174See L</datetime_parser>
1175
1176=cut
1177
f86fcf0d 1178sub build_datetime_parser {
1179 my $self = shift;
1180 my $type = $self->datetime_parser_type(@_);
1181 eval "use ${type}";
1182 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1183 return $type;
1184}
1185
c756145c 1186sub DESTROY {
1187 my $self = shift;
f5de3933 1188 return if !$self->_dbh;
c756145c 1189 $self->_verify_pid;
1190 $self->_dbh(undef);
1191}
92925617 1192
8b445e33 11931;
1194
9b83fccd 1195=head1 SQL METHODS
1196
1197The module defines a set of methods within the DBIC::SQL::Abstract
1198namespace. These build on L<SQL::Abstract::Limit> to provide the
1199SQL query functions.
1200
1201The following methods are extended:-
1202
1203=over 4
1204
1205=item delete
1206
1207=item insert
1208
1209=item select
1210
1211=item update
1212
1213=item limit_dialect
1214
2cc3a7be 1215See L</connect_info> for details.
1216For setting, this method is deprecated in favor of L</connect_info>.
bb4f246d 1217
9b83fccd 1218=item quote_char
1219
2cc3a7be 1220See L</connect_info> for details.
1221For setting, this method is deprecated in favor of L</connect_info>.
bb4f246d 1222
9b83fccd 1223=item name_sep
1224
2cc3a7be 1225See L</connect_info> for details.
1226For setting, this method is deprecated in favor of L</connect_info>.
bb4f246d 1227
9b83fccd 1228=back
1229
8b445e33 1230=head1 AUTHORS
1231
daec44b8 1232Matt S. Trout <mst@shadowcatsystems.co.uk>
8b445e33 1233
9f19b1d6 1234Andy Grundman <andy@hybridized.org>
1235
8b445e33 1236=head1 LICENSE
1237
1238You may distribute this code under the same terms as Perl itself.
1239
1240=cut