1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
4 use base 'DBIx::Class::Storage';
9 use SQL::Abstract::Limit;
10 use DBIx::Class::Storage::DBI::Cursor;
11 use DBIx::Class::Storage::Statistics;
13 use Scalar::Util 'blessed';
15 __PACKAGE__->mk_group_accessors(
17 qw/_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid _conn_tid
18 disable_sth_caching cursor on_connect_do transaction_depth/
23 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
25 use base qw/SQL::Abstract::Limit/;
27 # This prevents the caching of $dbh in S::A::L, I believe
29 my $self = shift->SUPER::new(@_);
31 # If limit_dialect is a ref (like a $dbh), go ahead and replace
32 # it with what it resolves to:
33 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
34 if ref $self->{limit_dialect};
40 my ($self, $sql, $order, $rows, $offset ) = @_;
43 my $last = $rows + $offset;
44 my ( $order_by ) = $self->_order_by( $order );
49 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
54 WHERE ROW_NUM BETWEEN $offset AND $last
60 # While we're at it, this should make LIMIT queries more efficient,
61 # without digging into things too deeply
62 use Scalar::Util 'blessed';
64 my ($self, $syntax) = @_;
65 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
66 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
67 return 'RowNumberOver';
70 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
74 my ($self, $table, $fields, $where, $order, @rest) = @_;
75 $table = $self->_quote($table) unless ref($table);
76 local $self->{rownum_hack_count} = 1
77 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
78 @rest = (-1) unless defined $rest[0];
79 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
80 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
81 local $self->{having_bind} = [];
82 my ($sql, @ret) = $self->SUPER::select(
83 $table, $self->_recurse_fields($fields), $where, $order, @rest
85 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
91 $table = $self->_quote($table) unless ref($table);
92 $self->SUPER::insert($table, @_);
98 $table = $self->_quote($table) unless ref($table);
99 $self->SUPER::update($table, @_);
105 $table = $self->_quote($table) unless ref($table);
106 $self->SUPER::delete($table, @_);
112 return $_[1].$self->_order_by($_[2]);
114 return $self->SUPER::_emulate_limit(@_);
118 sub _recurse_fields {
119 my ($self, $fields) = @_;
120 my $ref = ref $fields;
121 return $self->_quote($fields) unless $ref;
122 return $$fields if $ref eq 'SCALAR';
124 if ($ref eq 'ARRAY') {
125 return join(', ', map {
126 $self->_recurse_fields($_)
127 .(exists $self->{rownum_hack_count}
128 ? ' AS col'.$self->{rownum_hack_count}++
131 } elsif ($ref eq 'HASH') {
132 foreach my $func (keys %$fields) {
133 return $self->_sqlcase($func)
134 .'( '.$self->_recurse_fields($fields->{$func}).' )';
143 if (ref $_[0] eq 'HASH') {
144 if (defined $_[0]->{group_by}) {
145 $ret = $self->_sqlcase(' group by ')
146 .$self->_recurse_fields($_[0]->{group_by});
148 if (defined $_[0]->{having}) {
150 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
151 push(@{$self->{having_bind}}, @extra);
152 $ret .= $self->_sqlcase(' having ').$frag;
154 if (defined $_[0]->{order_by}) {
155 $ret .= $self->_order_by($_[0]->{order_by});
157 } elsif (ref $_[0] eq 'SCALAR') {
158 $ret = $self->_sqlcase(' order by ').${ $_[0] };
159 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
160 my @order = @{+shift};
161 $ret = $self->_sqlcase(' order by ')
163 my $r = $self->_order_by($_, @_);
164 $r =~ s/^ ?ORDER BY //i;
168 $ret = $self->SUPER::_order_by(@_);
173 sub _order_directions {
174 my ($self, $order) = @_;
175 $order = $order->{order_by} if ref $order eq 'HASH';
176 return $self->SUPER::_order_directions($order);
180 my ($self, $from) = @_;
181 if (ref $from eq 'ARRAY') {
182 return $self->_recurse_from(@$from);
183 } elsif (ref $from eq 'HASH') {
184 return $self->_make_as($from);
186 return $from; # would love to quote here but _table ends up getting called
187 # twice during an ->select without a limit clause due to
188 # the way S::A::Limit->select works. should maybe consider
189 # bypassing this and doing S::A::select($self, ...) in
190 # our select method above. meantime, quoting shims have
191 # been added to select/insert/update/delete here
196 my ($self, $from, @join) = @_;
198 push(@sqlf, $self->_make_as($from));
199 foreach my $j (@join) {
202 # check whether a join type exists
203 my $join_clause = '';
204 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
205 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
206 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
208 $join_clause = ' JOIN ';
210 push(@sqlf, $join_clause);
212 if (ref $to eq 'ARRAY') {
213 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
215 push(@sqlf, $self->_make_as($to));
217 push(@sqlf, ' ON ', $self->_join_condition($on));
219 return join('', @sqlf);
223 my ($self, $from) = @_;
224 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
225 reverse each %{$self->_skip_options($from)});
229 my ($self, $hash) = @_;
231 $clean_hash->{$_} = $hash->{$_}
232 for grep {!/^-/} keys %$hash;
236 sub _join_condition {
237 my ($self, $cond) = @_;
238 if (ref $cond eq 'HASH') {
243 # XXX no throw_exception() in this package and croak() fails with strange results
244 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
245 if ref($v) ne 'SCALAR';
249 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
252 return scalar($self->_recurse_where(\%j));
253 } elsif (ref $cond eq 'ARRAY') {
254 return join(' OR ', map { $self->_join_condition($_) } @$cond);
256 die "Can't handle this yet!";
261 my ($self, $label) = @_;
262 return '' unless defined $label;
263 return "*" if $label eq '*';
264 return $label unless $self->{quote_char};
265 if(ref $self->{quote_char} eq "ARRAY"){
266 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
267 if !defined $self->{name_sep};
268 my $sep = $self->{name_sep};
269 return join($self->{name_sep},
270 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
271 split(/\Q$sep\E/,$label));
273 return $self->SUPER::_quote($label);
278 $self->{limit_dialect} = shift if @_;
279 return $self->{limit_dialect};
284 $self->{quote_char} = shift if @_;
285 return $self->{quote_char};
290 $self->{name_sep} = shift if @_;
291 return $self->{name_sep};
294 } # End of BEGIN block
298 DBIx::Class::Storage::DBI - DBI storage handler
304 This class represents the connection to an RDBMS via L<DBI>. See
305 L<DBIx::Class::Storage> for general information. This pod only
306 documents DBI-specific methods and behaviors.
313 my $new = shift->next::method(@_);
315 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
316 $new->transaction_depth(0);
317 $new->_sql_maker_opts({});
318 $new->{_in_dbh_do} = 0;
319 $new->{_dbh_gen} = 0;
326 The arguments of C<connect_info> are always a single array reference.
328 This is normally accessed via L<DBIx::Class::Schema/connection>, which
329 encapsulates its argument list in an arrayref before calling
330 C<connect_info> here.
332 The arrayref can either contain the same set of arguments one would
333 normally pass to L<DBI/connect>, or a lone code reference which returns
334 a connected database handle. Please note that the L<DBI> docs
335 recommend that you always explicitly set C<AutoCommit> to either
336 C<0> or C<1>. L<DBIx::Class> further recommends that it be set
337 to C<1>, and that you perform transactions via our L</txn_do>
338 method. L<DBIx::Class> will set it to C<1> if you do not do explicitly
339 set it to zero. This is the default for most DBDs. See below for more
342 In either case, if the final argument in your connect_info happens
343 to be a hashref, C<connect_info> will look there for several
344 connection-specific options:
350 This can be set to an arrayref of literal sql statements, which will
351 be executed immediately after making the connection to the database
352 every time we [re-]connect.
354 =item disable_sth_caching
356 If set to a true value, this option will disable the caching of
357 statement handles via L<DBI/prepare_cached>.
361 Sets the limit dialect. This is useful for JDBC-bridge among others
362 where the remote SQL-dialect cannot be determined by the name of the
367 Specifies what characters to use to quote table and column names. If
368 you use this you will want to specify L<name_sep> as well.
370 quote_char expects either a single character, in which case is it is placed
371 on either side of the table/column, or an arrayref of length 2 in which case the
372 table/column name is placed between the elements.
374 For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd
375 use C<quote_char =E<gt> [qw/[ ]/]>.
379 This only needs to be used in conjunction with L<quote_char>, and is used to
380 specify the charecter that seperates elements (schemas, tables, columns) from
381 each other. In most cases this is simply a C<.>.
385 These options can be mixed in with your other L<DBI> connection attributes,
386 or placed in a seperate hashref after all other normal L<DBI> connection
389 Every time C<connect_info> is invoked, any previous settings for
390 these options will be cleared before setting the new ones, regardless of
391 whether any options are specified in the new C<connect_info>.
393 Important note: DBIC expects the returned database handle provided by
394 a subref argument to have RaiseError set on it. If it doesn't, things
395 might not work very well, YMMV. If you don't use a subref, DBIC will
396 force this setting for you anyways. Setting HandleError to anything
397 other than simple exception object wrapper might cause problems too.
399 Another Important Note:
401 DBIC can do some wonderful magic with handling exceptions,
402 disconnections, and transactions when you use C<AutoCommit => 1>
403 combined with C<txn_do> for transaction support.
405 If you set C<AutoCommit => 0> in your connect info, then you are always
406 in an assumed transaction between commits, and you're telling us you'd
407 like to manage that manually. A lot of DBIC's magic protections
408 go away. We can't protect you from exceptions due to database
409 disconnects because we don't know anything about how to restart your
410 transactions. You're on your own for handling all sorts of exceptional
411 cases if you choose the C<AutoCommit => 0> path, just as you would
416 # Simple SQLite connection
417 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
420 ->connect_info([ sub { DBI->connect(...) } ]);
422 # A bit more complicated
429 { quote_char => q{"}, name_sep => q{.} },
433 # Equivalent to the previous example
439 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
443 # Subref + DBIC-specific connection options
446 sub { DBI->connect(...) },
450 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
451 disable_sth_caching => 1,
459 my ($self, $info_arg) = @_;
461 return $self->_connect_info if !$info_arg;
463 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
464 # the new set of options
465 $self->_sql_maker(undef);
466 $self->_sql_maker_opts({});
468 my $info = [ @$info_arg ]; # copy because we can alter it
469 my $last_info = $info->[-1];
470 if(ref $last_info eq 'HASH') {
471 for my $storage_opt (qw/on_connect_do disable_sth_caching/) {
472 if(my $value = delete $last_info->{$storage_opt}) {
473 $self->$storage_opt($value);
476 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
477 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
478 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
482 # Get rid of any trailing empty hashref
483 pop(@$info) if !keys %$last_info;
486 if(ref $info->[0] ne 'CODE') {
487 # Extend to 3 arguments with undefs, if necessary
488 while(scalar(@$info) < 3) { push(@$info, undef) }
490 # Complain if 4th argument is defined and is not a HASH
491 if(defined $info->[3] && ref $info->[3] ne 'HASH') {
492 warn "4th argument of DBI connect info is defined "
493 . " but is not a hashref!";
496 # Set AutoCommit to 1 if not specified manually
499 if(!defined $info->[3]->{AutoCommit}) {
500 $info->[3]->{AutoCommit} = 1;
505 $self->_connect_info($info);
510 This method is deprecated in favor of setting via L</connect_info>.
514 Arguments: $subref, @extra_coderef_args?
516 Execute the given subref using the new exception-based connection management.
518 The first two arguments will be the storage object that C<dbh_do> was called
519 on and a database handle to use. Any additional arguments will be passed
520 verbatim to the called subref as arguments 2 and onwards.
522 Using this (instead of $self->_dbh or $self->dbh) ensures correct
523 exception handling and reconnection (or failover in future subclasses).
525 Your subref should have no side-effects outside of the database, as
526 there is the potential for your subref to be partially double-executed
527 if the database connection was stale/dysfunctional.
531 my @stuff = $schema->storage->dbh_do(
533 my ($storage, $dbh, @cols) = @_;
534 my $cols = join(q{, }, @cols);
535 $dbh->selectrow_array("SELECT $cols FROM foo");
546 ref $coderef eq 'CODE' or $self->throw_exception
547 ('$coderef must be a CODE reference');
549 return $coderef->($self, $self->_dbh, @_) if $self->{_in_dbh_do}
550 || $self->{transaction_depth};
552 local $self->{_in_dbh_do} = 1;
555 my $want_array = wantarray;
558 $self->_verify_pid if $self->_dbh;
559 $self->_populate_dbh if !$self->_dbh;
561 @result = $coderef->($self, $self->_dbh, @_);
563 elsif(defined $want_array) {
564 $result[0] = $coderef->($self, $self->_dbh, @_);
567 $coderef->($self, $self->_dbh, @_);
572 if(!$exception) { return $want_array ? @result : $result[0] }
574 $self->throw_exception($exception) if $self->connected;
576 # We were not connected - reconnect and retry, but let any
577 # exception fall right through this time
578 $self->_populate_dbh;
579 $coderef->($self, $self->_dbh, @_);
582 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
583 # It also informs dbh_do to bypass itself while under the direction of txn_do,
584 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
589 ref $coderef eq 'CODE' or $self->throw_exception
590 ('$coderef must be a CODE reference');
592 local $self->{_in_dbh_do} = 1;
595 my $want_array = wantarray;
600 $self->_verify_pid if $self->_dbh;
601 $self->_populate_dbh if !$self->_dbh;
605 @result = $coderef->(@_);
607 elsif(defined $want_array) {
608 $result[0] = $coderef->(@_);
617 if(!$exception) { return $want_array ? @result : $result[0] }
619 if($tried++ > 0 || $self->connected) {
620 eval { $self->txn_rollback };
621 my $rollback_exception = $@;
622 if($rollback_exception) {
623 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
624 $self->throw_exception($exception) # propagate nested rollback
625 if $rollback_exception =~ /$exception_class/;
627 $self->throw_exception(
628 "Transaction aborted: ${exception}. "
629 . "Rollback failed: ${rollback_exception}"
632 $self->throw_exception($exception)
635 # We were not connected, and was first try - reconnect and retry
637 $self->_populate_dbh;
643 Our C<disconnect> method also performs a rollback first if the
644 database is not in C<AutoCommit> mode.
651 if( $self->connected ) {
652 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
653 $self->_dbh->disconnect;
662 if(my $dbh = $self->_dbh) {
663 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
671 return ($dbh->FETCH('Active') && $dbh->ping);
677 # handle pid changes correctly
678 # NOTE: assumes $self->_dbh is a valid $dbh
682 return if $self->_conn_pid == $$;
684 $self->_dbh->{InactiveDestroy} = 1;
691 sub ensure_connected {
694 unless ($self->connected) {
695 $self->_populate_dbh;
701 Returns the dbh - a data base handle of class L<DBI>.
708 $self->ensure_connected;
712 sub _sql_maker_args {
715 return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
720 unless ($self->_sql_maker) {
721 $self->_sql_maker(new DBIC::SQL::Abstract( $self->_sql_maker_args ));
723 return $self->_sql_maker;
728 my @info = @{$self->_connect_info || []};
729 $self->_dbh($self->_connect(@info));
731 # Always set the transaction depth on connect, since
732 # there is no transaction in progress by definition
733 $self->{transaction_depth} = $self->_dbh->{AutoCommit} ? 0 : 1;
735 if(ref $self eq 'DBIx::Class::Storage::DBI') {
736 my $driver = $self->_dbh->{Driver}->{Name};
737 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
738 bless $self, "DBIx::Class::Storage::DBI::${driver}";
739 $self->_rebless() if $self->can('_rebless');
743 # if on-connect sql statements are given execute them
744 foreach my $sql_statement (@{$self->on_connect_do || []}) {
745 $self->debugobj->query_start($sql_statement) if $self->debug();
746 $self->_dbh->do($sql_statement);
747 $self->debugobj->query_end($sql_statement) if $self->debug();
750 $self->_conn_pid($$);
751 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
755 my ($self, @info) = @_;
757 $self->throw_exception("You failed to provide any connection info")
760 my ($old_connect_via, $dbh);
762 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
763 $old_connect_via = $DBI::connect_via;
764 $DBI::connect_via = 'connect';
768 if(ref $info[0] eq 'CODE') {
772 $dbh = DBI->connect(@info);
773 $dbh->{RaiseError} = 1;
774 $dbh->{PrintError} = 0;
775 $dbh->{PrintWarn} = 0;
779 $DBI::connect_via = $old_connect_via if $old_connect_via;
782 $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
791 if($self->{transaction_depth}++ == 0) {
792 $self->debugobj->txn_begin()
794 # this isn't ->_dbh-> because
795 # we should reconnect on begin_work
796 # for AutoCommit users
797 $self->dbh->begin_work;
803 if ($self->{transaction_depth} == 1) {
804 my $dbh = $self->_dbh;
805 $self->debugobj->txn_commit()
808 $self->{transaction_depth} = 0
809 if $dbh->{AutoCommit};
811 elsif($self->{transaction_depth} > 1) {
812 $self->{transaction_depth}--
818 my $dbh = $self->_dbh;
821 $autocommit = $dbh->{AutoCommit};
822 if ($self->{transaction_depth} == 1) {
823 $self->debugobj->txn_rollback()
826 $self->{transaction_depth} = 0
829 elsif($self->{transaction_depth} > 1) {
830 $self->{transaction_depth}--;
833 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
838 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
839 $error =~ /$exception_class/ and $self->throw_exception($error);
840 # ensure that a failed rollback resets the transaction depth
841 $self->{transaction_depth} = $autocommit ? 0 : 1;
842 $self->throw_exception($error);
846 # This used to be the top-half of _execute. It was split out to make it
847 # easier to override in NoBindVars without duping the rest. It takes up
848 # all of _execute's args, and emits $sql, @bind.
849 sub _prep_for_execute {
850 my ($self, $op, $extra_bind, $ident, @args) = @_;
852 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
854 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
856 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
858 return ($sql, @bind);
862 my ($self, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
864 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
865 $ident = $ident->from();
868 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
870 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
874 map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind;
875 $self->debugobj->query_start($sql, @debug_bind);
880 $sth = eval { $self->sth($sql,$op) };
883 $self->throw_exception(
884 'no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql"
891 my $placeholder_index = 1;
893 foreach my $bound (@bind) {
896 my($column_name, @data) = @$bound;
898 if( $bind_attributes ) {
899 $attributes = $bind_attributes->{$column_name}
900 if defined $bind_attributes->{$column_name};
903 foreach my $data (@data)
905 $data = ref $data ? ''.$data : $data; # stringify args
907 $sth->bind_param($placeholder_index, $data, $attributes);
908 $placeholder_index++;
915 $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr))
917 $self->_populate_dbh;
922 $self->throw_exception("'$sql' did not generate a statement.");
924 } # While(1) to retry if disconencted
928 map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind;
929 $self->debugobj->query_end($sql, @debug_bind);
931 return (wantarray ? ($rv, $sth, @bind) : $rv);
935 my ($self, $source, $to_insert) = @_;
937 my $ident = $source->from;
938 my $bind_attributes = $self->source_bind_attributes($source);
940 $self->throw_exception(
941 "Couldn't insert ".join(', ',
942 map "$_ => $to_insert->{$_}", keys %$to_insert
944 ) unless ($self->_execute('insert' => [], $source, $bind_attributes, $to_insert));
948 ## Still not quite perfect, and EXPERIMENTAL
949 ## Currently it is assumed that all values passed will be "normal", i.e. not
950 ## scalar refs, or at least, all the same type as the first set, the statement is
951 ## only prepped once.
953 my ($self, $source, $cols, $data) = @_;
955 my $table = $source->from;
956 @colvalues{@$cols} = (0..$#$cols);
957 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
960 my @debug_bind = map { defined $_->[1] ? qq{$_->[1]} : q{'NULL'} } @bind;
961 $self->debugobj->query_start($sql, @debug_bind);
963 my $sth = $self->sth($sql);
965 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
969 ## This must be an arrayref, else nothing works!
971 my $tuple_status = [];
974 ##print STDERR Dumper( $data, $sql, [@bind] );
980 ## Get the bind_attributes, if any exist
981 my $bind_attributes = $self->source_bind_attributes($source);
983 ## Bind the values and execute
986 my $placeholder_index = 1;
988 foreach my $bound (@bind) {
991 my ($column_name, $data_index) = @$bound;
993 if( $bind_attributes ) {
994 $attributes = $bind_attributes->{$column_name}
995 if defined $bind_attributes->{$column_name};
998 my @data = map { $_->[$data_index] } @$data;
1000 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1001 $placeholder_index++;
1003 $sth->execute_array( {ArrayTupleStatus => $tuple_status} );
1007 if ($@ || !defined $rv) {
1009 foreach my $tuple (@$tuple_status) {
1010 $errors .= "\n" . $tuple->[1] if(ref $tuple);
1012 $self->throw_exception("Error executing '$sql': ".($@ || $errors));
1015 $self->throw_exception("'$sql' did not generate a statement.");
1018 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
1019 $self->debugobj->query_end($sql, @debug_bind);
1021 return (wantarray ? ($rv, $sth, @bind) : $rv);
1025 my $self = shift @_;
1026 my $source = shift @_;
1027 my $bind_attributes = $self->source_bind_attributes($source);
1029 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1034 my $self = shift @_;
1035 my $source = shift @_;
1037 my $bind_attrs = {}; ## If ever it's needed...
1039 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1043 my ($self, $ident, $select, $condition, $attrs) = @_;
1044 my $order = $attrs->{order_by};
1045 if (ref $condition eq 'SCALAR') {
1046 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1048 if (exists $attrs->{group_by} || $attrs->{having}) {
1050 group_by => $attrs->{group_by},
1051 having => $attrs->{having},
1052 ($order ? (order_by => $order) : ())
1055 my $bind_attrs = {}; ## Future support
1056 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1057 if ($attrs->{software_limit} ||
1058 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1059 $attrs->{software_limit} = 1;
1061 $self->throw_exception("rows attribute must be positive if present")
1062 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1063 push @args, $attrs->{rows}, $attrs->{offset};
1065 return $self->_execute(@args);
1068 sub source_bind_attributes {
1069 my ($self, $source) = @_;
1071 my $bind_attributes;
1072 foreach my $column ($source->columns) {
1074 my $data_type = $source->column_info($column)->{data_type} || '';
1075 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1079 return $bind_attributes;
1086 =item Arguments: $ident, $select, $condition, $attrs
1090 Handle a SQL select statement.
1096 my ($ident, $select, $condition, $attrs) = @_;
1097 return $self->cursor->new($self, \@_, $attrs);
1102 my ($rv, $sth, @bind) = $self->_select(@_);
1103 my @row = $sth->fetchrow_array;
1104 # Need to call finish() to work round broken DBDs
1113 =item Arguments: $sql
1117 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1122 my ($self, $dbh, $sql) = @_;
1124 # 3 is the if_active parameter which avoids active sth re-use
1125 my $sth = $self->disable_sth_caching
1126 ? $dbh->prepare($sql)
1127 : $dbh->prepare_cached($sql, {}, 3);
1129 $self->throw_exception(
1130 'no sth generated via sql (' . ($@ || $dbh->errstr) . "): $sql"
1137 my ($self, $sql) = @_;
1138 $self->dbh_do($self->can('_dbh_sth'), $sql);
1141 sub _dbh_columns_info_for {
1142 my ($self, $dbh, $table) = @_;
1144 if ($dbh->can('column_info')) {
1147 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1148 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1150 while ( my $info = $sth->fetchrow_hashref() ){
1152 $column_info{data_type} = $info->{TYPE_NAME};
1153 $column_info{size} = $info->{COLUMN_SIZE};
1154 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1155 $column_info{default_value} = $info->{COLUMN_DEF};
1156 my $col_name = $info->{COLUMN_NAME};
1157 $col_name =~ s/^\"(.*)\"$/$1/;
1159 $result{$col_name} = \%column_info;
1162 return \%result if !$@ && scalar keys %result;
1166 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1168 my @columns = @{$sth->{NAME_lc}};
1169 for my $i ( 0 .. $#columns ){
1171 $column_info{data_type} = $sth->{TYPE}->[$i];
1172 $column_info{size} = $sth->{PRECISION}->[$i];
1173 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1175 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1176 $column_info{data_type} = $1;
1177 $column_info{size} = $2;
1180 $result{$columns[$i]} = \%column_info;
1184 foreach my $col (keys %result) {
1185 my $colinfo = $result{$col};
1186 my $type_num = $colinfo->{data_type};
1188 if(defined $type_num && $dbh->can('type_info')) {
1189 my $type_info = $dbh->type_info($type_num);
1190 $type_name = $type_info->{TYPE_NAME} if $type_info;
1191 $colinfo->{data_type} = $type_name if $type_name;
1198 sub columns_info_for {
1199 my ($self, $table) = @_;
1200 $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
1203 =head2 last_insert_id
1205 Return the row id of the last insert.
1209 sub _dbh_last_insert_id {
1210 my ($self, $dbh, $source, $col) = @_;
1211 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1212 $dbh->func('last_insert_rowid');
1215 sub last_insert_id {
1217 $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
1222 Returns the database driver name.
1226 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1228 =head2 bind_attribute_by_data_type
1230 Given a datatype from column info, returns a database specific bind attribute for
1231 $dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1234 Generally only needed for special case column types, like bytea in postgres.
1238 sub bind_attribute_by_data_type {
1242 =head2 create_ddl_dir (EXPERIMENTAL)
1246 =item Arguments: $schema \@databases, $version, $directory, $preversion, $sqlt_args
1250 Creates a SQL file based on the Schema, for each of the specified
1251 database types, in the given directory.
1253 Note that this feature is currently EXPERIMENTAL and may not work correctly
1254 across all databases, or fully handle complex relationships.
1260 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1262 if(!$dir || !-d $dir)
1264 warn "No directory given, using ./\n";
1267 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1268 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1269 $version ||= $schema->VERSION || '1.x';
1270 $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
1272 eval "use SQL::Translator";
1273 $self->throw_exception("Can't create a ddl file without SQL::Translator: $@") if $@;
1275 my $sqlt = SQL::Translator->new({
1277 add_drop_table => 1,
1279 foreach my $db (@$databases)
1282 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1283 # $sqlt->parser_args({'DBIx::Class' => $schema);
1284 $sqlt = $self->configure_sqlt($sqlt, $db);
1285 $sqlt->data($schema);
1286 $sqlt->producer($db);
1289 my $filename = $schema->ddl_filename($db, $dir, $version);
1292 warn("$filename already exists, skipping $db");
1296 my $output = $sqlt->translate;
1299 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1302 if(!open($file, ">$filename"))
1304 $self->throw_exception("Can't open $filename for writing ($!)");
1307 print $file $output;
1312 eval "use SQL::Translator::Diff";
1315 warn("Can't diff versions without SQL::Translator::Diff: $@");
1319 my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
1320 # print "Previous version $prefilename\n";
1321 if(!-e $prefilename)
1323 warn("No previous schema file found ($prefilename)");
1326 #### We need to reparse the SQLite file we just wrote, so that
1327 ## Diff doesnt get all confoosed, and Diff is *very* confused.
1328 ## FIXME: rip Diff to pieces!
1329 # my $target_schema = $sqlt->schema;
1330 # unless ( $target_schema->name ) {
1331 # $target_schema->name( $filename );
1334 push @input, {file => $prefilename, parser => $db};
1335 push @input, {file => $filename, parser => $db};
1336 my ( $source_schema, $source_db, $target_schema, $target_db ) = map {
1337 my $file = $_->{'file'};
1338 my $parser = $_->{'parser'};
1340 my $t = SQL::Translator->new;
1343 $t->parser( $parser ) or die $t->error;
1344 my $out = $t->translate( $file ) or die $t->error;
1345 my $schema = $t->schema;
1346 unless ( $schema->name ) {
1347 $schema->name( $file );
1352 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1353 $target_schema, $db,
1356 my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1357 print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1360 warn("$difffile already exists, skipping");
1363 if(!open $file, ">$difffile")
1365 $self->throw_exception("Can't write to $difffile ($!)");
1374 sub configure_sqlt() {
1377 my $db = shift || $self->sqlt_type;
1378 if ($db eq 'PostgreSQL') {
1379 $tr->quote_table_names(0);
1380 $tr->quote_field_names(0);
1385 =head2 deployment_statements
1389 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1393 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1394 The database driver name is given by C<$type>, though the value from
1395 L</sqlt_type> is used if it is not specified.
1397 C<$directory> is used to return statements from files in a previously created
1398 L</create_ddl_dir> directory and is optional. The filenames are constructed
1399 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1401 If no C<$directory> is specified then the statements are constructed on the
1402 fly using L<SQL::Translator> and C<$version> is ignored.
1404 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1408 sub deployment_statements {
1409 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1410 # Need to be connected to get the correct sqlt_type
1411 $self->ensure_connected() unless $type;
1412 $type ||= $self->sqlt_type;
1413 $version ||= $schema->VERSION || '1.x';
1415 my $filename = $schema->ddl_filename($type, $dir, $version);
1419 open($file, "<$filename")
1420 or $self->throw_exception("Can't open $filename ($!)");
1423 return join('', @rows);
1426 eval "use SQL::Translator";
1429 eval "use SQL::Translator::Parser::DBIx::Class;";
1430 $self->throw_exception($@) if $@;
1431 eval "use SQL::Translator::Producer::${type};";
1432 $self->throw_exception($@) if $@;
1434 # sources needs to be a parser arg, but for simplicty allow at top level
1436 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1437 if exists $sqltargs->{sources};
1439 my $tr = SQL::Translator->new(%$sqltargs);
1440 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1441 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1444 $self->throw_exception("No SQL::Translator, and no Schema file found, aborting deploy");
1450 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1451 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1452 for ( split(";\n", $statement)) {
1453 next if($_ =~ /^--/);
1455 # next if($_ =~ /^DROP/m);
1456 next if($_ =~ /^BEGIN TRANSACTION/m);
1457 next if($_ =~ /^COMMIT/m);
1458 next if $_ =~ /^\s+$/; # skip whitespace only
1459 $self->debugobj->query_start($_) if $self->debug;
1460 $self->dbh->do($_) or warn "SQL was:\n $_"; # XXX exceptions?
1461 $self->debugobj->query_end($_) if $self->debug;
1466 =head2 datetime_parser
1468 Returns the datetime parser class
1472 sub datetime_parser {
1474 return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1477 =head2 datetime_parser_type
1479 Defines (returns) the datetime parser class - currently hardwired to
1480 L<DateTime::Format::MySQL>
1484 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1486 =head2 build_datetime_parser
1488 See L</datetime_parser>
1492 sub build_datetime_parser {
1494 my $type = $self->datetime_parser_type(@_);
1496 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1502 return if !$self->_dbh;
1511 The module defines a set of methods within the DBIC::SQL::Abstract
1512 namespace. These build on L<SQL::Abstract::Limit> to provide the
1513 SQL query functions.
1515 The following methods are extended:-
1529 See L</connect_info> for details.
1530 For setting, this method is deprecated in favor of L</connect_info>.
1534 See L</connect_info> for details.
1535 For setting, this method is deprecated in favor of L</connect_info>.
1539 See L</connect_info> for details.
1540 For setting, this method is deprecated in favor of L</connect_info>.
1546 Matt S. Trout <mst@shadowcatsystems.co.uk>
1548 Andy Grundman <andy@hybridized.org>
1552 You may distribute this code under the same terms as Perl itself.