Minor cookbook fix (two adjacent examples were mixed up)
[dbsrgits/DBIx-Class.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
eda28767 6use strict;
20a2c954 7use warnings;
550adccc 8use Carp::Clan qw/^DBIx::Class/;
8b445e33 9use DBI;
aeaf3ce2 10use SQL::Abstract::Limit;
28927b50 11use DBIx::Class::Storage::DBI::Cursor;
4c248161 12use DBIx::Class::Storage::Statistics;
664612fb 13use Scalar::Util qw/blessed weaken/;
046ad905 14
541df64a 15__PACKAGE__->mk_group_accessors('simple' =>
16 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts
e4eb8ee1 17 _conn_pid _conn_tid disable_sth_caching on_connect_do
d6feb60f 18 on_disconnect_do transaction_depth unsafe _dbh_autocommit
ddf66ced 19 auto_savepoint savepoints/
046ad905 20);
21
e4eb8ee1 22__PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
23
95ba7ee4 24__PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
25__PACKAGE__->sql_maker_class('DBIC::SQL::Abstract');
26
bd7efd39 27BEGIN {
28
a89c6fc0 29package # Hide from PAUSE
30 DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
bd7efd39 31
32use base qw/SQL::Abstract::Limit/;
33
2cc3a7be 34# This prevents the caching of $dbh in S::A::L, I believe
35sub new {
36 my $self = shift->SUPER::new(@_);
37
38 # If limit_dialect is a ref (like a $dbh), go ahead and replace
39 # it with what it resolves to:
40 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
41 if ref $self->{limit_dialect};
42
43 $self;
44}
45
260129d8 46sub _RowNumberOver {
47 my ($self, $sql, $order, $rows, $offset ) = @_;
48
49 $offset += 1;
50 my $last = $rows + $offset;
51 my ( $order_by ) = $self->_order_by( $order );
52
53 $sql = <<"";
54SELECT * FROM
55(
56 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
57 $sql
58 $order_by
59 ) Q1
60) Q2
61WHERE ROW_NUM BETWEEN $offset AND $last
62
63 return $sql;
64}
65
66
2cc3a7be 67# While we're at it, this should make LIMIT queries more efficient,
68# without digging into things too deeply
758272ec 69use Scalar::Util 'blessed';
2cc3a7be 70sub _find_syntax {
71 my ($self, $syntax) = @_;
758272ec 72 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
260129d8 73 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
74 return 'RowNumberOver';
75 }
76
2cc3a7be 77 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
78}
79
54540863 80sub select {
81 my ($self, $table, $fields, $where, $order, @rest) = @_;
6346a152 82 $table = $self->_quote($table) unless ref($table);
eac29141 83 local $self->{rownum_hack_count} = 1
84 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
54540863 85 @rest = (-1) unless defined $rest[0];
0823196c 86 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
87 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
8839560b 88 local $self->{having_bind} = [];
bc0c9800 89 my ($sql, @ret) = $self->SUPER::select(
90 $table, $self->_recurse_fields($fields), $where, $order, @rest
91 );
95ba7ee4 92 $sql .=
93 $self->{for} ?
94 (
95 $self->{for} eq 'update' ? ' FOR UPDATE' :
96 $self->{for} eq 'shared' ? ' FOR SHARE' :
97 ''
98 ) :
99 ''
100 ;
8839560b 101 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
54540863 102}
103
6346a152 104sub insert {
105 my $self = shift;
106 my $table = shift;
107 $table = $self->_quote($table) unless ref($table);
108 $self->SUPER::insert($table, @_);
109}
110
111sub update {
112 my $self = shift;
113 my $table = shift;
114 $table = $self->_quote($table) unless ref($table);
115 $self->SUPER::update($table, @_);
116}
117
118sub delete {
119 my $self = shift;
120 my $table = shift;
121 $table = $self->_quote($table) unless ref($table);
122 $self->SUPER::delete($table, @_);
123}
124
54540863 125sub _emulate_limit {
126 my $self = shift;
127 if ($_[3] == -1) {
128 return $_[1].$self->_order_by($_[2]);
129 } else {
130 return $self->SUPER::_emulate_limit(@_);
131 }
132}
133
134sub _recurse_fields {
e8e971f2 135 my ($self, $fields, $params) = @_;
54540863 136 my $ref = ref $fields;
137 return $self->_quote($fields) unless $ref;
138 return $$fields if $ref eq 'SCALAR';
139
140 if ($ref eq 'ARRAY') {
1d78a406 141 return join(', ', map {
eac29141 142 $self->_recurse_fields($_)
1d78a406 143 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
144 ? ' AS col'.$self->{rownum_hack_count}++
145 : '')
e8e971f2 146 } @$fields);
54540863 147 } elsif ($ref eq 'HASH') {
148 foreach my $func (keys %$fields) {
149 return $self->_sqlcase($func)
150 .'( '.$self->_recurse_fields($fields->{$func}).' )';
151 }
152 }
153}
154
155sub _order_by {
156 my $self = shift;
157 my $ret = '';
8839560b 158 my @extra;
54540863 159 if (ref $_[0] eq 'HASH') {
160 if (defined $_[0]->{group_by}) {
161 $ret = $self->_sqlcase(' group by ')
1d78a406 162 .$self->_recurse_fields($_[0]->{group_by}, { no_rownum_hack => 1 });
54540863 163 }
8839560b 164 if (defined $_[0]->{having}) {
165 my $frag;
166 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
167 push(@{$self->{having_bind}}, @extra);
168 $ret .= $self->_sqlcase(' having ').$frag;
169 }
54540863 170 if (defined $_[0]->{order_by}) {
7ce5cbe7 171 $ret .= $self->_order_by($_[0]->{order_by});
54540863 172 }
d09c569a 173 } elsif (ref $_[0] eq 'SCALAR') {
e535069e 174 $ret = $self->_sqlcase(' order by ').${ $_[0] };
d09c569a 175 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
176 my @order = @{+shift};
177 $ret = $self->_sqlcase(' order by ')
178 .join(', ', map {
179 my $r = $self->_order_by($_, @_);
180 $r =~ s/^ ?ORDER BY //i;
181 $r;
182 } @order);
54540863 183 } else {
184 $ret = $self->SUPER::_order_by(@_);
185 }
186 return $ret;
187}
188
f48dd03f 189sub _order_directions {
190 my ($self, $order) = @_;
191 $order = $order->{order_by} if ref $order eq 'HASH';
192 return $self->SUPER::_order_directions($order);
193}
194
2a816814 195sub _table {
bd7efd39 196 my ($self, $from) = @_;
197 if (ref $from eq 'ARRAY') {
198 return $self->_recurse_from(@$from);
199 } elsif (ref $from eq 'HASH') {
200 return $self->_make_as($from);
201 } else {
6346a152 202 return $from; # would love to quote here but _table ends up getting called
203 # twice during an ->select without a limit clause due to
204 # the way S::A::Limit->select works. should maybe consider
205 # bypassing this and doing S::A::select($self, ...) in
206 # our select method above. meantime, quoting shims have
207 # been added to select/insert/update/delete here
bd7efd39 208 }
209}
210
211sub _recurse_from {
212 my ($self, $from, @join) = @_;
213 my @sqlf;
214 push(@sqlf, $self->_make_as($from));
215 foreach my $j (@join) {
216 my ($to, $on) = @$j;
73856587 217
54540863 218 # check whether a join type exists
219 my $join_clause = '';
ca7b9fdf 220 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
221 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
222 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
54540863 223 } else {
224 $join_clause = ' JOIN ';
225 }
73856587 226 push(@sqlf, $join_clause);
227
bd7efd39 228 if (ref $to eq 'ARRAY') {
229 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
230 } else {
96cdbbab 231 push(@sqlf, $self->_make_as($to));
bd7efd39 232 }
233 push(@sqlf, ' ON ', $self->_join_condition($on));
234 }
235 return join('', @sqlf);
236}
237
238sub _make_as {
239 my ($self, $from) = @_;
54540863 240 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
bc0c9800 241 reverse each %{$self->_skip_options($from)});
73856587 242}
243
244sub _skip_options {
54540863 245 my ($self, $hash) = @_;
246 my $clean_hash = {};
247 $clean_hash->{$_} = $hash->{$_}
248 for grep {!/^-/} keys %$hash;
249 return $clean_hash;
bd7efd39 250}
251
252sub _join_condition {
253 my ($self, $cond) = @_;
5efe4c79 254 if (ref $cond eq 'HASH') {
255 my %j;
bc0c9800 256 for (keys %$cond) {
635b9634 257 my $v = $cond->{$_};
258 if (ref $v) {
259 # XXX no throw_exception() in this package and croak() fails with strange results
260 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
261 if ref($v) ne 'SCALAR';
262 $j{$_} = $v;
263 }
264 else {
265 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
266 }
bc0c9800 267 };
635b9634 268 return scalar($self->_recurse_where(\%j));
5efe4c79 269 } elsif (ref $cond eq 'ARRAY') {
270 return join(' OR ', map { $self->_join_condition($_) } @$cond);
271 } else {
272 die "Can't handle this yet!";
273 }
bd7efd39 274}
275
2a816814 276sub _quote {
277 my ($self, $label) = @_;
278 return '' unless defined $label;
3b24f6ea 279 return "*" if $label eq '*';
41728a6e 280 return $label unless $self->{quote_char};
3b24f6ea 281 if(ref $self->{quote_char} eq "ARRAY"){
282 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
283 if !defined $self->{name_sep};
284 my $sep = $self->{name_sep};
285 return join($self->{name_sep},
286 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
287 split(/\Q$sep\E/,$label));
288 }
2a816814 289 return $self->SUPER::_quote($label);
290}
291
7be93b07 292sub limit_dialect {
293 my $self = shift;
294 $self->{limit_dialect} = shift if @_;
295 return $self->{limit_dialect};
296}
297
2437a1e3 298sub quote_char {
299 my $self = shift;
300 $self->{quote_char} = shift if @_;
301 return $self->{quote_char};
302}
303
304sub name_sep {
305 my $self = shift;
306 $self->{name_sep} = shift if @_;
307 return $self->{name_sep};
308}
309
bd7efd39 310} # End of BEGIN block
311
b327f988 312=head1 NAME
313
314DBIx::Class::Storage::DBI - DBI storage handler
315
316=head1 SYNOPSIS
317
318=head1 DESCRIPTION
319
046ad905 320This class represents the connection to an RDBMS via L<DBI>. See
321L<DBIx::Class::Storage> for general information. This pod only
322documents DBI-specific methods and behaviors.
b327f988 323
324=head1 METHODS
325
9b83fccd 326=cut
327
8b445e33 328sub new {
046ad905 329 my $new = shift->next::method(@_);
82cc0386 330
d79f59b9 331 $new->transaction_depth(0);
2cc3a7be 332 $new->_sql_maker_opts({});
ddf66ced 333 $new->{savepoints} = [];
1b994857 334 $new->{_in_dbh_do} = 0;
dbaee748 335 $new->{_dbh_gen} = 0;
82cc0386 336
046ad905 337 $new;
1c339d71 338}
339
1b45b01e 340=head2 connect_info
341
bb4f246d 342The arguments of C<connect_info> are always a single array reference.
1b45b01e 343
bb4f246d 344This is normally accessed via L<DBIx::Class::Schema/connection>, which
345encapsulates its argument list in an arrayref before calling
346C<connect_info> here.
1b45b01e 347
bb4f246d 348The arrayref can either contain the same set of arguments one would
349normally pass to L<DBI/connect>, or a lone code reference which returns
77d76d0f 350a connected database handle. Please note that the L<DBI> docs
351recommend that you always explicitly set C<AutoCommit> to either
352C<0> or C<1>. L<DBIx::Class> further recommends that it be set
353to C<1>, and that you perform transactions via our L</txn_do>
2bc2ddc7 354method. L<DBIx::Class> will set it to C<1> if you do not do explicitly
355set it to zero. This is the default for most DBDs. See below for more
356details.
d7c4c15c 357
2cc3a7be 358In either case, if the final argument in your connect_info happens
359to be a hashref, C<connect_info> will look there for several
360connection-specific options:
361
362=over 4
363
364=item on_connect_do
365
6d2e7a96 366Specifies things to do immediately after connecting or re-connecting to
367the database. Its value may contain:
368
369=over
370
371=item an array reference
372
373This contains SQL statements to execute in order. Each element contains
374a string or a code reference that returns a string.
375
376=item a code reference
377
378This contains some code to execute. Unlike code references within an
379array reference, its return value is ignored.
380
381=back
579ca3f7 382
383=item on_disconnect_do
384
1dafdb2a 385Takes arguments in the same form as L<on_connect_do> and executes them
6d2e7a96 386immediately before disconnecting from the database.
579ca3f7 387
388Note, this only runs if you explicitly call L<disconnect> on the
389storage object.
2cc3a7be 390
b33697ef 391=item disable_sth_caching
392
393If set to a true value, this option will disable the caching of
394statement handles via L<DBI/prepare_cached>.
395
2cc3a7be 396=item limit_dialect
397
398Sets the limit dialect. This is useful for JDBC-bridge among others
399where the remote SQL-dialect cannot be determined by the name of the
400driver alone.
401
402=item quote_char
d7c4c15c 403
2cc3a7be 404Specifies what characters to use to quote table and column names. If
405you use this you will want to specify L<name_sep> as well.
406
407quote_char expects either a single character, in which case is it is placed
408on either side of the table/column, or an arrayref of length 2 in which case the
409table/column name is placed between the elements.
410
411For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd
412use C<quote_char =E<gt> [qw/[ ]/]>.
413
414=item name_sep
415
416This only needs to be used in conjunction with L<quote_char>, and is used to
417specify the charecter that seperates elements (schemas, tables, columns) from
418each other. In most cases this is simply a C<.>.
419
61646ebd 420=item unsafe
421
422This Storage driver normally installs its own C<HandleError>, sets
2ab60eb9 423C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
424all database handles, including those supplied by a coderef. It does this
425so that it can have consistent and useful error behavior.
61646ebd 426
427If you set this option to a true value, Storage will not do its usual
2ab60eb9 428modifications to the database handle's attributes, and instead relies on
429the settings in your connect_info DBI options (or the values you set in
430your connection coderef, in the case that you are connecting via coderef).
61646ebd 431
432Note that your custom settings can cause Storage to malfunction,
433especially if you set a C<HandleError> handler that suppresses exceptions
434and/or disable C<RaiseError>.
435
a3628767 436=item auto_savepoint
437
438If this option is true, L<DBIx::Class> will use savepoints when nesting
439transactions, making it possible to recover from failure in the inner
440transaction without having to abort all outer transactions.
441
2cc3a7be 442=back
443
444These options can be mixed in with your other L<DBI> connection attributes,
445or placed in a seperate hashref after all other normal L<DBI> connection
446arguments.
447
448Every time C<connect_info> is invoked, any previous settings for
449these options will be cleared before setting the new ones, regardless of
450whether any options are specified in the new C<connect_info>.
451
77d76d0f 452Another Important Note:
453
454DBIC can do some wonderful magic with handling exceptions,
c64db0f4 455disconnections, and transactions when you use C<< AutoCommit => 1 >>
77d76d0f 456combined with C<txn_do> for transaction support.
457
c64db0f4 458If you set C<< AutoCommit => 0 >> in your connect info, then you are always
77d76d0f 459in an assumed transaction between commits, and you're telling us you'd
460like to manage that manually. A lot of DBIC's magic protections
461go away. We can't protect you from exceptions due to database
462disconnects because we don't know anything about how to restart your
463transactions. You're on your own for handling all sorts of exceptional
c64db0f4 464cases if you choose the C<< AutoCommit => 0 >> path, just as you would
77d76d0f 465be with raw DBI.
466
2cc3a7be 467Examples:
468
469 # Simple SQLite connection
bb4f246d 470 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
6789ebe3 471
2cc3a7be 472 # Connect via subref
bb4f246d 473 ->connect_info([ sub { DBI->connect(...) } ]);
6789ebe3 474
2cc3a7be 475 # A bit more complicated
bb4f246d 476 ->connect_info(
477 [
478 'dbi:Pg:dbname=foo',
479 'postgres',
480 'my_pg_password',
77d76d0f 481 { AutoCommit => 1 },
2cc3a7be 482 { quote_char => q{"}, name_sep => q{.} },
483 ]
484 );
485
486 # Equivalent to the previous example
487 ->connect_info(
488 [
489 'dbi:Pg:dbname=foo',
490 'postgres',
491 'my_pg_password',
77d76d0f 492 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
bb4f246d 493 ]
494 );
6789ebe3 495
2cc3a7be 496 # Subref + DBIC-specific connection options
bb4f246d 497 ->connect_info(
498 [
499 sub { DBI->connect(...) },
2cc3a7be 500 {
501 quote_char => q{`},
502 name_sep => q{@},
503 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
b33697ef 504 disable_sth_caching => 1,
2cc3a7be 505 },
bb4f246d 506 ]
507 );
6789ebe3 508
004d31fb 509=cut
510
046ad905 511sub connect_info {
512 my ($self, $info_arg) = @_;
4c248161 513
046ad905 514 return $self->_connect_info if !$info_arg;
4c248161 515
046ad905 516 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
517 # the new set of options
518 $self->_sql_maker(undef);
519 $self->_sql_maker_opts({});
fdad5fab 520 $self->_connect_info([@$info_arg]); # copy for _connect_info
486ad69b 521
fdad5fab 522 my $dbi_info = [@$info_arg]; # copy for _dbi_connect_info
8df3d107 523
541df64a 524 my $last_info = $dbi_info->[-1];
046ad905 525 if(ref $last_info eq 'HASH') {
9a0891be 526 $last_info = { %$last_info }; # so delete is non-destructive
5322ea52 527 my @storage_option = qw(
528 on_connect_do on_disconnect_do disable_sth_caching unsafe cursor_class
d6feb60f 529 auto_savepoint
5322ea52 530 );
579ca3f7 531 for my $storage_opt (@storage_option) {
b33697ef 532 if(my $value = delete $last_info->{$storage_opt}) {
533 $self->$storage_opt($value);
534 }
046ad905 535 }
536 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
537 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
538 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
539 }
540 }
9a0891be 541 # re-insert modified hashref
542 $dbi_info->[-1] = $last_info;
486ad69b 543
046ad905 544 # Get rid of any trailing empty hashref
541df64a 545 pop(@$dbi_info) if !keys %$last_info;
046ad905 546 }
fdad5fab 547 $self->_dbi_connect_info($dbi_info);
d7c4c15c 548
fdad5fab 549 $self->_connect_info;
046ad905 550}
004d31fb 551
046ad905 552=head2 on_connect_do
4c248161 553
046ad905 554This method is deprecated in favor of setting via L</connect_info>.
486ad69b 555
f11383c2 556=head2 dbh_do
557
3ff1602f 558Arguments: ($subref | $method_name), @extra_coderef_args?
046ad905 559
3ff1602f 560Execute the given $subref or $method_name using the new exception-based
561connection management.
046ad905 562
d4f16b21 563The first two arguments will be the storage object that C<dbh_do> was called
564on and a database handle to use. Any additional arguments will be passed
565verbatim to the called subref as arguments 2 and onwards.
566
567Using this (instead of $self->_dbh or $self->dbh) ensures correct
568exception handling and reconnection (or failover in future subclasses).
569
570Your subref should have no side-effects outside of the database, as
571there is the potential for your subref to be partially double-executed
572if the database connection was stale/dysfunctional.
046ad905 573
56769f7c 574Example:
f11383c2 575
56769f7c 576 my @stuff = $schema->storage->dbh_do(
577 sub {
d4f16b21 578 my ($storage, $dbh, @cols) = @_;
579 my $cols = join(q{, }, @cols);
580 $dbh->selectrow_array("SELECT $cols FROM foo");
046ad905 581 },
582 @column_list
56769f7c 583 );
f11383c2 584
585=cut
586
587sub dbh_do {
046ad905 588 my $self = shift;
3ff1602f 589 my $code = shift;
aa27edf7 590
6ad1059d 591 my $dbh = $self->_dbh;
592
593 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
cb19f4dd 594 || $self->{transaction_depth};
595
1b994857 596 local $self->{_in_dbh_do} = 1;
597
f11383c2 598 my @result;
599 my $want_array = wantarray;
600
601 eval {
6ad1059d 602 $self->_verify_pid if $dbh;
37976db0 603 if(!$self->_dbh) {
6ad1059d 604 $self->_populate_dbh;
605 $dbh = $self->_dbh;
606 }
607
f11383c2 608 if($want_array) {
6ad1059d 609 @result = $self->$code($dbh, @_);
f11383c2 610 }
56769f7c 611 elsif(defined $want_array) {
6ad1059d 612 $result[0] = $self->$code($dbh, @_);
f11383c2 613 }
56769f7c 614 else {
6ad1059d 615 $self->$code($dbh, @_);
56769f7c 616 }
f11383c2 617 };
56769f7c 618
aa27edf7 619 my $exception = $@;
620 if(!$exception) { return $want_array ? @result : $result[0] }
621
622 $self->throw_exception($exception) if $self->connected;
623
624 # We were not connected - reconnect and retry, but let any
625 # exception fall right through this time
626 $self->_populate_dbh;
3ff1602f 627 $self->$code($self->_dbh, @_);
aa27edf7 628}
629
630# This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
631# It also informs dbh_do to bypass itself while under the direction of txn_do,
1b994857 632# via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
aa27edf7 633sub txn_do {
634 my $self = shift;
635 my $coderef = shift;
636
637 ref $coderef eq 'CODE' or $self->throw_exception
638 ('$coderef must be a CODE reference');
639
d6feb60f 640 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
57c18b65 641
1b994857 642 local $self->{_in_dbh_do} = 1;
f11383c2 643
aa27edf7 644 my @result;
645 my $want_array = wantarray;
646
d4f16b21 647 my $tried = 0;
648 while(1) {
649 eval {
650 $self->_verify_pid if $self->_dbh;
651 $self->_populate_dbh if !$self->_dbh;
aa27edf7 652
d4f16b21 653 $self->txn_begin;
654 if($want_array) {
655 @result = $coderef->(@_);
656 }
657 elsif(defined $want_array) {
658 $result[0] = $coderef->(@_);
659 }
660 else {
661 $coderef->(@_);
662 }
663 $self->txn_commit;
664 };
aa27edf7 665
d4f16b21 666 my $exception = $@;
667 if(!$exception) { return $want_array ? @result : $result[0] }
668
669 if($tried++ > 0 || $self->connected) {
670 eval { $self->txn_rollback };
671 my $rollback_exception = $@;
672 if($rollback_exception) {
673 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
674 $self->throw_exception($exception) # propagate nested rollback
675 if $rollback_exception =~ /$exception_class/;
676
677 $self->throw_exception(
678 "Transaction aborted: ${exception}. "
679 . "Rollback failed: ${rollback_exception}"
680 );
681 }
682 $self->throw_exception($exception)
aa27edf7 683 }
56769f7c 684
d4f16b21 685 # We were not connected, and was first try - reconnect and retry
686 # via the while loop
687 $self->_populate_dbh;
688 }
f11383c2 689}
690
9b83fccd 691=head2 disconnect
692
046ad905 693Our C<disconnect> method also performs a rollback first if the
9b83fccd 694database is not in C<AutoCommit> mode.
695
696=cut
697
412db1f4 698sub disconnect {
699 my ($self) = @_;
700
92925617 701 if( $self->connected ) {
6d2e7a96 702 my $connection_do = $self->on_disconnect_do;
703 $self->_do_connection_actions($connection_do) if ref($connection_do);
704
57c18b65 705 $self->_dbh->rollback unless $self->_dbh_autocommit;
92925617 706 $self->_dbh->disconnect;
707 $self->_dbh(undef);
dbaee748 708 $self->{_dbh_gen}++;
92925617 709 }
412db1f4 710}
711
f11383c2 712sub connected {
713 my ($self) = @_;
412db1f4 714
1346e22d 715 if(my $dbh = $self->_dbh) {
716 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
dbaee748 717 $self->_dbh(undef);
718 $self->{_dbh_gen}++;
719 return;
1346e22d 720 }
56769f7c 721 else {
722 $self->_verify_pid;
649bfb8c 723 return 0 if !$self->_dbh;
56769f7c 724 }
1346e22d 725 return ($dbh->FETCH('Active') && $dbh->ping);
726 }
727
728 return 0;
412db1f4 729}
730
f11383c2 731# handle pid changes correctly
56769f7c 732# NOTE: assumes $self->_dbh is a valid $dbh
f11383c2 733sub _verify_pid {
734 my ($self) = @_;
735
6ae3f9b9 736 return if defined $self->_conn_pid && $self->_conn_pid == $$;
f11383c2 737
f11383c2 738 $self->_dbh->{InactiveDestroy} = 1;
d3abf3fe 739 $self->_dbh(undef);
dbaee748 740 $self->{_dbh_gen}++;
f11383c2 741
742 return;
743}
744
412db1f4 745sub ensure_connected {
746 my ($self) = @_;
747
748 unless ($self->connected) {
8b445e33 749 $self->_populate_dbh;
750 }
412db1f4 751}
752
c235bbae 753=head2 dbh
754
755Returns the dbh - a data base handle of class L<DBI>.
756
757=cut
758
412db1f4 759sub dbh {
760 my ($self) = @_;
761
762 $self->ensure_connected;
8b445e33 763 return $self->_dbh;
764}
765
f1f56aad 766sub _sql_maker_args {
767 my ($self) = @_;
768
6e399b4f 769 return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
f1f56aad 770}
771
48c69e7c 772sub sql_maker {
773 my ($self) = @_;
fdc1c3d0 774 unless ($self->_sql_maker) {
95ba7ee4 775 my $sql_maker_class = $self->sql_maker_class;
776 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
48c69e7c 777 }
778 return $self->_sql_maker;
779}
780
3ff1602f 781sub _rebless {}
782
8b445e33 783sub _populate_dbh {
784 my ($self) = @_;
7e47ea83 785 my @info = @{$self->_dbi_connect_info || []};
8b445e33 786 $self->_dbh($self->_connect(@info));
2fd24e78 787
77d76d0f 788 # Always set the transaction depth on connect, since
789 # there is no transaction in progress by definition
57c18b65 790 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
77d76d0f 791
2fd24e78 792 if(ref $self eq 'DBIx::Class::Storage::DBI') {
793 my $driver = $self->_dbh->{Driver}->{Name};
efe6365b 794 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
2fd24e78 795 bless $self, "DBIx::Class::Storage::DBI::${driver}";
3ff1602f 796 $self->_rebless();
2fd24e78 797 }
843f8ecd 798 }
2fd24e78 799
6d2e7a96 800 my $connection_do = $self->on_connect_do;
801 $self->_do_connection_actions($connection_do) if ref($connection_do);
5ef3e508 802
1346e22d 803 $self->_conn_pid($$);
804 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
8b445e33 805}
806
6d2e7a96 807sub _do_connection_actions {
808 my $self = shift;
809 my $connection_do = shift;
810
811 if (ref $connection_do eq 'ARRAY') {
812 $self->_do_query($_) foreach @$connection_do;
813 }
814 elsif (ref $connection_do eq 'CODE') {
815 $connection_do->();
816 }
817
818 return $self;
819}
820
579ca3f7 821sub _do_query {
822 my ($self, $action) = @_;
823
6d2e7a96 824 if (ref $action eq 'CODE') {
1dafdb2a 825 $action = $action->($self);
826 $self->_do_query($_) foreach @$action;
579ca3f7 827 }
828 else {
1bd1640b 829 my @to_run = (ref $action eq 'ARRAY') ? (@$action) : ($action);
830 $self->_query_start(@to_run);
831 $self->_dbh->do(@to_run);
832 $self->_query_end(@to_run);
579ca3f7 833 }
834
835 return $self;
836}
837
8b445e33 838sub _connect {
839 my ($self, @info) = @_;
5ef3e508 840
9d31f7dc 841 $self->throw_exception("You failed to provide any connection info")
61646ebd 842 if !@info;
9d31f7dc 843
90ec6cad 844 my ($old_connect_via, $dbh);
845
5ef3e508 846 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
61646ebd 847 $old_connect_via = $DBI::connect_via;
848 $DBI::connect_via = 'connect';
5ef3e508 849 }
850
75db246c 851 eval {
f5de3933 852 if(ref $info[0] eq 'CODE') {
853 $dbh = &{$info[0]}
854 }
855 else {
856 $dbh = DBI->connect(@info);
61646ebd 857 }
858
e7827df0 859 if($dbh && !$self->unsafe) {
664612fb 860 my $weak_self = $self;
861 weaken($weak_self);
61646ebd 862 $dbh->{HandleError} = sub {
664612fb 863 $weak_self->throw_exception("DBI Exception: $_[0]")
61646ebd 864 };
2ab60eb9 865 $dbh->{ShowErrorStatement} = 1;
61646ebd 866 $dbh->{RaiseError} = 1;
867 $dbh->{PrintError} = 0;
f5de3933 868 }
75db246c 869 };
90ec6cad 870
871 $DBI::connect_via = $old_connect_via if $old_connect_via;
872
d92a4015 873 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
874 if !$dbh || $@;
90ec6cad 875
57c18b65 876 $self->_dbh_autocommit($dbh->{AutoCommit});
877
e571e823 878 $dbh;
8b445e33 879}
880
adb3554a 881sub svp_begin {
882 my ($self, $name) = @_;
adb3554a 883
ddf66ced 884 $name = $self->_svp_generate_name
885 unless defined $name;
886
887 $self->throw_exception ("You can't use savepoints outside a transaction")
888 if $self->{transaction_depth} == 0;
889
890 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
891 unless $self->can('_svp_begin');
892
893 push @{ $self->{savepoints} }, $name;
adb3554a 894
adb3554a 895 $self->debugobj->svp_begin($name) if $self->debug;
ddf66ced 896
897 return $self->_svp_begin($name);
adb3554a 898}
899
900sub svp_release {
901 my ($self, $name) = @_;
902
ddf66ced 903 $self->throw_exception ("You can't use savepoints outside a transaction")
904 if $self->{transaction_depth} == 0;
adb3554a 905
ddf66ced 906 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
907 unless $self->can('_svp_release');
908
909 if (defined $name) {
910 $self->throw_exception ("Savepoint '$name' does not exist")
911 unless grep { $_ eq $name } @{ $self->{savepoints} };
912
913 # Dig through the stack until we find the one we are releasing. This keeps
914 # the stack up to date.
915 my $svp;
adb3554a 916
ddf66ced 917 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
918 } else {
919 $name = pop @{ $self->{savepoints} };
adb3554a 920 }
ddf66ced 921
adb3554a 922 $self->debugobj->svp_release($name) if $self->debug;
ddf66ced 923
924 return $self->_svp_release($name);
adb3554a 925}
926
927sub svp_rollback {
928 my ($self, $name) = @_;
929
ddf66ced 930 $self->throw_exception ("You can't use savepoints outside a transaction")
931 if $self->{transaction_depth} == 0;
adb3554a 932
ddf66ced 933 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
934 unless $self->can('_svp_rollback');
935
936 if (defined $name) {
937 # If they passed us a name, verify that it exists in the stack
938 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
939 $self->throw_exception("Savepoint '$name' does not exist!");
940 }
adb3554a 941
ddf66ced 942 # Dig through the stack until we find the one we are releasing. This keeps
943 # the stack up to date.
944 while(my $s = pop(@{ $self->{savepoints} })) {
945 last if($s eq $name);
946 }
947 # Add the savepoint back to the stack, as a rollback doesn't remove the
948 # named savepoint, only everything after it.
949 push(@{ $self->{savepoints} }, $name);
950 } else {
951 # We'll assume they want to rollback to the last savepoint
952 $name = $self->{savepoints}->[-1];
adb3554a 953 }
ddf66ced 954
adb3554a 955 $self->debugobj->svp_rollback($name) if $self->debug;
ddf66ced 956
957 return $self->_svp_rollback($name);
958}
959
960sub _svp_generate_name {
961 my ($self) = @_;
962
963 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
adb3554a 964}
d32d82f9 965
8091aa91 966sub txn_begin {
d79f59b9 967 my $self = shift;
291bf95f 968 $self->ensure_connected();
57c18b65 969 if($self->{transaction_depth} == 0) {
77d76d0f 970 $self->debugobj->txn_begin()
971 if $self->debug;
972 # this isn't ->_dbh-> because
973 # we should reconnect on begin_work
974 # for AutoCommit users
975 $self->dbh->begin_work;
d6feb60f 976 } elsif ($self->auto_savepoint) {
ddf66ced 977 $self->svp_begin;
986e4fca 978 }
57c18b65 979 $self->{transaction_depth}++;
8091aa91 980}
8b445e33 981
8091aa91 982sub txn_commit {
d79f59b9 983 my $self = shift;
77d76d0f 984 if ($self->{transaction_depth} == 1) {
985 my $dbh = $self->_dbh;
986 $self->debugobj->txn_commit()
987 if ($self->debug);
988 $dbh->commit;
989 $self->{transaction_depth} = 0
57c18b65 990 if $self->_dbh_autocommit;
77d76d0f 991 }
992 elsif($self->{transaction_depth} > 1) {
d6feb60f 993 $self->{transaction_depth}--;
ddf66ced 994 $self->svp_release
d6feb60f 995 if $self->auto_savepoint;
77d76d0f 996 }
d32d82f9 997}
998
77d76d0f 999sub txn_rollback {
1000 my $self = shift;
1001 my $dbh = $self->_dbh;
77d76d0f 1002 eval {
77d76d0f 1003 if ($self->{transaction_depth} == 1) {
d32d82f9 1004 $self->debugobj->txn_rollback()
1005 if ($self->debug);
77d76d0f 1006 $self->{transaction_depth} = 0
57c18b65 1007 if $self->_dbh_autocommit;
1008 $dbh->rollback;
d32d82f9 1009 }
77d76d0f 1010 elsif($self->{transaction_depth} > 1) {
1011 $self->{transaction_depth}--;
d6feb60f 1012 if ($self->auto_savepoint) {
ddf66ced 1013 $self->svp_rollback;
1014 $self->svp_release;
d6feb60f 1015 }
986e4fca 1016 }
f11383c2 1017 else {
d32d82f9 1018 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
986e4fca 1019 }
77d76d0f 1020 };
a62cf8d4 1021 if ($@) {
1022 my $error = $@;
1023 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1024 $error =~ /$exception_class/ and $self->throw_exception($error);
77d76d0f 1025 # ensure that a failed rollback resets the transaction depth
57c18b65 1026 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
77d76d0f 1027 $self->throw_exception($error);
8091aa91 1028 }
1029}
8b445e33 1030
b7151206 1031# This used to be the top-half of _execute. It was split out to make it
1032# easier to override in NoBindVars without duping the rest. It takes up
1033# all of _execute's args, and emits $sql, @bind.
1034sub _prep_for_execute {
d944c5ae 1035 my ($self, $op, $extra_bind, $ident, $args) = @_;
b7151206 1036
d944c5ae 1037 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
db4b5f11 1038 unshift(@bind,
1039 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1040 if $extra_bind;
b7151206 1041
d944c5ae 1042 return ($sql, \@bind);
b7151206 1043}
1044
e5d9ee92 1045sub _fix_bind_params {
1046 my ($self, @bind) = @_;
1047
1048 ### Turn @bind from something like this:
1049 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1050 ### to this:
1051 ### ( "'1'", "'1'", "'3'" )
1052 return
1053 map {
1054 if ( defined( $_ && $_->[1] ) ) {
1055 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1056 }
1057 else { q{'NULL'}; }
1058 } @bind;
1059}
1060
1061sub _query_start {
1062 my ( $self, $sql, @bind ) = @_;
1063
1064 if ( $self->debug ) {
1065 @bind = $self->_fix_bind_params(@bind);
1066 $self->debugobj->query_start( $sql, @bind );
1067 }
1068}
1069
1070sub _query_end {
1071 my ( $self, $sql, @bind ) = @_;
1072
1073 if ( $self->debug ) {
1074 @bind = $self->_fix_bind_params(@bind);
1075 $self->debugobj->query_end( $sql, @bind );
1076 }
1077}
1078
baa31d2f 1079sub _dbh_execute {
1080 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
7af8b477 1081
eda28767 1082 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
b7ce6568 1083 $ident = $ident->from();
1084 }
d944c5ae 1085
1086 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
d92a4015 1087
e5d9ee92 1088 $self->_query_start( $sql, @$bind );
95dad7e2 1089
61646ebd 1090 my $sth = $self->sth($sql,$op);
6e399b4f 1091
61646ebd 1092 my $placeholder_index = 1;
6e399b4f 1093
61646ebd 1094 foreach my $bound (@$bind) {
1095 my $attributes = {};
1096 my($column_name, @data) = @$bound;
6e399b4f 1097
61646ebd 1098 if ($bind_attributes) {
1099 $attributes = $bind_attributes->{$column_name}
1100 if defined $bind_attributes->{$column_name};
1101 }
6e399b4f 1102
61646ebd 1103 foreach my $data (@data) {
1104 $data = ref $data ? ''.$data : $data; # stringify args
0b5dee17 1105
61646ebd 1106 $sth->bind_param($placeholder_index, $data, $attributes);
1107 $placeholder_index++;
95dad7e2 1108 }
61646ebd 1109 }
d92a4015 1110
61646ebd 1111 # Can this fail without throwing an exception anyways???
1112 my $rv = $sth->execute();
1113 $self->throw_exception($sth->errstr) if !$rv;
d92a4015 1114
e5d9ee92 1115 $self->_query_end( $sql, @$bind );
baa31d2f 1116
d944c5ae 1117 return (wantarray ? ($rv, $sth, @$bind) : $rv);
223b8fe3 1118}
1119
baa31d2f 1120sub _execute {
1121 my $self = shift;
3ff1602f 1122 $self->dbh_do('_dbh_execute', @_)
baa31d2f 1123}
1124
8b445e33 1125sub insert {
7af8b477 1126 my ($self, $source, $to_insert) = @_;
1127
1128 my $ident = $source->from;
8b646589 1129 my $bind_attributes = $self->source_bind_attributes($source);
1130
a982c051 1131 foreach my $col ( $source->columns ) {
1132 if ( !defined $to_insert->{$col} ) {
1133 my $col_info = $source->column_info($col);
1134
1135 if ( $col_info->{auto_nextval} ) {
6088eb64 1136 $self->ensure_connected;
a982c051 1137 $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1138 }
1139 }
1140 }
1141
61646ebd 1142 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
8e08ecc4 1143
8b445e33 1144 return $to_insert;
1145}
1146
744076d8 1147## Still not quite perfect, and EXPERIMENTAL
1148## Currently it is assumed that all values passed will be "normal", i.e. not
1149## scalar refs, or at least, all the same type as the first set, the statement is
1150## only prepped once.
54e0bd06 1151sub insert_bulk {
9fdf90df 1152 my ($self, $source, $cols, $data) = @_;
744076d8 1153 my %colvalues;
9fdf90df 1154 my $table = $source->from;
744076d8 1155 @colvalues{@$cols} = (0..$#$cols);
1156 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
7af8b477 1157
e5d9ee92 1158 $self->_query_start( $sql, @bind );
894328b8 1159 my $sth = $self->sth($sql);
54e0bd06 1160
54e0bd06 1161# @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1162
744076d8 1163 ## This must be an arrayref, else nothing works!
9fdf90df 1164
744076d8 1165 my $tuple_status = [];
9fdf90df 1166
1167 ##use Data::Dumper;
1168 ##print STDERR Dumper( $data, $sql, [@bind] );
eda28767 1169
61646ebd 1170 my $time = time();
8b646589 1171
61646ebd 1172 ## Get the bind_attributes, if any exist
1173 my $bind_attributes = $self->source_bind_attributes($source);
9fdf90df 1174
61646ebd 1175 ## Bind the values and execute
1176 my $placeholder_index = 1;
9fdf90df 1177
61646ebd 1178 foreach my $bound (@bind) {
9fdf90df 1179
61646ebd 1180 my $attributes = {};
1181 my ($column_name, $data_index) = @$bound;
eda28767 1182
61646ebd 1183 if( $bind_attributes ) {
1184 $attributes = $bind_attributes->{$column_name}
1185 if defined $bind_attributes->{$column_name};
1186 }
9fdf90df 1187
61646ebd 1188 my @data = map { $_->[$data_index] } @$data;
9fdf90df 1189
61646ebd 1190 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1191 $placeholder_index++;
54e0bd06 1192 }
61646ebd 1193 my $rv = $sth->execute_array({ArrayTupleStatus => $tuple_status});
1194 $self->throw_exception($sth->errstr) if !$rv;
1195
e5d9ee92 1196 $self->_query_end( $sql, @bind );
54e0bd06 1197 return (wantarray ? ($rv, $sth, @bind) : $rv);
1198}
1199
8b445e33 1200sub update {
7af8b477 1201 my $self = shift @_;
1202 my $source = shift @_;
8b646589 1203 my $bind_attributes = $self->source_bind_attributes($source);
8b646589 1204
b7ce6568 1205 return $self->_execute('update' => [], $source, $bind_attributes, @_);
8b445e33 1206}
1207
7af8b477 1208
8b445e33 1209sub delete {
7af8b477 1210 my $self = shift @_;
1211 my $source = shift @_;
1212
1213 my $bind_attrs = {}; ## If ever it's needed...
7af8b477 1214
b7ce6568 1215 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
8b445e33 1216}
1217
de705b51 1218sub _select {
8b445e33 1219 my ($self, $ident, $select, $condition, $attrs) = @_;
223b8fe3 1220 my $order = $attrs->{order_by};
95ba7ee4 1221
223b8fe3 1222 if (ref $condition eq 'SCALAR') {
1223 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1224 }
95ba7ee4 1225
1226 my $for = delete $attrs->{for};
1227 my $sql_maker = $self->sql_maker;
1228 local $sql_maker->{for} = $for;
1229
8839560b 1230 if (exists $attrs->{group_by} || $attrs->{having}) {
bc0c9800 1231 $order = {
1232 group_by => $attrs->{group_by},
1233 having => $attrs->{having},
1234 ($order ? (order_by => $order) : ())
1235 };
54540863 1236 }
7af8b477 1237 my $bind_attrs = {}; ## Future support
1238 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
9229f20a 1239 if ($attrs->{software_limit} ||
1240 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1241 $attrs->{software_limit} = 1;
5c91499f 1242 } else {
0823196c 1243 $self->throw_exception("rows attribute must be positive if present")
1244 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
e60dc79f 1245
1246 # MySQL actually recommends this approach. I cringe.
1247 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
5c91499f 1248 push @args, $attrs->{rows}, $attrs->{offset};
1249 }
95ba7ee4 1250
de705b51 1251 return $self->_execute(@args);
1252}
1253
8b646589 1254sub source_bind_attributes {
1255 my ($self, $source) = @_;
1256
1257 my $bind_attributes;
1258 foreach my $column ($source->columns) {
1259
1260 my $data_type = $source->column_info($column)->{data_type} || '';
1261 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
eda28767 1262 if $data_type;
8b646589 1263 }
1264
1265 return $bind_attributes;
1266}
1267
9b83fccd 1268=head2 select
1269
d3b0e369 1270=over 4
1271
1272=item Arguments: $ident, $select, $condition, $attrs
1273
1274=back
1275
9b83fccd 1276Handle a SQL select statement.
1277
1278=cut
1279
de705b51 1280sub select {
1281 my $self = shift;
1282 my ($ident, $select, $condition, $attrs) = @_;
e4eb8ee1 1283 return $self->cursor_class->new($self, \@_, $attrs);
8b445e33 1284}
1285
1a14aa3f 1286sub select_single {
de705b51 1287 my $self = shift;
1288 my ($rv, $sth, @bind) = $self->_select(@_);
6157db4f 1289 my @row = $sth->fetchrow_array;
1a4e8d7c 1290 if(@row && $sth->fetchrow_array) {
1291 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1292 }
a3eaff0e 1293 # Need to call finish() to work round broken DBDs
6157db4f 1294 $sth->finish();
1295 return @row;
1a14aa3f 1296}
1297
9b83fccd 1298=head2 sth
1299
d3b0e369 1300=over 4
1301
1302=item Arguments: $sql
1303
1304=back
1305
9b83fccd 1306Returns a L<DBI> sth (statement handle) for the supplied SQL.
1307
1308=cut
1309
d4f16b21 1310sub _dbh_sth {
1311 my ($self, $dbh, $sql) = @_;
b33697ef 1312
d32d82f9 1313 # 3 is the if_active parameter which avoids active sth re-use
b33697ef 1314 my $sth = $self->disable_sth_caching
1315 ? $dbh->prepare($sql)
1316 : $dbh->prepare_cached($sql, {}, 3);
1317
d92a4015 1318 # XXX You would think RaiseError would make this impossible,
1319 # but apparently that's not true :(
61646ebd 1320 $self->throw_exception($dbh->errstr) if !$sth;
b33697ef 1321
1322 $sth;
d32d82f9 1323}
1324
8b445e33 1325sub sth {
cb5f2eea 1326 my ($self, $sql) = @_;
3ff1602f 1327 $self->dbh_do('_dbh_sth', $sql);
8b445e33 1328}
1329
d4f16b21 1330sub _dbh_columns_info_for {
1331 my ($self, $dbh, $table) = @_;
a32e8402 1332
d32d82f9 1333 if ($dbh->can('column_info')) {
a953d8d9 1334 my %result;
d32d82f9 1335 eval {
1336 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1337 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1338 $sth->execute();
1339 while ( my $info = $sth->fetchrow_hashref() ){
1340 my %column_info;
1341 $column_info{data_type} = $info->{TYPE_NAME};
1342 $column_info{size} = $info->{COLUMN_SIZE};
1343 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1344 $column_info{default_value} = $info->{COLUMN_DEF};
1345 my $col_name = $info->{COLUMN_NAME};
1346 $col_name =~ s/^\"(.*)\"$/$1/;
1347
1348 $result{$col_name} = \%column_info;
0d67fe74 1349 }
d32d82f9 1350 };
093fc7a6 1351 return \%result if !$@ && scalar keys %result;
d32d82f9 1352 }
0d67fe74 1353
d32d82f9 1354 my %result;
88262f96 1355 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
d32d82f9 1356 $sth->execute;
1357 my @columns = @{$sth->{NAME_lc}};
1358 for my $i ( 0 .. $#columns ){
1359 my %column_info;
248bf0d0 1360 $column_info{data_type} = $sth->{TYPE}->[$i];
d32d82f9 1361 $column_info{size} = $sth->{PRECISION}->[$i];
1362 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
0d67fe74 1363
d32d82f9 1364 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1365 $column_info{data_type} = $1;
1366 $column_info{size} = $2;
0d67fe74 1367 }
1368
d32d82f9 1369 $result{$columns[$i]} = \%column_info;
1370 }
248bf0d0 1371 $sth->finish;
1372
1373 foreach my $col (keys %result) {
1374 my $colinfo = $result{$col};
1375 my $type_num = $colinfo->{data_type};
1376 my $type_name;
1377 if(defined $type_num && $dbh->can('type_info')) {
1378 my $type_info = $dbh->type_info($type_num);
1379 $type_name = $type_info->{TYPE_NAME} if $type_info;
1380 $colinfo->{data_type} = $type_name if $type_name;
1381 }
1382 }
d32d82f9 1383
1384 return \%result;
1385}
1386
1387sub columns_info_for {
1388 my ($self, $table) = @_;
3ff1602f 1389 $self->dbh_do('_dbh_columns_info_for', $table);
a953d8d9 1390}
1391
9b83fccd 1392=head2 last_insert_id
1393
1394Return the row id of the last insert.
1395
1396=cut
1397
d4f16b21 1398sub _dbh_last_insert_id {
1399 my ($self, $dbh, $source, $col) = @_;
1400 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1401 $dbh->func('last_insert_rowid');
1402}
1403
843f8ecd 1404sub last_insert_id {
d4f16b21 1405 my $self = shift;
3ff1602f 1406 $self->dbh_do('_dbh_last_insert_id', @_);
843f8ecd 1407}
1408
9b83fccd 1409=head2 sqlt_type
1410
1411Returns the database driver name.
1412
1413=cut
1414
d4f16b21 1415sub sqlt_type { shift->dbh->{Driver}->{Name} }
1c339d71 1416
a71859b4 1417=head2 bind_attribute_by_data_type
1418
1419Given a datatype from column info, returns a database specific bind attribute for
1420$dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1421just handle it.
1422
1423Generally only needed for special case column types, like bytea in postgres.
1424
1425=cut
1426
1427sub bind_attribute_by_data_type {
1428 return;
1429}
1430
58ded37e 1431=head2 create_ddl_dir
9b83fccd 1432
1433=over 4
1434
348d7c84 1435=item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
9b83fccd 1436
1437=back
1438
d3b0e369 1439Creates a SQL file based on the Schema, for each of the specified
9b83fccd 1440database types, in the given directory.
1441
348d7c84 1442By default, C<\%sqlt_args> will have
1443
1444 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1445
1446merged with the hash passed in. To disable any of those features, pass in a
1447hashref like the following
1448
1449 { ignore_constraint_names => 0, # ... other options }
1450
9b83fccd 1451=cut
1452
e673f011 1453sub create_ddl_dir
1454{
c9d2e0a2 1455 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
e673f011 1456
1457 if(!$dir || !-d $dir)
1458 {
1459 warn "No directory given, using ./\n";
1460 $dir = "./";
1461 }
1462 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1463 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1464 $version ||= $schema->VERSION || '1.x';
d4d46d19 1465 $sqltargs = {
1466 add_drop_table => 1,
1467 ignore_constraint_names => 1,
1468 ignore_index_names => 1,
1469 %{$sqltargs || {}}
1470 };
e673f011 1471
b6d9f089 1472 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09: '}
40dce2a5 1473 . $self->_check_sqlt_message . q{'})
1474 if !$self->_check_sqlt_version;
e673f011 1475
45f1a484 1476 my $sqlt = SQL::Translator->new( $sqltargs );
b7e303a8 1477
1478 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1479 my $sqlt_schema = $sqlt->translate({ data => $schema }) or die $sqlt->error;
1480
e673f011 1481 foreach my $db (@$databases)
1482 {
1483 $sqlt->reset();
c9d2e0a2 1484 $sqlt = $self->configure_sqlt($sqlt, $db);
b7e303a8 1485 $sqlt->{schema} = $sqlt_schema;
e673f011 1486 $sqlt->producer($db);
1487
1488 my $file;
1489 my $filename = $schema->ddl_filename($db, $dir, $version);
1490 if(-e $filename)
1491 {
c9d2e0a2 1492 warn("$filename already exists, skipping $db");
b98d9e8a 1493 next unless ($preversion);
1494 } else {
1495 my $output = $sqlt->translate;
1496 if(!$output)
1497 {
1498 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
c9d2e0a2 1499 next;
b98d9e8a 1500 }
1501 if(!open($file, ">$filename"))
1502 {
1503 $self->throw_exception("Can't open $filename for writing ($!)");
1504 next;
1505 }
1506 print $file $output;
1507 close($file);
1508 }
c9d2e0a2 1509 if($preversion)
1510 {
40dce2a5 1511 require SQL::Translator::Diff;
c9d2e0a2 1512
1513 my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
e2c0df8e 1514# print "Previous version $prefilename\n";
c9d2e0a2 1515 if(!-e $prefilename)
1516 {
1517 warn("No previous schema file found ($prefilename)");
1518 next;
1519 }
c9d2e0a2 1520
2dc2cd0f 1521 my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1522 print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1523 if(-e $difffile)
1524 {
1525 warn("$difffile already exists, skipping");
1526 next;
1527 }
1528
b7e303a8 1529 my $source_schema;
1530 {
45f1a484 1531 my $t = SQL::Translator->new($sqltargs);
c9d2e0a2 1532 $t->debug( 0 );
1533 $t->trace( 0 );
b7e303a8 1534 $t->parser( $db ) or die $t->error;
45f1a484 1535 $t = $self->configure_sqlt($t, $db);
b7e303a8 1536 my $out = $t->translate( $prefilename ) or die $t->error;
1537 $source_schema = $t->schema;
1538 unless ( $source_schema->name ) {
1539 $source_schema->name( $prefilename );
c9d2e0a2 1540 }
b7e303a8 1541 }
c9d2e0a2 1542
2dc2cd0f 1543 # The "new" style of producers have sane normalization and can support
1544 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1545 # And we have to diff parsed SQL against parsed SQL.
1546 my $dest_schema = $sqlt_schema;
1547
3ce95357 1548 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
45f1a484 1549 my $t = SQL::Translator->new($sqltargs);
2dc2cd0f 1550 $t->debug( 0 );
1551 $t->trace( 0 );
1552 $t->parser( $db ) or die $t->error;
45f1a484 1553 $t = $self->configure_sqlt($t, $db);
2dc2cd0f 1554 my $out = $t->translate( $filename ) or die $t->error;
1555 $dest_schema = $t->schema;
1556 $dest_schema->name( $filename )
1557 unless $dest_schema->name;
1558 }
c9d2e0a2 1559
1560 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2dc2cd0f 1561 $dest_schema, $db,
45f1a484 1562 $sqltargs
c9d2e0a2 1563 );
c9d2e0a2 1564 if(!open $file, ">$difffile")
1565 {
1566 $self->throw_exception("Can't write to $difffile ($!)");
1567 next;
1568 }
1569 print $file $diff;
1570 close($file);
1571 }
e673f011 1572 }
c9d2e0a2 1573}
e673f011 1574
c9d2e0a2 1575sub configure_sqlt() {
1576 my $self = shift;
1577 my $tr = shift;
1578 my $db = shift || $self->sqlt_type;
1579 if ($db eq 'PostgreSQL') {
1580 $tr->quote_table_names(0);
1581 $tr->quote_field_names(0);
1582 }
1583 return $tr;
e673f011 1584}
1585
9b83fccd 1586=head2 deployment_statements
1587
d3b0e369 1588=over 4
1589
1590=item Arguments: $schema, $type, $version, $directory, $sqlt_args
1591
1592=back
1593
1594Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1595The database driver name is given by C<$type>, though the value from
1596L</sqlt_type> is used if it is not specified.
1597
1598C<$directory> is used to return statements from files in a previously created
1599L</create_ddl_dir> directory and is optional. The filenames are constructed
1600from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1601
1602If no C<$directory> is specified then the statements are constructed on the
1603fly using L<SQL::Translator> and C<$version> is ignored.
1604
1605See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
9b83fccd 1606
1607=cut
1608
e673f011 1609sub deployment_statements {
1610 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
915919c5 1611 # Need to be connected to get the correct sqlt_type
c377d939 1612 $self->ensure_connected() unless $type;
e673f011 1613 $type ||= $self->sqlt_type;
1614 $version ||= $schema->VERSION || '1.x';
1615 $dir ||= './';
c9d2e0a2 1616 my $filename = $schema->ddl_filename($type, $dir, $version);
1617 if(-f $filename)
1618 {
1619 my $file;
1620 open($file, "<$filename")
1621 or $self->throw_exception("Can't open $filename ($!)");
1622 my @rows = <$file>;
1623 close($file);
1624 return join('', @rows);
1625 }
1626
b6d9f089 1627 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09: '}
40dce2a5 1628 . $self->_check_sqlt_message . q{'})
1629 if !$self->_check_sqlt_version;
1630
1631 require SQL::Translator::Parser::DBIx::Class;
1632 eval qq{use SQL::Translator::Producer::${type}};
1633 $self->throw_exception($@) if $@;
1634
1635 # sources needs to be a parser arg, but for simplicty allow at top level
1636 # coming in
1637 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1638 if exists $sqltargs->{sources};
1639
1640 my $tr = SQL::Translator->new(%$sqltargs);
1641 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1642 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
e673f011 1643
c9d2e0a2 1644 return;
e673f011 1645
1c339d71 1646}
843f8ecd 1647
1c339d71 1648sub deploy {
260129d8 1649 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1650 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
61bf0de5 1651 foreach my $line ( split(";\n", $statement)) {
1652 next if($line =~ /^--/);
1653 next if(!$line);
1654# next if($line =~ /^DROP/m);
1655 next if($line =~ /^BEGIN TRANSACTION/m);
1656 next if($line =~ /^COMMIT/m);
1657 next if $line =~ /^\s+$/; # skip whitespace only
e5d9ee92 1658 $self->_query_start($line);
61bf0de5 1659 eval {
1660 $self->dbh->do($line); # shouldn't be using ->dbh ?
1661 };
1662 if ($@) {
1663 warn qq{$@ (running "${line}")};
1664 }
e5d9ee92 1665 $self->_query_end($line);
e4fe9ba3 1666 }
75d07914 1667 }
1c339d71 1668}
843f8ecd 1669
9b83fccd 1670=head2 datetime_parser
1671
1672Returns the datetime parser class
1673
1674=cut
1675
f86fcf0d 1676sub datetime_parser {
1677 my $self = shift;
114780ee 1678 return $self->{datetime_parser} ||= do {
1679 $self->ensure_connected;
1680 $self->build_datetime_parser(@_);
1681 };
f86fcf0d 1682}
1683
9b83fccd 1684=head2 datetime_parser_type
1685
1686Defines (returns) the datetime parser class - currently hardwired to
1687L<DateTime::Format::MySQL>
1688
1689=cut
1690
f86fcf0d 1691sub datetime_parser_type { "DateTime::Format::MySQL"; }
1692
9b83fccd 1693=head2 build_datetime_parser
1694
1695See L</datetime_parser>
1696
1697=cut
1698
f86fcf0d 1699sub build_datetime_parser {
1700 my $self = shift;
1701 my $type = $self->datetime_parser_type(@_);
1702 eval "use ${type}";
1703 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1704 return $type;
1705}
1706
40dce2a5 1707{
1708 my $_check_sqlt_version; # private
1709 my $_check_sqlt_message; # private
1710 sub _check_sqlt_version {
1711 return $_check_sqlt_version if defined $_check_sqlt_version;
b6d9f089 1712 eval 'use SQL::Translator "0.09"';
b7e303a8 1713 $_check_sqlt_message = $@ || '';
1714 $_check_sqlt_version = !$@;
40dce2a5 1715 }
1716
1717 sub _check_sqlt_message {
1718 _check_sqlt_version if !defined $_check_sqlt_message;
1719 $_check_sqlt_message;
1720 }
1721}
1722
c756145c 1723sub DESTROY {
1724 my $self = shift;
f5de3933 1725 return if !$self->_dbh;
c756145c 1726 $self->_verify_pid;
1727 $self->_dbh(undef);
1728}
92925617 1729
8b445e33 17301;
1731
9b83fccd 1732=head1 SQL METHODS
1733
1734The module defines a set of methods within the DBIC::SQL::Abstract
1735namespace. These build on L<SQL::Abstract::Limit> to provide the
1736SQL query functions.
1737
1738The following methods are extended:-
1739
1740=over 4
1741
1742=item delete
1743
1744=item insert
1745
1746=item select
1747
1748=item update
1749
1750=item limit_dialect
1751
2cc3a7be 1752See L</connect_info> for details.
1753For setting, this method is deprecated in favor of L</connect_info>.
bb4f246d 1754
9b83fccd 1755=item quote_char
1756
2cc3a7be 1757See L</connect_info> for details.
1758For setting, this method is deprecated in favor of L</connect_info>.
bb4f246d 1759
9b83fccd 1760=item name_sep
1761
2cc3a7be 1762See L</connect_info> for details.
1763For setting, this method is deprecated in favor of L</connect_info>.
bb4f246d 1764
9b83fccd 1765=back
1766
8b445e33 1767=head1 AUTHORS
1768
daec44b8 1769Matt S. Trout <mst@shadowcatsystems.co.uk>
8b445e33 1770
9f19b1d6 1771Andy Grundman <andy@hybridized.org>
1772
8b445e33 1773=head1 LICENSE
1774
1775You may distribute this code under the same terms as Perl itself.
1776
1777=cut