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;
14 __PACKAGE__->mk_group_accessors(
16 qw/_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid _conn_tid
17 disable_sth_caching cursor on_connect_do transaction_depth/
22 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
24 use base qw/SQL::Abstract::Limit/;
26 # This prevents the caching of $dbh in S::A::L, I believe
28 my $self = shift->SUPER::new(@_);
30 # If limit_dialect is a ref (like a $dbh), go ahead and replace
31 # it with what it resolves to:
32 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
33 if ref $self->{limit_dialect};
39 my ($self, $sql, $order, $rows, $offset ) = @_;
42 my $last = $rows + $offset;
43 my ( $order_by ) = $self->_order_by( $order );
48 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
53 WHERE ROW_NUM BETWEEN $offset AND $last
59 # While we're at it, this should make LIMIT queries more efficient,
60 # without digging into things too deeply
61 use Scalar::Util 'blessed';
63 my ($self, $syntax) = @_;
64 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
65 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
66 return 'RowNumberOver';
69 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
73 my ($self, $table, $fields, $where, $order, @rest) = @_;
74 $table = $self->_quote($table) unless ref($table);
75 local $self->{rownum_hack_count} = 1
76 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
77 @rest = (-1) unless defined $rest[0];
78 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
79 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
80 local $self->{having_bind} = [];
81 my ($sql, @ret) = $self->SUPER::select(
82 $table, $self->_recurse_fields($fields), $where, $order, @rest
84 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
90 $table = $self->_quote($table) unless ref($table);
91 $self->SUPER::insert($table, @_);
97 $table = $self->_quote($table) unless ref($table);
98 $self->SUPER::update($table, @_);
104 $table = $self->_quote($table) unless ref($table);
105 $self->SUPER::delete($table, @_);
111 return $_[1].$self->_order_by($_[2]);
113 return $self->SUPER::_emulate_limit(@_);
117 sub _recurse_fields {
118 my ($self, $fields) = @_;
119 my $ref = ref $fields;
120 return $self->_quote($fields) unless $ref;
121 return $$fields if $ref eq 'SCALAR';
123 if ($ref eq 'ARRAY') {
124 return join(', ', map {
125 $self->_recurse_fields($_)
126 .(exists $self->{rownum_hack_count}
127 ? ' AS col'.$self->{rownum_hack_count}++
130 } elsif ($ref eq 'HASH') {
131 foreach my $func (keys %$fields) {
132 return $self->_sqlcase($func)
133 .'( '.$self->_recurse_fields($fields->{$func}).' )';
142 if (ref $_[0] eq 'HASH') {
143 if (defined $_[0]->{group_by}) {
144 $ret = $self->_sqlcase(' group by ')
145 .$self->_recurse_fields($_[0]->{group_by});
147 if (defined $_[0]->{having}) {
149 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
150 push(@{$self->{having_bind}}, @extra);
151 $ret .= $self->_sqlcase(' having ').$frag;
153 if (defined $_[0]->{order_by}) {
154 $ret .= $self->_order_by($_[0]->{order_by});
156 } elsif (ref $_[0] eq 'SCALAR') {
157 $ret = $self->_sqlcase(' order by ').${ $_[0] };
158 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
159 my @order = @{+shift};
160 $ret = $self->_sqlcase(' order by ')
162 my $r = $self->_order_by($_, @_);
163 $r =~ s/^ ?ORDER BY //i;
167 $ret = $self->SUPER::_order_by(@_);
172 sub _order_directions {
173 my ($self, $order) = @_;
174 $order = $order->{order_by} if ref $order eq 'HASH';
175 return $self->SUPER::_order_directions($order);
179 my ($self, $from) = @_;
180 if (ref $from eq 'ARRAY') {
181 return $self->_recurse_from(@$from);
182 } elsif (ref $from eq 'HASH') {
183 return $self->_make_as($from);
185 return $from; # would love to quote here but _table ends up getting called
186 # twice during an ->select without a limit clause due to
187 # the way S::A::Limit->select works. should maybe consider
188 # bypassing this and doing S::A::select($self, ...) in
189 # our select method above. meantime, quoting shims have
190 # been added to select/insert/update/delete here
195 my ($self, $from, @join) = @_;
197 push(@sqlf, $self->_make_as($from));
198 foreach my $j (@join) {
201 # check whether a join type exists
202 my $join_clause = '';
203 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
204 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
205 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
207 $join_clause = ' JOIN ';
209 push(@sqlf, $join_clause);
211 if (ref $to eq 'ARRAY') {
212 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
214 push(@sqlf, $self->_make_as($to));
216 push(@sqlf, ' ON ', $self->_join_condition($on));
218 return join('', @sqlf);
222 my ($self, $from) = @_;
223 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
224 reverse each %{$self->_skip_options($from)});
228 my ($self, $hash) = @_;
230 $clean_hash->{$_} = $hash->{$_}
231 for grep {!/^-/} keys %$hash;
235 sub _join_condition {
236 my ($self, $cond) = @_;
237 if (ref $cond eq 'HASH') {
242 # XXX no throw_exception() in this package and croak() fails with strange results
243 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
244 if ref($v) ne 'SCALAR';
248 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
251 return scalar($self->_recurse_where(\%j));
252 } elsif (ref $cond eq 'ARRAY') {
253 return join(' OR ', map { $self->_join_condition($_) } @$cond);
255 die "Can't handle this yet!";
260 my ($self, $label) = @_;
261 return '' unless defined $label;
262 return "*" if $label eq '*';
263 return $label unless $self->{quote_char};
264 if(ref $self->{quote_char} eq "ARRAY"){
265 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
266 if !defined $self->{name_sep};
267 my $sep = $self->{name_sep};
268 return join($self->{name_sep},
269 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
270 split(/\Q$sep\E/,$label));
272 return $self->SUPER::_quote($label);
277 $self->{limit_dialect} = shift if @_;
278 return $self->{limit_dialect};
283 $self->{quote_char} = shift if @_;
284 return $self->{quote_char};
289 $self->{name_sep} = shift if @_;
290 return $self->{name_sep};
293 } # End of BEGIN block
297 DBIx::Class::Storage::DBI - DBI storage handler
303 This class represents the connection to an RDBMS via L<DBI>. See
304 L<DBIx::Class::Storage> for general information. This pod only
305 documents DBI-specific methods and behaviors.
312 my $new = shift->next::method(@_);
314 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
315 $new->transaction_depth(0);
316 $new->_sql_maker_opts({});
317 $new->{_in_dbh_do} = 0;
318 $new->{_dbh_gen} = 0;
325 The arguments of C<connect_info> are always a single array reference.
327 This is normally accessed via L<DBIx::Class::Schema/connection>, which
328 encapsulates its argument list in an arrayref before calling
329 C<connect_info> here.
331 The arrayref can either contain the same set of arguments one would
332 normally pass to L<DBI/connect>, or a lone code reference which returns
333 a connected database handle.
335 In either case, if the final argument in your connect_info happens
336 to be a hashref, C<connect_info> will look there for several
337 connection-specific options:
343 This can be set to an arrayref of literal sql statements, which will
344 be executed immediately after making the connection to the database
345 every time we [re-]connect.
347 =item disable_sth_caching
349 If set to a true value, this option will disable the caching of
350 statement handles via L<DBI/prepare_cached>.
354 Sets the limit dialect. This is useful for JDBC-bridge among others
355 where the remote SQL-dialect cannot be determined by the name of the
360 Specifies what characters to use to quote table and column names. If
361 you use this you will want to specify L<name_sep> as well.
363 quote_char expects either a single character, in which case is it is placed
364 on either side of the table/column, or an arrayref of length 2 in which case the
365 table/column name is placed between the elements.
367 For example under MySQL you'd use C<quote_char =E<gt> '`'>, and user SQL Server you'd
368 use C<quote_char =E<gt> [qw/[ ]/]>.
372 This only needs to be used in conjunction with L<quote_char>, and is used to
373 specify the charecter that seperates elements (schemas, tables, columns) from
374 each other. In most cases this is simply a C<.>.
378 These options can be mixed in with your other L<DBI> connection attributes,
379 or placed in a seperate hashref after all other normal L<DBI> connection
382 Every time C<connect_info> is invoked, any previous settings for
383 these options will be cleared before setting the new ones, regardless of
384 whether any options are specified in the new C<connect_info>.
386 Important note: DBIC expects the returned database handle provided by
387 a subref argument to have RaiseError set on it. If it doesn't, things
388 might not work very well, YMMV. If you don't use a subref, DBIC will
389 force this setting for you anyways. Setting HandleError to anything
390 other than simple exception object wrapper might cause problems too.
394 # Simple SQLite connection
395 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
398 ->connect_info([ sub { DBI->connect(...) } ]);
400 # A bit more complicated
407 { quote_char => q{"}, name_sep => q{.} },
411 # Equivalent to the previous example
417 { AutoCommit => 0, quote_char => q{"}, name_sep => q{.} },
421 # Subref + DBIC-specific connection options
424 sub { DBI->connect(...) },
428 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
429 disable_sth_caching => 1,
437 my ($self, $info_arg) = @_;
439 return $self->_connect_info if !$info_arg;
441 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
442 # the new set of options
443 $self->_sql_maker(undef);
444 $self->_sql_maker_opts({});
446 my $info = [ @$info_arg ]; # copy because we can alter it
447 my $last_info = $info->[-1];
448 if(ref $last_info eq 'HASH') {
449 for my $storage_opt (qw/on_connect_do disable_sth_caching/) {
450 if(my $value = delete $last_info->{$storage_opt}) {
451 $self->$storage_opt($value);
454 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
455 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
456 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
460 # Get rid of any trailing empty hashref
461 pop(@$info) if !keys %$last_info;
464 $self->_connect_info($info);
469 This method is deprecated in favor of setting via L</connect_info>.
473 Arguments: $subref, @extra_coderef_args?
475 Execute the given subref using the new exception-based connection management.
477 The first two arguments will be the storage object that C<dbh_do> was called
478 on and a database handle to use. Any additional arguments will be passed
479 verbatim to the called subref as arguments 2 and onwards.
481 Using this (instead of $self->_dbh or $self->dbh) ensures correct
482 exception handling and reconnection (or failover in future subclasses).
484 Your subref should have no side-effects outside of the database, as
485 there is the potential for your subref to be partially double-executed
486 if the database connection was stale/dysfunctional.
490 my @stuff = $schema->storage->dbh_do(
492 my ($storage, $dbh, @cols) = @_;
493 my $cols = join(q{, }, @cols);
494 $dbh->selectrow_array("SELECT $cols FROM foo");
505 ref $coderef eq 'CODE' or $self->throw_exception
506 ('$coderef must be a CODE reference');
508 return $coderef->($self, $self->_dbh, @_) if $self->{_in_dbh_do};
509 local $self->{_in_dbh_do} = 1;
512 my $want_array = wantarray;
515 $self->_verify_pid if $self->_dbh;
516 $self->_populate_dbh if !$self->_dbh;
518 @result = $coderef->($self, $self->_dbh, @_);
520 elsif(defined $want_array) {
521 $result[0] = $coderef->($self, $self->_dbh, @_);
524 $coderef->($self, $self->_dbh, @_);
529 if(!$exception) { return $want_array ? @result : $result[0] }
531 $self->throw_exception($exception) if $self->connected;
533 # We were not connected - reconnect and retry, but let any
534 # exception fall right through this time
535 $self->_populate_dbh;
536 $coderef->($self, $self->_dbh, @_);
539 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
540 # It also informs dbh_do to bypass itself while under the direction of txn_do,
541 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
546 ref $coderef eq 'CODE' or $self->throw_exception
547 ('$coderef must be a CODE reference');
549 local $self->{_in_dbh_do} = 1;
552 my $want_array = wantarray;
557 $self->_verify_pid if $self->_dbh;
558 $self->_populate_dbh if !$self->_dbh;
562 @result = $coderef->(@_);
564 elsif(defined $want_array) {
565 $result[0] = $coderef->(@_);
574 if(!$exception) { return $want_array ? @result : $result[0] }
576 if($tried++ > 0 || $self->connected) {
577 eval { $self->txn_rollback };
578 my $rollback_exception = $@;
579 if($rollback_exception) {
580 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
581 $self->throw_exception($exception) # propagate nested rollback
582 if $rollback_exception =~ /$exception_class/;
584 $self->throw_exception(
585 "Transaction aborted: ${exception}. "
586 . "Rollback failed: ${rollback_exception}"
589 $self->throw_exception($exception)
592 # We were not connected, and was first try - reconnect and retry
594 $self->_populate_dbh;
600 Our C<disconnect> method also performs a rollback first if the
601 database is not in C<AutoCommit> mode.
608 if( $self->connected ) {
609 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
610 $self->_dbh->disconnect;
619 if(my $dbh = $self->_dbh) {
620 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
628 return ($dbh->FETCH('Active') && $dbh->ping);
634 # handle pid changes correctly
635 # NOTE: assumes $self->_dbh is a valid $dbh
639 return if $self->_conn_pid == $$;
641 $self->_dbh->{InactiveDestroy} = 1;
648 sub ensure_connected {
651 unless ($self->connected) {
652 $self->_populate_dbh;
658 Returns the dbh - a data base handle of class L<DBI>.
665 $self->ensure_connected;
669 sub _sql_maker_args {
672 return ( limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
677 unless ($self->_sql_maker) {
678 $self->_sql_maker(new DBIC::SQL::Abstract( $self->_sql_maker_args ));
680 return $self->_sql_maker;
685 my @info = @{$self->_connect_info || []};
686 $self->_dbh($self->_connect(@info));
688 if(ref $self eq 'DBIx::Class::Storage::DBI') {
689 my $driver = $self->_dbh->{Driver}->{Name};
690 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
691 bless $self, "DBIx::Class::Storage::DBI::${driver}";
692 $self->_rebless() if $self->can('_rebless');
696 # if on-connect sql statements are given execute them
697 foreach my $sql_statement (@{$self->on_connect_do || []}) {
698 $self->debugobj->query_start($sql_statement) if $self->debug();
699 $self->_dbh->do($sql_statement);
700 $self->debugobj->query_end($sql_statement) if $self->debug();
703 $self->_conn_pid($$);
704 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
708 my ($self, @info) = @_;
710 $self->throw_exception("You failed to provide any connection info")
713 my ($old_connect_via, $dbh);
715 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
716 $old_connect_via = $DBI::connect_via;
717 $DBI::connect_via = 'connect';
721 if(ref $info[0] eq 'CODE') {
725 $dbh = DBI->connect(@info);
726 $dbh->{RaiseError} = 1;
727 $dbh->{PrintError} = 0;
728 $dbh->{PrintWarn} = 0;
732 $DBI::connect_via = $old_connect_via if $old_connect_via;
735 $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
742 my ($self, $dbh) = @_;
743 if ($dbh->{AutoCommit}) {
744 $self->debugobj->txn_begin()
752 $self->dbh_do($self->can('_dbh_txn_begin'))
753 if $self->{transaction_depth}++ == 0;
756 sub _dbh_txn_commit {
757 my ($self, $dbh) = @_;
758 if ($self->{transaction_depth} == 0) {
759 unless ($dbh->{AutoCommit}) {
760 $self->debugobj->txn_commit()
766 if (--$self->{transaction_depth} == 0) {
767 $self->debugobj->txn_commit()
776 $self->dbh_do($self->can('_dbh_txn_commit'));
779 sub _dbh_txn_rollback {
780 my ($self, $dbh) = @_;
781 if ($self->{transaction_depth} == 0) {
782 unless ($dbh->{AutoCommit}) {
783 $self->debugobj->txn_rollback()
789 if (--$self->{transaction_depth} == 0) {
790 $self->debugobj->txn_rollback()
795 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
803 eval { $self->dbh_do($self->can('_dbh_txn_rollback')) };
806 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
807 $error =~ /$exception_class/ and $self->throw_exception($error);
808 $self->{transaction_depth} = 0; # ensure that a failed rollback
809 $self->throw_exception($error); # resets the transaction depth
813 # This used to be the top-half of _execute. It was split out to make it
814 # easier to override in NoBindVars without duping the rest. It takes up
815 # all of _execute's args, and emits $sql, @bind.
816 sub _prep_for_execute {
817 my ($self, $op, $extra_bind, $ident, @args) = @_;
819 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
820 unshift(@bind, @$extra_bind) if $extra_bind;
821 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
823 return ($sql, @bind);
829 my ($sql, @bind) = $self->_prep_for_execute(@_);
832 my @debug_bind = map { defined $_ ? qq{'$_'} : q{'NULL'} } @bind;
833 $self->debugobj->query_start($sql, @debug_bind);
836 my $sth = $self->sth($sql);
841 $rv = eval { $sth->execute(@bind) };
844 $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
847 $self->throw_exception("'$sql' did not generate a statement.");
850 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
851 $self->debugobj->query_end($sql, @debug_bind);
853 return (wantarray ? ($rv, $sth, @bind) : $rv);
857 my ($self, $ident, $to_insert) = @_;
858 $self->throw_exception(
859 "Couldn't insert ".join(', ',
860 map "$_ => $to_insert->{$_}", keys %$to_insert
862 ) unless ($self->_execute('insert' => [], $ident, $to_insert));
866 ## Still not quite perfect, and EXPERIMENTAL
867 ## Currently it is assumed that all values passed will be "normal", i.e. not
868 ## scalar refs, or at least, all the same type as the first set, the statement is
869 ## only prepped once.
871 my ($self, $table, $cols, $data) = @_;
873 @colvalues{@$cols} = (0..$#$cols);
874 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
875 # print STDERR "BIND".Dumper(\@bind);
878 my @debug_bind = map { defined $_ ? qq{'$_'} : q{'NULL'} } @bind;
879 $self->debugobj->query_start($sql, @debug_bind);
881 my $sth = $self->sth($sql);
883 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
886 ## This must be an arrayref, else nothing works!
887 my $tuple_status = [];
889 # print STDERR Dumper($data);
892 $rv = eval { $sth->execute_array({ ArrayTupleFetch => sub { my $values = shift @$data; return if !$values; return [ @{$values}[@bind] ]},
893 ArrayTupleStatus => $tuple_status }) };
894 # print STDERR Dumper($tuple_status);
895 # print STDERR "RV: $rv\n";
896 if ($@ || !defined $rv) {
898 foreach my $tuple (@$tuple_status)
900 $errors .= "\n" . $tuple->[1] if(ref $tuple);
902 $self->throw_exception("Error executing '$sql': ".($@ || $errors));
905 $self->throw_exception("'$sql' did not generate a statement.");
908 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
909 $self->debugobj->query_end($sql, @debug_bind);
911 return (wantarray ? ($rv, $sth, @bind) : $rv);
915 return shift->_execute('update' => [], @_);
919 return shift->_execute('delete' => [], @_);
923 my ($self, $ident, $select, $condition, $attrs) = @_;
924 my $order = $attrs->{order_by};
925 if (ref $condition eq 'SCALAR') {
926 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
928 if (exists $attrs->{group_by} || $attrs->{having}) {
930 group_by => $attrs->{group_by},
931 having => $attrs->{having},
932 ($order ? (order_by => $order) : ())
935 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
936 if ($attrs->{software_limit} ||
937 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
938 $attrs->{software_limit} = 1;
940 $self->throw_exception("rows attribute must be positive if present")
941 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
942 push @args, $attrs->{rows}, $attrs->{offset};
944 return $self->_execute(@args);
951 =item Arguments: $ident, $select, $condition, $attrs
955 Handle a SQL select statement.
961 my ($ident, $select, $condition, $attrs) = @_;
962 return $self->cursor->new($self, \@_, $attrs);
967 my ($rv, $sth, @bind) = $self->_select(@_);
968 my @row = $sth->fetchrow_array;
969 # Need to call finish() to work round broken DBDs
978 =item Arguments: $sql
982 Returns a L<DBI> sth (statement handle) for the supplied SQL.
987 my ($self, $dbh, $sql) = @_;
989 # 3 is the if_active parameter which avoids active sth re-use
990 my $sth = $self->disable_sth_caching
991 ? $dbh->prepare($sql)
992 : $dbh->prepare_cached($sql, {}, 3);
994 $self->throw_exception(
995 'no sth generated via sql (' . ($@ || $dbh->errstr) . "): $sql"
1002 my ($self, $sql) = @_;
1003 $self->dbh_do($self->can('_dbh_sth'), $sql);
1006 sub _dbh_columns_info_for {
1007 my ($self, $dbh, $table) = @_;
1009 if ($dbh->can('column_info')) {
1012 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1013 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1015 while ( my $info = $sth->fetchrow_hashref() ){
1017 $column_info{data_type} = $info->{TYPE_NAME};
1018 $column_info{size} = $info->{COLUMN_SIZE};
1019 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1020 $column_info{default_value} = $info->{COLUMN_DEF};
1021 my $col_name = $info->{COLUMN_NAME};
1022 $col_name =~ s/^\"(.*)\"$/$1/;
1024 $result{$col_name} = \%column_info;
1027 return \%result if !$@ && scalar keys %result;
1031 my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
1033 my @columns = @{$sth->{NAME_lc}};
1034 for my $i ( 0 .. $#columns ){
1036 my $type_num = $sth->{TYPE}->[$i];
1038 if(defined $type_num && $dbh->can('type_info')) {
1039 my $type_info = $dbh->type_info($type_num);
1040 $type_name = $type_info->{TYPE_NAME} if $type_info;
1042 $column_info{data_type} = $type_name ? $type_name : $type_num;
1043 $column_info{size} = $sth->{PRECISION}->[$i];
1044 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1046 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1047 $column_info{data_type} = $1;
1048 $column_info{size} = $2;
1051 $result{$columns[$i]} = \%column_info;
1057 sub columns_info_for {
1058 my ($self, $table) = @_;
1059 $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
1062 =head2 last_insert_id
1064 Return the row id of the last insert.
1068 sub _dbh_last_insert_id {
1069 my ($self, $dbh, $source, $col) = @_;
1070 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1071 $dbh->func('last_insert_rowid');
1074 sub last_insert_id {
1076 $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
1081 Returns the database driver name.
1085 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1087 =head2 create_ddl_dir (EXPERIMENTAL)
1091 =item Arguments: $schema \@databases, $version, $directory, $preversion, $sqlt_args
1095 Creates a SQL file based on the Schema, for each of the specified
1096 database types, in the given directory.
1098 Note that this feature is currently EXPERIMENTAL and may not work correctly
1099 across all databases, or fully handle complex relationships.
1105 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1107 if(!$dir || !-d $dir)
1109 warn "No directory given, using ./\n";
1112 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1113 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1114 $version ||= $schema->VERSION || '1.x';
1115 $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
1117 eval "use SQL::Translator";
1118 $self->throw_exception("Can't create a ddl file without SQL::Translator: $@") if $@;
1120 my $sqlt = SQL::Translator->new({
1122 add_drop_table => 1,
1124 foreach my $db (@$databases)
1127 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1128 # $sqlt->parser_args({'DBIx::Class' => $schema);
1129 $sqlt = $self->configure_sqlt($sqlt, $db);
1130 $sqlt->data($schema);
1131 $sqlt->producer($db);
1134 my $filename = $schema->ddl_filename($db, $dir, $version);
1137 warn("$filename already exists, skipping $db");
1141 my $output = $sqlt->translate;
1144 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1147 if(!open($file, ">$filename"))
1149 $self->throw_exception("Can't open $filename for writing ($!)");
1152 print $file $output;
1157 eval "use SQL::Translator::Diff";
1160 warn("Can't diff versions without SQL::Translator::Diff: $@");
1164 my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
1165 # print "Previous version $prefilename\n";
1166 if(!-e $prefilename)
1168 warn("No previous schema file found ($prefilename)");
1171 #### We need to reparse the SQLite file we just wrote, so that
1172 ## Diff doesnt get all confoosed, and Diff is *very* confused.
1173 ## FIXME: rip Diff to pieces!
1174 # my $target_schema = $sqlt->schema;
1175 # unless ( $target_schema->name ) {
1176 # $target_schema->name( $filename );
1179 push @input, {file => $prefilename, parser => $db};
1180 push @input, {file => $filename, parser => $db};
1181 my ( $source_schema, $source_db, $target_schema, $target_db ) = map {
1182 my $file = $_->{'file'};
1183 my $parser = $_->{'parser'};
1185 my $t = SQL::Translator->new;
1188 $t->parser( $parser ) or die $t->error;
1189 my $out = $t->translate( $file ) or die $t->error;
1190 my $schema = $t->schema;
1191 unless ( $schema->name ) {
1192 $schema->name( $file );
1197 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1198 $target_schema, $db,
1201 my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1202 print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1205 warn("$difffile already exists, skipping");
1208 if(!open $file, ">$difffile")
1210 $self->throw_exception("Can't write to $difffile ($!)");
1219 sub configure_sqlt() {
1222 my $db = shift || $self->sqlt_type;
1223 if ($db eq 'PostgreSQL') {
1224 $tr->quote_table_names(0);
1225 $tr->quote_field_names(0);
1230 =head2 deployment_statements
1234 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1238 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1239 The database driver name is given by C<$type>, though the value from
1240 L</sqlt_type> is used if it is not specified.
1242 C<$directory> is used to return statements from files in a previously created
1243 L</create_ddl_dir> directory and is optional. The filenames are constructed
1244 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1246 If no C<$directory> is specified then the statements are constructed on the
1247 fly using L<SQL::Translator> and C<$version> is ignored.
1249 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1253 sub deployment_statements {
1254 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1255 # Need to be connected to get the correct sqlt_type
1256 $self->ensure_connected() unless $type;
1257 $type ||= $self->sqlt_type;
1258 $version ||= $schema->VERSION || '1.x';
1260 my $filename = $schema->ddl_filename($type, $dir, $version);
1264 open($file, "<$filename")
1265 or $self->throw_exception("Can't open $filename ($!)");
1268 return join('', @rows);
1271 eval "use SQL::Translator";
1274 eval "use SQL::Translator::Parser::DBIx::Class;";
1275 $self->throw_exception($@) if $@;
1276 eval "use SQL::Translator::Producer::${type};";
1277 $self->throw_exception($@) if $@;
1279 # sources needs to be a parser arg, but for simplicty allow at top level
1281 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1282 if exists $sqltargs->{sources};
1284 my $tr = SQL::Translator->new(%$sqltargs);
1285 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1286 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1289 $self->throw_exception("No SQL::Translator, and no Schema file found, aborting deploy");
1295 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1296 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1297 for ( split(";\n", $statement)) {
1298 next if($_ =~ /^--/);
1300 # next if($_ =~ /^DROP/m);
1301 next if($_ =~ /^BEGIN TRANSACTION/m);
1302 next if($_ =~ /^COMMIT/m);
1303 next if $_ =~ /^\s+$/; # skip whitespace only
1304 $self->debugobj->query_start($_) if $self->debug;
1305 $self->dbh->do($_) or warn "SQL was:\n $_"; # XXX exceptions?
1306 $self->debugobj->query_end($_) if $self->debug;
1311 =head2 datetime_parser
1313 Returns the datetime parser class
1317 sub datetime_parser {
1319 return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1322 =head2 datetime_parser_type
1324 Defines (returns) the datetime parser class - currently hardwired to
1325 L<DateTime::Format::MySQL>
1329 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1331 =head2 build_datetime_parser
1333 See L</datetime_parser>
1337 sub build_datetime_parser {
1339 my $type = $self->datetime_parser_type(@_);
1341 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1347 return if !$self->_dbh;
1356 The module defines a set of methods within the DBIC::SQL::Abstract
1357 namespace. These build on L<SQL::Abstract::Limit> to provide the
1358 SQL query functions.
1360 The following methods are extended:-
1374 See L</connect_info> for details.
1375 For setting, this method is deprecated in favor of L</connect_info>.
1379 See L</connect_info> for details.
1380 For setting, this method is deprecated in favor of L</connect_info>.
1384 See L</connect_info> for details.
1385 For setting, this method is deprecated in favor of L</connect_info>.
1391 Matt S. Trout <mst@shadowcatsystems.co.uk>
1393 Andy Grundman <andy@hybridized.org>
1397 You may distribute this code under the same terms as Perl itself.