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.
336 In either case, if the final argument in your connect_info happens
337 to be a hashref, C<connect_info> will look there for several
338 connection-specific options:
344 This can be set to an arrayref of literal sql statements, which will
345 be executed immediately after making the connection to the database
346 every time we [re-]connect.
348 =item disable_sth_caching
350 If set to a true value, this option will disable the caching of
351 statement handles via L<DBI/prepare_cached>.
355 Sets the limit dialect. This is useful for JDBC-bridge among others
356 where the remote SQL-dialect cannot be determined by the name of the
361 Specifies what characters to use to quote table and column names. If
362 you use this you will want to specify L<name_sep> as well.
364 quote_char expects either a single character, in which case is it is placed
365 on either side of the table/column, or an arrayref of length 2 in which case the
366 table/column name is placed between the elements.
368 For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd
369 use C<quote_char =E<gt> [qw/[ ]/]>.
373 This only needs to be used in conjunction with L<quote_char>, and is used to
374 specify the charecter that seperates elements (schemas, tables, columns) from
375 each other. In most cases this is simply a C<.>.
379 These options can be mixed in with your other L<DBI> connection attributes,
380 or placed in a seperate hashref after all other normal L<DBI> connection
383 Every time C<connect_info> is invoked, any previous settings for
384 these options will be cleared before setting the new ones, regardless of
385 whether any options are specified in the new C<connect_info>.
387 Important note: DBIC expects the returned database handle provided by
388 a subref argument to have RaiseError set on it. If it doesn't, things
389 might not work very well, YMMV. If you don't use a subref, DBIC will
390 force this setting for you anyways. Setting HandleError to anything
391 other than simple exception object wrapper might cause problems too.
395 # Simple SQLite connection
396 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
399 ->connect_info([ sub { DBI->connect(...) } ]);
401 # A bit more complicated
408 { quote_char => q{"}, name_sep => q{.} },
412 # Equivalent to the previous example
418 { AutoCommit => 0, quote_char => q{"}, name_sep => q{.} },
422 # Subref + DBIC-specific connection options
425 sub { DBI->connect(...) },
429 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
430 disable_sth_caching => 1,
438 my ($self, $info_arg) = @_;
440 return $self->_connect_info if !$info_arg;
442 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
443 # the new set of options
444 $self->_sql_maker(undef);
445 $self->_sql_maker_opts({});
447 my $info = [ @$info_arg ]; # copy because we can alter it
448 my $last_info = $info->[-1];
449 if(ref $last_info eq 'HASH') {
450 for my $storage_opt (qw/on_connect_do disable_sth_caching/) {
451 if(my $value = delete $last_info->{$storage_opt}) {
452 $self->$storage_opt($value);
455 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
456 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
457 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
461 # Get rid of any trailing empty hashref
462 pop(@$info) if !keys %$last_info;
465 $self->_connect_info($info);
470 This method is deprecated in favor of setting via L</connect_info>.
474 Arguments: $subref, @extra_coderef_args?
476 Execute the given subref using the new exception-based connection management.
478 The first two arguments will be the storage object that C<dbh_do> was called
479 on and a database handle to use. Any additional arguments will be passed
480 verbatim to the called subref as arguments 2 and onwards.
482 Using this (instead of $self->_dbh or $self->dbh) ensures correct
483 exception handling and reconnection (or failover in future subclasses).
485 Your subref should have no side-effects outside of the database, as
486 there is the potential for your subref to be partially double-executed
487 if the database connection was stale/dysfunctional.
491 my @stuff = $schema->storage->dbh_do(
493 my ($storage, $dbh, @cols) = @_;
494 my $cols = join(q{, }, @cols);
495 $dbh->selectrow_array("SELECT $cols FROM foo");
506 ref $coderef eq 'CODE' or $self->throw_exception
507 ('$coderef must be a CODE reference');
509 return $coderef->($self, $self->_dbh, @_) if $self->{_in_dbh_do};
510 local $self->{_in_dbh_do} = 1;
513 my $want_array = wantarray;
516 $self->_verify_pid if $self->_dbh;
517 $self->_populate_dbh if !$self->_dbh;
519 @result = $coderef->($self, $self->_dbh, @_);
521 elsif(defined $want_array) {
522 $result[0] = $coderef->($self, $self->_dbh, @_);
525 $coderef->($self, $self->_dbh, @_);
530 if(!$exception) { return $want_array ? @result : $result[0] }
532 $self->throw_exception($exception) if $self->connected;
534 # We were not connected - reconnect and retry, but let any
535 # exception fall right through this time
536 $self->_populate_dbh;
537 $coderef->($self, $self->_dbh, @_);
540 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
541 # It also informs dbh_do to bypass itself while under the direction of txn_do,
542 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
547 ref $coderef eq 'CODE' or $self->throw_exception
548 ('$coderef must be a CODE reference');
550 local $self->{_in_dbh_do} = 1;
553 my $want_array = wantarray;
558 $self->_verify_pid if $self->_dbh;
559 $self->_populate_dbh if !$self->_dbh;
563 @result = $coderef->(@_);
565 elsif(defined $want_array) {
566 $result[0] = $coderef->(@_);
575 if(!$exception) { return $want_array ? @result : $result[0] }
577 if($tried++ > 0 || $self->connected) {
578 eval { $self->txn_rollback };
579 my $rollback_exception = $@;
580 if($rollback_exception) {
581 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
582 $self->throw_exception($exception) # propagate nested rollback
583 if $rollback_exception =~ /$exception_class/;
585 $self->throw_exception(
586 "Transaction aborted: ${exception}. "
587 . "Rollback failed: ${rollback_exception}"
590 $self->throw_exception($exception)
593 # We were not connected, and was first try - reconnect and retry
595 $self->_populate_dbh;
601 Our C<disconnect> method also performs a rollback first if the
602 database is not in C<AutoCommit> mode.
609 if( $self->connected ) {
610 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
611 $self->_dbh->disconnect;
620 if(my $dbh = $self->_dbh) {
621 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
629 return ($dbh->FETCH('Active') && $dbh->ping);
635 # handle pid changes correctly
636 # NOTE: assumes $self->_dbh is a valid $dbh
640 return if $self->_conn_pid == $$;
642 $self->_dbh->{InactiveDestroy} = 1;
649 sub ensure_connected {
652 unless ($self->connected) {
653 $self->_populate_dbh;
659 Returns the dbh - a data base handle of class L<DBI>.
666 $self->ensure_connected;
670 sub _sql_maker_args {
673 return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
678 unless ($self->_sql_maker) {
679 $self->_sql_maker(new DBIC::SQL::Abstract( $self->_sql_maker_args ));
681 return $self->_sql_maker;
686 my @info = @{$self->_connect_info || []};
687 $self->_dbh($self->_connect(@info));
689 if(ref $self eq 'DBIx::Class::Storage::DBI') {
690 my $driver = $self->_dbh->{Driver}->{Name};
691 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
692 bless $self, "DBIx::Class::Storage::DBI::${driver}";
693 $self->_rebless() if $self->can('_rebless');
697 # if on-connect sql statements are given execute them
698 foreach my $sql_statement (@{$self->on_connect_do || []}) {
699 $self->debugobj->query_start($sql_statement) if $self->debug();
700 $self->_dbh->do($sql_statement);
701 $self->debugobj->query_end($sql_statement) if $self->debug();
704 # Rebless after we connect to the database, so we can take advantage of
706 if(ref $self eq 'DBIx::Class::Storage::DBI') {
707 my $driver = $self->_dbh->{Driver}->{Name};
708 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
709 bless $self, "DBIx::Class::Storage::DBI::${driver}";
710 $self->_rebless() if $self->can('_rebless');
714 $self->_conn_pid($$);
715 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
719 my ($self, @info) = @_;
721 $self->throw_exception("You failed to provide any connection info")
724 my ($old_connect_via, $dbh);
726 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
727 $old_connect_via = $DBI::connect_via;
728 $DBI::connect_via = 'connect';
732 if(ref $info[0] eq 'CODE') {
736 $dbh = DBI->connect(@info);
737 $dbh->{RaiseError} = 1;
738 $dbh->{PrintError} = 0;
739 $dbh->{PrintWarn} = 0;
743 $DBI::connect_via = $old_connect_via if $old_connect_via;
746 $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
753 my ($self, $dbh) = @_;
754 if ($dbh->{AutoCommit}) {
755 $self->debugobj->txn_begin()
763 $self->dbh_do($self->can('_dbh_txn_begin'))
764 if $self->{transaction_depth}++ == 0;
767 sub _dbh_txn_commit {
768 my ($self, $dbh) = @_;
769 if ($self->{transaction_depth} == 0) {
770 unless ($dbh->{AutoCommit}) {
771 $self->debugobj->txn_commit()
777 if (--$self->{transaction_depth} == 0) {
778 $self->debugobj->txn_commit()
787 $self->dbh_do($self->can('_dbh_txn_commit'));
790 sub _dbh_txn_rollback {
791 my ($self, $dbh) = @_;
792 if ($self->{transaction_depth} == 0) {
793 unless ($dbh->{AutoCommit}) {
794 $self->debugobj->txn_rollback()
800 if (--$self->{transaction_depth} == 0) {
801 $self->debugobj->txn_rollback()
806 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
814 eval { $self->dbh_do($self->can('_dbh_txn_rollback')) };
817 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
818 $error =~ /$exception_class/ and $self->throw_exception($error);
819 $self->{transaction_depth} = 0; # ensure that a failed rollback
820 $self->throw_exception($error); # resets the transaction depth
824 # This used to be the top-half of _execute. It was split out to make it
825 # easier to override in NoBindVars without duping the rest. It takes up
826 # all of _execute's args, and emits $sql, @bind.
827 sub _prep_for_execute {
828 my ($self, $op, $extra_bind, $ident, @args) = @_;
830 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
832 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
834 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
836 return ($sql, @bind);
840 my ($self, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
842 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
843 $ident = $ident->from();
846 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
848 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
852 map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind;
853 $self->debugobj->query_start($sql, @debug_bind);
855 my $sth = eval { $self->sth($sql,$op) };
858 $self->throw_exception(
859 'no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql"
867 my $placeholder_index = 1;
869 foreach my $bound (@bind) {
872 my($column_name, @data) = @$bound;
874 if( $bind_attributes ) {
875 $attributes = $bind_attributes->{$column_name}
876 if defined $bind_attributes->{$column_name};
879 foreach my $data (@data)
881 $data = ref $data ? ''.$data : $data; # stringify args
883 $sth->bind_param($placeholder_index, $data, $attributes);
884 $placeholder_index++;
891 $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
894 $self->throw_exception("'$sql' did not generate a statement.");
898 map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @bind;
899 $self->debugobj->query_end($sql, @debug_bind);
901 return (wantarray ? ($rv, $sth, @bind) : $rv);
905 my ($self, $source, $to_insert) = @_;
907 my $ident = $source->from;
908 my $bind_attributes = $self->source_bind_attributes($source);
910 $self->throw_exception(
911 "Couldn't insert ".join(', ',
912 map "$_ => $to_insert->{$_}", keys %$to_insert
914 ) unless ($self->_execute('insert' => [], $source, $bind_attributes, $to_insert));
918 ## Still not quite perfect, and EXPERIMENTAL
919 ## Currently it is assumed that all values passed will be "normal", i.e. not
920 ## scalar refs, or at least, all the same type as the first set, the statement is
921 ## only prepped once.
923 my ($self, $source, $cols, $data) = @_;
925 my $table = $source->from;
926 @colvalues{@$cols} = (0..$#$cols);
927 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
930 my @debug_bind = map { defined $_->[1] ? qq{$_->[1]} : q{'NULL'} } @bind;
931 $self->debugobj->query_start($sql, @debug_bind);
933 my $sth = $self->sth($sql);
935 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
939 ## This must be an arrayref, else nothing works!
941 my $tuple_status = [];
944 ##print STDERR Dumper( $data, $sql, [@bind] );
950 ## Get the bind_attributes, if any exist
951 my $bind_attributes = $self->source_bind_attributes($source);
953 ## Bind the values and execute
956 my $placeholder_index = 1;
958 foreach my $bound (@bind) {
961 my ($column_name, $data_index) = @$bound;
963 if( $bind_attributes ) {
964 $attributes = $bind_attributes->{$column_name}
965 if defined $bind_attributes->{$column_name};
968 my @data = map { $_->[$data_index] } @$data;
970 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
971 $placeholder_index++;
973 $sth->execute_array( {ArrayTupleStatus => $tuple_status} );
977 if ($@ || !defined $rv) {
979 foreach my $tuple (@$tuple_status) {
980 $errors .= "\n" . $tuple->[1] if(ref $tuple);
982 $self->throw_exception("Error executing '$sql': ".($@ || $errors));
985 $self->throw_exception("'$sql' did not generate a statement.");
988 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
989 $self->debugobj->query_end($sql, @debug_bind);
991 return (wantarray ? ($rv, $sth, @bind) : $rv);
996 my $source = shift @_;
997 my $bind_attributes = $self->source_bind_attributes($source);
999 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1004 my $self = shift @_;
1005 my $source = shift @_;
1007 my $bind_attrs = {}; ## If ever it's needed...
1009 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1013 my ($self, $ident, $select, $condition, $attrs) = @_;
1014 my $order = $attrs->{order_by};
1015 if (ref $condition eq 'SCALAR') {
1016 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1018 if (exists $attrs->{group_by} || $attrs->{having}) {
1020 group_by => $attrs->{group_by},
1021 having => $attrs->{having},
1022 ($order ? (order_by => $order) : ())
1025 my $bind_attrs = {}; ## Future support
1026 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1027 if ($attrs->{software_limit} ||
1028 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1029 $attrs->{software_limit} = 1;
1031 $self->throw_exception("rows attribute must be positive if present")
1032 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1033 push @args, $attrs->{rows}, $attrs->{offset};
1035 return $self->_execute(@args);
1038 sub source_bind_attributes {
1039 my ($self, $source) = @_;
1041 my $bind_attributes;
1042 foreach my $column ($source->columns) {
1044 my $data_type = $source->column_info($column)->{data_type} || '';
1045 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1049 return $bind_attributes;
1056 =item Arguments: $ident, $select, $condition, $attrs
1060 Handle a SQL select statement.
1066 my ($ident, $select, $condition, $attrs) = @_;
1067 return $self->cursor->new($self, \@_, $attrs);
1072 my ($rv, $sth, @bind) = $self->_select(@_);
1073 my @row = $sth->fetchrow_array;
1074 # Need to call finish() to work round broken DBDs
1083 =item Arguments: $sql
1087 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1092 my ($self, $dbh, $sql) = @_;
1094 # 3 is the if_active parameter which avoids active sth re-use
1095 my $sth = $self->disable_sth_caching
1096 ? $dbh->prepare($sql)
1097 : $dbh->prepare_cached($sql, {}, 3);
1099 $self->throw_exception(
1100 'no sth generated via sql (' . ($@ || $dbh->errstr) . "): $sql"
1107 my ($self, $sql) = @_;
1108 $self->dbh_do($self->can('_dbh_sth'), $sql);
1111 sub _dbh_columns_info_for {
1112 my ($self, $dbh, $table) = @_;
1114 if ($dbh->can('column_info')) {
1117 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1118 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1120 while ( my $info = $sth->fetchrow_hashref() ){
1122 $column_info{data_type} = $info->{TYPE_NAME};
1123 $column_info{size} = $info->{COLUMN_SIZE};
1124 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1125 $column_info{default_value} = $info->{COLUMN_DEF};
1126 my $col_name = $info->{COLUMN_NAME};
1127 $col_name =~ s/^\"(.*)\"$/$1/;
1129 $result{$col_name} = \%column_info;
1132 return \%result if !$@ && scalar keys %result;
1136 my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
1138 my @columns = @{$sth->{NAME_lc}};
1139 for my $i ( 0 .. $#columns ){
1141 my $type_num = $sth->{TYPE}->[$i];
1143 if(defined $type_num && $dbh->can('type_info')) {
1144 my $type_info = $dbh->type_info($type_num);
1145 $type_name = $type_info->{TYPE_NAME} if $type_info;
1147 $column_info{data_type} = $type_name ? $type_name : $type_num;
1148 $column_info{size} = $sth->{PRECISION}->[$i];
1149 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1151 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1152 $column_info{data_type} = $1;
1153 $column_info{size} = $2;
1156 $result{$columns[$i]} = \%column_info;
1162 sub columns_info_for {
1163 my ($self, $table) = @_;
1164 $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
1167 =head2 last_insert_id
1169 Return the row id of the last insert.
1173 sub _dbh_last_insert_id {
1174 my ($self, $dbh, $source, $col) = @_;
1175 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1176 $dbh->func('last_insert_rowid');
1179 sub last_insert_id {
1181 $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
1186 Returns the database driver name.
1190 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1192 =head2 bind_attribute_by_data_type
1194 Given a datatype from column info, returns a database specific bind attribute for
1195 $dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1198 Generally only needed for special case column types, like bytea in postgres.
1202 sub bind_attribute_by_data_type {
1206 =head2 create_ddl_dir (EXPERIMENTAL)
1210 =item Arguments: $schema \@databases, $version, $directory, $preversion, $sqlt_args
1214 Creates a SQL file based on the Schema, for each of the specified
1215 database types, in the given directory.
1217 Note that this feature is currently EXPERIMENTAL and may not work correctly
1218 across all databases, or fully handle complex relationships.
1224 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1226 if(!$dir || !-d $dir)
1228 warn "No directory given, using ./\n";
1231 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1232 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1233 $version ||= $schema->VERSION || '1.x';
1234 $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
1236 eval "use SQL::Translator";
1237 $self->throw_exception("Can't create a ddl file without SQL::Translator: $@") if $@;
1239 my $sqlt = SQL::Translator->new({
1241 add_drop_table => 1,
1243 foreach my $db (@$databases)
1246 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1247 # $sqlt->parser_args({'DBIx::Class' => $schema);
1248 $sqlt = $self->configure_sqlt($sqlt, $db);
1249 $sqlt->data($schema);
1250 $sqlt->producer($db);
1253 my $filename = $schema->ddl_filename($db, $dir, $version);
1256 warn("$filename already exists, skipping $db");
1260 my $output = $sqlt->translate;
1263 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1266 if(!open($file, ">$filename"))
1268 $self->throw_exception("Can't open $filename for writing ($!)");
1271 print $file $output;
1276 eval "use SQL::Translator::Diff";
1279 warn("Can't diff versions without SQL::Translator::Diff: $@");
1283 my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
1284 # print "Previous version $prefilename\n";
1285 if(!-e $prefilename)
1287 warn("No previous schema file found ($prefilename)");
1290 #### We need to reparse the SQLite file we just wrote, so that
1291 ## Diff doesnt get all confoosed, and Diff is *very* confused.
1292 ## FIXME: rip Diff to pieces!
1293 # my $target_schema = $sqlt->schema;
1294 # unless ( $target_schema->name ) {
1295 # $target_schema->name( $filename );
1298 push @input, {file => $prefilename, parser => $db};
1299 push @input, {file => $filename, parser => $db};
1300 my ( $source_schema, $source_db, $target_schema, $target_db ) = map {
1301 my $file = $_->{'file'};
1302 my $parser = $_->{'parser'};
1304 my $t = SQL::Translator->new;
1307 $t->parser( $parser ) or die $t->error;
1308 my $out = $t->translate( $file ) or die $t->error;
1309 my $schema = $t->schema;
1310 unless ( $schema->name ) {
1311 $schema->name( $file );
1316 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1317 $target_schema, $db,
1320 my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1321 print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1324 warn("$difffile already exists, skipping");
1327 if(!open $file, ">$difffile")
1329 $self->throw_exception("Can't write to $difffile ($!)");
1338 sub configure_sqlt() {
1341 my $db = shift || $self->sqlt_type;
1342 if ($db eq 'PostgreSQL') {
1343 $tr->quote_table_names(0);
1344 $tr->quote_field_names(0);
1349 =head2 deployment_statements
1353 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1357 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1358 The database driver name is given by C<$type>, though the value from
1359 L</sqlt_type> is used if it is not specified.
1361 C<$directory> is used to return statements from files in a previously created
1362 L</create_ddl_dir> directory and is optional. The filenames are constructed
1363 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1365 If no C<$directory> is specified then the statements are constructed on the
1366 fly using L<SQL::Translator> and C<$version> is ignored.
1368 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1372 sub deployment_statements {
1373 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1374 # Need to be connected to get the correct sqlt_type
1375 $self->ensure_connected() unless $type;
1376 $type ||= $self->sqlt_type;
1377 $version ||= $schema->VERSION || '1.x';
1379 my $filename = $schema->ddl_filename($type, $dir, $version);
1383 open($file, "<$filename")
1384 or $self->throw_exception("Can't open $filename ($!)");
1387 return join('', @rows);
1390 eval "use SQL::Translator";
1393 eval "use SQL::Translator::Parser::DBIx::Class;";
1394 $self->throw_exception($@) if $@;
1395 eval "use SQL::Translator::Producer::${type};";
1396 $self->throw_exception($@) if $@;
1398 # sources needs to be a parser arg, but for simplicty allow at top level
1400 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1401 if exists $sqltargs->{sources};
1403 my $tr = SQL::Translator->new(%$sqltargs);
1404 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1405 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1408 $self->throw_exception("No SQL::Translator, and no Schema file found, aborting deploy");
1414 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1415 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1416 for ( split(";\n", $statement)) {
1417 next if($_ =~ /^--/);
1419 # next if($_ =~ /^DROP/m);
1420 next if($_ =~ /^BEGIN TRANSACTION/m);
1421 next if($_ =~ /^COMMIT/m);
1422 next if $_ =~ /^\s+$/; # skip whitespace only
1423 $self->debugobj->query_start($_) if $self->debug;
1424 $self->dbh->do($_) or warn "SQL was:\n $_"; # XXX exceptions?
1425 $self->debugobj->query_end($_) if $self->debug;
1430 =head2 datetime_parser
1432 Returns the datetime parser class
1436 sub datetime_parser {
1438 return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1441 =head2 datetime_parser_type
1443 Defines (returns) the datetime parser class - currently hardwired to
1444 L<DateTime::Format::MySQL>
1448 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1450 =head2 build_datetime_parser
1452 See L</datetime_parser>
1456 sub build_datetime_parser {
1458 my $type = $self->datetime_parser_type(@_);
1460 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1466 return if !$self->_dbh;
1475 The module defines a set of methods within the DBIC::SQL::Abstract
1476 namespace. These build on L<SQL::Abstract::Limit> to provide the
1477 SQL query functions.
1479 The following methods are extended:-
1493 See L</connect_info> for details.
1494 For setting, this method is deprecated in favor of L</connect_info>.
1498 See L</connect_info> for details.
1499 For setting, this method is deprecated in favor of L</connect_info>.
1503 See L</connect_info> for details.
1504 For setting, this method is deprecated in favor of L</connect_info>.
1510 Matt S. Trout <mst@shadowcatsystems.co.uk>
1512 Andy Grundman <andy@hybridized.org>
1516 You may distribute this code under the same terms as Perl itself.