1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base 'DBIx::Class::Storage';
10 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
17 __PACKAGE__->mk_group_accessors('simple' =>
18 qw/_connect_info _dbi_connect_info _dbh _sql_maker _sql_maker_opts _conn_pid
19 _conn_tid transaction_depth _dbh_autocommit _driver_determined savepoints/
22 # the values for these accessors are picked out (and deleted) from
23 # the attribute hashref passed to connect_info
24 my @storage_options = qw/
25 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
26 disable_sth_caching unsafe auto_savepoint
28 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
31 # default cursor class, overridable in connect_info attributes
32 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
34 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class/);
35 __PACKAGE__->sql_maker_class('DBIx::Class::SQLAHacks');
40 DBIx::Class::Storage::DBI - DBI storage handler
44 my $schema = MySchema->connect('dbi:SQLite:my.db');
46 $schema->storage->debug(1);
47 $schema->dbh_do("DROP TABLE authors");
49 $schema->resultset('Book')->search({
50 written_on => $schema->storage->datetime_parser(DateTime->now)
55 This class represents the connection to an RDBMS via L<DBI>. See
56 L<DBIx::Class::Storage> for general information. This pod only
57 documents DBI-specific methods and behaviors.
64 my $new = shift->next::method(@_);
66 $new->transaction_depth(0);
67 $new->_sql_maker_opts({});
68 $new->{savepoints} = [];
69 $new->{_in_dbh_do} = 0;
77 This method is normally called by L<DBIx::Class::Schema/connection>, which
78 encapsulates its argument list in an arrayref before passing them here.
80 The argument list may contain:
86 The same 4-element argument set one would normally pass to
87 L<DBI/connect>, optionally followed by
88 L<extra attributes|/DBIx::Class specific connection attributes>
89 recognized by DBIx::Class:
91 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
95 A single code reference which returns a connected
96 L<DBI database handle|DBI/connect> optionally followed by
97 L<extra attributes|/DBIx::Class specific connection attributes> recognized
100 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
104 A single hashref with all the attributes and the dsn/user/password
107 $connect_info_args = [{
115 This is particularly useful for L<Catalyst> based applications, allowing the
116 following config (L<Config::General> style):
121 dsn dbi:mysql:database=test
130 Please note that the L<DBI> docs recommend that you always explicitly
131 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
132 recommends that it be set to I<1>, and that you perform transactions
133 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
134 to I<1> if you do not do explicitly set it to zero. This is the default
135 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
137 =head3 DBIx::Class specific connection attributes
139 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
140 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
141 the following connection options. These options can be mixed in with your other
142 L<DBI> connection attributes, or placed in a seperate hashref
143 (C<\%extra_attributes>) as shown above.
145 Every time C<connect_info> is invoked, any previous settings for
146 these options will be cleared before setting the new ones, regardless of
147 whether any options are specified in the new C<connect_info>.
154 Specifies things to do immediately after connecting or re-connecting to
155 the database. Its value may contain:
161 This contains one SQL statement to execute.
163 =item an array reference
165 This contains SQL statements to execute in order. Each element contains
166 a string or a code reference that returns a string.
168 =item a code reference
170 This contains some code to execute. Unlike code references within an
171 array reference, its return value is ignored.
175 =item on_disconnect_do
177 Takes arguments in the same form as L</on_connect_do> and executes them
178 immediately before disconnecting from the database.
180 Note, this only runs if you explicitly call L</disconnect> on the
183 =item on_connect_call
185 A more generalized form of L</on_connect_do> that calls the specified
186 C<connect_call_METHOD> methods in your storage driver.
188 on_connect_do => 'select 1'
192 on_connect_call => [ [ do_sql => 'select 1' ] ]
194 Its values may contain:
200 Will call the C<connect_call_METHOD> method.
202 =item a code reference
204 Will execute C<< $code->($storage) >>
206 =item an array reference
208 Each value can be a method name or code reference.
210 =item an array of arrays
212 For each array, the first item is taken to be the C<connect_call_> method name
213 or code reference, and the rest are parameters to it.
217 Some predefined storage methods you may use:
223 Executes a SQL string or a code reference that returns a SQL string. This is
224 what L</on_connect_do> and L</on_disconnect_do> use.
232 Will execute the scalar as SQL.
236 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
237 attributes hashref and bind values.
239 =item a code reference
241 Will execute C<< $code->($storage) >> and execute the return array refs as
248 Execute any statements necessary to initialize the database session to return
249 and accept datetime/timestamp values used with
250 L<DBIx::Class::InflateColumn::DateTime>.
252 Only necessary for some databases, see your specific storage driver for
253 implementation details.
257 =item on_disconnect_call
259 Takes arguments in the same form as L</on_connect_call> and executes them
260 immediately before disconnecting from the database.
262 Calls the C<disconnect_call_METHOD> methods as opposed to the
263 C<connect_call_METHOD> methods called by L</on_connect_call>.
265 Note, this only runs if you explicitly call L</disconnect> on the
268 =item disable_sth_caching
270 If set to a true value, this option will disable the caching of
271 statement handles via L<DBI/prepare_cached>.
275 Sets the limit dialect. This is useful for JDBC-bridge among others
276 where the remote SQL-dialect cannot be determined by the name of the
277 driver alone. See also L<SQL::Abstract::Limit>.
281 Specifies what characters to use to quote table and column names. If
282 you use this you will want to specify L</name_sep> as well.
284 C<quote_char> expects either a single character, in which case is it
285 is placed on either side of the table/column name, or an arrayref of length
286 2 in which case the table/column name is placed between the elements.
288 For example under MySQL you should use C<< quote_char => '`' >>, and for
289 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
293 This only needs to be used in conjunction with C<quote_char>, and is used to
294 specify the charecter that seperates elements (schemas, tables, columns) from
295 each other. In most cases this is simply a C<.>.
297 The consequences of not supplying this value is that L<SQL::Abstract>
298 will assume DBIx::Class' uses of aliases to be complete column
299 names. The output will look like I<"me.name"> when it should actually
304 This Storage driver normally installs its own C<HandleError>, sets
305 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
306 all database handles, including those supplied by a coderef. It does this
307 so that it can have consistent and useful error behavior.
309 If you set this option to a true value, Storage will not do its usual
310 modifications to the database handle's attributes, and instead relies on
311 the settings in your connect_info DBI options (or the values you set in
312 your connection coderef, in the case that you are connecting via coderef).
314 Note that your custom settings can cause Storage to malfunction,
315 especially if you set a C<HandleError> handler that suppresses exceptions
316 and/or disable C<RaiseError>.
320 If this option is true, L<DBIx::Class> will use savepoints when nesting
321 transactions, making it possible to recover from failure in the inner
322 transaction without having to abort all outer transactions.
326 Use this argument to supply a cursor class other than the default
327 L<DBIx::Class::Storage::DBI::Cursor>.
331 Some real-life examples of arguments to L</connect_info> and
332 L<DBIx::Class::Schema/connect>
334 # Simple SQLite connection
335 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
338 ->connect_info([ sub { DBI->connect(...) } ]);
340 # A bit more complicated
347 { quote_char => q{"}, name_sep => q{.} },
351 # Equivalent to the previous example
357 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
361 # Same, but with hashref as argument
362 # See parse_connect_info for explanation
365 dsn => 'dbi:Pg:dbname=foo',
367 password => 'my_pg_password',
374 # Subref + DBIx::Class-specific connection options
377 sub { DBI->connect(...) },
381 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
382 disable_sth_caching => 1,
392 my ($self, $info_arg) = @_;
394 return $self->_connect_info if !$info_arg;
396 my @args = @$info_arg; # take a shallow copy for further mutilation
397 $self->_connect_info([@args]); # copy for _connect_info
400 # combine/pre-parse arguments depending on invocation style
403 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
404 %attrs = %{ $args[1] || {} };
407 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
408 %attrs = %{$args[0]};
410 for (qw/password user dsn/) {
411 unshift @args, delete $attrs{$_};
414 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
416 % { $args[3] || {} },
417 % { $args[4] || {} },
419 @args = @args[0,1,2];
422 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
423 # the new set of options
424 $self->_sql_maker(undef);
425 $self->_sql_maker_opts({});
428 for my $storage_opt (@storage_options, 'cursor_class') { # @storage_options is declared at the top of the module
429 if(my $value = delete $attrs{$storage_opt}) {
430 $self->$storage_opt($value);
433 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
434 if(my $opt_val = delete $attrs{$sql_maker_opt}) {
435 $self->_sql_maker_opts->{$sql_maker_opt} = $opt_val;
440 if (ref $args[0] eq 'CODE') {
441 # _connect() never looks past $args[0] in this case
445 %{ $self->_default_dbi_connect_attributes || {} },
450 $self->_dbi_connect_info([@args, keys %attrs ? \%attrs : ()]);
451 $self->_connect_info;
454 sub _default_dbi_connect_attributes {
455 return { AutoCommit => 1 };
460 This method is deprecated in favour of setting via L</connect_info>.
464 =head2 on_disconnect_do
466 This method is deprecated in favour of setting via L</connect_info>.
470 sub _parse_connect_do {
471 my ($self, $type) = @_;
473 my $val = $self->$type;
474 return () if not defined $val;
479 push @res, [ 'do_sql', $val ];
480 } elsif (ref($val) eq 'CODE') {
482 } elsif (ref($val) eq 'ARRAY') {
483 push @res, map { [ 'do_sql', $_ ] } @$val;
485 $self->throw_exception("Invalid type for $type: ".ref($val));
493 Arguments: ($subref | $method_name), @extra_coderef_args?
495 Execute the given $subref or $method_name using the new exception-based
496 connection management.
498 The first two arguments will be the storage object that C<dbh_do> was called
499 on and a database handle to use. Any additional arguments will be passed
500 verbatim to the called subref as arguments 2 and onwards.
502 Using this (instead of $self->_dbh or $self->dbh) ensures correct
503 exception handling and reconnection (or failover in future subclasses).
505 Your subref should have no side-effects outside of the database, as
506 there is the potential for your subref to be partially double-executed
507 if the database connection was stale/dysfunctional.
511 my @stuff = $schema->storage->dbh_do(
513 my ($storage, $dbh, @cols) = @_;
514 my $cols = join(q{, }, @cols);
515 $dbh->selectrow_array("SELECT $cols FROM foo");
526 my $dbh = $self->_dbh;
528 return $self->$code($dbh, @_) if $self->{_in_dbh_do}
529 || $self->{transaction_depth};
531 local $self->{_in_dbh_do} = 1;
533 $self->_do_with_reconnect($code, @_);
536 sub _do_with_reconnect {
540 my $want_array = wantarray;
541 my $dbh = $self->_dbh;
544 $self->_verify_pid if $dbh;
546 $self->_populate_dbh;
551 @result = $self->$code($dbh, @_);
553 elsif(defined $want_array) {
554 $result[0] = $self->$code($dbh, @_);
557 $self->$code($dbh, @_);
562 if(!$exception) { return $want_array ? @result : $result[0] }
564 $self->throw_exception($exception) if $self->connected;
566 # We were not connected - reconnect and retry, but let any
567 # exception fall right through this time
568 $self->_populate_dbh;
569 $self->$code($self->_dbh, @_);
572 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
573 # It also informs dbh_do to bypass itself while under the direction of txn_do,
574 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
579 ref $coderef eq 'CODE' or $self->throw_exception
580 ('$coderef must be a CODE reference');
582 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
584 local $self->{_in_dbh_do} = 1;
587 my $want_array = wantarray;
592 $self->_verify_pid if $self->_dbh;
593 $self->_populate_dbh if !$self->_dbh;
597 @result = $coderef->(@_);
599 elsif(defined $want_array) {
600 $result[0] = $coderef->(@_);
609 if(!$exception) { return $want_array ? @result : $result[0] }
611 if($tried++ > 0 || $self->connected) {
612 eval { $self->txn_rollback };
613 my $rollback_exception = $@;
614 if($rollback_exception) {
615 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
616 $self->throw_exception($exception) # propagate nested rollback
617 if $rollback_exception =~ /$exception_class/;
619 $self->throw_exception(
620 "Transaction aborted: ${exception}. "
621 . "Rollback failed: ${rollback_exception}"
624 $self->throw_exception($exception)
627 # We were not connected, and was first try - reconnect and retry
629 $self->_populate_dbh;
635 Our C<disconnect> method also performs a rollback first if the
636 database is not in C<AutoCommit> mode.
646 push @actions, ( $self->on_disconnect_call || () );
647 push @actions, $self->_parse_connect_do ('on_disconnect_do');
649 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
651 $self->_dbh->rollback unless $self->_dbh_autocommit;
652 $self->_dbh->disconnect;
658 =head2 with_deferred_fk_checks
662 =item Arguments: C<$coderef>
664 =item Return Value: The return value of $coderef
668 Storage specific method to run the code ref with FK checks deferred or
669 in MySQL's case disabled entirely.
673 # Storage subclasses should override this
674 sub with_deferred_fk_checks {
675 my ($self, $sub) = @_;
684 =item Arguments: none
686 =item Return Value: 1|0
690 Verifies that the the current database handle is active and ready to execute
691 an SQL statement (i.e. the connection did not get stale, server is still
692 answering, etc.) This method is used internally by L</dbh>.
699 if(my $dbh = $self->_dbh) {
700 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
707 return 0 if !$self->_dbh;
709 return ($dbh->FETCH('Active') && $self->_ping);
718 my $dbh = $self->_dbh or return 0;
723 # handle pid changes correctly
724 # NOTE: assumes $self->_dbh is a valid $dbh
728 return if defined $self->_conn_pid && $self->_conn_pid == $$;
730 $self->_dbh->{InactiveDestroy} = 1;
737 sub ensure_connected {
740 unless ($self->connected) {
741 $self->_populate_dbh;
747 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
748 is guaranteed to be healthy by implicitly calling L</connected>, and if
749 necessary performing a reconnection before returning.
756 if (not $self->_dbh) {
757 $self->_populate_dbh;
759 $self->ensure_connected;
766 This returns the B<last> available C<$dbh> if any, or attempts to
767 connect and returns the resulting handle. This method differs from
768 L</dbh> by not validating if a preexisting handle is still healthy
769 via L</connected>. Make sure you take appropriate precautions
770 when using this method, as the C<$dbh> may be useless at this point.
776 $self->_populate_dbh unless $self->_dbh;
780 sub _sql_maker_args {
785 array_datatypes => 1,
786 limit_dialect => $self->last_dbh,
787 %{$self->_sql_maker_opts}
793 unless ($self->_sql_maker) {
794 my $sql_maker_class = $self->sql_maker_class;
795 $self->ensure_class_loaded ($sql_maker_class);
796 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
798 return $self->_sql_maker;
806 my @info = @{$self->_dbi_connect_info || []};
807 $self->_dbh($self->_connect(@info));
809 $self->_conn_pid($$);
810 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
812 $self->_determine_driver;
814 # Always set the transaction depth on connect, since
815 # there is no transaction in progress by definition
816 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
818 $self->_run_connection_actions unless $self->{_in_determine_driver};
821 sub _run_connection_actions {
825 push @actions, ( $self->on_connect_call || () );
826 push @actions, $self->_parse_connect_do ('on_connect_do');
828 $self->_do_connection_actions(connect_call_ => $_) for @actions;
831 sub _determine_driver {
834 if (not $self->_driver_determined) {
835 my $started_unconnected = 0;
836 local $self->{_in_determine_driver} = 1;
838 if (ref($self) eq __PACKAGE__) {
840 if ($self->_dbh) { # we are connected
841 $driver = $self->_dbh->{Driver}{Name};
843 # try to use dsn to not require being connected, the driver may still
844 # force a connection in _rebless to determine version
845 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
846 $started_unconnected = 1;
849 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
850 if ($self->load_optional_class($storage_class)) {
851 mro::set_mro($storage_class, 'c3');
852 bless $self, $storage_class;
857 $self->_driver_determined(1);
859 $self->_run_connection_actions
860 if $started_unconnected && defined $self->_dbh;
864 sub _do_connection_actions {
866 my $method_prefix = shift;
869 if (not ref($call)) {
870 my $method = $method_prefix . $call;
872 } elsif (ref($call) eq 'CODE') {
874 } elsif (ref($call) eq 'ARRAY') {
875 if (ref($call->[0]) ne 'ARRAY') {
876 $self->_do_connection_actions($method_prefix, $_) for @$call;
878 $self->_do_connection_actions($method_prefix, @$_) for @$call;
881 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
887 sub connect_call_do_sql {
889 $self->_do_query(@_);
892 sub disconnect_call_do_sql {
894 $self->_do_query(@_);
897 # override in db-specific backend when necessary
898 sub connect_call_datetime_setup { 1 }
901 my ($self, $action) = @_;
903 if (ref $action eq 'CODE') {
904 $action = $action->($self);
905 $self->_do_query($_) foreach @$action;
908 # Most debuggers expect ($sql, @bind), so we need to exclude
909 # the attribute hash which is the second argument to $dbh->do
910 # furthermore the bind values are usually to be presented
911 # as named arrayref pairs, so wrap those here too
912 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
913 my $sql = shift @do_args;
914 my $attrs = shift @do_args;
915 my @bind = map { [ undef, $_ ] } @do_args;
917 $self->_query_start($sql, @bind);
918 $self->_dbh->do($sql, $attrs, @do_args);
919 $self->_query_end($sql, @bind);
926 my ($self, @info) = @_;
928 $self->throw_exception("You failed to provide any connection info")
931 my ($old_connect_via, $dbh);
933 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
934 $old_connect_via = $DBI::connect_via;
935 $DBI::connect_via = 'connect';
939 if(ref $info[0] eq 'CODE') {
943 $dbh = DBI->connect(@info);
946 if($dbh && !$self->unsafe) {
947 my $weak_self = $self;
948 Scalar::Util::weaken($weak_self);
949 $dbh->{HandleError} = sub {
951 $weak_self->throw_exception("DBI Exception: $_[0]");
954 croak ("DBI Exception: $_[0]");
957 $dbh->{ShowErrorStatement} = 1;
958 $dbh->{RaiseError} = 1;
959 $dbh->{PrintError} = 0;
963 $DBI::connect_via = $old_connect_via if $old_connect_via;
965 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
968 $self->_dbh_autocommit($dbh->{AutoCommit});
974 my ($self, $name) = @_;
976 $name = $self->_svp_generate_name
977 unless defined $name;
979 $self->throw_exception ("You can't use savepoints outside a transaction")
980 if $self->{transaction_depth} == 0;
982 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
983 unless $self->can('_svp_begin');
985 push @{ $self->{savepoints} }, $name;
987 $self->debugobj->svp_begin($name) if $self->debug;
989 return $self->_svp_begin($name);
993 my ($self, $name) = @_;
995 $self->throw_exception ("You can't use savepoints outside a transaction")
996 if $self->{transaction_depth} == 0;
998 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
999 unless $self->can('_svp_release');
1001 if (defined $name) {
1002 $self->throw_exception ("Savepoint '$name' does not exist")
1003 unless grep { $_ eq $name } @{ $self->{savepoints} };
1005 # Dig through the stack until we find the one we are releasing. This keeps
1006 # the stack up to date.
1009 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1011 $name = pop @{ $self->{savepoints} };
1014 $self->debugobj->svp_release($name) if $self->debug;
1016 return $self->_svp_release($name);
1020 my ($self, $name) = @_;
1022 $self->throw_exception ("You can't use savepoints outside a transaction")
1023 if $self->{transaction_depth} == 0;
1025 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1026 unless $self->can('_svp_rollback');
1028 if (defined $name) {
1029 # If they passed us a name, verify that it exists in the stack
1030 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1031 $self->throw_exception("Savepoint '$name' does not exist!");
1034 # Dig through the stack until we find the one we are releasing. This keeps
1035 # the stack up to date.
1036 while(my $s = pop(@{ $self->{savepoints} })) {
1037 last if($s eq $name);
1039 # Add the savepoint back to the stack, as a rollback doesn't remove the
1040 # named savepoint, only everything after it.
1041 push(@{ $self->{savepoints} }, $name);
1043 # We'll assume they want to rollback to the last savepoint
1044 $name = $self->{savepoints}->[-1];
1047 $self->debugobj->svp_rollback($name) if $self->debug;
1049 return $self->_svp_rollback($name);
1052 sub _svp_generate_name {
1055 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1060 if($self->{transaction_depth} == 0) {
1061 $self->debugobj->txn_begin()
1063 # this isn't ->_dbh-> because
1064 # we should reconnect on begin_work
1065 # for AutoCommit users
1066 $self->_do_with_reconnect(sub { $_[1]->begin_work });
1067 } elsif ($self->auto_savepoint) {
1070 $self->{transaction_depth}++;
1075 if ($self->{transaction_depth} == 1) {
1076 my $dbh = $self->_dbh;
1077 $self->debugobj->txn_commit()
1080 $self->{transaction_depth} = 0
1081 if $self->_dbh_autocommit;
1083 elsif($self->{transaction_depth} > 1) {
1084 $self->{transaction_depth}--;
1086 if $self->auto_savepoint;
1092 my $dbh = $self->_dbh;
1094 if ($self->{transaction_depth} == 1) {
1095 $self->debugobj->txn_rollback()
1097 $self->{transaction_depth} = 0
1098 if $self->_dbh_autocommit;
1101 elsif($self->{transaction_depth} > 1) {
1102 $self->{transaction_depth}--;
1103 if ($self->auto_savepoint) {
1104 $self->svp_rollback;
1109 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1114 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1115 $error =~ /$exception_class/ and $self->throw_exception($error);
1116 # ensure that a failed rollback resets the transaction depth
1117 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1118 $self->throw_exception($error);
1122 # This used to be the top-half of _execute. It was split out to make it
1123 # easier to override in NoBindVars without duping the rest. It takes up
1124 # all of _execute's args, and emits $sql, @bind.
1125 sub _prep_for_execute {
1126 my ($self, $op, $extra_bind, $ident, $args) = @_;
1128 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1129 $ident = $ident->from();
1132 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1135 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1137 return ($sql, \@bind);
1141 sub _fix_bind_params {
1142 my ($self, @bind) = @_;
1144 ### Turn @bind from something like this:
1145 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1147 ### ( "'1'", "'1'", "'3'" )
1150 if ( defined( $_ && $_->[1] ) ) {
1151 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1158 my ( $self, $sql, @bind ) = @_;
1160 if ( $self->debug ) {
1161 @bind = $self->_fix_bind_params(@bind);
1163 $self->debugobj->query_start( $sql, @bind );
1168 my ( $self, $sql, @bind ) = @_;
1170 if ( $self->debug ) {
1171 @bind = $self->_fix_bind_params(@bind);
1172 $self->debugobj->query_end( $sql, @bind );
1177 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1179 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1181 $self->_query_start( $sql, @$bind );
1183 my $sth = $self->sth($sql,$op);
1185 my $placeholder_index = 1;
1187 foreach my $bound (@$bind) {
1188 my $attributes = {};
1189 my($column_name, @data) = @$bound;
1191 if ($bind_attributes) {
1192 $attributes = $bind_attributes->{$column_name}
1193 if defined $bind_attributes->{$column_name};
1196 foreach my $data (@data) {
1197 my $ref = ref $data;
1198 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1200 $sth->bind_param($placeholder_index, $data, $attributes);
1201 $placeholder_index++;
1205 # Can this fail without throwing an exception anyways???
1206 my $rv = $sth->execute();
1207 $self->throw_exception($sth->errstr) if !$rv;
1209 $self->_query_end( $sql, @$bind );
1211 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1216 $self->dbh_do('_dbh_execute', @_)
1220 my ($self, $source, $to_insert) = @_;
1222 # redispatch to insert method of storage we reblessed into, if necessary
1223 if (not $self->_driver_determined) {
1224 $self->_determine_driver;
1225 goto $self->can('insert');
1228 my $ident = $source->from;
1229 my $bind_attributes = $self->source_bind_attributes($source);
1231 my $updated_cols = {};
1233 foreach my $col ( $source->columns ) {
1234 if ( !defined $to_insert->{$col} ) {
1235 my $col_info = $source->column_info($col);
1237 if ( $col_info->{auto_nextval} ) {
1238 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1240 $col_info->{sequence} ||
1241 $self->_dbh_get_autoinc_seq($self->last_dbh, $source)
1247 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1249 return $updated_cols;
1252 ## Still not quite perfect, and EXPERIMENTAL
1253 ## Currently it is assumed that all values passed will be "normal", i.e. not
1254 ## scalar refs, or at least, all the same type as the first set, the statement is
1255 ## only prepped once.
1257 my ($self, $source, $cols, $data) = @_;
1259 my $table = $source->from;
1260 @colvalues{@$cols} = (0..$#$cols);
1261 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1263 $self->_determine_driver;
1265 $self->_query_start( $sql, @bind );
1266 my $sth = $self->sth($sql);
1268 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1270 ## This must be an arrayref, else nothing works!
1271 my $tuple_status = [];
1273 ## Get the bind_attributes, if any exist
1274 my $bind_attributes = $self->source_bind_attributes($source);
1276 ## Bind the values and execute
1277 my $placeholder_index = 1;
1279 foreach my $bound (@bind) {
1281 my $attributes = {};
1282 my ($column_name, $data_index) = @$bound;
1284 if( $bind_attributes ) {
1285 $attributes = $bind_attributes->{$column_name}
1286 if defined $bind_attributes->{$column_name};
1289 my @data = map { $_->[$data_index] } @$data;
1291 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1292 $placeholder_index++;
1294 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1297 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1299 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1300 if ($i > $#$tuple_status);
1302 require Data::Dumper;
1303 local $Data::Dumper::Terse = 1;
1304 local $Data::Dumper::Indent = 1;
1305 local $Data::Dumper::Useqq = 1;
1306 local $Data::Dumper::Quotekeys = 0;
1308 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1309 $tuple_status->[$i][1],
1310 Data::Dumper::Dumper(
1311 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1315 $self->throw_exception($sth->errstr) if !$rv;
1317 $self->_query_end( $sql, @bind );
1318 return (wantarray ? ($rv, $sth, @bind) : $rv);
1322 my $self = shift @_;
1323 my $source = shift @_;
1324 $self->_determine_driver;
1325 my $bind_attributes = $self->source_bind_attributes($source);
1327 return $self->_execute('update' => [], $source, $bind_attributes, @_);
1332 my $self = shift @_;
1333 my $source = shift @_;
1334 $self->_determine_driver;
1335 my $bind_attrs = $self->source_bind_attributes($source);
1337 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1340 # We were sent here because the $rs contains a complex search
1341 # which will require a subquery to select the correct rows
1342 # (i.e. joined or limited resultsets)
1344 # Genarating a single PK column subquery is trivial and supported
1345 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1346 # Look at _multipk_update_delete()
1347 sub _subq_update_delete {
1349 my ($rs, $op, $values) = @_;
1351 my $rsrc = $rs->result_source;
1353 # we already check this, but double check naively just in case. Should be removed soon
1354 my $sel = $rs->_resolved_attrs->{select};
1355 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1356 my @pcols = $rsrc->primary_columns;
1357 if (@$sel != @pcols) {
1358 $self->throw_exception (
1359 'Subquery update/delete can not be called on resultsets selecting a'
1360 .' number of columns different than the number of primary keys'
1367 $op eq 'update' ? $values : (),
1368 { $pcols[0] => { -in => $rs->as_query } },
1373 return $self->_multipk_update_delete (@_);
1377 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1378 # resultset update/delete involving subqueries. So by default resort
1379 # to simple (and inefficient) delete_all style per-row opearations,
1380 # while allowing specific storages to override this with a faster
1383 sub _multipk_update_delete {
1384 return shift->_per_row_update_delete (@_);
1387 # This is the default loop used to delete/update rows for multi PK
1388 # resultsets, and used by mysql exclusively (because it can't do anything
1391 # We do not use $row->$op style queries, because resultset update/delete
1392 # is not expected to cascade (this is what delete_all/update_all is for).
1394 # There should be no race conditions as the entire operation is rolled
1397 sub _per_row_update_delete {
1399 my ($rs, $op, $values) = @_;
1401 my $rsrc = $rs->result_source;
1402 my @pcols = $rsrc->primary_columns;
1404 my $guard = $self->txn_scope_guard;
1406 # emulate the return value of $sth->execute for non-selects
1407 my $row_cnt = '0E0';
1409 my $subrs_cur = $rs->cursor;
1410 while (my @pks = $subrs_cur->next) {
1413 for my $i (0.. $#pcols) {
1414 $cond->{$pcols[$i]} = $pks[$i];
1419 $op eq 'update' ? $values : (),
1434 # localization is neccessary as
1435 # 1) there is no infrastructure to pass this around before SQLA2
1436 # 2) _select_args sets it and _prep_for_execute consumes it
1437 my $sql_maker = $self->sql_maker;
1438 local $sql_maker->{_dbic_rs_attrs};
1440 return $self->_execute($self->_select_args(@_));
1443 sub _select_args_to_query {
1446 # localization is neccessary as
1447 # 1) there is no infrastructure to pass this around before SQLA2
1448 # 2) _select_args sets it and _prep_for_execute consumes it
1449 my $sql_maker = $self->sql_maker;
1450 local $sql_maker->{_dbic_rs_attrs};
1452 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1453 # = $self->_select_args($ident, $select, $cond, $attrs);
1454 my ($op, $bind, $ident, $bind_attrs, @args) =
1455 $self->_select_args(@_);
1457 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1458 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1459 $prepared_bind ||= [];
1462 ? ($sql, $prepared_bind, $bind_attrs)
1463 : \[ "($sql)", @$prepared_bind ]
1468 my ($self, $ident, $select, $where, $attrs) = @_;
1470 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1472 my $sql_maker = $self->sql_maker;
1473 $sql_maker->{_dbic_rs_attrs} = {
1479 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1484 # calculate bind_attrs before possible $ident mangling
1485 my $bind_attrs = {};
1486 for my $alias (keys %$alias2source) {
1487 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1488 for my $col (keys %$bindtypes) {
1490 my $fqcn = join ('.', $alias, $col);
1491 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1493 # Unqialified column names are nice, but at the same time can be
1494 # rather ambiguous. What we do here is basically go along with
1495 # the loop, adding an unqualified column slot to $bind_attrs,
1496 # alongside the fully qualified name. As soon as we encounter
1497 # another column by that name (which would imply another table)
1498 # we unset the unqualified slot and never add any info to it
1499 # to avoid erroneous type binding. If this happens the users
1500 # only choice will be to fully qualify his column name
1502 if (exists $bind_attrs->{$col}) {
1503 $bind_attrs->{$col} = {};
1506 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1513 $attrs->{software_limit}
1515 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1517 $attrs->{software_limit} = 1;
1520 $self->throw_exception("rows attribute must be positive if present")
1521 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1523 # MySQL actually recommends this approach. I cringe.
1524 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1529 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1530 # otherwise delegate the limiting to the storage, unless software limit was requested
1532 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1534 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1535 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1537 ($ident, $select, $where, $attrs)
1538 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1540 elsif (! $attrs->{software_limit} ) {
1541 push @limit, $attrs->{rows}, $attrs->{offset};
1545 # This would be the point to deflate anything found in $where
1546 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1547 # expect a row object. And all we have is a resultsource (it is trivial
1548 # to extract deflator coderefs via $alias2source above).
1550 # I don't see a way forward other than changing the way deflators are
1551 # invoked, and that's just bad...
1555 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1556 (qw/order_by group_by having/ )
1559 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1563 # This is the code producing joined subqueries like:
1564 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1566 sub _adjust_select_args_for_complex_prefetch {
1567 my ($self, $from, $select, $where, $attrs) = @_;
1569 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1570 if (ref $from ne 'ARRAY');
1572 # copies for mangling
1574 $select = [ @$select ];
1575 $attrs = { %$attrs };
1577 # separate attributes
1578 my $sub_attrs = { %$attrs };
1579 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1580 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1582 my $select_root_alias = $attrs->{alias};
1583 my $sql_maker = $self->sql_maker;
1585 # create subquery select list - consider only stuff *not* brought in by the prefetch
1586 my $sub_select = [];
1588 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1589 my $sel = $attrs->{select}[$i];
1591 # alias any functions to the dbic-side 'as' label
1592 # adjust the outer select accordingly
1593 if (ref $sel eq 'HASH' && !$sel->{-select}) {
1594 $sel = { -select => $sel, -as => $attrs->{as}[$i] };
1595 $select->[$i] = join ('.', $attrs->{alias}, ($attrs->{as}[$i] || "select_$i") );
1598 push @$sub_select, $sel;
1601 # bring over all non-collapse-induced order_by into the inner query (if any)
1602 # the outer one will have to keep them all
1603 delete $sub_attrs->{order_by};
1604 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1605 $sub_attrs->{order_by} = [
1606 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1610 # mangle {from}, keep in mind that $from is "headless" from here on
1611 my $join_root = shift @$from;
1614 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1616 # in complex search_related chains $select_root_alias may *not* be
1617 # 'me' so always include it in the inner join
1618 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1621 # decide which parts of the join will remain on the inside
1623 # this is not a very viable optimisation, but it was written
1624 # before I realised this, so might as well remain. We can throw
1625 # away _any_ branches of the join tree that are:
1626 # 1) not mentioned in the condition/order
1627 # 2) left-join leaves (or left-join leaf chains)
1628 # Most of the join conditions will not satisfy this, but for real
1629 # complex queries some might, and we might make some RDBMS happy.
1632 # since we do not have introspectable SQLA, we fall back to ugly
1633 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1634 # in order to determine what goes into %inner_joins
1635 # It may not be very efficient, but it's a reasonable stop-gap
1637 # produce stuff unquoted, so it can be scanned
1638 local $sql_maker->{quote_char};
1639 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1643 { ref $_ ? $_->[0] : $_ }
1644 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1647 my $where_sql = $sql_maker->where ($where);
1648 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1651 for my $alias (keys %join_info) {
1653 # any table alias found on a column name in where or order_by
1654 # gets included in %inner_joins
1655 # Also any parent joins that are needed to reach this particular alias
1656 for my $piece ($select_sql, $where_sql, @order_by ) {
1657 if ($piece =~ /\b $alias $sep/x) {
1658 $inner_joins{$alias} = 1;
1664 # scan for non-leaf/non-left joins and mark as needed
1665 # also mark all ancestor joins that are needed to reach this particular alias
1666 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1668 # traverse by the size of the -join_path i.e. reverse depth first
1669 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1671 my $j = $join_info{$alias};
1672 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1674 if ($inner_joins{$alias}) {
1675 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1679 # construct the inner $from for the subquery
1680 my $inner_from = [ $join_root ];
1681 for my $j (@$from) {
1682 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1685 # if a multi-type join was needed in the subquery ("multi" is indicated by
1686 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1687 unless ($sub_attrs->{group_by}) {
1688 for my $alias (keys %inner_joins) {
1690 # the dot comes from some weirdness in collapse
1691 # remove after the rewrite
1692 if ($attrs->{collapse}{".$alias"}) {
1693 $sub_attrs->{group_by} ||= $sub_select;
1699 # generate the subquery
1700 my $subq = $self->_select_args_to_query (
1706 my $subq_joinspec = {
1707 -alias => $select_root_alias,
1708 -source_handle => $join_root->{-source_handle},
1709 $select_root_alias => $subq,
1712 # Generate a new from (really just replace the join slot with the subquery)
1713 # Before we would start the outer chain from the subquery itself (i.e.
1714 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1715 # a bad idea for search_related, as the root of the chain was effectively
1716 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1717 # of 'cds', which would prevent from doing things like order_by artist.*)
1718 # See t/prefetch/via_search_related.t for a better idea
1720 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1726 else { # this is trickier
1727 @outer_from = ($join_root);
1729 for my $j (@$from) {
1730 if ($j->[0]{-alias} eq $select_root_alias) {
1737 push @outer_from, $j;
1742 # This is totally horrific - the $where ends up in both the inner and outer query
1743 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1744 # then if where conditions apply to the *right* side of the prefetch, you may have
1745 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1746 # the outer select to exclude joins you didin't want in the first place
1748 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1749 return (\@outer_from, $select, $where, $attrs);
1752 sub _resolve_ident_sources {
1753 my ($self, $ident) = @_;
1755 my $alias2source = {};
1758 # the reason this is so contrived is that $ident may be a {from}
1759 # structure, specifying multiple tables to join
1760 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1761 # this is compat mode for insert/update/delete which do not deal with aliases
1762 $alias2source->{me} = $ident;
1765 elsif (ref $ident eq 'ARRAY') {
1769 if (ref $_ eq 'HASH') {
1771 $rs_alias = $tabinfo->{-alias};
1773 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1777 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1778 if ($tabinfo->{-source_handle});
1782 return ($alias2source, $rs_alias);
1785 # Takes $ident, \@column_names
1787 # returns { $column_name => \%column_info, ... }
1788 # also note: this adds -result_source => $rsrc to the column info
1791 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1792 sub _resolve_column_info {
1793 my ($self, $ident, $colnames) = @_;
1794 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1796 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1799 my (%return, %seen_cols);
1801 # compile a global list of column names, to be able to properly
1802 # disambiguate unqualified column names (if at all possible)
1803 for my $alias (keys %$alias2src) {
1804 my $rsrc = $alias2src->{$alias};
1805 for my $colname ($rsrc->columns) {
1806 push @{$seen_cols{$colname}}, $alias;
1811 foreach my $col (@$colnames) {
1812 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1815 # see if the column was seen exactly once (so we know which rsrc it came from)
1816 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1817 $alias = $seen_cols{$colname}[0];
1824 my $rsrc = $alias2src->{$alias};
1825 $return{$col} = $rsrc && {
1826 %{$rsrc->column_info($colname)},
1827 -result_source => $rsrc,
1828 -source_alias => $alias,
1835 # Returns a counting SELECT for a simple count
1836 # query. Abstracted so that a storage could override
1837 # this to { count => 'firstcol' } or whatever makes
1838 # sense as a performance optimization
1840 #my ($self, $source, $rs_attrs) = @_;
1841 return { count => '*' };
1844 # Returns a SELECT which will end up in the subselect
1845 # There may or may not be a group_by, as the subquery
1846 # might have been called to accomodate a limit
1848 # Most databases would be happy with whatever ends up
1849 # here, but some choke in various ways.
1851 sub _subq_count_select {
1852 my ($self, $source, $rs_attrs) = @_;
1853 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1855 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1856 return @pcols ? \@pcols : [ 1 ];
1860 sub source_bind_attributes {
1861 my ($self, $source) = @_;
1863 my $bind_attributes;
1864 foreach my $column ($source->columns) {
1866 my $data_type = $source->column_info($column)->{data_type} || '';
1867 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1871 return $bind_attributes;
1878 =item Arguments: $ident, $select, $condition, $attrs
1882 Handle a SQL select statement.
1888 my ($ident, $select, $condition, $attrs) = @_;
1889 return $self->cursor_class->new($self, \@_, $attrs);
1894 my ($rv, $sth, @bind) = $self->_select(@_);
1895 my @row = $sth->fetchrow_array;
1896 my @nextrow = $sth->fetchrow_array if @row;
1897 if(@row && @nextrow) {
1898 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1900 # Need to call finish() to work round broken DBDs
1909 =item Arguments: $sql
1913 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1918 my ($self, $dbh, $sql) = @_;
1920 # 3 is the if_active parameter which avoids active sth re-use
1921 my $sth = $self->disable_sth_caching
1922 ? $dbh->prepare($sql)
1923 : $dbh->prepare_cached($sql, {}, 3);
1925 # XXX You would think RaiseError would make this impossible,
1926 # but apparently that's not true :(
1927 $self->throw_exception($dbh->errstr) if !$sth;
1933 my ($self, $sql) = @_;
1934 $self->dbh_do('_dbh_sth', $sql);
1937 sub _dbh_columns_info_for {
1938 my ($self, $dbh, $table) = @_;
1940 if ($dbh->can('column_info')) {
1943 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1944 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1946 while ( my $info = $sth->fetchrow_hashref() ){
1948 $column_info{data_type} = $info->{TYPE_NAME};
1949 $column_info{size} = $info->{COLUMN_SIZE};
1950 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1951 $column_info{default_value} = $info->{COLUMN_DEF};
1952 my $col_name = $info->{COLUMN_NAME};
1953 $col_name =~ s/^\"(.*)\"$/$1/;
1955 $result{$col_name} = \%column_info;
1958 return \%result if !$@ && scalar keys %result;
1962 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
1964 my @columns = @{$sth->{NAME_lc}};
1965 for my $i ( 0 .. $#columns ){
1967 $column_info{data_type} = $sth->{TYPE}->[$i];
1968 $column_info{size} = $sth->{PRECISION}->[$i];
1969 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
1971 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
1972 $column_info{data_type} = $1;
1973 $column_info{size} = $2;
1976 $result{$columns[$i]} = \%column_info;
1980 foreach my $col (keys %result) {
1981 my $colinfo = $result{$col};
1982 my $type_num = $colinfo->{data_type};
1984 if(defined $type_num && $dbh->can('type_info')) {
1985 my $type_info = $dbh->type_info($type_num);
1986 $type_name = $type_info->{TYPE_NAME} if $type_info;
1987 $colinfo->{data_type} = $type_name if $type_name;
1994 sub columns_info_for {
1995 my ($self, $table) = @_;
1996 $self->dbh_do('_dbh_columns_info_for', $table);
1999 =head2 last_insert_id
2001 Return the row id of the last insert.
2005 sub _dbh_last_insert_id {
2006 # All Storage's need to register their own _dbh_last_insert_id
2007 # the old SQLite-based method was highly inappropriate
2010 my $class = ref $self;
2011 $self->throw_exception (<<EOE);
2013 No _dbh_last_insert_id() method found in $class.
2014 Since the method of obtaining the autoincrement id of the last insert
2015 operation varies greatly between different databases, this method must be
2016 individually implemented for every storage class.
2020 sub last_insert_id {
2022 $self->dbh_do('_dbh_last_insert_id', @_);
2027 Returns the database driver name.
2031 sub sqlt_type { shift->last_dbh->{Driver}->{Name} }
2033 =head2 bind_attribute_by_data_type
2035 Given a datatype from column info, returns a database specific bind
2036 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2037 let the database planner just handle it.
2039 Generally only needed for special case column types, like bytea in postgres.
2043 sub bind_attribute_by_data_type {
2047 =head2 is_datatype_numeric
2049 Given a datatype from column_info, returns a boolean value indicating if
2050 the current RDBMS considers it a numeric value. This controls how
2051 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2052 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2053 be performed instead of the usual C<eq>.
2057 sub is_datatype_numeric {
2058 my ($self, $dt) = @_;
2060 return 0 unless $dt;
2062 return $dt =~ /^ (?:
2063 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2068 =head2 create_ddl_dir (EXPERIMENTAL)
2072 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2076 Creates a SQL file based on the Schema, for each of the specified
2077 database engines in C<\@databases> in the given directory.
2078 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2080 Given a previous version number, this will also create a file containing
2081 the ALTER TABLE statements to transform the previous schema into the
2082 current one. Note that these statements may contain C<DROP TABLE> or
2083 C<DROP COLUMN> statements that can potentially destroy data.
2085 The file names are created using the C<ddl_filename> method below, please
2086 override this method in your schema if you would like a different file
2087 name format. For the ALTER file, the same format is used, replacing
2088 $version in the name with "$preversion-$version".
2090 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2091 The most common value for this would be C<< { add_drop_table => 1 } >>
2092 to have the SQL produced include a C<DROP TABLE> statement for each table
2093 created. For quoting purposes supply C<quote_table_names> and
2094 C<quote_field_names>.
2096 If no arguments are passed, then the following default values are assumed:
2100 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2102 =item version - $schema->schema_version
2104 =item directory - './'
2106 =item preversion - <none>
2110 By default, C<\%sqlt_args> will have
2112 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2114 merged with the hash passed in. To disable any of those features, pass in a
2115 hashref like the following
2117 { ignore_constraint_names => 0, # ... other options }
2120 Note that this feature is currently EXPERIMENTAL and may not work correctly
2121 across all databases, or fully handle complex relationships.
2123 WARNING: Please check all SQL files created, before applying them.
2127 sub create_ddl_dir {
2128 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2130 if(!$dir || !-d $dir) {
2131 carp "No directory given, using ./\n";
2134 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2135 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2137 my $schema_version = $schema->schema_version || '1.x';
2138 $version ||= $schema_version;
2141 add_drop_table => 1,
2142 ignore_constraint_names => 1,
2143 ignore_index_names => 1,
2147 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2148 . $self->_check_sqlt_message . q{'})
2149 if !$self->_check_sqlt_version;
2151 my $sqlt = SQL::Translator->new( $sqltargs );
2153 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2154 my $sqlt_schema = $sqlt->translate({ data => $schema })
2155 or $self->throw_exception ($sqlt->error);
2157 foreach my $db (@$databases) {
2159 $sqlt->{schema} = $sqlt_schema;
2160 $sqlt->producer($db);
2163 my $filename = $schema->ddl_filename($db, $version, $dir);
2164 if (-e $filename && ($version eq $schema_version )) {
2165 # if we are dumping the current version, overwrite the DDL
2166 carp "Overwriting existing DDL file - $filename";
2170 my $output = $sqlt->translate;
2172 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2175 if(!open($file, ">$filename")) {
2176 $self->throw_exception("Can't open $filename for writing ($!)");
2179 print $file $output;
2182 next unless ($preversion);
2184 require SQL::Translator::Diff;
2186 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2187 if(!-e $prefilename) {
2188 carp("No previous schema file found ($prefilename)");
2192 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2194 carp("Overwriting existing diff file - $difffile");
2200 my $t = SQL::Translator->new($sqltargs);
2205 or $self->throw_exception ($t->error);
2207 my $out = $t->translate( $prefilename )
2208 or $self->throw_exception ($t->error);
2210 $source_schema = $t->schema;
2212 $source_schema->name( $prefilename )
2213 unless ( $source_schema->name );
2216 # The "new" style of producers have sane normalization and can support
2217 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2218 # And we have to diff parsed SQL against parsed SQL.
2219 my $dest_schema = $sqlt_schema;
2221 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2222 my $t = SQL::Translator->new($sqltargs);
2227 or $self->throw_exception ($t->error);
2229 my $out = $t->translate( $filename )
2230 or $self->throw_exception ($t->error);
2232 $dest_schema = $t->schema;
2234 $dest_schema->name( $filename )
2235 unless $dest_schema->name;
2238 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2242 if(!open $file, ">$difffile") {
2243 $self->throw_exception("Can't write to $difffile ($!)");
2251 =head2 deployment_statements
2255 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2259 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2261 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2262 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2264 C<$directory> is used to return statements from files in a previously created
2265 L</create_ddl_dir> directory and is optional. The filenames are constructed
2266 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2268 If no C<$directory> is specified then the statements are constructed on the
2269 fly using L<SQL::Translator> and C<$version> is ignored.
2271 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2275 sub deployment_statements {
2276 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2277 # Need to be connected to get the correct sqlt_type
2278 $self->last_dbh() unless $type;
2279 $type ||= $self->sqlt_type;
2280 $version ||= $schema->schema_version || '1.x';
2282 my $filename = $schema->ddl_filename($type, $version, $dir);
2286 open($file, "<$filename")
2287 or $self->throw_exception("Can't open $filename ($!)");
2290 return join('', @rows);
2293 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2294 . $self->_check_sqlt_message . q{'})
2295 if !$self->_check_sqlt_version;
2297 require SQL::Translator::Parser::DBIx::Class;
2298 eval qq{use SQL::Translator::Producer::${type}};
2299 $self->throw_exception($@) if $@;
2301 # sources needs to be a parser arg, but for simplicty allow at top level
2303 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2304 if exists $sqltargs->{sources};
2306 my $tr = SQL::Translator->new(%$sqltargs);
2307 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
2308 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
2312 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2315 return if($line =~ /^--/);
2317 # next if($line =~ /^DROP/m);
2318 return if($line =~ /^BEGIN TRANSACTION/m);
2319 return if($line =~ /^COMMIT/m);
2320 return if $line =~ /^\s+$/; # skip whitespace only
2321 $self->_query_start($line);
2323 # a previous error may invalidate $dbh - thus we need to use dbh()
2324 # to guarantee a healthy $dbh (this is temporary until we get
2325 # proper error handling on deploy() )
2326 $self->dbh->do($line);
2329 carp qq{$@ (running "${line}")};
2331 $self->_query_end($line);
2333 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2334 if (@statements > 1) {
2335 foreach my $statement (@statements) {
2336 $deploy->( $statement );
2339 elsif (@statements == 1) {
2340 foreach my $line ( split(";\n", $statements[0])) {
2346 =head2 datetime_parser
2348 Returns the datetime parser class
2352 sub datetime_parser {
2354 return $self->{datetime_parser} ||= do {
2356 $self->build_datetime_parser(@_);
2360 =head2 datetime_parser_type
2362 Defines (returns) the datetime parser class - currently hardwired to
2363 L<DateTime::Format::MySQL>
2367 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2369 =head2 build_datetime_parser
2371 See L</datetime_parser>
2375 sub build_datetime_parser {
2377 my $type = $self->datetime_parser_type(@_);
2379 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2384 my $_check_sqlt_version; # private
2385 my $_check_sqlt_message; # private
2386 sub _check_sqlt_version {
2387 return $_check_sqlt_version if defined $_check_sqlt_version;
2388 eval 'use SQL::Translator "0.09003"';
2389 $_check_sqlt_message = $@ || '';
2390 $_check_sqlt_version = !$@;
2393 sub _check_sqlt_message {
2394 _check_sqlt_version if !defined $_check_sqlt_message;
2395 $_check_sqlt_message;
2399 =head2 is_replicating
2401 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2402 replicate from a master database. Default is undef, which is the result
2403 returned by databases that don't support replication.
2407 sub is_replicating {
2412 =head2 lag_behind_master
2414 Returns a number that represents a certain amount of lag behind a master db
2415 when a given storage is replicating. The number is database dependent, but
2416 starts at zero and increases with the amount of lag. Default in undef
2420 sub lag_behind_master {
2426 return if !$self->_dbh;
2435 =head2 DBIx::Class and AutoCommit
2437 DBIx::Class can do some wonderful magic with handling exceptions,
2438 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2439 (the default) combined with C<txn_do> for transaction support.
2441 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2442 in an assumed transaction between commits, and you're telling us you'd
2443 like to manage that manually. A lot of the magic protections offered by
2444 this module will go away. We can't protect you from exceptions due to database
2445 disconnects because we don't know anything about how to restart your
2446 transactions. You're on your own for handling all sorts of exceptional
2447 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2453 Matt S. Trout <mst@shadowcatsystems.co.uk>
2455 Andy Grundman <andy@hybridized.org>
2459 You may distribute this code under the same terms as Perl itself.