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') && $self->_ping);
681 my $dbh = $self->_dbh or return 0;
686 # handle pid changes correctly
687 # NOTE: assumes $self->_dbh is a valid $dbh
691 return if defined $self->_conn_pid && $self->_conn_pid == $$;
693 $self->_dbh->{InactiveDestroy} = 1;
700 sub ensure_connected {
703 unless ($self->connected) {
704 $self->_populate_dbh;
710 Returns the dbh - a data base handle of class L<DBI>.
717 $self->ensure_connected;
721 sub _sql_maker_args {
724 return ( bindtype=>'columns', array_datatypes => 1, limit_dialect => $self->dbh, %{$self->_sql_maker_opts} );
729 unless ($self->_sql_maker) {
730 my $sql_maker_class = $self->sql_maker_class;
731 $self->ensure_class_loaded ($sql_maker_class);
732 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
734 return $self->_sql_maker;
741 my @info = @{$self->_dbi_connect_info || []};
742 $self->_dbh($self->_connect(@info));
744 $self->_conn_pid($$);
745 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
747 $self->_determine_driver;
749 # Always set the transaction depth on connect, since
750 # there is no transaction in progress by definition
751 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
755 push @actions, ( $self->on_connect_call || () );
756 push @actions, $self->_parse_connect_do ('on_connect_do');
758 $self->_do_connection_actions(connect_call_ => $_) for @actions;
761 sub _determine_driver {
764 if (ref $self eq 'DBIx::Class::Storage::DBI') {
767 if ($self->_dbh) { # we are connected
768 $driver = $self->_dbh->{Driver}{Name};
770 # try to use dsn to not require being connected, the driver may still
771 # force a connection in _rebless to determine version
772 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
775 if ($self->load_optional_class("DBIx::Class::Storage::DBI::${driver}")) {
776 bless $self, "DBIx::Class::Storage::DBI::${driver}";
782 sub _do_connection_actions {
784 my $method_prefix = shift;
787 if (not ref($call)) {
788 my $method = $method_prefix . $call;
790 } elsif (ref($call) eq 'CODE') {
792 } elsif (ref($call) eq 'ARRAY') {
793 if (ref($call->[0]) ne 'ARRAY') {
794 $self->_do_connection_actions($method_prefix, $_) for @$call;
796 $self->_do_connection_actions($method_prefix, @$_) for @$call;
799 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
805 sub connect_call_do_sql {
807 $self->_do_query(@_);
810 sub disconnect_call_do_sql {
812 $self->_do_query(@_);
815 # override in db-specific backend when necessary
816 sub connect_call_datetime_setup { 1 }
819 my ($self, $action) = @_;
821 if (ref $action eq 'CODE') {
822 $action = $action->($self);
823 $self->_do_query($_) foreach @$action;
826 # Most debuggers expect ($sql, @bind), so we need to exclude
827 # the attribute hash which is the second argument to $dbh->do
828 # furthermore the bind values are usually to be presented
829 # as named arrayref pairs, so wrap those here too
830 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
831 my $sql = shift @do_args;
832 my $attrs = shift @do_args;
833 my @bind = map { [ undef, $_ ] } @do_args;
835 $self->_query_start($sql, @bind);
836 $self->_dbh->do($sql, $attrs, @do_args);
837 $self->_query_end($sql, @bind);
844 my ($self, @info) = @_;
846 $self->throw_exception("You failed to provide any connection info")
849 my ($old_connect_via, $dbh);
851 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
852 $old_connect_via = $DBI::connect_via;
853 $DBI::connect_via = 'connect';
857 if(ref $info[0] eq 'CODE') {
861 $dbh = DBI->connect(@info);
864 if($dbh && !$self->unsafe) {
865 my $weak_self = $self;
866 Scalar::Util::weaken($weak_self);
867 $dbh->{HandleError} = sub {
869 $weak_self->throw_exception("DBI Exception: $_[0]");
872 croak ("DBI Exception: $_[0]");
875 $dbh->{ShowErrorStatement} = 1;
876 $dbh->{RaiseError} = 1;
877 $dbh->{PrintError} = 0;
881 $DBI::connect_via = $old_connect_via if $old_connect_via;
883 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
886 $self->_dbh_autocommit($dbh->{AutoCommit});
892 my ($self, $name) = @_;
894 $name = $self->_svp_generate_name
895 unless defined $name;
897 $self->throw_exception ("You can't use savepoints outside a transaction")
898 if $self->{transaction_depth} == 0;
900 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
901 unless $self->can('_svp_begin');
903 push @{ $self->{savepoints} }, $name;
905 $self->debugobj->svp_begin($name) if $self->debug;
907 return $self->_svp_begin($name);
911 my ($self, $name) = @_;
913 $self->throw_exception ("You can't use savepoints outside a transaction")
914 if $self->{transaction_depth} == 0;
916 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
917 unless $self->can('_svp_release');
920 $self->throw_exception ("Savepoint '$name' does not exist")
921 unless grep { $_ eq $name } @{ $self->{savepoints} };
923 # Dig through the stack until we find the one we are releasing. This keeps
924 # the stack up to date.
927 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
929 $name = pop @{ $self->{savepoints} };
932 $self->debugobj->svp_release($name) if $self->debug;
934 return $self->_svp_release($name);
938 my ($self, $name) = @_;
940 $self->throw_exception ("You can't use savepoints outside a transaction")
941 if $self->{transaction_depth} == 0;
943 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
944 unless $self->can('_svp_rollback');
947 # If they passed us a name, verify that it exists in the stack
948 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
949 $self->throw_exception("Savepoint '$name' does not exist!");
952 # Dig through the stack until we find the one we are releasing. This keeps
953 # the stack up to date.
954 while(my $s = pop(@{ $self->{savepoints} })) {
955 last if($s eq $name);
957 # Add the savepoint back to the stack, as a rollback doesn't remove the
958 # named savepoint, only everything after it.
959 push(@{ $self->{savepoints} }, $name);
961 # We'll assume they want to rollback to the last savepoint
962 $name = $self->{savepoints}->[-1];
965 $self->debugobj->svp_rollback($name) if $self->debug;
967 return $self->_svp_rollback($name);
970 sub _svp_generate_name {
973 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
978 $self->ensure_connected();
979 if($self->{transaction_depth} == 0) {
980 $self->debugobj->txn_begin()
982 # this isn't ->_dbh-> because
983 # we should reconnect on begin_work
984 # for AutoCommit users
985 $self->dbh->begin_work;
986 } elsif ($self->auto_savepoint) {
989 $self->{transaction_depth}++;
994 if ($self->{transaction_depth} == 1) {
995 my $dbh = $self->_dbh;
996 $self->debugobj->txn_commit()
999 $self->{transaction_depth} = 0
1000 if $self->_dbh_autocommit;
1002 elsif($self->{transaction_depth} > 1) {
1003 $self->{transaction_depth}--;
1005 if $self->auto_savepoint;
1011 my $dbh = $self->_dbh;
1013 if ($self->{transaction_depth} == 1) {
1014 $self->debugobj->txn_rollback()
1016 $self->{transaction_depth} = 0
1017 if $self->_dbh_autocommit;
1020 elsif($self->{transaction_depth} > 1) {
1021 $self->{transaction_depth}--;
1022 if ($self->auto_savepoint) {
1023 $self->svp_rollback;
1028 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1033 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1034 $error =~ /$exception_class/ and $self->throw_exception($error);
1035 # ensure that a failed rollback resets the transaction depth
1036 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1037 $self->throw_exception($error);
1041 # This used to be the top-half of _execute. It was split out to make it
1042 # easier to override in NoBindVars without duping the rest. It takes up
1043 # all of _execute's args, and emits $sql, @bind.
1044 sub _prep_for_execute {
1045 my ($self, $op, $extra_bind, $ident, $args) = @_;
1047 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1048 $ident = $ident->from();
1051 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1054 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1056 return ($sql, \@bind);
1060 sub _fix_bind_params {
1061 my ($self, @bind) = @_;
1063 ### Turn @bind from something like this:
1064 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1066 ### ( "'1'", "'1'", "'3'" )
1069 if ( defined( $_ && $_->[1] ) ) {
1070 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1077 my ( $self, $sql, @bind ) = @_;
1079 if ( $self->debug ) {
1080 @bind = $self->_fix_bind_params(@bind);
1082 $self->debugobj->query_start( $sql, @bind );
1087 my ( $self, $sql, @bind ) = @_;
1089 if ( $self->debug ) {
1090 @bind = $self->_fix_bind_params(@bind);
1091 $self->debugobj->query_end( $sql, @bind );
1096 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1098 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1100 $self->_query_start( $sql, @$bind );
1102 my $sth = $self->sth($sql,$op);
1104 my $placeholder_index = 1;
1106 foreach my $bound (@$bind) {
1107 my $attributes = {};
1108 my($column_name, @data) = @$bound;
1110 if ($bind_attributes) {
1111 $attributes = $bind_attributes->{$column_name}
1112 if defined $bind_attributes->{$column_name};
1115 foreach my $data (@data) {
1116 my $ref = ref $data;
1117 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1119 $sth->bind_param($placeholder_index, $data, $attributes);
1120 $placeholder_index++;
1124 # Can this fail without throwing an exception anyways???
1125 my $rv = $sth->execute();
1126 $self->throw_exception($sth->errstr) if !$rv;
1128 $self->_query_end( $sql, @$bind );
1130 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1135 $self->dbh_do('_dbh_execute', @_)
1139 my ($self, $source, $to_insert) = @_;
1141 my $ident = $source->from;
1142 my $bind_attributes = $self->source_bind_attributes($source);
1144 my $updated_cols = {};
1146 $self->ensure_connected;
1147 foreach my $col ( $source->columns ) {
1148 if ( !defined $to_insert->{$col} ) {
1149 my $col_info = $source->column_info($col);
1151 if ( $col_info->{auto_nextval} ) {
1152 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch( 'nextval', $col_info->{sequence} || $self->_dbh_get_autoinc_seq($self->dbh, $source) );
1157 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1159 return $updated_cols;
1162 ## Still not quite perfect, and EXPERIMENTAL
1163 ## Currently it is assumed that all values passed will be "normal", i.e. not
1164 ## scalar refs, or at least, all the same type as the first set, the statement is
1165 ## only prepped once.
1167 my ($self, $source, $cols, $data) = @_;
1169 my $table = $source->from;
1170 @colvalues{@$cols} = (0..$#$cols);
1171 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1173 $self->_query_start( $sql, @bind );
1174 my $sth = $self->sth($sql);
1176 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1178 ## This must be an arrayref, else nothing works!
1179 my $tuple_status = [];
1181 ## Get the bind_attributes, if any exist
1182 my $bind_attributes = $self->source_bind_attributes($source);
1184 ## Bind the values and execute
1185 my $placeholder_index = 1;
1187 foreach my $bound (@bind) {
1189 my $attributes = {};
1190 my ($column_name, $data_index) = @$bound;
1192 if( $bind_attributes ) {
1193 $attributes = $bind_attributes->{$column_name}
1194 if defined $bind_attributes->{$column_name};
1197 my @data = map { $_->[$data_index] } @$data;
1199 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1200 $placeholder_index++;
1202 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1205 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1207 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1208 if ($i > $#$tuple_status);
1210 require Data::Dumper;
1211 local $Data::Dumper::Terse = 1;
1212 local $Data::Dumper::Indent = 1;
1213 local $Data::Dumper::Useqq = 1;
1214 local $Data::Dumper::Quotekeys = 0;
1216 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1217 $tuple_status->[$i][1],
1218 Data::Dumper::Dumper(
1219 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1223 $self->throw_exception($sth->errstr) if !$rv;
1225 $self->_query_end( $sql, @bind );
1226 return (wantarray ? ($rv, $sth, @bind) : $rv);
1230 my $self = shift @_;
1231 my $source = shift @_;
1232 my $bind_attributes = $self->source_bind_attributes($source);
1234 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1239 my $self = shift @_;
1240 my $source = shift @_;
1242 my $bind_attrs = $self->source_bind_attributes($source);
1244 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1247 # We were sent here because the $rs contains a complex search
1248 # which will require a subquery to select the correct rows
1249 # (i.e. joined or limited resultsets)
1251 # Genarating a single PK column subquery is trivial and supported
1252 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1253 # Look at _multipk_update_delete()
1254 sub _subq_update_delete {
1256 my ($rs, $op, $values) = @_;
1258 my $rsrc = $rs->result_source;
1260 # we already check this, but double check naively just in case. Should be removed soon
1261 my $sel = $rs->_resolved_attrs->{select};
1262 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1263 my @pcols = $rsrc->primary_columns;
1264 if (@$sel != @pcols) {
1265 $self->throw_exception (
1266 'Subquery update/delete can not be called on resultsets selecting a'
1267 .' number of columns different than the number of primary keys'
1274 $op eq 'update' ? $values : (),
1275 { $pcols[0] => { -in => $rs->as_query } },
1280 return $self->_multipk_update_delete (@_);
1284 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1285 # resultset update/delete involving subqueries. So by default resort
1286 # to simple (and inefficient) delete_all style per-row opearations,
1287 # while allowing specific storages to override this with a faster
1290 sub _multipk_update_delete {
1291 return shift->_per_row_update_delete (@_);
1294 # This is the default loop used to delete/update rows for multi PK
1295 # resultsets, and used by mysql exclusively (because it can't do anything
1298 # We do not use $row->$op style queries, because resultset update/delete
1299 # is not expected to cascade (this is what delete_all/update_all is for).
1301 # There should be no race conditions as the entire operation is rolled
1304 sub _per_row_update_delete {
1306 my ($rs, $op, $values) = @_;
1308 my $rsrc = $rs->result_source;
1309 my @pcols = $rsrc->primary_columns;
1311 my $guard = $self->txn_scope_guard;
1313 # emulate the return value of $sth->execute for non-selects
1314 my $row_cnt = '0E0';
1316 my $subrs_cur = $rs->cursor;
1317 while (my @pks = $subrs_cur->next) {
1320 for my $i (0.. $#pcols) {
1321 $cond->{$pcols[$i]} = $pks[$i];
1326 $op eq 'update' ? $values : (),
1341 # localization is neccessary as
1342 # 1) there is no infrastructure to pass this around (easy to do, but will wait)
1343 # 2) _select_args sets it and _prep_for_execute consumes it
1344 my $sql_maker = $self->sql_maker;
1345 local $sql_maker->{for};
1347 return $self->_execute($self->_select_args(@_));
1350 sub _select_args_to_query {
1353 # localization is neccessary as
1354 # 1) there is no infrastructure to pass this around (easy to do, but will wait)
1355 # 2) _select_args sets it and _prep_for_execute consumes it
1356 my $sql_maker = $self->sql_maker;
1357 local $sql_maker->{for};
1359 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1360 # = $self->_select_args($ident, $select, $cond, $attrs);
1361 my ($op, $bind, $ident, $bind_attrs, @args) =
1362 $self->_select_args(@_);
1364 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1365 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1366 $prepared_bind ||= [];
1369 ? ($sql, $prepared_bind, $bind_attrs)
1370 : \[ "($sql)", @$prepared_bind ]
1375 my ($self, $ident, $select, $where, $attrs) = @_;
1377 my $sql_maker = $self->sql_maker;
1378 my $alias2source = $self->_resolve_ident_sources ($ident);
1380 # calculate bind_attrs before possible $ident mangling
1381 my $bind_attrs = {};
1382 for my $alias (keys %$alias2source) {
1383 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1384 for my $col (keys %$bindtypes) {
1386 my $fqcn = join ('.', $alias, $col);
1387 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1389 # so that unqualified searches can be bound too
1390 $bind_attrs->{$col} = $bind_attrs->{$fqcn} if $alias eq 'me';
1396 $attrs->{software_limit}
1398 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1400 $attrs->{software_limit} = 1;
1403 $self->throw_exception("rows attribute must be positive if present")
1404 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1406 # MySQL actually recommends this approach. I cringe.
1407 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1412 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1413 # otherwise delegate the limiting to the storage, unless software limit was requested
1415 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1417 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1418 $attrs->{prefetch_select} && @{$attrs->{prefetch_select}} )
1420 ($ident, $select, $where, $attrs)
1421 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1423 elsif (! $attrs->{software_limit} ) {
1424 push @limit, $attrs->{rows}, $attrs->{offset};
1428 # This would be the point to deflate anything found in $where
1429 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1430 # expect a row object. And all we have is a resultsource (it is trivial
1431 # to extract deflator coderefs via $alias2source above).
1433 # I don't see a way forward other than changing the way deflators are
1434 # invoked, and that's just bad...
1438 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1439 (qw/order_by group_by having _virtual_order_by/ )
1442 $sql_maker->{for} = delete $attrs->{for};
1444 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1447 sub _adjust_select_args_for_complex_prefetch {
1448 my ($self, $from, $select, $where, $attrs) = @_;
1450 # copies for mangling
1452 $select = [ @$select ];
1453 $attrs = { %$attrs };
1455 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1456 if (ref $from ne 'ARRAY');
1458 # separate attributes
1459 my $sub_attrs = { %$attrs };
1460 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1461 delete $sub_attrs->{$_} for qw/for collapse prefetch_select _collapse_order_by select as/;
1463 my $alias = $attrs->{alias};
1465 # create subquery select list - loop only over primary columns
1466 my $sub_select = [];
1467 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{prefetch_select}} - 1) {
1468 my $sel = $attrs->{select}[$i];
1470 # alias any functions to the dbic-side 'as' label
1471 # adjust the outer select accordingly
1472 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1473 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1474 $select->[$i] = join ('.', $attrs->{alias}, $attrs->{as}[$i]);
1477 push @$sub_select, $sel;
1480 # bring over all non-collapse-induced order_by into the inner query (if any)
1481 # the outer one will have to keep them all
1482 delete $sub_attrs->{order_by};
1483 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1484 $sub_attrs->{order_by} = [
1485 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1490 my $select_root = shift @$from;
1491 my @outer_from = @$from;
1494 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1496 # in complex search_related chains $alias may *not* be 'me'
1497 # so always include it in the inner join, and also shift away
1498 # from the outer stack, so that the two datasets actually do
1500 if ($select_root->{-alias} ne $alias) {
1501 $inner_joins{$alias} = 1;
1503 while (@outer_from && $outer_from[0][0]{-alias} ne $alias) {
1506 if (! @outer_from) {
1507 $self->throw_exception ("Unable to find '$alias' in the {from} stack, something is wrong");
1510 shift @outer_from; # the new subquery will represent this alias, so get rid of it
1514 # decide which parts of the join will remain on the inside
1516 # this is not a very viable optimisation, but it was written
1517 # before I realised this, so might as well remain. We can throw
1518 # away _any_ branches of the join tree that are:
1519 # 1) not mentioned in the condition/order
1520 # 2) left-join leaves (or left-join leaf chains)
1521 # Most of the join conditions will not satisfy this, but for real
1522 # complex queries some might, and we might make some RDBMS happy.
1525 # since we do not have introspectable SQLA, we fall back to ugly
1526 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1527 # in order to determine what goes into %inner_joins
1528 # It may not be very efficient, but it's a reasonable stop-gap
1530 # produce stuff unquoted, so it can be scanned
1531 my $sql_maker = $self->sql_maker;
1532 local $sql_maker->{quote_char};
1535 { ref $_ ? $_->[0] : $_ }
1536 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1539 my $where_sql = $sql_maker->where ($where);
1542 for my $alias (keys %join_info) {
1544 # any table alias found on a column name in where or order_by
1545 # gets included in %inner_joins
1546 # Also any parent joins that are needed to reach this particular alias
1547 for my $piece ($where_sql, @order_by ) {
1548 if ($piece =~ /\b$alias\./) {
1549 $inner_joins{$alias} = 1;
1555 # scan for non-leaf/non-left joins and mark as needed
1556 # also mark all ancestor joins that are needed to reach this particular alias
1557 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1559 # traverse by the size of the -join_path i.e. reverse depth first
1560 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1562 my $j = $join_info{$alias};
1563 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1565 if ($inner_joins{$alias}) {
1566 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1570 # construct the inner $from for the subquery
1571 my $inner_from = [ $select_root ];
1572 for my $j (@$from) {
1573 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1576 # if a multi-type join was needed in the subquery ("multi" is indicated by
1577 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1579 for my $alias (keys %inner_joins) {
1581 # the dot comes from some weirdness in collapse
1582 # remove after the rewrite
1583 if ($attrs->{collapse}{".$alias"}) {
1584 $sub_attrs->{group_by} ||= $sub_select;
1589 # generate the subquery
1590 my $subq = $self->_select_args_to_query (
1597 # put it in the new {from}
1598 unshift @outer_from, { $alias => $subq };
1600 # This is totally horrific - the $where ends up in both the inner and outer query
1601 # Unfortunately not much can be done until SQLA2 introspection arrives
1603 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1604 return (\@outer_from, $select, $where, $attrs);
1607 sub _resolve_ident_sources {
1608 my ($self, $ident) = @_;
1610 my $alias2source = {};
1612 # the reason this is so contrived is that $ident may be a {from}
1613 # structure, specifying multiple tables to join
1614 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1615 # this is compat mode for insert/update/delete which do not deal with aliases
1616 $alias2source->{me} = $ident;
1618 elsif (ref $ident eq 'ARRAY') {
1622 if (ref $_ eq 'HASH') {
1625 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1629 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1630 if ($tabinfo->{-source_handle});
1634 return $alias2source;
1637 # Returns a counting SELECT for a simple count
1638 # query. Abstracted so that a storage could override
1639 # this to { count => 'firstcol' } or whatever makes
1640 # sense as a performance optimization
1642 #my ($self, $source, $rs_attrs) = @_;
1643 return { count => '*' };
1646 # Returns a SELECT which will end up in the subselect
1647 # There may or may not be a group_by, as the subquery
1648 # might have been called to accomodate a limit
1650 # Most databases would be happy with whatever ends up
1651 # here, but some choke in various ways.
1653 sub _subq_count_select {
1654 my ($self, $source, $rs_attrs) = @_;
1655 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1657 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1658 return @pcols ? \@pcols : [ 1 ];
1662 sub source_bind_attributes {
1663 my ($self, $source) = @_;
1665 my $bind_attributes;
1666 foreach my $column ($source->columns) {
1668 my $data_type = $source->column_info($column)->{data_type} || '';
1669 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1673 return $bind_attributes;
1680 =item Arguments: $ident, $select, $condition, $attrs
1684 Handle a SQL select statement.
1690 my ($ident, $select, $condition, $attrs) = @_;
1691 return $self->cursor_class->new($self, \@_, $attrs);
1696 my ($rv, $sth, @bind) = $self->_select(@_);
1697 my @row = $sth->fetchrow_array;
1698 my @nextrow = $sth->fetchrow_array if @row;
1699 if(@row && @nextrow) {
1700 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1702 # Need to call finish() to work round broken DBDs
1711 =item Arguments: $sql
1715 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1720 my ($self, $dbh, $sql) = @_;
1722 # 3 is the if_active parameter which avoids active sth re-use
1723 my $sth = $self->disable_sth_caching
1724 ? $dbh->prepare($sql)
1725 : $dbh->prepare_cached($sql, {}, 3);
1727 # XXX You would think RaiseError would make this impossible,
1728 # but apparently that's not true :(
1729 $self->throw_exception($dbh->errstr) if !$sth;
1735 my ($self, $sql) = @_;
1736 $self->dbh_do('_dbh_sth', $sql);
1739 sub _dbh_columns_info_for {
1740 my ($self, $dbh, $table) = @_;
1742 if ($dbh->can('column_info')) {
1745 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1746 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1748 while ( my $info = $sth->fetchrow_hashref() ){
1750 $column_info{data_type} = $info->{TYPE_NAME};
1751 $column_info{size} = $info->{COLUMN_SIZE};
1752 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1753 $column_info{default_value} = $info->{COLUMN_DEF};
1754 my $col_name = $info->{COLUMN_NAME};
1755 $col_name =~ s/^\"(.*)\"$/$1/;
1757 $result{$col_name} = \%column_info;
1760 return \%result if !$@ && scalar keys %result;
1764 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1766 my @columns = @{$sth->{NAME_lc}};
1767 for my $i ( 0 .. $#columns ){
1769 $column_info{data_type} = $sth->{TYPE}->[$i];
1770 $column_info{size} = $sth->{PRECISION}->[$i];
1771 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1773 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1774 $column_info{data_type} = $1;
1775 $column_info{size} = $2;
1778 $result{$columns[$i]} = \%column_info;
1782 foreach my $col (keys %result) {
1783 my $colinfo = $result{$col};
1784 my $type_num = $colinfo->{data_type};
1786 if(defined $type_num && $dbh->can('type_info')) {
1787 my $type_info = $dbh->type_info($type_num);
1788 $type_name = $type_info->{TYPE_NAME} if $type_info;
1789 $colinfo->{data_type} = $type_name if $type_name;
1796 sub columns_info_for {
1797 my ($self, $table) = @_;
1798 $self->dbh_do('_dbh_columns_info_for', $table);
1801 =head2 last_insert_id
1803 Return the row id of the last insert.
1807 sub _dbh_last_insert_id {
1808 # All Storage's need to register their own _dbh_last_insert_id
1809 # the old SQLite-based method was highly inappropriate
1812 my $class = ref $self;
1813 $self->throw_exception (<<EOE);
1815 No _dbh_last_insert_id() method found in $class.
1816 Since the method of obtaining the autoincrement id of the last insert
1817 operation varies greatly between different databases, this method must be
1818 individually implemented for every storage class.
1822 sub last_insert_id {
1824 $self->dbh_do('_dbh_last_insert_id', @_);
1829 Returns the database driver name.
1833 sub sqlt_type { shift->dbh->{Driver}->{Name} }
1835 =head2 bind_attribute_by_data_type
1837 Given a datatype from column info, returns a database specific bind
1838 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
1839 let the database planner just handle it.
1841 Generally only needed for special case column types, like bytea in postgres.
1845 sub bind_attribute_by_data_type {
1849 =head2 is_datatype_numeric
1851 Given a datatype from column_info, returns a boolean value indicating if
1852 the current RDBMS considers it a numeric value. This controls how
1853 L<DBIx::Class::Row/set_column> decides whether to mark the column as
1854 dirty - when the datatype is deemed numeric a C<< != >> comparison will
1855 be performed instead of the usual C<eq>.
1859 sub is_datatype_numeric {
1860 my ($self, $dt) = @_;
1862 return 0 unless $dt;
1864 return $dt =~ /^ (?:
1865 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
1870 =head2 create_ddl_dir (EXPERIMENTAL)
1874 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
1878 Creates a SQL file based on the Schema, for each of the specified
1879 database engines in C<\@databases> in the given directory.
1880 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
1882 Given a previous version number, this will also create a file containing
1883 the ALTER TABLE statements to transform the previous schema into the
1884 current one. Note that these statements may contain C<DROP TABLE> or
1885 C<DROP COLUMN> statements that can potentially destroy data.
1887 The file names are created using the C<ddl_filename> method below, please
1888 override this method in your schema if you would like a different file
1889 name format. For the ALTER file, the same format is used, replacing
1890 $version in the name with "$preversion-$version".
1892 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
1893 The most common value for this would be C<< { add_drop_table => 1 } >>
1894 to have the SQL produced include a C<DROP TABLE> statement for each table
1895 created. For quoting purposes supply C<quote_table_names> and
1896 C<quote_field_names>.
1898 If no arguments are passed, then the following default values are assumed:
1902 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
1904 =item version - $schema->schema_version
1906 =item directory - './'
1908 =item preversion - <none>
1912 By default, C<\%sqlt_args> will have
1914 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
1916 merged with the hash passed in. To disable any of those features, pass in a
1917 hashref like the following
1919 { ignore_constraint_names => 0, # ... other options }
1922 Note that this feature is currently EXPERIMENTAL and may not work correctly
1923 across all databases, or fully handle complex relationships.
1925 WARNING: Please check all SQL files created, before applying them.
1929 sub create_ddl_dir {
1930 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
1932 if(!$dir || !-d $dir) {
1933 carp "No directory given, using ./\n";
1936 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
1937 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
1939 my $schema_version = $schema->schema_version || '1.x';
1940 $version ||= $schema_version;
1943 add_drop_table => 1,
1944 ignore_constraint_names => 1,
1945 ignore_index_names => 1,
1949 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
1950 . $self->_check_sqlt_message . q{'})
1951 if !$self->_check_sqlt_version;
1953 my $sqlt = SQL::Translator->new( $sqltargs );
1955 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
1956 my $sqlt_schema = $sqlt->translate({ data => $schema })
1957 or $self->throw_exception ($sqlt->error);
1959 foreach my $db (@$databases) {
1961 $sqlt->{schema} = $sqlt_schema;
1962 $sqlt->producer($db);
1965 my $filename = $schema->ddl_filename($db, $version, $dir);
1966 if (-e $filename && ($version eq $schema_version )) {
1967 # if we are dumping the current version, overwrite the DDL
1968 carp "Overwriting existing DDL file - $filename";
1972 my $output = $sqlt->translate;
1974 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
1977 if(!open($file, ">$filename")) {
1978 $self->throw_exception("Can't open $filename for writing ($!)");
1981 print $file $output;
1984 next unless ($preversion);
1986 require SQL::Translator::Diff;
1988 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
1989 if(!-e $prefilename) {
1990 carp("No previous schema file found ($prefilename)");
1994 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
1996 carp("Overwriting existing diff file - $difffile");
2002 my $t = SQL::Translator->new($sqltargs);
2007 or $self->throw_exception ($t->error);
2009 my $out = $t->translate( $prefilename )
2010 or $self->throw_exception ($t->error);
2012 $source_schema = $t->schema;
2014 $source_schema->name( $prefilename )
2015 unless ( $source_schema->name );
2018 # The "new" style of producers have sane normalization and can support
2019 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2020 # And we have to diff parsed SQL against parsed SQL.
2021 my $dest_schema = $sqlt_schema;
2023 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2024 my $t = SQL::Translator->new($sqltargs);
2029 or $self->throw_exception ($t->error);
2031 my $out = $t->translate( $filename )
2032 or $self->throw_exception ($t->error);
2034 $dest_schema = $t->schema;
2036 $dest_schema->name( $filename )
2037 unless $dest_schema->name;
2040 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2044 if(!open $file, ">$difffile") {
2045 $self->throw_exception("Can't write to $difffile ($!)");
2053 =head2 deployment_statements
2057 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2061 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2063 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2064 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2066 C<$directory> is used to return statements from files in a previously created
2067 L</create_ddl_dir> directory and is optional. The filenames are constructed
2068 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2070 If no C<$directory> is specified then the statements are constructed on the
2071 fly using L<SQL::Translator> and C<$version> is ignored.
2073 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2077 sub deployment_statements {
2078 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2079 # Need to be connected to get the correct sqlt_type
2080 $self->ensure_connected() unless $type;
2081 $type ||= $self->sqlt_type;
2082 $version ||= $schema->schema_version || '1.x';
2084 my $filename = $schema->ddl_filename($type, $version, $dir);
2088 open($file, "<$filename")
2089 or $self->throw_exception("Can't open $filename ($!)");
2092 return join('', @rows);
2095 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2096 . $self->_check_sqlt_message . q{'})
2097 if !$self->_check_sqlt_version;
2099 require SQL::Translator::Parser::DBIx::Class;
2100 eval qq{use SQL::Translator::Producer::${type}};
2101 $self->throw_exception($@) if $@;
2103 # sources needs to be a parser arg, but for simplicty allow at top level
2105 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2106 if exists $sqltargs->{sources};
2108 my $tr = SQL::Translator->new(%$sqltargs);
2109 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2110 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2114 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2117 return if($line =~ /^--/);
2119 # next if($line =~ /^DROP/m);
2120 return if($line =~ /^BEGIN TRANSACTION/m);
2121 return if($line =~ /^COMMIT/m);
2122 return if $line =~ /^\s+$/; # skip whitespace only
2123 $self->_query_start($line);
2125 $self->dbh->do($line); # shouldn't be using ->dbh ?
2128 carp qq{$@ (running "${line}")};
2130 $self->_query_end($line);
2132 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2133 if (@statements > 1) {
2134 foreach my $statement (@statements) {
2135 $deploy->( $statement );
2138 elsif (@statements == 1) {
2139 foreach my $line ( split(";\n", $statements[0])) {
2145 =head2 datetime_parser
2147 Returns the datetime parser class
2151 sub datetime_parser {
2153 return $self->{datetime_parser} ||= do {
2154 $self->ensure_connected;
2155 $self->build_datetime_parser(@_);
2159 =head2 datetime_parser_type
2161 Defines (returns) the datetime parser class - currently hardwired to
2162 L<DateTime::Format::MySQL>
2166 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2168 =head2 build_datetime_parser
2170 See L</datetime_parser>
2174 sub build_datetime_parser {
2176 my $type = $self->datetime_parser_type(@_);
2178 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2183 my $_check_sqlt_version; # private
2184 my $_check_sqlt_message; # private
2185 sub _check_sqlt_version {
2186 return $_check_sqlt_version if defined $_check_sqlt_version;
2187 eval 'use SQL::Translator "0.09003"';
2188 $_check_sqlt_message = $@ || '';
2189 $_check_sqlt_version = !$@;
2192 sub _check_sqlt_message {
2193 _check_sqlt_version if !defined $_check_sqlt_message;
2194 $_check_sqlt_message;
2198 =head2 is_replicating
2200 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2201 replicate from a master database. Default is undef, which is the result
2202 returned by databases that don't support replication.
2206 sub is_replicating {
2211 =head2 lag_behind_master
2213 Returns a number that represents a certain amount of lag behind a master db
2214 when a given storage is replicating. The number is database dependent, but
2215 starts at zero and increases with the amount of lag. Default in undef
2219 sub lag_behind_master {
2225 return if !$self->_dbh;
2234 =head2 DBIx::Class and AutoCommit
2236 DBIx::Class can do some wonderful magic with handling exceptions,
2237 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2238 combined with C<txn_do> for transaction support.
2240 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2241 in an assumed transaction between commits, and you're telling us you'd
2242 like to manage that manually. A lot of the magic protections offered by
2243 this module will go away. We can't protect you from exceptions due to database
2244 disconnects because we don't know anything about how to restart your
2245 transactions. You're on your own for handling all sorts of exceptional
2246 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2253 Matt S. Trout <mst@shadowcatsystems.co.uk>
2255 Andy Grundman <andy@hybridized.org>
2259 You may distribute this code under the same terms as Perl itself.