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 carp "Retrying $code after catching disconnected exception: $exception"
567 if $ENV{DBIC_DBIRETRY_DEBUG};
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->(@_);
608 # ->connected might unset $@ - copy
610 if(!$exception) { return $want_array ? @result : $result[0] }
612 if($tried++ || $self->connected) {
613 eval { $self->txn_rollback };
614 my $rollback_exception = $@;
615 if($rollback_exception) {
616 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
617 $self->throw_exception($exception) # propagate nested rollback
618 if $rollback_exception =~ /$exception_class/;
620 $self->throw_exception(
621 "Transaction aborted: ${exception}. "
622 . "Rollback failed: ${rollback_exception}"
625 $self->throw_exception($exception)
628 # We were not connected, and was first try - reconnect and retry
630 carp "Retrying $coderef after catching disconnected exception: $exception"
631 if $ENV{DBIC_DBIRETRY_DEBUG};
632 $self->_populate_dbh;
638 Our C<disconnect> method also performs a rollback first if the
639 database is not in C<AutoCommit> mode.
649 push @actions, ( $self->on_disconnect_call || () );
650 push @actions, $self->_parse_connect_do ('on_disconnect_do');
652 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
654 $self->_dbh_rollback unless $self->_dbh_autocommit;
656 $self->_dbh->disconnect;
662 =head2 with_deferred_fk_checks
666 =item Arguments: C<$coderef>
668 =item Return Value: The return value of $coderef
672 Storage specific method to run the code ref with FK checks deferred or
673 in MySQL's case disabled entirely.
677 # Storage subclasses should override this
678 sub with_deferred_fk_checks {
679 my ($self, $sub) = @_;
688 =item Arguments: none
690 =item Return Value: 1|0
694 Verifies that the the current database handle is active and ready to execute
695 an SQL statement (i.e. the connection did not get stale, server is still
696 answering, etc.) This method is used internally by L</dbh>.
702 return 0 unless $self->_seems_connected;
705 local $self->_dbh->{RaiseError} = 1;
710 sub _seems_connected {
713 my $dbh = $self->_dbh
716 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
723 return 0 if !$self->_dbh;
726 return $dbh->FETCH('Active');
732 my $dbh = $self->_dbh or return 0;
737 # handle pid changes correctly
738 # NOTE: assumes $self->_dbh is a valid $dbh
742 return if defined $self->_conn_pid && $self->_conn_pid == $$;
744 $self->_dbh->{InactiveDestroy} = 1;
751 sub ensure_connected {
754 unless ($self->connected) {
755 $self->_populate_dbh;
761 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
762 is guaranteed to be healthy by implicitly calling L</connected>, and if
763 necessary performing a reconnection before returning. Keep in mind that this
764 is very B<expensive> on some database engines. Consider using L<dbh_do>
772 if (not $self->_dbh) {
773 $self->_populate_dbh;
775 $self->ensure_connected;
780 # this is the internal "get dbh or connect (don't check)" method
783 $self->_populate_dbh unless $self->_dbh;
787 sub _sql_maker_args {
792 array_datatypes => 1,
793 limit_dialect => $self->_get_dbh,
794 %{$self->_sql_maker_opts}
800 unless ($self->_sql_maker) {
801 my $sql_maker_class = $self->sql_maker_class;
802 $self->ensure_class_loaded ($sql_maker_class);
803 $self->_sql_maker($sql_maker_class->new( $self->_sql_maker_args ));
805 return $self->_sql_maker;
813 my @info = @{$self->_dbi_connect_info || []};
814 $self->_dbh(undef); # in case ->connected failed we might get sent here
815 $self->_dbh($self->_connect(@info));
817 $self->_conn_pid($$);
818 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
820 $self->_determine_driver;
822 # Always set the transaction depth on connect, since
823 # there is no transaction in progress by definition
824 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
826 $self->_run_connection_actions unless $self->{_in_determine_driver};
829 sub _run_connection_actions {
833 push @actions, ( $self->on_connect_call || () );
834 push @actions, $self->_parse_connect_do ('on_connect_do');
836 $self->_do_connection_actions(connect_call_ => $_) for @actions;
839 sub _determine_driver {
842 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
843 my $started_unconnected = 0;
844 local $self->{_in_determine_driver} = 1;
846 if (ref($self) eq __PACKAGE__) {
848 if ($self->_dbh) { # we are connected
849 $driver = $self->_dbh->{Driver}{Name};
851 # try to use dsn to not require being connected, the driver may still
852 # force a connection in _rebless to determine version
853 ($driver) = $self->_dbi_connect_info->[0] =~ /dbi:([^:]+):/i;
854 $started_unconnected = 1;
857 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
858 if ($self->load_optional_class($storage_class)) {
859 mro::set_mro($storage_class, 'c3');
860 bless $self, $storage_class;
865 $self->_driver_determined(1);
867 $self->_run_connection_actions
868 if $started_unconnected && defined $self->_dbh;
872 sub _do_connection_actions {
874 my $method_prefix = shift;
877 if (not ref($call)) {
878 my $method = $method_prefix . $call;
880 } elsif (ref($call) eq 'CODE') {
882 } elsif (ref($call) eq 'ARRAY') {
883 if (ref($call->[0]) ne 'ARRAY') {
884 $self->_do_connection_actions($method_prefix, $_) for @$call;
886 $self->_do_connection_actions($method_prefix, @$_) for @$call;
889 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
895 sub connect_call_do_sql {
897 $self->_do_query(@_);
900 sub disconnect_call_do_sql {
902 $self->_do_query(@_);
905 # override in db-specific backend when necessary
906 sub connect_call_datetime_setup { 1 }
909 my ($self, $action) = @_;
911 if (ref $action eq 'CODE') {
912 $action = $action->($self);
913 $self->_do_query($_) foreach @$action;
916 # Most debuggers expect ($sql, @bind), so we need to exclude
917 # the attribute hash which is the second argument to $dbh->do
918 # furthermore the bind values are usually to be presented
919 # as named arrayref pairs, so wrap those here too
920 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
921 my $sql = shift @do_args;
922 my $attrs = shift @do_args;
923 my @bind = map { [ undef, $_ ] } @do_args;
925 $self->_query_start($sql, @bind);
926 $self->_dbh->do($sql, $attrs, @do_args);
927 $self->_query_end($sql, @bind);
934 my ($self, @info) = @_;
936 $self->throw_exception("You failed to provide any connection info")
939 my ($old_connect_via, $dbh);
941 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
942 $old_connect_via = $DBI::connect_via;
943 $DBI::connect_via = 'connect';
947 if(ref $info[0] eq 'CODE') {
951 $dbh = DBI->connect(@info);
954 if($dbh && !$self->unsafe) {
955 my $weak_self = $self;
956 Scalar::Util::weaken($weak_self);
957 $dbh->{HandleError} = sub {
959 $weak_self->throw_exception("DBI Exception: $_[0]");
962 croak ("DBI Exception: $_[0]");
965 $dbh->{ShowErrorStatement} = 1;
966 $dbh->{RaiseError} = 1;
967 $dbh->{PrintError} = 0;
971 $DBI::connect_via = $old_connect_via if $old_connect_via;
973 $self->throw_exception("DBI Connection failed: " . ($@||$DBI::errstr))
976 $self->_dbh_autocommit($dbh->{AutoCommit});
982 my ($self, $name) = @_;
984 $name = $self->_svp_generate_name
985 unless defined $name;
987 $self->throw_exception ("You can't use savepoints outside a transaction")
988 if $self->{transaction_depth} == 0;
990 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
991 unless $self->can('_svp_begin');
993 push @{ $self->{savepoints} }, $name;
995 $self->debugobj->svp_begin($name) if $self->debug;
997 return $self->_svp_begin($name);
1001 my ($self, $name) = @_;
1003 $self->throw_exception ("You can't use savepoints outside a transaction")
1004 if $self->{transaction_depth} == 0;
1006 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1007 unless $self->can('_svp_release');
1009 if (defined $name) {
1010 $self->throw_exception ("Savepoint '$name' does not exist")
1011 unless grep { $_ eq $name } @{ $self->{savepoints} };
1013 # Dig through the stack until we find the one we are releasing. This keeps
1014 # the stack up to date.
1017 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1019 $name = pop @{ $self->{savepoints} };
1022 $self->debugobj->svp_release($name) if $self->debug;
1024 return $self->_svp_release($name);
1028 my ($self, $name) = @_;
1030 $self->throw_exception ("You can't use savepoints outside a transaction")
1031 if $self->{transaction_depth} == 0;
1033 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1034 unless $self->can('_svp_rollback');
1036 if (defined $name) {
1037 # If they passed us a name, verify that it exists in the stack
1038 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1039 $self->throw_exception("Savepoint '$name' does not exist!");
1042 # Dig through the stack until we find the one we are releasing. This keeps
1043 # the stack up to date.
1044 while(my $s = pop(@{ $self->{savepoints} })) {
1045 last if($s eq $name);
1047 # Add the savepoint back to the stack, as a rollback doesn't remove the
1048 # named savepoint, only everything after it.
1049 push(@{ $self->{savepoints} }, $name);
1051 # We'll assume they want to rollback to the last savepoint
1052 $name = $self->{savepoints}->[-1];
1055 $self->debugobj->svp_rollback($name) if $self->debug;
1057 return $self->_svp_rollback($name);
1060 sub _svp_generate_name {
1063 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1068 if($self->{transaction_depth} == 0) {
1069 $self->debugobj->txn_begin()
1071 $self->_dbh_begin_work;
1073 elsif ($self->auto_savepoint) {
1076 $self->{transaction_depth}++;
1079 sub _dbh_begin_work {
1081 # being here implies we have AutoCommit => 1
1082 # if the user is utilizing txn_do - good for
1083 # him, otherwise we need to ensure that the
1084 # $dbh is healthy on BEGIN
1085 my $dbh_method = $self->{_in_dbh_do} ? '_dbh' : 'dbh';
1086 $self->$dbh_method->begin_work;
1091 if ($self->{transaction_depth} == 1) {
1092 my $dbh = $self->_dbh;
1093 $self->debugobj->txn_commit()
1096 $self->{transaction_depth} = 0
1097 if $self->_dbh_autocommit;
1099 elsif($self->{transaction_depth} > 1) {
1100 $self->{transaction_depth}--;
1102 if $self->auto_savepoint;
1108 $self->_dbh->commit;
1113 my $dbh = $self->_dbh;
1115 if ($self->{transaction_depth} == 1) {
1116 $self->debugobj->txn_rollback()
1118 $self->{transaction_depth} = 0
1119 if $self->_dbh_autocommit;
1120 $self->_dbh_rollback;
1122 elsif($self->{transaction_depth} > 1) {
1123 $self->{transaction_depth}--;
1124 if ($self->auto_savepoint) {
1125 $self->svp_rollback;
1130 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1135 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1136 $error =~ /$exception_class/ and $self->throw_exception($error);
1137 # ensure that a failed rollback resets the transaction depth
1138 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1139 $self->throw_exception($error);
1145 $self->_dbh->rollback;
1148 # This used to be the top-half of _execute. It was split out to make it
1149 # easier to override in NoBindVars without duping the rest. It takes up
1150 # all of _execute's args, and emits $sql, @bind.
1151 sub _prep_for_execute {
1152 my ($self, $op, $extra_bind, $ident, $args) = @_;
1154 if( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1155 $ident = $ident->from();
1158 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1161 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1163 return ($sql, \@bind);
1167 sub _fix_bind_params {
1168 my ($self, @bind) = @_;
1170 ### Turn @bind from something like this:
1171 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1173 ### ( "'1'", "'1'", "'3'" )
1176 if ( defined( $_ && $_->[1] ) ) {
1177 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1184 my ( $self, $sql, @bind ) = @_;
1186 if ( $self->debug ) {
1187 @bind = $self->_fix_bind_params(@bind);
1189 $self->debugobj->query_start( $sql, @bind );
1194 my ( $self, $sql, @bind ) = @_;
1196 if ( $self->debug ) {
1197 @bind = $self->_fix_bind_params(@bind);
1198 $self->debugobj->query_end( $sql, @bind );
1203 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1205 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1207 $self->_query_start( $sql, @$bind );
1209 my $sth = $self->sth($sql,$op);
1211 my $placeholder_index = 1;
1213 foreach my $bound (@$bind) {
1214 my $attributes = {};
1215 my($column_name, @data) = @$bound;
1217 if ($bind_attributes) {
1218 $attributes = $bind_attributes->{$column_name}
1219 if defined $bind_attributes->{$column_name};
1222 foreach my $data (@data) {
1223 my $ref = ref $data;
1224 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1226 $sth->bind_param($placeholder_index, $data, $attributes);
1227 $placeholder_index++;
1231 # Can this fail without throwing an exception anyways???
1232 my $rv = $sth->execute();
1233 $self->throw_exception($sth->errstr) if !$rv;
1235 $self->_query_end( $sql, @$bind );
1237 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1242 $self->dbh_do('_dbh_execute', @_)
1246 my ($self, $source, $to_insert) = @_;
1248 # redispatch to insert method of storage we reblessed into, if necessary
1249 if (not $self->_driver_determined) {
1250 $self->_determine_driver;
1251 goto $self->can('insert');
1254 my $ident = $source->from;
1255 my $bind_attributes = $self->source_bind_attributes($source);
1257 my $updated_cols = {};
1259 foreach my $col ( $source->columns ) {
1260 if ( !defined $to_insert->{$col} ) {
1261 my $col_info = $source->column_info($col);
1263 if ( $col_info->{auto_nextval} ) {
1264 $updated_cols->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1266 $col_info->{sequence} ||
1267 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source)
1273 $self->_execute('insert' => [], $source, $bind_attributes, $to_insert);
1275 return $updated_cols;
1278 ## Still not quite perfect, and EXPERIMENTAL
1279 ## Currently it is assumed that all values passed will be "normal", i.e. not
1280 ## scalar refs, or at least, all the same type as the first set, the statement is
1281 ## only prepped once.
1283 my ($self, $source, $cols, $data) = @_;
1285 my $table = $source->from;
1286 @colvalues{@$cols} = (0..$#$cols);
1287 my ($sql, @bind) = $self->sql_maker->insert($table, \%colvalues);
1289 $self->_determine_driver;
1291 $self->_query_start( $sql, @bind );
1292 my $sth = $self->sth($sql);
1294 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1296 ## This must be an arrayref, else nothing works!
1297 my $tuple_status = [];
1299 ## Get the bind_attributes, if any exist
1300 my $bind_attributes = $self->source_bind_attributes($source);
1302 ## Bind the values and execute
1303 my $placeholder_index = 1;
1305 foreach my $bound (@bind) {
1307 my $attributes = {};
1308 my ($column_name, $data_index) = @$bound;
1310 if( $bind_attributes ) {
1311 $attributes = $bind_attributes->{$column_name}
1312 if defined $bind_attributes->{$column_name};
1315 my @data = map { $_->[$data_index] } @$data;
1317 $sth->bind_param_array( $placeholder_index, [@data], $attributes );
1318 $placeholder_index++;
1320 my $rv = eval { $sth->execute_array({ArrayTupleStatus => $tuple_status}) };
1323 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1325 $self->throw_exception($sth->errstr || "Unexpected populate error: $err")
1326 if ($i > $#$tuple_status);
1328 require Data::Dumper;
1329 local $Data::Dumper::Terse = 1;
1330 local $Data::Dumper::Indent = 1;
1331 local $Data::Dumper::Useqq = 1;
1332 local $Data::Dumper::Quotekeys = 0;
1334 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1335 $tuple_status->[$i][1],
1336 Data::Dumper::Dumper(
1337 { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) }
1341 $self->throw_exception($sth->errstr) if !$rv;
1343 $self->_query_end( $sql, @bind );
1344 return (wantarray ? ($rv, $sth, @bind) : $rv);
1348 my ($self, $source, @args) = @_;
1350 # redispatch to update method of storage we reblessed into, if necessary
1351 if (not $self->_driver_determined) {
1352 $self->_determine_driver;
1353 goto $self->can('update');
1356 my $bind_attributes = $self->source_bind_attributes($source);
1358 return $self->_execute('update' => [], $source, $bind_attributes, @args);
1363 my $self = shift @_;
1364 my $source = shift @_;
1365 $self->_determine_driver;
1366 my $bind_attrs = $self->source_bind_attributes($source);
1368 return $self->_execute('delete' => [], $source, $bind_attrs, @_);
1371 # We were sent here because the $rs contains a complex search
1372 # which will require a subquery to select the correct rows
1373 # (i.e. joined or limited resultsets)
1375 # Genarating a single PK column subquery is trivial and supported
1376 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1377 # Look at _multipk_update_delete()
1378 sub _subq_update_delete {
1380 my ($rs, $op, $values) = @_;
1382 my $rsrc = $rs->result_source;
1384 # we already check this, but double check naively just in case. Should be removed soon
1385 my $sel = $rs->_resolved_attrs->{select};
1386 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1387 my @pcols = $rsrc->primary_columns;
1388 if (@$sel != @pcols) {
1389 $self->throw_exception (
1390 'Subquery update/delete can not be called on resultsets selecting a'
1391 .' number of columns different than the number of primary keys'
1398 $op eq 'update' ? $values : (),
1399 { $pcols[0] => { -in => $rs->as_query } },
1404 return $self->_multipk_update_delete (@_);
1408 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1409 # resultset update/delete involving subqueries. So by default resort
1410 # to simple (and inefficient) delete_all style per-row opearations,
1411 # while allowing specific storages to override this with a faster
1414 sub _multipk_update_delete {
1415 return shift->_per_row_update_delete (@_);
1418 # This is the default loop used to delete/update rows for multi PK
1419 # resultsets, and used by mysql exclusively (because it can't do anything
1422 # We do not use $row->$op style queries, because resultset update/delete
1423 # is not expected to cascade (this is what delete_all/update_all is for).
1425 # There should be no race conditions as the entire operation is rolled
1428 sub _per_row_update_delete {
1430 my ($rs, $op, $values) = @_;
1432 my $rsrc = $rs->result_source;
1433 my @pcols = $rsrc->primary_columns;
1435 my $guard = $self->txn_scope_guard;
1437 # emulate the return value of $sth->execute for non-selects
1438 my $row_cnt = '0E0';
1440 my $subrs_cur = $rs->cursor;
1441 while (my @pks = $subrs_cur->next) {
1444 for my $i (0.. $#pcols) {
1445 $cond->{$pcols[$i]} = $pks[$i];
1450 $op eq 'update' ? $values : (),
1465 # localization is neccessary as
1466 # 1) there is no infrastructure to pass this around before SQLA2
1467 # 2) _select_args sets it and _prep_for_execute consumes it
1468 my $sql_maker = $self->sql_maker;
1469 local $sql_maker->{_dbic_rs_attrs};
1471 return $self->_execute($self->_select_args(@_));
1474 sub _select_args_to_query {
1477 # localization is neccessary as
1478 # 1) there is no infrastructure to pass this around before SQLA2
1479 # 2) _select_args sets it and _prep_for_execute consumes it
1480 my $sql_maker = $self->sql_maker;
1481 local $sql_maker->{_dbic_rs_attrs};
1483 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $order, $rows, $offset)
1484 # = $self->_select_args($ident, $select, $cond, $attrs);
1485 my ($op, $bind, $ident, $bind_attrs, @args) =
1486 $self->_select_args(@_);
1488 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $order, $rows, $offset ]);
1489 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1490 $prepared_bind ||= [];
1493 ? ($sql, $prepared_bind, $bind_attrs)
1494 : \[ "($sql)", @$prepared_bind ]
1499 my ($self, $ident, $select, $where, $attrs) = @_;
1501 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1503 my $sql_maker = $self->sql_maker;
1504 $sql_maker->{_dbic_rs_attrs} = {
1510 ? ( _source_handle => $alias2source->{$rs_alias}->handle )
1515 # calculate bind_attrs before possible $ident mangling
1516 my $bind_attrs = {};
1517 for my $alias (keys %$alias2source) {
1518 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1519 for my $col (keys %$bindtypes) {
1521 my $fqcn = join ('.', $alias, $col);
1522 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1524 # Unqialified column names are nice, but at the same time can be
1525 # rather ambiguous. What we do here is basically go along with
1526 # the loop, adding an unqualified column slot to $bind_attrs,
1527 # alongside the fully qualified name. As soon as we encounter
1528 # another column by that name (which would imply another table)
1529 # we unset the unqualified slot and never add any info to it
1530 # to avoid erroneous type binding. If this happens the users
1531 # only choice will be to fully qualify his column name
1533 if (exists $bind_attrs->{$col}) {
1534 $bind_attrs->{$col} = {};
1537 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
1544 $attrs->{software_limit}
1546 $sql_maker->_default_limit_syntax eq "GenericSubQ"
1548 $attrs->{software_limit} = 1;
1551 $self->throw_exception("rows attribute must be positive if present")
1552 if (defined($attrs->{rows}) && !($attrs->{rows} > 0));
1554 # MySQL actually recommends this approach. I cringe.
1555 $attrs->{rows} = 2**48 if not defined $attrs->{rows} and defined $attrs->{offset};
1560 # see if we need to tear the prefetch apart (either limited has_many or grouped prefetch)
1561 # otherwise delegate the limiting to the storage, unless software limit was requested
1563 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
1565 ( $attrs->{group_by} && @{$attrs->{group_by}} &&
1566 $attrs->{_prefetch_select} && @{$attrs->{_prefetch_select}} )
1568 ($ident, $select, $where, $attrs)
1569 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
1571 elsif (! $attrs->{software_limit} ) {
1572 push @limit, $attrs->{rows}, $attrs->{offset};
1576 # This would be the point to deflate anything found in $where
1577 # (and leave $attrs->{bind} intact). Problem is - inflators historically
1578 # expect a row object. And all we have is a resultsource (it is trivial
1579 # to extract deflator coderefs via $alias2source above).
1581 # I don't see a way forward other than changing the way deflators are
1582 # invoked, and that's just bad...
1586 { $attrs->{$_} ? ( $_ => $attrs->{$_} ) : () }
1587 (qw/order_by group_by having/ )
1590 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $order, @limit);
1594 # This is the code producing joined subqueries like:
1595 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
1597 sub _adjust_select_args_for_complex_prefetch {
1598 my ($self, $from, $select, $where, $attrs) = @_;
1600 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
1601 if (ref $from ne 'ARRAY');
1603 # copies for mangling
1605 $select = [ @$select ];
1606 $attrs = { %$attrs };
1608 # separate attributes
1609 my $sub_attrs = { %$attrs };
1610 delete $attrs->{$_} for qw/where bind rows offset group_by having/;
1611 delete $sub_attrs->{$_} for qw/for collapse _prefetch_select _collapse_order_by select as/;
1613 my $select_root_alias = $attrs->{alias};
1614 my $sql_maker = $self->sql_maker;
1616 # create subquery select list - consider only stuff *not* brought in by the prefetch
1617 my $sub_select = [];
1619 for my $i (0 .. @{$attrs->{select}} - @{$attrs->{_prefetch_select}} - 1) {
1620 my $sel = $attrs->{select}[$i];
1622 # alias any functions to the dbic-side 'as' label
1623 # adjust the outer select accordingly
1624 if (ref $sel eq 'HASH' ) {
1625 $sel->{-as} ||= $attrs->{as}[$i];
1626 $select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "select_$i") );
1629 push @$sub_select, $sel;
1632 # bring over all non-collapse-induced order_by into the inner query (if any)
1633 # the outer one will have to keep them all
1634 delete $sub_attrs->{order_by};
1635 if (my $ord_cnt = @{$attrs->{order_by}} - @{$attrs->{_collapse_order_by}} ) {
1636 $sub_attrs->{order_by} = [
1637 @{$attrs->{order_by}}[ 0 .. $ord_cnt - 1]
1641 # mangle {from}, keep in mind that $from is "headless" from here on
1642 my $join_root = shift @$from;
1645 my %join_info = map { $_->[0]{-alias} => $_->[0] } (@$from);
1647 # in complex search_related chains $select_root_alias may *not* be
1648 # 'me' so always include it in the inner join
1649 $inner_joins{$select_root_alias} = 1 if ($join_root->{-alias} ne $select_root_alias);
1652 # decide which parts of the join will remain on the inside
1654 # this is not a very viable optimisation, but it was written
1655 # before I realised this, so might as well remain. We can throw
1656 # away _any_ branches of the join tree that are:
1657 # 1) not mentioned in the condition/order
1658 # 2) left-join leaves (or left-join leaf chains)
1659 # Most of the join conditions will not satisfy this, but for real
1660 # complex queries some might, and we might make some RDBMS happy.
1663 # since we do not have introspectable SQLA, we fall back to ugly
1664 # scanning of raw SQL for WHERE, and for pieces of ORDER BY
1665 # in order to determine what goes into %inner_joins
1666 # It may not be very efficient, but it's a reasonable stop-gap
1668 # produce stuff unquoted, so it can be scanned
1669 local $sql_maker->{quote_char};
1670 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1674 { ref $_ ? $_->[0] : $_ }
1675 $sql_maker->_order_by_chunks ($sub_attrs->{order_by})
1678 my $where_sql = $sql_maker->where ($where);
1679 my $select_sql = $sql_maker->_recurse_fields ($sub_select);
1682 for my $alias (keys %join_info) {
1684 # any table alias found on a column name in where or order_by
1685 # gets included in %inner_joins
1686 # Also any parent joins that are needed to reach this particular alias
1687 for my $piece ($select_sql, $where_sql, @order_by ) {
1688 if ($piece =~ /\b $alias $sep/x) {
1689 $inner_joins{$alias} = 1;
1695 # scan for non-leaf/non-left joins and mark as needed
1696 # also mark all ancestor joins that are needed to reach this particular alias
1697 # (e.g. join => { cds => 'tracks' } - tracks will bring cds too )
1699 # traverse by the size of the -join_path i.e. reverse depth first
1700 for my $alias (sort { @{$join_info{$b}{-join_path}} <=> @{$join_info{$a}{-join_path}} } (keys %join_info) ) {
1702 my $j = $join_info{$alias};
1703 $inner_joins{$alias} = 1 if (! $j->{-join_type} || ($j->{-join_type} !~ /^left$/i) );
1705 if ($inner_joins{$alias}) {
1706 $inner_joins{$_} = 1 for (@{$j->{-join_path}});
1710 # construct the inner $from for the subquery
1711 my $inner_from = [ $join_root ];
1712 for my $j (@$from) {
1713 push @$inner_from, $j if $inner_joins{$j->[0]{-alias}};
1716 # if a multi-type join was needed in the subquery ("multi" is indicated by
1717 # presence in {collapse}) - add a group_by to simulate the collapse in the subq
1718 unless ($sub_attrs->{group_by}) {
1719 for my $alias (keys %inner_joins) {
1721 # the dot comes from some weirdness in collapse
1722 # remove after the rewrite
1723 if ($attrs->{collapse}{".$alias"}) {
1724 $sub_attrs->{group_by} ||= $sub_select;
1730 # generate the subquery
1731 my $subq = $self->_select_args_to_query (
1737 my $subq_joinspec = {
1738 -alias => $select_root_alias,
1739 -source_handle => $join_root->{-source_handle},
1740 $select_root_alias => $subq,
1743 # Generate a new from (really just replace the join slot with the subquery)
1744 # Before we would start the outer chain from the subquery itself (i.e.
1745 # SELECT ... FROM (SELECT ... ) alias JOIN ..., but this turned out to be
1746 # a bad idea for search_related, as the root of the chain was effectively
1747 # lost (i.e. $artist_rs->search_related ('cds'... ) would result in alias
1748 # of 'cds', which would prevent from doing things like order_by artist.*)
1749 # See t/prefetch/via_search_related.t for a better idea
1751 if ($join_root->{-alias} eq $select_root_alias) { # just swap the root part and we're done
1757 else { # this is trickier
1758 @outer_from = ($join_root);
1760 for my $j (@$from) {
1761 if ($j->[0]{-alias} eq $select_root_alias) {
1768 push @outer_from, $j;
1773 # This is totally horrific - the $where ends up in both the inner and outer query
1774 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
1775 # then if where conditions apply to the *right* side of the prefetch, you may have
1776 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
1777 # the outer select to exclude joins you didin't want in the first place
1779 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
1780 return (\@outer_from, $select, $where, $attrs);
1783 sub _resolve_ident_sources {
1784 my ($self, $ident) = @_;
1786 my $alias2source = {};
1789 # the reason this is so contrived is that $ident may be a {from}
1790 # structure, specifying multiple tables to join
1791 if ( Scalar::Util::blessed($ident) && $ident->isa("DBIx::Class::ResultSource") ) {
1792 # this is compat mode for insert/update/delete which do not deal with aliases
1793 $alias2source->{me} = $ident;
1796 elsif (ref $ident eq 'ARRAY') {
1800 if (ref $_ eq 'HASH') {
1802 $rs_alias = $tabinfo->{-alias};
1804 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
1808 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
1809 if ($tabinfo->{-source_handle});
1813 return ($alias2source, $rs_alias);
1816 # Takes $ident, \@column_names
1818 # returns { $column_name => \%column_info, ... }
1819 # also note: this adds -result_source => $rsrc to the column info
1822 # my $col_sources = $self->_resolve_column_info($ident, @column_names);
1823 sub _resolve_column_info {
1824 my ($self, $ident, $colnames) = @_;
1825 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
1827 my $sep = $self->_sql_maker_opts->{name_sep} || '.';
1830 my (%return, %seen_cols);
1832 # compile a global list of column names, to be able to properly
1833 # disambiguate unqualified column names (if at all possible)
1834 for my $alias (keys %$alias2src) {
1835 my $rsrc = $alias2src->{$alias};
1836 for my $colname ($rsrc->columns) {
1837 push @{$seen_cols{$colname}}, $alias;
1842 foreach my $col (@$colnames) {
1843 my ($alias, $colname) = $col =~ m/^ (?: ([^$sep]+) $sep)? (.+) $/x;
1846 # see if the column was seen exactly once (so we know which rsrc it came from)
1847 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1) {
1848 $alias = $seen_cols{$colname}[0];
1855 my $rsrc = $alias2src->{$alias};
1856 $return{$col} = $rsrc && {
1857 %{$rsrc->column_info($colname)},
1858 -result_source => $rsrc,
1859 -source_alias => $alias,
1866 # Returns a counting SELECT for a simple count
1867 # query. Abstracted so that a storage could override
1868 # this to { count => 'firstcol' } or whatever makes
1869 # sense as a performance optimization
1871 #my ($self, $source, $rs_attrs) = @_;
1872 return { count => '*' };
1875 # Returns a SELECT which will end up in the subselect
1876 # There may or may not be a group_by, as the subquery
1877 # might have been called to accomodate a limit
1879 # Most databases would be happy with whatever ends up
1880 # here, but some choke in various ways.
1882 sub _subq_count_select {
1883 my ($self, $source, $rs_attrs) = @_;
1884 return $rs_attrs->{group_by} if $rs_attrs->{group_by};
1886 my @pcols = map { join '.', $rs_attrs->{alias}, $_ } ($source->primary_columns);
1887 return @pcols ? \@pcols : [ 1 ];
1891 # Returns an ordered list of column names before they are used
1892 # in a SELECT statement. By default simply returns the list
1895 # This may be overridden in a specific storage when there are
1896 # requirements such as moving BLOB columns to the end of the
1898 sub _order_select_columns {
1899 #my ($self, $source, $columns) = @_;
1903 sub source_bind_attributes {
1904 my ($self, $source) = @_;
1906 my $bind_attributes;
1907 foreach my $column ($source->columns) {
1909 my $data_type = $source->column_info($column)->{data_type} || '';
1910 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
1914 return $bind_attributes;
1921 =item Arguments: $ident, $select, $condition, $attrs
1925 Handle a SQL select statement.
1931 my ($ident, $select, $condition, $attrs) = @_;
1932 return $self->cursor_class->new($self, \@_, $attrs);
1937 my ($rv, $sth, @bind) = $self->_select(@_);
1938 my @row = $sth->fetchrow_array;
1939 my @nextrow = $sth->fetchrow_array if @row;
1940 if(@row && @nextrow) {
1941 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
1943 # Need to call finish() to work round broken DBDs
1952 =item Arguments: $sql
1956 Returns a L<DBI> sth (statement handle) for the supplied SQL.
1961 my ($self, $dbh, $sql) = @_;
1963 # 3 is the if_active parameter which avoids active sth re-use
1964 my $sth = $self->disable_sth_caching
1965 ? $dbh->prepare($sql)
1966 : $dbh->prepare_cached($sql, {}, 3);
1968 # XXX You would think RaiseError would make this impossible,
1969 # but apparently that's not true :(
1970 $self->throw_exception($dbh->errstr) if !$sth;
1976 my ($self, $sql) = @_;
1977 $self->dbh_do('_dbh_sth', $sql);
1980 sub _dbh_columns_info_for {
1981 my ($self, $dbh, $table) = @_;
1983 if ($dbh->can('column_info')) {
1986 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
1987 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
1989 while ( my $info = $sth->fetchrow_hashref() ){
1991 $column_info{data_type} = $info->{TYPE_NAME};
1992 $column_info{size} = $info->{COLUMN_SIZE};
1993 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
1994 $column_info{default_value} = $info->{COLUMN_DEF};
1995 my $col_name = $info->{COLUMN_NAME};
1996 $col_name =~ s/^\"(.*)\"$/$1/;
1998 $result{$col_name} = \%column_info;
2001 return \%result if !$@ && scalar keys %result;
2005 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2007 my @columns = @{$sth->{NAME_lc}};
2008 for my $i ( 0 .. $#columns ){
2010 $column_info{data_type} = $sth->{TYPE}->[$i];
2011 $column_info{size} = $sth->{PRECISION}->[$i];
2012 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2014 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2015 $column_info{data_type} = $1;
2016 $column_info{size} = $2;
2019 $result{$columns[$i]} = \%column_info;
2023 foreach my $col (keys %result) {
2024 my $colinfo = $result{$col};
2025 my $type_num = $colinfo->{data_type};
2027 if(defined $type_num && $dbh->can('type_info')) {
2028 my $type_info = $dbh->type_info($type_num);
2029 $type_name = $type_info->{TYPE_NAME} if $type_info;
2030 $colinfo->{data_type} = $type_name if $type_name;
2037 sub columns_info_for {
2038 my ($self, $table) = @_;
2039 $self->dbh_do('_dbh_columns_info_for', $table);
2042 =head2 last_insert_id
2044 Return the row id of the last insert.
2048 sub _dbh_last_insert_id {
2049 # All Storage's need to register their own _dbh_last_insert_id
2050 # the old SQLite-based method was highly inappropriate
2053 my $class = ref $self;
2054 $self->throw_exception (<<EOE);
2056 No _dbh_last_insert_id() method found in $class.
2057 Since the method of obtaining the autoincrement id of the last insert
2058 operation varies greatly between different databases, this method must be
2059 individually implemented for every storage class.
2063 sub last_insert_id {
2065 $self->dbh_do('_dbh_last_insert_id', @_);
2070 Returns the database driver name.
2074 sub sqlt_type { shift->_get_dbh->{Driver}->{Name} }
2077 # Check if placeholders are supported at all
2078 sub _placeholders_supported {
2080 my $dbh = $self->_get_dbh;
2082 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2083 # but it is inaccurate more often than not
2085 local $dbh->{PrintError} = 0;
2086 local $dbh->{RaiseError} = 1;
2087 $dbh->do('select ?', {}, 1);
2092 # Check if placeholders bound to non-string types throw exceptions
2094 sub _typeless_placeholders_supported {
2096 my $dbh = $self->_get_dbh;
2099 local $dbh->{PrintError} = 0;
2100 local $dbh->{RaiseError} = 1;
2101 # this specifically tests a bind that is NOT a string
2102 $dbh->do('select 1 where 1 = ?', {}, 1);
2108 =head2 bind_attribute_by_data_type
2110 Given a datatype from column info, returns a database specific bind
2111 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2112 let the database planner just handle it.
2114 Generally only needed for special case column types, like bytea in postgres.
2118 sub bind_attribute_by_data_type {
2122 =head2 is_datatype_numeric
2124 Given a datatype from column_info, returns a boolean value indicating if
2125 the current RDBMS considers it a numeric value. This controls how
2126 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2127 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2128 be performed instead of the usual C<eq>.
2132 sub is_datatype_numeric {
2133 my ($self, $dt) = @_;
2135 return 0 unless $dt;
2137 return $dt =~ /^ (?:
2138 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2143 =head2 create_ddl_dir (EXPERIMENTAL)
2147 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2151 Creates a SQL file based on the Schema, for each of the specified
2152 database engines in C<\@databases> in the given directory.
2153 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2155 Given a previous version number, this will also create a file containing
2156 the ALTER TABLE statements to transform the previous schema into the
2157 current one. Note that these statements may contain C<DROP TABLE> or
2158 C<DROP COLUMN> statements that can potentially destroy data.
2160 The file names are created using the C<ddl_filename> method below, please
2161 override this method in your schema if you would like a different file
2162 name format. For the ALTER file, the same format is used, replacing
2163 $version in the name with "$preversion-$version".
2165 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2166 The most common value for this would be C<< { add_drop_table => 1 } >>
2167 to have the SQL produced include a C<DROP TABLE> statement for each table
2168 created. For quoting purposes supply C<quote_table_names> and
2169 C<quote_field_names>.
2171 If no arguments are passed, then the following default values are assumed:
2175 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2177 =item version - $schema->schema_version
2179 =item directory - './'
2181 =item preversion - <none>
2185 By default, C<\%sqlt_args> will have
2187 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2189 merged with the hash passed in. To disable any of those features, pass in a
2190 hashref like the following
2192 { ignore_constraint_names => 0, # ... other options }
2195 Note that this feature is currently EXPERIMENTAL and may not work correctly
2196 across all databases, or fully handle complex relationships.
2198 WARNING: Please check all SQL files created, before applying them.
2202 sub create_ddl_dir {
2203 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2205 if(!$dir || !-d $dir) {
2206 carp "No directory given, using ./\n";
2209 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2210 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2212 my $schema_version = $schema->schema_version || '1.x';
2213 $version ||= $schema_version;
2216 add_drop_table => 1,
2217 ignore_constraint_names => 1,
2218 ignore_index_names => 1,
2222 $self->throw_exception(q{Can't create a ddl file without SQL::Translator 0.09003: '}
2223 . $self->_check_sqlt_message . q{'})
2224 if !$self->_check_sqlt_version;
2226 my $sqlt = SQL::Translator->new( $sqltargs );
2228 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2229 my $sqlt_schema = $sqlt->translate({ data => $schema })
2230 or $self->throw_exception ($sqlt->error);
2232 foreach my $db (@$databases) {
2234 $sqlt->{schema} = $sqlt_schema;
2235 $sqlt->producer($db);
2238 my $filename = $schema->ddl_filename($db, $version, $dir);
2239 if (-e $filename && ($version eq $schema_version )) {
2240 # if we are dumping the current version, overwrite the DDL
2241 carp "Overwriting existing DDL file - $filename";
2245 my $output = $sqlt->translate;
2247 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2250 if(!open($file, ">$filename")) {
2251 $self->throw_exception("Can't open $filename for writing ($!)");
2254 print $file $output;
2257 next unless ($preversion);
2259 require SQL::Translator::Diff;
2261 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2262 if(!-e $prefilename) {
2263 carp("No previous schema file found ($prefilename)");
2267 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2269 carp("Overwriting existing diff file - $difffile");
2275 my $t = SQL::Translator->new($sqltargs);
2280 or $self->throw_exception ($t->error);
2282 my $out = $t->translate( $prefilename )
2283 or $self->throw_exception ($t->error);
2285 $source_schema = $t->schema;
2287 $source_schema->name( $prefilename )
2288 unless ( $source_schema->name );
2291 # The "new" style of producers have sane normalization and can support
2292 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2293 # And we have to diff parsed SQL against parsed SQL.
2294 my $dest_schema = $sqlt_schema;
2296 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2297 my $t = SQL::Translator->new($sqltargs);
2302 or $self->throw_exception ($t->error);
2304 my $out = $t->translate( $filename )
2305 or $self->throw_exception ($t->error);
2307 $dest_schema = $t->schema;
2309 $dest_schema->name( $filename )
2310 unless $dest_schema->name;
2313 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2317 if(!open $file, ">$difffile") {
2318 $self->throw_exception("Can't write to $difffile ($!)");
2326 =head2 deployment_statements
2330 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2334 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2336 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2337 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2339 C<$directory> is used to return statements from files in a previously created
2340 L</create_ddl_dir> directory and is optional. The filenames are constructed
2341 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2343 If no C<$directory> is specified then the statements are constructed on the
2344 fly using L<SQL::Translator> and C<$version> is ignored.
2346 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2350 sub deployment_statements {
2351 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2352 $type ||= $self->sqlt_type;
2353 $version ||= $schema->schema_version || '1.x';
2355 my $filename = $schema->ddl_filename($type, $version, $dir);
2359 open($file, "<$filename")
2360 or $self->throw_exception("Can't open $filename ($!)");
2363 return join('', @rows);
2366 $self->throw_exception(q{Can't deploy without SQL::Translator 0.09003: '}
2367 . $self->_check_sqlt_message . q{'})
2368 if !$self->_check_sqlt_version;
2370 # sources needs to be a parser arg, but for simplicty allow at top level
2372 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2373 if exists $sqltargs->{sources};
2375 my $tr = SQL::Translator->new(
2376 producer => "SQL::Translator::Producer::${type}",
2378 parser => 'SQL::Translator::Parser::DBIx::Class',
2381 return $tr->translate;
2385 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2388 return if($line =~ /^--/);
2390 # next if($line =~ /^DROP/m);
2391 return if($line =~ /^BEGIN TRANSACTION/m);
2392 return if($line =~ /^COMMIT/m);
2393 return if $line =~ /^\s+$/; # skip whitespace only
2394 $self->_query_start($line);
2396 # do a dbh_do cycle here, as we need some error checking in
2397 # place (even though we will ignore errors)
2398 $self->dbh_do (sub { $_[1]->do($line) });
2401 carp qq{$@ (running "${line}")};
2403 $self->_query_end($line);
2405 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2406 if (@statements > 1) {
2407 foreach my $statement (@statements) {
2408 $deploy->( $statement );
2411 elsif (@statements == 1) {
2412 foreach my $line ( split(";\n", $statements[0])) {
2418 =head2 datetime_parser
2420 Returns the datetime parser class
2424 sub datetime_parser {
2426 return $self->{datetime_parser} ||= do {
2427 $self->_populate_dbh unless $self->_dbh;
2428 $self->build_datetime_parser(@_);
2432 =head2 datetime_parser_type
2434 Defines (returns) the datetime parser class - currently hardwired to
2435 L<DateTime::Format::MySQL>
2439 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2441 =head2 build_datetime_parser
2443 See L</datetime_parser>
2447 sub build_datetime_parser {
2449 my $type = $self->datetime_parser_type(@_);
2451 $self->throw_exception("Couldn't load ${type}: $@") if $@;
2456 my $_check_sqlt_version; # private
2457 my $_check_sqlt_message; # private
2458 sub _check_sqlt_version {
2459 return $_check_sqlt_version if defined $_check_sqlt_version;
2460 eval 'use SQL::Translator "0.09003"';
2461 $_check_sqlt_message = $@ || '';
2462 $_check_sqlt_version = !$@;
2465 sub _check_sqlt_message {
2466 _check_sqlt_version if !defined $_check_sqlt_message;
2467 $_check_sqlt_message;
2471 =head2 is_replicating
2473 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2474 replicate from a master database. Default is undef, which is the result
2475 returned by databases that don't support replication.
2479 sub is_replicating {
2484 =head2 lag_behind_master
2486 Returns a number that represents a certain amount of lag behind a master db
2487 when a given storage is replicating. The number is database dependent, but
2488 starts at zero and increases with the amount of lag. Default in undef
2492 sub lag_behind_master {
2498 $self->_verify_pid if $self->_dbh;
2500 # some databases need this to stop spewing warnings
2501 if (my $dbh = $self->_dbh) {
2502 eval { $dbh->disconnect };
2512 =head2 DBIx::Class and AutoCommit
2514 DBIx::Class can do some wonderful magic with handling exceptions,
2515 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2516 (the default) combined with C<txn_do> for transaction support.
2518 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2519 in an assumed transaction between commits, and you're telling us you'd
2520 like to manage that manually. A lot of the magic protections offered by
2521 this module will go away. We can't protect you from exceptions due to database
2522 disconnects because we don't know anything about how to restart your
2523 transactions. You're on your own for handling all sorts of exceptional
2524 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2530 Matt S. Trout <mst@shadowcatsystems.co.uk>
2532 Andy Grundman <andy@hybridized.org>
2536 You may distribute this code under the same terms as Perl itself.