1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
4 use base 'DBIx::Class::Storage';
8 use Carp::Clan qw/^DBIx::Class/;
10 use SQL::Abstract::Limit;
11 use DBIx::Class::Storage::DBI::Cursor;
12 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 transaction_depth _dbh_autocommit savepoints/
20 # the values for these accessors are picked out (and deleted) from
21 # the attribute hashref passed to connect_info
22 my @storage_options = qw/
23 on_connect_do on_disconnect_do disable_sth_caching unsafe auto_savepoint
25 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
28 # default cursor class, overridable in connect_info attributes
29 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
31 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
32 __PACKAGE__->sql_maker_class('DBIC::SQL::Abstract');
36 package # Hide from PAUSE
37 DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
39 use base qw/SQL::Abstract::Limit/;
42 my $self = shift->SUPER::new(@_);
44 # This prevents the caching of $dbh in S::A::L, I believe
45 # If limit_dialect is a ref (like a $dbh), go ahead and replace
46 # it with what it resolves to:
47 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
48 if ref $self->{limit_dialect};
55 # Some databases (sqlite) do not handle multiple parenthesis
56 # around in/between arguments. A tentative x IN ( ( 1, 2 ,3) )
57 # is interpreted as x IN 1 or something similar.
59 # Since we currently do not have access to the SQLA AST, resort
60 # to barbaric mutilation of any SQL supplied in literal form
62 sub _strip_outer_paren {
63 my ($self, $arg) = @_;
67 return $self->_SWITCH_refkind ($arg, {
69 $$arg->[0] = __strip_outer_paren ($$arg->[0]);
73 return \__strip_outer_paren( $$arg );
81 sub __strip_outer_paren {
84 if ($sql and not ref $sql) {
85 while ($sql =~ /^ \s* \( (.*) \) \s* $/x ) {
94 my ($self, $lhs, $op, $rhs) = @_;
95 $rhs = $self->_strip_outer_paren ($rhs);
96 return $self->SUPER::_where_field_IN ($lhs, $op, $rhs);
99 sub _where_field_BETWEEN {
100 my ($self, $lhs, $op, $rhs) = @_;
101 $rhs = $self->_strip_outer_paren ($rhs);
102 return $self->SUPER::_where_field_BETWEEN ($lhs, $op, $rhs);
107 # DB2 is the only remaining DB using this. Even though we are not sure if
108 # RowNumberOver is still needed here (should be part of SQLA) leave the
111 my ($self, $sql, $order, $rows, $offset ) = @_;
114 my $last = $rows + $offset;
115 my ( $order_by ) = $self->_order_by( $order );
120 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
125 WHERE ROW_NUM BETWEEN $offset AND $last
133 # While we're at it, this should make LIMIT queries more efficient,
134 # without digging into things too deeply
135 use Scalar::Util 'blessed';
137 my ($self, $syntax) = @_;
139 # DB2 is the only remaining DB using this. Even though we are not sure if
140 # RowNumberOver is still needed here (should be part of SQLA) leave the
142 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
143 if(ref($self) && $dbhname && $dbhname eq 'DB2') {
144 return 'RowNumberOver';
147 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
151 my ($self, $table, $fields, $where, $order, @rest) = @_;
152 local $self->{having_bind} = [];
153 local $self->{from_bind} = [];
155 if (ref $table eq 'SCALAR') {
158 elsif (not ref $table) {
159 $table = $self->_quote($table);
161 local $self->{rownum_hack_count} = 1
162 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
163 @rest = (-1) unless defined $rest[0];
164 die "LIMIT 0 Does Not Compute" if $rest[0] == 0;
165 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
166 my ($sql, @where_bind) = $self->SUPER::select(
167 $table, $self->_recurse_fields($fields), $where, $order, @rest
172 $self->{for} eq 'update' ? ' FOR UPDATE' :
173 $self->{for} eq 'shared' ? ' FOR SHARE' :
178 return wantarray ? ($sql, @{$self->{from_bind}}, @where_bind, @{$self->{having_bind}}) : $sql;
184 $table = $self->_quote($table) unless ref($table);
185 $self->SUPER::insert($table, @_);
191 $table = $self->_quote($table) unless ref($table);
192 $self->SUPER::update($table, @_);
198 $table = $self->_quote($table) unless ref($table);
199 $self->SUPER::delete($table, @_);
205 return $_[1].$self->_order_by($_[2]);
207 return $self->SUPER::_emulate_limit(@_);
211 sub _recurse_fields {
212 my ($self, $fields, $params) = @_;
213 my $ref = ref $fields;
214 return $self->_quote($fields) unless $ref;
215 return $$fields if $ref eq 'SCALAR';
217 if ($ref eq 'ARRAY') {
218 return join(', ', map {
219 $self->_recurse_fields($_)
220 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
221 ? ' AS col'.$self->{rownum_hack_count}++
224 } elsif ($ref eq 'HASH') {
225 foreach my $func (keys %$fields) {
226 if ($func eq 'distinct') {
227 my $_fields = $fields->{$func};
228 if (ref $_fields eq 'ARRAY' && @{$_fields} > 1) {
229 die "Unsupported syntax, please use " .
230 "{ group_by => [ qw/" . (join ' ', @$_fields) . "/ ] }" .
232 "{ select => [ qw/" . (join ' ', @$_fields) . "/ ], distinct => 1 }";
235 warn "This syntax will be deprecated in 09, please use " .
236 "{ group_by => '${_fields}' }" .
238 "{ select => '${_fields}', distinct => 1 }";
242 return $self->_sqlcase($func)
243 .'( '.$self->_recurse_fields($fields->{$func}).' )';
246 # Is the second check absolutely necessary?
247 elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
248 return $self->_fold_sqlbind( $fields );
251 Carp::croak($ref . qq{ unexpected in _recurse_fields()})
259 if (ref $_[0] eq 'HASH') {
260 if (defined $_[0]->{group_by}) {
261 $ret = $self->_sqlcase(' group by ')
262 .$self->_recurse_fields($_[0]->{group_by}, { no_rownum_hack => 1 });
264 if (defined $_[0]->{having}) {
266 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
267 push(@{$self->{having_bind}}, @extra);
268 $ret .= $self->_sqlcase(' having ').$frag;
270 if (defined $_[0]->{order_by}) {
271 $ret .= $self->_order_by($_[0]->{order_by});
273 if (grep { $_ =~ /^-(desc|asc)/i } keys %{$_[0]}) {
274 return $self->SUPER::_order_by($_[0]);
276 } elsif (ref $_[0] eq 'SCALAR') {
277 $ret = $self->_sqlcase(' order by ').${ $_[0] };
278 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
279 my @order = @{+shift};
280 $ret = $self->_sqlcase(' order by ')
282 my $r = $self->_order_by($_, @_);
283 $r =~ s/^ ?ORDER BY //i;
287 $ret = $self->SUPER::_order_by(@_);
292 sub _order_directions {
293 my ($self, $order) = @_;
294 $order = $order->{order_by} if ref $order eq 'HASH';
295 return $self->SUPER::_order_directions($order);
299 my ($self, $from) = @_;
300 if (ref $from eq 'ARRAY') {
301 return $self->_recurse_from(@$from);
302 } elsif (ref $from eq 'HASH') {
303 return $self->_make_as($from);
305 return $from; # would love to quote here but _table ends up getting called
306 # twice during an ->select without a limit clause due to
307 # the way S::A::Limit->select works. should maybe consider
308 # bypassing this and doing S::A::select($self, ...) in
309 # our select method above. meantime, quoting shims have
310 # been added to select/insert/update/delete here
315 my ($self, $from, @join) = @_;
317 push(@sqlf, $self->_make_as($from));
318 foreach my $j (@join) {
321 # check whether a join type exists
322 my $join_clause = '';
323 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
324 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
325 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
327 $join_clause = ' JOIN ';
329 push(@sqlf, $join_clause);
331 if (ref $to eq 'ARRAY') {
332 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
334 push(@sqlf, $self->_make_as($to));
336 push(@sqlf, ' ON ', $self->_join_condition($on));
338 return join('', @sqlf);
342 my ($self, $sqlbind) = @_;
343 my $sql = shift @$$sqlbind;
344 push @{$self->{from_bind}}, @$$sqlbind;
349 my ($self, $from) = @_;
350 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_
351 : ref $_ eq 'REF' ? $self->_fold_sqlbind($_)
353 } reverse each %{$self->_skip_options($from)});
357 my ($self, $hash) = @_;
359 $clean_hash->{$_} = $hash->{$_}
360 for grep {!/^-/} keys %$hash;
364 sub _join_condition {
365 my ($self, $cond) = @_;
366 if (ref $cond eq 'HASH') {
371 # XXX no throw_exception() in this package and croak() fails with strange results
372 Carp::croak(ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
373 if ref($v) ne 'SCALAR';
377 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
380 return scalar($self->_recurse_where(\%j));
381 } elsif (ref $cond eq 'ARRAY') {
382 return join(' OR ', map { $self->_join_condition($_) } @$cond);
384 die "Can't handle this yet!";
389 my ($self, $label) = @_;
390 return '' unless defined $label;
391 return "*" if $label eq '*';
392 return $label unless $self->{quote_char};
393 if(ref $self->{quote_char} eq "ARRAY"){
394 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
395 if !defined $self->{name_sep};
396 my $sep = $self->{name_sep};
397 return join($self->{name_sep},
398 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
399 split(/\Q$sep\E/,$label));
401 return $self->SUPER::_quote($label);
406 $self->{limit_dialect} = shift if @_;
407 return $self->{limit_dialect};
412 $self->{quote_char} = shift if @_;
413 return $self->{quote_char};
418 $self->{name_sep} = shift if @_;
419 return $self->{name_sep};
422 } # End of BEGIN block
426 DBIx::Class::Storage::DBI - DBI storage handler
430 my $schema = MySchema->connect('dbi:SQLite:my.db');
432 $schema->storage->debug(1);
433 $schema->dbh_do("DROP TABLE authors");
435 $schema->resultset('Book')->search({
436 written_on => $schema->storage->datetime_parser(DateTime->now)
441 This class represents the connection to an RDBMS via L<DBI>. See
442 L<DBIx::Class::Storage> for general information. This pod only
443 documents DBI-specific methods and behaviors.
450 my $new = shift->next::method(@_);
452 $new->transaction_depth(0);
453 $new->_sql_maker_opts({});
454 $new->{savepoints} = [];
455 $new->{_in_dbh_do} = 0;
456 $new->{_dbh_gen} = 0;
463 This method is normally called by L<DBIx::Class::Schema/connection>, which
464 encapsulates its argument list in an arrayref before passing them here.
466 The argument list may contain:
472 The same 4-element argument set one would normally pass to
473 L<DBI/connect>, optionally followed by
474 L<extra attributes|/DBIx::Class specific connection attributes>
475 recognized by DBIx::Class:
477 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
481 A single code reference which returns a connected
482 L<DBI database handle|DBI/connect> optionally followed by
483 L<extra attributes|/DBIx::Class specific connection attributes> recognized
486 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
490 A single hashref with all the attributes and the dsn/user/password
493 $connect_info_args = [{
501 This is particularly useful for L<Catalyst> based applications, allowing the
502 following config (L<Config::General> style):
507 dsn dbi:mysql:database=test
516 Please note that the L<DBI> docs recommend that you always explicitly
517 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
518 recommends that it be set to I<1>, and that you perform transactions
519 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
520 to I<1> if you do not do explicitly set it to zero. This is the default
521 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
523 =head3 DBIx::Class specific connection attributes
525 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
526 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
527 the following connection options. These options can be mixed in with your other
528 L<DBI> connection attributes, or placed in a seperate hashref
529 (C<\%extra_attributes>) as shown above.
531 Every time C<connect_info> is invoked, any previous settings for
532 these options will be cleared before setting the new ones, regardless of
533 whether any options are specified in the new C<connect_info>.
540 Specifies things to do immediately after connecting or re-connecting to
541 the database. Its value may contain:
545 =item an array reference
547 This contains SQL statements to execute in order. Each element contains
548 a string or a code reference that returns a string.
550 =item a code reference
552 This contains some code to execute. Unlike code references within an
553 array reference, its return value is ignored.
557 =item on_disconnect_do
559 Takes arguments in the same form as L</on_connect_do> and executes them
560 immediately before disconnecting from the database.
562 Note, this only runs if you explicitly call L</disconnect> on the
565 =item disable_sth_caching
567 If set to a true value, this option will disable the caching of
568 statement handles via L<DBI/prepare_cached>.
572 Sets the limit dialect. This is useful for JDBC-bridge among others
573 where the remote SQL-dialect cannot be determined by the name of the
574 driver alone. See also L<SQL::Abstract::Limit>.
578 Specifies what characters to use to quote table and column names. If
579 you use this you will want to specify L</name_sep> as well.
581 C<quote_char> expects either a single character, in which case is it
582 is placed on either side of the table/column name, or an arrayref of length
583 2 in which case the table/column name is placed between the elements.
585 For example under MySQL you should use C<< quote_char => '`' >>, and for
586 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
590 This only needs to be used in conjunction with C<quote_char>, and is used to
591 specify the charecter that seperates elements (schemas, tables, columns) from
592 each other. In most cases this is simply a C<.>.
594 The consequences of not supplying this value is that L<SQL::Abstract>
595 will assume DBIx::Class' uses of aliases to be complete column
596 names. The output will look like I<"me.name"> when it should actually
601 This Storage driver normally installs its own C<HandleError>, sets
602 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
603 all database handles, including those supplied by a coderef. It does this
604 so that it can have consistent and useful error behavior.
606 If you set this option to a true value, Storage will not do its usual
607 modifications to the database handle's attributes, and instead relies on
608 the settings in your connect_info DBI options (or the values you set in
609 your connection coderef, in the case that you are connecting via coderef).
611 Note that your custom settings can cause Storage to malfunction,
612 especially if you set a C<HandleError> handler that suppresses exceptions
613 and/or disable C<RaiseError>.
617 If this option is true, L<DBIx::Class> will use savepoints when nesting
618 transactions, making it possible to recover from failure in the inner
619 transaction without having to abort all outer transactions.
623 Use this argument to supply a cursor class other than the default
624 L<DBIx::Class::Storage::DBI::Cursor>.
628 Some real-life examples of arguments to L</connect_info> and
629 L<DBIx::Class::Schema/connect>
631 # Simple SQLite connection
632 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
635 ->connect_info([ sub { DBI->connect(...) } ]);
637 # A bit more complicated
644 { quote_char => q{"}, name_sep => q{.} },
648 # Equivalent to the previous example
654 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
658 # Same, but with hashref as argument
659 # See parse_connect_info for explanation
662 dsn => 'dbi:Pg:dbname=foo',
664 password => 'my_pg_password',
671 # Subref + DBIx::Class-specific connection options
674 sub { DBI->connect(...) },
678 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
679 disable_sth_caching => 1,
689 my ($self, $info_arg) = @_;
691 return $self->_connect_info if !$info_arg;
693 my @args = @$info_arg; # take a shallow copy for further mutilation
694 $self->_connect_info([@args]); # copy for _connect_info
697 # combine/pre-parse arguments depending on invocation style
700 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
701 %attrs = %{ $args[1] || {} };
704 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
705 %attrs = %{$args[0]};
707 for (qw/password user dsn/) {
708 unshift @args, delete $attrs{$_};
711 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
713 % { $args[3] || {} },
714 % { $args[4] || {} },
716 @args = @args[0,1,2];
719 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
720 # the new set of options
721 $self->_sql_maker(undef);
722 $self->_sql_maker_opts({});
725 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
726 if(my $value = delete $attrs{$storage_opt}) {
727 $self->$storage_opt($value);
730 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
731 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
732 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
737 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
739 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
740 $self->_connect_info;
745 This method is deprecated in favour of setting via L</connect_info>.
750 Arguments: ($subref | $method_name), @extra_coderef_args?
752 Execute the given $subref or $method_name using the new exception-based
753 connection management.
755 The first two arguments will be the storage object that C<dbh_do> was called
756 on and a database handle to use. Any additional arguments will be passed
757 verbatim to the called subref as arguments 2 and onwards.
759 Using this (instead of $self->_dbh or $self->dbh) ensures correct
760 exception handling and reconnection (or failover in future subclasses).
762 Your subref should have no side-effects outside of the database, as
763 there is the potential for your subref to be partially double-executed
764 if the database connection was stale/dysfunctional.
768 my @stuff = $schema->storage->dbh_do(
770 my ($storage, $dbh, @cols) = @_;
771 my $cols = join(q{, }, @cols);
772 $dbh->selectrow_array("SELECT $cols FROM foo");
783 my $dbh = $self->_dbh;
785 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
786 || $self->{transaction_depth};
788 local $self->{_in_dbh_do} = 1;
791 my $want_array = wantarray;
794 $self->_verify_pid if $dbh;
796 $self->_populate_dbh;
801 @result = $self->$code($dbh, @_);
803 elsif(defined $want_array) {
804 $result[0] = $self->$code($dbh, @_);
807 $self->$code($dbh, @_);
812 if(!$exception) { return $want_array ? @result : $result[0] }
814 $self->throw_exception($exception) if $self->connected;
816 # We were not connected - reconnect and retry, but let any
817 # exception fall right through this time
818 $self->_populate_dbh;
819 $self->$code($self->_dbh, @_);
822 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
823 # It also informs dbh_do to bypass itself while under the direction of txn_do,
824 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
829 ref $coderef eq 'CODE' or $self->throw_exception
830 ('$coderef must be a CODE reference');
832 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
834 local $self->{_in_dbh_do} = 1;
837 my $want_array = wantarray;
842 $self->_verify_pid if $self->_dbh;
843 $self->_populate_dbh if !$self->_dbh;
847 @result = $coderef->(@_);
849 elsif(defined $want_array) {
850 $result[0] = $coderef->(@_);
859 if(!$exception) { return $want_array ? @result : $result[0] }
861 if($tried++ > 0 || $self->connected) {
862 eval { $self->txn_rollback };
863 my $rollback_exception = $@;
864 if($rollback_exception) {
865 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
866 $self->throw_exception($exception) # propagate nested rollback
867 if $rollback_exception =~ /$exception_class/;
869 $self->throw_exception(
870 "Transaction aborted: ${exception}. "
871 . "Rollback failed: ${rollback_exception}"
874 $self->throw_exception($exception)
877 # We were not connected, and was first try - reconnect and retry
879 $self->_populate_dbh;
885 Our C<disconnect> method also performs a rollback first if the
886 database is not in C<AutoCommit> mode.
893 if( $self->connected ) {
894 my $connection_do = $self->on_disconnect_do;
895 $self->_do_connection_actions($connection_do) if ref($connection_do);
897 $self->_dbh->rollback unless $self->_dbh_autocommit;
898 $self->_dbh->disconnect;
904 =head2 with_deferred_fk_checks
908 =item Arguments: C<$coderef>
910 =item Return Value: The return value of $coderef
914 Storage specific method to run the code ref with FK checks deferred or
915 in MySQL's case disabled entirely.
919 # Storage subclasses should override this
920 sub with_deferred_fk_checks {
921 my ($self, $sub) = @_;
929 if(my $dbh = $self->_dbh) {
930 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
937 return 0 if !$self->_dbh;
939 return ($dbh->FETCH('Active') && $dbh->ping);
945 # handle pid changes correctly
946 # NOTE: assumes $self->_dbh is a valid $dbh
950 return if defined $self->_conn_pid && $self->_conn_pid == $$;
952 $self->_dbh->{InactiveDestroy} = 1;
959 sub ensure_connected {
962 unless ($self->connected) {
963 $self->_populate_dbh;
969 Returns the dbh - a data base handle of class L<DBI>.
976 $self->ensure_connected;
980 sub _sql_maker_args {
983 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
988 unless ($self->_sql_maker) {
989 my $sql_maker_class = $self->sql_maker_class;
990 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
992 return $self->_sql_maker;
999 my @info = @{$self->_dbi_connect_info || []};
1000 $self->_dbh($self->_connect(@info));
1002 # Always set the transaction depth on connect, since
1003 # there is no transaction in progress by definition
1004 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1006 if(ref $self eq 'DBIx::Class::Storage::DBI') {
1007 my $driver = $self->_dbh->{Driver}->{Name};
1008 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
1009 bless $self, "DBIx::Class::Storage::DBI::${driver}";
1014 $self->_conn_pid($$);
1015 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
1017 my $connection_do = $self->on_connect_do;
1018 $self->_do_connection_actions($connection_do) if ref($connection_do);
1021 sub _do_connection_actions {
1023 my $connection_do = shift;
1025 if (ref $connection_do eq 'ARRAY') {
1026 $self->_do_query($_) foreach @$connection_do;
1028 elsif (ref $connection_do eq 'CODE') {
1029 $connection_do->($self);
1036 my ($self, $action) = @_;
1038 if (ref $action eq 'CODE') {
1039 $action = $action->($self);
1040 $self->_do_query($_) foreach @$action;
1043 # Most debuggers expect ($sql, @bind), so we need to exclude
1044 # the attribute hash which is the second argument to $dbh->do
1045 # furthermore the bind values are usually to be presented
1046 # as named arrayref pairs, so wrap those here too
1047 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1048 my $sql = shift @do_args;
1049 my $attrs = shift @do_args;
1050 my @bind = map { [ undef, $_ ] } @do_args;
1052 $self->_query_start($sql, @bind);
1053 $self->_dbh->do($sql, $attrs, @do_args);
1054 $self->_query_end($sql, @bind);
1061 my ($self, @info) = @_;
1063 $self->throw_exception("You failed to provide any connection info")
1066 my ($old_connect_via, $dbh);
1068 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1069 $old_connect_via = $DBI::connect_via;
1070 $DBI::connect_via = 'connect';
1074 if(ref $info[0] eq 'CODE') {
1078 $dbh = DBI->connect(@info);
1081 if($dbh && !$self->unsafe) {
1082 my $weak_self = $self;
1084 $dbh->{HandleError} = sub {
1086 $weak_self->throw_exception("DBI Exception: $_[0]");
1089 croak ("DBI Exception: $_[0]");
1092 $dbh->{ShowErrorStatement} = 1;
1093 $dbh->{RaiseError} = 1;
1094 $dbh->{PrintError} = 0;
1098 $DBI::connect_via = $old_connect_via if $old_connect_via;
1100 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
1103 $self->_dbh_autocommit($dbh->{AutoCommit});
1109 my ($self, $name) = @_;
1111 $name = $self->_svp_generate_name
1112 unless defined $name;
1114 $self->throw_exception ("You can't use savepoints outside a transaction")
1115 if $self->{transaction_depth} == 0;
1117 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1118 unless $self->can('_svp_begin');
1120 push @{ $self->{savepoints} }, $name;
1122 $self->debugobj->svp_begin($name) if $self->debug;
1124 return $self->_svp_begin($name);
1128 my ($self, $name) = @_;
1130 $self->throw_exception ("You can't use savepoints outside a transaction")
1131 if $self->{transaction_depth} == 0;
1133 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1134 unless $self->can('_svp_release');
1136 if (defined $name) {
1137 $self->throw_exception ("Savepoint '$name' does not exist")
1138 unless grep { $_ eq $name } @{ $self->{savepoints} };
1140 # Dig through the stack until we find the one we are releasing. This keeps
1141 # the stack up to date.
1144 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1146 $name = pop @{ $self->{savepoints} };
1149 $self->debugobj->svp_release($name) if $self->debug;
1151 return $self->_svp_release($name);
1155 my ($self, $name) = @_;
1157 $self->throw_exception ("You can't use savepoints outside a transaction")
1158 if $self->{transaction_depth} == 0;
1160 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1161 unless $self->can('_svp_rollback');
1163 if (defined $name) {
1164 # If they passed us a name, verify that it exists in the stack
1165 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1166 $self->throw_exception("Savepoint '$name' does not exist!");
1169 # Dig through the stack until we find the one we are releasing. This keeps
1170 # the stack up to date.
1171 while(my $s = pop(@{ $self->{savepoints} })) {
1172 last if($s eq $name);
1174 # Add the savepoint back to the stack, as a rollback doesn't remove the
1175 # named savepoint, only everything after it.
1176 push(@{ $self->{savepoints} }, $name);
1178 # We'll assume they want to rollback to the last savepoint
1179 $name = $self->{savepoints}->[-1];
1182 $self->debugobj->svp_rollback($name) if $self->debug;
1184 return $self->_svp_rollback($name);
1187 sub _svp_generate_name {
1190 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1195 $self->ensure_connected();
1196 if($self->{transaction_depth} == 0) {
1197 $self->debugobj->txn_begin()
1199 # this isn't ->_dbh-> because
1200 # we should reconnect on begin_work
1201 # for AutoCommit users
1202 $self->dbh->begin_work;
1203 } elsif ($self->auto_savepoint) {
1206 $self->{transaction_depth}++;
1211 if ($self->{transaction_depth} == 1) {
1212 my $dbh = $self->_dbh;
1213 $self->debugobj->txn_commit()
1216 $self->{transaction_depth} = 0
1217 if $self->_dbh_autocommit;
1219 elsif($self->{transaction_depth} > 1) {
1220 $self->{transaction_depth}--;
1222 if $self->auto_savepoint;
1228 my $dbh = $self->_dbh;
1230 if ($self->{transaction_depth} == 1) {
1231 $self->debugobj->txn_rollback()
1233 $self->{transaction_depth} = 0
1234 if $self->_dbh_autocommit;
1237 elsif($self->{transaction_depth} > 1) {
1238 $self->{transaction_depth}--;
1239 if ($self->auto_savepoint) {
1240 $self->svp_rollback;
1245 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1250 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1251 $error =~ /$exception_class/ and $self->throw_exception($error);
1252 # ensure that a failed rollback resets the transaction depth
1253 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1254 $self->throw_exception($error);
1258 # This used to be the top-half of _execute. It was split out to make it
1259 # easier to override in NoBindVars without duping the rest. It takes up
1260 # all of _execute's args, and emits $sql, @bind.
1261 sub _prep_for_execute {
1262 my ($self, $op, $extra_bind, $ident, $args) = @_;
1264 if( blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1265 $ident = $ident->from();
1268 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1271 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1273 return ($sql, \@bind);
1276 sub _fix_bind_params {
1277 my ($self, @bind) = @_;
1279 ### Turn @bind from something like this:
1280 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1282 ### ( "'1'", "'1'", "'3'" )
1285 if ( defined( $_ && $_->[1] ) ) {
1286 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1293 my ( $self, $sql, @bind ) = @_;
1295 if ( $self->debug ) {
1296 @bind = $self->_fix_bind_params(@bind);
1298 $self->debugobj->query_start( $sql, @bind );
1303 my ( $self, $sql, @bind ) = @_;
1305 if ( $self->debug ) {
1306 @bind = $self->_fix_bind_params(@bind);
1307 $self->debugobj->query_end( $sql, @bind );
1312 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1314 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1316 $self->_query_start( $sql, @$bind );
1318 my $sth = $self->sth($sql,$op);
1320 my $placeholder_index = 1;
1322 foreach my $bound (@$bind) {
1323 my $attributes = {};
1324 my($column_name, @data) = @$bound;
1326 if ($bind_attributes) {
1327 $attributes = $bind_attributes->{$column_name}
1328 if defined $bind_attributes->{$column_name};
1331 foreach my $data (@data) {
1332 my $ref = ref $data;
1333 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1335 $sth->bind_param($placeholder_index, $data, $attributes);
1336 $placeholder_index++;
1340 # Can this fail without throwing an exception anyways???
1341 my $rv = $sth->execute();
1342 $self->throw_exception($sth->errstr) if !$rv;
1344 $self->_query_end( $sql, @$bind );
1346 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1351 $self->dbh_do('_dbh_execute', @_)
1355 my ($self, $source, $to_insert) = @_;
1357 my $ident = $source->from;
1358 my $bind_attributes = $self->source_bind_attributes($source);
1360 my $updated_cols = {};
1362 $self->ensure_connected;
1363 foreach my $col ( $source->columns ) {
1364 if ( !defined $to_insert->{$col} ) {
1365 my $col_info = $source->column_info($col);
1367 if ( $col_info->{auto_nextval} ) {
1368 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1373 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1375 return $updated_cols;
1378 ## Still not quite perfect, and EXPERIMENTAL
1379 ## Currently it is assumed that all values passed will be "normal", i.e. not
1380 ## scalar refs, or at least, all the same type as the first set, the statement is
1381 ## only prepped once.
1383 my ($self, $source, $cols, $data) = @_;
1385 my $table = $source->from;
1386 @colvalues{@$cols} = (0..$#$cols);
1387 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1389 $self->_query_start( $sql, @bind );
1390 my $sth = $self->sth($sql);
1392 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1394 ## This must be an arrayref, else nothing works!
1396 my $tuple_status = [];
1399 ##print STDERR Dumper( $data, $sql, [@bind] );
1403 ## Get the bind_attributes, if any exist
1404 my $bind_attributes = $self->source_bind_attributes($source);
1406 ## Bind the values and execute
1407 my $placeholder_index = 1;
1409 foreach my $bound (@bind) {
1411 my $attributes = {};
1412 my ($column_name, $data_index) = @$bound;
1414 if( $bind_attributes ) {
1415 $attributes = $bind_attributes->{$column_name}
1416 if defined $bind_attributes->{$column_name};
1419 my @data = map { $_->[$data_index] } @$data;
1421 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1422 $placeholder_index++;
1424 my $rv = $sth->execute_array({ArrayTupleStatus => $tuple_status});
1425 $self->throw_exception($sth->errstr) if !$rv;
1427 $self->_query_end( $sql, @bind );
1428 return (wantarray ? ($rv, $sth, @bind) : $rv);
1432 my $self = shift @_;
1433 my $source = shift @_;
1434 my $bind_attributes = $self->source_bind_attributes($source);
1436 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1441 my $self = shift @_;
1442 my $source = shift @_;
1444 my $bind_attrs = {}; ## If ever it's needed...
1446 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1451 my $sql_maker = $self->sql_maker;
1452 local $sql_maker->{for};
1453 return $self->_execute($self->_select_args(@_));
1457 my ($self, $ident, $select, $condition, $attrs) = @_;
1458 my $order = $attrs->{order_by};
1460 my $for = delete $attrs->{for};
1461 my $sql_maker = $self->sql_maker;
1462 $sql_maker->{for} = $for;
1464 if (exists $attrs->{group_by} || $attrs->{having}) {
1466 group_by => $attrs->{group_by},
1467 having => $attrs->{having},
1468 ($order ? (order_by => $order) : ())
1471 my $bind_attrs = {}; ## Future support
1472 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1473 if ($attrs->{software_limit} ||
1474 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
1475 $attrs->{software_limit} = 1;
1477 $self->throw_exception("rows attribute must be positive if present")
1478 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1480 # MySQL actually recommends this approach. I cringe.
1481 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1482 push @args, $attrs->{rows}, $attrs->{offset};
1487 sub source_bind_attributes {
1488 my ($self, $source) = @_;
1490 my $bind_attributes;
1491 foreach my $column ($source->columns) {
1493 my $data_type = $source->column_info($column)->{data_type} || '';
1494 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1498 return $bind_attributes;
1505 =item Arguments: $ident, $select, $condition, $attrs
1509 Handle a SQL select statement.
1515 my ($ident, $select, $condition, $attrs) = @_;
1516 return $self->cursor_class->new($self, \@_, $attrs);
1521 my ($rv, $sth, @bind) = $self->_select(@_);
1522 my @row = $sth->fetchrow_array;
1523 my @nextrow = $sth->fetchrow_array if @row;
1524 if(@row && @nextrow) {
1525 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1527 # Need to call finish() to work round broken DBDs
1536 =item Arguments: $sql
1540 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1545 my ($self, $dbh, $sql) = @_;
1547 # 3 is the if_active parameter which avoids active sth re-use
1548 my $sth = $self->disable_sth_caching
1549 ? $dbh->prepare($sql)
1550 : $dbh->prepare_cached($sql, {}, 3);
1552 # XXX You would think RaiseError would make this impossible,
1553 # but apparently that's not true :(
1554 $self->throw_exception($dbh->errstr) if !$sth;
1560 my ($self, $sql) = @_;
1561 $self->dbh_do('_dbh_sth', $sql);
1564 sub _dbh_columns_info_for {
1565 my ($self, $dbh, $table) = @_;
1567 if ($dbh->can('column_info')) {
1570 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1571 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1573 while ( my $info = $sth->fetchrow_hashref() ){
1575 $column_info{data_type} = $info->{TYPE_NAME};
1576 $column_info{size} = $info->{COLUMN_SIZE};
1577 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1578 $column_info{default_value} = $info->{COLUMN_DEF};
1579 my $col_name = $info->{COLUMN_NAME};
1580 $col_name =~ s/^\"(.*)\"$/$1/;
1582 $result{$col_name} = \%column_info;
1585 return \%result if !$@ && scalar keys %result;
1589 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1591 my @columns = @{$sth->{NAME_lc}};
1592 for my $i ( 0 .. $#columns ){
1594 $column_info{data_type} = $sth->{TYPE}->[$i];
1595 $column_info{size} = $sth->{PRECISION}->[$i];
1596 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1598 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1599 $column_info{data_type} = $1;
1600 $column_info{size} = $2;
1603 $result{$columns[$i]} = \%column_info;
1607 foreach my $col (keys %result) {
1608 my $colinfo = $result{$col};
1609 my $type_num = $colinfo->{data_type};
1611 if(defined $type_num && $dbh->can('type_info')) {
1612 my $type_info = $dbh->type_info($type_num);
1613 $type_name = $type_info->{TYPE_NAME} if $type_info;
1614 $colinfo->{data_type} = $type_name if $type_name;
1621 sub columns_info_for {
1622 my ($self, $table) = @_;
1623 $self->dbh_do('_dbh_columns_info_for', $table);
1626 =head2 last_insert_id
1628 Return the row id of the last insert.
1632 sub _dbh_last_insert_id {
1633 # All Storage's need to register their own _dbh_last_insert_id
1634 # the old SQLite-based method was highly inappropriate
1637 my $class = ref $self;
1638 $self->throw_exception (<<EOE);
1640 No _dbh_last_insert_id() method found in $class.
1641 Since the method of obtaining the autoincrement id of the last insert
1642 operation varies greatly between different databases, this method must be
1643 individually implemented for every storage class.
1647 sub last_insert_id {
1649 $self->dbh_do('_dbh_last_insert_id', @_);
1654 Returns the database driver name.
1658 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1660 =head2 bind_attribute_by_data_type
1662 Given a datatype from column info, returns a database specific bind
1663 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1664 let the database planner just handle it.
1666 Generally only needed for special case column types, like bytea in postgres.
1670 sub bind_attribute_by_data_type {
1674 =head2 create_ddl_dir
1678 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1682 Creates a SQL file based on the Schema, for each of the specified
1683 database types, in the given directory.
1685 By default, C<\%sqlt_args> will have
1687 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1689 merged with the hash passed in. To disable any of those features, pass in a
1690 hashref like the following
1692 { ignore_constraint_names => 0, # ... other options }
1696 sub create_ddl_dir {
1697 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1699 if(!$dir || !-d $dir) {
1700 warn "No directory given, using ./\n";
1703 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1704 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1706 my $schema_version = $schema->schema_version || '1.x';
1707 $version ||= $schema_version;
1710 add_drop_table => 1,
1711 ignore_constraint_names => 1,
1712 ignore_index_names => 1,
1716 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1717 . $self->_check_sqlt_message . q{'})
1718 if !$self->_check_sqlt_version;
1720 my $sqlt = SQL::Translator->new( $sqltargs );
1722 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1723 my $sqlt_schema = $sqlt->translate({ data => $schema }) or die $sqlt->error;
1725 foreach my $db (@$databases) {
1727 $sqlt->{schema} = $sqlt_schema;
1728 $sqlt->producer($db);
1731 my $filename = $schema->ddl_filename($db, $version, $dir);
1732 if (-e $filename && ($version eq $schema_version )) {
1733 # if we are dumping the current version, overwrite the DDL
1734 warn "Overwriting existing DDL file - $filename";
1738 my $output = $sqlt->translate;
1740 warn("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1743 if(!open($file, ">$filename")) {
1744 $self->throw_exception("Can't open $filename for writing ($!)");
1747 print $file $output;
1750 next unless ($preversion);
1752 require SQL::Translator::Diff;
1754 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1755 if(!-e $prefilename) {
1756 warn("No previous schema file found ($prefilename)");
1760 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1762 warn("Overwriting existing diff file - $difffile");
1768 my $t = SQL::Translator->new($sqltargs);
1771 $t->parser( $db ) or die $t->error;
1772 my $out = $t->translate( $prefilename ) or die $t->error;
1773 $source_schema = $t->schema;
1774 unless ( $source_schema->name ) {
1775 $source_schema->name( $prefilename );
1779 # The "new" style of producers have sane normalization and can support
1780 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1781 # And we have to diff parsed SQL against parsed SQL.
1782 my $dest_schema = $sqlt_schema;
1784 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1785 my $t = SQL::Translator->new($sqltargs);
1788 $t->parser( $db ) or die $t->error;
1789 my $out = $t->translate( $filename ) or die $t->error;
1790 $dest_schema = $t->schema;
1791 $dest_schema->name( $filename )
1792 unless $dest_schema->name;
1795 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1799 if(!open $file, ">$difffile") {
1800 $self->throw_exception("Can't write to $difffile ($!)");
1808 =head2 deployment_statements
1812 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1816 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1817 The database driver name is given by C<$type>, though the value from
1818 L</sqlt_type> is used if it is not specified.
1820 C<$directory> is used to return statements from files in a previously created
1821 L</create_ddl_dir> directory and is optional. The filenames are constructed
1822 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1824 If no C<$directory> is specified then the statements are constructed on the
1825 fly using L<SQL::Translator> and C<$version> is ignored.
1827 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1831 sub deployment_statements {
1832 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1833 # Need to be connected to get the correct sqlt_type
1834 $self->ensure_connected() unless $type;
1835 $type ||= $self->sqlt_type;
1836 $version ||= $schema->schema_version || '1.x';
1838 my $filename = $schema->ddl_filename($type, $version, $dir);
1842 open($file, "<$filename")
1843 or $self->throw_exception("Can't open $filename ($!)");
1846 return join('', @rows);
1849 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
1850 . $self->_check_sqlt_message . q{'})
1851 if !$self->_check_sqlt_version;
1853 require SQL::Translator::Parser::DBIx::Class;
1854 eval qq{use SQL::Translator::Producer::${type}};
1855 $self->throw_exception($@) if $@;
1857 # sources needs to be a parser arg, but for simplicty allow at top level
1859 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1860 if exists $sqltargs->{sources};
1862 my $tr = SQL::Translator->new(%$sqltargs);
1863 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1864 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1868 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1871 return if($line =~ /^--/);
1873 # next if($line =~ /^DROP/m);
1874 return if($line =~ /^BEGIN TRANSACTION/m);
1875 return if($line =~ /^COMMIT/m);
1876 return if $line =~ /^\s+$/; # skip whitespace only
1877 $self->_query_start($line);
1879 $self->dbh->do($line); # shouldn't be using ->dbh ?
1882 warn qq{$@ (running "${line}")};
1884 $self->_query_end($line);
1886 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { no_comments => 1, %{ $sqltargs || {} } } );
1887 if (@statements > 1) {
1888 foreach my $statement (@statements) {
1889 $deploy->( $statement );
1892 elsif (@statements == 1) {
1893 foreach my $line ( split(";\n", $statements[0])) {
1899 =head2 datetime_parser
1901 Returns the datetime parser class
1905 sub datetime_parser {
1907 return $self->{datetime_parser} ||= do {
1908 $self->ensure_connected;
1909 $self->build_datetime_parser(@_);
1913 =head2 datetime_parser_type
1915 Defines (returns) the datetime parser class - currently hardwired to
1916 L<DateTime::Format::MySQL>
1920 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1922 =head2 build_datetime_parser
1924 See L</datetime_parser>
1928 sub build_datetime_parser {
1930 my $type = $self->datetime_parser_type(@_);
1932 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1937 my $_check_sqlt_version; # private
1938 my $_check_sqlt_message; # private
1939 sub _check_sqlt_version {
1940 return $_check_sqlt_version if defined $_check_sqlt_version;
1941 eval 'use SQL::Translator "0.09003"';
1942 $_check_sqlt_message = $@ || '';
1943 $_check_sqlt_version = !$@;
1946 sub _check_sqlt_message {
1947 _check_sqlt_version if !defined $_check_sqlt_message;
1948 $_check_sqlt_message;
1952 =head2 is_replicating
1954 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
1955 replicate from a master database. Default is undef, which is the result
1956 returned by databases that don't support replication.
1960 sub is_replicating {
1965 =head2 lag_behind_master
1967 Returns a number that represents a certain amount of lag behind a master db
1968 when a given storage is replicating. The number is database dependent, but
1969 starts at zero and increases with the amount of lag. Default in undef
1973 sub lag_behind_master {
1979 return if !$self->_dbh;
1988 =head2 DBIx::Class and AutoCommit
1990 DBIx::Class can do some wonderful magic with handling exceptions,
1991 disconnections, and transactions when you use C<< AutoCommit => 1 >>
1992 combined with C<txn_do> for transaction support.
1994 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
1995 in an assumed transaction between commits, and you're telling us you'd
1996 like to manage that manually. A lot of the magic protections offered by
1997 this module will go away. We can't protect you from exceptions due to database
1998 disconnects because we don't know anything about how to restart your
1999 transactions. You're on your own for handling all sorts of exceptional
2000 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2006 The module defines a set of methods within the DBIC::SQL::Abstract
2007 namespace. These build on L<SQL::Abstract::Limit> to provide the
2008 SQL query functions.
2010 The following methods are extended:-
2024 See L</connect_info> for details.
2028 See L</connect_info> for details.
2032 See L</connect_info> for details.
2038 Matt S. Trout <mst@shadowcatsystems.co.uk>
2040 Andy Grundman <andy@hybridized.org>
2044 You may distribute this code under the same terms as Perl itself.