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 qw/blessed weaken/;
15 __PACKAGE__->mk_group_accessors('simple' =>
16 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts
17 _conn_pid _conn_tid disable_sth_caching cursor on_connect_do
18 transaction_depth unsafe/
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 This Storage driver normally installs its own C<HandleError>, sets
386 C<RaiseError> on, and sets C<PrintError> off on all database handles,
387 including those supplied by a coderef. It does this so that it can
388 have consistent and useful error behavior.
390 If you set this option to a true value, Storage will not do its usual
391 modifications to the database handle's C<RaiseError>, C<PrintError>, and
392 C<HandleError> attributes, and instead relies on the settings in your
393 connect_info DBI options (or the values you set in your connection
394 coderef, in the case that you are connecting via coderef).
396 Note that your custom settings can cause Storage to malfunction,
397 especially if you set a C<HandleError> handler that suppresses exceptions
398 and/or disable C<RaiseError>.
402 These options can be mixed in with your other L<DBI> connection attributes,
403 or placed in a seperate hashref after all other normal L<DBI> connection
406 Every time C<connect_info> is invoked, any previous settings for
407 these options will be cleared before setting the new ones, regardless of
408 whether any options are specified in the new C<connect_info>.
410 Another Important Note:
412 DBIC can do some wonderful magic with handling exceptions,
413 disconnections, and transactions when you use C<AutoCommit => 1>
414 combined with C<txn_do> for transaction support.
416 If you set C<AutoCommit => 0> in your connect info, then you are always
417 in an assumed transaction between commits, and you're telling us you'd
418 like to manage that manually. A lot of DBIC's magic protections
419 go away. We can't protect you from exceptions due to database
420 disconnects because we don't know anything about how to restart your
421 transactions. You're on your own for handling all sorts of exceptional
422 cases if you choose the C<AutoCommit => 0> path, just as you would
427 # Simple SQLite connection
428 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
431 ->connect_info([ sub { DBI->connect(...) } ]);
433 # A bit more complicated
440 { quote_char => q{"}, name_sep => q{.} },
444 # Equivalent to the previous example
450 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
454 # Subref + DBIC-specific connection options
457 sub { DBI->connect(...) },
461 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
462 disable_sth_caching => 1,
470 my ($self, $info_arg) = @_;
472 return $self->_connect_info if !$info_arg;
474 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
475 # the new set of options
476 $self->_sql_maker(undef);
477 $self->_sql_maker_opts({});
478 $self->_connect_info([@$info_arg]); # copy for _connect_info
480 my $dbi_info = [@$info_arg]; # copy for _dbi_connect_info
482 my $last_info = $dbi_info->[-1];
483 if(ref $last_info eq 'HASH') {
484 for my $storage_opt (qw/on_connect_do disable_sth_caching unsafe/) {
485 if(my $value = delete $last_info->{$storage_opt}) {
486 $self->$storage_opt($value);
489 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
490 if(my $opt_val = delete $last_info->{$sql_maker_opt}) {
491 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
495 # Get rid of any trailing empty hashref
496 pop(@$dbi_info) if !keys %$last_info;
498 $self->_dbi_connect_info($dbi_info);
500 $self->_connect_info;
505 This method is deprecated in favor of setting via L</connect_info>.
509 Arguments: $subref, @extra_coderef_args?
511 Execute the given subref using the new exception-based connection management.
513 The first two arguments will be the storage object that C<dbh_do> was called
514 on and a database handle to use. Any additional arguments will be passed
515 verbatim to the called subref as arguments 2 and onwards.
517 Using this (instead of $self->_dbh or $self->dbh) ensures correct
518 exception handling and reconnection (or failover in future subclasses).
520 Your subref should have no side-effects outside of the database, as
521 there is the potential for your subref to be partially double-executed
522 if the database connection was stale/dysfunctional.
526 my @stuff = $schema->storage->dbh_do(
528 my ($storage, $dbh, @cols) = @_;
529 my $cols = join(q{, }, @cols);
530 $dbh->selectrow_array("SELECT $cols FROM foo");
541 ref $coderef eq 'CODE' or $self->throw_exception
542 ('$coderef must be a CODE reference');
544 return $coderef->($self, $self->_dbh, @_) if $self->{_in_dbh_do}
545 || $self->{transaction_depth};
547 local $self->{_in_dbh_do} = 1;
550 my $want_array = wantarray;
553 $self->_verify_pid if $self->_dbh;
554 $self->_populate_dbh if !$self->_dbh;
556 @result = $coderef->($self, $self->_dbh, @_);
558 elsif(defined $want_array) {
559 $result[0] = $coderef->($self, $self->_dbh, @_);
562 $coderef->($self, $self->_dbh, @_);
567 if(!$exception) { return $want_array ? @result : $result[0] }
569 $self->throw_exception($exception) if $self->connected;
571 # We were not connected - reconnect and retry, but let any
572 # exception fall right through this time
573 $self->_populate_dbh;
574 $coderef->($self, $self->_dbh, @_);
577 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
578 # It also informs dbh_do to bypass itself while under the direction of txn_do,
579 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
584 ref $coderef eq 'CODE' or $self->throw_exception
585 ('$coderef must be a CODE reference');
587 local $self->{_in_dbh_do} = 1;
590 my $want_array = wantarray;
595 $self->_verify_pid if $self->_dbh;
596 $self->_populate_dbh if !$self->_dbh;
600 @result = $coderef->(@_);
602 elsif(defined $want_array) {
603 $result[0] = $coderef->(@_);
612 if(!$exception) { return $want_array ? @result : $result[0] }
614 if($tried++ > 0 || $self->connected) {
615 eval { $self->txn_rollback };
616 my $rollback_exception = $@;
617 if($rollback_exception) {
618 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
619 $self->throw_exception($exception) # propagate nested rollback
620 if $rollback_exception =~ /$exception_class/;
622 $self->throw_exception(
623 "Transaction aborted: ${exception}. "
624 . "Rollback failed: ${rollback_exception}"
627 $self->throw_exception($exception)
630 # We were not connected, and was first try - reconnect and retry
632 $self->_populate_dbh;
638 Our C<disconnect> method also performs a rollback first if the
639 database is not in C<AutoCommit> mode.
646 if( $self->connected ) {
647 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
648 $self->_dbh->disconnect;
657 if(my $dbh = $self->_dbh) {
658 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
666 return ($dbh->FETCH('Active') && $dbh->ping);
672 # handle pid changes correctly
673 # NOTE: assumes $self->_dbh is a valid $dbh
677 return if $self->_conn_pid == $$;
679 $self->_dbh->{InactiveDestroy} = 1;
686 sub ensure_connected {
689 unless ($self->connected) {
690 $self->_populate_dbh;
696 Returns the dbh - a data base handle of class L<DBI>.
703 $self->ensure_connected;
707 sub _sql_maker_args {
710 return ( bindtype=>'columns', limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
715 unless ($self->_sql_maker) {
716 $self->_sql_maker(new DBIC::SQL::Abstract( $self->_sql_maker_args ));
718 return $self->_sql_maker;
723 my @info = @{$self->_dbi_connect_info || []};
724 $self->_dbh($self->_connect(@info));
726 # Always set the transaction depth on connect, since
727 # there is no transaction in progress by definition
728 $self->{transaction_depth} = $self->_dbh->{AutoCommit} ? 0 : 1;
730 if(ref $self eq 'DBIx::Class::Storage::DBI') {
731 my $driver = $self->_dbh->{Driver}->{Name};
732 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
733 bless $self, "DBIx::Class::Storage::DBI::${driver}";
734 $self->_rebless() if $self->can('_rebless');
738 # if on-connect sql statements are given execute them
739 foreach my $sql_statement (@{$self->on_connect_do || []}) {
740 $self->debugobj->query_start($sql_statement) if $self->debug();
741 $self->_dbh->do($sql_statement);
742 $self->debugobj->query_end($sql_statement) if $self->debug();
745 $self->_conn_pid($$);
746 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
750 my ($self, @info) = @_;
752 $self->throw_exception("You failed to provide any connection info")
755 my ($old_connect_via, $dbh);
757 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
758 $old_connect_via = $DBI::connect_via;
759 $DBI::connect_via = 'connect';
763 if(ref $info[0] eq 'CODE') {
767 $dbh = DBI->connect(@info);
771 my $weak_self = $self;
773 $dbh->{HandleError} = sub {
774 $weak_self->throw_exception("DBI Exception: $_[0]")
776 $dbh->{RaiseError} = 1;
777 $dbh->{PrintError} = 0;
781 $DBI::connect_via = $old_connect_via if $old_connect_via;
783 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
792 if($self->{transaction_depth}++ == 0) {
793 $self->debugobj->txn_begin()
795 # this isn't ->_dbh-> because
796 # we should reconnect on begin_work
797 # for AutoCommit users
798 $self->dbh->begin_work;
804 if ($self->{transaction_depth} == 1) {
805 my $dbh = $self->_dbh;
806 $self->debugobj->txn_commit()
809 $self->{transaction_depth} = 0
810 if $dbh->{AutoCommit};
812 elsif($self->{transaction_depth} > 1) {
813 $self->{transaction_depth}--
819 my $dbh = $self->_dbh;
822 $autocommit = $dbh->{AutoCommit};
823 if ($self->{transaction_depth} == 1) {
824 $self->debugobj->txn_rollback()
827 $self->{transaction_depth} = 0
830 elsif($self->{transaction_depth} > 1) {
831 $self->{transaction_depth}--;
834 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
839 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
840 $error =~ /$exception_class/ and $self->throw_exception($error);
841 # ensure that a failed rollback resets the transaction depth
842 $self->{transaction_depth} = $autocommit ? 0 : 1;
843 $self->throw_exception($error);
847 # This used to be the top-half of _execute. It was split out to make it
848 # easier to override in NoBindVars without duping the rest. It takes up
849 # all of _execute's args, and emits $sql, @bind.
850 sub _prep_for_execute {
851 my ($self, $op, $extra_bind, $ident, $args) = @_;
853 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
855 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
858 return ($sql, \@bind);
862 my ($self, $dbh, $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->_prep_for_execute($op, $extra_bind, $ident, \@args);
872 map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @$bind;
873 $self->debugobj->query_start($sql, @debug_bind);
876 my $sth = $self->sth($sql,$op);
878 my $placeholder_index = 1;
880 foreach my $bound (@$bind) {
882 my($column_name, @data) = @$bound;
884 if ($bind_attributes) {
885 $attributes = $bind_attributes->{$column_name}
886 if defined $bind_attributes->{$column_name};
889 foreach my $data (@data) {
890 $data = ref $data ? ''.$data : $data; # stringify args
892 $sth->bind_param($placeholder_index, $data, $attributes);
893 $placeholder_index++;
897 # Can this fail without throwing an exception anyways???
898 my $rv = $sth->execute();
899 $self->throw_exception($sth->errstr) if !$rv;
903 map { defined ($_ && $_->[1]) ? qq{'$_->[1]'} : q{'NULL'} } @$bind;
904 $self->debugobj->query_end($sql, @debug_bind);
907 return (wantarray ? ($rv, $sth, @$bind) : $rv);
912 $self->dbh_do($self->can('_dbh_execute'), @_)
916 my ($self, $source, $to_insert) = @_;
918 my $ident = $source->from;
919 my $bind_attributes = $self->source_bind_attributes($source);
921 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
926 ## Still not quite perfect, and EXPERIMENTAL
927 ## Currently it is assumed that all values passed will be "normal", i.e. not
928 ## scalar refs, or at least, all the same type as the first set, the statement is
929 ## only prepped once.
931 my ($self, $source, $cols, $data) = @_;
933 my $table = $source->from;
934 @colvalues{@$cols} = (0..$#$cols);
935 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
938 my @debug_bind = map { defined $_->[1] ? qq{$_->[1]} : q{'NULL'} } @bind;
939 $self->debugobj->query_start($sql, @debug_bind);
941 my $sth = $self->sth($sql);
943 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
945 ## This must be an arrayref, else nothing works!
947 my $tuple_status = [];
950 ##print STDERR Dumper( $data, $sql, [@bind] );
954 ## Get the bind_attributes, if any exist
955 my $bind_attributes = $self->source_bind_attributes($source);
957 ## Bind the values and execute
958 my $placeholder_index = 1;
960 foreach my $bound (@bind) {
963 my ($column_name, $data_index) = @$bound;
965 if( $bind_attributes ) {
966 $attributes = $bind_attributes->{$column_name}
967 if defined $bind_attributes->{$column_name};
970 my @data = map { $_->[$data_index] } @$data;
972 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
973 $placeholder_index++;
975 my $rv = $sth->execute_array({ArrayTupleStatus => $tuple_status});
976 $self->throw_exception($sth->errstr) if !$rv;
979 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
980 $self->debugobj->query_end($sql, @debug_bind);
982 return (wantarray ? ($rv, $sth, @bind) : $rv);
987 my $source = shift @_;
988 my $bind_attributes = $self->source_bind_attributes($source);
990 return $self->_execute('update' => [], $source, $bind_attributes, @_);
996 my $source = shift @_;
998 my $bind_attrs = {}; ## If ever it's needed...
1000 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1004 my ($self, $ident, $select, $condition, $attrs) = @_;
1005 my $order = $attrs->{order_by};
1006 if (ref $condition eq 'SCALAR') {
1007 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
1009 if (exists $attrs->{group_by} || $attrs->{having}) {
1011 group_by => $attrs->{group_by},
1012 having => $attrs->{having},
1013 ($order ? (order_by => $order) : ())
1016 my $bind_attrs = {}; ## Future support
1017 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1018 if ($attrs->{software_limit} ||
1019 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1020 $attrs->{software_limit} = 1;
1022 $self->throw_exception("rows attribute must be positive if present")
1023 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1024 push @args, $attrs->{rows}, $attrs->{offset};
1026 return $self->_execute(@args);
1029 sub source_bind_attributes {
1030 my ($self, $source) = @_;
1032 my $bind_attributes;
1033 foreach my $column ($source->columns) {
1035 my $data_type = $source->column_info($column)->{data_type} || '';
1036 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1040 return $bind_attributes;
1047 =item Arguments: $ident, $select, $condition, $attrs
1051 Handle a SQL select statement.
1057 my ($ident, $select, $condition, $attrs) = @_;
1058 return $self->cursor->new($self, \@_, $attrs);
1063 my ($rv, $sth, @bind) = $self->_select(@_);
1064 my @row = $sth->fetchrow_array;
1065 # Need to call finish() to work round broken DBDs
1074 =item Arguments: $sql
1078 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1083 my ($self, $dbh, $sql) = @_;
1085 # 3 is the if_active parameter which avoids active sth re-use
1086 my $sth = $self->disable_sth_caching
1087 ? $dbh->prepare($sql)
1088 : $dbh->prepare_cached($sql, {}, 3);
1090 # XXX You would think RaiseError would make this impossible,
1091 # but apparently that's not true :(
1092 $self->throw_exception($dbh->errstr) if !$sth;
1098 my ($self, $sql) = @_;
1099 $self->dbh_do($self->can('_dbh_sth'), $sql);
1102 sub _dbh_columns_info_for {
1103 my ($self, $dbh, $table) = @_;
1105 if ($dbh->can('column_info')) {
1108 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1109 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1111 while ( my $info = $sth->fetchrow_hashref() ){
1113 $column_info{data_type} = $info->{TYPE_NAME};
1114 $column_info{size} = $info->{COLUMN_SIZE};
1115 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1116 $column_info{default_value} = $info->{COLUMN_DEF};
1117 my $col_name = $info->{COLUMN_NAME};
1118 $col_name =~ s/^\"(.*)\"$/$1/;
1120 $result{$col_name} = \%column_info;
1123 return \%result if !$@ && scalar keys %result;
1127 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1129 my @columns = @{$sth->{NAME_lc}};
1130 for my $i ( 0 .. $#columns ){
1132 $column_info{data_type} = $sth->{TYPE}->[$i];
1133 $column_info{size} = $sth->{PRECISION}->[$i];
1134 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1136 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1137 $column_info{data_type} = $1;
1138 $column_info{size} = $2;
1141 $result{$columns[$i]} = \%column_info;
1145 foreach my $col (keys %result) {
1146 my $colinfo = $result{$col};
1147 my $type_num = $colinfo->{data_type};
1149 if(defined $type_num && $dbh->can('type_info')) {
1150 my $type_info = $dbh->type_info($type_num);
1151 $type_name = $type_info->{TYPE_NAME} if $type_info;
1152 $colinfo->{data_type} = $type_name if $type_name;
1159 sub columns_info_for {
1160 my ($self, $table) = @_;
1161 $self->dbh_do($self->can('_dbh_columns_info_for'), $table);
1164 =head2 last_insert_id
1166 Return the row id of the last insert.
1170 sub _dbh_last_insert_id {
1171 my ($self, $dbh, $source, $col) = @_;
1172 # XXX This is a SQLite-ism as a default... is there a DBI-generic way?
1173 $dbh->func('last_insert_rowid');
1176 sub last_insert_id {
1178 $self->dbh_do($self->can('_dbh_last_insert_id'), @_);
1183 Returns the database driver name.
1187 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1189 =head2 bind_attribute_by_data_type
1191 Given a datatype from column info, returns a database specific bind attribute for
1192 $dbh->bind_param($val,$attribute) or nothing if we will let the database planner
1195 Generally only needed for special case column types, like bytea in postgres.
1199 sub bind_attribute_by_data_type {
1203 =head2 create_ddl_dir (EXPERIMENTAL)
1207 =item Arguments: $schema \@databases, $version, $directory, $preversion, $sqlt_args
1211 Creates a SQL file based on the Schema, for each of the specified
1212 database types, in the given directory.
1214 Note that this feature is currently EXPERIMENTAL and may not work correctly
1215 across all databases, or fully handle complex relationships.
1221 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1223 if(!$dir || !-d $dir)
1225 warn "No directory given, using ./\n";
1228 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1229 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1230 $version ||= $schema->VERSION || '1.x';
1231 $sqltargs = { ( add_drop_table => 1 ), %{$sqltargs || {}} };
1233 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.08: '}
1234 . $self->_check_sqlt_message . q{'})
1235 if !$self->_check_sqlt_version;
1237 my $sqlt = SQL::Translator->new({
1239 add_drop_table => 1,
1241 foreach my $db (@$databases)
1244 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1245 # $sqlt->parser_args({'DBIx::Class' => $schema);
1246 $sqlt = $self->configure_sqlt($sqlt, $db);
1247 $sqlt->data($schema);
1248 $sqlt->producer($db);
1251 my $filename = $schema->ddl_filename($db, $dir, $version);
1254 warn("$filename already exists, skipping $db");
1258 my $output = $sqlt->translate;
1261 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1264 if(!open($file, ">$filename"))
1266 $self->throw_exception("Can't open $filename for writing ($!)");
1269 print $file $output;
1274 require SQL::Translator::Diff;
1276 my $prefilename = $schema->ddl_filename($db, $dir, $preversion);
1277 # print "Previous version $prefilename\n";
1278 if(!-e $prefilename)
1280 warn("No previous schema file found ($prefilename)");
1283 #### We need to reparse the SQLite file we just wrote, so that
1284 ## Diff doesnt get all confoosed, and Diff is *very* confused.
1285 ## FIXME: rip Diff to pieces!
1286 # my $target_schema = $sqlt->schema;
1287 # unless ( $target_schema->name ) {
1288 # $target_schema->name( $filename );
1291 push @input, {file => $prefilename, parser => $db};
1292 push @input, {file => $filename, parser => $db};
1293 my ( $source_schema, $source_db, $target_schema, $target_db ) = map {
1294 my $file = $_->{'file'};
1295 my $parser = $_->{'parser'};
1297 my $t = SQL::Translator->new;
1300 $t->parser( $parser ) or die $t->error;
1301 my $out = $t->translate( $file ) or die $t->error;
1302 my $schema = $t->schema;
1303 unless ( $schema->name ) {
1304 $schema->name( $file );
1309 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1310 $target_schema, $db,
1313 my $difffile = $schema->ddl_filename($db, $dir, $version, $preversion);
1314 print STDERR "Diff: $difffile: $db, $dir, $version, $preversion \n";
1317 warn("$difffile already exists, skipping");
1320 if(!open $file, ">$difffile")
1322 $self->throw_exception("Can't write to $difffile ($!)");
1331 sub configure_sqlt() {
1334 my $db = shift || $self->sqlt_type;
1335 if ($db eq 'PostgreSQL') {
1336 $tr->quote_table_names(0);
1337 $tr->quote_field_names(0);
1342 =head2 deployment_statements
1346 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1350 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1351 The database driver name is given by C<$type>, though the value from
1352 L</sqlt_type> is used if it is not specified.
1354 C<$directory> is used to return statements from files in a previously created
1355 L</create_ddl_dir> directory and is optional. The filenames are constructed
1356 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1358 If no C<$directory> is specified then the statements are constructed on the
1359 fly using L<SQL::Translator> and C<$version> is ignored.
1361 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1365 sub deployment_statements {
1366 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1367 # Need to be connected to get the correct sqlt_type
1368 $self->ensure_connected() unless $type;
1369 $type ||= $self->sqlt_type;
1370 $version ||= $schema->VERSION || '1.x';
1372 my $filename = $schema->ddl_filename($type, $dir, $version);
1376 open($file, "<$filename")
1377 or $self->throw_exception("Can't open $filename ($!)");
1380 return join('', @rows);
1383 $self->throw_exception(q{Can't deploy without SQL::Translator 0.08: '}
1384 . $self->_check_sqlt_message . q{'})
1385 if !$self->_check_sqlt_version;
1387 require SQL::Translator::Parser::DBIx::Class;
1388 eval qq{use SQL::Translator::Producer::${type}};
1389 $self->throw_exception($@) if $@;
1391 # sources needs to be a parser arg, but for simplicty allow at top level
1393 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1394 if exists $sqltargs->{sources};
1396 my $tr = SQL::Translator->new(%$sqltargs);
1397 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1398 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1405 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1406 foreach my $statement ( $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } ) ) {
1407 for ( split(";\n", $statement)) {
1408 next if($_ =~ /^--/);
1410 # next if($_ =~ /^DROP/m);
1411 next if($_ =~ /^BEGIN TRANSACTION/m);
1412 next if($_ =~ /^COMMIT/m);
1413 next if $_ =~ /^\s+$/; # skip whitespace only
1414 $self->debugobj->query_start($_) if $self->debug;
1415 $self->dbh->do($_); # shouldn't be using ->dbh ?
1416 $self->debugobj->query_end($_) if $self->debug;
1421 =head2 datetime_parser
1423 Returns the datetime parser class
1427 sub datetime_parser {
1429 return $self->{datetime_parser} ||= $self->build_datetime_parser(@_);
1432 =head2 datetime_parser_type
1434 Defines (returns) the datetime parser class - currently hardwired to
1435 L<DateTime::Format::MySQL>
1439 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1441 =head2 build_datetime_parser
1443 See L</datetime_parser>
1447 sub build_datetime_parser {
1449 my $type = $self->datetime_parser_type(@_);
1451 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1456 my $_check_sqlt_version; # private
1457 my $_check_sqlt_message; # private
1458 sub _check_sqlt_version {
1459 return $_check_sqlt_version if defined $_check_sqlt_version;
1460 eval 'use SQL::Translator 0.08';
1461 $_check_sqlt_message = $@ ? $@ : '';
1462 $_check_sqlt_version = $@ ? 0 : 1;
1465 sub _check_sqlt_message {
1466 _check_sqlt_version if !defined $_check_sqlt_message;
1467 $_check_sqlt_message;
1473 return if !$self->_dbh;
1482 The module defines a set of methods within the DBIC::SQL::Abstract
1483 namespace. These build on L<SQL::Abstract::Limit> to provide the
1484 SQL query functions.
1486 The following methods are extended:-
1500 See L</connect_info> for details.
1501 For setting, this method is deprecated in favor of L</connect_info>.
1505 See L</connect_info> for details.
1506 For setting, this method is deprecated in favor of L</connect_info>.
1510 See L</connect_info> for details.
1511 For setting, this method is deprecated in favor of L</connect_info>.
1517 Matt S. Trout <mst@shadowcatsystems.co.uk>
1519 Andy Grundman <andy@hybridized.org>
1523 You may distribute this code under the same terms as Perl itself.