1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base 'DBIx::Class::Storage';
10 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
17 __PACKAGE__->mk_group_accessors('simple' =>
18 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
19 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
22 # the values for these accessors are picked out (and deleted) from
23 # the attribute hashref passed to connect_info
24 my @storage_options = qw/
25 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
26 disable_sth_caching unsafe auto_savepoint
28 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
31 # default cursor class, overridable in connect_info attributes
32 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
34 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
35 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 DBIx::Class::Storage::DBI - DBI storage handler
44 my $schema = MySchema->connect('dbi:SQLite:my.db');
46 $schema->storage->debug(1);
47 $schema->dbh_do("DROP TABLE authors");
49 $schema->resultset('Book')->search({
50 written_on => $schema->storage->datetime_parser(DateTime->now)
55 This class represents the connection to an RDBMS via L<DBI>. See
56 L<DBIx::Class::Storage> for general information. This pod only
57 documents DBI-specific methods and behaviors.
64 my $new = shift->next::method(@_);
66 $new->transaction_depth(0);
67 $new->_sql_maker_opts({});
68 $new->{savepoints} = [];
69 $new->{_in_dbh_do} = 0;
77 This method is normally called by L<DBIx::Class::Schema/connection>, which
78 encapsulates its argument list in an arrayref before passing them here.
80 The argument list may contain:
86 The same 4-element argument set one would normally pass to
87 L<DBI/connect>, optionally followed by
88 L<extra attributes|/DBIx::Class specific connection attributes>
89 recognized by DBIx::Class:
91 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
95 A single code reference which returns a connected
96 L<DBI database handle|DBI/connect> optionally followed by
97 L<extra attributes|/DBIx::Class specific connection attributes> recognized
100 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
104 A single hashref with all the attributes and the dsn/user/password
107 $connect_info_args = [{
115 This is particularly useful for L<Catalyst> based applications, allowing the
116 following config (L<Config::General> style):
121 dsn dbi:mysql:database=test
130 Please note that the L<DBI> docs recommend that you always explicitly
131 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
132 recommends that it be set to I<1>, and that you perform transactions
133 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
134 to I<1> if you do not do explicitly set it to zero. This is the default
135 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
137 =head3 DBIx::Class specific connection attributes
139 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
140 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
141 the following connection options. These options can be mixed in with your other
142 L<DBI> connection attributes, or placed in a seperate hashref
143 (C<\%extra_attributes>) as shown above.
145 Every time C<connect_info> is invoked, any previous settings for
146 these options will be cleared before setting the new ones, regardless of
147 whether any options are specified in the new C<connect_info>.
154 Specifies things to do immediately after connecting or re-connecting to
155 the database. Its value may contain:
161 This contains one SQL statement to execute.
163 =item an array reference
165 This contains SQL statements to execute in order. Each element contains
166 a string or a code reference that returns a string.
168 =item a code reference
170 This contains some code to execute. Unlike code references within an
171 array reference, its return value is ignored.
175 =item on_disconnect_do
177 Takes arguments in the same form as L</on_connect_do> and executes them
178 immediately before disconnecting from the database.
180 Note, this only runs if you explicitly call L</disconnect> on the
183 =item on_connect_call
185 A more generalized form of L</on_connect_do> that calls the specified
186 C<connect_call_METHOD> methods in your storage driver.
188 on_connect_do => 'select 1'
192 on_connect_call => [ [ do_sql => 'select 1' ] ]
194 Its values may contain:
200 Will call the C<connect_call_METHOD> method.
202 =item a code reference
204 Will execute C<< $code->($storage) >>
206 =item an array reference
208 Each value can be a method name or code reference.
210 =item an array of arrays
212 For each array, the first item is taken to be the C<connect_call_> method name
213 or code reference, and the rest are parameters to it.
217 Some predefined storage methods you may use:
223 Executes a SQL string or a code reference that returns a SQL string. This is
224 what L</on_connect_do> and L</on_disconnect_do> use.
232 Will execute the scalar as SQL.
236 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
237 attributes hashref and bind values.
239 =item a code reference
241 Will execute C<< $code->($storage) >> and execute the return array refs as
248 Execute any statements necessary to initialize the database session to return
249 and accept datetime/timestamp values used with
250 L<DBIx::Class::InflateColumn::DateTime>.
252 Only necessary for some databases, see your specific storage driver for
253 implementation details.
257 =item on_disconnect_call
259 Takes arguments in the same form as L</on_connect_call> and executes them
260 immediately before disconnecting from the database.
262 Calls the C<disconnect_call_METHOD> methods as opposed to the
263 C<connect_call_METHOD> methods called by L</on_connect_call>.
265 Note, this only runs if you explicitly call L</disconnect> on the
268 =item disable_sth_caching
270 If set to a true value, this option will disable the caching of
271 statement handles via L<DBI/prepare_cached>.
275 Sets the limit dialect. This is useful for JDBC-bridge among others
276 where the remote SQL-dialect cannot be determined by the name of the
277 driver alone. See also L<SQL::Abstract::Limit>.
281 Specifies what characters to use to quote table and column names. If
282 you use this you will want to specify L</name_sep> as well.
284 C<quote_char> expects either a single character, in which case is it
285 is placed on either side of the table/column name, or an arrayref of length
286 2 in which case the table/column name is placed between the elements.
288 For example under MySQL you should use C<< quote_char => '`' >>, and for
289 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
293 This only needs to be used in conjunction with C<quote_char>, and is used to
294 specify the charecter that seperates elements (schemas, tables, columns) from
295 each other. In most cases this is simply a C<.>.
297 The consequences of not supplying this value is that L<SQL::Abstract>
298 will assume DBIx::Class' uses of aliases to be complete column
299 names. The output will look like I<"me.name"> when it should actually
304 This Storage driver normally installs its own C<HandleError>, sets
305 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
306 all database handles, including those supplied by a coderef. It does this
307 so that it can have consistent and useful error behavior.
309 If you set this option to a true value, Storage will not do its usual
310 modifications to the database handle's attributes, and instead relies on
311 the settings in your connect_info DBI options (or the values you set in
312 your connection coderef, in the case that you are connecting via coderef).
314 Note that your custom settings can cause Storage to malfunction,
315 especially if you set a C<HandleError> handler that suppresses exceptions
316 and/or disable C<RaiseError>.
320 If this option is true, L<DBIx::Class> will use savepoints when nesting
321 transactions, making it possible to recover from failure in the inner
322 transaction without having to abort all outer transactions.
326 Use this argument to supply a cursor class other than the default
327 L<DBIx::Class::Storage::DBI::Cursor>.
331 Some real-life examples of arguments to L</connect_info> and
332 L<DBIx::Class::Schema/connect>
334 # Simple SQLite connection
335 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
338 ->connect_info([ sub { DBI->connect(...) } ]);
340 # A bit more complicated
347 { quote_char => q{"}, name_sep => q{.} },
351 # Equivalent to the previous example
357 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
361 # Same, but with hashref as argument
362 # See parse_connect_info for explanation
365 dsn => 'dbi:Pg:dbname=foo',
367 password => 'my_pg_password',
374 # Subref + DBIx::Class-specific connection options
377 sub { DBI->connect(...) },
381 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
382 disable_sth_caching => 1,
392 my ($self, $info_arg) = @_;
394 return $self->_connect_info if !$info_arg;
396 my @args = @$info_arg; # take a shallow copy for further mutilation
397 $self->_connect_info([@args]); # copy for _connect_info
400 # combine/pre-parse arguments depending on invocation style
403 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
404 %attrs = %{ $args[1] || {} };
407 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
408 %attrs = %{$args[0]};
410 for (qw/password user dsn/) {
411 unshift @args, delete $attrs{$_};
414 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
416 % { $args[3] || {} },
417 % { $args[4] || {} },
419 @args = @args[0,1,2];
422 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
423 # the new set of options
424 $self->_sql_maker(undef);
425 $self->_sql_maker_opts({});
428 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
429 if(my $value = delete $attrs{$storage_opt}) {
430 $self->$storage_opt($value);
433 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
434 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
435 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
440 if (ref $args[0] eq 'CODE') {
441 # _connect() never looks past $args[0] in this case
445 %{ $self->_default_dbi_connect_attributes || {} },
450 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
451 $self->_connect_info;
454 sub _default_dbi_connect_attributes {
455 return { AutoCommit => 1 };
460 This method is deprecated in favour of setting via L</connect_info>.
464 =head2 on_disconnect_do
466 This method is deprecated in favour of setting via L</connect_info>.
470 sub _parse_connect_do {
471 my ($self, $type) = @_;
473 my $val = $self->$type;
474 return () if not defined $val;
479 push @res, [ 'do_sql', $val ];
480 } elsif (ref($val) eq 'CODE') {
482 } elsif (ref($val) eq 'ARRAY') {
483 push @res, map { [ 'do_sql', $_ ] } @$val;
485 $self->throw_exception("Invalid type for $type: ".ref($val));
493 Arguments: ($subref | $method_name), @extra_coderef_args?
495 Execute the given $subref or $method_name using the new exception-based
496 connection management.
498 The first two arguments will be the storage object that C<dbh_do> was called
499 on and a database handle to use. Any additional arguments will be passed
500 verbatim to the called subref as arguments 2 and onwards.
502 Using this (instead of $self->_dbh or $self->dbh) ensures correct
503 exception handling and reconnection (or failover in future subclasses).
505 Your subref should have no side-effects outside of the database, as
506 there is the potential for your subref to be partially double-executed
507 if the database connection was stale/dysfunctional.
511 my @stuff = $schema->storage->dbh_do(
513 my ($storage, $dbh, @cols) = @_;
514 my $cols = join(q{, }, @cols);
515 $dbh->selectrow_array("SELECT $cols FROM foo");
526 my $dbh = $self->_dbh;
528 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
529 || $self->{transaction_depth};
531 local $self->{_in_dbh_do} = 1;
534 my $want_array = wantarray;
537 $self->_verify_pid if $dbh;
539 $self->_populate_dbh;
544 @result = $self->$code($dbh, @_);
546 elsif(defined $want_array) {
547 $result[0] = $self->$code($dbh, @_);
550 $self->$code($dbh, @_);
555 if(!$exception) { return $want_array ? @result : $result[0] }
557 $self->throw_exception($exception) if $self->connected;
559 # We were not connected - reconnect and retry, but let any
560 # exception fall right through this time
561 $self->_populate_dbh;
562 $self->$code($self->_dbh, @_);
565 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
566 # It also informs dbh_do to bypass itself while under the direction of txn_do,
567 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
572 ref $coderef eq 'CODE' or $self->throw_exception
573 ('$coderef must be a CODE reference');
575 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
577 local $self->{_in_dbh_do} = 1;
580 my $want_array = wantarray;
585 $self->_verify_pid if $self->_dbh;
586 $self->_populate_dbh if !$self->_dbh;
590 @result = $coderef->(@_);
592 elsif(defined $want_array) {
593 $result[0] = $coderef->(@_);
602 if(!$exception) { return $want_array ? @result : $result[0] }
604 if($tried++ || $self->connected) {
605 eval { $self->txn_rollback };
606 my $rollback_exception = $@;
607 if($rollback_exception) {
608 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
609 $self->throw_exception($exception) # propagate nested rollback
610 if $rollback_exception =~ /$exception_class/;
612 $self->throw_exception(
613 "Transaction aborted: ${exception}. "
614 . "Rollback failed: ${rollback_exception}"
617 $self->throw_exception($exception)
620 # We were not connected, and was first try - reconnect and retry
622 $self->_populate_dbh;
628 Our C<disconnect> method also performs a rollback first if the
629 database is not in C<AutoCommit> mode.
639 push @actions, ( $self->on_disconnect_call || () );
640 push @actions, $self->_parse_connect_do ('on_disconnect_do');
642 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
644 $self->_dbh->rollback unless $self->_dbh_autocommit;
645 $self->_dbh->disconnect;
651 =head2 with_deferred_fk_checks
655 =item Arguments: C<$coderef>
657 =item Return Value: The return value of $coderef
661 Storage specific method to run the code ref with FK checks deferred or
662 in MySQL's case disabled entirely.
666 # Storage subclasses should override this
667 sub with_deferred_fk_checks {
668 my ($self, $sub) = @_;
677 =item Arguments: none
679 =item Return Value: 1|0
683 Verifies that the the current database handle is active and ready to execute
684 an SQL statement (i.e. the connection did not get stale, server is still
685 answering, etc.) This method is used internally by L</dbh>.
692 if(my $dbh = $self->_dbh) {
693 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
700 return 0 if !$self->_dbh;
702 return ($dbh->FETCH('Active') && $self->_ping);
711 my $dbh = $self->_dbh or return 0;
716 # handle pid changes correctly
717 # NOTE: assumes $self->_dbh is a valid $dbh
721 return if defined $self->_conn_pid && $self->_conn_pid == $$;
723 $self->_dbh->{InactiveDestroy} = 1;
730 sub ensure_connected {
733 unless ($self->connected) {
734 $self->_populate_dbh;
740 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
741 is guaranteed to be healthy by implicitly calling L</connected>, and if
742 necessary performing a reconnection before returning.
749 if (not $self->_dbh) {
750 $self->_populate_dbh;
752 $self->ensure_connected;
759 This returns the B<last> available C<$dbh> if any, or attempts to
760 connect and returns the resulting handle. This method differs from
761 L</dbh> by not validating if a preexisting handle is still healthy
762 via L</connected>. Make sure you take appropriate precautions
763 when using this method, as the C<$dbh> may be useless at this point.
769 $self->_populate_dbh unless $self->_dbh;
773 sub _sql_maker_args {
778 array_datatypes => 1,
779 limit_dialect => $self->last_dbh,
780 %{$self->_sql_maker_opts}
786 unless ($self->_sql_maker) {
787 my $sql_maker_class = $self->sql_maker_class;
788 $self->ensure_class_loaded ($sql_maker_class);
789 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
791 return $self->_sql_maker;
799 my @info = @{$self->_dbi_connect_info || []};
800 $self->_dbh($self->_connect(@info));
802 $self->_conn_pid($$);
803 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
805 $self->_determine_driver;
807 # Always set the transaction depth on connect, since
808 # there is no transaction in progress by definition
809 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
811 $self->_run_connection_actions unless $self->{_in_determine_driver};
814 sub _run_connection_actions {
818 push @actions, ( $self->on_connect_call || () );
819 push @actions, $self->_parse_connect_do ('on_connect_do');
821 $self->_do_connection_actions(connect_call_ => $_) for @actions;
824 sub _determine_driver {
827 if (not $self->_driver_determined) {
828 my $started_unconnected = 0;
829 local $self->{_in_determine_driver} = 1;
831 if (ref($self) eq __PACKAGE__) {
833 if ($self->_dbh) { # we are connected
834 $driver = $self->_dbh->{Driver}{Name};
836 # try to use dsn to not require being connected, the driver may still
837 # force a connection in _rebless to determine version
838 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
839 $started_unconnected = 1;
842 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
843 if ($self->load_optional_class($storage_class)) {
844 mro::set_mro($storage_class, 'c3');
845 bless $self, $storage_class;
850 $self->_driver_determined(1);
852 $self->_run_connection_actions
853 if $started_unconnected && defined $self->_dbh;
857 sub _do_connection_actions {
859 my $method_prefix = shift;
862 if (not ref($call)) {
863 my $method = $method_prefix . $call;
865 } elsif (ref($call) eq 'CODE') {
867 } elsif (ref($call) eq 'ARRAY') {
868 if (ref($call->[0]) ne 'ARRAY') {
869 $self->_do_connection_actions($method_prefix, $_) for @$call;
871 $self->_do_connection_actions($method_prefix, @$_) for @$call;
874 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
880 sub connect_call_do_sql {
882 $self->_do_query(@_);
885 sub disconnect_call_do_sql {
887 $self->_do_query(@_);
890 # override in db-specific backend when necessary
891 sub connect_call_datetime_setup { 1 }
894 my ($self, $action) = @_;
896 if (ref $action eq 'CODE') {
897 $action = $action->($self);
898 $self->_do_query($_) foreach @$action;
901 # Most debuggers expect ($sql, @bind), so we need to exclude
902 # the attribute hash which is the second argument to $dbh->do
903 # furthermore the bind values are usually to be presented
904 # as named arrayref pairs, so wrap those here too
905 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
906 my $sql = shift @do_args;
907 my $attrs = shift @do_args;
908 my @bind = map { [ undef, $_ ] } @do_args;
910 $self->_query_start($sql, @bind);
911 $self->_dbh->do($sql, $attrs, @do_args);
912 $self->_query_end($sql, @bind);
919 my ($self, @info) = @_;
921 $self->throw_exception("You failed to provide any connection info")
924 my ($old_connect_via, $dbh);
926 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
927 $old_connect_via = $DBI::connect_via;
928 $DBI::connect_via = 'connect';
932 if(ref $info[0] eq 'CODE') {
936 $dbh = DBI->connect(@info);
939 if($dbh && !$self->unsafe) {
940 my $weak_self = $self;
941 Scalar::Util::weaken($weak_self);
942 $dbh->{HandleError} = sub {
944 $weak_self->throw_exception("DBI Exception: $_[0]");
947 croak ("DBI Exception: $_[0]");
950 $dbh->{ShowErrorStatement} = 1;
951 $dbh->{RaiseError} = 1;
952 $dbh->{PrintError} = 0;
956 $DBI::connect_via = $old_connect_via if $old_connect_via;
958 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
961 $self->_dbh_autocommit($dbh->{AutoCommit});
967 my ($self, $name) = @_;
969 $name = $self->_svp_generate_name
970 unless defined $name;
972 $self->throw_exception ("You can't use savepoints outside a transaction")
973 if $self->{transaction_depth} == 0;
975 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
976 unless $self->can('_svp_begin');
978 push @{ $self->{savepoints} }, $name;
980 $self->debugobj->svp_begin($name) if $self->debug;
982 return $self->_svp_begin($name);
986 my ($self, $name) = @_;
988 $self->throw_exception ("You can't use savepoints outside a transaction")
989 if $self->{transaction_depth} == 0;
991 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
992 unless $self->can('_svp_release');
995 $self->throw_exception ("Savepoint '$name' does not exist")
996 unless grep { $_ eq $name } @{ $self->{savepoints} };
998 # Dig through the stack until we find the one we are releasing. This keeps
999 # the stack up to date.
1002 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1004 $name = pop @{ $self->{savepoints} };
1007 $self->debugobj->svp_release($name) if $self->debug;
1009 return $self->_svp_release($name);
1013 my ($self, $name) = @_;
1015 $self->throw_exception ("You can't use savepoints outside a transaction")
1016 if $self->{transaction_depth} == 0;
1018 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1019 unless $self->can('_svp_rollback');
1021 if (defined $name) {
1022 # If they passed us a name, verify that it exists in the stack
1023 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1024 $self->throw_exception("Savepoint '$name' does not exist!");
1027 # Dig through the stack until we find the one we are releasing. This keeps
1028 # the stack up to date.
1029 while(my $s = pop(@{ $self->{savepoints} })) {
1030 last if($s eq $name);
1032 # Add the savepoint back to the stack, as a rollback doesn't remove the
1033 # named savepoint, only everything after it.
1034 push(@{ $self->{savepoints} }, $name);
1036 # We'll assume they want to rollback to the last savepoint
1037 $name = $self->{savepoints}->[-1];
1040 $self->debugobj->svp_rollback($name) if $self->debug;
1042 return $self->_svp_rollback($name);
1045 sub _svp_generate_name {
1048 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1053 if($self->{transaction_depth} == 0) {
1054 $self->debugobj->txn_begin()
1057 # being here implies we have AutoCommit => 1
1058 # if the user is utilizing txn_do - good for
1059 # him, otherwise we need to ensure that the
1060 # $dbh is healthy on BEGIN
1061 my $dbh_method = $self->{_in_dbh_do} ? '_dbh' : 'dbh';
1062 $self->$dbh_method->begin_work;
1064 } elsif ($self->auto_savepoint) {
1067 $self->{transaction_depth}++;
1072 if ($self->{transaction_depth} == 1) {
1073 my $dbh = $self->_dbh;
1074 $self->debugobj->txn_commit()
1077 $self->{transaction_depth} = 0
1078 if $self->_dbh_autocommit;
1080 elsif($self->{transaction_depth} > 1) {
1081 $self->{transaction_depth}--;
1083 if $self->auto_savepoint;
1089 my $dbh = $self->_dbh;
1091 if ($self->{transaction_depth} == 1) {
1092 $self->debugobj->txn_rollback()
1094 $self->{transaction_depth} = 0
1095 if $self->_dbh_autocommit;
1098 elsif($self->{transaction_depth} > 1) {
1099 $self->{transaction_depth}--;
1100 if ($self->auto_savepoint) {
1101 $self->svp_rollback;
1106 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1111 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1112 $error =~ /$exception_class/ and $self->throw_exception($error);
1113 # ensure that a failed rollback resets the transaction depth
1114 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1115 $self->throw_exception($error);
1119 # This used to be the top-half of _execute. It was split out to make it
1120 # easier to override in NoBindVars without duping the rest. It takes up
1121 # all of _execute's args, and emits $sql, @bind.
1122 sub _prep_for_execute {
1123 my ($self, $op, $extra_bind, $ident, $args) = @_;
1125 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1126 $ident = $ident->from();
1129 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1132 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1134 return ($sql, \@bind);
1138 sub _fix_bind_params {
1139 my ($self, @bind) = @_;
1141 ### Turn @bind from something like this:
1142 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1144 ### ( "'1'", "'1'", "'3'" )
1147 if ( defined( $_ && $_->[1] ) ) {
1148 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1155 my ( $self, $sql, @bind ) = @_;
1157 if ( $self->debug ) {
1158 @bind = $self->_fix_bind_params(@bind);
1160 $self->debugobj->query_start( $sql, @bind );
1165 my ( $self, $sql, @bind ) = @_;
1167 if ( $self->debug ) {
1168 @bind = $self->_fix_bind_params(@bind);
1169 $self->debugobj->query_end( $sql, @bind );
1174 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1176 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1178 $self->_query_start( $sql, @$bind );
1180 my $sth = $self->sth($sql,$op);
1182 my $placeholder_index = 1;
1184 foreach my $bound (@$bind) {
1185 my $attributes = {};
1186 my($column_name, @data) = @$bound;
1188 if ($bind_attributes) {
1189 $attributes = $bind_attributes->{$column_name}
1190 if defined $bind_attributes->{$column_name};
1193 foreach my $data (@data) {
1194 my $ref = ref $data;
1195 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1197 $sth->bind_param($placeholder_index, $data, $attributes);
1198 $placeholder_index++;
1202 # Can this fail without throwing an exception anyways???
1203 my $rv = $sth->execute();
1204 $self->throw_exception($sth->errstr) if !$rv;
1206 $self->_query_end( $sql, @$bind );
1208 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1213 $self->dbh_do('_dbh_execute', @_)
1217 my ($self, $source, $to_insert) = @_;
1219 # redispatch to insert method of storage we reblessed into, if necessary
1220 if (not $self->_driver_determined) {
1221 $self->_determine_driver;
1222 goto $self->can('insert');
1225 my $ident = $source->from;
1226 my $bind_attributes = $self->source_bind_attributes($source);
1228 my $updated_cols = {};
1230 foreach my $col ( $source->columns ) {
1231 if ( !defined $to_insert->{$col} ) {
1232 my $col_info = $source->column_info($col);
1234 if ( $col_info->{auto_nextval} ) {
1235 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1237 $col_info->{sequence} ||
1238 $self->_dbh_get_autoinc_seq($self->last_dbh, $source)
1244 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1246 return $updated_cols;
1249 ## Still not quite perfect, and EXPERIMENTAL
1250 ## Currently it is assumed that all values passed will be "normal", i.e. not
1251 ## scalar refs, or at least, all the same type as the first set, the statement is
1252 ## only prepped once.
1254 my ($self, $source, $cols, $data) = @_;
1256 my $table = $source->from;
1257 @colvalues{@$cols} = (0..$#$cols);
1258 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1260 $self->_determine_driver;
1262 $self->_query_start( $sql, @bind );
1263 my $sth = $self->sth($sql);
1265 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1267 ## This must be an arrayref, else nothing works!
1268 my $tuple_status = [];
1270 ## Get the bind_attributes, if any exist
1271 my $bind_attributes = $self->source_bind_attributes($source);
1273 ## Bind the values and execute
1274 my $placeholder_index = 1;
1276 foreach my $bound (@bind) {
1278 my $attributes = {};
1279 my ($column_name, $data_index) = @$bound;
1281 if( $bind_attributes ) {
1282 $attributes = $bind_attributes->{$column_name}
1283 if defined $bind_attributes->{$column_name};
1286 my @data = map { $_->[$data_index] } @$data;
1288 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1289 $placeholder_index++;
1291 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1294 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1296 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1297 if ($i > $#$tuple_status);
1299 require Data::Dumper;
1300 local $Data::Dumper::Terse = 1;
1301 local $Data::Dumper::Indent = 1;
1302 local $Data::Dumper::Useqq = 1;
1303 local $Data::Dumper::Quotekeys = 0;
1305 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1306 $tuple_status->[$i][1],
1307 Data::Dumper::Dumper(
1308 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1312 $self->throw_exception($sth->errstr) if !$rv;
1314 $self->_query_end( $sql, @bind );
1315 return (wantarray ? ($rv, $sth, @bind) : $rv);
1319 my $self = shift @_;
1320 my $source = shift @_;
1321 $self->_determine_driver;
1322 my $bind_attributes = $self->source_bind_attributes($source);
1324 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1329 my $self = shift @_;
1330 my $source = shift @_;
1331 $self->_determine_driver;
1332 my $bind_attrs = $self->source_bind_attributes($source);
1334 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1337 # We were sent here because the $rs contains a complex search
1338 # which will require a subquery to select the correct rows
1339 # (i.e. joined or limited resultsets)
1341 # Genarating a single PK column subquery is trivial and supported
1342 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1343 # Look at _multipk_update_delete()
1344 sub _subq_update_delete {
1346 my ($rs, $op, $values) = @_;
1348 my $rsrc = $rs->result_source;
1350 # we already check this, but double check naively just in case. Should be removed soon
1351 my $sel = $rs->_resolved_attrs->{select};
1352 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1353 my @pcols = $rsrc->primary_columns;
1354 if (@$sel != @pcols) {
1355 $self->throw_exception (
1356 'Subquery update/delete can not be called on resultsets selecting a'
1357 .' number of columns different than the number of primary keys'
1364 $op eq 'update' ? $values : (),
1365 { $pcols[0] => { -in => $rs->as_query } },
1370 return $self->_multipk_update_delete (@_);
1374 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1375 # resultset update/delete involving subqueries. So by default resort
1376 # to simple (and inefficient) delete_all style per-row opearations,
1377 # while allowing specific storages to override this with a faster
1380 sub _multipk_update_delete {
1381 return shift->_per_row_update_delete (@_);
1384 # This is the default loop used to delete/update rows for multi PK
1385 # resultsets, and used by mysql exclusively (because it can't do anything
1388 # We do not use $row->$op style queries, because resultset update/delete
1389 # is not expected to cascade (this is what delete_all/update_all is for).
1391 # There should be no race conditions as the entire operation is rolled
1394 sub _per_row_update_delete {
1396 my ($rs, $op, $values) = @_;
1398 my $rsrc = $rs->result_source;
1399 my @pcols = $rsrc->primary_columns;
1401 my $guard = $self->txn_scope_guard;
1403 # emulate the return value of $sth->execute for non-selects
1404 my $row_cnt = '0E0';
1406 my $subrs_cur = $rs->cursor;
1407 while (my @pks = $subrs_cur->next) {
1410 for my $i (0.. $#pcols) {
1411 $cond->{$pcols[$i]} = $pks[$i];
1416 $op eq 'update' ? $values : (),
1431 # localization is neccessary as
1432 # 1) there is no infrastructure to pass this around before SQLA2
1433 # 2) _select_args sets it and _prep_for_execute consumes it
1434 my $sql_maker = $self->sql_maker;
1435 local $sql_maker->{_dbic_rs_attrs};
1437 return $self->_execute($self->_select_args(@_));
1440 sub _select_args_to_query {
1443 # localization is neccessary as
1444 # 1) there is no infrastructure to pass this around before SQLA2
1445 # 2) _select_args sets it and _prep_for_execute consumes it
1446 my $sql_maker = $self->sql_maker;
1447 local $sql_maker->{_dbic_rs_attrs};
1449 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1450 # = $self->_select_args($ident, $select, $cond, $attrs);
1451 my ($op, $bind, $ident, $bind_attrs, @args) =
1452 $self->_select_args(@_);
1454 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1455 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1456 $prepared_bind ||= [];
1459 ? ($sql, $prepared_bind, $bind_attrs)
1460 : \[ "($sql)", @$prepared_bind ]
1465 my ($self, $ident, $select, $where, $attrs) = @_;
1467 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1469 my $sql_maker = $self->sql_maker;
1470 $sql_maker->{_dbic_rs_attrs} = {
1476 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1481 # calculate bind_attrs before possible $ident mangling
1482 my $bind_attrs = {};
1483 for my $alias (keys %$alias2source) {
1484 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1485 for my $col (keys %$bindtypes) {
1487 my $fqcn = join ('.', $alias, $col);
1488 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1490 # Unqialified column names are nice, but at the same time can be
1491 # rather ambiguous. What we do here is basically go along with
1492 # the loop, adding an unqualified column slot to $bind_attrs,
1493 # alongside the fully qualified name. As soon as we encounter
1494 # another column by that name (which would imply another table)
1495 # we unset the unqualified slot and never add any info to it
1496 # to avoid erroneous type binding. If this happens the users
1497 # only choice will be to fully qualify his column name
1499 if (exists $bind_attrs->{$col}) {
1500 $bind_attrs->{$col} = {};
1503 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1510 $attrs->{software_limit}
1512 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1514 $attrs->{software_limit} = 1;
1517 $self->throw_exception("rows attribute must be positive if present")
1518 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1520 # MySQL actually recommends this approach. I cringe.
1521 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1526 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1527 # otherwise delegate the limiting to the storage, unless software limit was requested
1529 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1531 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1532 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1534 ($ident, $select, $where, $attrs)
1535 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1537 elsif (! $attrs->{software_limit} ) {
1538 push @limit, $attrs->{rows}, $attrs->{offset};
1542 # This would be the point to deflate anything found in $where
1543 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1544 # expect a row object. And all we have is a resultsource (it is trivial
1545 # to extract deflator coderefs via $alias2source above).
1547 # I don't see a way forward other than changing the way deflators are
1548 # invoked, and that's just bad...
1552 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1553 (qw/order_by group_by having/ )
1556 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1560 # This is the code producing joined subqueries like:
1561 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1563 sub _adjust_select_args_for_complex_prefetch {
1564 my ($self, $from, $select, $where, $attrs) = @_;
1566 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1567 if (ref $from ne 'ARRAY');
1569 # copies for mangling
1571 $select = [ @$select ];
1572 $attrs = { %$attrs };
1574 # separate attributes
1575 my $sub_attrs = { %$attrs };
1576 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1577 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1579 my $select_root_alias = $attrs->{alias};
1580 my $sql_maker = $self->sql_maker;
1582 # create subquery select list - consider only stuff *not* brought in by the prefetch
1583 my $sub_select = [];
1585 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1586 my $sel = $attrs->{select}[$i];
1588 # alias any functions to the dbic-side 'as' label
1589 # adjust the outer select accordingly
1590 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1591 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1592 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1595 push @$sub_select, $sel;
1598 # bring over all non-collapse-induced order_by into the inner query (if any)
1599 # the outer one will have to keep them all
1600 delete $sub_attrs->{order_by};
1601 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1602 $sub_attrs->{order_by} = [
1603 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1607 # mangle {from}, keep in mind that $from is "headless" from here on
1608 my $join_root = shift @$from;
1611 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1613 # in complex search_related chains $select_root_alias may *not* be
1614 # 'me' so always include it in the inner join
1615 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1618 # decide which parts of the join will remain on the inside
1620 # this is not a very viable optimisation, but it was written
1621 # before I realised this, so might as well remain. We can throw
1622 # away _any_ branches of the join tree that are:
1623 # 1) not mentioned in the condition/order
1624 # 2) left-join leaves (or left-join leaf chains)
1625 # Most of the join conditions will not satisfy this, but for real
1626 # complex queries some might, and we might make some RDBMS happy.
1629 # since we do not have introspectable SQLA, we fall back to ugly
1630 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1631 # in order to determine what goes into %inner_joins
1632 # It may not be very efficient, but it's a reasonable stop-gap
1634 # produce stuff unquoted, so it can be scanned
1635 local $sql_maker->{quote_char};
1636 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1640 { ref $_ ? $_->[0] : $_ }
1641 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1644 my $where_sql = $sql_maker->where ($where);
1645 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1648 for my $alias (keys %join_info) {
1650 # any table alias found on a column name in where or order_by
1651 # gets included in %inner_joins
1652 # Also any parent joins that are needed to reach this particular alias
1653 for my $piece ($select_sql, $where_sql, @order_by ) {
1654 if ($piece =~ /\b $alias $sep/x) {
1655 $inner_joins{$alias} = 1;
1661 # scan for non-leaf/non-left joins and mark as needed
1662 # also mark all ancestor joins that are needed to reach this particular alias
1663 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1665 # traverse by the size of the -join_path i.e. reverse depth first
1666 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1668 my $j = $join_info{$alias};
1669 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1671 if ($inner_joins{$alias}) {
1672 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1676 # construct the inner $from for the subquery
1677 my $inner_from = [ $join_root ];
1678 for my $j (@$from) {
1679 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1682 # if a multi-type join was needed in the subquery ("multi" is indicated by
1683 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1684 unless ($sub_attrs->{group_by}) {
1685 for my $alias (keys %inner_joins) {
1687 # the dot comes from some weirdness in collapse
1688 # remove after the rewrite
1689 if ($attrs->{collapse}{".$alias"}) {
1690 $sub_attrs->{group_by} ||= $sub_select;
1696 # generate the subquery
1697 my $subq = $self->_select_args_to_query (
1703 my $subq_joinspec = {
1704 -alias => $select_root_alias,
1705 -source_handle => $join_root->{-source_handle},
1706 $select_root_alias => $subq,
1709 # Generate a new from (really just replace the join slot with the subquery)
1710 # Before we would start the outer chain from the subquery itself (i.e.
1711 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1712 # a bad idea for search_related, as the root of the chain was effectively
1713 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1714 # of 'cds', which would prevent from doing things like order_by artist.*)
1715 # See t/prefetch/via_search_related.t for a better idea
1717 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1723 else { # this is trickier
1724 @outer_from = ($join_root);
1726 for my $j (@$from) {
1727 if ($j->[0]{-alias} eq $select_root_alias) {
1734 push @outer_from, $j;
1739 # This is totally horrific - the $where ends up in both the inner and outer query
1740 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1741 # then if where conditions apply to the *right* side of the prefetch, you may have
1742 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1743 # the outer select to exclude joins you didin't want in the first place
1745 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1746 return (\@outer_from, $select, $where, $attrs);
1749 sub _resolve_ident_sources {
1750 my ($self, $ident) = @_;
1752 my $alias2source = {};
1755 # the reason this is so contrived is that $ident may be a {from}
1756 # structure, specifying multiple tables to join
1757 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1758 # this is compat mode for insert/update/delete which do not deal with aliases
1759 $alias2source->{me} = $ident;
1762 elsif (ref $ident eq 'ARRAY') {
1766 if (ref $_ eq 'HASH') {
1768 $rs_alias = $tabinfo->{-alias};
1770 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1774 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1775 if ($tabinfo->{-source_handle});
1779 return ($alias2source, $rs_alias);
1782 # Takes $ident, \@column_names
1784 # returns { $column_name => \%column_info, ... }
1785 # also note: this adds -result_source => $rsrc to the column info
1788 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1789 sub _resolve_column_info {
1790 my ($self, $ident, $colnames) = @_;
1791 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1793 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1796 my (%return, %seen_cols);
1798 # compile a global list of column names, to be able to properly
1799 # disambiguate unqualified column names (if at all possible)
1800 for my $alias (keys %$alias2src) {
1801 my $rsrc = $alias2src->{$alias};
1802 for my $colname ($rsrc->columns) {
1803 push @{$seen_cols{$colname}}, $alias;
1808 foreach my $col (@$colnames) {
1809 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1812 # see if the column was seen exactly once (so we know which rsrc it came from)
1813 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1814 $alias = $seen_cols{$colname}[0];
1821 my $rsrc = $alias2src->{$alias};
1822 $return{$col} = $rsrc && {
1823 %{$rsrc->column_info($colname)},
1824 -result_source => $rsrc,
1825 -source_alias => $alias,
1832 # Returns a counting SELECT for a simple count
1833 # query. Abstracted so that a storage could override
1834 # this to { count => 'firstcol' } or whatever makes
1835 # sense as a performance optimization
1837 #my ($self, $source, $rs_attrs) = @_;
1838 return { count => '*' };
1841 # Returns a SELECT which will end up in the subselect
1842 # There may or may not be a group_by, as the subquery
1843 # might have been called to accomodate a limit
1845 # Most databases would be happy with whatever ends up
1846 # here, but some choke in various ways.
1848 sub _subq_count_select {
1849 my ($self, $source, $rs_attrs) = @_;
1850 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1852 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1853 return @pcols ? \@pcols : [ 1 ];
1857 sub source_bind_attributes {
1858 my ($self, $source) = @_;
1860 my $bind_attributes;
1861 foreach my $column ($source->columns) {
1863 my $data_type = $source->column_info($column)->{data_type} || '';
1864 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1868 return $bind_attributes;
1875 =item Arguments: $ident, $select, $condition, $attrs
1879 Handle a SQL select statement.
1885 my ($ident, $select, $condition, $attrs) = @_;
1886 return $self->cursor_class->new($self, \@_, $attrs);
1891 my ($rv, $sth, @bind) = $self->_select(@_);
1892 my @row = $sth->fetchrow_array;
1893 my @nextrow = $sth->fetchrow_array if @row;
1894 if(@row && @nextrow) {
1895 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1897 # Need to call finish() to work round broken DBDs
1906 =item Arguments: $sql
1910 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1915 my ($self, $dbh, $sql) = @_;
1917 # 3 is the if_active parameter which avoids active sth re-use
1918 my $sth = $self->disable_sth_caching
1919 ? $dbh->prepare($sql)
1920 : $dbh->prepare_cached($sql, {}, 3);
1922 # XXX You would think RaiseError would make this impossible,
1923 # but apparently that's not true :(
1924 $self->throw_exception($dbh->errstr) if !$sth;
1930 my ($self, $sql) = @_;
1931 $self->dbh_do('_dbh_sth', $sql);
1934 sub _dbh_columns_info_for {
1935 my ($self, $dbh, $table) = @_;
1937 if ($dbh->can('column_info')) {
1940 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1941 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1943 while ( my $info = $sth->fetchrow_hashref() ){
1945 $column_info{data_type} = $info->{TYPE_NAME};
1946 $column_info{size} = $info->{COLUMN_SIZE};
1947 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1948 $column_info{default_value} = $info->{COLUMN_DEF};
1949 my $col_name = $info->{COLUMN_NAME};
1950 $col_name =~ s/^\"(.*)\"$/$1/;
1952 $result{$col_name} = \%column_info;
1955 return \%result if !$@ && scalar keys %result;
1959 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1961 my @columns = @{$sth->{NAME_lc}};
1962 for my $i ( 0 .. $#columns ){
1964 $column_info{data_type} = $sth->{TYPE}->[$i];
1965 $column_info{size} = $sth->{PRECISION}->[$i];
1966 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1968 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1969 $column_info{data_type} = $1;
1970 $column_info{size} = $2;
1973 $result{$columns[$i]} = \%column_info;
1977 foreach my $col (keys %result) {
1978 my $colinfo = $result{$col};
1979 my $type_num = $colinfo->{data_type};
1981 if(defined $type_num && $dbh->can('type_info')) {
1982 my $type_info = $dbh->type_info($type_num);
1983 $type_name = $type_info->{TYPE_NAME} if $type_info;
1984 $colinfo->{data_type} = $type_name if $type_name;
1991 sub columns_info_for {
1992 my ($self, $table) = @_;
1993 $self->dbh_do('_dbh_columns_info_for', $table);
1996 =head2 last_insert_id
1998 Return the row id of the last insert.
2002 sub _dbh_last_insert_id {
2003 # All Storage's need to register their own _dbh_last_insert_id
2004 # the old SQLite-based method was highly inappropriate
2007 my $class = ref $self;
2008 $self->throw_exception (<<EOE);
2010 No _dbh_last_insert_id() method found in $class.
2011 Since the method of obtaining the autoincrement id of the last insert
2012 operation varies greatly between different databases, this method must be
2013 individually implemented for every storage class.
2017 sub last_insert_id {
2019 $self->dbh_do('_dbh_last_insert_id', @_);
2024 Returns the database driver name.
2028 sub sqlt_type { shift->last_dbh->{Driver}->{Name} }
2030 =head2 bind_attribute_by_data_type
2032 Given a datatype from column info, returns a database specific bind
2033 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2034 let the database planner just handle it.
2036 Generally only needed for special case column types, like bytea in postgres.
2040 sub bind_attribute_by_data_type {
2044 =head2 is_datatype_numeric
2046 Given a datatype from column_info, returns a boolean value indicating if
2047 the current RDBMS considers it a numeric value. This controls how
2048 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2049 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2050 be performed instead of the usual C<eq>.
2054 sub is_datatype_numeric {
2055 my ($self, $dt) = @_;
2057 return 0 unless $dt;
2059 return $dt =~ /^ (?:
2060 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2065 =head2 create_ddl_dir (EXPERIMENTAL)
2069 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2073 Creates a SQL file based on the Schema, for each of the specified
2074 database engines in C<\@databases> in the given directory.
2075 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2077 Given a previous version number, this will also create a file containing
2078 the ALTER TABLE statements to transform the previous schema into the
2079 current one. Note that these statements may contain C<DROP TABLE> or
2080 C<DROP COLUMN> statements that can potentially destroy data.
2082 The file names are created using the C<ddl_filename> method below, please
2083 override this method in your schema if you would like a different file
2084 name format. For the ALTER file, the same format is used, replacing
2085 $version in the name with "$preversion-$version".
2087 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2088 The most common value for this would be C<< { add_drop_table => 1 } >>
2089 to have the SQL produced include a C<DROP TABLE> statement for each table
2090 created. For quoting purposes supply C<quote_table_names> and
2091 C<quote_field_names>.
2093 If no arguments are passed, then the following default values are assumed:
2097 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2099 =item version - $schema->schema_version
2101 =item directory - './'
2103 =item preversion - <none>
2107 By default, C<\%sqlt_args> will have
2109 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2111 merged with the hash passed in. To disable any of those features, pass in a
2112 hashref like the following
2114 { ignore_constraint_names => 0, # ... other options }
2117 Note that this feature is currently EXPERIMENTAL and may not work correctly
2118 across all databases, or fully handle complex relationships.
2120 WARNING: Please check all SQL files created, before applying them.
2124 sub create_ddl_dir {
2125 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2127 if(!$dir || !-d $dir) {
2128 carp "No directory given, using ./\n";
2131 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2132 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2134 my $schema_version = $schema->schema_version || '1.x';
2135 $version ||= $schema_version;
2138 add_drop_table => 1,
2139 ignore_constraint_names => 1,
2140 ignore_index_names => 1,
2144 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2145 . $self->_check_sqlt_message . q{'})
2146 if !$self->_check_sqlt_version;
2148 my $sqlt = SQL::Translator->new( $sqltargs );
2150 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2151 my $sqlt_schema = $sqlt->translate({ data => $schema })
2152 or $self->throw_exception ($sqlt->error);
2154 foreach my $db (@$databases) {
2156 $sqlt->{schema} = $sqlt_schema;
2157 $sqlt->producer($db);
2160 my $filename = $schema->ddl_filename($db, $version, $dir);
2161 if (-e $filename && ($version eq $schema_version )) {
2162 # if we are dumping the current version, overwrite the DDL
2163 carp "Overwriting existing DDL file - $filename";
2167 my $output = $sqlt->translate;
2169 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2172 if(!open($file, ">$filename")) {
2173 $self->throw_exception("Can't open $filename for writing ($!)");
2176 print $file $output;
2179 next unless ($preversion);
2181 require SQL::Translator::Diff;
2183 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2184 if(!-e $prefilename) {
2185 carp("No previous schema file found ($prefilename)");
2189 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2191 carp("Overwriting existing diff file - $difffile");
2197 my $t = SQL::Translator->new($sqltargs);
2202 or $self->throw_exception ($t->error);
2204 my $out = $t->translate( $prefilename )
2205 or $self->throw_exception ($t->error);
2207 $source_schema = $t->schema;
2209 $source_schema->name( $prefilename )
2210 unless ( $source_schema->name );
2213 # The "new" style of producers have sane normalization and can support
2214 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2215 # And we have to diff parsed SQL against parsed SQL.
2216 my $dest_schema = $sqlt_schema;
2218 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2219 my $t = SQL::Translator->new($sqltargs);
2224 or $self->throw_exception ($t->error);
2226 my $out = $t->translate( $filename )
2227 or $self->throw_exception ($t->error);
2229 $dest_schema = $t->schema;
2231 $dest_schema->name( $filename )
2232 unless $dest_schema->name;
2235 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2239 if(!open $file, ">$difffile") {
2240 $self->throw_exception("Can't write to $difffile ($!)");
2248 =head2 deployment_statements
2252 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2256 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2258 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2259 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2261 C<$directory> is used to return statements from files in a previously created
2262 L</create_ddl_dir> directory and is optional. The filenames are constructed
2263 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2265 If no C<$directory> is specified then the statements are constructed on the
2266 fly using L<SQL::Translator> and C<$version> is ignored.
2268 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2272 sub deployment_statements {
2273 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2274 # Need to be connected to get the correct sqlt_type
2275 $self->last_dbh() unless $type;
2276 $type ||= $self->sqlt_type;
2277 $version ||= $schema->schema_version || '1.x';
2279 my $filename = $schema->ddl_filename($type, $version, $dir);
2283 open($file, "<$filename")
2284 or $self->throw_exception("Can't open $filename ($!)");
2287 return join('', @rows);
2290 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2291 . $self->_check_sqlt_message . q{'})
2292 if !$self->_check_sqlt_version;
2294 require SQL::Translator::Parser::DBIx::Class;
2295 eval qq{use SQL::Translator::Producer::${type}};
2296 $self->throw_exception($@) if $@;
2298 # sources needs to be a parser arg, but for simplicty allow at top level
2300 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2301 if exists $sqltargs->{sources};
2303 my $tr = SQL::Translator->new(%$sqltargs);
2304 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2305 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2309 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2312 return if($line =~ /^--/);
2314 # next if($line =~ /^DROP/m);
2315 return if($line =~ /^BEGIN TRANSACTION/m);
2316 return if($line =~ /^COMMIT/m);
2317 return if $line =~ /^\s+$/; # skip whitespace only
2318 $self->_query_start($line);
2320 # a previous error may invalidate $dbh - thus we need to use dbh()
2321 # to guarantee a healthy $dbh (this is temporary until we get
2322 # proper error handling on deploy() )
2323 $self->dbh->do($line);
2326 carp qq{$@ (running "${line}")};
2328 $self->_query_end($line);
2330 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2331 if (@statements > 1) {
2332 foreach my $statement (@statements) {
2333 $deploy->( $statement );
2336 elsif (@statements == 1) {
2337 foreach my $line ( split(";\n", $statements[0])) {
2343 =head2 datetime_parser
2345 Returns the datetime parser class
2349 sub datetime_parser {
2351 return $self->{datetime_parser} ||= do {
2353 $self->build_datetime_parser(@_);
2357 =head2 datetime_parser_type
2359 Defines (returns) the datetime parser class - currently hardwired to
2360 L<DateTime::Format::MySQL>
2364 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2366 =head2 build_datetime_parser
2368 See L</datetime_parser>
2372 sub build_datetime_parser {
2374 my $type = $self->datetime_parser_type(@_);
2376 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2381 my $_check_sqlt_version; # private
2382 my $_check_sqlt_message; # private
2383 sub _check_sqlt_version {
2384 return $_check_sqlt_version if defined $_check_sqlt_version;
2385 eval 'use SQL::Translator "0.09003"';
2386 $_check_sqlt_message = $@ || '';
2387 $_check_sqlt_version = !$@;
2390 sub _check_sqlt_message {
2391 _check_sqlt_version if !defined $_check_sqlt_message;
2392 $_check_sqlt_message;
2396 =head2 is_replicating
2398 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2399 replicate from a master database. Default is undef, which is the result
2400 returned by databases that don't support replication.
2404 sub is_replicating {
2409 =head2 lag_behind_master
2411 Returns a number that represents a certain amount of lag behind a master db
2412 when a given storage is replicating. The number is database dependent, but
2413 starts at zero and increases with the amount of lag. Default in undef
2417 sub lag_behind_master {
2423 return if !$self->_dbh;
2432 =head2 DBIx::Class and AutoCommit
2434 DBIx::Class can do some wonderful magic with handling exceptions,
2435 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2436 (the default) combined with C<txn_do> for transaction support.
2438 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2439 in an assumed transaction between commits, and you're telling us you'd
2440 like to manage that manually. A lot of the magic protections offered by
2441 this module will go away. We can't protect you from exceptions due to database
2442 disconnects because we don't know anything about how to restart your
2443 transactions. You're on your own for handling all sorts of exceptional
2444 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2450 Matt S. Trout <mst@shadowcatsystems.co.uk>
2452 Andy Grundman <andy@hybridized.org>
2456 You may distribute this code under the same terms as Perl itself.