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
444 %attrs = (%{ $self->_dbi_connect_attributes }, %attrs);
447 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
448 $self->_connect_info;
451 sub _dbi_connect_attributes {
452 return { AutoCommit => 1 };
457 This method is deprecated in favour of setting via L</connect_info>.
461 =head2 on_disconnect_do
463 This method is deprecated in favour of setting via L</connect_info>.
467 sub _parse_connect_do {
468 my ($self, $type) = @_;
470 my $val = $self->$type;
471 return () if not defined $val;
476 push @res, [ 'do_sql', $val ];
477 } elsif (ref($val) eq 'CODE') {
479 } elsif (ref($val) eq 'ARRAY') {
480 push @res, map { [ 'do_sql', $_ ] } @$val;
482 $self->throw_exception("Invalid type for $type: ".ref($val));
490 Arguments: ($subref | $method_name), @extra_coderef_args?
492 Execute the given $subref or $method_name using the new exception-based
493 connection management.
495 The first two arguments will be the storage object that C<dbh_do> was called
496 on and a database handle to use. Any additional arguments will be passed
497 verbatim to the called subref as arguments 2 and onwards.
499 Using this (instead of $self->_dbh or $self->dbh) ensures correct
500 exception handling and reconnection (or failover in future subclasses).
502 Your subref should have no side-effects outside of the database, as
503 there is the potential for your subref to be partially double-executed
504 if the database connection was stale/dysfunctional.
508 my @stuff = $schema->storage->dbh_do(
510 my ($storage, $dbh, @cols) = @_;
511 my $cols = join(q{, }, @cols);
512 $dbh->selectrow_array("SELECT $cols FROM foo");
523 my $dbh = $self->_dbh;
525 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
526 || $self->{transaction_depth};
528 local $self->{_in_dbh_do} = 1;
531 my $want_array = wantarray;
534 $self->_verify_pid if $dbh;
536 $self->_populate_dbh;
541 @result = $self->$code($dbh, @_);
543 elsif(defined $want_array) {
544 $result[0] = $self->$code($dbh, @_);
547 $self->$code($dbh, @_);
552 if(!$exception) { return $want_array ? @result : $result[0] }
554 $self->throw_exception($exception) if $self->connected;
556 # We were not connected - reconnect and retry, but let any
557 # exception fall right through this time
558 $self->_populate_dbh;
559 $self->$code($self->_dbh, @_);
562 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
563 # It also informs dbh_do to bypass itself while under the direction of txn_do,
564 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
569 ref $coderef eq 'CODE' or $self->throw_exception
570 ('$coderef must be a CODE reference');
572 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
574 local $self->{_in_dbh_do} = 1;
577 my $want_array = wantarray;
582 $self->_verify_pid if $self->_dbh;
583 $self->_populate_dbh if !$self->_dbh;
587 @result = $coderef->(@_);
589 elsif(defined $want_array) {
590 $result[0] = $coderef->(@_);
599 if(!$exception) { return $want_array ? @result : $result[0] }
601 if($tried++ > 0 || $self->connected) {
602 eval { $self->txn_rollback };
603 my $rollback_exception = $@;
604 if($rollback_exception) {
605 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
606 $self->throw_exception($exception) # propagate nested rollback
607 if $rollback_exception =~ /$exception_class/;
609 $self->throw_exception(
610 "Transaction aborted: ${exception}. "
611 . "Rollback failed: ${rollback_exception}"
614 $self->throw_exception($exception)
617 # We were not connected, and was first try - reconnect and retry
619 $self->_populate_dbh;
625 Our C<disconnect> method also performs a rollback first if the
626 database is not in C<AutoCommit> mode.
636 push @actions, ( $self->on_disconnect_call || () );
637 push @actions, $self->_parse_connect_do ('on_disconnect_do');
639 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
641 $self->_dbh->rollback unless $self->_dbh_autocommit;
642 $self->_dbh->disconnect;
648 =head2 with_deferred_fk_checks
652 =item Arguments: C<$coderef>
654 =item Return Value: The return value of $coderef
658 Storage specific method to run the code ref with FK checks deferred or
659 in MySQL's case disabled entirely.
663 # Storage subclasses should override this
664 sub with_deferred_fk_checks {
665 my ($self, $sub) = @_;
674 =item Arguments: none
676 =item Return Value: 1|0
680 Verifies that the the current database handle is active and ready to execute
681 an SQL statement (i.e. the connection did not get stale, server is still
682 answering, etc.) This method is used internally by L</dbh>.
689 if(my $dbh = $self->_dbh) {
690 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
697 return 0 if !$self->_dbh;
699 return ($dbh->FETCH('Active') && $self->_ping);
708 my $dbh = $self->_dbh or return 0;
713 # handle pid changes correctly
714 # NOTE: assumes $self->_dbh is a valid $dbh
718 return if defined $self->_conn_pid && $self->_conn_pid == $$;
720 $self->_dbh->{InactiveDestroy} = 1;
727 sub ensure_connected {
730 unless ($self->connected) {
731 $self->_populate_dbh;
737 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
738 is guaranteed to be healthy by implicitly calling L</connected>, and if
739 necessary performing a reconnection before returning.
746 if (not $self->_dbh) {
747 $self->_populate_dbh;
749 $self->ensure_connected;
756 This returns the B<last> available C<$dbh> if any, or attempts to
757 connect and returns the resulting handle. This method differs from
758 L</dbh> by not validating if a preexisting handle is still healthy
759 via L</connected>. Make sure you take appropriate precautions
760 when using this method, as the C<$dbh> may be useless at this point.
766 $self->_populate_dbh unless $self->_dbh;
770 sub _sql_maker_args {
775 array_datatypes => 1,
776 limit_dialect => $self->last_dbh,
777 %{$self->_sql_maker_opts}
783 unless ($self->_sql_maker) {
784 my $sql_maker_class = $self->sql_maker_class;
785 $self->ensure_class_loaded ($sql_maker_class);
786 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
788 return $self->_sql_maker;
796 my @info = @{$self->_dbi_connect_info || []};
797 $self->_dbh($self->_connect(@info));
799 $self->_conn_pid($$);
800 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
802 $self->_determine_driver;
804 # Always set the transaction depth on connect, since
805 # there is no transaction in progress by definition
806 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
808 $self->_run_connection_actions unless $self->{_in_determine_driver};
811 sub _run_connection_actions {
815 push @actions, ( $self->on_connect_call || () );
816 push @actions, $self->_parse_connect_do ('on_connect_do');
818 $self->_do_connection_actions(connect_call_ => $_) for @actions;
821 sub _determine_driver {
824 if (not $self->_driver_determined) {
825 my $started_unconnected = 0;
826 local $self->{_in_determine_driver} = 1;
828 if (ref($self) eq __PACKAGE__) {
830 if ($self->_dbh) { # we are connected
831 $driver = $self->_dbh->{Driver}{Name};
833 # try to use dsn to not require being connected, the driver may still
834 # force a connection in _rebless to determine version
835 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
836 $started_unconnected = 1;
839 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
840 if ($self->load_optional_class($storage_class)) {
841 mro::set_mro($storage_class, 'c3');
842 bless $self, $storage_class;
847 $self->_driver_determined(1);
849 $self->_run_connection_actions
850 if $started_unconnected && defined $self->_dbh;
854 sub _do_connection_actions {
856 my $method_prefix = shift;
859 if (not ref($call)) {
860 my $method = $method_prefix . $call;
862 } elsif (ref($call) eq 'CODE') {
864 } elsif (ref($call) eq 'ARRAY') {
865 if (ref($call->[0]) ne 'ARRAY') {
866 $self->_do_connection_actions($method_prefix, $_) for @$call;
868 $self->_do_connection_actions($method_prefix, @$_) for @$call;
871 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
877 sub connect_call_do_sql {
879 $self->_do_query(@_);
882 sub disconnect_call_do_sql {
884 $self->_do_query(@_);
887 # override in db-specific backend when necessary
888 sub connect_call_datetime_setup { 1 }
891 my ($self, $action) = @_;
893 if (ref $action eq 'CODE') {
894 $action = $action->($self);
895 $self->_do_query($_) foreach @$action;
898 # Most debuggers expect ($sql, @bind), so we need to exclude
899 # the attribute hash which is the second argument to $dbh->do
900 # furthermore the bind values are usually to be presented
901 # as named arrayref pairs, so wrap those here too
902 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
903 my $sql = shift @do_args;
904 my $attrs = shift @do_args;
905 my @bind = map { [ undef, $_ ] } @do_args;
907 $self->_query_start($sql, @bind);
908 $self->_dbh->do($sql, $attrs, @do_args);
909 $self->_query_end($sql, @bind);
916 my ($self, @info) = @_;
918 $self->throw_exception("You failed to provide any connection info")
921 my ($old_connect_via, $dbh);
923 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
924 $old_connect_via = $DBI::connect_via;
925 $DBI::connect_via = 'connect';
929 if(ref $info[0] eq 'CODE') {
933 $dbh = DBI->connect(@info);
936 if($dbh && !$self->unsafe) {
937 my $weak_self = $self;
938 Scalar::Util::weaken($weak_self);
939 $dbh->{HandleError} = sub {
941 $weak_self->throw_exception("DBI Exception: $_[0]");
944 croak ("DBI Exception: $_[0]");
947 $dbh->{ShowErrorStatement} = 1;
948 $dbh->{RaiseError} = 1;
949 $dbh->{PrintError} = 0;
953 $DBI::connect_via = $old_connect_via if $old_connect_via;
955 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
958 $self->_dbh_autocommit($dbh->{AutoCommit});
964 my ($self, $name) = @_;
966 $name = $self->_svp_generate_name
967 unless defined $name;
969 $self->throw_exception ("You can't use savepoints outside a transaction")
970 if $self->{transaction_depth} == 0;
972 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
973 unless $self->can('_svp_begin');
975 push @{ $self->{savepoints} }, $name;
977 $self->debugobj->svp_begin($name) if $self->debug;
979 return $self->_svp_begin($name);
983 my ($self, $name) = @_;
985 $self->throw_exception ("You can't use savepoints outside a transaction")
986 if $self->{transaction_depth} == 0;
988 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
989 unless $self->can('_svp_release');
992 $self->throw_exception ("Savepoint '$name' does not exist")
993 unless grep { $_ eq $name } @{ $self->{savepoints} };
995 # Dig through the stack until we find the one we are releasing. This keeps
996 # the stack up to date.
999 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1001 $name = pop @{ $self->{savepoints} };
1004 $self->debugobj->svp_release($name) if $self->debug;
1006 return $self->_svp_release($name);
1010 my ($self, $name) = @_;
1012 $self->throw_exception ("You can't use savepoints outside a transaction")
1013 if $self->{transaction_depth} == 0;
1015 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1016 unless $self->can('_svp_rollback');
1018 if (defined $name) {
1019 # If they passed us a name, verify that it exists in the stack
1020 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1021 $self->throw_exception("Savepoint '$name' does not exist!");
1024 # Dig through the stack until we find the one we are releasing. This keeps
1025 # the stack up to date.
1026 while(my $s = pop(@{ $self->{savepoints} })) {
1027 last if($s eq $name);
1029 # Add the savepoint back to the stack, as a rollback doesn't remove the
1030 # named savepoint, only everything after it.
1031 push(@{ $self->{savepoints} }, $name);
1033 # We'll assume they want to rollback to the last savepoint
1034 $name = $self->{savepoints}->[-1];
1037 $self->debugobj->svp_rollback($name) if $self->debug;
1039 return $self->_svp_rollback($name);
1042 sub _svp_generate_name {
1045 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1050 if($self->{transaction_depth} == 0) {
1051 $self->debugobj->txn_begin()
1053 # this isn't ->_dbh-> because
1054 # we should reconnect on begin_work
1055 # for AutoCommit users
1056 $self->dbh_do(sub { $_[1]->begin_work });
1057 } elsif ($self->auto_savepoint) {
1060 $self->{transaction_depth}++;
1065 if ($self->{transaction_depth} == 1) {
1066 my $dbh = $self->_dbh;
1067 $self->debugobj->txn_commit()
1070 $self->{transaction_depth} = 0
1071 if $self->_dbh_autocommit;
1073 elsif($self->{transaction_depth} > 1) {
1074 $self->{transaction_depth}--;
1076 if $self->auto_savepoint;
1082 my $dbh = $self->_dbh;
1084 if ($self->{transaction_depth} == 1) {
1085 $self->debugobj->txn_rollback()
1087 $self->{transaction_depth} = 0
1088 if $self->_dbh_autocommit;
1091 elsif($self->{transaction_depth} > 1) {
1092 $self->{transaction_depth}--;
1093 if ($self->auto_savepoint) {
1094 $self->svp_rollback;
1099 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1104 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1105 $error =~ /$exception_class/ and $self->throw_exception($error);
1106 # ensure that a failed rollback resets the transaction depth
1107 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1108 $self->throw_exception($error);
1112 # This used to be the top-half of _execute. It was split out to make it
1113 # easier to override in NoBindVars without duping the rest. It takes up
1114 # all of _execute's args, and emits $sql, @bind.
1115 sub _prep_for_execute {
1116 my ($self, $op, $extra_bind, $ident, $args) = @_;
1118 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1119 $ident = $ident->from();
1122 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1125 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1127 return ($sql, \@bind);
1131 sub _fix_bind_params {
1132 my ($self, @bind) = @_;
1134 ### Turn @bind from something like this:
1135 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1137 ### ( "'1'", "'1'", "'3'" )
1140 if ( defined( $_ && $_->[1] ) ) {
1141 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1148 my ( $self, $sql, @bind ) = @_;
1150 if ( $self->debug ) {
1151 @bind = $self->_fix_bind_params(@bind);
1153 $self->debugobj->query_start( $sql, @bind );
1158 my ( $self, $sql, @bind ) = @_;
1160 if ( $self->debug ) {
1161 @bind = $self->_fix_bind_params(@bind);
1162 $self->debugobj->query_end( $sql, @bind );
1167 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1169 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1171 $self->_query_start( $sql, @$bind );
1173 my $sth = $self->sth($sql,$op);
1175 my $placeholder_index = 1;
1177 foreach my $bound (@$bind) {
1178 my $attributes = {};
1179 my($column_name, @data) = @$bound;
1181 if ($bind_attributes) {
1182 $attributes = $bind_attributes->{$column_name}
1183 if defined $bind_attributes->{$column_name};
1186 foreach my $data (@data) {
1187 my $ref = ref $data;
1188 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1190 $sth->bind_param($placeholder_index, $data, $attributes);
1191 $placeholder_index++;
1195 # Can this fail without throwing an exception anyways???
1196 my $rv = $sth->execute();
1197 $self->throw_exception($sth->errstr) if !$rv;
1199 $self->_query_end( $sql, @$bind );
1201 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1206 $self->dbh_do('_dbh_execute', @_)
1210 my ($self, $source, $to_insert) = @_;
1212 # redispatch to insert method of storage we reblessed into, if necessary
1213 if (not $self->_driver_determined) {
1214 $self->_determine_driver;
1215 goto $self->can('insert');
1218 my $ident = $source->from;
1219 my $bind_attributes = $self->source_bind_attributes($source);
1221 my $updated_cols = {};
1223 foreach my $col ( $source->columns ) {
1224 if ( !defined $to_insert->{$col} ) {
1225 my $col_info = $source->column_info($col);
1227 if ( $col_info->{auto_nextval} ) {
1228 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1230 $col_info->{sequence} ||
1231 $self->_dbh_get_autoinc_seq($self->last_dbh, $source)
1237 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1239 return $updated_cols;
1242 ## Still not quite perfect, and EXPERIMENTAL
1243 ## Currently it is assumed that all values passed will be "normal", i.e. not
1244 ## scalar refs, or at least, all the same type as the first set, the statement is
1245 ## only prepped once.
1247 my ($self, $source, $cols, $data) = @_;
1249 my $table = $source->from;
1250 @colvalues{@$cols} = (0..$#$cols);
1251 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1253 $self->_determine_driver;
1255 $self->_query_start( $sql, @bind );
1256 my $sth = $self->sth($sql);
1258 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1260 ## This must be an arrayref, else nothing works!
1261 my $tuple_status = [];
1263 ## Get the bind_attributes, if any exist
1264 my $bind_attributes = $self->source_bind_attributes($source);
1266 ## Bind the values and execute
1267 my $placeholder_index = 1;
1269 foreach my $bound (@bind) {
1271 my $attributes = {};
1272 my ($column_name, $data_index) = @$bound;
1274 if( $bind_attributes ) {
1275 $attributes = $bind_attributes->{$column_name}
1276 if defined $bind_attributes->{$column_name};
1279 my @data = map { $_->[$data_index] } @$data;
1281 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1282 $placeholder_index++;
1284 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1287 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1289 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1290 if ($i > $#$tuple_status);
1292 require Data::Dumper;
1293 local $Data::Dumper::Terse = 1;
1294 local $Data::Dumper::Indent = 1;
1295 local $Data::Dumper::Useqq = 1;
1296 local $Data::Dumper::Quotekeys = 0;
1298 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1299 $tuple_status->[$i][1],
1300 Data::Dumper::Dumper(
1301 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1305 $self->throw_exception($sth->errstr) if !$rv;
1307 $self->_query_end( $sql, @bind );
1308 return (wantarray ? ($rv, $sth, @bind) : $rv);
1312 my $self = shift @_;
1313 my $source = shift @_;
1314 $self->_determine_driver;
1315 my $bind_attributes = $self->source_bind_attributes($source);
1317 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1322 my $self = shift @_;
1323 my $source = shift @_;
1324 $self->_determine_driver;
1325 my $bind_attrs = $self->source_bind_attributes($source);
1327 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1330 # We were sent here because the $rs contains a complex search
1331 # which will require a subquery to select the correct rows
1332 # (i.e. joined or limited resultsets)
1334 # Genarating a single PK column subquery is trivial and supported
1335 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1336 # Look at _multipk_update_delete()
1337 sub _subq_update_delete {
1339 my ($rs, $op, $values) = @_;
1341 my $rsrc = $rs->result_source;
1343 # we already check this, but double check naively just in case. Should be removed soon
1344 my $sel = $rs->_resolved_attrs->{select};
1345 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1346 my @pcols = $rsrc->primary_columns;
1347 if (@$sel != @pcols) {
1348 $self->throw_exception (
1349 'Subquery update/delete can not be called on resultsets selecting a'
1350 .' number of columns different than the number of primary keys'
1357 $op eq 'update' ? $values : (),
1358 { $pcols[0] => { -in => $rs->as_query } },
1363 return $self->_multipk_update_delete (@_);
1367 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1368 # resultset update/delete involving subqueries. So by default resort
1369 # to simple (and inefficient) delete_all style per-row opearations,
1370 # while allowing specific storages to override this with a faster
1373 sub _multipk_update_delete {
1374 return shift->_per_row_update_delete (@_);
1377 # This is the default loop used to delete/update rows for multi PK
1378 # resultsets, and used by mysql exclusively (because it can't do anything
1381 # We do not use $row->$op style queries, because resultset update/delete
1382 # is not expected to cascade (this is what delete_all/update_all is for).
1384 # There should be no race conditions as the entire operation is rolled
1387 sub _per_row_update_delete {
1389 my ($rs, $op, $values) = @_;
1391 my $rsrc = $rs->result_source;
1392 my @pcols = $rsrc->primary_columns;
1394 my $guard = $self->txn_scope_guard;
1396 # emulate the return value of $sth->execute for non-selects
1397 my $row_cnt = '0E0';
1399 my $subrs_cur = $rs->cursor;
1400 while (my @pks = $subrs_cur->next) {
1403 for my $i (0.. $#pcols) {
1404 $cond->{$pcols[$i]} = $pks[$i];
1409 $op eq 'update' ? $values : (),
1424 # localization is neccessary as
1425 # 1) there is no infrastructure to pass this around before SQLA2
1426 # 2) _select_args sets it and _prep_for_execute consumes it
1427 my $sql_maker = $self->sql_maker;
1428 local $sql_maker->{_dbic_rs_attrs};
1430 return $self->_execute($self->_select_args(@_));
1433 sub _select_args_to_query {
1436 # localization is neccessary as
1437 # 1) there is no infrastructure to pass this around before SQLA2
1438 # 2) _select_args sets it and _prep_for_execute consumes it
1439 my $sql_maker = $self->sql_maker;
1440 local $sql_maker->{_dbic_rs_attrs};
1442 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1443 # = $self->_select_args($ident, $select, $cond, $attrs);
1444 my ($op, $bind, $ident, $bind_attrs, @args) =
1445 $self->_select_args(@_);
1447 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1448 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1449 $prepared_bind ||= [];
1452 ? ($sql, $prepared_bind, $bind_attrs)
1453 : \[ "($sql)", @$prepared_bind ]
1458 my ($self, $ident, $select, $where, $attrs) = @_;
1460 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1462 my $sql_maker = $self->sql_maker;
1463 $sql_maker->{_dbic_rs_attrs} = {
1469 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1474 # calculate bind_attrs before possible $ident mangling
1475 my $bind_attrs = {};
1476 for my $alias (keys %$alias2source) {
1477 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1478 for my $col (keys %$bindtypes) {
1480 my $fqcn = join ('.', $alias, $col);
1481 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1483 # Unqialified column names are nice, but at the same time can be
1484 # rather ambiguous. What we do here is basically go along with
1485 # the loop, adding an unqualified column slot to $bind_attrs,
1486 # alongside the fully qualified name. As soon as we encounter
1487 # another column by that name (which would imply another table)
1488 # we unset the unqualified slot and never add any info to it
1489 # to avoid erroneous type binding. If this happens the users
1490 # only choice will be to fully qualify his column name
1492 if (exists $bind_attrs->{$col}) {
1493 $bind_attrs->{$col} = {};
1496 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1503 $attrs->{software_limit}
1505 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1507 $attrs->{software_limit} = 1;
1510 $self->throw_exception("rows attribute must be positive if present")
1511 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1513 # MySQL actually recommends this approach. I cringe.
1514 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1519 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1520 # otherwise delegate the limiting to the storage, unless software limit was requested
1522 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1524 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1525 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1527 ($ident, $select, $where, $attrs)
1528 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1530 elsif (! $attrs->{software_limit} ) {
1531 push @limit, $attrs->{rows}, $attrs->{offset};
1535 # This would be the point to deflate anything found in $where
1536 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1537 # expect a row object. And all we have is a resultsource (it is trivial
1538 # to extract deflator coderefs via $alias2source above).
1540 # I don't see a way forward other than changing the way deflators are
1541 # invoked, and that's just bad...
1545 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1546 (qw/order_by group_by having/ )
1549 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1553 # This is the code producing joined subqueries like:
1554 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1556 sub _adjust_select_args_for_complex_prefetch {
1557 my ($self, $from, $select, $where, $attrs) = @_;
1559 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1560 if (ref $from ne 'ARRAY');
1562 # copies for mangling
1564 $select = [ @$select ];
1565 $attrs = { %$attrs };
1567 # separate attributes
1568 my $sub_attrs = { %$attrs };
1569 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1570 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1572 my $select_root_alias = $attrs->{alias};
1573 my $sql_maker = $self->sql_maker;
1575 # create subquery select list - consider only stuff *not* brought in by the prefetch
1576 my $sub_select = [];
1578 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1579 my $sel = $attrs->{select}[$i];
1581 # alias any functions to the dbic-side 'as' label
1582 # adjust the outer select accordingly
1583 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1584 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1585 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1588 push @$sub_select, $sel;
1591 # bring over all non-collapse-induced order_by into the inner query (if any)
1592 # the outer one will have to keep them all
1593 delete $sub_attrs->{order_by};
1594 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1595 $sub_attrs->{order_by} = [
1596 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1600 # mangle {from}, keep in mind that $from is "headless" from here on
1601 my $join_root = shift @$from;
1604 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1606 # in complex search_related chains $select_root_alias may *not* be
1607 # 'me' so always include it in the inner join
1608 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1611 # decide which parts of the join will remain on the inside
1613 # this is not a very viable optimisation, but it was written
1614 # before I realised this, so might as well remain. We can throw
1615 # away _any_ branches of the join tree that are:
1616 # 1) not mentioned in the condition/order
1617 # 2) left-join leaves (or left-join leaf chains)
1618 # Most of the join conditions will not satisfy this, but for real
1619 # complex queries some might, and we might make some RDBMS happy.
1622 # since we do not have introspectable SQLA, we fall back to ugly
1623 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1624 # in order to determine what goes into %inner_joins
1625 # It may not be very efficient, but it's a reasonable stop-gap
1627 # produce stuff unquoted, so it can be scanned
1628 local $sql_maker->{quote_char};
1629 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1633 { ref $_ ? $_->[0] : $_ }
1634 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1637 my $where_sql = $sql_maker->where ($where);
1638 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1641 for my $alias (keys %join_info) {
1643 # any table alias found on a column name in where or order_by
1644 # gets included in %inner_joins
1645 # Also any parent joins that are needed to reach this particular alias
1646 for my $piece ($select_sql, $where_sql, @order_by ) {
1647 if ($piece =~ /\b $alias $sep/x) {
1648 $inner_joins{$alias} = 1;
1654 # scan for non-leaf/non-left joins and mark as needed
1655 # also mark all ancestor joins that are needed to reach this particular alias
1656 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1658 # traverse by the size of the -join_path i.e. reverse depth first
1659 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1661 my $j = $join_info{$alias};
1662 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1664 if ($inner_joins{$alias}) {
1665 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1669 # construct the inner $from for the subquery
1670 my $inner_from = [ $join_root ];
1671 for my $j (@$from) {
1672 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1675 # if a multi-type join was needed in the subquery ("multi" is indicated by
1676 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1677 unless ($sub_attrs->{group_by}) {
1678 for my $alias (keys %inner_joins) {
1680 # the dot comes from some weirdness in collapse
1681 # remove after the rewrite
1682 if ($attrs->{collapse}{".$alias"}) {
1683 $sub_attrs->{group_by} ||= $sub_select;
1689 # generate the subquery
1690 my $subq = $self->_select_args_to_query (
1696 my $subq_joinspec = {
1697 -alias => $select_root_alias,
1698 -source_handle => $join_root->{-source_handle},
1699 $select_root_alias => $subq,
1702 # Generate a new from (really just replace the join slot with the subquery)
1703 # Before we would start the outer chain from the subquery itself (i.e.
1704 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1705 # a bad idea for search_related, as the root of the chain was effectively
1706 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1707 # of 'cds', which would prevent from doing things like order_by artist.*)
1708 # See t/prefetch/via_search_related.t for a better idea
1710 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1716 else { # this is trickier
1717 @outer_from = ($join_root);
1719 for my $j (@$from) {
1720 if ($j->[0]{-alias} eq $select_root_alias) {
1727 push @outer_from, $j;
1732 # This is totally horrific - the $where ends up in both the inner and outer query
1733 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1734 # then if where conditions apply to the *right* side of the prefetch, you may have
1735 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1736 # the outer select to exclude joins you didin't want in the first place
1738 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1739 return (\@outer_from, $select, $where, $attrs);
1742 sub _resolve_ident_sources {
1743 my ($self, $ident) = @_;
1745 my $alias2source = {};
1748 # the reason this is so contrived is that $ident may be a {from}
1749 # structure, specifying multiple tables to join
1750 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1751 # this is compat mode for insert/update/delete which do not deal with aliases
1752 $alias2source->{me} = $ident;
1755 elsif (ref $ident eq 'ARRAY') {
1759 if (ref $_ eq 'HASH') {
1761 $rs_alias = $tabinfo->{-alias};
1763 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1767 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1768 if ($tabinfo->{-source_handle});
1772 return ($alias2source, $rs_alias);
1775 # Takes $ident, \@column_names
1777 # returns { $column_name => \%column_info, ... }
1778 # also note: this adds -result_source => $rsrc to the column info
1781 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1782 sub _resolve_column_info {
1783 my ($self, $ident, $colnames) = @_;
1784 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1786 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1789 my (%return, %seen_cols);
1791 # compile a global list of column names, to be able to properly
1792 # disambiguate unqualified column names (if at all possible)
1793 for my $alias (keys %$alias2src) {
1794 my $rsrc = $alias2src->{$alias};
1795 for my $colname ($rsrc->columns) {
1796 push @{$seen_cols{$colname}}, $alias;
1801 foreach my $col (@$colnames) {
1802 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1805 # see if the column was seen exactly once (so we know which rsrc it came from)
1806 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1807 $alias = $seen_cols{$colname}[0];
1814 my $rsrc = $alias2src->{$alias};
1815 $return{$col} = $rsrc && {
1816 %{$rsrc->column_info($colname)},
1817 -result_source => $rsrc,
1818 -source_alias => $alias,
1825 # Returns a counting SELECT for a simple count
1826 # query. Abstracted so that a storage could override
1827 # this to { count => 'firstcol' } or whatever makes
1828 # sense as a performance optimization
1830 #my ($self, $source, $rs_attrs) = @_;
1831 return { count => '*' };
1834 # Returns a SELECT which will end up in the subselect
1835 # There may or may not be a group_by, as the subquery
1836 # might have been called to accomodate a limit
1838 # Most databases would be happy with whatever ends up
1839 # here, but some choke in various ways.
1841 sub _subq_count_select {
1842 my ($self, $source, $rs_attrs) = @_;
1843 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1845 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1846 return @pcols ? \@pcols : [ 1 ];
1850 sub source_bind_attributes {
1851 my ($self, $source) = @_;
1853 my $bind_attributes;
1854 foreach my $column ($source->columns) {
1856 my $data_type = $source->column_info($column)->{data_type} || '';
1857 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1861 return $bind_attributes;
1868 =item Arguments: $ident, $select, $condition, $attrs
1872 Handle a SQL select statement.
1878 my ($ident, $select, $condition, $attrs) = @_;
1879 return $self->cursor_class->new($self, \@_, $attrs);
1884 my ($rv, $sth, @bind) = $self->_select(@_);
1885 my @row = $sth->fetchrow_array;
1886 my @nextrow = $sth->fetchrow_array if @row;
1887 if(@row && @nextrow) {
1888 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1890 # Need to call finish() to work round broken DBDs
1899 =item Arguments: $sql
1903 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1908 my ($self, $dbh, $sql) = @_;
1910 # 3 is the if_active parameter which avoids active sth re-use
1911 my $sth = $self->disable_sth_caching
1912 ? $dbh->prepare($sql)
1913 : $dbh->prepare_cached($sql, {}, 3);
1915 # XXX You would think RaiseError would make this impossible,
1916 # but apparently that's not true :(
1917 $self->throw_exception($dbh->errstr) if !$sth;
1923 my ($self, $sql) = @_;
1924 $self->dbh_do('_dbh_sth', $sql);
1927 sub _dbh_columns_info_for {
1928 my ($self, $dbh, $table) = @_;
1930 if ($dbh->can('column_info')) {
1933 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1934 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1936 while ( my $info = $sth->fetchrow_hashref() ){
1938 $column_info{data_type} = $info->{TYPE_NAME};
1939 $column_info{size} = $info->{COLUMN_SIZE};
1940 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1941 $column_info{default_value} = $info->{COLUMN_DEF};
1942 my $col_name = $info->{COLUMN_NAME};
1943 $col_name =~ s/^\"(.*)\"$/$1/;
1945 $result{$col_name} = \%column_info;
1948 return \%result if !$@ && scalar keys %result;
1952 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1954 my @columns = @{$sth->{NAME_lc}};
1955 for my $i ( 0 .. $#columns ){
1957 $column_info{data_type} = $sth->{TYPE}->[$i];
1958 $column_info{size} = $sth->{PRECISION}->[$i];
1959 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1961 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1962 $column_info{data_type} = $1;
1963 $column_info{size} = $2;
1966 $result{$columns[$i]} = \%column_info;
1970 foreach my $col (keys %result) {
1971 my $colinfo = $result{$col};
1972 my $type_num = $colinfo->{data_type};
1974 if(defined $type_num && $dbh->can('type_info')) {
1975 my $type_info = $dbh->type_info($type_num);
1976 $type_name = $type_info->{TYPE_NAME} if $type_info;
1977 $colinfo->{data_type} = $type_name if $type_name;
1984 sub columns_info_for {
1985 my ($self, $table) = @_;
1986 $self->dbh_do('_dbh_columns_info_for', $table);
1989 =head2 last_insert_id
1991 Return the row id of the last insert.
1995 sub _dbh_last_insert_id {
1996 # All Storage's need to register their own _dbh_last_insert_id
1997 # the old SQLite-based method was highly inappropriate
2000 my $class = ref $self;
2001 $self->throw_exception (<<EOE);
2003 No _dbh_last_insert_id() method found in $class.
2004 Since the method of obtaining the autoincrement id of the last insert
2005 operation varies greatly between different databases, this method must be
2006 individually implemented for every storage class.
2010 sub last_insert_id {
2012 $self->dbh_do('_dbh_last_insert_id', @_);
2017 Returns the database driver name.
2021 sub sqlt_type { shift->last_dbh->{Driver}->{Name} }
2023 =head2 bind_attribute_by_data_type
2025 Given a datatype from column info, returns a database specific bind
2026 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2027 let the database planner just handle it.
2029 Generally only needed for special case column types, like bytea in postgres.
2033 sub bind_attribute_by_data_type {
2037 =head2 is_datatype_numeric
2039 Given a datatype from column_info, returns a boolean value indicating if
2040 the current RDBMS considers it a numeric value. This controls how
2041 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2042 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2043 be performed instead of the usual C<eq>.
2047 sub is_datatype_numeric {
2048 my ($self, $dt) = @_;
2050 return 0 unless $dt;
2052 return $dt =~ /^ (?:
2053 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2058 =head2 create_ddl_dir (EXPERIMENTAL)
2062 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2066 Creates a SQL file based on the Schema, for each of the specified
2067 database engines in C<\@databases> in the given directory.
2068 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2070 Given a previous version number, this will also create a file containing
2071 the ALTER TABLE statements to transform the previous schema into the
2072 current one. Note that these statements may contain C<DROP TABLE> or
2073 C<DROP COLUMN> statements that can potentially destroy data.
2075 The file names are created using the C<ddl_filename> method below, please
2076 override this method in your schema if you would like a different file
2077 name format. For the ALTER file, the same format is used, replacing
2078 $version in the name with "$preversion-$version".
2080 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2081 The most common value for this would be C<< { add_drop_table => 1 } >>
2082 to have the SQL produced include a C<DROP TABLE> statement for each table
2083 created. For quoting purposes supply C<quote_table_names> and
2084 C<quote_field_names>.
2086 If no arguments are passed, then the following default values are assumed:
2090 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2092 =item version - $schema->schema_version
2094 =item directory - './'
2096 =item preversion - <none>
2100 By default, C<\%sqlt_args> will have
2102 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2104 merged with the hash passed in. To disable any of those features, pass in a
2105 hashref like the following
2107 { ignore_constraint_names => 0, # ... other options }
2110 Note that this feature is currently EXPERIMENTAL and may not work correctly
2111 across all databases, or fully handle complex relationships.
2113 WARNING: Please check all SQL files created, before applying them.
2117 sub create_ddl_dir {
2118 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2120 if(!$dir || !-d $dir) {
2121 carp "No directory given, using ./\n";
2124 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2125 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2127 my $schema_version = $schema->schema_version || '1.x';
2128 $version ||= $schema_version;
2131 add_drop_table => 1,
2132 ignore_constraint_names => 1,
2133 ignore_index_names => 1,
2137 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2138 . $self->_check_sqlt_message . q{'})
2139 if !$self->_check_sqlt_version;
2141 my $sqlt = SQL::Translator->new( $sqltargs );
2143 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2144 my $sqlt_schema = $sqlt->translate({ data => $schema })
2145 or $self->throw_exception ($sqlt->error);
2147 foreach my $db (@$databases) {
2149 $sqlt->{schema} = $sqlt_schema;
2150 $sqlt->producer($db);
2153 my $filename = $schema->ddl_filename($db, $version, $dir);
2154 if (-e $filename && ($version eq $schema_version )) {
2155 # if we are dumping the current version, overwrite the DDL
2156 carp "Overwriting existing DDL file - $filename";
2160 my $output = $sqlt->translate;
2162 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2165 if(!open($file, ">$filename")) {
2166 $self->throw_exception("Can't open $filename for writing ($!)");
2169 print $file $output;
2172 next unless ($preversion);
2174 require SQL::Translator::Diff;
2176 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2177 if(!-e $prefilename) {
2178 carp("No previous schema file found ($prefilename)");
2182 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2184 carp("Overwriting existing diff file - $difffile");
2190 my $t = SQL::Translator->new($sqltargs);
2195 or $self->throw_exception ($t->error);
2197 my $out = $t->translate( $prefilename )
2198 or $self->throw_exception ($t->error);
2200 $source_schema = $t->schema;
2202 $source_schema->name( $prefilename )
2203 unless ( $source_schema->name );
2206 # The "new" style of producers have sane normalization and can support
2207 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2208 # And we have to diff parsed SQL against parsed SQL.
2209 my $dest_schema = $sqlt_schema;
2211 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2212 my $t = SQL::Translator->new($sqltargs);
2217 or $self->throw_exception ($t->error);
2219 my $out = $t->translate( $filename )
2220 or $self->throw_exception ($t->error);
2222 $dest_schema = $t->schema;
2224 $dest_schema->name( $filename )
2225 unless $dest_schema->name;
2228 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2232 if(!open $file, ">$difffile") {
2233 $self->throw_exception("Can't write to $difffile ($!)");
2241 =head2 deployment_statements
2245 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2249 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2251 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2252 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2254 C<$directory> is used to return statements from files in a previously created
2255 L</create_ddl_dir> directory and is optional. The filenames are constructed
2256 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2258 If no C<$directory> is specified then the statements are constructed on the
2259 fly using L<SQL::Translator> and C<$version> is ignored.
2261 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2265 sub deployment_statements {
2266 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2267 # Need to be connected to get the correct sqlt_type
2268 $self->last_dbh() unless $type;
2269 $type ||= $self->sqlt_type;
2270 $version ||= $schema->schema_version || '1.x';
2272 my $filename = $schema->ddl_filename($type, $version, $dir);
2276 open($file, "<$filename")
2277 or $self->throw_exception("Can't open $filename ($!)");
2280 return join('', @rows);
2283 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2284 . $self->_check_sqlt_message . q{'})
2285 if !$self->_check_sqlt_version;
2287 require SQL::Translator::Parser::DBIx::Class;
2288 eval qq{use SQL::Translator::Producer::${type}};
2289 $self->throw_exception($@) if $@;
2291 # sources needs to be a parser arg, but for simplicty allow at top level
2293 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2294 if exists $sqltargs->{sources};
2296 my $tr = SQL::Translator->new(%$sqltargs);
2297 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2298 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2302 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2305 return if($line =~ /^--/);
2307 # next if($line =~ /^DROP/m);
2308 return if($line =~ /^BEGIN TRANSACTION/m);
2309 return if($line =~ /^COMMIT/m);
2310 return if $line =~ /^\s+$/; # skip whitespace only
2311 $self->_query_start($line);
2313 # a previous error may invalidate $dbh - thus we need to use dbh()
2314 # to guarantee a healthy $dbh (this is temporary until we get
2315 # proper error handling on deploy() )
2316 $self->dbh->do($line);
2319 carp qq{$@ (running "${line}")};
2321 $self->_query_end($line);
2323 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2324 if (@statements > 1) {
2325 foreach my $statement (@statements) {
2326 $deploy->( $statement );
2329 elsif (@statements == 1) {
2330 foreach my $line ( split(";\n", $statements[0])) {
2336 =head2 datetime_parser
2338 Returns the datetime parser class
2342 sub datetime_parser {
2344 return $self->{datetime_parser} ||= do {
2346 $self->build_datetime_parser(@_);
2350 =head2 datetime_parser_type
2352 Defines (returns) the datetime parser class - currently hardwired to
2353 L<DateTime::Format::MySQL>
2357 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2359 =head2 build_datetime_parser
2361 See L</datetime_parser>
2365 sub build_datetime_parser {
2367 my $type = $self->datetime_parser_type(@_);
2369 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2374 my $_check_sqlt_version; # private
2375 my $_check_sqlt_message; # private
2376 sub _check_sqlt_version {
2377 return $_check_sqlt_version if defined $_check_sqlt_version;
2378 eval 'use SQL::Translator "0.09003"';
2379 $_check_sqlt_message = $@ || '';
2380 $_check_sqlt_version = !$@;
2383 sub _check_sqlt_message {
2384 _check_sqlt_version if !defined $_check_sqlt_message;
2385 $_check_sqlt_message;
2389 =head2 is_replicating
2391 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2392 replicate from a master database. Default is undef, which is the result
2393 returned by databases that don't support replication.
2397 sub is_replicating {
2402 =head2 lag_behind_master
2404 Returns a number that represents a certain amount of lag behind a master db
2405 when a given storage is replicating. The number is database dependent, but
2406 starts at zero and increases with the amount of lag. Default in undef
2410 sub lag_behind_master {
2416 return if !$self->_dbh;
2425 =head2 DBIx::Class and AutoCommit
2427 DBIx::Class can do some wonderful magic with handling exceptions,
2428 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2429 combined with C<txn_do> for transaction support.
2431 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2432 in an assumed transaction between commits, and you're telling us you'd
2433 like to manage that manually. A lot of the magic protections offered by
2434 this module will go away. We can't protect you from exceptions due to database
2435 disconnects because we don't know anything about how to restart your
2436 transactions. You're on your own for handling all sorts of exceptional
2437 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2444 Matt S. Trout <mst@shadowcatsystems.co.uk>
2446 Andy Grundman <andy@hybridized.org>
2450 You may distribute this code under the same terms as Perl itself.