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 DBIx::Class::Storage::DBI::Cursor;
11 use DBIx::Class::Storage::Statistics;
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('DBIx::Class::SQLAHacks');
37 DBIx::Class::Storage::DBI - DBI storage handler
41 my $schema = MySchema->connect('dbi:SQLite:my.db');
43 $schema->storage->debug(1);
44 $schema->dbh_do("DROP TABLE authors");
46 $schema->resultset('Book')->search({
47 written_on => $schema->storage->datetime_parser(DateTime->now)
52 This class represents the connection to an RDBMS via L<DBI>. See
53 L<DBIx::Class::Storage> for general information. This pod only
54 documents DBI-specific methods and behaviors.
61 my $new = shift->next::method(@_);
63 $new->transaction_depth(0);
64 $new->_sql_maker_opts({});
65 $new->{savepoints} = [];
66 $new->{_in_dbh_do} = 0;
74 This method is normally called by L<DBIx::Class::Schema/connection>, which
75 encapsulates its argument list in an arrayref before passing them here.
77 The argument list may contain:
83 The same 4-element argument set one would normally pass to
84 L<DBI/connect>, optionally followed by
85 L<extra attributes|/DBIx::Class specific connection attributes>
86 recognized by DBIx::Class:
88 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
92 A single code reference which returns a connected
93 L<DBI database handle|DBI/connect> optionally followed by
94 L<extra attributes|/DBIx::Class specific connection attributes> recognized
97 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
101 A single hashref with all the attributes and the dsn/user/password
104 $connect_info_args = [{
112 This is particularly useful for L<Catalyst> based applications, allowing the
113 following config (L<Config::General> style):
118 dsn dbi:mysql:database=test
127 Please note that the L<DBI> docs recommend that you always explicitly
128 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
129 recommends that it be set to I<1>, and that you perform transactions
130 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
131 to I<1> if you do not do explicitly set it to zero. This is the default
132 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
134 =head3 DBIx::Class specific connection attributes
136 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
137 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
138 the following connection options. These options can be mixed in with your other
139 L<DBI> connection attributes, or placed in a seperate hashref
140 (C<\%extra_attributes>) as shown above.
142 Every time C<connect_info> is invoked, any previous settings for
143 these options will be cleared before setting the new ones, regardless of
144 whether any options are specified in the new C<connect_info>.
151 Specifies things to do immediately after connecting or re-connecting to
152 the database. Its value may contain:
158 This contains one SQL statement to execute.
160 =item an array reference
162 This contains SQL statements to execute in order. Each element contains
163 a string or a code reference that returns a string.
165 =item a code reference
167 This contains some code to execute. Unlike code references within an
168 array reference, its return value is ignored.
172 =item on_disconnect_do
174 Takes arguments in the same form as L</on_connect_do> and executes them
175 immediately before disconnecting from the database.
177 Note, this only runs if you explicitly call L</disconnect> on the
180 =item disable_sth_caching
182 If set to a true value, this option will disable the caching of
183 statement handles via L<DBI/prepare_cached>.
187 Sets the limit dialect. This is useful for JDBC-bridge among others
188 where the remote SQL-dialect cannot be determined by the name of the
189 driver alone. See also L<SQL::Abstract::Limit>.
193 Specifies what characters to use to quote table and column names. If
194 you use this you will want to specify L</name_sep> as well.
196 C<quote_char> expects either a single character, in which case is it
197 is placed on either side of the table/column name, or an arrayref of length
198 2 in which case the table/column name is placed between the elements.
200 For example under MySQL you should use C<< quote_char => '`' >>, and for
201 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
205 This only needs to be used in conjunction with C<quote_char>, and is used to
206 specify the charecter that seperates elements (schemas, tables, columns) from
207 each other. In most cases this is simply a C<.>.
209 The consequences of not supplying this value is that L<SQL::Abstract>
210 will assume DBIx::Class' uses of aliases to be complete column
211 names. The output will look like I<"me.name"> when it should actually
216 This Storage driver normally installs its own C<HandleError>, sets
217 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
218 all database handles, including those supplied by a coderef. It does this
219 so that it can have consistent and useful error behavior.
221 If you set this option to a true value, Storage will not do its usual
222 modifications to the database handle's attributes, and instead relies on
223 the settings in your connect_info DBI options (or the values you set in
224 your connection coderef, in the case that you are connecting via coderef).
226 Note that your custom settings can cause Storage to malfunction,
227 especially if you set a C<HandleError> handler that suppresses exceptions
228 and/or disable C<RaiseError>.
232 If this option is true, L<DBIx::Class> will use savepoints when nesting
233 transactions, making it possible to recover from failure in the inner
234 transaction without having to abort all outer transactions.
238 Use this argument to supply a cursor class other than the default
239 L<DBIx::Class::Storage::DBI::Cursor>.
243 Some real-life examples of arguments to L</connect_info> and
244 L<DBIx::Class::Schema/connect>
246 # Simple SQLite connection
247 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
250 ->connect_info([ sub { DBI->connect(...) } ]);
252 # A bit more complicated
259 { quote_char => q{"}, name_sep => q{.} },
263 # Equivalent to the previous example
269 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
273 # Same, but with hashref as argument
274 # See parse_connect_info for explanation
277 dsn => 'dbi:Pg:dbname=foo',
279 password => 'my_pg_password',
286 # Subref + DBIx::Class-specific connection options
289 sub { DBI->connect(...) },
293 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
294 disable_sth_caching => 1,
304 my ($self, $info_arg) = @_;
306 return $self->_connect_info if !$info_arg;
308 my @args = @$info_arg; # take a shallow copy for further mutilation
309 $self->_connect_info([@args]); # copy for _connect_info
312 # combine/pre-parse arguments depending on invocation style
315 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
316 %attrs = %{ $args[1] || {} };
319 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
320 %attrs = %{$args[0]};
322 for (qw/password user dsn/) {
323 unshift @args, delete $attrs{$_};
326 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
328 % { $args[3] || {} },
329 % { $args[4] || {} },
331 @args = @args[0,1,2];
334 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
335 # the new set of options
336 $self->_sql_maker(undef);
337 $self->_sql_maker_opts({});
340 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
341 if(my $value = delete $attrs{$storage_opt}) {
342 $self->$storage_opt($value);
345 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
346 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
347 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
352 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
354 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
355 $self->_connect_info;
360 This method is deprecated in favour of setting via L</connect_info>.
365 Arguments: ($subref | $method_name), @extra_coderef_args?
367 Execute the given $subref or $method_name using the new exception-based
368 connection management.
370 The first two arguments will be the storage object that C<dbh_do> was called
371 on and a database handle to use. Any additional arguments will be passed
372 verbatim to the called subref as arguments 2 and onwards.
374 Using this (instead of $self->_dbh or $self->dbh) ensures correct
375 exception handling and reconnection (or failover in future subclasses).
377 Your subref should have no side-effects outside of the database, as
378 there is the potential for your subref to be partially double-executed
379 if the database connection was stale/dysfunctional.
383 my @stuff = $schema->storage->dbh_do(
385 my ($storage, $dbh, @cols) = @_;
386 my $cols = join(q{, }, @cols);
387 $dbh->selectrow_array("SELECT $cols FROM foo");
398 my $dbh = $self->_dbh;
400 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
401 || $self->{transaction_depth};
403 local $self->{_in_dbh_do} = 1;
406 my $want_array = wantarray;
409 $self->_verify_pid if $dbh;
411 $self->_populate_dbh;
416 @result = $self->$code($dbh, @_);
418 elsif(defined $want_array) {
419 $result[0] = $self->$code($dbh, @_);
422 $self->$code($dbh, @_);
427 if(!$exception) { return $want_array ? @result : $result[0] }
429 $self->throw_exception($exception) if $self->connected;
431 # We were not connected - reconnect and retry, but let any
432 # exception fall right through this time
433 $self->_populate_dbh;
434 $self->$code($self->_dbh, @_);
437 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
438 # It also informs dbh_do to bypass itself while under the direction of txn_do,
439 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
444 ref $coderef eq 'CODE' or $self->throw_exception
445 ('$coderef must be a CODE reference');
447 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
449 local $self->{_in_dbh_do} = 1;
452 my $want_array = wantarray;
457 $self->_verify_pid if $self->_dbh;
458 $self->_populate_dbh if !$self->_dbh;
462 @result = $coderef->(@_);
464 elsif(defined $want_array) {
465 $result[0] = $coderef->(@_);
474 if(!$exception) { return $want_array ? @result : $result[0] }
476 if($tried++ > 0 || $self->connected) {
477 eval { $self->txn_rollback };
478 my $rollback_exception = $@;
479 if($rollback_exception) {
480 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
481 $self->throw_exception($exception) # propagate nested rollback
482 if $rollback_exception =~ /$exception_class/;
484 $self->throw_exception(
485 "Transaction aborted: ${exception}. "
486 . "Rollback failed: ${rollback_exception}"
489 $self->throw_exception($exception)
492 # We were not connected, and was first try - reconnect and retry
494 $self->_populate_dbh;
500 Our C<disconnect> method also performs a rollback first if the
501 database is not in C<AutoCommit> mode.
508 if( $self->connected ) {
509 my $connection_do = $self->on_disconnect_do;
510 $self->_do_connection_actions($connection_do) if ref($connection_do);
512 $self->_dbh->rollback unless $self->_dbh_autocommit;
513 $self->_dbh->disconnect;
519 =head2 with_deferred_fk_checks
523 =item Arguments: C<$coderef>
525 =item Return Value: The return value of $coderef
529 Storage specific method to run the code ref with FK checks deferred or
530 in MySQL's case disabled entirely.
534 # Storage subclasses should override this
535 sub with_deferred_fk_checks {
536 my ($self, $sub) = @_;
544 if(my $dbh = $self->_dbh) {
545 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
552 return 0 if !$self->_dbh;
554 return ($dbh->FETCH('Active') && $dbh->ping);
560 # handle pid changes correctly
561 # NOTE: assumes $self->_dbh is a valid $dbh
565 return if defined $self->_conn_pid && $self->_conn_pid == $$;
567 $self->_dbh->{InactiveDestroy} = 1;
574 sub ensure_connected {
577 unless ($self->connected) {
578 $self->_populate_dbh;
584 Returns the dbh - a data base handle of class L<DBI>.
591 $self->ensure_connected;
595 sub _sql_maker_args {
598 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
603 unless ($self->_sql_maker) {
604 my $sql_maker_class = $self->sql_maker_class;
605 $self->ensure_class_loaded ($sql_maker_class);
606 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
608 return $self->_sql_maker;
615 my @info = @{$self->_dbi_connect_info || []};
616 $self->_dbh($self->_connect(@info));
618 $self->_conn_pid($$);
619 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
621 $self->_determine_driver;
623 # Always set the transaction depth on connect, since
624 # there is no transaction in progress by definition
625 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
627 my $connection_do = $self->on_connect_do;
628 $self->_do_connection_actions($connection_do) if $connection_do;
631 sub _determine_driver {
634 if (ref $self eq 'DBIx::Class::Storage::DBI') {
637 if ($self->_dbh) { # we are connected
638 $driver = $self->_dbh->{Driver}{Name};
640 # try to use dsn to not require being connected, the driver may still
641 # force a connection in _rebless to determine version
642 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
645 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
646 bless $self, "DBIx::Class::Storage::DBI::${driver}";
652 sub _do_connection_actions {
654 my $connection_do = shift;
656 if (!ref $connection_do) {
657 $self->_do_query($connection_do);
659 elsif (ref $connection_do eq 'ARRAY') {
660 $self->_do_query($_) foreach @$connection_do;
662 elsif (ref $connection_do eq 'CODE') {
663 $connection_do->($self);
666 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref $connection_do) );
673 my ($self, $action) = @_;
675 if (ref $action eq 'CODE') {
676 $action = $action->($self);
677 $self->_do_query($_) foreach @$action;
680 # Most debuggers expect ($sql, @bind), so we need to exclude
681 # the attribute hash which is the second argument to $dbh->do
682 # furthermore the bind values are usually to be presented
683 # as named arrayref pairs, so wrap those here too
684 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
685 my $sql = shift @do_args;
686 my $attrs = shift @do_args;
687 my @bind = map { [ undef, $_ ] } @do_args;
689 $self->_query_start($sql, @bind);
690 $self->_dbh->do($sql, $attrs, @do_args);
691 $self->_query_end($sql, @bind);
698 my ($self, @info) = @_;
700 $self->throw_exception("You failed to provide any connection info")
703 my ($old_connect_via, $dbh);
705 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
706 $old_connect_via = $DBI::connect_via;
707 $DBI::connect_via = 'connect';
711 if(ref $info[0] eq 'CODE') {
715 $dbh = DBI->connect(@info);
718 if($dbh && !$self->unsafe) {
719 my $weak_self = $self;
720 Scalar::Util::weaken($weak_self);
721 $dbh->{HandleError} = sub {
723 $weak_self->throw_exception("DBI Exception: $_[0]");
726 croak ("DBI Exception: $_[0]");
729 $dbh->{ShowErrorStatement} = 1;
730 $dbh->{RaiseError} = 1;
731 $dbh->{PrintError} = 0;
735 $DBI::connect_via = $old_connect_via if $old_connect_via;
737 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
740 $self->_dbh_autocommit($dbh->{AutoCommit});
746 my ($self, $name) = @_;
748 $name = $self->_svp_generate_name
749 unless defined $name;
751 $self->throw_exception ("You can't use savepoints outside a transaction")
752 if $self->{transaction_depth} == 0;
754 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
755 unless $self->can('_svp_begin');
757 push @{ $self->{savepoints} }, $name;
759 $self->debugobj->svp_begin($name) if $self->debug;
761 return $self->_svp_begin($name);
765 my ($self, $name) = @_;
767 $self->throw_exception ("You can't use savepoints outside a transaction")
768 if $self->{transaction_depth} == 0;
770 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
771 unless $self->can('_svp_release');
774 $self->throw_exception ("Savepoint '$name' does not exist")
775 unless grep { $_ eq $name } @{ $self->{savepoints} };
777 # Dig through the stack until we find the one we are releasing. This keeps
778 # the stack up to date.
781 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
783 $name = pop @{ $self->{savepoints} };
786 $self->debugobj->svp_release($name) if $self->debug;
788 return $self->_svp_release($name);
792 my ($self, $name) = @_;
794 $self->throw_exception ("You can't use savepoints outside a transaction")
795 if $self->{transaction_depth} == 0;
797 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
798 unless $self->can('_svp_rollback');
801 # If they passed us a name, verify that it exists in the stack
802 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
803 $self->throw_exception("Savepoint '$name' does not exist!");
806 # Dig through the stack until we find the one we are releasing. This keeps
807 # the stack up to date.
808 while(my $s = pop(@{ $self->{savepoints} })) {
809 last if($s eq $name);
811 # Add the savepoint back to the stack, as a rollback doesn't remove the
812 # named savepoint, only everything after it.
813 push(@{ $self->{savepoints} }, $name);
815 # We'll assume they want to rollback to the last savepoint
816 $name = $self->{savepoints}->[-1];
819 $self->debugobj->svp_rollback($name) if $self->debug;
821 return $self->_svp_rollback($name);
824 sub _svp_generate_name {
827 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
832 $self->ensure_connected();
833 if($self->{transaction_depth} == 0) {
834 $self->debugobj->txn_begin()
836 # this isn't ->_dbh-> because
837 # we should reconnect on begin_work
838 # for AutoCommit users
839 $self->dbh->begin_work;
840 } elsif ($self->auto_savepoint) {
843 $self->{transaction_depth}++;
848 if ($self->{transaction_depth} == 1) {
849 my $dbh = $self->_dbh;
850 $self->debugobj->txn_commit()
853 $self->{transaction_depth} = 0
854 if $self->_dbh_autocommit;
856 elsif($self->{transaction_depth} > 1) {
857 $self->{transaction_depth}--;
859 if $self->auto_savepoint;
865 my $dbh = $self->_dbh;
867 if ($self->{transaction_depth} == 1) {
868 $self->debugobj->txn_rollback()
870 $self->{transaction_depth} = 0
871 if $self->_dbh_autocommit;
874 elsif($self->{transaction_depth} > 1) {
875 $self->{transaction_depth}--;
876 if ($self->auto_savepoint) {
882 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
887 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
888 $error =~ /$exception_class/ and $self->throw_exception($error);
889 # ensure that a failed rollback resets the transaction depth
890 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
891 $self->throw_exception($error);
895 # This used to be the top-half of _execute. It was split out to make it
896 # easier to override in NoBindVars without duping the rest. It takes up
897 # all of _execute's args, and emits $sql, @bind.
898 sub _prep_for_execute {
899 my ($self, $op, $extra_bind, $ident, $args) = @_;
901 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
902 $ident = $ident->from();
905 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
908 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
910 return ($sql, \@bind);
914 sub _fix_bind_params {
915 my ($self, @bind) = @_;
917 ### Turn @bind from something like this:
918 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
920 ### ( "'1'", "'1'", "'3'" )
923 if ( defined( $_ && $_->[1] ) ) {
924 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
930 sub _flatten_bind_params {
931 my ($self, @bind) = @_;
933 ### Turn @bind from something like this:
934 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
939 if ( defined( $_ && $_->[1] ) ) {
947 my ( $self, $sql, @bind ) = @_;
949 if ( $self->debug ) {
950 @bind = $self->_fix_bind_params(@bind);
952 $self->debugobj->query_start( $sql, @bind );
957 my ( $self, $sql, @bind ) = @_;
959 if ( $self->debug ) {
960 @bind = $self->_fix_bind_params(@bind);
961 $self->debugobj->query_end( $sql, @bind );
966 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
968 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
970 $self->_query_start( $sql, @$bind );
972 my $sth = $self->sth($sql,$op);
974 my $placeholder_index = 1;
976 foreach my $bound (@$bind) {
978 my($column_name, @data) = @$bound;
980 if ($bind_attributes) {
981 $attributes = $bind_attributes->{$column_name}
982 if defined $bind_attributes->{$column_name};
985 foreach my $data (@data) {
987 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
989 $sth->bind_param($placeholder_index, $data, $attributes);
990 $placeholder_index++;
994 # Can this fail without throwing an exception anyways???
995 my $rv = $sth->execute();
996 $self->throw_exception($sth->errstr) if !$rv;
998 $self->_query_end( $sql, @$bind );
1000 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1005 $self->dbh_do('_dbh_execute', @_)
1009 my ($self, $source, $to_insert) = @_;
1011 my $ident = $source->from;
1012 my $bind_attributes = $self->source_bind_attributes($source);
1014 my $updated_cols = {};
1016 $self->ensure_connected;
1017 foreach my $col ( $source->columns ) {
1018 if ( !defined $to_insert->{$col} ) {
1019 my $col_info = $source->column_info($col);
1021 if ( $col_info->{auto_nextval} ) {
1022 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1027 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1029 return $updated_cols;
1032 ## Still not quite perfect, and EXPERIMENTAL
1033 ## Currently it is assumed that all values passed will be "normal", i.e. not
1034 ## scalar refs, or at least, all the same type as the first set, the statement is
1035 ## only prepped once.
1037 my ($self, $source, $cols, $data) = @_;
1039 my $table = $source->from;
1040 @colvalues{@$cols} = (0..$#$cols);
1041 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1043 $self->_query_start( $sql, @bind );
1044 my $sth = $self->sth($sql);
1046 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1048 ## This must be an arrayref, else nothing works!
1049 my $tuple_status = [];
1051 ## Get the bind_attributes, if any exist
1052 my $bind_attributes = $self->source_bind_attributes($source);
1054 ## Bind the values and execute
1055 my $placeholder_index = 1;
1057 foreach my $bound (@bind) {
1059 my $attributes = {};
1060 my ($column_name, $data_index) = @$bound;
1062 if( $bind_attributes ) {
1063 $attributes = $bind_attributes->{$column_name}
1064 if defined $bind_attributes->{$column_name};
1067 my @data = map { $_->[$data_index] } @$data;
1069 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1070 $placeholder_index++;
1072 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1075 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1077 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1078 if ($i > $#$tuple_status);
1080 require Data::Dumper;
1081 local $Data::Dumper::Terse = 1;
1082 local $Data::Dumper::Indent = 1;
1083 local $Data::Dumper::Useqq = 1;
1084 local $Data::Dumper::Quotekeys = 0;
1086 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1087 $tuple_status->[$i][1],
1088 Data::Dumper::Dumper(
1089 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1093 $self->throw_exception($sth->errstr) if !$rv;
1095 $self->_query_end( $sql, @bind );
1096 return (wantarray ? ($rv, $sth, @bind) : $rv);
1100 my $self = shift @_;
1101 my $source = shift @_;
1102 my $bind_attributes = $self->source_bind_attributes($source);
1104 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1109 my $self = shift @_;
1110 my $source = shift @_;
1112 my $bind_attrs = $self->source_bind_attributes($source);
1114 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1117 # We were sent here because the $rs contains a complex search
1118 # which will require a subquery to select the correct rows
1119 # (i.e. joined or limited resultsets)
1121 # Genarating a single PK column subquery is trivial and supported
1122 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1123 # Look at _multipk_update_delete()
1124 sub _subq_update_delete {
1126 my ($rs, $op, $values) = @_;
1128 my $rsrc = $rs->result_source;
1130 # we already check this, but double check naively just in case. Should be removed soon
1131 my $sel = $rs->_resolved_attrs->{select};
1132 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1133 my @pcols = $rsrc->primary_columns;
1134 if (@$sel != @pcols) {
1135 $self->throw_exception (
1136 'Subquery update/delete can not be called on resultsets selecting a'
1137 .' number of columns different than the number of primary keys'
1144 $op eq 'update' ? $values : (),
1145 { $pcols[0] => { -in => $rs->as_query } },
1150 return $self->_multipk_update_delete (@_);
1154 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1155 # resultset update/delete involving subqueries. So by default resort
1156 # to simple (and inefficient) delete_all style per-row opearations,
1157 # while allowing specific storages to override this with a faster
1160 sub _multipk_update_delete {
1161 return shift->_per_row_update_delete (@_);
1164 # This is the default loop used to delete/update rows for multi PK
1165 # resultsets, and used by mysql exclusively (because it can't do anything
1168 # We do not use $row->$op style queries, because resultset update/delete
1169 # is not expected to cascade (this is what delete_all/update_all is for).
1171 # There should be no race conditions as the entire operation is rolled
1174 sub _per_row_update_delete {
1176 my ($rs, $op, $values) = @_;
1178 my $rsrc = $rs->result_source;
1179 my @pcols = $rsrc->primary_columns;
1181 my $guard = $self->txn_scope_guard;
1183 # emulate the return value of $sth->execute for non-selects
1184 my $row_cnt = '0E0';
1186 my $subrs_cur = $rs->cursor;
1187 while (my @pks = $subrs_cur->next) {
1190 for my $i (0.. $#pcols) {
1191 $cond->{$pcols[$i]} = $pks[$i];
1196 $op eq 'update' ? $values : (),
1211 # localization is neccessary as
1212 # 1) there is no infrastructure to pass this around (easy to do, but will wait)
1213 # 2) _select_args sets it and _prep_for_execute consumes it
1214 my $sql_maker = $self->sql_maker;
1215 local $sql_maker->{for};
1217 return $self->_execute($self->_select_args(@_));
1220 sub _select_args_to_query {
1223 # localization is neccessary as
1224 # 1) there is no infrastructure to pass this around (easy to do, but will wait)
1225 # 2) _select_args sets it and _prep_for_execute consumes it
1226 my $sql_maker = $self->sql_maker;
1227 local $sql_maker->{for};
1229 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1230 # = $self->_select_args($ident, $select, $cond, $attrs);
1231 my ($op, $bind, $ident, $bind_attrs, @args) =
1232 $self->_select_args(@_);
1234 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1235 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1236 $prepared_bind ||= [];
1239 ? ($sql, $prepared_bind, $bind_attrs)
1240 : \[ "($sql)", @$prepared_bind ]
1245 my ($self, $ident, $select, $condition, $attrs) = @_;
1247 my $sql_maker = $self->sql_maker;
1248 $sql_maker->{for} = delete $attrs->{for};
1251 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1252 (qw/order_by group_by having _virtual_order_by/ )
1256 my $bind_attrs = {};
1258 my $alias2source = $self->_resolve_ident_sources ($ident);
1260 for my $alias (keys %$alias2source) {
1261 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1262 for my $col (keys %$bindtypes) {
1264 my $fqcn = join ('.', $alias, $col);
1265 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1267 # so that unqualified searches can be bound too
1268 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq 'me';
1272 # This would be the point to deflate anything found in $condition
1273 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1274 # expect a row object. And all we have is a resultsource (it is trivial
1275 # to extract deflator coderefs via $alias2source above).
1277 # I don't see a way forward other than changing the way deflators are
1278 # invoked, and that's just bad...
1280 my @args = ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $condition, $order);
1281 if ($attrs->{software_limit} ||
1282 $sql_maker->_default_limit_syntax eq "GenericSubQ") {
1283 $attrs->{software_limit} = 1;
1285 $self->throw_exception("rows attribute must be positive if present")
1286 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1288 # MySQL actually recommends this approach. I cringe.
1289 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1290 push @args, $attrs->{rows}, $attrs->{offset};
1295 sub _resolve_ident_sources {
1296 my ($self, $ident) = @_;
1298 my $alias2source = {};
1300 # the reason this is so contrived is that $ident may be a {from}
1301 # structure, specifying multiple tables to join
1302 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1303 # this is compat mode for insert/update/delete which do not deal with aliases
1304 $alias2source->{me} = $ident;
1306 elsif (ref $ident eq 'ARRAY') {
1310 if (ref $_ eq 'HASH') {
1313 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1317 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1318 if ($tabinfo->{-source_handle});
1322 return $alias2source;
1325 sub _copy_attributes_for_count {
1326 my ($self, $source, $attrs) = @_;
1327 my %attrs = %$attrs;
1329 # take off any column specs, any pagers, record_filter is cdbi, and no point of ordering a count
1330 delete @attrs{qw/select as rows offset page order_by record_filter/};
1336 my ($self, $source, $attrs) = @_;
1338 my $tmp_attrs = $self->_copy_attributes_for_count($source, $attrs);
1340 # overwrite the selector
1341 $tmp_attrs->{select} = { count => '*' };
1343 my $tmp_rs = $source->resultset_class->new($source, $tmp_attrs);
1344 my ($count) = $tmp_rs->cursor->next;
1346 # if the offset/rows attributes are still present, we did not use
1347 # a subquery, so we need to make the calculations in software
1348 $count -= $attrs->{offset} if $attrs->{offset};
1349 $count = $attrs->{rows} if $attrs->{rows} and $attrs->{rows} < $count;
1350 $count = 0 if ($count < 0);
1356 my ($self, $source, $attrs) = @_;
1358 # copy for the subquery, we need to do some adjustments to it too
1359 my $sub_attrs = { %$attrs };
1361 # these can not go in the subquery, and there is no point of ordering it
1362 delete $sub_attrs->{$_} for qw/prefetch collapse select as order_by/;
1364 # if we prefetch, we group_by primary keys only as this is what we would get out of the rs via ->next/->all
1365 # simply deleting group_by suffices, as the code below will re-fill it
1366 # Note: we check $attrs, as $sub_attrs has collapse deleted
1367 if (ref $attrs->{collapse} and keys %{$attrs->{collapse}} ) {
1368 delete $sub_attrs->{group_by};
1371 $sub_attrs->{group_by} ||= [ map { "$attrs->{alias}.$_" } ($source->primary_columns) ];
1372 $sub_attrs->{select} = $self->_grouped_count_select ($source, $sub_attrs);
1375 count_subq => $source->resultset_class->new ($source, $sub_attrs )->as_query
1378 # the subquery replaces this
1379 delete $attrs->{$_} for qw/where bind prefetch collapse group_by having having_bind rows offset page pager/;
1381 return $self->count ($source, $attrs);
1385 # Returns a SELECT to go with a supplied GROUP BY
1386 # (caled by count_grouped so a group_by is present)
1387 # Most databases expect them to match, but some
1388 # choke in various ways.
1390 sub _grouped_count_select {
1391 my ($self, $source, $rs_args) = @_;
1392 return $rs_args->{group_by};
1395 sub source_bind_attributes {
1396 my ($self, $source) = @_;
1398 my $bind_attributes;
1399 foreach my $column ($source->columns) {
1401 my $data_type = $source->column_info($column)->{data_type} || '';
1402 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1406 return $bind_attributes;
1413 =item Arguments: $ident, $select, $condition, $attrs
1417 Handle a SQL select statement.
1423 my ($ident, $select, $condition, $attrs) = @_;
1424 return $self->cursor_class->new($self, \@_, $attrs);
1429 my ($rv, $sth, @bind) = $self->_select(@_);
1430 my @row = $sth->fetchrow_array;
1431 my @nextrow = $sth->fetchrow_array if @row;
1432 if(@row && @nextrow) {
1433 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1435 # Need to call finish() to work round broken DBDs
1444 =item Arguments: $sql
1448 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1453 my ($self, $dbh, $sql) = @_;
1455 # 3 is the if_active parameter which avoids active sth re-use
1456 my $sth = $self->disable_sth_caching
1457 ? $dbh->prepare($sql)
1458 : $dbh->prepare_cached($sql, {}, 3);
1460 # XXX You would think RaiseError would make this impossible,
1461 # but apparently that's not true :(
1462 $self->throw_exception($dbh->errstr) if !$sth;
1468 my ($self, $sql) = @_;
1469 $self->dbh_do('_dbh_sth', $sql);
1472 sub _dbh_columns_info_for {
1473 my ($self, $dbh, $table) = @_;
1475 if ($dbh->can('column_info')) {
1478 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1479 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1481 while ( my $info = $sth->fetchrow_hashref() ){
1483 $column_info{data_type} = $info->{TYPE_NAME};
1484 $column_info{size} = $info->{COLUMN_SIZE};
1485 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1486 $column_info{default_value} = $info->{COLUMN_DEF};
1487 my $col_name = $info->{COLUMN_NAME};
1488 $col_name =~ s/^\"(.*)\"$/$1/;
1490 $result{$col_name} = \%column_info;
1493 return \%result if !$@ && scalar keys %result;
1497 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1499 my @columns = @{$sth->{NAME_lc}};
1500 for my $i ( 0 .. $#columns ){
1502 $column_info{data_type} = $sth->{TYPE}->[$i];
1503 $column_info{size} = $sth->{PRECISION}->[$i];
1504 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1506 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1507 $column_info{data_type} = $1;
1508 $column_info{size} = $2;
1511 $result{$columns[$i]} = \%column_info;
1515 foreach my $col (keys %result) {
1516 my $colinfo = $result{$col};
1517 my $type_num = $colinfo->{data_type};
1519 if(defined $type_num && $dbh->can('type_info')) {
1520 my $type_info = $dbh->type_info($type_num);
1521 $type_name = $type_info->{TYPE_NAME} if $type_info;
1522 $colinfo->{data_type} = $type_name if $type_name;
1529 sub columns_info_for {
1530 my ($self, $table) = @_;
1531 $self->dbh_do('_dbh_columns_info_for', $table);
1534 =head2 last_insert_id
1536 Return the row id of the last insert.
1540 sub _dbh_last_insert_id {
1541 # All Storage's need to register their own _dbh_last_insert_id
1542 # the old SQLite-based method was highly inappropriate
1545 my $class = ref $self;
1546 $self->throw_exception (<<EOE);
1548 No _dbh_last_insert_id() method found in $class.
1549 Since the method of obtaining the autoincrement id of the last insert
1550 operation varies greatly between different databases, this method must be
1551 individually implemented for every storage class.
1555 sub last_insert_id {
1557 $self->dbh_do('_dbh_last_insert_id', @_);
1562 Returns the database driver name.
1566 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1568 =head2 bind_attribute_by_data_type
1570 Given a datatype from column info, returns a database specific bind
1571 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1572 let the database planner just handle it.
1574 Generally only needed for special case column types, like bytea in postgres.
1578 sub bind_attribute_by_data_type {
1582 =head2 is_datatype_numeric
1584 Given a datatype from column_info, returns a boolean value indicating if
1585 the current RDBMS considers it a numeric value. This controls how
1586 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1587 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1588 be performed instead of the usual C<eq>.
1592 sub is_datatype_numeric {
1593 my ($self, $dt) = @_;
1595 return 0 unless $dt;
1597 return $dt =~ /^ (?:
1598 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1603 =head2 create_ddl_dir (EXPERIMENTAL)
1607 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1611 Creates a SQL file based on the Schema, for each of the specified
1612 database engines in C<\@databases> in the given directory.
1613 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1615 Given a previous version number, this will also create a file containing
1616 the ALTER TABLE statements to transform the previous schema into the
1617 current one. Note that these statements may contain C<DROP TABLE> or
1618 C<DROP COLUMN> statements that can potentially destroy data.
1620 The file names are created using the C<ddl_filename> method below, please
1621 override this method in your schema if you would like a different file
1622 name format. For the ALTER file, the same format is used, replacing
1623 $version in the name with "$preversion-$version".
1625 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1626 The most common value for this would be C<< { add_drop_table => 1 } >>
1627 to have the SQL produced include a C<DROP TABLE> statement for each table
1628 created. For quoting purposes supply C<quote_table_names> and
1629 C<quote_field_names>.
1631 If no arguments are passed, then the following default values are assumed:
1635 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1637 =item version - $schema->schema_version
1639 =item directory - './'
1641 =item preversion - <none>
1645 By default, C<\%sqlt_args> will have
1647 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1649 merged with the hash passed in. To disable any of those features, pass in a
1650 hashref like the following
1652 { ignore_constraint_names => 0, # ... other options }
1655 Note that this feature is currently EXPERIMENTAL and may not work correctly
1656 across all databases, or fully handle complex relationships.
1658 WARNING: Please check all SQL files created, before applying them.
1662 sub create_ddl_dir {
1663 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1665 if(!$dir || !-d $dir) {
1666 carp "No directory given, using ./\n";
1669 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1670 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1672 my $schema_version = $schema->schema_version || '1.x';
1673 $version ||= $schema_version;
1676 add_drop_table => 1,
1677 ignore_constraint_names => 1,
1678 ignore_index_names => 1,
1682 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1683 . $self->_check_sqlt_message . q{'})
1684 if !$self->_check_sqlt_version;
1686 my $sqlt = SQL::Translator->new( $sqltargs );
1688 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1689 my $sqlt_schema = $sqlt->translate({ data => $schema })
1690 or $self->throw_exception ($sqlt->error);
1692 foreach my $db (@$databases) {
1694 $sqlt->{schema} = $sqlt_schema;
1695 $sqlt->producer($db);
1698 my $filename = $schema->ddl_filename($db, $version, $dir);
1699 if (-e $filename && ($version eq $schema_version )) {
1700 # if we are dumping the current version, overwrite the DDL
1701 carp "Overwriting existing DDL file - $filename";
1705 my $output = $sqlt->translate;
1707 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1710 if(!open($file, ">$filename")) {
1711 $self->throw_exception("Can't open $filename for writing ($!)");
1714 print $file $output;
1717 next unless ($preversion);
1719 require SQL::Translator::Diff;
1721 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1722 if(!-e $prefilename) {
1723 carp("No previous schema file found ($prefilename)");
1727 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1729 carp("Overwriting existing diff file - $difffile");
1735 my $t = SQL::Translator->new($sqltargs);
1740 or $self->throw_exception ($t->error);
1742 my $out = $t->translate( $prefilename )
1743 or $self->throw_exception ($t->error);
1745 $source_schema = $t->schema;
1747 $source_schema->name( $prefilename )
1748 unless ( $source_schema->name );
1751 # The "new" style of producers have sane normalization and can support
1752 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1753 # And we have to diff parsed SQL against parsed SQL.
1754 my $dest_schema = $sqlt_schema;
1756 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1757 my $t = SQL::Translator->new($sqltargs);
1762 or $self->throw_exception ($t->error);
1764 my $out = $t->translate( $filename )
1765 or $self->throw_exception ($t->error);
1767 $dest_schema = $t->schema;
1769 $dest_schema->name( $filename )
1770 unless $dest_schema->name;
1773 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1777 if(!open $file, ">$difffile") {
1778 $self->throw_exception("Can't write to $difffile ($!)");
1786 =head2 deployment_statements
1790 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1794 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1796 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
1797 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
1799 C<$directory> is used to return statements from files in a previously created
1800 L</create_ddl_dir> directory and is optional. The filenames are constructed
1801 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1803 If no C<$directory> is specified then the statements are constructed on the
1804 fly using L<SQL::Translator> and C<$version> is ignored.
1806 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1810 sub deployment_statements {
1811 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1812 # Need to be connected to get the correct sqlt_type
1813 $self->ensure_connected() unless $type;
1814 $type ||= $self->sqlt_type;
1815 $version ||= $schema->schema_version || '1.x';
1817 my $filename = $schema->ddl_filename($type, $version, $dir);
1821 open($file, "<$filename")
1822 or $self->throw_exception("Can't open $filename ($!)");
1825 return join('', @rows);
1828 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
1829 . $self->_check_sqlt_message . q{'})
1830 if !$self->_check_sqlt_version;
1832 require SQL::Translator::Parser::DBIx::Class;
1833 eval qq{use SQL::Translator::Producer::${type}};
1834 $self->throw_exception($@) if $@;
1836 # sources needs to be a parser arg, but for simplicty allow at top level
1838 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1839 if exists $sqltargs->{sources};
1841 my $tr = SQL::Translator->new(%$sqltargs);
1842 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1843 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1847 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1850 return if($line =~ /^--/);
1852 # next if($line =~ /^DROP/m);
1853 return if($line =~ /^BEGIN TRANSACTION/m);
1854 return if($line =~ /^COMMIT/m);
1855 return if $line =~ /^\s+$/; # skip whitespace only
1856 $self->_query_start($line);
1858 $self->dbh->do($line); # shouldn't be using ->dbh ?
1861 carp qq{$@ (running "${line}")};
1863 $self->_query_end($line);
1865 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
1866 if (@statements > 1) {
1867 foreach my $statement (@statements) {
1868 $deploy->( $statement );
1871 elsif (@statements == 1) {
1872 foreach my $line ( split(";\n", $statements[0])) {
1878 =head2 datetime_parser
1880 Returns the datetime parser class
1884 sub datetime_parser {
1886 return $self->{datetime_parser} ||= do {
1887 $self->ensure_connected;
1888 $self->build_datetime_parser(@_);
1892 =head2 datetime_parser_type
1894 Defines (returns) the datetime parser class - currently hardwired to
1895 L<DateTime::Format::MySQL>
1899 sub datetime_parser_type { "DateTime::Format::MySQL"; }
1901 =head2 build_datetime_parser
1903 See L</datetime_parser>
1907 sub build_datetime_parser {
1909 my $type = $self->datetime_parser_type(@_);
1911 $self->throw_exception("Couldn't load ${type}: $@") if $@;
1916 my $_check_sqlt_version; # private
1917 my $_check_sqlt_message; # private
1918 sub _check_sqlt_version {
1919 return $_check_sqlt_version if defined $_check_sqlt_version;
1920 eval 'use SQL::Translator "0.09003"';
1921 $_check_sqlt_message = $@ || '';
1922 $_check_sqlt_version = !$@;
1925 sub _check_sqlt_message {
1926 _check_sqlt_version if !defined $_check_sqlt_message;
1927 $_check_sqlt_message;
1931 =head2 is_replicating
1933 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
1934 replicate from a master database. Default is undef, which is the result
1935 returned by databases that don't support replication.
1939 sub is_replicating {
1944 =head2 lag_behind_master
1946 Returns a number that represents a certain amount of lag behind a master db
1947 when a given storage is replicating. The number is database dependent, but
1948 starts at zero and increases with the amount of lag. Default in undef
1952 sub lag_behind_master {
1958 return if !$self->_dbh;
1967 =head2 DBIx::Class and AutoCommit
1969 DBIx::Class can do some wonderful magic with handling exceptions,
1970 disconnections, and transactions when you use C<< AutoCommit => 1 >>
1971 combined with C<txn_do> for transaction support.
1973 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
1974 in an assumed transaction between commits, and you're telling us you'd
1975 like to manage that manually. A lot of the magic protections offered by
1976 this module will go away. We can't protect you from exceptions due to database
1977 disconnects because we don't know anything about how to restart your
1978 transactions. You're on your own for handling all sorts of exceptional
1979 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
1986 Matt S. Trout <mst@shadowcatsystems.co.uk>
1988 Andy Grundman <andy@hybridized.org>
1992 You may distribute this code under the same terms as Perl itself.