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 {
464 This method is deprecated in favour of setting via L</connect_info>.
468 =head2 on_disconnect_do
470 This method is deprecated in favour of setting via L</connect_info>.
474 sub _parse_connect_do {
475 my ($self, $type) = @_;
477 my $val = $self->$type;
478 return () if not defined $val;
483 push @res, [ 'do_sql', $val ];
484 } elsif (ref($val) eq 'CODE') {
486 } elsif (ref($val) eq 'ARRAY') {
487 push @res, map { [ 'do_sql', $_ ] } @$val;
489 $self->throw_exception("Invalid type for $type: ".ref($val));
497 Arguments: ($subref | $method_name), @extra_coderef_args?
499 Execute the given $subref or $method_name using the new exception-based
500 connection management.
502 The first two arguments will be the storage object that C<dbh_do> was called
503 on and a database handle to use. Any additional arguments will be passed
504 verbatim to the called subref as arguments 2 and onwards.
506 Using this (instead of $self->_dbh or $self->dbh) ensures correct
507 exception handling and reconnection (or failover in future subclasses).
509 Your subref should have no side-effects outside of the database, as
510 there is the potential for your subref to be partially double-executed
511 if the database connection was stale/dysfunctional.
515 my @stuff = $schema->storage->dbh_do(
517 my ($storage, $dbh, @cols) = @_;
518 my $cols = join(q{, }, @cols);
519 $dbh->selectrow_array("SELECT $cols FROM foo");
530 my $dbh = $self->_dbh;
532 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
533 || $self->{transaction_depth};
535 local $self->{_in_dbh_do} = 1;
538 my $want_array = wantarray;
541 $self->_verify_pid if $dbh;
543 $self->_populate_dbh;
548 @result = $self->$code($dbh, @_);
550 elsif(defined $want_array) {
551 $result[0] = $self->$code($dbh, @_);
554 $self->$code($dbh, @_);
558 # ->connected might unset $@ - copy
560 if(!$exception) { return $want_array ? @result : $result[0] }
562 $self->throw_exception($exception) if $self->connected;
564 # We were not connected - reconnect and retry, but let any
565 # exception fall right through this time
566 $self->_populate_dbh;
567 $self->$code($self->_dbh, @_);
570 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
571 # It also informs dbh_do to bypass itself while under the direction of txn_do,
572 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
577 ref $coderef eq 'CODE' or $self->throw_exception
578 ('$coderef must be a CODE reference');
580 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
582 local $self->{_in_dbh_do} = 1;
585 my $want_array = wantarray;
590 $self->_verify_pid if $self->_dbh;
591 $self->_populate_dbh if !$self->_dbh;
595 @result = $coderef->(@_);
597 elsif(defined $want_array) {
598 $result[0] = $coderef->(@_);
606 # ->connected might unset $@ - copy
608 if(!$exception) { return $want_array ? @result : $result[0] }
610 if($tried++ || $self->connected) {
611 eval { $self->txn_rollback };
612 my $rollback_exception = $@;
613 if($rollback_exception) {
614 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
615 $self->throw_exception($exception) # propagate nested rollback
616 if $rollback_exception =~ /$exception_class/;
618 $self->throw_exception(
619 "Transaction aborted: ${exception}. "
620 . "Rollback failed: ${rollback_exception}"
623 $self->throw_exception($exception)
626 # We were not connected, and was first try - reconnect and retry
628 $self->_populate_dbh;
634 Our C<disconnect> method also performs a rollback first if the
635 database is not in C<AutoCommit> mode.
645 push @actions, ( $self->on_disconnect_call || () );
646 push @actions, $self->_parse_connect_do ('on_disconnect_do');
648 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
650 $self->_dbh->rollback unless $self->_dbh_autocommit;
651 $self->_dbh->disconnect;
657 =head2 with_deferred_fk_checks
661 =item Arguments: C<$coderef>
663 =item Return Value: The return value of $coderef
667 Storage specific method to run the code ref with FK checks deferred or
668 in MySQL's case disabled entirely.
672 # Storage subclasses should override this
673 sub with_deferred_fk_checks {
674 my ($self, $sub) = @_;
683 =item Arguments: none
685 =item Return Value: 1|0
689 Verifies that the the current database handle is active and ready to execute
690 an SQL statement (i.e. the connection did not get stale, server is still
691 answering, etc.) This method is used internally by L</dbh>.
697 return 0 unless $self->_seems_connected;
700 local $self->_dbh->{RaiseError} = 1;
705 sub _seems_connected {
708 my $dbh = $self->_dbh
711 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
718 return 0 if !$self->_dbh;
721 return $dbh->FETCH('Active');
727 my $dbh = $self->_dbh or return 0;
732 # handle pid changes correctly
733 # NOTE: assumes $self->_dbh is a valid $dbh
737 return if defined $self->_conn_pid && $self->_conn_pid == $$;
739 $self->_dbh->{InactiveDestroy} = 1;
746 sub ensure_connected {
749 unless ($self->connected) {
750 $self->_populate_dbh;
756 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
757 is guaranteed to be healthy by implicitly calling L</connected>, and if
758 necessary performing a reconnection before returning. Keep in mind that this
759 is very B<expensive> on some database engines. Consider using L<dbh_do>
767 if (not $self->_dbh) {
768 $self->_populate_dbh;
770 $self->ensure_connected;
775 # this is the internal "get dbh or connect (don't check)" method
778 $self->_populate_dbh unless $self->_dbh;
782 sub _sql_maker_args {
787 array_datatypes => 1,
788 limit_dialect => $self->_get_dbh,
789 %{$self->_sql_maker_opts}
795 unless ($self->_sql_maker) {
796 my $sql_maker_class = $self->sql_maker_class;
797 $self->ensure_class_loaded ($sql_maker_class);
798 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
800 return $self->_sql_maker;
808 my @info = @{$self->_dbi_connect_info || []};
809 $self->_dbh(undef); # in case ->connected failed we might get sent here
810 $self->_dbh($self->_connect(@info));
812 $self->_conn_pid($$);
813 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
815 $self->_determine_driver;
817 # Always set the transaction depth on connect, since
818 # there is no transaction in progress by definition
819 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
821 $self->_run_connection_actions unless $self->{_in_determine_driver};
824 sub _run_connection_actions {
828 push @actions, ( $self->on_connect_call || () );
829 push @actions, $self->_parse_connect_do ('on_connect_do');
831 $self->_do_connection_actions(connect_call_ => $_) for @actions;
834 sub _determine_driver {
837 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
838 my $started_unconnected = 0;
839 local $self->{_in_determine_driver} = 1;
841 if (ref($self) eq __PACKAGE__) {
843 if ($self->_dbh) { # we are connected
844 $driver = $self->_dbh->{Driver}{Name};
846 # try to use dsn to not require being connected, the driver may still
847 # force a connection in _rebless to determine version
848 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
849 $started_unconnected = 1;
852 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
853 if ($self->load_optional_class($storage_class)) {
854 mro::set_mro($storage_class, 'c3');
855 bless $self, $storage_class;
860 $self->_driver_determined(1);
862 $self->_run_connection_actions
863 if $started_unconnected && defined $self->_dbh;
867 sub _do_connection_actions {
869 my $method_prefix = shift;
872 if (not ref($call)) {
873 my $method = $method_prefix . $call;
875 } elsif (ref($call) eq 'CODE') {
877 } elsif (ref($call) eq 'ARRAY') {
878 if (ref($call->[0]) ne 'ARRAY') {
879 $self->_do_connection_actions($method_prefix, $_) for @$call;
881 $self->_do_connection_actions($method_prefix, @$_) for @$call;
884 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
890 sub connect_call_do_sql {
892 $self->_do_query(@_);
895 sub disconnect_call_do_sql {
897 $self->_do_query(@_);
900 # override in db-specific backend when necessary
901 sub connect_call_datetime_setup { 1 }
904 my ($self, $action) = @_;
906 if (ref $action eq 'CODE') {
907 $action = $action->($self);
908 $self->_do_query($_) foreach @$action;
911 # Most debuggers expect ($sql, @bind), so we need to exclude
912 # the attribute hash which is the second argument to $dbh->do
913 # furthermore the bind values are usually to be presented
914 # as named arrayref pairs, so wrap those here too
915 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
916 my $sql = shift @do_args;
917 my $attrs = shift @do_args;
918 my @bind = map { [ undef, $_ ] } @do_args;
920 $self->_query_start($sql, @bind);
921 $self->_dbh->do($sql, $attrs, @do_args);
922 $self->_query_end($sql, @bind);
929 my ($self, @info) = @_;
931 $self->throw_exception("You failed to provide any connection info")
934 my ($old_connect_via, $dbh);
936 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
937 $old_connect_via = $DBI::connect_via;
938 $DBI::connect_via = 'connect';
942 if(ref $info[0] eq 'CODE') {
946 $dbh = DBI->connect(@info);
949 if($dbh && !$self->unsafe) {
950 my $weak_self = $self;
951 Scalar::Util::weaken($weak_self);
952 $dbh->{HandleError} = sub {
954 $weak_self->throw_exception("DBI Exception: $_[0]");
957 croak ("DBI Exception: $_[0]");
960 $dbh->{ShowErrorStatement} = 1;
961 $dbh->{RaiseError} = 1;
962 $dbh->{PrintError} = 0;
966 $DBI::connect_via = $old_connect_via if $old_connect_via;
968 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
971 $self->_dbh_autocommit($dbh->{AutoCommit});
977 my ($self, $name) = @_;
979 $name = $self->_svp_generate_name
980 unless defined $name;
982 $self->throw_exception ("You can't use savepoints outside a transaction")
983 if $self->{transaction_depth} == 0;
985 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
986 unless $self->can('_svp_begin');
988 push @{ $self->{savepoints} }, $name;
990 $self->debugobj->svp_begin($name) if $self->debug;
992 return $self->_svp_begin($name);
996 my ($self, $name) = @_;
998 $self->throw_exception ("You can't use savepoints outside a transaction")
999 if $self->{transaction_depth} == 0;
1001 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1002 unless $self->can('_svp_release');
1004 if (defined $name) {
1005 $self->throw_exception ("Savepoint '$name' does not exist")
1006 unless grep { $_ eq $name } @{ $self->{savepoints} };
1008 # Dig through the stack until we find the one we are releasing. This keeps
1009 # the stack up to date.
1012 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1014 $name = pop @{ $self->{savepoints} };
1017 $self->debugobj->svp_release($name) if $self->debug;
1019 return $self->_svp_release($name);
1023 my ($self, $name) = @_;
1025 $self->throw_exception ("You can't use savepoints outside a transaction")
1026 if $self->{transaction_depth} == 0;
1028 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1029 unless $self->can('_svp_rollback');
1031 if (defined $name) {
1032 # If they passed us a name, verify that it exists in the stack
1033 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1034 $self->throw_exception("Savepoint '$name' does not exist!");
1037 # Dig through the stack until we find the one we are releasing. This keeps
1038 # the stack up to date.
1039 while(my $s = pop(@{ $self->{savepoints} })) {
1040 last if($s eq $name);
1042 # Add the savepoint back to the stack, as a rollback doesn't remove the
1043 # named savepoint, only everything after it.
1044 push(@{ $self->{savepoints} }, $name);
1046 # We'll assume they want to rollback to the last savepoint
1047 $name = $self->{savepoints}->[-1];
1050 $self->debugobj->svp_rollback($name) if $self->debug;
1052 return $self->_svp_rollback($name);
1055 sub _svp_generate_name {
1058 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1063 if($self->{transaction_depth} == 0) {
1064 $self->debugobj->txn_begin()
1067 # being here implies we have AutoCommit => 1
1068 # if the user is utilizing txn_do - good for
1069 # him, otherwise we need to ensure that the
1070 # $dbh is healthy on BEGIN
1071 my $dbh_method = $self->{_in_dbh_do} ? '_dbh' : 'dbh';
1072 $self->$dbh_method->begin_work;
1074 } elsif ($self->auto_savepoint) {
1077 $self->{transaction_depth}++;
1082 if ($self->{transaction_depth} == 1) {
1083 my $dbh = $self->_dbh;
1084 $self->debugobj->txn_commit()
1087 $self->{transaction_depth} = 0
1088 if $self->_dbh_autocommit;
1090 elsif($self->{transaction_depth} > 1) {
1091 $self->{transaction_depth}--;
1093 if $self->auto_savepoint;
1099 my $dbh = $self->_dbh;
1101 if ($self->{transaction_depth} == 1) {
1102 $self->debugobj->txn_rollback()
1104 $self->{transaction_depth} = 0
1105 if $self->_dbh_autocommit;
1108 elsif($self->{transaction_depth} > 1) {
1109 $self->{transaction_depth}--;
1110 if ($self->auto_savepoint) {
1111 $self->svp_rollback;
1116 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1121 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1122 $error =~ /$exception_class/ and $self->throw_exception($error);
1123 # ensure that a failed rollback resets the transaction depth
1124 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1125 $self->throw_exception($error);
1129 # This used to be the top-half of _execute. It was split out to make it
1130 # easier to override in NoBindVars without duping the rest. It takes up
1131 # all of _execute's args, and emits $sql, @bind.
1132 sub _prep_for_execute {
1133 my ($self, $op, $extra_bind, $ident, $args) = @_;
1135 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1136 $ident = $ident->from();
1139 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1142 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1144 return ($sql, \@bind);
1148 sub _fix_bind_params {
1149 my ($self, @bind) = @_;
1151 ### Turn @bind from something like this:
1152 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1154 ### ( "'1'", "'1'", "'3'" )
1157 if ( defined( $_ && $_->[1] ) ) {
1158 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1165 my ( $self, $sql, @bind ) = @_;
1167 if ( $self->debug ) {
1168 @bind = $self->_fix_bind_params(@bind);
1170 $self->debugobj->query_start( $sql, @bind );
1175 my ( $self, $sql, @bind ) = @_;
1177 if ( $self->debug ) {
1178 @bind = $self->_fix_bind_params(@bind);
1179 $self->debugobj->query_end( $sql, @bind );
1184 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1186 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1188 $self->_query_start( $sql, @$bind );
1190 my $sth = $self->sth($sql,$op);
1192 my $placeholder_index = 1;
1194 foreach my $bound (@$bind) {
1195 my $attributes = {};
1196 my($column_name, @data) = @$bound;
1198 if ($bind_attributes) {
1199 $attributes = $bind_attributes->{$column_name}
1200 if defined $bind_attributes->{$column_name};
1203 foreach my $data (@data) {
1204 my $ref = ref $data;
1205 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1207 $sth->bind_param($placeholder_index, $data, $attributes);
1208 $placeholder_index++;
1212 # Can this fail without throwing an exception anyways???
1213 my $rv = $sth->execute();
1214 $self->throw_exception($sth->errstr) if !$rv;
1216 $self->_query_end( $sql, @$bind );
1218 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1223 $self->dbh_do('_dbh_execute', @_)
1227 my ($self, $source, $to_insert) = @_;
1229 # redispatch to insert method of storage we reblessed into, if necessary
1230 if (not $self->_driver_determined) {
1231 $self->_determine_driver;
1232 goto $self->can('insert');
1235 my $ident = $source->from;
1236 my $bind_attributes = $self->source_bind_attributes($source);
1238 my $updated_cols = {};
1240 foreach my $col ( $source->columns ) {
1241 if ( !defined $to_insert->{$col} ) {
1242 my $col_info = $source->column_info($col);
1244 if ( $col_info->{auto_nextval} ) {
1245 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1247 $col_info->{sequence} ||
1248 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1254 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1256 return $updated_cols;
1259 ## Still not quite perfect, and EXPERIMENTAL
1260 ## Currently it is assumed that all values passed will be "normal", i.e. not
1261 ## scalar refs, or at least, all the same type as the first set, the statement is
1262 ## only prepped once.
1264 my ($self, $source, $cols, $data) = @_;
1266 my $table = $source->from;
1267 @colvalues{@$cols} = (0..$#$cols);
1268 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1270 $self->_determine_driver;
1272 $self->_query_start( $sql, @bind );
1273 my $sth = $self->sth($sql);
1275 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1277 ## This must be an arrayref, else nothing works!
1278 my $tuple_status = [];
1280 ## Get the bind_attributes, if any exist
1281 my $bind_attributes = $self->source_bind_attributes($source);
1283 ## Bind the values and execute
1284 my $placeholder_index = 1;
1286 foreach my $bound (@bind) {
1288 my $attributes = {};
1289 my ($column_name, $data_index) = @$bound;
1291 if( $bind_attributes ) {
1292 $attributes = $bind_attributes->{$column_name}
1293 if defined $bind_attributes->{$column_name};
1296 my @data = map { $_->[$data_index] } @$data;
1298 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1299 $placeholder_index++;
1301 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1304 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1306 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1307 if ($i > $#$tuple_status);
1309 require Data::Dumper;
1310 local $Data::Dumper::Terse = 1;
1311 local $Data::Dumper::Indent = 1;
1312 local $Data::Dumper::Useqq = 1;
1313 local $Data::Dumper::Quotekeys = 0;
1315 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1316 $tuple_status->[$i][1],
1317 Data::Dumper::Dumper(
1318 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1322 $self->throw_exception($sth->errstr) if !$rv;
1324 $self->_query_end( $sql, @bind );
1325 return (wantarray ? ($rv, $sth, @bind) : $rv);
1329 my $self = shift @_;
1330 my $source = shift @_;
1331 $self->_determine_driver;
1332 my $bind_attributes = $self->source_bind_attributes($source);
1334 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1339 my $self = shift @_;
1340 my $source = shift @_;
1341 $self->_determine_driver;
1342 my $bind_attrs = $self->source_bind_attributes($source);
1344 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1347 # We were sent here because the $rs contains a complex search
1348 # which will require a subquery to select the correct rows
1349 # (i.e. joined or limited resultsets)
1351 # Genarating a single PK column subquery is trivial and supported
1352 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1353 # Look at _multipk_update_delete()
1354 sub _subq_update_delete {
1356 my ($rs, $op, $values) = @_;
1358 my $rsrc = $rs->result_source;
1360 # we already check this, but double check naively just in case. Should be removed soon
1361 my $sel = $rs->_resolved_attrs->{select};
1362 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1363 my @pcols = $rsrc->primary_columns;
1364 if (@$sel != @pcols) {
1365 $self->throw_exception (
1366 'Subquery update/delete can not be called on resultsets selecting a'
1367 .' number of columns different than the number of primary keys'
1374 $op eq 'update' ? $values : (),
1375 { $pcols[0] => { -in => $rs->as_query } },
1380 return $self->_multipk_update_delete (@_);
1384 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1385 # resultset update/delete involving subqueries. So by default resort
1386 # to simple (and inefficient) delete_all style per-row opearations,
1387 # while allowing specific storages to override this with a faster
1390 sub _multipk_update_delete {
1391 return shift->_per_row_update_delete (@_);
1394 # This is the default loop used to delete/update rows for multi PK
1395 # resultsets, and used by mysql exclusively (because it can't do anything
1398 # We do not use $row->$op style queries, because resultset update/delete
1399 # is not expected to cascade (this is what delete_all/update_all is for).
1401 # There should be no race conditions as the entire operation is rolled
1404 sub _per_row_update_delete {
1406 my ($rs, $op, $values) = @_;
1408 my $rsrc = $rs->result_source;
1409 my @pcols = $rsrc->primary_columns;
1411 my $guard = $self->txn_scope_guard;
1413 # emulate the return value of $sth->execute for non-selects
1414 my $row_cnt = '0E0';
1416 my $subrs_cur = $rs->cursor;
1417 while (my @pks = $subrs_cur->next) {
1420 for my $i (0.. $#pcols) {
1421 $cond->{$pcols[$i]} = $pks[$i];
1426 $op eq 'update' ? $values : (),
1441 # localization is neccessary as
1442 # 1) there is no infrastructure to pass this around before SQLA2
1443 # 2) _select_args sets it and _prep_for_execute consumes it
1444 my $sql_maker = $self->sql_maker;
1445 local $sql_maker->{_dbic_rs_attrs};
1447 return $self->_execute($self->_select_args(@_));
1450 sub _select_args_to_query {
1453 # localization is neccessary as
1454 # 1) there is no infrastructure to pass this around before SQLA2
1455 # 2) _select_args sets it and _prep_for_execute consumes it
1456 my $sql_maker = $self->sql_maker;
1457 local $sql_maker->{_dbic_rs_attrs};
1459 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1460 # = $self->_select_args($ident, $select, $cond, $attrs);
1461 my ($op, $bind, $ident, $bind_attrs, @args) =
1462 $self->_select_args(@_);
1464 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1465 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1466 $prepared_bind ||= [];
1469 ? ($sql, $prepared_bind, $bind_attrs)
1470 : \[ "($sql)", @$prepared_bind ]
1475 my ($self, $ident, $select, $where, $attrs) = @_;
1477 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1479 my $sql_maker = $self->sql_maker;
1480 $sql_maker->{_dbic_rs_attrs} = {
1486 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1491 # calculate bind_attrs before possible $ident mangling
1492 my $bind_attrs = {};
1493 for my $alias (keys %$alias2source) {
1494 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1495 for my $col (keys %$bindtypes) {
1497 my $fqcn = join ('.', $alias, $col);
1498 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1500 # Unqialified column names are nice, but at the same time can be
1501 # rather ambiguous. What we do here is basically go along with
1502 # the loop, adding an unqualified column slot to $bind_attrs,
1503 # alongside the fully qualified name. As soon as we encounter
1504 # another column by that name (which would imply another table)
1505 # we unset the unqualified slot and never add any info to it
1506 # to avoid erroneous type binding. If this happens the users
1507 # only choice will be to fully qualify his column name
1509 if (exists $bind_attrs->{$col}) {
1510 $bind_attrs->{$col} = {};
1513 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1520 $attrs->{software_limit}
1522 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1524 $attrs->{software_limit} = 1;
1527 $self->throw_exception("rows attribute must be positive if present")
1528 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1530 # MySQL actually recommends this approach. I cringe.
1531 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1536 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1537 # otherwise delegate the limiting to the storage, unless software limit was requested
1539 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1541 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1542 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1544 ($ident, $select, $where, $attrs)
1545 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1547 elsif (! $attrs->{software_limit} ) {
1548 push @limit, $attrs->{rows}, $attrs->{offset};
1552 # This would be the point to deflate anything found in $where
1553 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1554 # expect a row object. And all we have is a resultsource (it is trivial
1555 # to extract deflator coderefs via $alias2source above).
1557 # I don't see a way forward other than changing the way deflators are
1558 # invoked, and that's just bad...
1562 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1563 (qw/order_by group_by having/ )
1566 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1570 # This is the code producing joined subqueries like:
1571 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1573 sub _adjust_select_args_for_complex_prefetch {
1574 my ($self, $from, $select, $where, $attrs) = @_;
1576 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1577 if (ref $from ne 'ARRAY');
1579 # copies for mangling
1581 $select = [ @$select ];
1582 $attrs = { %$attrs };
1584 # separate attributes
1585 my $sub_attrs = { %$attrs };
1586 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1587 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1589 my $select_root_alias = $attrs->{alias};
1590 my $sql_maker = $self->sql_maker;
1592 # create subquery select list - consider only stuff *not* brought in by the prefetch
1593 my $sub_select = [];
1595 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1596 my $sel = $attrs->{select}[$i];
1598 # alias any functions to the dbic-side 'as' label
1599 # adjust the outer select accordingly
1600 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1601 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1602 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1605 push @$sub_select, $sel;
1608 # bring over all non-collapse-induced order_by into the inner query (if any)
1609 # the outer one will have to keep them all
1610 delete $sub_attrs->{order_by};
1611 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1612 $sub_attrs->{order_by} = [
1613 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1617 # mangle {from}, keep in mind that $from is "headless" from here on
1618 my $join_root = shift @$from;
1621 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1623 # in complex search_related chains $select_root_alias may *not* be
1624 # 'me' so always include it in the inner join
1625 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1628 # decide which parts of the join will remain on the inside
1630 # this is not a very viable optimisation, but it was written
1631 # before I realised this, so might as well remain. We can throw
1632 # away _any_ branches of the join tree that are:
1633 # 1) not mentioned in the condition/order
1634 # 2) left-join leaves (or left-join leaf chains)
1635 # Most of the join conditions will not satisfy this, but for real
1636 # complex queries some might, and we might make some RDBMS happy.
1639 # since we do not have introspectable SQLA, we fall back to ugly
1640 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1641 # in order to determine what goes into %inner_joins
1642 # It may not be very efficient, but it's a reasonable stop-gap
1644 # produce stuff unquoted, so it can be scanned
1645 local $sql_maker->{quote_char};
1646 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1650 { ref $_ ? $_->[0] : $_ }
1651 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1654 my $where_sql = $sql_maker->where ($where);
1655 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1658 for my $alias (keys %join_info) {
1660 # any table alias found on a column name in where or order_by
1661 # gets included in %inner_joins
1662 # Also any parent joins that are needed to reach this particular alias
1663 for my $piece ($select_sql, $where_sql, @order_by ) {
1664 if ($piece =~ /\b $alias $sep/x) {
1665 $inner_joins{$alias} = 1;
1671 # scan for non-leaf/non-left joins and mark as needed
1672 # also mark all ancestor joins that are needed to reach this particular alias
1673 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1675 # traverse by the size of the -join_path i.e. reverse depth first
1676 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1678 my $j = $join_info{$alias};
1679 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1681 if ($inner_joins{$alias}) {
1682 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1686 # construct the inner $from for the subquery
1687 my $inner_from = [ $join_root ];
1688 for my $j (@$from) {
1689 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1692 # if a multi-type join was needed in the subquery ("multi" is indicated by
1693 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1694 unless ($sub_attrs->{group_by}) {
1695 for my $alias (keys %inner_joins) {
1697 # the dot comes from some weirdness in collapse
1698 # remove after the rewrite
1699 if ($attrs->{collapse}{".$alias"}) {
1700 $sub_attrs->{group_by} ||= $sub_select;
1706 # generate the subquery
1707 my $subq = $self->_select_args_to_query (
1713 my $subq_joinspec = {
1714 -alias => $select_root_alias,
1715 -source_handle => $join_root->{-source_handle},
1716 $select_root_alias => $subq,
1719 # Generate a new from (really just replace the join slot with the subquery)
1720 # Before we would start the outer chain from the subquery itself (i.e.
1721 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1722 # a bad idea for search_related, as the root of the chain was effectively
1723 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1724 # of 'cds', which would prevent from doing things like order_by artist.*)
1725 # See t/prefetch/via_search_related.t for a better idea
1727 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1733 else { # this is trickier
1734 @outer_from = ($join_root);
1736 for my $j (@$from) {
1737 if ($j->[0]{-alias} eq $select_root_alias) {
1744 push @outer_from, $j;
1749 # This is totally horrific - the $where ends up in both the inner and outer query
1750 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1751 # then if where conditions apply to the *right* side of the prefetch, you may have
1752 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1753 # the outer select to exclude joins you didin't want in the first place
1755 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1756 return (\@outer_from, $select, $where, $attrs);
1759 sub _resolve_ident_sources {
1760 my ($self, $ident) = @_;
1762 my $alias2source = {};
1765 # the reason this is so contrived is that $ident may be a {from}
1766 # structure, specifying multiple tables to join
1767 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1768 # this is compat mode for insert/update/delete which do not deal with aliases
1769 $alias2source->{me} = $ident;
1772 elsif (ref $ident eq 'ARRAY') {
1776 if (ref $_ eq 'HASH') {
1778 $rs_alias = $tabinfo->{-alias};
1780 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1784 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1785 if ($tabinfo->{-source_handle});
1789 return ($alias2source, $rs_alias);
1792 # Takes $ident, \@column_names
1794 # returns { $column_name => \%column_info, ... }
1795 # also note: this adds -result_source => $rsrc to the column info
1798 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1799 sub _resolve_column_info {
1800 my ($self, $ident, $colnames) = @_;
1801 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1803 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1806 my (%return, %seen_cols);
1808 # compile a global list of column names, to be able to properly
1809 # disambiguate unqualified column names (if at all possible)
1810 for my $alias (keys %$alias2src) {
1811 my $rsrc = $alias2src->{$alias};
1812 for my $colname ($rsrc->columns) {
1813 push @{$seen_cols{$colname}}, $alias;
1818 foreach my $col (@$colnames) {
1819 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1822 # see if the column was seen exactly once (so we know which rsrc it came from)
1823 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1824 $alias = $seen_cols{$colname}[0];
1831 my $rsrc = $alias2src->{$alias};
1832 $return{$col} = $rsrc && {
1833 %{$rsrc->column_info($colname)},
1834 -result_source => $rsrc,
1835 -source_alias => $alias,
1842 # Returns a counting SELECT for a simple count
1843 # query. Abstracted so that a storage could override
1844 # this to { count => 'firstcol' } or whatever makes
1845 # sense as a performance optimization
1847 #my ($self, $source, $rs_attrs) = @_;
1848 return { count => '*' };
1851 # Returns a SELECT which will end up in the subselect
1852 # There may or may not be a group_by, as the subquery
1853 # might have been called to accomodate a limit
1855 # Most databases would be happy with whatever ends up
1856 # here, but some choke in various ways.
1858 sub _subq_count_select {
1859 my ($self, $source, $rs_attrs) = @_;
1860 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1862 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1863 return @pcols ? \@pcols : [ 1 ];
1867 sub source_bind_attributes {
1868 my ($self, $source) = @_;
1870 my $bind_attributes;
1871 foreach my $column ($source->columns) {
1873 my $data_type = $source->column_info($column)->{data_type} || '';
1874 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1878 return $bind_attributes;
1885 =item Arguments: $ident, $select, $condition, $attrs
1889 Handle a SQL select statement.
1895 my ($ident, $select, $condition, $attrs) = @_;
1896 return $self->cursor_class->new($self, \@_, $attrs);
1901 my ($rv, $sth, @bind) = $self->_select(@_);
1902 my @row = $sth->fetchrow_array;
1903 my @nextrow = $sth->fetchrow_array if @row;
1904 if(@row && @nextrow) {
1905 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1907 # Need to call finish() to work round broken DBDs
1916 =item Arguments: $sql
1920 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1925 my ($self, $dbh, $sql) = @_;
1927 # 3 is the if_active parameter which avoids active sth re-use
1928 my $sth = $self->disable_sth_caching
1929 ? $dbh->prepare($sql)
1930 : $dbh->prepare_cached($sql, {}, 3);
1932 # XXX You would think RaiseError would make this impossible,
1933 # but apparently that's not true :(
1934 $self->throw_exception($dbh->errstr) if !$sth;
1940 my ($self, $sql) = @_;
1941 $self->dbh_do('_dbh_sth', $sql);
1944 sub _dbh_columns_info_for {
1945 my ($self, $dbh, $table) = @_;
1947 if ($dbh->can('column_info')) {
1950 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1951 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1953 while ( my $info = $sth->fetchrow_hashref() ){
1955 $column_info{data_type} = $info->{TYPE_NAME};
1956 $column_info{size} = $info->{COLUMN_SIZE};
1957 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1958 $column_info{default_value} = $info->{COLUMN_DEF};
1959 my $col_name = $info->{COLUMN_NAME};
1960 $col_name =~ s/^\"(.*)\"$/$1/;
1962 $result{$col_name} = \%column_info;
1965 return \%result if !$@ && scalar keys %result;
1969 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1971 my @columns = @{$sth->{NAME_lc}};
1972 for my $i ( 0 .. $#columns ){
1974 $column_info{data_type} = $sth->{TYPE}->[$i];
1975 $column_info{size} = $sth->{PRECISION}->[$i];
1976 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1978 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1979 $column_info{data_type} = $1;
1980 $column_info{size} = $2;
1983 $result{$columns[$i]} = \%column_info;
1987 foreach my $col (keys %result) {
1988 my $colinfo = $result{$col};
1989 my $type_num = $colinfo->{data_type};
1991 if(defined $type_num && $dbh->can('type_info')) {
1992 my $type_info = $dbh->type_info($type_num);
1993 $type_name = $type_info->{TYPE_NAME} if $type_info;
1994 $colinfo->{data_type} = $type_name if $type_name;
2001 sub columns_info_for {
2002 my ($self, $table) = @_;
2003 $self->dbh_do('_dbh_columns_info_for', $table);
2006 =head2 last_insert_id
2008 Return the row id of the last insert.
2012 sub _dbh_last_insert_id {
2013 # All Storage's need to register their own _dbh_last_insert_id
2014 # the old SQLite-based method was highly inappropriate
2017 my $class = ref $self;
2018 $self->throw_exception (<<EOE);
2020 No _dbh_last_insert_id() method found in $class.
2021 Since the method of obtaining the autoincrement id of the last insert
2022 operation varies greatly between different databases, this method must be
2023 individually implemented for every storage class.
2027 sub last_insert_id {
2029 $self->dbh_do('_dbh_last_insert_id', @_);
2034 Returns the database driver name.
2038 sub sqlt_type { shift->_get_dbh->{Driver}->{Name} }
2040 =head2 bind_attribute_by_data_type
2042 Given a datatype from column info, returns a database specific bind
2043 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2044 let the database planner just handle it.
2046 Generally only needed for special case column types, like bytea in postgres.
2050 sub bind_attribute_by_data_type {
2054 =head2 is_datatype_numeric
2056 Given a datatype from column_info, returns a boolean value indicating if
2057 the current RDBMS considers it a numeric value. This controls how
2058 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2059 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2060 be performed instead of the usual C<eq>.
2064 sub is_datatype_numeric {
2065 my ($self, $dt) = @_;
2067 return 0 unless $dt;
2069 return $dt =~ /^ (?:
2070 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2075 =head2 create_ddl_dir (EXPERIMENTAL)
2079 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2083 Creates a SQL file based on the Schema, for each of the specified
2084 database engines in C<\@databases> in the given directory.
2085 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2087 Given a previous version number, this will also create a file containing
2088 the ALTER TABLE statements to transform the previous schema into the
2089 current one. Note that these statements may contain C<DROP TABLE> or
2090 C<DROP COLUMN> statements that can potentially destroy data.
2092 The file names are created using the C<ddl_filename> method below, please
2093 override this method in your schema if you would like a different file
2094 name format. For the ALTER file, the same format is used, replacing
2095 $version in the name with "$preversion-$version".
2097 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2098 The most common value for this would be C<< { add_drop_table => 1 } >>
2099 to have the SQL produced include a C<DROP TABLE> statement for each table
2100 created. For quoting purposes supply C<quote_table_names> and
2101 C<quote_field_names>.
2103 If no arguments are passed, then the following default values are assumed:
2107 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2109 =item version - $schema->schema_version
2111 =item directory - './'
2113 =item preversion - <none>
2117 By default, C<\%sqlt_args> will have
2119 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2121 merged with the hash passed in. To disable any of those features, pass in a
2122 hashref like the following
2124 { ignore_constraint_names => 0, # ... other options }
2127 Note that this feature is currently EXPERIMENTAL and may not work correctly
2128 across all databases, or fully handle complex relationships.
2130 WARNING: Please check all SQL files created, before applying them.
2134 sub create_ddl_dir {
2135 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2137 if(!$dir || !-d $dir) {
2138 carp "No directory given, using ./\n";
2141 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2142 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2144 my $schema_version = $schema->schema_version || '1.x';
2145 $version ||= $schema_version;
2148 add_drop_table => 1,
2149 ignore_constraint_names => 1,
2150 ignore_index_names => 1,
2154 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2155 . $self->_check_sqlt_message . q{'})
2156 if !$self->_check_sqlt_version;
2158 my $sqlt = SQL::Translator->new( $sqltargs );
2160 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2161 my $sqlt_schema = $sqlt->translate({ data => $schema })
2162 or $self->throw_exception ($sqlt->error);
2164 foreach my $db (@$databases) {
2166 $sqlt->{schema} = $sqlt_schema;
2167 $sqlt->producer($db);
2170 my $filename = $schema->ddl_filename($db, $version, $dir);
2171 if (-e $filename && ($version eq $schema_version )) {
2172 # if we are dumping the current version, overwrite the DDL
2173 carp "Overwriting existing DDL file - $filename";
2177 my $output = $sqlt->translate;
2179 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2182 if(!open($file, ">$filename")) {
2183 $self->throw_exception("Can't open $filename for writing ($!)");
2186 print $file $output;
2189 next unless ($preversion);
2191 require SQL::Translator::Diff;
2193 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2194 if(!-e $prefilename) {
2195 carp("No previous schema file found ($prefilename)");
2199 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2201 carp("Overwriting existing diff file - $difffile");
2207 my $t = SQL::Translator->new($sqltargs);
2212 or $self->throw_exception ($t->error);
2214 my $out = $t->translate( $prefilename )
2215 or $self->throw_exception ($t->error);
2217 $source_schema = $t->schema;
2219 $source_schema->name( $prefilename )
2220 unless ( $source_schema->name );
2223 # The "new" style of producers have sane normalization and can support
2224 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2225 # And we have to diff parsed SQL against parsed SQL.
2226 my $dest_schema = $sqlt_schema;
2228 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2229 my $t = SQL::Translator->new($sqltargs);
2234 or $self->throw_exception ($t->error);
2236 my $out = $t->translate( $filename )
2237 or $self->throw_exception ($t->error);
2239 $dest_schema = $t->schema;
2241 $dest_schema->name( $filename )
2242 unless $dest_schema->name;
2245 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2249 if(!open $file, ">$difffile") {
2250 $self->throw_exception("Can't write to $difffile ($!)");
2258 =head2 deployment_statements
2262 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2266 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2268 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2269 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2271 C<$directory> is used to return statements from files in a previously created
2272 L</create_ddl_dir> directory and is optional. The filenames are constructed
2273 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2275 If no C<$directory> is specified then the statements are constructed on the
2276 fly using L<SQL::Translator> and C<$version> is ignored.
2278 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2282 sub deployment_statements {
2283 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2284 $type ||= $self->sqlt_type;
2285 $version ||= $schema->schema_version || '1.x';
2287 my $filename = $schema->ddl_filename($type, $version, $dir);
2291 open($file, "<$filename")
2292 or $self->throw_exception("Can't open $filename ($!)");
2295 return join('', @rows);
2298 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2299 . $self->_check_sqlt_message . q{'})
2300 if !$self->_check_sqlt_version;
2302 require SQL::Translator::Parser::DBIx::Class;
2303 eval qq{use SQL::Translator::Producer::${type}};
2304 $self->throw_exception($@) if $@;
2306 # sources needs to be a parser arg, but for simplicty allow at top level
2308 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2309 if exists $sqltargs->{sources};
2311 my $tr = SQL::Translator->new(%$sqltargs);
2312 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2313 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2317 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2320 return if($line =~ /^--/);
2322 # next if($line =~ /^DROP/m);
2323 return if($line =~ /^BEGIN TRANSACTION/m);
2324 return if($line =~ /^COMMIT/m);
2325 return if $line =~ /^\s+$/; # skip whitespace only
2326 $self->_query_start($line);
2328 # do a dbh_do cycle here, as we need some error checking in
2329 # place (even though we will ignore errors)
2330 $self->dbh_do (sub { $_[1]->do($line) });
2333 carp qq{$@ (running "${line}")};
2335 $self->_query_end($line);
2337 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2338 if (@statements > 1) {
2339 foreach my $statement (@statements) {
2340 $deploy->( $statement );
2343 elsif (@statements == 1) {
2344 foreach my $line ( split(";\n", $statements[0])) {
2350 =head2 datetime_parser
2352 Returns the datetime parser class
2356 sub datetime_parser {
2358 return $self->{datetime_parser} ||= do {
2359 $self->_populate_dbh unless $self->_dbh;
2360 $self->build_datetime_parser(@_);
2364 =head2 datetime_parser_type
2366 Defines (returns) the datetime parser class - currently hardwired to
2367 L<DateTime::Format::MySQL>
2371 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2373 =head2 build_datetime_parser
2375 See L</datetime_parser>
2379 sub build_datetime_parser {
2381 my $type = $self->datetime_parser_type(@_);
2383 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2388 my $_check_sqlt_version; # private
2389 my $_check_sqlt_message; # private
2390 sub _check_sqlt_version {
2391 return $_check_sqlt_version if defined $_check_sqlt_version;
2392 eval 'use SQL::Translator "0.09003"';
2393 $_check_sqlt_message = $@ || '';
2394 $_check_sqlt_version = !$@;
2397 sub _check_sqlt_message {
2398 _check_sqlt_version if !defined $_check_sqlt_message;
2399 $_check_sqlt_message;
2403 =head2 is_replicating
2405 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2406 replicate from a master database. Default is undef, which is the result
2407 returned by databases that don't support replication.
2411 sub is_replicating {
2416 =head2 lag_behind_master
2418 Returns a number that represents a certain amount of lag behind a master db
2419 when a given storage is replicating. The number is database dependent, but
2420 starts at zero and increases with the amount of lag. Default in undef
2424 sub lag_behind_master {
2430 return if !$self->_dbh;
2439 =head2 DBIx::Class and AutoCommit
2441 DBIx::Class can do some wonderful magic with handling exceptions,
2442 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2443 (the default) combined with C<txn_do> for transaction support.
2445 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2446 in an assumed transaction between commits, and you're telling us you'd
2447 like to manage that manually. A lot of the magic protections offered by
2448 this module will go away. We can't protect you from exceptions due to database
2449 disconnects because we don't know anything about how to restart your
2450 transactions. You're on your own for handling all sorts of exceptional
2451 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2457 Matt S. Trout <mst@shadowcatsystems.co.uk>
2459 Andy Grundman <andy@hybridized.org>
2463 You may distribute this code under the same terms as Perl itself.