1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base qw/DBIx::Class::Storage::DBIHacks DBIx::Class::Storage/;
10 use Carp::Clan qw/^DBIx::Class|^Try::Tiny/;
12 use DBIx::Class::Storage::DBI::Cursor;
13 use DBIx::Class::Storage::Statistics;
14 use Scalar::Util qw/refaddr weaken reftype blessed/;
15 use Data::Dumper::Concise 'Dumper';
16 use Sub::Name 'subname';
18 use File::Path 'make_path';
22 # default cursor class, overridable in connect_info attributes
23 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
25 __PACKAGE__->mk_group_accessors('inherited' => qw/sql_maker_class sql_limit_dialect/);
26 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
28 __PACKAGE__->mk_group_accessors('simple' => qw/
29 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
30 _dbh _dbh_details _conn_pid _conn_tid _sql_maker _sql_maker_opts
31 transaction_depth _dbh_autocommit savepoints
34 # the values for these accessors are picked out (and deleted) from
35 # the attribute hashref passed to connect_info
36 my @storage_options = qw/
37 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
38 disable_sth_caching unsafe auto_savepoint
40 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
43 # capability definitions, using a 2-tiered accessor system
46 # A driver/user may define _use_X, which blindly without any checks says:
47 # "(do not) use this capability", (use_dbms_capability is an "inherited"
50 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
51 # accessor, which in turn calls _determine_supports_X, and stores the return
52 # in a special slot on the storage object, which is wiped every time a $dbh
53 # reconnection takes place (it is not guaranteed that upon reconnection we
54 # will get the same rdbms version). _determine_supports_X does not need to
55 # exist on a driver, as we ->can for it before calling.
57 my @capabilities = (qw/insert_returning placeholders typeless_placeholders/);
58 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
59 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } @capabilities );
62 # Each of these methods need _determine_driver called before itself
63 # in order to function reliably. This is a purely DRY optimization
65 # get_(use)_dbms_capability need to be called on the correct Storage
66 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
67 # _determine_supports_X which obv. needs a correct driver as well
68 my @rdbms_specific_methods = qw/
82 get_use_dbms_capability
89 for my $meth (@rdbms_specific_methods) {
91 my $orig = __PACKAGE__->can ($meth)
92 or die "$meth is not a ::Storage::DBI method!";
95 no warnings qw/redefine/;
96 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
97 if (not $_[0]->_driver_determined and not $_[0]->{_in_determine_driver}) {
98 $_[0]->_determine_driver;
100 # This for some reason crashes and burns on perl 5.8.1
101 # IFF the method ends up throwing an exception
102 #goto $_[0]->can ($meth);
104 my $cref = $_[0]->can ($meth);
114 DBIx::Class::Storage::DBI - DBI storage handler
118 my $schema = MySchema->connect('dbi:SQLite:my.db');
120 $schema->storage->debug(1);
122 my @stuff = $schema->storage->dbh_do(
124 my ($storage, $dbh, @args) = @_;
125 $dbh->do("DROP TABLE authors");
130 $schema->resultset('Book')->search({
131 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
136 This class represents the connection to an RDBMS via L<DBI>. See
137 L<DBIx::Class::Storage> for general information. This pod only
138 documents DBI-specific methods and behaviors.
145 my $new = shift->next::method(@_);
147 $new->transaction_depth(0);
148 $new->_sql_maker_opts({});
149 $new->_dbh_details({});
150 $new->{savepoints} = [];
151 $new->{_in_dbh_do} = 0;
152 $new->{_dbh_gen} = 0;
154 # read below to see what this does
155 $new->_arm_global_destructor;
160 # This is hack to work around perl shooting stuff in random
161 # order on exit(). If we do not walk the remaining storage
162 # objects in an END block, there is a *small but real* chance
163 # of a fork()ed child to kill the parent's shared DBI handle,
164 # *before perl reaches the DESTROY in this package*
165 # Yes, it is ugly and effective.
167 my %seek_and_destroy;
169 sub _arm_global_destructor {
171 my $key = Scalar::Util::refaddr ($self);
172 $seek_and_destroy{$key} = $self;
173 Scalar::Util::weaken ($seek_and_destroy{$key});
177 local $?; # just in case the DBI destructor changes it somehow
179 # destroy just the object if not native to this process/thread
180 $_->_preserve_foreign_dbh for (grep
182 values %seek_and_destroy
190 # some databases spew warnings on implicit disconnect
191 local $SIG{__WARN__} = sub {};
195 sub _preserve_foreign_dbh {
198 return unless $self->_dbh;
202 return unless $self->_dbh;
208 # handle pid changes correctly - do not destroy parent's connection
212 return if ( defined $self->_conn_pid and $self->_conn_pid == $$ );
214 $self->_dbh->{InactiveDestroy} = 1;
221 # very similar to above, but seems to FAIL if I set InactiveDestroy
225 if ( ! defined $self->_conn_tid ) {
228 elsif ( $self->_conn_tid == threads->tid ) {
229 return; # same thread
232 #$self->_dbh->{InactiveDestroy} = 1; # why does t/51threads.t fail...?
242 This method is normally called by L<DBIx::Class::Schema/connection>, which
243 encapsulates its argument list in an arrayref before passing them here.
245 The argument list may contain:
251 The same 4-element argument set one would normally pass to
252 L<DBI/connect>, optionally followed by
253 L<extra attributes|/DBIx::Class specific connection attributes>
254 recognized by DBIx::Class:
256 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
260 A single code reference which returns a connected
261 L<DBI database handle|DBI/connect> optionally followed by
262 L<extra attributes|/DBIx::Class specific connection attributes> recognized
265 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
269 A single hashref with all the attributes and the dsn/user/password
272 $connect_info_args = [{
280 $connect_info_args = [{
281 dbh_maker => sub { DBI->connect (...) },
286 This is particularly useful for L<Catalyst> based applications, allowing the
287 following config (L<Config::General> style):
292 dsn dbi:mysql:database=test
299 The C<dsn>/C<user>/C<password> combination can be substituted by the
300 C<dbh_maker> key whose value is a coderef that returns a connected
301 L<DBI database handle|DBI/connect>
305 Please note that the L<DBI> docs recommend that you always explicitly
306 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
307 recommends that it be set to I<1>, and that you perform transactions
308 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
309 to I<1> if you do not do explicitly set it to zero. This is the default
310 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
312 =head3 DBIx::Class specific connection attributes
314 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
315 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
316 the following connection options. These options can be mixed in with your other
317 L<DBI> connection attributes, or placed in a separate hashref
318 (C<\%extra_attributes>) as shown above.
320 Every time C<connect_info> is invoked, any previous settings for
321 these options will be cleared before setting the new ones, regardless of
322 whether any options are specified in the new C<connect_info>.
329 Specifies things to do immediately after connecting or re-connecting to
330 the database. Its value may contain:
336 This contains one SQL statement to execute.
338 =item an array reference
340 This contains SQL statements to execute in order. Each element contains
341 a string or a code reference that returns a string.
343 =item a code reference
345 This contains some code to execute. Unlike code references within an
346 array reference, its return value is ignored.
350 =item on_disconnect_do
352 Takes arguments in the same form as L</on_connect_do> and executes them
353 immediately before disconnecting from the database.
355 Note, this only runs if you explicitly call L</disconnect> on the
358 =item on_connect_call
360 A more generalized form of L</on_connect_do> that calls the specified
361 C<connect_call_METHOD> methods in your storage driver.
363 on_connect_do => 'select 1'
367 on_connect_call => [ [ do_sql => 'select 1' ] ]
369 Its values may contain:
375 Will call the C<connect_call_METHOD> method.
377 =item a code reference
379 Will execute C<< $code->($storage) >>
381 =item an array reference
383 Each value can be a method name or code reference.
385 =item an array of arrays
387 For each array, the first item is taken to be the C<connect_call_> method name
388 or code reference, and the rest are parameters to it.
392 Some predefined storage methods you may use:
398 Executes a SQL string or a code reference that returns a SQL string. This is
399 what L</on_connect_do> and L</on_disconnect_do> use.
407 Will execute the scalar as SQL.
411 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
412 attributes hashref and bind values.
414 =item a code reference
416 Will execute C<< $code->($storage) >> and execute the return array refs as
423 Execute any statements necessary to initialize the database session to return
424 and accept datetime/timestamp values used with
425 L<DBIx::Class::InflateColumn::DateTime>.
427 Only necessary for some databases, see your specific storage driver for
428 implementation details.
432 =item on_disconnect_call
434 Takes arguments in the same form as L</on_connect_call> and executes them
435 immediately before disconnecting from the database.
437 Calls the C<disconnect_call_METHOD> methods as opposed to the
438 C<connect_call_METHOD> methods called by L</on_connect_call>.
440 Note, this only runs if you explicitly call L</disconnect> on the
443 =item disable_sth_caching
445 If set to a true value, this option will disable the caching of
446 statement handles via L<DBI/prepare_cached>.
450 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
451 default L</sql_limit_dialect> setting of the storage (if any). For a list
452 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
456 Specifies what characters to use to quote table and column names.
458 C<quote_char> expects either a single character, in which case is it
459 is placed on either side of the table/column name, or an arrayref of length
460 2 in which case the table/column name is placed between the elements.
462 For example under MySQL you should use C<< quote_char => '`' >>, and for
463 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
467 This parameter is only useful in conjunction with C<quote_char>, and is used to
468 specify the character that separates elements (schemas, tables, columns) from
469 each other. If unspecified it defaults to the most commonly used C<.>.
473 This Storage driver normally installs its own C<HandleError>, sets
474 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
475 all database handles, including those supplied by a coderef. It does this
476 so that it can have consistent and useful error behavior.
478 If you set this option to a true value, Storage will not do its usual
479 modifications to the database handle's attributes, and instead relies on
480 the settings in your connect_info DBI options (or the values you set in
481 your connection coderef, in the case that you are connecting via coderef).
483 Note that your custom settings can cause Storage to malfunction,
484 especially if you set a C<HandleError> handler that suppresses exceptions
485 and/or disable C<RaiseError>.
489 If this option is true, L<DBIx::Class> will use savepoints when nesting
490 transactions, making it possible to recover from failure in the inner
491 transaction without having to abort all outer transactions.
495 Use this argument to supply a cursor class other than the default
496 L<DBIx::Class::Storage::DBI::Cursor>.
500 Some real-life examples of arguments to L</connect_info> and
501 L<DBIx::Class::Schema/connect>
503 # Simple SQLite connection
504 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
507 ->connect_info([ sub { DBI->connect(...) } ]);
509 # Connect via subref in hashref
511 dbh_maker => sub { DBI->connect(...) },
512 on_connect_do => 'alter session ...',
515 # A bit more complicated
522 { quote_char => q{"} },
526 # Equivalent to the previous example
532 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
536 # Same, but with hashref as argument
537 # See parse_connect_info for explanation
540 dsn => 'dbi:Pg:dbname=foo',
542 password => 'my_pg_password',
549 # Subref + DBIx::Class-specific connection options
552 sub { DBI->connect(...) },
556 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
557 disable_sth_caching => 1,
567 my ($self, $info) = @_;
569 return $self->_connect_info if !$info;
571 $self->_connect_info($info); # copy for _connect_info
573 $info = $self->_normalize_connect_info($info)
574 if ref $info eq 'ARRAY';
576 for my $storage_opt (keys %{ $info->{storage_options} }) {
577 my $value = $info->{storage_options}{$storage_opt};
579 $self->$storage_opt($value);
582 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
583 # the new set of options
584 $self->_sql_maker(undef);
585 $self->_sql_maker_opts({});
587 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
588 my $value = $info->{sql_maker_options}{$sql_maker_opt};
590 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
594 %{ $self->_default_dbi_connect_attributes || {} },
595 %{ $info->{attributes} || {} },
598 my @args = @{ $info->{arguments} };
600 $self->_dbi_connect_info([@args,
601 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
604 # save attributes them in a separate accessor so they are always
605 # introspectable, even in case of a CODE $dbhmaker
606 $self->_dbic_connect_attributes (\%attrs);
608 return $self->_connect_info;
611 sub _normalize_connect_info {
612 my ($self, $info_arg) = @_;
615 my @args = @$info_arg; # take a shallow copy for further mutilation
617 # combine/pre-parse arguments depending on invocation style
620 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
621 %attrs = %{ $args[1] || {} };
624 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
625 %attrs = %{$args[0]};
627 if (my $code = delete $attrs{dbh_maker}) {
630 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
633 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
634 . "to the result of 'dbh_maker'",
636 join (', ', map { "'$_'" } (@ignored) ),
641 @args = delete @attrs{qw/dsn user password/};
644 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
646 % { $args[3] || {} },
647 % { $args[4] || {} },
649 @args = @args[0,1,2];
652 $info{arguments} = \@args;
654 my @storage_opts = grep exists $attrs{$_},
655 @storage_options, 'cursor_class';
657 @{ $info{storage_options} }{@storage_opts} =
658 delete @attrs{@storage_opts} if @storage_opts;
660 my @sql_maker_opts = grep exists $attrs{$_},
661 qw/limit_dialect quote_char name_sep/;
663 @{ $info{sql_maker_options} }{@sql_maker_opts} =
664 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
666 $info{attributes} = \%attrs if %attrs;
671 sub _default_dbi_connect_attributes {
681 This method is deprecated in favour of setting via L</connect_info>.
685 =head2 on_disconnect_do
687 This method is deprecated in favour of setting via L</connect_info>.
691 sub _parse_connect_do {
692 my ($self, $type) = @_;
694 my $val = $self->$type;
695 return () if not defined $val;
700 push @res, [ 'do_sql', $val ];
701 } elsif (ref($val) eq 'CODE') {
703 } elsif (ref($val) eq 'ARRAY') {
704 push @res, map { [ 'do_sql', $_ ] } @$val;
706 $self->throw_exception("Invalid type for $type: ".ref($val));
714 Arguments: ($subref | $method_name), @extra_coderef_args?
716 Execute the given $subref or $method_name using the new exception-based
717 connection management.
719 The first two arguments will be the storage object that C<dbh_do> was called
720 on and a database handle to use. Any additional arguments will be passed
721 verbatim to the called subref as arguments 2 and onwards.
723 Using this (instead of $self->_dbh or $self->dbh) ensures correct
724 exception handling and reconnection (or failover in future subclasses).
726 Your subref should have no side-effects outside of the database, as
727 there is the potential for your subref to be partially double-executed
728 if the database connection was stale/dysfunctional.
732 my @stuff = $schema->storage->dbh_do(
734 my ($storage, $dbh, @cols) = @_;
735 my $cols = join(q{, }, @cols);
736 $dbh->selectrow_array("SELECT $cols FROM foo");
747 my $dbh = $self->_get_dbh;
749 return $self->$code($dbh, @_)
750 if ( $self->{_in_dbh_do} || $self->{transaction_depth} );
752 local $self->{_in_dbh_do} = 1;
754 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
757 $self->$code ($dbh, @$args);
759 $self->throw_exception($_) if $self->connected;
761 # We were not connected - reconnect and retry, but let any
762 # exception fall right through this time
763 carp "Retrying $code after catching disconnected exception: $_"
764 if $ENV{DBIC_DBIRETRY_DEBUG};
766 $self->_populate_dbh;
767 $self->$code($self->_dbh, @$args);
771 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
772 # It also informs dbh_do to bypass itself while under the direction of txn_do,
773 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
778 ref $coderef eq 'CODE' or $self->throw_exception
779 ('$coderef must be a CODE reference');
781 return $coderef->(@_) if $self->{transaction_depth} && ! $self->auto_savepoint;
783 local $self->{_in_dbh_do} = 1;
786 my $want_array = wantarray;
792 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
798 @result = $coderef->(@$args);
800 elsif(defined $want_array) {
801 $result[0] = $coderef->(@$args);
811 if(! defined $exception) { return $want_array ? @result : $result[0] }
813 if($tried++ || $self->connected) {
814 my $rollback_exception;
815 try { $self->txn_rollback } catch { $rollback_exception = shift };
816 if(defined $rollback_exception) {
817 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
818 $self->throw_exception($exception) # propagate nested rollback
819 if $rollback_exception =~ /$exception_class/;
821 $self->throw_exception(
822 "Transaction aborted: ${exception}. "
823 . "Rollback failed: ${rollback_exception}"
826 $self->throw_exception($exception)
829 # We were not connected, and was first try - reconnect and retry
831 carp "Retrying $coderef after catching disconnected exception: $exception"
832 if $ENV{DBIC_TXNRETRY_DEBUG};
833 $self->_populate_dbh;
839 Our C<disconnect> method also performs a rollback first if the
840 database is not in C<AutoCommit> mode.
850 push @actions, ( $self->on_disconnect_call || () );
851 push @actions, $self->_parse_connect_do ('on_disconnect_do');
853 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
855 $self->_dbh_rollback unless $self->_dbh_autocommit;
857 %{ $self->_dbh->{CachedKids} } = ();
858 $self->_dbh->disconnect;
864 =head2 with_deferred_fk_checks
868 =item Arguments: C<$coderef>
870 =item Return Value: The return value of $coderef
874 Storage specific method to run the code ref with FK checks deferred or
875 in MySQL's case disabled entirely.
879 # Storage subclasses should override this
880 sub with_deferred_fk_checks {
881 my ($self, $sub) = @_;
889 =item Arguments: none
891 =item Return Value: 1|0
895 Verifies that the current database handle is active and ready to execute
896 an SQL statement (e.g. the connection did not get stale, server is still
897 answering, etc.) This method is used internally by L</dbh>.
903 return 0 unless $self->_seems_connected;
906 local $self->_dbh->{RaiseError} = 1;
911 sub _seems_connected {
914 $self->_preserve_foreign_dbh;
916 my $dbh = $self->_dbh
919 return $dbh->FETCH('Active');
925 my $dbh = $self->_dbh or return 0;
930 sub ensure_connected {
933 unless ($self->connected) {
934 $self->_populate_dbh;
940 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
941 is guaranteed to be healthy by implicitly calling L</connected>, and if
942 necessary performing a reconnection before returning. Keep in mind that this
943 is very B<expensive> on some database engines. Consider using L</dbh_do>
951 if (not $self->_dbh) {
952 $self->_populate_dbh;
954 $self->ensure_connected;
959 # this is the internal "get dbh or connect (don't check)" method
962 $self->_preserve_foreign_dbh;
963 $self->_populate_dbh unless $self->_dbh;
969 unless ($self->_sql_maker) {
970 my $sql_maker_class = $self->sql_maker_class;
971 $self->ensure_class_loaded ($sql_maker_class);
973 my %opts = %{$self->_sql_maker_opts||{}};
977 $self->sql_limit_dialect
980 my $s_class = (ref $self) || $self;
982 "Your storage class ($s_class) does not set sql_limit_dialect and you "
983 . 'have not supplied an explicit limit_dialect in your connection_info. '
984 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
985 . 'databases but can be (and often is) painfully slow.'
992 $self->_sql_maker($sql_maker_class->new(
994 array_datatypes => 1,
995 limit_dialect => $dialect,
1000 return $self->_sql_maker;
1003 # nothing to do by default
1010 my @info = @{$self->_dbi_connect_info || []};
1011 $self->_dbh(undef); # in case ->connected failed we might get sent here
1012 $self->_dbh_details({}); # reset everything we know
1014 $self->_dbh($self->_connect(@info));
1016 $self->_conn_pid($$);
1017 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
1019 $self->_determine_driver;
1021 # Always set the transaction depth on connect, since
1022 # there is no transaction in progress by definition
1023 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1025 $self->_run_connection_actions unless $self->{_in_determine_driver};
1028 sub _run_connection_actions {
1032 push @actions, ( $self->on_connect_call || () );
1033 push @actions, $self->_parse_connect_do ('on_connect_do');
1035 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1040 sub set_use_dbms_capability {
1041 $_[0]->set_inherited ($_[1], $_[2]);
1044 sub get_use_dbms_capability {
1045 my ($self, $capname) = @_;
1047 my $use = $self->get_inherited ($capname);
1050 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1054 sub set_dbms_capability {
1055 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1058 sub get_dbms_capability {
1059 my ($self, $capname) = @_;
1061 my $cap = $self->_dbh_details->{capability}{$capname};
1063 unless (defined $cap) {
1064 if (my $meth = $self->can ("_determine$capname")) {
1065 $cap = $self->$meth ? 1 : 0;
1071 $self->set_dbms_capability ($capname, $cap);
1081 unless ($info = $self->_dbh_details->{info}) {
1085 my $server_version = try { $self->_get_server_version };
1087 if (defined $server_version) {
1088 $info->{dbms_version} = $server_version;
1090 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1091 my @verparts = split (/\./, $numeric_version);
1097 # consider only up to 3 version parts, iff not more than 3 digits
1099 while (@verparts && @use_parts < 3) {
1100 my $p = shift @verparts;
1102 push @use_parts, $p;
1104 push @use_parts, 0 while @use_parts < 3;
1106 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1110 $self->_dbh_details->{info} = $info;
1116 sub _get_server_version {
1117 shift->_get_dbh->get_info(18);
1120 sub _determine_driver {
1123 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1124 my $started_connected = 0;
1125 local $self->{_in_determine_driver} = 1;
1127 if (ref($self) eq __PACKAGE__) {
1129 if ($self->_dbh) { # we are connected
1130 $driver = $self->_dbh->{Driver}{Name};
1131 $started_connected = 1;
1133 # if connect_info is a CODEREF, we have no choice but to connect
1134 if (ref $self->_dbi_connect_info->[0] &&
1135 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1136 $self->_populate_dbh;
1137 $driver = $self->_dbh->{Driver}{Name};
1140 # try to use dsn to not require being connected, the driver may still
1141 # force a connection in _rebless to determine version
1142 # (dsn may not be supplied at all if all we do is make a mock-schema)
1143 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1144 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1145 $driver ||= $ENV{DBI_DRIVER};
1150 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1151 if ($self->load_optional_class($storage_class)) {
1152 mro::set_mro($storage_class, 'c3');
1153 bless $self, $storage_class;
1159 $self->_driver_determined(1);
1161 $self->_init; # run driver-specific initializations
1163 $self->_run_connection_actions
1164 if !$started_connected && defined $self->_dbh;
1168 sub _do_connection_actions {
1170 my $method_prefix = shift;
1173 if (not ref($call)) {
1174 my $method = $method_prefix . $call;
1176 } elsif (ref($call) eq 'CODE') {
1178 } elsif (ref($call) eq 'ARRAY') {
1179 if (ref($call->[0]) ne 'ARRAY') {
1180 $self->_do_connection_actions($method_prefix, $_) for @$call;
1182 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1185 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1191 sub connect_call_do_sql {
1193 $self->_do_query(@_);
1196 sub disconnect_call_do_sql {
1198 $self->_do_query(@_);
1201 # override in db-specific backend when necessary
1202 sub connect_call_datetime_setup { 1 }
1205 my ($self, $action) = @_;
1207 if (ref $action eq 'CODE') {
1208 $action = $action->($self);
1209 $self->_do_query($_) foreach @$action;
1212 # Most debuggers expect ($sql, @bind), so we need to exclude
1213 # the attribute hash which is the second argument to $dbh->do
1214 # furthermore the bind values are usually to be presented
1215 # as named arrayref pairs, so wrap those here too
1216 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1217 my $sql = shift @do_args;
1218 my $attrs = shift @do_args;
1219 my @bind = map { [ undef, $_ ] } @do_args;
1221 $self->_query_start($sql, @bind);
1222 $self->_get_dbh->do($sql, $attrs, @do_args);
1223 $self->_query_end($sql, @bind);
1230 my ($self, @info) = @_;
1232 $self->throw_exception("You failed to provide any connection info")
1235 my ($old_connect_via, $dbh);
1237 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1238 $old_connect_via = $DBI::connect_via;
1239 $DBI::connect_via = 'connect';
1243 if(ref $info[0] eq 'CODE') {
1244 $dbh = $info[0]->();
1247 $dbh = DBI->connect(@info);
1254 unless ($self->unsafe) {
1256 # this odd anonymous coderef dereference is in fact really
1257 # necessary to avoid the unwanted effect described in perl5
1260 my $weak_self = $_[0];
1263 $_[1]->{HandleError} = sub {
1265 $weak_self->throw_exception("DBI Exception: $_[0]");
1268 # the handler may be invoked by something totally out of
1270 croak ("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1275 $dbh->{ShowErrorStatement} = 1;
1276 $dbh->{RaiseError} = 1;
1277 $dbh->{PrintError} = 0;
1281 $self->throw_exception("DBI Connection failed: $_")
1284 $DBI::connect_via = $old_connect_via if $old_connect_via;
1287 $self->_dbh_autocommit($dbh->{AutoCommit});
1292 my ($self, $name) = @_;
1294 $name = $self->_svp_generate_name
1295 unless defined $name;
1297 $self->throw_exception ("You can't use savepoints outside a transaction")
1298 if $self->{transaction_depth} == 0;
1300 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1301 unless $self->can('_svp_begin');
1303 push @{ $self->{savepoints} }, $name;
1305 $self->debugobj->svp_begin($name) if $self->debug;
1307 return $self->_svp_begin($name);
1311 my ($self, $name) = @_;
1313 $self->throw_exception ("You can't use savepoints outside a transaction")
1314 if $self->{transaction_depth} == 0;
1316 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1317 unless $self->can('_svp_release');
1319 if (defined $name) {
1320 $self->throw_exception ("Savepoint '$name' does not exist")
1321 unless grep { $_ eq $name } @{ $self->{savepoints} };
1323 # Dig through the stack until we find the one we are releasing. This keeps
1324 # the stack up to date.
1327 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1329 $name = pop @{ $self->{savepoints} };
1332 $self->debugobj->svp_release($name) if $self->debug;
1334 return $self->_svp_release($name);
1338 my ($self, $name) = @_;
1340 $self->throw_exception ("You can't use savepoints outside a transaction")
1341 if $self->{transaction_depth} == 0;
1343 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1344 unless $self->can('_svp_rollback');
1346 if (defined $name) {
1347 # If they passed us a name, verify that it exists in the stack
1348 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1349 $self->throw_exception("Savepoint '$name' does not exist!");
1352 # Dig through the stack until we find the one we are releasing. This keeps
1353 # the stack up to date.
1354 while(my $s = pop(@{ $self->{savepoints} })) {
1355 last if($s eq $name);
1357 # Add the savepoint back to the stack, as a rollback doesn't remove the
1358 # named savepoint, only everything after it.
1359 push(@{ $self->{savepoints} }, $name);
1361 # We'll assume they want to rollback to the last savepoint
1362 $name = $self->{savepoints}->[-1];
1365 $self->debugobj->svp_rollback($name) if $self->debug;
1367 return $self->_svp_rollback($name);
1370 sub _svp_generate_name {
1373 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1379 # this means we have not yet connected and do not know the AC status
1380 # (e.g. coderef $dbh)
1381 $self->ensure_connected if (! defined $self->_dbh_autocommit);
1383 if($self->{transaction_depth} == 0) {
1384 $self->debugobj->txn_begin()
1386 $self->_dbh_begin_work;
1388 elsif ($self->auto_savepoint) {
1391 $self->{transaction_depth}++;
1394 sub _dbh_begin_work {
1397 # if the user is utilizing txn_do - good for him, otherwise we need to
1398 # ensure that the $dbh is healthy on BEGIN.
1399 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1400 # will be replaced by a failure of begin_work itself (which will be
1401 # then retried on reconnect)
1402 if ($self->{_in_dbh_do}) {
1403 $self->_dbh->begin_work;
1405 $self->dbh_do(sub { $_[1]->begin_work });
1411 if ($self->{transaction_depth} == 1) {
1412 $self->debugobj->txn_commit()
1415 $self->{transaction_depth} = 0
1416 if $self->_dbh_autocommit;
1418 elsif($self->{transaction_depth} > 1) {
1419 $self->{transaction_depth}--;
1421 if $self->auto_savepoint;
1427 my $dbh = $self->_dbh
1428 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1434 my $dbh = $self->_dbh;
1436 if ($self->{transaction_depth} == 1) {
1437 $self->debugobj->txn_rollback()
1439 $self->{transaction_depth} = 0
1440 if $self->_dbh_autocommit;
1441 $self->_dbh_rollback;
1443 elsif($self->{transaction_depth} > 1) {
1444 $self->{transaction_depth}--;
1445 if ($self->auto_savepoint) {
1446 $self->svp_rollback;
1451 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1455 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1457 if ($_ !~ /$exception_class/) {
1458 # ensure that a failed rollback resets the transaction depth
1459 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1462 $self->throw_exception($_)
1468 my $dbh = $self->_dbh
1469 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1473 # This used to be the top-half of _execute. It was split out to make it
1474 # easier to override in NoBindVars without duping the rest. It takes up
1475 # all of _execute's args, and emits $sql, @bind.
1476 sub _prep_for_execute {
1477 my ($self, $op, $extra_bind, $ident, $args) = @_;
1479 if( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
1480 $ident = $ident->from();
1483 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1486 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1488 return ($sql, \@bind);
1492 sub _fix_bind_params {
1493 my ($self, @bind) = @_;
1495 ### Turn @bind from something like this:
1496 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1498 ### ( "'1'", "'1'", "'3'" )
1501 if ( defined( $_ && $_->[1] ) ) {
1502 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1509 my ( $self, $sql, @bind ) = @_;
1511 if ( $self->debug ) {
1512 @bind = $self->_fix_bind_params(@bind);
1514 $self->debugobj->query_start( $sql, @bind );
1519 my ( $self, $sql, @bind ) = @_;
1521 if ( $self->debug ) {
1522 @bind = $self->_fix_bind_params(@bind);
1523 $self->debugobj->query_end( $sql, @bind );
1528 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1530 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1532 $self->_query_start( $sql, @$bind );
1534 my $sth = $self->sth($sql,$op);
1536 my $placeholder_index = 1;
1538 foreach my $bound (@$bind) {
1539 my $attributes = {};
1540 my($column_name, @data) = @$bound;
1542 if ($bind_attributes) {
1543 $attributes = $bind_attributes->{$column_name}
1544 if defined $bind_attributes->{$column_name};
1547 foreach my $data (@data) {
1548 my $ref = ref $data;
1549 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1551 $sth->bind_param($placeholder_index, $data, $attributes);
1552 $placeholder_index++;
1556 # Can this fail without throwing an exception anyways???
1557 my $rv = $sth->execute();
1558 $self->throw_exception(
1559 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1562 $self->_query_end( $sql, @$bind );
1564 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1569 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1572 sub _prefetch_insert_auto_nextvals {
1573 my ($self, $source, $to_insert) = @_;
1577 foreach my $col ( $source->columns ) {
1578 if ( !defined $to_insert->{$col} ) {
1579 my $col_info = $source->column_info($col);
1581 if ( $col_info->{auto_nextval} ) {
1582 $upd->{$col} = $to_insert->{$col} = $self->_sequence_fetch(
1584 $col_info->{sequence} ||=
1585 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1596 my ($source, $to_insert, $opts) = @_;
1598 my $updated_cols = $self->_prefetch_insert_auto_nextvals (@_);
1600 my $bind_attributes = $self->source_bind_attributes($source);
1602 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $opts);
1604 if ($opts->{returning}) {
1605 my @ret_cols = @{$opts->{returning}};
1607 my @ret_vals = try {
1608 local $SIG{__WARN__} = sub {};
1609 my @r = $sth->fetchrow_array;
1615 @ret{@ret_cols} = @ret_vals if (@ret_vals);
1623 return $updated_cols;
1626 ## Currently it is assumed that all values passed will be "normal", i.e. not
1627 ## scalar refs, or at least, all the same type as the first set, the statement is
1628 ## only prepped once.
1630 my ($self, $source, $cols, $data) = @_;
1633 @colvalues{@$cols} = (0..$#$cols);
1635 for my $i (0..$#$cols) {
1636 my $first_val = $data->[0][$i];
1637 next unless ref $first_val eq 'SCALAR';
1639 $colvalues{ $cols->[$i] } = $first_val;
1642 # check for bad data and stringify stringifiable objects
1643 my $bad_slice = sub {
1644 my ($msg, $col_idx, $slice_idx) = @_;
1645 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1649 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1651 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1657 for my $datum_idx (0..$#$data) {
1658 my $datum = $data->[$datum_idx];
1660 for my $col_idx (0..$#$cols) {
1661 my $val = $datum->[$col_idx];
1662 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1663 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1665 if ($is_literal_sql) {
1667 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1669 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1670 $bad_slice->("$reftype reference found where literal SQL expected",
1671 $col_idx, $datum_idx);
1673 elsif ($$val ne $$sqla_bind){
1674 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1675 $col_idx, $datum_idx);
1678 elsif (my $reftype = ref $val) {
1680 if (overload::Method($val, '""')) {
1681 $datum->[$col_idx] = "".$val;
1684 $bad_slice->("$reftype reference found where bind expected",
1685 $col_idx, $datum_idx);
1691 my ($sql, $bind) = $self->_prep_for_execute (
1692 'insert', undef, $source, [\%colvalues]
1696 my $empty_bind = 1 if (not @bind) &&
1697 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1699 if ((not @bind) && (not $empty_bind)) {
1700 $self->throw_exception(
1701 'Cannot insert_bulk without support for placeholders'
1705 # neither _execute_array, nor _execute_inserts_with_no_binds are
1706 # atomic (even if _execute _array is a single call). Thus a safety
1708 my $guard = $self->txn_scope_guard;
1710 $self->_query_start( $sql, [ dummy => '__BULK_INSERT__' ] );
1711 my $sth = $self->sth($sql);
1714 # bind_param_array doesn't work if there are no binds
1715 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1718 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1719 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1723 $self->_query_end( $sql, [ dummy => '__BULK_INSERT__' ] );
1727 return (wantarray ? ($rv, $sth, @bind) : $rv);
1730 sub _execute_array {
1731 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1733 ## This must be an arrayref, else nothing works!
1734 my $tuple_status = [];
1736 ## Get the bind_attributes, if any exist
1737 my $bind_attributes = $self->source_bind_attributes($source);
1739 ## Bind the values and execute
1740 my $placeholder_index = 1;
1742 foreach my $bound (@$bind) {
1744 my $attributes = {};
1745 my ($column_name, $data_index) = @$bound;
1747 if( $bind_attributes ) {
1748 $attributes = $bind_attributes->{$column_name}
1749 if defined $bind_attributes->{$column_name};
1752 my @data = map { $_->[$data_index] } @$data;
1754 $sth->bind_param_array(
1757 (%$attributes ? $attributes : ()),
1759 $placeholder_index++;
1764 $rv = $self->_dbh_execute_array($sth, $tuple_status, @extra);
1770 # Statement must finish even if there was an exception.
1775 $err = shift unless defined $err
1779 if (! defined $err and $sth->err);
1783 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1785 $self->throw_exception("Unexpected populate error: $err")
1786 if ($i > $#$tuple_status);
1788 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1789 ($tuple_status->[$i][1] || $err),
1790 Dumper { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) },
1797 sub _dbh_execute_array {
1798 my ($self, $sth, $tuple_status, @extra) = @_;
1800 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1803 sub _dbh_execute_inserts_with_no_binds {
1804 my ($self, $sth, $count) = @_;
1808 my $dbh = $self->_get_dbh;
1809 local $dbh->{RaiseError} = 1;
1810 local $dbh->{PrintError} = 0;
1812 $sth->execute foreach 1..$count;
1818 # Make sure statement is finished even if there was an exception.
1823 $err = shift unless defined $err;
1827 $self->throw_exception($err) if defined $err;
1833 my ($self, $source, @args) = @_;
1835 my $bind_attrs = $self->source_bind_attributes($source);
1837 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1842 my ($self, $source, @args) = @_;
1844 my $bind_attrs = $self->source_bind_attributes($source);
1846 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1849 # We were sent here because the $rs contains a complex search
1850 # which will require a subquery to select the correct rows
1851 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1853 # Generating a single PK column subquery is trivial and supported
1854 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1855 # Look at _multipk_update_delete()
1856 sub _subq_update_delete {
1858 my ($rs, $op, $values) = @_;
1860 my $rsrc = $rs->result_source;
1862 # quick check if we got a sane rs on our hands
1863 my @pcols = $rsrc->_pri_cols;
1865 my $sel = $rs->_resolved_attrs->{select};
1866 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1869 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1871 join ("\x00", sort @$sel )
1873 $self->throw_exception (
1874 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1881 $op eq 'update' ? $values : (),
1882 { $pcols[0] => { -in => $rs->as_query } },
1887 return $self->_multipk_update_delete (@_);
1891 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1892 # resultset update/delete involving subqueries. So by default resort
1893 # to simple (and inefficient) delete_all style per-row opearations,
1894 # while allowing specific storages to override this with a faster
1897 sub _multipk_update_delete {
1898 return shift->_per_row_update_delete (@_);
1901 # This is the default loop used to delete/update rows for multi PK
1902 # resultsets, and used by mysql exclusively (because it can't do anything
1905 # We do not use $row->$op style queries, because resultset update/delete
1906 # is not expected to cascade (this is what delete_all/update_all is for).
1908 # There should be no race conditions as the entire operation is rolled
1911 sub _per_row_update_delete {
1913 my ($rs, $op, $values) = @_;
1915 my $rsrc = $rs->result_source;
1916 my @pcols = $rsrc->_pri_cols;
1918 my $guard = $self->txn_scope_guard;
1920 # emulate the return value of $sth->execute for non-selects
1921 my $row_cnt = '0E0';
1923 my $subrs_cur = $rs->cursor;
1924 my @all_pk = $subrs_cur->all;
1925 for my $pks ( @all_pk) {
1928 for my $i (0.. $#pcols) {
1929 $cond->{$pcols[$i]} = $pks->[$i];
1934 $op eq 'update' ? $values : (),
1948 $self->_execute($self->_select_args(@_));
1951 sub _select_args_to_query {
1954 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1955 # = $self->_select_args($ident, $select, $cond, $attrs);
1956 my ($op, $bind, $ident, $bind_attrs, @args) =
1957 $self->_select_args(@_);
1959 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1960 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1961 $prepared_bind ||= [];
1964 ? ($sql, $prepared_bind, $bind_attrs)
1965 : \[ "($sql)", @$prepared_bind ]
1970 my ($self, $ident, $select, $where, $attrs) = @_;
1972 my $sql_maker = $self->sql_maker;
1973 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
1980 $rs_alias && $alias2source->{$rs_alias}
1981 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
1986 # calculate bind_attrs before possible $ident mangling
1987 my $bind_attrs = {};
1988 for my $alias (keys %$alias2source) {
1989 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
1990 for my $col (keys %$bindtypes) {
1992 my $fqcn = join ('.', $alias, $col);
1993 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
1995 # Unqialified column names are nice, but at the same time can be
1996 # rather ambiguous. What we do here is basically go along with
1997 # the loop, adding an unqualified column slot to $bind_attrs,
1998 # alongside the fully qualified name. As soon as we encounter
1999 # another column by that name (which would imply another table)
2000 # we unset the unqualified slot and never add any info to it
2001 # to avoid erroneous type binding. If this happens the users
2002 # only choice will be to fully qualify his column name
2004 if (exists $bind_attrs->{$col}) {
2005 $bind_attrs->{$col} = {};
2008 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
2013 # Sanity check the attributes (SQLMaker does it too, but
2014 # in case of a software_limit we'll never reach there)
2015 if (defined $attrs->{offset}) {
2016 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2017 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2019 $attrs->{offset} ||= 0;
2021 if (defined $attrs->{rows}) {
2022 $self->throw_exception("The rows attribute must be a positive integer if present")
2023 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2025 elsif ($attrs->{offset}) {
2026 # MySQL actually recommends this approach. I cringe.
2027 $attrs->{rows} = $sql_maker->__max_int;
2032 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2033 # storage, unless software limit was requested
2036 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2038 # grouped prefetch (to satisfy group_by == select)
2039 ( $attrs->{group_by}
2041 @{$attrs->{group_by}}
2043 $attrs->{_prefetch_select}
2045 @{$attrs->{_prefetch_select}}
2048 ($ident, $select, $where, $attrs)
2049 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2051 elsif (! $attrs->{software_limit} ) {
2052 push @limit, $attrs->{rows}, $attrs->{offset};
2055 # try to simplify the joinmap further (prune unreferenced type-single joins)
2056 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2059 # This would be the point to deflate anything found in $where
2060 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2061 # expect a row object. And all we have is a resultsource (it is trivial
2062 # to extract deflator coderefs via $alias2source above).
2064 # I don't see a way forward other than changing the way deflators are
2065 # invoked, and that's just bad...
2068 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
2071 # Returns a counting SELECT for a simple count
2072 # query. Abstracted so that a storage could override
2073 # this to { count => 'firstcol' } or whatever makes
2074 # sense as a performance optimization
2076 #my ($self, $source, $rs_attrs) = @_;
2077 return { count => '*' };
2081 sub source_bind_attributes {
2082 my ($self, $source) = @_;
2084 my $bind_attributes;
2085 foreach my $column ($source->columns) {
2087 my $data_type = $source->column_info($column)->{data_type} || '';
2088 $bind_attributes->{$column} = $self->bind_attribute_by_data_type($data_type)
2092 return $bind_attributes;
2099 =item Arguments: $ident, $select, $condition, $attrs
2103 Handle a SQL select statement.
2109 my ($ident, $select, $condition, $attrs) = @_;
2110 return $self->cursor_class->new($self, \@_, $attrs);
2115 my ($rv, $sth, @bind) = $self->_select(@_);
2116 my @row = $sth->fetchrow_array;
2117 my @nextrow = $sth->fetchrow_array if @row;
2118 if(@row && @nextrow) {
2119 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2121 # Need to call finish() to work round broken DBDs
2126 =head2 sql_limit_dialect
2128 This is an accessor for the default SQL limit dialect used by a particular
2129 storage driver. Can be overriden by supplying an explicit L</limit_dialect>
2130 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2131 see L<DBIx::Class::SQLMaker::LimitDialects>.
2137 =item Arguments: $sql
2141 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2146 my ($self, $dbh, $sql) = @_;
2148 # 3 is the if_active parameter which avoids active sth re-use
2149 my $sth = $self->disable_sth_caching
2150 ? $dbh->prepare($sql)
2151 : $dbh->prepare_cached($sql, {}, 3);
2153 # XXX You would think RaiseError would make this impossible,
2154 # but apparently that's not true :(
2155 $self->throw_exception($dbh->errstr) if !$sth;
2161 my ($self, $sql) = @_;
2162 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2165 sub _dbh_columns_info_for {
2166 my ($self, $dbh, $table) = @_;
2168 if ($dbh->can('column_info')) {
2172 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2173 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2175 while ( my $info = $sth->fetchrow_hashref() ){
2177 $column_info{data_type} = $info->{TYPE_NAME};
2178 $column_info{size} = $info->{COLUMN_SIZE};
2179 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2180 $column_info{default_value} = $info->{COLUMN_DEF};
2181 my $col_name = $info->{COLUMN_NAME};
2182 $col_name =~ s/^\"(.*)\"$/$1/;
2184 $result{$col_name} = \%column_info;
2189 return \%result if !$caught && scalar keys %result;
2193 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2195 my @columns = @{$sth->{NAME_lc}};
2196 for my $i ( 0 .. $#columns ){
2198 $column_info{data_type} = $sth->{TYPE}->[$i];
2199 $column_info{size} = $sth->{PRECISION}->[$i];
2200 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2202 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2203 $column_info{data_type} = $1;
2204 $column_info{size} = $2;
2207 $result{$columns[$i]} = \%column_info;
2211 foreach my $col (keys %result) {
2212 my $colinfo = $result{$col};
2213 my $type_num = $colinfo->{data_type};
2215 if(defined $type_num && $dbh->can('type_info')) {
2216 my $type_info = $dbh->type_info($type_num);
2217 $type_name = $type_info->{TYPE_NAME} if $type_info;
2218 $colinfo->{data_type} = $type_name if $type_name;
2225 sub columns_info_for {
2226 my ($self, $table) = @_;
2227 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2230 =head2 last_insert_id
2232 Return the row id of the last insert.
2236 sub _dbh_last_insert_id {
2237 my ($self, $dbh, $source, $col) = @_;
2239 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2241 return $id if defined $id;
2243 my $class = ref $self;
2244 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2247 sub last_insert_id {
2249 $self->_dbh_last_insert_id ($self->_dbh, @_);
2252 =head2 _native_data_type
2256 =item Arguments: $type_name
2260 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2261 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2262 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2264 The default implementation returns C<undef>, implement in your Storage driver if
2265 you need this functionality.
2267 Should map types from other databases to the native RDBMS type, for example
2268 C<VARCHAR2> to C<VARCHAR>.
2270 Types with modifiers should map to the underlying data type. For example,
2271 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2273 Composite types should map to the container type, for example
2274 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2278 sub _native_data_type {
2279 #my ($self, $data_type) = @_;
2283 # Check if placeholders are supported at all
2284 sub _determine_supports_placeholders {
2286 my $dbh = $self->_get_dbh;
2288 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2289 # but it is inaccurate more often than not
2291 local $dbh->{PrintError} = 0;
2292 local $dbh->{RaiseError} = 1;
2293 $dbh->do('select ?', {}, 1);
2301 # Check if placeholders bound to non-string types throw exceptions
2303 sub _determine_supports_typeless_placeholders {
2305 my $dbh = $self->_get_dbh;
2308 local $dbh->{PrintError} = 0;
2309 local $dbh->{RaiseError} = 1;
2310 # this specifically tests a bind that is NOT a string
2311 $dbh->do('select 1 where 1 = ?', {}, 1);
2321 Returns the database driver name.
2326 shift->_get_dbh->{Driver}->{Name};
2329 =head2 bind_attribute_by_data_type
2331 Given a datatype from column info, returns a database specific bind
2332 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2333 let the database planner just handle it.
2335 Generally only needed for special case column types, like bytea in postgres.
2339 sub bind_attribute_by_data_type {
2343 =head2 is_datatype_numeric
2345 Given a datatype from column_info, returns a boolean value indicating if
2346 the current RDBMS considers it a numeric value. This controls how
2347 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2348 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2349 be performed instead of the usual C<eq>.
2353 sub is_datatype_numeric {
2354 my ($self, $dt) = @_;
2356 return 0 unless $dt;
2358 return $dt =~ /^ (?:
2359 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2364 =head2 create_ddl_dir
2368 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2372 Creates a SQL file based on the Schema, for each of the specified
2373 database engines in C<\@databases> in the given directory.
2374 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2376 Given a previous version number, this will also create a file containing
2377 the ALTER TABLE statements to transform the previous schema into the
2378 current one. Note that these statements may contain C<DROP TABLE> or
2379 C<DROP COLUMN> statements that can potentially destroy data.
2381 The file names are created using the C<ddl_filename> method below, please
2382 override this method in your schema if you would like a different file
2383 name format. For the ALTER file, the same format is used, replacing
2384 $version in the name with "$preversion-$version".
2386 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2387 The most common value for this would be C<< { add_drop_table => 1 } >>
2388 to have the SQL produced include a C<DROP TABLE> statement for each table
2389 created. For quoting purposes supply C<quote_table_names> and
2390 C<quote_field_names>.
2392 If no arguments are passed, then the following default values are assumed:
2396 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2398 =item version - $schema->schema_version
2400 =item directory - './'
2402 =item preversion - <none>
2406 By default, C<\%sqlt_args> will have
2408 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2410 merged with the hash passed in. To disable any of those features, pass in a
2411 hashref like the following
2413 { ignore_constraint_names => 0, # ... other options }
2416 WARNING: You are strongly advised to check all SQL files created, before applying
2421 sub create_ddl_dir {
2422 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2425 carp "No directory given, using ./\n";
2430 make_path ("$dir") # make_path does not like objects (i.e. Path::Class::Dir)
2432 $self->throw_exception(
2433 "Failed to create '$dir': " . ($! || $@ || 'error unknow')
2437 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2439 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2440 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2442 my $schema_version = $schema->schema_version || '1.x';
2443 $version ||= $schema_version;
2446 add_drop_table => 1,
2447 ignore_constraint_names => 1,
2448 ignore_index_names => 1,
2452 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2453 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2456 my $sqlt = SQL::Translator->new( $sqltargs );
2458 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2459 my $sqlt_schema = $sqlt->translate({ data => $schema })
2460 or $self->throw_exception ($sqlt->error);
2462 foreach my $db (@$databases) {
2464 $sqlt->{schema} = $sqlt_schema;
2465 $sqlt->producer($db);
2468 my $filename = $schema->ddl_filename($db, $version, $dir);
2469 if (-e $filename && ($version eq $schema_version )) {
2470 # if we are dumping the current version, overwrite the DDL
2471 carp "Overwriting existing DDL file - $filename";
2475 my $output = $sqlt->translate;
2477 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2480 if(!open($file, ">$filename")) {
2481 $self->throw_exception("Can't open $filename for writing ($!)");
2484 print $file $output;
2487 next unless ($preversion);
2489 require SQL::Translator::Diff;
2491 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2492 if(!-e $prefilename) {
2493 carp("No previous schema file found ($prefilename)");
2497 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2499 carp("Overwriting existing diff file - $difffile");
2505 my $t = SQL::Translator->new($sqltargs);
2510 or $self->throw_exception ($t->error);
2512 my $out = $t->translate( $prefilename )
2513 or $self->throw_exception ($t->error);
2515 $source_schema = $t->schema;
2517 $source_schema->name( $prefilename )
2518 unless ( $source_schema->name );
2521 # The "new" style of producers have sane normalization and can support
2522 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2523 # And we have to diff parsed SQL against parsed SQL.
2524 my $dest_schema = $sqlt_schema;
2526 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2527 my $t = SQL::Translator->new($sqltargs);
2532 or $self->throw_exception ($t->error);
2534 my $out = $t->translate( $filename )
2535 or $self->throw_exception ($t->error);
2537 $dest_schema = $t->schema;
2539 $dest_schema->name( $filename )
2540 unless $dest_schema->name;
2543 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2547 if(!open $file, ">$difffile") {
2548 $self->throw_exception("Can't write to $difffile ($!)");
2556 =head2 deployment_statements
2560 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2564 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2566 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2567 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2569 C<$directory> is used to return statements from files in a previously created
2570 L</create_ddl_dir> directory and is optional. The filenames are constructed
2571 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2573 If no C<$directory> is specified then the statements are constructed on the
2574 fly using L<SQL::Translator> and C<$version> is ignored.
2576 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2580 sub deployment_statements {
2581 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2582 $type ||= $self->sqlt_type;
2583 $version ||= $schema->schema_version || '1.x';
2585 my $filename = $schema->ddl_filename($type, $version, $dir);
2589 open($file, "<$filename")
2590 or $self->throw_exception("Can't open $filename ($!)");
2593 return join('', @rows);
2596 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2597 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2600 # sources needs to be a parser arg, but for simplicty allow at top level
2602 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2603 if exists $sqltargs->{sources};
2605 my $tr = SQL::Translator->new(
2606 producer => "SQL::Translator::Producer::${type}",
2608 parser => 'SQL::Translator::Parser::DBIx::Class',
2615 @ret = $tr->translate;
2618 $ret[0] = $tr->translate;
2621 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2622 unless (@ret && defined $ret[0]);
2624 return $wa ? @ret : $ret[0];
2628 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2631 return if($line =~ /^--/);
2633 # next if($line =~ /^DROP/m);
2634 return if($line =~ /^BEGIN TRANSACTION/m);
2635 return if($line =~ /^COMMIT/m);
2636 return if $line =~ /^\s+$/; # skip whitespace only
2637 $self->_query_start($line);
2639 # do a dbh_do cycle here, as we need some error checking in
2640 # place (even though we will ignore errors)
2641 $self->dbh_do (sub { $_[1]->do($line) });
2643 carp qq{$_ (running "${line}")};
2645 $self->_query_end($line);
2647 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2648 if (@statements > 1) {
2649 foreach my $statement (@statements) {
2650 $deploy->( $statement );
2653 elsif (@statements == 1) {
2654 foreach my $line ( split(";\n", $statements[0])) {
2660 =head2 datetime_parser
2662 Returns the datetime parser class
2666 sub datetime_parser {
2668 return $self->{datetime_parser} ||= do {
2669 $self->build_datetime_parser(@_);
2673 =head2 datetime_parser_type
2675 Defines (returns) the datetime parser class - currently hardwired to
2676 L<DateTime::Format::MySQL>
2680 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2682 =head2 build_datetime_parser
2684 See L</datetime_parser>
2688 sub build_datetime_parser {
2690 my $type = $self->datetime_parser_type(@_);
2691 $self->ensure_class_loaded ($type);
2696 =head2 is_replicating
2698 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2699 replicate from a master database. Default is undef, which is the result
2700 returned by databases that don't support replication.
2704 sub is_replicating {
2709 =head2 lag_behind_master
2711 Returns a number that represents a certain amount of lag behind a master db
2712 when a given storage is replicating. The number is database dependent, but
2713 starts at zero and increases with the amount of lag. Default in undef
2717 sub lag_behind_master {
2721 =head2 relname_to_table_alias
2725 =item Arguments: $relname, $join_count
2729 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2732 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2733 way these aliases are named.
2735 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2736 otherwise C<"$relname">.
2740 sub relname_to_table_alias {
2741 my ($self, $relname, $join_count) = @_;
2743 my $alias = ($join_count && $join_count > 1 ?
2744 join('_', $relname, $join_count) : $relname);
2753 =head2 DBIx::Class and AutoCommit
2755 DBIx::Class can do some wonderful magic with handling exceptions,
2756 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2757 (the default) combined with C<txn_do> for transaction support.
2759 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2760 in an assumed transaction between commits, and you're telling us you'd
2761 like to manage that manually. A lot of the magic protections offered by
2762 this module will go away. We can't protect you from exceptions due to database
2763 disconnects because we don't know anything about how to restart your
2764 transactions. You're on your own for handling all sorts of exceptional
2765 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2771 Matt S. Trout <mst@shadowcatsystems.co.uk>
2773 Andy Grundman <andy@hybridized.org>
2777 You may distribute this code under the same terms as Perl itself.