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 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
646 if ($self->load_optional_class($storage_class)) {
647 mro::set_mro($storage_class, 'c3');
648 bless $self, $storage_class;
654 sub _do_connection_actions {
656 my $connection_do = shift;
658 if (!ref $connection_do) {
659 $self->_do_query($connection_do);
661 elsif (ref $connection_do eq 'ARRAY') {
662 $self->_do_query($_) foreach @$connection_do;
664 elsif (ref $connection_do eq 'CODE') {
665 $connection_do->($self);
668 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref $connection_do) );
675 my ($self, $action) = @_;
677 if (ref $action eq 'CODE') {
678 $action = $action->($self);
679 $self->_do_query($_) foreach @$action;
682 # Most debuggers expect ($sql, @bind), so we need to exclude
683 # the attribute hash which is the second argument to $dbh->do
684 # furthermore the bind values are usually to be presented
685 # as named arrayref pairs, so wrap those here too
686 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
687 my $sql = shift @do_args;
688 my $attrs = shift @do_args;
689 my @bind = map { [ undef, $_ ] } @do_args;
691 $self->_query_start($sql, @bind);
692 $self->_dbh->do($sql, $attrs, @do_args);
693 $self->_query_end($sql, @bind);
700 my ($self, @info) = @_;
702 $self->throw_exception("You failed to provide any connection info")
705 my ($old_connect_via, $dbh);
707 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
708 $old_connect_via = $DBI::connect_via;
709 $DBI::connect_via = 'connect';
713 if(ref $info[0] eq 'CODE') {
717 $dbh = DBI->connect(@info);
720 if($dbh && !$self->unsafe) {
721 my $weak_self = $self;
722 Scalar::Util::weaken($weak_self);
723 $dbh->{HandleError} = sub {
725 $weak_self->throw_exception("DBI Exception: $_[0]");
728 croak ("DBI Exception: $_[0]");
731 $dbh->{ShowErrorStatement} = 1;
732 $dbh->{RaiseError} = 1;
733 $dbh->{PrintError} = 0;
737 $DBI::connect_via = $old_connect_via if $old_connect_via;
739 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
742 $self->_dbh_autocommit($dbh->{AutoCommit});
748 my ($self, $name) = @_;
750 $name = $self->_svp_generate_name
751 unless defined $name;
753 $self->throw_exception ("You can't use savepoints outside a transaction")
754 if $self->{transaction_depth} == 0;
756 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
757 unless $self->can('_svp_begin');
759 push @{ $self->{savepoints} }, $name;
761 $self->debugobj->svp_begin($name) if $self->debug;
763 return $self->_svp_begin($name);
767 my ($self, $name) = @_;
769 $self->throw_exception ("You can't use savepoints outside a transaction")
770 if $self->{transaction_depth} == 0;
772 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
773 unless $self->can('_svp_release');
776 $self->throw_exception ("Savepoint '$name' does not exist")
777 unless grep { $_ eq $name } @{ $self->{savepoints} };
779 # Dig through the stack until we find the one we are releasing. This keeps
780 # the stack up to date.
783 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
785 $name = pop @{ $self->{savepoints} };
788 $self->debugobj->svp_release($name) if $self->debug;
790 return $self->_svp_release($name);
794 my ($self, $name) = @_;
796 $self->throw_exception ("You can't use savepoints outside a transaction")
797 if $self->{transaction_depth} == 0;
799 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
800 unless $self->can('_svp_rollback');
803 # If they passed us a name, verify that it exists in the stack
804 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
805 $self->throw_exception("Savepoint '$name' does not exist!");
808 # Dig through the stack until we find the one we are releasing. This keeps
809 # the stack up to date.
810 while(my $s = pop(@{ $self->{savepoints} })) {
811 last if($s eq $name);
813 # Add the savepoint back to the stack, as a rollback doesn't remove the
814 # named savepoint, only everything after it.
815 push(@{ $self->{savepoints} }, $name);
817 # We'll assume they want to rollback to the last savepoint
818 $name = $self->{savepoints}->[-1];
821 $self->debugobj->svp_rollback($name) if $self->debug;
823 return $self->_svp_rollback($name);
826 sub _svp_generate_name {
829 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
834 $self->ensure_connected();
835 if($self->{transaction_depth} == 0) {
836 $self->debugobj->txn_begin()
838 # this isn't ->_dbh-> because
839 # we should reconnect on begin_work
840 # for AutoCommit users
841 $self->dbh->begin_work;
842 } elsif ($self->auto_savepoint) {
845 $self->{transaction_depth}++;
850 if ($self->{transaction_depth} == 1) {
851 my $dbh = $self->_dbh;
852 $self->debugobj->txn_commit()
855 $self->{transaction_depth} = 0
856 if $self->_dbh_autocommit;
858 elsif($self->{transaction_depth} > 1) {
859 $self->{transaction_depth}--;
861 if $self->auto_savepoint;
867 my $dbh = $self->_dbh;
869 if ($self->{transaction_depth} == 1) {
870 $self->debugobj->txn_rollback()
872 $self->{transaction_depth} = 0
873 if $self->_dbh_autocommit;
876 elsif($self->{transaction_depth} > 1) {
877 $self->{transaction_depth}--;
878 if ($self->auto_savepoint) {
884 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
889 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
890 $error =~ /$exception_class/ and $self->throw_exception($error);
891 # ensure that a failed rollback resets the transaction depth
892 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
893 $self->throw_exception($error);
897 # This used to be the top-half of _execute. It was split out to make it
898 # easier to override in NoBindVars without duping the rest. It takes up
899 # all of _execute's args, and emits $sql, @bind.
900 sub _prep_for_execute {
901 my ($self, $op, $extra_bind, $ident, $args) = @_;
903 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
904 $ident = $ident->from();
907 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
910 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
912 return ($sql, \@bind);
916 sub _fix_bind_params {
917 my ($self, @bind) = @_;
919 ### Turn @bind from something like this:
920 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
922 ### ( "'1'", "'1'", "'3'" )
925 if ( defined( $_ && $_->[1] ) ) {
926 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
933 my ( $self, $sql, @bind ) = @_;
935 if ( $self->debug ) {
936 @bind = $self->_fix_bind_params(@bind);
938 $self->debugobj->query_start( $sql, @bind );
943 my ( $self, $sql, @bind ) = @_;
945 if ( $self->debug ) {
946 @bind = $self->_fix_bind_params(@bind);
947 $self->debugobj->query_end( $sql, @bind );
952 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
954 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
956 $self->_query_start( $sql, @$bind );
958 my $sth = $self->sth($sql,$op);
960 my $placeholder_index = 1;
962 foreach my $bound (@$bind) {
964 my($column_name, @data) = @$bound;
966 if ($bind_attributes) {
967 $attributes = $bind_attributes->{$column_name}
968 if defined $bind_attributes->{$column_name};
971 foreach my $data (@data) {
973 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
975 $sth->bind_param($placeholder_index, $data, $attributes);
976 $placeholder_index++;
980 # Can this fail without throwing an exception anyways???
981 my $rv = $sth->execute();
982 $self->throw_exception($sth->errstr) if !$rv;
984 $self->_query_end( $sql, @$bind );
986 return (wantarray ? ($rv, $sth, @$bind) : $rv);
991 $self->dbh_do('_dbh_execute', @_)
995 my ($self, $source, $to_insert) = @_;
997 my $ident = $source->from;
998 my $bind_attributes = $self->source_bind_attributes($source);
1000 my $updated_cols = {};
1002 $self->ensure_connected;
1003 foreach my $col ( $source->columns ) {
1004 if ( !defined $to_insert->{$col} ) {
1005 my $col_info = $source->column_info($col);
1007 if ( $col_info->{auto_nextval} ) {
1008 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1013 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1015 return $updated_cols;
1018 ## Still not quite perfect, and EXPERIMENTAL
1019 ## Currently it is assumed that all values passed will be "normal", i.e. not
1020 ## scalar refs, or at least, all the same type as the first set, the statement is
1021 ## only prepped once.
1023 my ($self, $source, $cols, $data) = @_;
1025 my $table = $source->from;
1026 @colvalues{@$cols} = (0..$#$cols);
1027 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1029 $self->_query_start( $sql, @bind );
1030 my $sth = $self->sth($sql);
1032 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1034 ## This must be an arrayref, else nothing works!
1035 my $tuple_status = [];
1037 ## Get the bind_attributes, if any exist
1038 my $bind_attributes = $self->source_bind_attributes($source);
1040 ## Bind the values and execute
1041 my $placeholder_index = 1;
1043 foreach my $bound (@bind) {
1045 my $attributes = {};
1046 my ($column_name, $data_index) = @$bound;
1048 if( $bind_attributes ) {
1049 $attributes = $bind_attributes->{$column_name}
1050 if defined $bind_attributes->{$column_name};
1053 my @data = map { $_->[$data_index] } @$data;
1055 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1056 $placeholder_index++;
1058 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1061 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1063 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1064 if ($i > $#$tuple_status);
1066 require Data::Dumper;
1067 local $Data::Dumper::Terse = 1;
1068 local $Data::Dumper::Indent = 1;
1069 local $Data::Dumper::Useqq = 1;
1070 local $Data::Dumper::Quotekeys = 0;
1072 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1073 $tuple_status->[$i][1],
1074 Data::Dumper::Dumper(
1075 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1079 $self->throw_exception($sth->errstr) if !$rv;
1081 $self->_query_end( $sql, @bind );
1082 return (wantarray ? ($rv, $sth, @bind) : $rv);
1086 my $self = shift @_;
1087 my $source = shift @_;
1088 my $bind_attributes = $self->source_bind_attributes($source);
1090 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1095 my $self = shift @_;
1096 my $source = shift @_;
1098 my $bind_attrs = $self->source_bind_attributes($source);
1100 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1103 # We were sent here because the $rs contains a complex search
1104 # which will require a subquery to select the correct rows
1105 # (i.e. joined or limited resultsets)
1107 # Genarating a single PK column subquery is trivial and supported
1108 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1109 # Look at _multipk_update_delete()
1110 sub _subq_update_delete {
1112 my ($rs, $op, $values) = @_;
1114 my $rsrc = $rs->result_source;
1116 # we already check this, but double check naively just in case. Should be removed soon
1117 my $sel = $rs->_resolved_attrs->{select};
1118 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1119 my @pcols = $rsrc->primary_columns;
1120 if (@$sel != @pcols) {
1121 $self->throw_exception (
1122 'Subquery update/delete can not be called on resultsets selecting a'
1123 .' number of columns different than the number of primary keys'
1130 $op eq 'update' ? $values : (),
1131 { $pcols[0] => { -in => $rs->as_query } },
1136 return $self->_multipk_update_delete (@_);
1140 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1141 # resultset update/delete involving subqueries. So by default resort
1142 # to simple (and inefficient) delete_all style per-row opearations,
1143 # while allowing specific storages to override this with a faster
1146 sub _multipk_update_delete {
1147 return shift->_per_row_update_delete (@_);
1150 # This is the default loop used to delete/update rows for multi PK
1151 # resultsets, and used by mysql exclusively (because it can't do anything
1154 # We do not use $row->$op style queries, because resultset update/delete
1155 # is not expected to cascade (this is what delete_all/update_all is for).
1157 # There should be no race conditions as the entire operation is rolled
1160 sub _per_row_update_delete {
1162 my ($rs, $op, $values) = @_;
1164 my $rsrc = $rs->result_source;
1165 my @pcols = $rsrc->primary_columns;
1167 my $guard = $self->txn_scope_guard;
1169 # emulate the return value of $sth->execute for non-selects
1170 my $row_cnt = '0E0';
1172 my $subrs_cur = $rs->cursor;
1173 while (my @pks = $subrs_cur->next) {
1176 for my $i (0.. $#pcols) {
1177 $cond->{$pcols[$i]} = $pks[$i];
1182 $op eq 'update' ? $values : (),
1197 # localization is neccessary as
1198 # 1) there is no infrastructure to pass this around before SQLA2
1199 # 2) _select_args sets it and _prep_for_execute consumes it
1200 my $sql_maker = $self->sql_maker;
1201 local $sql_maker->{_dbic_rs_attrs};
1203 return $self->_execute($self->_select_args(@_));
1206 sub _select_args_to_query {
1209 # localization is neccessary as
1210 # 1) there is no infrastructure to pass this around before SQLA2
1211 # 2) _select_args sets it and _prep_for_execute consumes it
1212 my $sql_maker = $self->sql_maker;
1213 local $sql_maker->{_dbic_rs_attrs};
1215 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1216 # = $self->_select_args($ident, $select, $cond, $attrs);
1217 my ($op, $bind, $ident, $bind_attrs, @args) =
1218 $self->_select_args(@_);
1220 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1221 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1222 $prepared_bind ||= [];
1225 ? ($sql, $prepared_bind, $bind_attrs)
1226 : \[ "($sql)", @$prepared_bind ]
1231 my ($self, $ident, $select, $where, $attrs) = @_;
1233 my $sql_maker = $self->sql_maker;
1234 $sql_maker->{_dbic_rs_attrs} = {
1241 my ($alias2source, $root_alias) = $self->_resolve_ident_sources ($ident);
1243 # calculate bind_attrs before possible $ident mangling
1244 my $bind_attrs = {};
1245 for my $alias (keys %$alias2source) {
1246 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1247 for my $col (keys %$bindtypes) {
1249 my $fqcn = join ('.', $alias, $col);
1250 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1252 # so that unqualified searches can be bound too
1253 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq $root_alias;
1258 if ($attrs->{software_limit} ||
1259 $sql_maker->_default_limit_syntax eq "GenericSubQ") {
1260 $attrs->{software_limit} = 1;
1262 $self->throw_exception("rows attribute must be positive if present")
1263 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1265 # MySQL actually recommends this approach. I cringe.
1266 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1268 if ($attrs->{rows} && keys %{$attrs->{collapse}}) {
1269 ($ident, $select, $where, $attrs)
1270 = $self->_adjust_select_args_for_limited_prefetch ($ident, $select, $where, $attrs);
1273 push @limit, $attrs->{rows}, $attrs->{offset};
1278 # This would be the point to deflate anything found in $where
1279 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1280 # expect a row object. And all we have is a resultsource (it is trivial
1281 # to extract deflator coderefs via $alias2source above).
1283 # I don't see a way forward other than changing the way deflators are
1284 # invoked, and that's just bad...
1288 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1289 (qw/order_by group_by having _virtual_order_by/ )
1293 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1296 sub _adjust_select_args_for_limited_prefetch {
1297 my ($self, $from, $select, $where, $attrs) = @_;
1299 if ($attrs->{group_by} && @{$attrs->{group_by}}) {
1300 $self->throw_exception ('has_many prefetch with limit (rows/offset) is not supported on grouped resultsets');
1303 $self->throw_exception ('has_many prefetch with limit (rows/offset) is not supported on resultsets with a custom from attribute')
1304 if (ref $from ne 'ARRAY');
1307 # separate attributes
1308 my $sub_attrs = { %$attrs };
1309 delete $attrs->{$_} for qw/where bind rows offset/;
1310 delete $sub_attrs->{$_} for qw/for collapse select as order_by/;
1312 my $alias = $attrs->{alias};
1314 # create subquery select list
1315 my $sub_select = [ grep { $_ =~ /^$alias\./ } @{$attrs->{select}} ];
1317 # bring over all non-collapse-induced order_by into the inner query (if any)
1318 # the outer one will have to keep them all
1319 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1320 $sub_attrs->{order_by} = [
1321 @{$attrs->{order_by}}[ 0 .. ($#{$attrs->{order_by}} - $ord_cnt - 1) ]
1327 my $select_root = shift @$from;
1328 my @outer_from = @$from;
1331 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1333 # in complex search_related chains $alias may *not* be 'me'
1334 # so always include it in the inner join, and also shift away
1335 # from the outer stack, so that the two datasets actually do
1337 if ($select_root->{-alias} ne $alias) {
1338 $inner_joins{$alias} = 1;
1340 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1343 if (! @outer_from) {
1344 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1347 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1351 # decide which parts of the join will remain on the inside
1353 # this is not a very viable optimisation, but it was written
1354 # before I realised this, so might as well remain. We can throw
1355 # away _any_ branches of the join tree that are:
1356 # 1) not mentioned in the condition/order
1357 # 2) left-join leaves (or left-join leaf chains)
1358 # Most of the join ocnditions will not satisfy this, but for real
1359 # complex queries some might, and we might make some RDBMS happy.
1362 # since we do not have introspectable SQLA, we fall back to ugly
1363 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1364 # in order to determine what goes into %inner_joins
1365 # It may not be very efficient, but it's a reasonable stop-gap
1367 # produce stuff unquoted, so it can be scanned
1368 my $sql_maker = $self->sql_maker;
1369 local $sql_maker->{quote_char};
1372 { ref $_ ? $_->[0] : $_ }
1373 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1376 my $where_sql = $sql_maker->where ($where);
1379 for my $alias (keys %join_info) {
1381 # any table alias found on a column name in where or order_by
1382 # gets included in %inner_joins
1383 # Also any parent joins that are needed to reach this particular alias
1384 for my $piece ($where_sql, @order_by ) {
1385 if ($piece =~ /\b$alias\./) {
1386 $inner_joins{$alias} = 1;
1392 # scan for non-leaf/non-left joins and mark as needed
1393 # also mark all ancestor joins that are needed to reach this particular alias
1394 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1396 # traverse by the size of the -join_path i.e. reverse depth first
1397 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1399 my $j = $join_info{$alias};
1400 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1402 if ($inner_joins{$alias}) {
1403 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1407 # construct the inner $from for the subquery
1408 my $inner_from = [ $select_root ];
1409 for my $j (@$from) {
1410 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1413 # if a multi-type join was needed in the subquery ("multi" is indicated by
1414 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1416 for my $alias (keys %inner_joins) {
1418 # the dot comes from some weirdness in collapse
1419 # remove after the rewrite
1420 if ($attrs->{collapse}{".$alias"}) {
1421 $sub_attrs->{group_by} = $sub_select;
1426 # generate the subquery
1427 my $subq = $self->_select_args_to_query (
1434 # put it in the new {from}
1435 unshift @outer_from, {
1437 -source_handle => $select_root->{-source_handle},
1441 # This is totally horrific - the $where ends up in both the inner and outer query
1442 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1443 # then if where conditions apply to the *right* side of the prefetch, you may have
1444 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1445 # the outer select to exclude joins you didin't want in the first place
1447 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1448 return (\@outer_from, $select, $where, $attrs);
1451 sub _resolve_ident_sources {
1452 my ($self, $ident) = @_;
1454 my $alias2source = {};
1457 # the reason this is so contrived is that $ident may be a {from}
1458 # structure, specifying multiple tables to join
1459 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1460 # this is compat mode for insert/update/delete which do not deal with aliases
1461 $alias2source->{me} = $ident;
1464 elsif (ref $ident eq 'ARRAY') {
1468 if (ref $_ eq 'HASH') {
1470 $root_alias = $tabinfo->{-alias};
1472 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1476 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1477 if ($tabinfo->{-source_handle});
1481 return ($alias2source, $root_alias);
1484 # Takes $ident, \@column_names
1486 # returns { $column_name => \%column_info, ... }
1487 # also note: this adds -result_source => $rsrc to the column info
1490 # my $col_sources = $self->_resolve_column_info($ident, [map $_->[0], @{$bind}]);
1491 sub _resolve_column_info {
1492 my ($self, $ident, $colnames) = @_;
1493 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1495 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1498 my (%return, %converted);
1499 foreach my $col (@$colnames) {
1500 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1502 # deal with unqualified cols - we assume the main alias for all
1503 # unqualified ones, ugly but can't think of anything better right now
1504 $alias ||= $root_alias;
1506 my $rsrc = $alias2src->{$alias};
1507 $return{$col} = $rsrc && { %{$rsrc->column_info($colname)}, -result_source => $rsrc };
1512 # Returns a counting SELECT for a simple count
1513 # query. Abstracted so that a storage could override
1514 # this to { count => 'firstcol' } or whatever makes
1515 # sense as a performance optimization
1517 #my ($self, $source, $rs_attrs) = @_;
1518 return { count => '*' };
1521 # Returns a SELECT which will end up in the subselect
1522 # There may or may not be a group_by, as the subquery
1523 # might have been called to accomodate a limit
1525 # Most databases would be happy with whatever ends up
1526 # here, but some choke in various ways.
1528 sub _subq_count_select {
1529 my ($self, $source, $rs_attrs) = @_;
1530 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1532 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1533 return @pcols ? \@pcols : [ 1 ];
1537 sub source_bind_attributes {
1538 my ($self, $source) = @_;
1540 my $bind_attributes;
1541 foreach my $column ($source->columns) {
1543 my $data_type = $source->column_info($column)->{data_type} || '';
1544 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1548 return $bind_attributes;
1555 =item Arguments: $ident, $select, $condition, $attrs
1559 Handle a SQL select statement.
1565 my ($ident, $select, $condition, $attrs) = @_;
1566 return $self->cursor_class->new($self, \@_, $attrs);
1571 my ($rv, $sth, @bind) = $self->_select(@_);
1572 my @row = $sth->fetchrow_array;
1573 my @nextrow = $sth->fetchrow_array if @row;
1574 if(@row && @nextrow) {
1575 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1577 # Need to call finish() to work round broken DBDs
1586 =item Arguments: $sql
1590 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1595 my ($self, $dbh, $sql) = @_;
1597 # 3 is the if_active parameter which avoids active sth re-use
1598 my $sth = $self->disable_sth_caching
1599 ? $dbh->prepare($sql)
1600 : $dbh->prepare_cached($sql, {}, 3);
1602 # XXX You would think RaiseError would make this impossible,
1603 # but apparently that's not true :(
1604 $self->throw_exception($dbh->errstr) if !$sth;
1610 my ($self, $sql) = @_;
1611 $self->dbh_do('_dbh_sth', $sql);
1614 sub _dbh_columns_info_for {
1615 my ($self, $dbh, $table) = @_;
1617 if ($dbh->can('column_info')) {
1620 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1621 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1623 while ( my $info = $sth->fetchrow_hashref() ){
1625 $column_info{data_type} = $info->{TYPE_NAME};
1626 $column_info{size} = $info->{COLUMN_SIZE};
1627 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1628 $column_info{default_value} = $info->{COLUMN_DEF};
1629 my $col_name = $info->{COLUMN_NAME};
1630 $col_name =~ s/^\"(.*)\"$/$1/;
1632 $result{$col_name} = \%column_info;
1635 return \%result if !$@ && scalar keys %result;
1639 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1641 my @columns = @{$sth->{NAME_lc}};
1642 for my $i ( 0 .. $#columns ){
1644 $column_info{data_type} = $sth->{TYPE}->[$i];
1645 $column_info{size} = $sth->{PRECISION}->[$i];
1646 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1648 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1649 $column_info{data_type} = $1;
1650 $column_info{size} = $2;
1653 $result{$columns[$i]} = \%column_info;
1657 foreach my $col (keys %result) {
1658 my $colinfo = $result{$col};
1659 my $type_num = $colinfo->{data_type};
1661 if(defined $type_num && $dbh->can('type_info')) {
1662 my $type_info = $dbh->type_info($type_num);
1663 $type_name = $type_info->{TYPE_NAME} if $type_info;
1664 $colinfo->{data_type} = $type_name if $type_name;
1671 sub columns_info_for {
1672 my ($self, $table) = @_;
1673 $self->dbh_do('_dbh_columns_info_for', $table);
1676 =head2 last_insert_id
1678 Return the row id of the last insert.
1682 sub _dbh_last_insert_id {
1683 # All Storage's need to register their own _dbh_last_insert_id
1684 # the old SQLite-based method was highly inappropriate
1687 my $class = ref $self;
1688 $self->throw_exception (<<EOE);
1690 No _dbh_last_insert_id() method found in $class.
1691 Since the method of obtaining the autoincrement id of the last insert
1692 operation varies greatly between different databases, this method must be
1693 individually implemented for every storage class.
1697 sub last_insert_id {
1699 $self->dbh_do('_dbh_last_insert_id', @_);
1704 Returns the database driver name.
1708 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1710 =head2 bind_attribute_by_data_type
1712 Given a datatype from column info, returns a database specific bind
1713 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1714 let the database planner just handle it.
1716 Generally only needed for special case column types, like bytea in postgres.
1720 sub bind_attribute_by_data_type {
1724 =head2 is_datatype_numeric
1726 Given a datatype from column_info, returns a boolean value indicating if
1727 the current RDBMS considers it a numeric value. This controls how
1728 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1729 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1730 be performed instead of the usual C<eq>.
1734 sub is_datatype_numeric {
1735 my ($self, $dt) = @_;
1737 return 0 unless $dt;
1739 return $dt =~ /^ (?:
1740 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1745 =head2 create_ddl_dir (EXPERIMENTAL)
1749 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1753 Creates a SQL file based on the Schema, for each of the specified
1754 database engines in C<\@databases> in the given directory.
1755 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1757 Given a previous version number, this will also create a file containing
1758 the ALTER TABLE statements to transform the previous schema into the
1759 current one. Note that these statements may contain C<DROP TABLE> or
1760 C<DROP COLUMN> statements that can potentially destroy data.
1762 The file names are created using the C<ddl_filename> method below, please
1763 override this method in your schema if you would like a different file
1764 name format. For the ALTER file, the same format is used, replacing
1765 $version in the name with "$preversion-$version".
1767 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1768 The most common value for this would be C<< { add_drop_table => 1 } >>
1769 to have the SQL produced include a C<DROP TABLE> statement for each table
1770 created. For quoting purposes supply C<quote_table_names> and
1771 C<quote_field_names>.
1773 If no arguments are passed, then the following default values are assumed:
1777 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1779 =item version - $schema->schema_version
1781 =item directory - './'
1783 =item preversion - <none>
1787 By default, C<\%sqlt_args> will have
1789 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1791 merged with the hash passed in. To disable any of those features, pass in a
1792 hashref like the following
1794 { ignore_constraint_names => 0, # ... other options }
1797 Note that this feature is currently EXPERIMENTAL and may not work correctly
1798 across all databases, or fully handle complex relationships.
1800 WARNING: Please check all SQL files created, before applying them.
1804 sub create_ddl_dir {
1805 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1807 if(!$dir || !-d $dir) {
1808 carp "No directory given, using ./\n";
1811 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1812 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1814 my $schema_version = $schema->schema_version || '1.x';
1815 $version ||= $schema_version;
1818 add_drop_table => 1,
1819 ignore_constraint_names => 1,
1820 ignore_index_names => 1,
1824 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1825 . $self->_check_sqlt_message . q{'})
1826 if !$self->_check_sqlt_version;
1828 my $sqlt = SQL::Translator->new( $sqltargs );
1830 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1831 my $sqlt_schema = $sqlt->translate({ data => $schema })
1832 or $self->throw_exception ($sqlt->error);
1834 foreach my $db (@$databases) {
1836 $sqlt->{schema} = $sqlt_schema;
1837 $sqlt->producer($db);
1840 my $filename = $schema->ddl_filename($db, $version, $dir);
1841 if (-e $filename && ($version eq $schema_version )) {
1842 # if we are dumping the current version, overwrite the DDL
1843 carp "Overwriting existing DDL file - $filename";
1847 my $output = $sqlt->translate;
1849 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1852 if(!open($file, ">$filename")) {
1853 $self->throw_exception("Can't open $filename for writing ($!)");
1856 print $file $output;
1859 next unless ($preversion);
1861 require SQL::Translator::Diff;
1863 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1864 if(!-e $prefilename) {
1865 carp("No previous schema file found ($prefilename)");
1869 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1871 carp("Overwriting existing diff file - $difffile");
1877 my $t = SQL::Translator->new($sqltargs);
1882 or $self->throw_exception ($t->error);
1884 my $out = $t->translate( $prefilename )
1885 or $self->throw_exception ($t->error);
1887 $source_schema = $t->schema;
1889 $source_schema->name( $prefilename )
1890 unless ( $source_schema->name );
1893 # The "new" style of producers have sane normalization and can support
1894 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
1895 # And we have to diff parsed SQL against parsed SQL.
1896 my $dest_schema = $sqlt_schema;
1898 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
1899 my $t = SQL::Translator->new($sqltargs);
1904 or $self->throw_exception ($t->error);
1906 my $out = $t->translate( $filename )
1907 or $self->throw_exception ($t->error);
1909 $dest_schema = $t->schema;
1911 $dest_schema->name( $filename )
1912 unless $dest_schema->name;
1915 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
1919 if(!open $file, ">$difffile") {
1920 $self->throw_exception("Can't write to $difffile ($!)");
1928 =head2 deployment_statements
1932 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
1936 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
1938 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
1939 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
1941 C<$directory> is used to return statements from files in a previously created
1942 L</create_ddl_dir> directory and is optional. The filenames are constructed
1943 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
1945 If no C<$directory> is specified then the statements are constructed on the
1946 fly using L<SQL::Translator> and C<$version> is ignored.
1948 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
1952 sub deployment_statements {
1953 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
1954 # Need to be connected to get the correct sqlt_type
1955 $self->ensure_connected() unless $type;
1956 $type ||= $self->sqlt_type;
1957 $version ||= $schema->schema_version || '1.x';
1959 my $filename = $schema->ddl_filename($type, $version, $dir);
1963 open($file, "<$filename")
1964 or $self->throw_exception("Can't open $filename ($!)");
1967 return join('', @rows);
1970 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
1971 . $self->_check_sqlt_message . q{'})
1972 if !$self->_check_sqlt_version;
1974 require SQL::Translator::Parser::DBIx::Class;
1975 eval qq{use SQL::Translator::Producer::${type}};
1976 $self->throw_exception($@) if $@;
1978 # sources needs to be a parser arg, but for simplicty allow at top level
1980 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
1981 if exists $sqltargs->{sources};
1983 my $tr = SQL::Translator->new(%$sqltargs);
1984 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
1985 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
1989 my ($self, $schema, $type, $sqltargs, $dir) = @_;
1992 return if($line =~ /^--/);
1994 # next if($line =~ /^DROP/m);
1995 return if($line =~ /^BEGIN TRANSACTION/m);
1996 return if($line =~ /^COMMIT/m);
1997 return if $line =~ /^\s+$/; # skip whitespace only
1998 $self->_query_start($line);
2000 $self->dbh->do($line); # shouldn't be using ->dbh ?
2003 carp qq{$@ (running "${line}")};
2005 $self->_query_end($line);
2007 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2008 if (@statements > 1) {
2009 foreach my $statement (@statements) {
2010 $deploy->( $statement );
2013 elsif (@statements == 1) {
2014 foreach my $line ( split(";\n", $statements[0])) {
2020 =head2 datetime_parser
2022 Returns the datetime parser class
2026 sub datetime_parser {
2028 return $self->{datetime_parser} ||= do {
2029 $self->ensure_connected;
2030 $self->build_datetime_parser(@_);
2034 =head2 datetime_parser_type
2036 Defines (returns) the datetime parser class - currently hardwired to
2037 L<DateTime::Format::MySQL>
2041 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2043 =head2 build_datetime_parser
2045 See L</datetime_parser>
2049 sub build_datetime_parser {
2051 my $type = $self->datetime_parser_type(@_);
2053 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2058 my $_check_sqlt_version; # private
2059 my $_check_sqlt_message; # private
2060 sub _check_sqlt_version {
2061 return $_check_sqlt_version if defined $_check_sqlt_version;
2062 eval 'use SQL::Translator "0.09003"';
2063 $_check_sqlt_message = $@ || '';
2064 $_check_sqlt_version = !$@;
2067 sub _check_sqlt_message {
2068 _check_sqlt_version if !defined $_check_sqlt_message;
2069 $_check_sqlt_message;
2073 =head2 is_replicating
2075 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2076 replicate from a master database. Default is undef, which is the result
2077 returned by databases that don't support replication.
2081 sub is_replicating {
2086 =head2 lag_behind_master
2088 Returns a number that represents a certain amount of lag behind a master db
2089 when a given storage is replicating. The number is database dependent, but
2090 starts at zero and increases with the amount of lag. Default in undef
2094 sub lag_behind_master {
2100 return if !$self->_dbh;
2109 =head2 DBIx::Class and AutoCommit
2111 DBIx::Class can do some wonderful magic with handling exceptions,
2112 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2113 combined with C<txn_do> for transaction support.
2115 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2116 in an assumed transaction between commits, and you're telling us you'd
2117 like to manage that manually. A lot of the magic protections offered by
2118 this module will go away. We can't protect you from exceptions due to database
2119 disconnects because we don't know anything about how to restart your
2120 transactions. You're on your own for handling all sorts of exceptional
2121 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2128 Matt S. Trout <mst@shadowcatsystems.co.uk>
2130 Andy Grundman <andy@hybridized.org>
2134 You may distribute this code under the same terms as Perl itself.