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_call on_disconnect_call on_connect_do on_disconnect_do
24 disable_sth_caching unsafe auto_savepoint
26 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
29 # default cursor class, overridable in connect_info attributes
30 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
32 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
33 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
38 DBIx::Class::Storage::DBI - DBI storage handler
42 my $schema = MySchema->connect('dbi:SQLite:my.db');
44 $schema->storage->debug(1);
45 $schema->dbh_do("DROP TABLE authors");
47 $schema->resultset('Book')->search({
48 written_on => $schema->storage->datetime_parser(DateTime->now)
53 This class represents the connection to an RDBMS via L<DBI>. See
54 L<DBIx::Class::Storage> for general information. This pod only
55 documents DBI-specific methods and behaviors.
62 my $new = shift->next::method(@_);
64 $new->transaction_depth(0);
65 $new->_sql_maker_opts({});
66 $new->{savepoints} = [];
67 $new->{_in_dbh_do} = 0;
75 This method is normally called by L<DBIx::Class::Schema/connection>, which
76 encapsulates its argument list in an arrayref before passing them here.
78 The argument list may contain:
84 The same 4-element argument set one would normally pass to
85 L<DBI/connect>, optionally followed by
86 L<extra attributes|/DBIx::Class specific connection attributes>
87 recognized by DBIx::Class:
89 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
93 A single code reference which returns a connected
94 L<DBI database handle|DBI/connect> optionally followed by
95 L<extra attributes|/DBIx::Class specific connection attributes> recognized
98 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
102 A single hashref with all the attributes and the dsn/user/password
105 $connect_info_args = [{
113 This is particularly useful for L<Catalyst> based applications, allowing the
114 following config (L<Config::General> style):
119 dsn dbi:mysql:database=test
128 Please note that the L<DBI> docs recommend that you always explicitly
129 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
130 recommends that it be set to I<1>, and that you perform transactions
131 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
132 to I<1> if you do not do explicitly set it to zero. This is the default
133 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
135 =head3 DBIx::Class specific connection attributes
137 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
138 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
139 the following connection options. These options can be mixed in with your other
140 L<DBI> connection attributes, or placed in a seperate hashref
141 (C<\%extra_attributes>) as shown above.
143 Every time C<connect_info> is invoked, any previous settings for
144 these options will be cleared before setting the new ones, regardless of
145 whether any options are specified in the new C<connect_info>.
152 Specifies things to do immediately after connecting or re-connecting to
153 the database. Its value may contain:
159 This contains one SQL statement to execute.
161 =item an array reference
163 This contains SQL statements to execute in order. Each element contains
164 a string or a code reference that returns a string.
166 =item a code reference
168 This contains some code to execute. Unlike code references within an
169 array reference, its return value is ignored.
173 =item on_disconnect_do
175 Takes arguments in the same form as L</on_connect_do> and executes them
176 immediately before disconnecting from the database.
178 Note, this only runs if you explicitly call L</disconnect> on the
181 =item on_connect_call
183 A more generalized form of L</on_connect_do> that calls the specified
184 C<connect_call_METHOD> methods in your storage driver.
186 on_connect_do => 'select 1'
190 on_connect_call => [ [ do_sql => 'select 1' ] ]
192 Its values may contain:
198 Will call the C<connect_call_METHOD> method.
200 =item a code reference
202 Will execute C<< $code->($storage) >>
204 =item an array reference
206 Each value can be a method name or code reference.
208 =item an array of arrays
210 For each array, the first item is taken to be the C<connect_call_> method name
211 or code reference, and the rest are parameters to it.
215 Some predefined storage methods you may use:
221 Executes a SQL string or a code reference that returns a SQL string. This is
222 what L</on_connect_do> and L</on_disconnect_do> use.
230 Will execute the scalar as SQL.
234 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
235 attributes hashref and bind values.
237 =item a code reference
239 Will execute C<< $code->($storage) >> and execute the return array refs as
246 Execute any statements necessary to initialize the database session to return
247 and accept datetime/timestamp values used with
248 L<DBIx::Class::InflateColumn::DateTime>.
250 Only necessary for some databases, see your specific storage driver for
251 implementation details.
255 =item on_disconnect_call
257 Takes arguments in the same form as L</on_connect_call> and executes them
258 immediately before disconnecting from the database.
260 Calls the C<disconnect_call_METHOD> methods as opposed to the
261 C<connect_call_METHOD> methods called by L</on_connect_call>.
263 Note, this only runs if you explicitly call L</disconnect> on the
266 =item disable_sth_caching
268 If set to a true value, this option will disable the caching of
269 statement handles via L<DBI/prepare_cached>.
273 Sets the limit dialect. This is useful for JDBC-bridge among others
274 where the remote SQL-dialect cannot be determined by the name of the
275 driver alone. See also L<SQL::Abstract::Limit>.
279 Specifies what characters to use to quote table and column names. If
280 you use this you will want to specify L</name_sep> as well.
282 C<quote_char> expects either a single character, in which case is it
283 is placed on either side of the table/column name, or an arrayref of length
284 2 in which case the table/column name is placed between the elements.
286 For example under MySQL you should use C<< quote_char => '`' >>, and for
287 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
291 This only needs to be used in conjunction with C<quote_char>, and is used to
292 specify the charecter that seperates elements (schemas, tables, columns) from
293 each other. In most cases this is simply a C<.>.
295 The consequences of not supplying this value is that L<SQL::Abstract>
296 will assume DBIx::Class' uses of aliases to be complete column
297 names. The output will look like I<"me.name"> when it should actually
302 This Storage driver normally installs its own C<HandleError>, sets
303 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
304 all database handles, including those supplied by a coderef. It does this
305 so that it can have consistent and useful error behavior.
307 If you set this option to a true value, Storage will not do its usual
308 modifications to the database handle's attributes, and instead relies on
309 the settings in your connect_info DBI options (or the values you set in
310 your connection coderef, in the case that you are connecting via coderef).
312 Note that your custom settings can cause Storage to malfunction,
313 especially if you set a C<HandleError> handler that suppresses exceptions
314 and/or disable C<RaiseError>.
318 If this option is true, L<DBIx::Class> will use savepoints when nesting
319 transactions, making it possible to recover from failure in the inner
320 transaction without having to abort all outer transactions.
324 Use this argument to supply a cursor class other than the default
325 L<DBIx::Class::Storage::DBI::Cursor>.
329 Some real-life examples of arguments to L</connect_info> and
330 L<DBIx::Class::Schema/connect>
332 # Simple SQLite connection
333 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
336 ->connect_info([ sub { DBI->connect(...) } ]);
338 # A bit more complicated
345 { quote_char => q{"}, name_sep => q{.} },
349 # Equivalent to the previous example
355 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
359 # Same, but with hashref as argument
360 # See parse_connect_info for explanation
363 dsn => 'dbi:Pg:dbname=foo',
365 password => 'my_pg_password',
372 # Subref + DBIx::Class-specific connection options
375 sub { DBI->connect(...) },
379 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
380 disable_sth_caching => 1,
390 my ($self, $info_arg) = @_;
392 return $self->_connect_info if !$info_arg;
394 my @args = @$info_arg; # take a shallow copy for further mutilation
395 $self->_connect_info([@args]); # copy for _connect_info
398 # combine/pre-parse arguments depending on invocation style
401 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
402 %attrs = %{ $args[1] || {} };
405 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
406 %attrs = %{$args[0]};
408 for (qw/password user dsn/) {
409 unshift @args, delete $attrs{$_};
412 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
414 % { $args[3] || {} },
415 % { $args[4] || {} },
417 @args = @args[0,1,2];
420 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
421 # the new set of options
422 $self->_sql_maker(undef);
423 $self->_sql_maker_opts({});
426 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
427 if(my $value = delete $attrs{$storage_opt}) {
428 $self->$storage_opt($value);
431 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
432 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
433 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
438 %attrs = () if (ref $args[0] eq 'CODE'); # _connect() never looks past $args[0] in this case
440 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
441 $self->_connect_info;
446 This method is deprecated in favour of setting via L</connect_info>.
450 =head2 on_disconnect_do
452 This method is deprecated in favour of setting via L</connect_info>.
456 sub _parse_connect_do {
457 my ($self, $type) = @_;
459 my $val = $self->$type;
460 return () if not defined $val;
465 push @res, [ 'do_sql', $val ];
466 } elsif (ref($val) eq 'CODE') {
468 } elsif (ref($val) eq 'ARRAY') {
469 push @res, map { [ 'do_sql', $_ ] } @$val;
471 $self->throw_exception("Invalid type for $type: ".ref($val));
479 Arguments: ($subref | $method_name), @extra_coderef_args?
481 Execute the given $subref or $method_name using the new exception-based
482 connection management.
484 The first two arguments will be the storage object that C<dbh_do> was called
485 on and a database handle to use. Any additional arguments will be passed
486 verbatim to the called subref as arguments 2 and onwards.
488 Using this (instead of $self->_dbh or $self->dbh) ensures correct
489 exception handling and reconnection (or failover in future subclasses).
491 Your subref should have no side-effects outside of the database, as
492 there is the potential for your subref to be partially double-executed
493 if the database connection was stale/dysfunctional.
497 my @stuff = $schema->storage->dbh_do(
499 my ($storage, $dbh, @cols) = @_;
500 my $cols = join(q{, }, @cols);
501 $dbh->selectrow_array("SELECT $cols FROM foo");
512 my $dbh = $self->_dbh;
514 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
515 || $self->{transaction_depth};
517 local $self->{_in_dbh_do} = 1;
520 my $want_array = wantarray;
523 $self->_verify_pid if $dbh;
525 $self->_populate_dbh;
530 @result = $self->$code($dbh, @_);
532 elsif(defined $want_array) {
533 $result[0] = $self->$code($dbh, @_);
536 $self->$code($dbh, @_);
541 if(!$exception) { return $want_array ? @result : $result[0] }
543 $self->throw_exception($exception) if $self->connected;
545 # We were not connected - reconnect and retry, but let any
546 # exception fall right through this time
547 $self->_populate_dbh;
548 $self->$code($self->_dbh, @_);
551 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
552 # It also informs dbh_do to bypass itself while under the direction of txn_do,
553 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
558 ref $coderef eq 'CODE' or $self->throw_exception
559 ('$coderef must be a CODE reference');
561 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
563 local $self->{_in_dbh_do} = 1;
566 my $want_array = wantarray;
571 $self->_verify_pid if $self->_dbh;
572 $self->_populate_dbh if !$self->_dbh;
576 @result = $coderef->(@_);
578 elsif(defined $want_array) {
579 $result[0] = $coderef->(@_);
588 if(!$exception) { return $want_array ? @result : $result[0] }
590 if($tried++ > 0 || $self->connected) {
591 eval { $self->txn_rollback };
592 my $rollback_exception = $@;
593 if($rollback_exception) {
594 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
595 $self->throw_exception($exception) # propagate nested rollback
596 if $rollback_exception =~ /$exception_class/;
598 $self->throw_exception(
599 "Transaction aborted: ${exception}. "
600 . "Rollback failed: ${rollback_exception}"
603 $self->throw_exception($exception)
606 # We were not connected, and was first try - reconnect and retry
608 $self->_populate_dbh;
614 Our C<disconnect> method also performs a rollback first if the
615 database is not in C<AutoCommit> mode.
622 if( $self->connected ) {
625 push @actions, ( $self->on_disconnect_call || () );
626 push @actions, $self->_parse_connect_do ('on_disconnect_do');
628 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
630 $self->_dbh->rollback unless $self->_dbh_autocommit;
631 $self->_dbh->disconnect;
637 =head2 with_deferred_fk_checks
641 =item Arguments: C<$coderef>
643 =item Return Value: The return value of $coderef
647 Storage specific method to run the code ref with FK checks deferred or
648 in MySQL's case disabled entirely.
652 # Storage subclasses should override this
653 sub with_deferred_fk_checks {
654 my ($self, $sub) = @_;
662 if(my $dbh = $self->_dbh) {
663 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
670 return 0 if !$self->_dbh;
672 return ($dbh->FETCH('Active') && $dbh->ping);
678 # handle pid changes correctly
679 # NOTE: assumes $self->_dbh is a valid $dbh
683 return if defined $self->_conn_pid && $self->_conn_pid == $$;
685 $self->_dbh->{InactiveDestroy} = 1;
692 sub ensure_connected {
695 unless ($self->connected) {
696 $self->_populate_dbh;
702 Returns the dbh - a data base handle of class L<DBI>.
709 $self->ensure_connected;
713 sub _sql_maker_args {
716 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
721 unless ($self->_sql_maker) {
722 my $sql_maker_class = $self->sql_maker_class;
723 $self->ensure_class_loaded ($sql_maker_class);
724 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
726 return $self->_sql_maker;
733 my @info = @{$self->_dbi_connect_info || []};
734 $self->_dbh($self->_connect(@info));
736 $self->_conn_pid($$);
737 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
739 $self->_determine_driver;
741 # Always set the transaction depth on connect, since
742 # there is no transaction in progress by definition
743 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
747 push @actions, ( $self->on_connect_call || () );
748 push @actions, $self->_parse_connect_do ('on_connect_do');
750 $self->_do_connection_actions(connect_call_ => $_) for @actions;
753 sub _determine_driver {
756 if (ref $self eq 'DBIx::Class::Storage::DBI') {
759 if ($self->_dbh) { # we are connected
760 $driver = $self->_dbh->{Driver}{Name};
762 # try to use dsn to not require being connected, the driver may still
763 # force a connection in _rebless to determine version
764 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
767 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
768 bless $self, "DBIx::Class::Storage::DBI::${driver}";
774 sub _do_connection_actions {
776 my $method_prefix = shift;
779 if (not ref($call)) {
780 my $method = $method_prefix . $call;
782 } elsif (ref($call) eq 'CODE') {
784 } elsif (ref($call) eq 'ARRAY') {
785 if (ref($call->[0]) ne 'ARRAY') {
786 $self->_do_connection_actions($method_prefix, $_) for @$call;
788 $self->_do_connection_actions($method_prefix, @$_) for @$call;
791 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
797 sub connect_call_do_sql {
799 $self->_do_query(@_);
802 sub disconnect_call_do_sql {
804 $self->_do_query(@_);
807 # override in db-specific backend when necessary
808 sub connect_call_datetime_setup { 1 }
811 my ($self, $action) = @_;
813 if (ref $action eq 'CODE') {
814 $action = $action->($self);
815 $self->_do_query($_) foreach @$action;
818 # Most debuggers expect ($sql, @bind), so we need to exclude
819 # the attribute hash which is the second argument to $dbh->do
820 # furthermore the bind values are usually to be presented
821 # as named arrayref pairs, so wrap those here too
822 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
823 my $sql = shift @do_args;
824 my $attrs = shift @do_args;
825 my @bind = map { [ undef, $_ ] } @do_args;
827 $self->_query_start($sql, @bind);
828 $self->_dbh->do($sql, $attrs, @do_args);
829 $self->_query_end($sql, @bind);
836 my ($self, @info) = @_;
838 $self->throw_exception("You failed to provide any connection info")
841 my ($old_connect_via, $dbh);
843 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
844 $old_connect_via = $DBI::connect_via;
845 $DBI::connect_via = 'connect';
849 if(ref $info[0] eq 'CODE') {
853 $dbh = DBI->connect(@info);
856 if($dbh && !$self->unsafe) {
857 my $weak_self = $self;
858 Scalar::Util::weaken($weak_self);
859 $dbh->{HandleError} = sub {
861 $weak_self->throw_exception("DBI Exception: $_[0]");
864 croak ("DBI Exception: $_[0]");
867 $dbh->{ShowErrorStatement} = 1;
868 $dbh->{RaiseError} = 1;
869 $dbh->{PrintError} = 0;
873 $DBI::connect_via = $old_connect_via if $old_connect_via;
875 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
878 $self->_dbh_autocommit($dbh->{AutoCommit});
884 my ($self, $name) = @_;
886 $name = $self->_svp_generate_name
887 unless defined $name;
889 $self->throw_exception ("You can't use savepoints outside a transaction")
890 if $self->{transaction_depth} == 0;
892 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
893 unless $self->can('_svp_begin');
895 push @{ $self->{savepoints} }, $name;
897 $self->debugobj->svp_begin($name) if $self->debug;
899 return $self->_svp_begin($name);
903 my ($self, $name) = @_;
905 $self->throw_exception ("You can't use savepoints outside a transaction")
906 if $self->{transaction_depth} == 0;
908 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
909 unless $self->can('_svp_release');
912 $self->throw_exception ("Savepoint '$name' does not exist")
913 unless grep { $_ eq $name } @{ $self->{savepoints} };
915 # Dig through the stack until we find the one we are releasing. This keeps
916 # the stack up to date.
919 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
921 $name = pop @{ $self->{savepoints} };
924 $self->debugobj->svp_release($name) if $self->debug;
926 return $self->_svp_release($name);
930 my ($self, $name) = @_;
932 $self->throw_exception ("You can't use savepoints outside a transaction")
933 if $self->{transaction_depth} == 0;
935 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
936 unless $self->can('_svp_rollback');
939 # If they passed us a name, verify that it exists in the stack
940 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
941 $self->throw_exception("Savepoint '$name' does not exist!");
944 # Dig through the stack until we find the one we are releasing. This keeps
945 # the stack up to date.
946 while(my $s = pop(@{ $self->{savepoints} })) {
947 last if($s eq $name);
949 # Add the savepoint back to the stack, as a rollback doesn't remove the
950 # named savepoint, only everything after it.
951 push(@{ $self->{savepoints} }, $name);
953 # We'll assume they want to rollback to the last savepoint
954 $name = $self->{savepoints}->[-1];
957 $self->debugobj->svp_rollback($name) if $self->debug;
959 return $self->_svp_rollback($name);
962 sub _svp_generate_name {
965 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
970 $self->ensure_connected();
971 if($self->{transaction_depth} == 0) {
972 $self->debugobj->txn_begin()
974 # this isn't ->_dbh-> because
975 # we should reconnect on begin_work
976 # for AutoCommit users
977 $self->dbh->begin_work;
978 } elsif ($self->auto_savepoint) {
981 $self->{transaction_depth}++;
986 if ($self->{transaction_depth} == 1) {
987 my $dbh = $self->_dbh;
988 $self->debugobj->txn_commit()
991 $self->{transaction_depth} = 0
992 if $self->_dbh_autocommit;
994 elsif($self->{transaction_depth} > 1) {
995 $self->{transaction_depth}--;
997 if $self->auto_savepoint;
1003 my $dbh = $self->_dbh;
1005 if ($self->{transaction_depth} == 1) {
1006 $self->debugobj->txn_rollback()
1008 $self->{transaction_depth} = 0
1009 if $self->_dbh_autocommit;
1012 elsif($self->{transaction_depth} > 1) {
1013 $self->{transaction_depth}--;
1014 if ($self->auto_savepoint) {
1015 $self->svp_rollback;
1020 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1025 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1026 $error =~ /$exception_class/ and $self->throw_exception($error);
1027 # ensure that a failed rollback resets the transaction depth
1028 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1029 $self->throw_exception($error);
1033 # This used to be the top-half of _execute. It was split out to make it
1034 # easier to override in NoBindVars without duping the rest. It takes up
1035 # all of _execute's args, and emits $sql, @bind.
1036 sub _prep_for_execute {
1037 my ($self, $op, $extra_bind, $ident, $args) = @_;
1039 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1040 $ident = $ident->from();
1043 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1046 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1048 return ($sql, \@bind);
1052 sub _fix_bind_params {
1053 my ($self, @bind) = @_;
1055 ### Turn @bind from something like this:
1056 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1058 ### ( "'1'", "'1'", "'3'" )
1061 if ( defined( $_ && $_->[1] ) ) {
1062 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1068 sub _flatten_bind_params {
1069 my ($self, @bind) = @_;
1071 ### Turn @bind from something like this:
1072 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1077 if ( defined( $_ && $_->[1] ) ) {
1085 my ( $self, $sql, @bind ) = @_;
1087 if ( $self->debug ) {
1088 @bind = $self->_fix_bind_params(@bind);
1090 $self->debugobj->query_start( $sql, @bind );
1095 my ( $self, $sql, @bind ) = @_;
1097 if ( $self->debug ) {
1098 @bind = $self->_fix_bind_params(@bind);
1099 $self->debugobj->query_end( $sql, @bind );
1104 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1106 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1108 $self->_query_start( $sql, @$bind );
1110 my $sth = $self->sth($sql,$op);
1112 my $placeholder_index = 1;
1114 foreach my $bound (@$bind) {
1115 my $attributes = {};
1116 my($column_name, @data) = @$bound;
1118 if ($bind_attributes) {
1119 $attributes = $bind_attributes->{$column_name}
1120 if defined $bind_attributes->{$column_name};
1123 foreach my $data (@data) {
1124 my $ref = ref $data;
1125 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1127 $sth->bind_param($placeholder_index, $data, $attributes);
1128 $placeholder_index++;
1132 # Can this fail without throwing an exception anyways???
1133 my $rv = $sth->execute();
1134 $self->throw_exception($sth->errstr) if !$rv;
1136 $self->_query_end( $sql, @$bind );
1138 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1143 $self->dbh_do('_dbh_execute', @_)
1147 my ($self, $source, $to_insert) = @_;
1149 my $ident = $source->from;
1150 my $bind_attributes = $self->source_bind_attributes($source);
1152 my $updated_cols = {};
1154 $self->ensure_connected;
1155 foreach my $col ( $source->columns ) {
1156 if ( !defined $to_insert->{$col} ) {
1157 my $col_info = $source->column_info($col);
1159 if ( $col_info->{auto_nextval} ) {
1160 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1165 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1167 return $updated_cols;
1170 ## Still not quite perfect, and EXPERIMENTAL
1171 ## Currently it is assumed that all values passed will be "normal", i.e. not
1172 ## scalar refs, or at least, all the same type as the first set, the statement is
1173 ## only prepped once.
1175 my ($self, $source, $cols, $data) = @_;
1177 my $table = $source->from;
1178 @colvalues{@$cols} = (0..$#$cols);
1179 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1181 $self->_query_start( $sql, @bind );
1182 my $sth = $self->sth($sql);
1184 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1186 ## This must be an arrayref, else nothing works!
1187 my $tuple_status = [];
1189 ## Get the bind_attributes, if any exist
1190 my $bind_attributes = $self->source_bind_attributes($source);
1192 ## Bind the values and execute
1193 my $placeholder_index = 1;
1195 foreach my $bound (@bind) {
1197 my $attributes = {};
1198 my ($column_name, $data_index) = @$bound;
1200 if( $bind_attributes ) {
1201 $attributes = $bind_attributes->{$column_name}
1202 if defined $bind_attributes->{$column_name};
1205 my @data = map { $_->[$data_index] } @$data;
1207 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1208 $placeholder_index++;
1210 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1213 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1215 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1216 if ($i > $#$tuple_status);
1218 require Data::Dumper;
1219 local $Data::Dumper::Terse = 1;
1220 local $Data::Dumper::Indent = 1;
1221 local $Data::Dumper::Useqq = 1;
1222 local $Data::Dumper::Quotekeys = 0;
1224 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1225 $tuple_status->[$i][1],
1226 Data::Dumper::Dumper(
1227 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1231 $self->throw_exception($sth->errstr) if !$rv;
1233 $self->_query_end( $sql, @bind );
1234 return (wantarray ? ($rv, $sth, @bind) : $rv);
1238 my $self = shift @_;
1239 my $source = shift @_;
1240 my $bind_attributes = $self->source_bind_attributes($source);
1242 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1247 my $self = shift @_;
1248 my $source = shift @_;
1250 my $bind_attrs = $self->source_bind_attributes($source);
1252 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1255 # We were sent here because the $rs contains a complex search
1256 # which will require a subquery to select the correct rows
1257 # (i.e. joined or limited resultsets)
1259 # Genarating a single PK column subquery is trivial and supported
1260 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1261 # Look at _multipk_update_delete()
1262 sub _subq_update_delete {
1264 my ($rs, $op, $values) = @_;
1266 my $rsrc = $rs->result_source;
1268 # we already check this, but double check naively just in case. Should be removed soon
1269 my $sel = $rs->_resolved_attrs->{select};
1270 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1271 my @pcols = $rsrc->primary_columns;
1272 if (@$sel != @pcols) {
1273 $self->throw_exception (
1274 'Subquery update/delete can not be called on resultsets selecting a'
1275 .' number of columns different than the number of primary keys'
1282 $op eq 'update' ? $values : (),
1283 { $pcols[0] => { -in => $rs->as_query } },
1288 return $self->_multipk_update_delete (@_);
1292 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1293 # resultset update/delete involving subqueries. So by default resort
1294 # to simple (and inefficient) delete_all style per-row opearations,
1295 # while allowing specific storages to override this with a faster
1298 sub _multipk_update_delete {
1299 return shift->_per_row_update_delete (@_);
1302 # This is the default loop used to delete/update rows for multi PK
1303 # resultsets, and used by mysql exclusively (because it can't do anything
1306 # We do not use $row->$op style queries, because resultset update/delete
1307 # is not expected to cascade (this is what delete_all/update_all is for).
1309 # There should be no race conditions as the entire operation is rolled
1312 sub _per_row_update_delete {
1314 my ($rs, $op, $values) = @_;
1316 my $rsrc = $rs->result_source;
1317 my @pcols = $rsrc->primary_columns;
1319 my $guard = $self->txn_scope_guard;
1321 # emulate the return value of $sth->execute for non-selects
1322 my $row_cnt = '0E0';
1324 my $subrs_cur = $rs->cursor;
1325 while (my @pks = $subrs_cur->next) {
1328 for my $i (0.. $#pcols) {
1329 $cond->{$pcols[$i]} = $pks[$i];
1334 $op eq 'update' ? $values : (),
1349 # localization is neccessary as
1350 # 1) there is no infrastructure to pass this around (easy to do, but will wait)
1351 # 2) _select_args sets it and _prep_for_execute consumes it
1352 my $sql_maker = $self->sql_maker;
1353 local $sql_maker->{for};
1355 return $self->_execute($self->_select_args(@_));
1358 sub _select_args_to_query {
1361 # localization is neccessary as
1362 # 1) there is no infrastructure to pass this around (easy to do, but will wait)
1363 # 2) _select_args sets it and _prep_for_execute consumes it
1364 my $sql_maker = $self->sql_maker;
1365 local $sql_maker->{for};
1367 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1368 # = $self->_select_args($ident, $select, $cond, $attrs);
1369 my ($op, $bind, $ident, $bind_attrs, @args) =
1370 $self->_select_args(@_);
1372 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1373 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1374 $prepared_bind ||= [];
1377 ? ($sql, $prepared_bind, $bind_attrs)
1378 : \[ "($sql)", @$prepared_bind ]
1383 my ($self, $ident, $select, $where, $attrs) = @_;
1385 my $sql_maker = $self->sql_maker;
1386 my $alias2source = $self->_resolve_ident_sources ($ident);
1388 # calculate bind_attrs before possible $ident mangling
1389 my $bind_attrs = {};
1390 for my $alias (keys %$alias2source) {
1391 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1392 for my $col (keys %$bindtypes) {
1394 my $fqcn = join ('.', $alias, $col);
1395 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1397 # so that unqualified searches can be bound too
1398 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq 'me';
1403 if ($attrs->{software_limit} ||
1404 $sql_maker->_default_limit_syntax eq "GenericSubQ") {
1405 $attrs->{software_limit} = 1;
1407 $self->throw_exception("rows attribute must be positive if present")
1408 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1410 # MySQL actually recommends this approach. I cringe.
1411 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1413 if ($attrs->{rows} && keys %{$attrs->{collapse}}) {
1414 ($ident, $select, $where, $attrs)
1415 = $self->_adjust_select_args_for_limited_prefetch ($ident, $select, $where, $attrs);
1418 push @limit, $attrs->{rows}, $attrs->{offset};
1423 # This would be the point to deflate anything found in $where
1424 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1425 # expect a row object. And all we have is a resultsource (it is trivial
1426 # to extract deflator coderefs via $alias2source above).
1428 # I don't see a way forward other than changing the way deflators are
1429 # invoked, and that's just bad...
1433 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1434 (qw/order_by group_by having _virtual_order_by/ )
1438 $sql_maker->{for} = delete $attrs->{for};
1440 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1443 sub _adjust_select_args_for_limited_prefetch {
1444 my ($self, $from, $select, $where, $attrs) = @_;
1446 if ($attrs->{group_by} and @{$attrs->{group_by}}) {
1447 $self->throw_exception ('Prefetch with limit (rows/offset) is not supported on resultsets with a group_by attribute');
1450 $self->throw_exception ('Prefetch with limit (rows/offset) is not supported on resultsets with a custom from attribute')
1451 if (ref $from ne 'ARRAY');
1454 # separate attributes
1455 my $sub_attrs = { %$attrs };
1456 delete $attrs->{$_} for qw/where bind rows offset/;
1457 delete $sub_attrs->{$_} for qw/for collapse select order_by/;
1459 my $alias = $attrs->{alias};
1461 # create subquery select list
1462 my $sub_select = [ grep { $_ =~ /^$alias\./ } @{$attrs->{select}} ];
1464 # bring over all non-collapse-induced order_by into the inner query (if any)
1465 # the outer one will have to keep them all
1466 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1467 $sub_attrs->{order_by} = [
1468 @{$attrs->{order_by}}[ 0 .. ($#{$attrs->{order_by}} - $ord_cnt - 1) ]
1474 my $select_root = shift @$from;
1475 my @outer_from = @$from;
1478 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1480 # in complex search_related chains $alias may *not* be 'me'
1481 # so always include it in the inner join, and also shift away
1482 # from the outer stack, so that the two datasets actually do
1484 if ($select_root->{-alias} ne $alias) {
1485 $inner_joins{$alias} = 1;
1487 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1490 if (! @outer_from) {
1491 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1494 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1498 # decide which parts of the join will remain on the inside
1500 # this is not a very viable optimisation, but it was written
1501 # before I realised this, so might as well remain. We can throw
1502 # away _any_ branches of the join tree that are:
1503 # 1) not mentioned in the condition/order
1504 # 2) left-join leaves (or left-join leaf chains)
1505 # Most of the join ocnditions will not satisfy this, but for real
1506 # complex queries some might, and we might make some RDBMS happy.
1509 # since we do not have introspectable SQLA, we fall back to ugly
1510 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1511 # in order to determine what goes into %inner_joins
1512 # It may not be very efficient, but it's a reasonable stop-gap
1514 # produce stuff unquoted, so it can be scanned
1515 my $sql_maker = $self->sql_maker;
1516 local $sql_maker->{quote_char};
1519 { ref $_ ? $_->[0] : $_ }
1520 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1523 my $where_sql = $sql_maker->where ($where);
1526 for my $alias (keys %join_info) {
1528 # any table alias found on a column name in where or order_by
1529 # gets included in %inner_joins
1530 # Also any parent joins that are needed to reach this particular alias
1531 for my $piece ($where_sql, @order_by ) {
1532 if ($piece =~ /\b$alias\./) {
1533 $inner_joins{$alias} = 1;
1539 # scan for non-leaf/non-left joins and mark as needed
1540 # also mark all ancestor joins that are needed to reach this particular alias
1541 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1543 # traverse by the size of the -join_path i.e. reverse depth first
1544 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1546 my $j = $join_info{$alias};
1547 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1549 if ($inner_joins{$alias}) {
1550 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1554 # construct the inner $from for the subquery
1555 my $inner_from = [ $select_root ];
1556 for my $j (@$from) {
1557 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1560 # if a multi-type join was needed in the subquery ("multi" is indicated by
1561 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1563 for my $alias (keys %inner_joins) {
1565 # the dot comes from some weirdness in collapse
1566 # remove after the rewrite
1567 if ($attrs->{collapse}{".$alias"}) {
1568 $sub_attrs->{group_by} = $sub_select;
1573 # generate the subquery
1574 my $subq = $self->_select_args_to_query (
1581 # put it in the new {from}
1582 unshift @outer_from, { $alias => $subq };
1584 # This is totally horrific - the $where ends up in both the inner and outer query
1585 # Unfortunately not much can be done until SQLA2 introspection arrives
1587 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1588 return (\@outer_from, $select, $where, $attrs);
1591 sub _resolve_ident_sources {
1592 my ($self, $ident) = @_;
1594 my $alias2source = {};
1596 # the reason this is so contrived is that $ident may be a {from}
1597 # structure, specifying multiple tables to join
1598 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1599 # this is compat mode for insert/update/delete which do not deal with aliases
1600 $alias2source->{me} = $ident;
1602 elsif (ref $ident eq 'ARRAY') {
1606 if (ref $_ eq 'HASH') {
1609 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1613 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1614 if ($tabinfo->{-source_handle});
1618 return $alias2source;
1621 # Returns a counting SELECT for a simple count
1622 # query. Abstracted so that a storage could override
1623 # this to { count => 'firstcol' } or whatever makes
1624 # sense as a performance optimization
1626 #my ($self, $source, $rs_attrs) = @_;
1627 return { count => '*' };
1630 # Returns a SELECT which will end up in the subselect
1631 # There may or may not be a group_by, as the subquery
1632 # might have been called to accomodate a limit
1634 # Most databases would be happy with whatever ends up
1635 # here, but some choke in various ways.
1637 sub _subq_count_select {
1638 my ($self, $source, $rs_attrs) = @_;
1639 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1641 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1642 return @pcols ? \@pcols : [ 1 ];
1646 sub source_bind_attributes {
1647 my ($self, $source) = @_;
1649 my $bind_attributes;
1650 foreach my $column ($source->columns) {
1652 my $data_type = $source->column_info($column)->{data_type} || '';
1653 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1657 return $bind_attributes;
1664 =item Arguments: $ident, $select, $condition, $attrs
1668 Handle a SQL select statement.
1674 my ($ident, $select, $condition, $attrs) = @_;
1675 return $self->cursor_class->new($self, \@_, $attrs);
1680 my ($rv, $sth, @bind) = $self->_select(@_);
1681 my @row = $sth->fetchrow_array;
1682 my @nextrow = $sth->fetchrow_array if @row;
1683 if(@row && @nextrow) {
1684 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1686 # Need to call finish() to work round broken DBDs
1695 =item Arguments: $sql
1699 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1704 my ($self, $dbh, $sql) = @_;
1706 # 3 is the if_active parameter which avoids active sth re-use
1707 my $sth = $self->disable_sth_caching
1708 ? $dbh->prepare($sql)
1709 : $dbh->prepare_cached($sql, {}, 3);
1711 # XXX You would think RaiseError would make this impossible,
1712 # but apparently that's not true :(
1713 $self->throw_exception($dbh->errstr) if !$sth;
1719 my ($self, $sql) = @_;
1720 $self->dbh_do('_dbh_sth', $sql);
1723 sub _dbh_columns_info_for {
1724 my ($self, $dbh, $table) = @_;
1726 if ($dbh->can('column_info')) {
1729 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1730 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1732 while ( my $info = $sth->fetchrow_hashref() ){
1734 $column_info{data_type} = $info->{TYPE_NAME};
1735 $column_info{size} = $info->{COLUMN_SIZE};
1736 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1737 $column_info{default_value} = $info->{COLUMN_DEF};
1738 my $col_name = $info->{COLUMN_NAME};
1739 $col_name =~ s/^\"(.*)\"$/$1/;
1741 $result{$col_name} = \%column_info;
1744 return \%result if !$@ && scalar keys %result;
1748 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1750 my @columns = @{$sth->{NAME_lc}};
1751 for my $i ( 0 .. $#columns ){
1753 $column_info{data_type} = $sth->{TYPE}->[$i];
1754 $column_info{size} = $sth->{PRECISION}->[$i];
1755 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1757 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1758 $column_info{data_type} = $1;
1759 $column_info{size} = $2;
1762 $result{$columns[$i]} = \%column_info;
1766 foreach my $col (keys %result) {
1767 my $colinfo = $result{$col};
1768 my $type_num = $colinfo->{data_type};
1770 if(defined $type_num && $dbh->can('type_info')) {
1771 my $type_info = $dbh->type_info($type_num);
1772 $type_name = $type_info->{TYPE_NAME} if $type_info;
1773 $colinfo->{data_type} = $type_name if $type_name;
1780 sub columns_info_for {
1781 my ($self, $table) = @_;
1782 $self->dbh_do('_dbh_columns_info_for', $table);
1785 =head2 last_insert_id
1787 Return the row id of the last insert.
1791 sub _dbh_last_insert_id {
1792 # All Storage's need to register their own _dbh_last_insert_id
1793 # the old SQLite-based method was highly inappropriate
1796 my $class = ref $self;
1797 $self->throw_exception (<<EOE);
1799 No _dbh_last_insert_id() method found in $class.
1800 Since the method of obtaining the autoincrement id of the last insert
1801 operation varies greatly between different databases, this method must be
1802 individually implemented for every storage class.
1806 sub last_insert_id {
1808 $self->dbh_do('_dbh_last_insert_id', @_);
1813 Returns the database driver name.
1817 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1819 =head2 bind_attribute_by_data_type
1821 Given a datatype from column info, returns a database specific bind
1822 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1823 let the database planner just handle it.
1825 Generally only needed for special case column types, like bytea in postgres.
1829 sub bind_attribute_by_data_type {
1833 =head2 is_datatype_numeric
1835 Given a datatype from column_info, returns a boolean value indicating if
1836 the current RDBMS considers it a numeric value. This controls how
1837 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1838 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1839 be performed instead of the usual C<eq>.
1843 sub is_datatype_numeric {
1844 my ($self, $dt) = @_;
1846 return 0 unless $dt;
1848 return $dt =~ /^ (?:
1849 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1854 =head2 create_ddl_dir (EXPERIMENTAL)
1858 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1862 Creates a SQL file based on the Schema, for each of the specified
1863 database engines in C<\@databases> in the given directory.
1864 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1866 Given a previous version number, this will also create a file containing
1867 the ALTER TABLE statements to transform the previous schema into the
1868 current one. Note that these statements may contain C<DROP TABLE> or
1869 C<DROP COLUMN> statements that can potentially destroy data.
1871 The file names are created using the C<ddl_filename> method below, please
1872 override this method in your schema if you would like a different file
1873 name format. For the ALTER file, the same format is used, replacing
1874 $version in the name with "$preversion-$version".
1876 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1877 The most common value for this would be C<< { add_drop_table => 1 } >>
1878 to have the SQL produced include a C<DROP TABLE> statement for each table
1879 created. For quoting purposes supply C<quote_table_names> and
1880 C<quote_field_names>.
1882 If no arguments are passed, then the following default values are assumed:
1886 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1888 =item version - $schema->schema_version
1890 =item directory - './'
1892 =item preversion - <none>
1896 By default, C<\%sqlt_args> will have
1898 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1900 merged with the hash passed in. To disable any of those features, pass in a
1901 hashref like the following
1903 { ignore_constraint_names => 0, # ... other options }
1906 Note that this feature is currently EXPERIMENTAL and may not work correctly
1907 across all databases, or fully handle complex relationships.
1909 WARNING: Please check all SQL files created, before applying them.
1913 sub create_ddl_dir {
1914 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1916 if(!$dir || !-d $dir) {
1917 carp "No directory given, using ./\n";
1920 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1921 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1923 my $schema_version = $schema->schema_version || '1.x';
1924 $version ||= $schema_version;
1927 add_drop_table => 1,
1928 ignore_constraint_names => 1,
1929 ignore_index_names => 1,
1933 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1934 . $self->_check_sqlt_message . q{'})
1935 if !$self->_check_sqlt_version;
1937 my $sqlt = SQL::Translator->new( $sqltargs );
1939 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1940 my $sqlt_schema = $sqlt->translate({ data => $schema })
1941 or $self->throw_exception ($sqlt->error);
1943 foreach my $db (@$databases) {
1945 $sqlt->{schema} = $sqlt_schema;
1946 $sqlt->producer($db);
1949 my $filename = $schema->ddl_filename($db, $version, $dir);
1950 if (-e $filename && ($version eq $schema_version )) {
1951 # if we are dumping the current version, overwrite the DDL
1952 carp "Overwriting existing DDL file - $filename";
1956 my $output = $sqlt->translate;
1958 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1961 if(!open($file, ">$filename")) {
1962 $self->throw_exception("Can't open $filename for writing ($!)");
1965 print $file $output;
1968 next unless ($preversion);
1970 require SQL::Translator::Diff;
1972 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1973 if(!-e $prefilename) {
1974 carp("No previous schema file found ($prefilename)");
1978 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1980 carp("Overwriting existing diff file - $difffile");
1986 my $t = SQL::Translator->new($sqltargs);
1991 or $self->throw_exception ($t->error);
1993 my $out = $t->translate( $prefilename )
1994 or $self->throw_exception ($t->error);
1996 $source_schema = $t->schema;
1998 $source_schema->name( $prefilename )
1999 unless ( $source_schema->name );
2002 # The "new" style of producers have sane normalization and can support
2003 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2004 # And we have to diff parsed SQL against parsed SQL.
2005 my $dest_schema = $sqlt_schema;
2007 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2008 my $t = SQL::Translator->new($sqltargs);
2013 or $self->throw_exception ($t->error);
2015 my $out = $t->translate( $filename )
2016 or $self->throw_exception ($t->error);
2018 $dest_schema = $t->schema;
2020 $dest_schema->name( $filename )
2021 unless $dest_schema->name;
2024 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2028 if(!open $file, ">$difffile") {
2029 $self->throw_exception("Can't write to $difffile ($!)");
2037 =head2 deployment_statements
2041 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2045 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2047 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2048 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2050 C<$directory> is used to return statements from files in a previously created
2051 L</create_ddl_dir> directory and is optional. The filenames are constructed
2052 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2054 If no C<$directory> is specified then the statements are constructed on the
2055 fly using L<SQL::Translator> and C<$version> is ignored.
2057 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2061 sub deployment_statements {
2062 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2063 # Need to be connected to get the correct sqlt_type
2064 $self->ensure_connected() unless $type;
2065 $type ||= $self->sqlt_type;
2066 $version ||= $schema->schema_version || '1.x';
2068 my $filename = $schema->ddl_filename($type, $version, $dir);
2072 open($file, "<$filename")
2073 or $self->throw_exception("Can't open $filename ($!)");
2076 return join('', @rows);
2079 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2080 . $self->_check_sqlt_message . q{'})
2081 if !$self->_check_sqlt_version;
2083 require SQL::Translator::Parser::DBIx::Class;
2084 eval qq{use SQL::Translator::Producer::${type}};
2085 $self->throw_exception($@) if $@;
2087 # sources needs to be a parser arg, but for simplicty allow at top level
2089 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2090 if exists $sqltargs->{sources};
2092 my $tr = SQL::Translator->new(%$sqltargs);
2093 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2094 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2098 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2101 return if($line =~ /^--/);
2103 # next if($line =~ /^DROP/m);
2104 return if($line =~ /^BEGIN TRANSACTION/m);
2105 return if($line =~ /^COMMIT/m);
2106 return if $line =~ /^\s+$/; # skip whitespace only
2107 $self->_query_start($line);
2109 $self->dbh->do($line); # shouldn't be using ->dbh ?
2112 carp qq{$@ (running "${line}")};
2114 $self->_query_end($line);
2116 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2117 if (@statements > 1) {
2118 foreach my $statement (@statements) {
2119 $deploy->( $statement );
2122 elsif (@statements == 1) {
2123 foreach my $line ( split(";\n", $statements[0])) {
2129 =head2 datetime_parser
2131 Returns the datetime parser class
2135 sub datetime_parser {
2137 return $self->{datetime_parser} ||= do {
2138 $self->ensure_connected;
2139 $self->build_datetime_parser(@_);
2143 =head2 datetime_parser_type
2145 Defines (returns) the datetime parser class - currently hardwired to
2146 L<DateTime::Format::MySQL>
2150 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2152 =head2 build_datetime_parser
2154 See L</datetime_parser>
2158 sub build_datetime_parser {
2160 my $type = $self->datetime_parser_type(@_);
2162 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2167 my $_check_sqlt_version; # private
2168 my $_check_sqlt_message; # private
2169 sub _check_sqlt_version {
2170 return $_check_sqlt_version if defined $_check_sqlt_version;
2171 eval 'use SQL::Translator "0.09003"';
2172 $_check_sqlt_message = $@ || '';
2173 $_check_sqlt_version = !$@;
2176 sub _check_sqlt_message {
2177 _check_sqlt_version if !defined $_check_sqlt_message;
2178 $_check_sqlt_message;
2182 =head2 is_replicating
2184 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2185 replicate from a master database. Default is undef, which is the result
2186 returned by databases that don't support replication.
2190 sub is_replicating {
2195 =head2 lag_behind_master
2197 Returns a number that represents a certain amount of lag behind a master db
2198 when a given storage is replicating. The number is database dependent, but
2199 starts at zero and increases with the amount of lag. Default in undef
2203 sub lag_behind_master {
2209 return if !$self->_dbh;
2218 =head2 DBIx::Class and AutoCommit
2220 DBIx::Class can do some wonderful magic with handling exceptions,
2221 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2222 combined with C<txn_do> for transaction support.
2224 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2225 in an assumed transaction between commits, and you're telling us you'd
2226 like to manage that manually. A lot of the magic protections offered by
2227 this module will go away. We can't protect you from exceptions due to database
2228 disconnects because we don't know anything about how to restart your
2229 transactions. You're on your own for handling all sorts of exceptional
2230 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2237 Matt S. Trout <mst@shadowcatsystems.co.uk>
2239 Andy Grundman <andy@hybridized.org>
2243 You may distribute this code under the same terms as Perl itself.