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 join_optimizer/);
58 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
59 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
61 # on by default, not strictly a capability (pending rewrite)
62 __PACKAGE__->_use_join_optimizer (1);
63 sub _determine_supports_join_optimizer { 1 };
65 # Each of these methods need _determine_driver called before itself
66 # in order to function reliably. This is a purely DRY optimization
68 # get_(use)_dbms_capability need to be called on the correct Storage
69 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
70 # _determine_supports_X which obv. needs a correct driver as well
71 my @rdbms_specific_methods = qw/
85 get_use_dbms_capability
92 for my $meth (@rdbms_specific_methods) {
94 my $orig = __PACKAGE__->can ($meth)
95 or die "$meth is not a ::Storage::DBI method!";
98 no warnings qw/redefine/;
99 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
100 if (not $_[0]->_driver_determined and not $_[0]->{_in_determine_driver}) {
101 $_[0]->_determine_driver;
103 # This for some reason crashes and burns on perl 5.8.1
104 # IFF the method ends up throwing an exception
105 #goto $_[0]->can ($meth);
107 my $cref = $_[0]->can ($meth);
117 DBIx::Class::Storage::DBI - DBI storage handler
121 my $schema = MySchema->connect('dbi:SQLite:my.db');
123 $schema->storage->debug(1);
125 my @stuff = $schema->storage->dbh_do(
127 my ($storage, $dbh, @args) = @_;
128 $dbh->do("DROP TABLE authors");
133 $schema->resultset('Book')->search({
134 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
139 This class represents the connection to an RDBMS via L<DBI>. See
140 L<DBIx::Class::Storage> for general information. This pod only
141 documents DBI-specific methods and behaviors.
148 my $new = shift->next::method(@_);
150 $new->transaction_depth(0);
151 $new->_sql_maker_opts({});
152 $new->_dbh_details({});
153 $new->{savepoints} = [];
154 $new->{_in_dbh_do} = 0;
155 $new->{_dbh_gen} = 0;
157 # read below to see what this does
158 $new->_arm_global_destructor;
163 # This is hack to work around perl shooting stuff in random
164 # order on exit(). If we do not walk the remaining storage
165 # objects in an END block, there is a *small but real* chance
166 # of a fork()ed child to kill the parent's shared DBI handle,
167 # *before perl reaches the DESTROY in this package*
168 # Yes, it is ugly and effective.
170 my %seek_and_destroy;
172 sub _arm_global_destructor {
174 my $key = refaddr ($self);
175 $seek_and_destroy{$key} = $self;
176 weaken ($seek_and_destroy{$key});
180 local $?; # just in case the DBI destructor changes it somehow
182 # destroy just the object if not native to this process/thread
183 $_->_preserve_foreign_dbh for (grep
185 values %seek_and_destroy
193 # some databases spew warnings on implicit disconnect
194 local $SIG{__WARN__} = sub {};
198 sub _preserve_foreign_dbh {
201 return unless $self->_dbh;
205 return unless $self->_dbh;
211 # handle pid changes correctly - do not destroy parent's connection
215 return if ( defined $self->_conn_pid and $self->_conn_pid == $$ );
217 $self->_dbh->{InactiveDestroy} = 1;
224 # very similar to above, but seems to FAIL if I set InactiveDestroy
228 if ( ! defined $self->_conn_tid ) {
231 elsif ( $self->_conn_tid == threads->tid ) {
232 return; # same thread
235 #$self->_dbh->{InactiveDestroy} = 1; # why does t/51threads.t fail...?
245 This method is normally called by L<DBIx::Class::Schema/connection>, which
246 encapsulates its argument list in an arrayref before passing them here.
248 The argument list may contain:
254 The same 4-element argument set one would normally pass to
255 L<DBI/connect>, optionally followed by
256 L<extra attributes|/DBIx::Class specific connection attributes>
257 recognized by DBIx::Class:
259 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
263 A single code reference which returns a connected
264 L<DBI database handle|DBI/connect> optionally followed by
265 L<extra attributes|/DBIx::Class specific connection attributes> recognized
268 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
272 A single hashref with all the attributes and the dsn/user/password
275 $connect_info_args = [{
283 $connect_info_args = [{
284 dbh_maker => sub { DBI->connect (...) },
289 This is particularly useful for L<Catalyst> based applications, allowing the
290 following config (L<Config::General> style):
295 dsn dbi:mysql:database=test
302 The C<dsn>/C<user>/C<password> combination can be substituted by the
303 C<dbh_maker> key whose value is a coderef that returns a connected
304 L<DBI database handle|DBI/connect>
308 Please note that the L<DBI> docs recommend that you always explicitly
309 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
310 recommends that it be set to I<1>, and that you perform transactions
311 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
312 to I<1> if you do not do explicitly set it to zero. This is the default
313 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
315 =head3 DBIx::Class specific connection attributes
317 In addition to the standard L<DBI|DBI/ATTRIBUTES_COMMON_TO_ALL_HANDLES>
318 L<connection|DBI/Database_Handle_Attributes> attributes, DBIx::Class recognizes
319 the following connection options. These options can be mixed in with your other
320 L<DBI> connection attributes, or placed in a separate hashref
321 (C<\%extra_attributes>) as shown above.
323 Every time C<connect_info> is invoked, any previous settings for
324 these options will be cleared before setting the new ones, regardless of
325 whether any options are specified in the new C<connect_info>.
332 Specifies things to do immediately after connecting or re-connecting to
333 the database. Its value may contain:
339 This contains one SQL statement to execute.
341 =item an array reference
343 This contains SQL statements to execute in order. Each element contains
344 a string or a code reference that returns a string.
346 =item a code reference
348 This contains some code to execute. Unlike code references within an
349 array reference, its return value is ignored.
353 =item on_disconnect_do
355 Takes arguments in the same form as L</on_connect_do> and executes them
356 immediately before disconnecting from the database.
358 Note, this only runs if you explicitly call L</disconnect> on the
361 =item on_connect_call
363 A more generalized form of L</on_connect_do> that calls the specified
364 C<connect_call_METHOD> methods in your storage driver.
366 on_connect_do => 'select 1'
370 on_connect_call => [ [ do_sql => 'select 1' ] ]
372 Its values may contain:
378 Will call the C<connect_call_METHOD> method.
380 =item a code reference
382 Will execute C<< $code->($storage) >>
384 =item an array reference
386 Each value can be a method name or code reference.
388 =item an array of arrays
390 For each array, the first item is taken to be the C<connect_call_> method name
391 or code reference, and the rest are parameters to it.
395 Some predefined storage methods you may use:
401 Executes a SQL string or a code reference that returns a SQL string. This is
402 what L</on_connect_do> and L</on_disconnect_do> use.
410 Will execute the scalar as SQL.
414 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
415 attributes hashref and bind values.
417 =item a code reference
419 Will execute C<< $code->($storage) >> and execute the return array refs as
426 Execute any statements necessary to initialize the database session to return
427 and accept datetime/timestamp values used with
428 L<DBIx::Class::InflateColumn::DateTime>.
430 Only necessary for some databases, see your specific storage driver for
431 implementation details.
435 =item on_disconnect_call
437 Takes arguments in the same form as L</on_connect_call> and executes them
438 immediately before disconnecting from the database.
440 Calls the C<disconnect_call_METHOD> methods as opposed to the
441 C<connect_call_METHOD> methods called by L</on_connect_call>.
443 Note, this only runs if you explicitly call L</disconnect> on the
446 =item disable_sth_caching
448 If set to a true value, this option will disable the caching of
449 statement handles via L<DBI/prepare_cached>.
453 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
454 default L</sql_limit_dialect> setting of the storage (if any). For a list
455 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
459 Specifies what characters to use to quote table and column names.
461 C<quote_char> expects either a single character, in which case is it
462 is placed on either side of the table/column name, or an arrayref of length
463 2 in which case the table/column name is placed between the elements.
465 For example under MySQL you should use C<< quote_char => '`' >>, and for
466 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
470 This parameter is only useful in conjunction with C<quote_char>, and is used to
471 specify the character that separates elements (schemas, tables, columns) from
472 each other. If unspecified it defaults to the most commonly used C<.>.
476 This Storage driver normally installs its own C<HandleError>, sets
477 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
478 all database handles, including those supplied by a coderef. It does this
479 so that it can have consistent and useful error behavior.
481 If you set this option to a true value, Storage will not do its usual
482 modifications to the database handle's attributes, and instead relies on
483 the settings in your connect_info DBI options (or the values you set in
484 your connection coderef, in the case that you are connecting via coderef).
486 Note that your custom settings can cause Storage to malfunction,
487 especially if you set a C<HandleError> handler that suppresses exceptions
488 and/or disable C<RaiseError>.
492 If this option is true, L<DBIx::Class> will use savepoints when nesting
493 transactions, making it possible to recover from failure in the inner
494 transaction without having to abort all outer transactions.
498 Use this argument to supply a cursor class other than the default
499 L<DBIx::Class::Storage::DBI::Cursor>.
503 Some real-life examples of arguments to L</connect_info> and
504 L<DBIx::Class::Schema/connect>
506 # Simple SQLite connection
507 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
510 ->connect_info([ sub { DBI->connect(...) } ]);
512 # Connect via subref in hashref
514 dbh_maker => sub { DBI->connect(...) },
515 on_connect_do => 'alter session ...',
518 # A bit more complicated
525 { quote_char => q{"} },
529 # Equivalent to the previous example
535 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
539 # Same, but with hashref as argument
540 # See parse_connect_info for explanation
543 dsn => 'dbi:Pg:dbname=foo',
545 password => 'my_pg_password',
552 # Subref + DBIx::Class-specific connection options
555 sub { DBI->connect(...) },
559 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
560 disable_sth_caching => 1,
570 my ($self, $info) = @_;
572 return $self->_connect_info if !$info;
574 $self->_connect_info($info); # copy for _connect_info
576 $info = $self->_normalize_connect_info($info)
577 if ref $info eq 'ARRAY';
579 for my $storage_opt (keys %{ $info->{storage_options} }) {
580 my $value = $info->{storage_options}{$storage_opt};
582 $self->$storage_opt($value);
585 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
586 # the new set of options
587 $self->_sql_maker(undef);
588 $self->_sql_maker_opts({});
590 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
591 my $value = $info->{sql_maker_options}{$sql_maker_opt};
593 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
597 %{ $self->_default_dbi_connect_attributes || {} },
598 %{ $info->{attributes} || {} },
601 my @args = @{ $info->{arguments} };
603 $self->_dbi_connect_info([@args,
604 %attrs && !(ref $args[0] eq 'CODE') ? \%attrs : ()]);
607 # save attributes them in a separate accessor so they are always
608 # introspectable, even in case of a CODE $dbhmaker
609 $self->_dbic_connect_attributes (\%attrs);
611 return $self->_connect_info;
614 sub _normalize_connect_info {
615 my ($self, $info_arg) = @_;
618 my @args = @$info_arg; # take a shallow copy for further mutilation
620 # combine/pre-parse arguments depending on invocation style
623 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
624 %attrs = %{ $args[1] || {} };
627 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
628 %attrs = %{$args[0]};
630 if (my $code = delete $attrs{dbh_maker}) {
633 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
636 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
637 . "to the result of 'dbh_maker'",
639 join (', ', map { "'$_'" } (@ignored) ),
644 @args = delete @attrs{qw/dsn user password/};
647 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
649 % { $args[3] || {} },
650 % { $args[4] || {} },
652 @args = @args[0,1,2];
655 $info{arguments} = \@args;
657 my @storage_opts = grep exists $attrs{$_},
658 @storage_options, 'cursor_class';
660 @{ $info{storage_options} }{@storage_opts} =
661 delete @attrs{@storage_opts} if @storage_opts;
663 my @sql_maker_opts = grep exists $attrs{$_},
664 qw/limit_dialect quote_char name_sep/;
666 @{ $info{sql_maker_options} }{@sql_maker_opts} =
667 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
669 $info{attributes} = \%attrs if %attrs;
674 sub _default_dbi_connect_attributes {
684 This method is deprecated in favour of setting via L</connect_info>.
688 =head2 on_disconnect_do
690 This method is deprecated in favour of setting via L</connect_info>.
694 sub _parse_connect_do {
695 my ($self, $type) = @_;
697 my $val = $self->$type;
698 return () if not defined $val;
703 push @res, [ 'do_sql', $val ];
704 } elsif (ref($val) eq 'CODE') {
706 } elsif (ref($val) eq 'ARRAY') {
707 push @res, map { [ 'do_sql', $_ ] } @$val;
709 $self->throw_exception("Invalid type for $type: ".ref($val));
717 Arguments: ($subref | $method_name), @extra_coderef_args?
719 Execute the given $subref or $method_name using the new exception-based
720 connection management.
722 The first two arguments will be the storage object that C<dbh_do> was called
723 on and a database handle to use. Any additional arguments will be passed
724 verbatim to the called subref as arguments 2 and onwards.
726 Using this (instead of $self->_dbh or $self->dbh) ensures correct
727 exception handling and reconnection (or failover in future subclasses).
729 Your subref should have no side-effects outside of the database, as
730 there is the potential for your subref to be partially double-executed
731 if the database connection was stale/dysfunctional.
735 my @stuff = $schema->storage->dbh_do(
737 my ($storage, $dbh, @cols) = @_;
738 my $cols = join(q{, }, @cols);
739 $dbh->selectrow_array("SELECT $cols FROM foo");
750 my $dbh = $self->_get_dbh;
752 return $self->$code($dbh, @_)
753 if ( $self->{_in_dbh_do} || $self->{transaction_depth} );
755 local $self->{_in_dbh_do} = 1;
757 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
760 $self->$code ($dbh, @$args);
762 $self->throw_exception($_) if $self->connected;
764 # We were not connected - reconnect and retry, but let any
765 # exception fall right through this time
766 carp "Retrying $code after catching disconnected exception: $_"
767 if $ENV{DBIC_DBIRETRY_DEBUG};
769 $self->_populate_dbh;
770 $self->$code($self->_dbh, @$args);
774 # This is basically a blend of dbh_do above and DBIx::Class::Storage::txn_do.
775 # It also informs dbh_do to bypass itself while under the direction of txn_do,
776 # via $self->{_in_dbh_do} (this saves some redundant eval and errorcheck, etc)
781 ref $coderef eq 'CODE' or $self->throw_exception
782 ('$coderef must be a CODE reference');
784 local $self->{_in_dbh_do} = 1;
787 my $want_array = wantarray;
793 # take a ref instead of a copy, to preserve coderef @_ aliasing semantics
798 my $txn_start_depth = $self->transaction_depth;
800 @result = $coderef->(@$args);
802 elsif(defined $want_array) {
803 $result[0] = $coderef->(@$args);
809 my $delta_txn = $txn_start_depth - $self->transaction_depth;
810 if ($delta_txn == 0) {
813 elsif ($delta_txn != 1) {
814 # an off-by-one would mean we fired a rollback
815 carp "Unexpected reduction of transaction depth by $delta_txn after execution of $coderef";
821 if(! defined $exception) { return $want_array ? @result : $result[0] }
823 if($self->transaction_depth > 1 || $tried++ || $self->connected) {
824 my $rollback_exception;
825 try { $self->txn_rollback } catch { $rollback_exception = shift };
826 if(defined $rollback_exception) {
827 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
828 $self->throw_exception($exception) # propagate nested rollback
829 if $rollback_exception =~ /$exception_class/;
831 $self->throw_exception(
832 "Transaction aborted: ${exception}. "
833 . "Rollback failed: ${rollback_exception}"
836 $self->throw_exception($exception)
839 # We were not connected, and was first try - reconnect and retry
841 carp "Retrying $coderef after catching disconnected exception: $exception"
842 if $ENV{DBIC_TXNRETRY_DEBUG};
843 $self->_populate_dbh;
849 Our C<disconnect> method also performs a rollback first if the
850 database is not in C<AutoCommit> mode.
860 push @actions, ( $self->on_disconnect_call || () );
861 push @actions, $self->_parse_connect_do ('on_disconnect_do');
863 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
865 $self->_dbh_rollback unless $self->_dbh_autocommit;
867 %{ $self->_dbh->{CachedKids} } = ();
868 $self->_dbh->disconnect;
874 =head2 with_deferred_fk_checks
878 =item Arguments: C<$coderef>
880 =item Return Value: The return value of $coderef
884 Storage specific method to run the code ref with FK checks deferred or
885 in MySQL's case disabled entirely.
889 # Storage subclasses should override this
890 sub with_deferred_fk_checks {
891 my ($self, $sub) = @_;
899 =item Arguments: none
901 =item Return Value: 1|0
905 Verifies that the current database handle is active and ready to execute
906 an SQL statement (e.g. the connection did not get stale, server is still
907 answering, etc.) This method is used internally by L</dbh>.
913 return 0 unless $self->_seems_connected;
916 local $self->_dbh->{RaiseError} = 1;
921 sub _seems_connected {
924 $self->_preserve_foreign_dbh;
926 my $dbh = $self->_dbh
929 return $dbh->FETCH('Active');
935 my $dbh = $self->_dbh or return 0;
940 sub ensure_connected {
943 unless ($self->connected) {
944 $self->_populate_dbh;
950 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
951 is guaranteed to be healthy by implicitly calling L</connected>, and if
952 necessary performing a reconnection before returning. Keep in mind that this
953 is very B<expensive> on some database engines. Consider using L</dbh_do>
961 if (not $self->_dbh) {
962 $self->_populate_dbh;
964 $self->ensure_connected;
969 # this is the internal "get dbh or connect (don't check)" method
972 $self->_preserve_foreign_dbh;
973 $self->_populate_dbh unless $self->_dbh;
979 unless ($self->_sql_maker) {
980 my $sql_maker_class = $self->sql_maker_class;
981 $self->ensure_class_loaded ($sql_maker_class);
983 my %opts = %{$self->_sql_maker_opts||{}};
987 $self->sql_limit_dialect
990 my $s_class = (ref $self) || $self;
992 "Your storage class ($s_class) does not set sql_limit_dialect and you "
993 . 'have not supplied an explicit limit_dialect in your connection_info. '
994 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
995 . 'databases but can be (and often is) painfully slow.'
1002 $self->_sql_maker($sql_maker_class->new(
1003 bindtype=>'columns',
1004 array_datatypes => 1,
1005 limit_dialect => $dialect,
1010 return $self->_sql_maker;
1013 # nothing to do by default
1020 my @info = @{$self->_dbi_connect_info || []};
1021 $self->_dbh(undef); # in case ->connected failed we might get sent here
1022 $self->_dbh_details({}); # reset everything we know
1024 $self->_dbh($self->_connect(@info));
1026 $self->_conn_pid($$);
1027 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
1029 $self->_determine_driver;
1031 # Always set the transaction depth on connect, since
1032 # there is no transaction in progress by definition
1033 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1035 $self->_run_connection_actions unless $self->{_in_determine_driver};
1038 sub _run_connection_actions {
1042 push @actions, ( $self->on_connect_call || () );
1043 push @actions, $self->_parse_connect_do ('on_connect_do');
1045 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1050 sub set_use_dbms_capability {
1051 $_[0]->set_inherited ($_[1], $_[2]);
1054 sub get_use_dbms_capability {
1055 my ($self, $capname) = @_;
1057 my $use = $self->get_inherited ($capname);
1060 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1064 sub set_dbms_capability {
1065 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1068 sub get_dbms_capability {
1069 my ($self, $capname) = @_;
1071 my $cap = $self->_dbh_details->{capability}{$capname};
1073 unless (defined $cap) {
1074 if (my $meth = $self->can ("_determine$capname")) {
1075 $cap = $self->$meth ? 1 : 0;
1081 $self->set_dbms_capability ($capname, $cap);
1091 unless ($info = $self->_dbh_details->{info}) {
1095 my $server_version = try { $self->_get_server_version };
1097 if (defined $server_version) {
1098 $info->{dbms_version} = $server_version;
1100 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1101 my @verparts = split (/\./, $numeric_version);
1107 # consider only up to 3 version parts, iff not more than 3 digits
1109 while (@verparts && @use_parts < 3) {
1110 my $p = shift @verparts;
1112 push @use_parts, $p;
1114 push @use_parts, 0 while @use_parts < 3;
1116 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1120 $self->_dbh_details->{info} = $info;
1126 sub _get_server_version {
1127 shift->_get_dbh->get_info(18);
1130 sub _determine_driver {
1133 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1134 my $started_connected = 0;
1135 local $self->{_in_determine_driver} = 1;
1137 if (ref($self) eq __PACKAGE__) {
1139 if ($self->_dbh) { # we are connected
1140 $driver = $self->_dbh->{Driver}{Name};
1141 $started_connected = 1;
1143 # if connect_info is a CODEREF, we have no choice but to connect
1144 if (ref $self->_dbi_connect_info->[0] &&
1145 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1146 $self->_populate_dbh;
1147 $driver = $self->_dbh->{Driver}{Name};
1150 # try to use dsn to not require being connected, the driver may still
1151 # force a connection in _rebless to determine version
1152 # (dsn may not be supplied at all if all we do is make a mock-schema)
1153 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1154 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1155 $driver ||= $ENV{DBI_DRIVER};
1160 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1161 if ($self->load_optional_class($storage_class)) {
1162 mro::set_mro($storage_class, 'c3');
1163 bless $self, $storage_class;
1169 $self->_driver_determined(1);
1171 $self->_init; # run driver-specific initializations
1173 $self->_run_connection_actions
1174 if !$started_connected && defined $self->_dbh;
1178 sub _do_connection_actions {
1180 my $method_prefix = shift;
1183 if (not ref($call)) {
1184 my $method = $method_prefix . $call;
1186 } elsif (ref($call) eq 'CODE') {
1188 } elsif (ref($call) eq 'ARRAY') {
1189 if (ref($call->[0]) ne 'ARRAY') {
1190 $self->_do_connection_actions($method_prefix, $_) for @$call;
1192 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1195 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1201 sub connect_call_do_sql {
1203 $self->_do_query(@_);
1206 sub disconnect_call_do_sql {
1208 $self->_do_query(@_);
1211 # override in db-specific backend when necessary
1212 sub connect_call_datetime_setup { 1 }
1215 my ($self, $action) = @_;
1217 if (ref $action eq 'CODE') {
1218 $action = $action->($self);
1219 $self->_do_query($_) foreach @$action;
1222 # Most debuggers expect ($sql, @bind), so we need to exclude
1223 # the attribute hash which is the second argument to $dbh->do
1224 # furthermore the bind values are usually to be presented
1225 # as named arrayref pairs, so wrap those here too
1226 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1227 my $sql = shift @do_args;
1228 my $attrs = shift @do_args;
1229 my @bind = map { [ undef, $_ ] } @do_args;
1231 $self->_query_start($sql, @bind);
1232 $self->_get_dbh->do($sql, $attrs, @do_args);
1233 $self->_query_end($sql, @bind);
1240 my ($self, @info) = @_;
1242 $self->throw_exception("You failed to provide any connection info")
1245 my ($old_connect_via, $dbh);
1247 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
1248 $old_connect_via = $DBI::connect_via;
1249 $DBI::connect_via = 'connect';
1253 if(ref $info[0] eq 'CODE') {
1254 $dbh = $info[0]->();
1257 $dbh = DBI->connect(@info);
1264 unless ($self->unsafe) {
1266 # this odd anonymous coderef dereference is in fact really
1267 # necessary to avoid the unwanted effect described in perl5
1270 my $weak_self = $_[0];
1273 $_[1]->{HandleError} = sub {
1275 $weak_self->throw_exception("DBI Exception: $_[0]");
1278 # the handler may be invoked by something totally out of
1280 croak ("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1285 $dbh->{ShowErrorStatement} = 1;
1286 $dbh->{RaiseError} = 1;
1287 $dbh->{PrintError} = 0;
1291 $self->throw_exception("DBI Connection failed: $_")
1294 $DBI::connect_via = $old_connect_via if $old_connect_via;
1297 $self->_dbh_autocommit($dbh->{AutoCommit});
1302 my ($self, $name) = @_;
1304 $name = $self->_svp_generate_name
1305 unless defined $name;
1307 $self->throw_exception ("You can't use savepoints outside a transaction")
1308 if $self->{transaction_depth} == 0;
1310 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1311 unless $self->can('_svp_begin');
1313 push @{ $self->{savepoints} }, $name;
1315 $self->debugobj->svp_begin($name) if $self->debug;
1317 return $self->_svp_begin($name);
1321 my ($self, $name) = @_;
1323 $self->throw_exception ("You can't use savepoints outside a transaction")
1324 if $self->{transaction_depth} == 0;
1326 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1327 unless $self->can('_svp_release');
1329 if (defined $name) {
1330 $self->throw_exception ("Savepoint '$name' does not exist")
1331 unless grep { $_ eq $name } @{ $self->{savepoints} };
1333 # Dig through the stack until we find the one we are releasing. This keeps
1334 # the stack up to date.
1337 do { $svp = pop @{ $self->{savepoints} } } while $svp ne $name;
1339 $name = pop @{ $self->{savepoints} };
1342 $self->debugobj->svp_release($name) if $self->debug;
1344 return $self->_svp_release($name);
1348 my ($self, $name) = @_;
1350 $self->throw_exception ("You can't use savepoints outside a transaction")
1351 if $self->{transaction_depth} == 0;
1353 $self->throw_exception ("Your Storage implementation doesn't support savepoints")
1354 unless $self->can('_svp_rollback');
1356 if (defined $name) {
1357 # If they passed us a name, verify that it exists in the stack
1358 unless(grep({ $_ eq $name } @{ $self->{savepoints} })) {
1359 $self->throw_exception("Savepoint '$name' does not exist!");
1362 # Dig through the stack until we find the one we are releasing. This keeps
1363 # the stack up to date.
1364 while(my $s = pop(@{ $self->{savepoints} })) {
1365 last if($s eq $name);
1367 # Add the savepoint back to the stack, as a rollback doesn't remove the
1368 # named savepoint, only everything after it.
1369 push(@{ $self->{savepoints} }, $name);
1371 # We'll assume they want to rollback to the last savepoint
1372 $name = $self->{savepoints}->[-1];
1375 $self->debugobj->svp_rollback($name) if $self->debug;
1377 return $self->_svp_rollback($name);
1380 sub _svp_generate_name {
1382 return 'savepoint_'.scalar(@{ $self->{'savepoints'} });
1388 # this means we have not yet connected and do not know the AC status
1389 # (e.g. coderef $dbh)
1390 if (! defined $self->_dbh_autocommit) {
1391 $self->ensure_connected;
1393 # otherwise re-connect on pid changes, so
1394 # that the txn_depth is adjusted properly
1395 # the lightweight _get_dbh is good enoug here
1396 # (only superficial handle check, no pings)
1401 if($self->transaction_depth == 0) {
1402 $self->debugobj->txn_begin()
1404 $self->_dbh_begin_work;
1406 elsif ($self->auto_savepoint) {
1409 $self->{transaction_depth}++;
1412 sub _dbh_begin_work {
1415 # if the user is utilizing txn_do - good for him, otherwise we need to
1416 # ensure that the $dbh is healthy on BEGIN.
1417 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1418 # will be replaced by a failure of begin_work itself (which will be
1419 # then retried on reconnect)
1420 if ($self->{_in_dbh_do}) {
1421 $self->_dbh->begin_work;
1423 $self->dbh_do(sub { $_[1]->begin_work });
1429 if ($self->{transaction_depth} == 1) {
1430 $self->debugobj->txn_commit()
1433 $self->{transaction_depth} = 0
1434 if $self->_dbh_autocommit;
1436 elsif($self->{transaction_depth} > 1) {
1437 $self->{transaction_depth}--;
1439 if $self->auto_savepoint;
1442 $self->throw_exception( 'Refusing to commit without a started transaction' );
1448 my $dbh = $self->_dbh
1449 or $self->throw_exception('cannot COMMIT on a disconnected handle');
1455 my $dbh = $self->_dbh;
1457 if ($self->{transaction_depth} == 1) {
1458 $self->debugobj->txn_rollback()
1460 $self->{transaction_depth} = 0
1461 if $self->_dbh_autocommit;
1462 $self->_dbh_rollback;
1464 elsif($self->{transaction_depth} > 1) {
1465 $self->{transaction_depth}--;
1466 if ($self->auto_savepoint) {
1467 $self->svp_rollback;
1472 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
1476 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
1478 if ($_ !~ /$exception_class/) {
1479 # ensure that a failed rollback resets the transaction depth
1480 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1483 $self->throw_exception($_)
1489 my $dbh = $self->_dbh
1490 or $self->throw_exception('cannot ROLLBACK on a disconnected handle');
1494 # This used to be the top-half of _execute. It was split out to make it
1495 # easier to override in NoBindVars without duping the rest. It takes up
1496 # all of _execute's args, and emits $sql, @bind.
1497 sub _prep_for_execute {
1498 my ($self, $op, $extra_bind, $ident, $args) = @_;
1500 if( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
1501 $ident = $ident->from();
1504 my ($sql, @bind) = $self->sql_maker->$op($ident, @$args);
1507 map { ref $_ eq 'ARRAY' ? $_ : [ '!!dummy', $_ ] } @$extra_bind)
1509 return ($sql, \@bind);
1513 sub _fix_bind_params {
1514 my ($self, @bind) = @_;
1516 ### Turn @bind from something like this:
1517 ### ( [ "artist", 1 ], [ "cdid", 1, 3 ] )
1519 ### ( "'1'", "'1'", "'3'" )
1522 if ( defined( $_ && $_->[1] ) ) {
1523 map { qq{'$_'}; } @{$_}[ 1 .. $#$_ ];
1530 my ( $self, $sql, @bind ) = @_;
1532 if ( $self->debug ) {
1533 @bind = $self->_fix_bind_params(@bind);
1535 $self->debugobj->query_start( $sql, @bind );
1540 my ( $self, $sql, @bind ) = @_;
1542 if ( $self->debug ) {
1543 @bind = $self->_fix_bind_params(@bind);
1544 $self->debugobj->query_end( $sql, @bind );
1549 my ($self, $dbh, $op, $extra_bind, $ident, $bind_attributes, @args) = @_;
1551 my ($sql, $bind) = $self->_prep_for_execute($op, $extra_bind, $ident, \@args);
1553 $self->_query_start( $sql, @$bind );
1555 my $sth = $self->sth($sql,$op);
1557 my $placeholder_index = 1;
1559 foreach my $bound (@$bind) {
1560 my $attributes = {};
1561 my($column_name, @data) = @$bound;
1563 if ($bind_attributes) {
1564 $attributes = $bind_attributes->{$column_name}
1565 if defined $bind_attributes->{$column_name};
1568 foreach my $data (@data) {
1569 my $ref = ref $data;
1570 $data = $ref && $ref ne 'ARRAY' ? ''.$data : $data; # stringify args (except arrayrefs)
1572 $sth->bind_param($placeholder_index, $data, $attributes);
1573 $placeholder_index++;
1577 # Can this fail without throwing an exception anyways???
1578 my $rv = $sth->execute();
1579 $self->throw_exception(
1580 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1583 $self->_query_end( $sql, @$bind );
1585 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1590 $self->dbh_do('_dbh_execute', @_); # retry over disconnects
1594 my ($self, $source, $to_insert) = @_;
1596 my $colinfo = $source->columns_info;
1598 # mix with auto-nextval marked values (a bit of a speed hit, but
1599 # no saner way to handle this yet)
1600 my $auto_nextvals = {} ;
1601 for my $col (keys %$colinfo) {
1603 $colinfo->{$col}{auto_nextval}
1606 ! exists $to_insert->{$col}
1608 ref $to_insert->{$col} eq 'SCALAR'
1611 $auto_nextvals->{$col} = $self->_sequence_fetch(
1613 ( $colinfo->{$col}{sequence} ||=
1614 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1621 $to_insert = { %$to_insert, %$auto_nextvals };
1623 # list of primary keys we try to fetch from the database
1624 # both not-exsists and scalarrefs are considered
1627 { $_ => scalar keys %fetch_pks } # so we can preserve order for prettyness
1629 { ! exists $to_insert->{$_} or ref $to_insert->{$_} eq 'SCALAR' }
1630 $source->primary_columns
1634 if ($self->_use_insert_returning) {
1636 # retain order as declared in the resultsource
1637 for (sort { $fetch_pks{$a} <=> $fetch_pks{$b} } keys %fetch_pks ) {
1638 push @{$sqla_opts->{returning}}, $_;
1642 my $bind_attributes = $self->source_bind_attributes($source);
1644 my ($rv, $sth) = $self->_execute('insert' => [], $source, $bind_attributes, $to_insert, $sqla_opts);
1646 my %returned_cols = %$auto_nextvals;
1648 if (my $retlist = $sqla_opts->{returning}) {
1649 my @ret_vals = try {
1650 local $SIG{__WARN__} = sub {};
1651 my @r = $sth->fetchrow_array;
1656 @returned_cols{@$retlist} = @ret_vals if @ret_vals;
1659 return \%returned_cols;
1663 ## Currently it is assumed that all values passed will be "normal", i.e. not
1664 ## scalar refs, or at least, all the same type as the first set, the statement is
1665 ## only prepped once.
1667 my ($self, $source, $cols, $data) = @_;
1670 @colvalues{@$cols} = (0..$#$cols);
1672 for my $i (0..$#$cols) {
1673 my $first_val = $data->[0][$i];
1674 next unless ref $first_val eq 'SCALAR';
1676 $colvalues{ $cols->[$i] } = $first_val;
1679 # check for bad data and stringify stringifiable objects
1680 my $bad_slice = sub {
1681 my ($msg, $col_idx, $slice_idx) = @_;
1682 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1686 local $Data::Dumper::Maxdepth = 1; # don't dump objects, if any
1688 map { $cols->[$_] => $data->[$slice_idx][$_] } (0 .. $#$cols)
1694 for my $datum_idx (0..$#$data) {
1695 my $datum = $data->[$datum_idx];
1697 for my $col_idx (0..$#$cols) {
1698 my $val = $datum->[$col_idx];
1699 my $sqla_bind = $colvalues{ $cols->[$col_idx] };
1700 my $is_literal_sql = (ref $sqla_bind) eq 'SCALAR';
1702 if ($is_literal_sql) {
1704 $bad_slice->('bind found where literal SQL expected', $col_idx, $datum_idx);
1706 elsif ((my $reftype = ref $val) ne 'SCALAR') {
1707 $bad_slice->("$reftype reference found where literal SQL expected",
1708 $col_idx, $datum_idx);
1710 elsif ($$val ne $$sqla_bind){
1711 $bad_slice->("inconsistent literal SQL value, expecting: '$$sqla_bind'",
1712 $col_idx, $datum_idx);
1715 elsif (my $reftype = ref $val) {
1717 if (overload::Method($val, '""')) {
1718 $datum->[$col_idx] = "".$val;
1721 $bad_slice->("$reftype reference found where bind expected",
1722 $col_idx, $datum_idx);
1728 my ($sql, $bind) = $self->_prep_for_execute (
1729 'insert', undef, $source, [\%colvalues]
1733 my $empty_bind = 1 if (not @bind) &&
1734 (grep { ref $_ eq 'SCALAR' } values %colvalues) == @$cols;
1736 if ((not @bind) && (not $empty_bind)) {
1737 $self->throw_exception(
1738 'Cannot insert_bulk without support for placeholders'
1742 # neither _execute_array, nor _execute_inserts_with_no_binds are
1743 # atomic (even if _execute _array is a single call). Thus a safety
1745 my $guard = $self->txn_scope_guard;
1747 $self->_query_start( $sql, [ dummy => '__BULK_INSERT__' ] );
1748 my $sth = $self->sth($sql);
1751 # bind_param_array doesn't work if there are no binds
1752 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
1755 # @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
1756 $self->_execute_array( $source, $sth, \@bind, $cols, $data );
1760 $self->_query_end( $sql, [ dummy => '__BULK_INSERT__' ] );
1764 return (wantarray ? ($rv, $sth, @bind) : $rv);
1767 sub _execute_array {
1768 my ($self, $source, $sth, $bind, $cols, $data, @extra) = @_;
1770 ## This must be an arrayref, else nothing works!
1771 my $tuple_status = [];
1773 ## Get the bind_attributes, if any exist
1774 my $bind_attributes = $self->source_bind_attributes($source);
1776 ## Bind the values and execute
1777 my $placeholder_index = 1;
1779 foreach my $bound (@$bind) {
1781 my $attributes = {};
1782 my ($column_name, $data_index) = @$bound;
1784 if( $bind_attributes ) {
1785 $attributes = $bind_attributes->{$column_name}
1786 if defined $bind_attributes->{$column_name};
1789 my @data = map { $_->[$data_index] } @$data;
1791 $sth->bind_param_array(
1794 (%$attributes ? $attributes : ()),
1796 $placeholder_index++;
1801 $rv = $self->_dbh_execute_array($sth, $tuple_status, @extra);
1807 # Statement must finish even if there was an exception.
1812 $err = shift unless defined $err
1816 if (! defined $err and $sth->err);
1820 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
1822 $self->throw_exception("Unexpected populate error: $err")
1823 if ($i > $#$tuple_status);
1825 $self->throw_exception(sprintf "%s for populate slice:\n%s",
1826 ($tuple_status->[$i][1] || $err),
1827 Dumper { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) },
1834 sub _dbh_execute_array {
1835 my ($self, $sth, $tuple_status, @extra) = @_;
1837 return $sth->execute_array({ArrayTupleStatus => $tuple_status});
1840 sub _dbh_execute_inserts_with_no_binds {
1841 my ($self, $sth, $count) = @_;
1845 my $dbh = $self->_get_dbh;
1846 local $dbh->{RaiseError} = 1;
1847 local $dbh->{PrintError} = 0;
1849 $sth->execute foreach 1..$count;
1855 # Make sure statement is finished even if there was an exception.
1860 $err = shift unless defined $err;
1864 $self->throw_exception($err) if defined $err;
1870 my ($self, $source, @args) = @_;
1872 my $bind_attrs = $self->source_bind_attributes($source);
1874 return $self->_execute('update' => [], $source, $bind_attrs, @args);
1879 my ($self, $source, @args) = @_;
1881 my $bind_attrs = $self->source_bind_attributes($source);
1883 return $self->_execute('delete' => [], $source, $bind_attrs, @args);
1886 # We were sent here because the $rs contains a complex search
1887 # which will require a subquery to select the correct rows
1888 # (i.e. joined or limited resultsets, or non-introspectable conditions)
1890 # Generating a single PK column subquery is trivial and supported
1891 # by all RDBMS. However if we have a multicolumn PK, things get ugly.
1892 # Look at _multipk_update_delete()
1893 sub _subq_update_delete {
1895 my ($rs, $op, $values) = @_;
1897 my $rsrc = $rs->result_source;
1899 # quick check if we got a sane rs on our hands
1900 my @pcols = $rsrc->_pri_cols;
1902 my $sel = $rs->_resolved_attrs->{select};
1903 $sel = [ $sel ] unless ref $sel eq 'ARRAY';
1906 join ("\x00", map { join '.', $rs->{attrs}{alias}, $_ } sort @pcols)
1908 join ("\x00", sort @$sel )
1910 $self->throw_exception (
1911 '_subq_update_delete can not be called on resultsets selecting columns other than the primary keys'
1918 $op eq 'update' ? $values : (),
1919 { $pcols[0] => { -in => $rs->as_query } },
1924 return $self->_multipk_update_delete (@_);
1928 # ANSI SQL does not provide a reliable way to perform a multicol-PK
1929 # resultset update/delete involving subqueries. So by default resort
1930 # to simple (and inefficient) delete_all style per-row opearations,
1931 # while allowing specific storages to override this with a faster
1934 sub _multipk_update_delete {
1935 return shift->_per_row_update_delete (@_);
1938 # This is the default loop used to delete/update rows for multi PK
1939 # resultsets, and used by mysql exclusively (because it can't do anything
1942 # We do not use $row->$op style queries, because resultset update/delete
1943 # is not expected to cascade (this is what delete_all/update_all is for).
1945 # There should be no race conditions as the entire operation is rolled
1948 sub _per_row_update_delete {
1950 my ($rs, $op, $values) = @_;
1952 my $rsrc = $rs->result_source;
1953 my @pcols = $rsrc->_pri_cols;
1955 my $guard = $self->txn_scope_guard;
1957 # emulate the return value of $sth->execute for non-selects
1958 my $row_cnt = '0E0';
1960 my $subrs_cur = $rs->cursor;
1961 my @all_pk = $subrs_cur->all;
1962 for my $pks ( @all_pk) {
1965 for my $i (0.. $#pcols) {
1966 $cond->{$pcols[$i]} = $pks->[$i];
1971 $op eq 'update' ? $values : (),
1985 $self->_execute($self->_select_args(@_));
1988 sub _select_args_to_query {
1991 # my ($op, $bind, $ident, $bind_attrs, $select, $cond, $rs_attrs, $rows, $offset)
1992 # = $self->_select_args($ident, $select, $cond, $attrs);
1993 my ($op, $bind, $ident, $bind_attrs, @args) =
1994 $self->_select_args(@_);
1996 # my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
1997 my ($sql, $prepared_bind) = $self->_prep_for_execute($op, $bind, $ident, \@args);
1998 $prepared_bind ||= [];
2001 ? ($sql, $prepared_bind, $bind_attrs)
2002 : \[ "($sql)", @$prepared_bind ]
2007 my ($self, $ident, $select, $where, $attrs) = @_;
2009 my $sql_maker = $self->sql_maker;
2010 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2017 $rs_alias && $alias2source->{$rs_alias}
2018 ? ( _rsroot_source_handle => $alias2source->{$rs_alias}->handle )
2023 # calculate bind_attrs before possible $ident mangling
2024 my $bind_attrs = {};
2025 for my $alias (keys %$alias2source) {
2026 my $bindtypes = $self->source_bind_attributes ($alias2source->{$alias}) || {};
2027 for my $col (keys %$bindtypes) {
2029 my $fqcn = join ('.', $alias, $col);
2030 $bind_attrs->{$fqcn} = $bindtypes->{$col} if $bindtypes->{$col};
2032 # Unqialified column names are nice, but at the same time can be
2033 # rather ambiguous. What we do here is basically go along with
2034 # the loop, adding an unqualified column slot to $bind_attrs,
2035 # alongside the fully qualified name. As soon as we encounter
2036 # another column by that name (which would imply another table)
2037 # we unset the unqualified slot and never add any info to it
2038 # to avoid erroneous type binding. If this happens the users
2039 # only choice will be to fully qualify his column name
2041 if (exists $bind_attrs->{$col}) {
2042 $bind_attrs->{$col} = {};
2045 $bind_attrs->{$col} = $bind_attrs->{$fqcn};
2050 # Sanity check the attributes (SQLMaker does it too, but
2051 # in case of a software_limit we'll never reach there)
2052 if (defined $attrs->{offset}) {
2053 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2054 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2056 $attrs->{offset} ||= 0;
2058 if (defined $attrs->{rows}) {
2059 $self->throw_exception("The rows attribute must be a positive integer if present")
2060 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2062 elsif ($attrs->{offset}) {
2063 # MySQL actually recommends this approach. I cringe.
2064 $attrs->{rows} = $sql_maker->__max_int;
2069 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2070 # storage, unless software limit was requested
2073 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2075 # grouped prefetch (to satisfy group_by == select)
2076 ( $attrs->{group_by}
2078 @{$attrs->{group_by}}
2080 $attrs->{_prefetch_select}
2082 @{$attrs->{_prefetch_select}}
2085 ($ident, $select, $where, $attrs)
2086 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2088 elsif (! $attrs->{software_limit} ) {
2089 push @limit, $attrs->{rows}, $attrs->{offset};
2092 # try to simplify the joinmap further (prune unreferenced type-single joins)
2093 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2096 # This would be the point to deflate anything found in $where
2097 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2098 # expect a row object. And all we have is a resultsource (it is trivial
2099 # to extract deflator coderefs via $alias2source above).
2101 # I don't see a way forward other than changing the way deflators are
2102 # invoked, and that's just bad...
2105 return ('select', $attrs->{bind}, $ident, $bind_attrs, $select, $where, $attrs, @limit);
2108 # Returns a counting SELECT for a simple count
2109 # query. Abstracted so that a storage could override
2110 # this to { count => 'firstcol' } or whatever makes
2111 # sense as a performance optimization
2113 #my ($self, $source, $rs_attrs) = @_;
2114 return { count => '*' };
2118 sub source_bind_attributes {
2119 my ($self, $source) = @_;
2121 my $bind_attributes;
2123 my $colinfo = $source->columns_info;
2125 for my $col (keys %$colinfo) {
2126 if (my $dt = $colinfo->{$col}{data_type} ) {
2127 $bind_attributes->{$col} = $self->bind_attribute_by_data_type($dt)
2131 return $bind_attributes;
2138 =item Arguments: $ident, $select, $condition, $attrs
2142 Handle a SQL select statement.
2148 my ($ident, $select, $condition, $attrs) = @_;
2149 return $self->cursor_class->new($self, \@_, $attrs);
2154 my ($rv, $sth, @bind) = $self->_select(@_);
2155 my @row = $sth->fetchrow_array;
2156 my @nextrow = $sth->fetchrow_array if @row;
2157 if(@row && @nextrow) {
2158 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2160 # Need to call finish() to work round broken DBDs
2165 =head2 sql_limit_dialect
2167 This is an accessor for the default SQL limit dialect used by a particular
2168 storage driver. Can be overriden by supplying an explicit L</limit_dialect>
2169 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2170 see L<DBIx::Class::SQLMaker::LimitDialects>.
2176 =item Arguments: $sql
2180 Returns a L<DBI> sth (statement handle) for the supplied SQL.
2185 my ($self, $dbh, $sql) = @_;
2187 # 3 is the if_active parameter which avoids active sth re-use
2188 my $sth = $self->disable_sth_caching
2189 ? $dbh->prepare($sql)
2190 : $dbh->prepare_cached($sql, {}, 3);
2192 # XXX You would think RaiseError would make this impossible,
2193 # but apparently that's not true :(
2194 $self->throw_exception($dbh->errstr) if !$sth;
2200 my ($self, $sql) = @_;
2201 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2204 sub _dbh_columns_info_for {
2205 my ($self, $dbh, $table) = @_;
2207 if ($dbh->can('column_info')) {
2211 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2212 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2214 while ( my $info = $sth->fetchrow_hashref() ){
2216 $column_info{data_type} = $info->{TYPE_NAME};
2217 $column_info{size} = $info->{COLUMN_SIZE};
2218 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2219 $column_info{default_value} = $info->{COLUMN_DEF};
2220 my $col_name = $info->{COLUMN_NAME};
2221 $col_name =~ s/^\"(.*)\"$/$1/;
2223 $result{$col_name} = \%column_info;
2228 return \%result if !$caught && scalar keys %result;
2232 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2234 my @columns = @{$sth->{NAME_lc}};
2235 for my $i ( 0 .. $#columns ){
2237 $column_info{data_type} = $sth->{TYPE}->[$i];
2238 $column_info{size} = $sth->{PRECISION}->[$i];
2239 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2241 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2242 $column_info{data_type} = $1;
2243 $column_info{size} = $2;
2246 $result{$columns[$i]} = \%column_info;
2250 foreach my $col (keys %result) {
2251 my $colinfo = $result{$col};
2252 my $type_num = $colinfo->{data_type};
2254 if(defined $type_num && $dbh->can('type_info')) {
2255 my $type_info = $dbh->type_info($type_num);
2256 $type_name = $type_info->{TYPE_NAME} if $type_info;
2257 $colinfo->{data_type} = $type_name if $type_name;
2264 sub columns_info_for {
2265 my ($self, $table) = @_;
2266 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2269 =head2 last_insert_id
2271 Return the row id of the last insert.
2275 sub _dbh_last_insert_id {
2276 my ($self, $dbh, $source, $col) = @_;
2278 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2280 return $id if defined $id;
2282 my $class = ref $self;
2283 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2286 sub last_insert_id {
2288 $self->_dbh_last_insert_id ($self->_dbh, @_);
2291 =head2 _native_data_type
2295 =item Arguments: $type_name
2299 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2300 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2301 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2303 The default implementation returns C<undef>, implement in your Storage driver if
2304 you need this functionality.
2306 Should map types from other databases to the native RDBMS type, for example
2307 C<VARCHAR2> to C<VARCHAR>.
2309 Types with modifiers should map to the underlying data type. For example,
2310 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2312 Composite types should map to the container type, for example
2313 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2317 sub _native_data_type {
2318 #my ($self, $data_type) = @_;
2322 # Check if placeholders are supported at all
2323 sub _determine_supports_placeholders {
2325 my $dbh = $self->_get_dbh;
2327 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2328 # but it is inaccurate more often than not
2330 local $dbh->{PrintError} = 0;
2331 local $dbh->{RaiseError} = 1;
2332 $dbh->do('select ?', {}, 1);
2340 # Check if placeholders bound to non-string types throw exceptions
2342 sub _determine_supports_typeless_placeholders {
2344 my $dbh = $self->_get_dbh;
2347 local $dbh->{PrintError} = 0;
2348 local $dbh->{RaiseError} = 1;
2349 # this specifically tests a bind that is NOT a string
2350 $dbh->do('select 1 where 1 = ?', {}, 1);
2360 Returns the database driver name.
2365 shift->_get_dbh->{Driver}->{Name};
2368 =head2 bind_attribute_by_data_type
2370 Given a datatype from column info, returns a database specific bind
2371 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2372 let the database planner just handle it.
2374 Generally only needed for special case column types, like bytea in postgres.
2378 sub bind_attribute_by_data_type {
2382 =head2 is_datatype_numeric
2384 Given a datatype from column_info, returns a boolean value indicating if
2385 the current RDBMS considers it a numeric value. This controls how
2386 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2387 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2388 be performed instead of the usual C<eq>.
2392 sub is_datatype_numeric {
2393 my ($self, $dt) = @_;
2395 return 0 unless $dt;
2397 return $dt =~ /^ (?:
2398 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2403 =head2 create_ddl_dir
2407 =item Arguments: $schema \@databases, $version, $directory, $preversion, \%sqlt_args
2411 Creates a SQL file based on the Schema, for each of the specified
2412 database engines in C<\@databases> in the given directory.
2413 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2415 Given a previous version number, this will also create a file containing
2416 the ALTER TABLE statements to transform the previous schema into the
2417 current one. Note that these statements may contain C<DROP TABLE> or
2418 C<DROP COLUMN> statements that can potentially destroy data.
2420 The file names are created using the C<ddl_filename> method below, please
2421 override this method in your schema if you would like a different file
2422 name format. For the ALTER file, the same format is used, replacing
2423 $version in the name with "$preversion-$version".
2425 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2426 The most common value for this would be C<< { add_drop_table => 1 } >>
2427 to have the SQL produced include a C<DROP TABLE> statement for each table
2428 created. For quoting purposes supply C<quote_table_names> and
2429 C<quote_field_names>.
2431 If no arguments are passed, then the following default values are assumed:
2435 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2437 =item version - $schema->schema_version
2439 =item directory - './'
2441 =item preversion - <none>
2445 By default, C<\%sqlt_args> will have
2447 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2449 merged with the hash passed in. To disable any of those features, pass in a
2450 hashref like the following
2452 { ignore_constraint_names => 0, # ... other options }
2455 WARNING: You are strongly advised to check all SQL files created, before applying
2460 sub create_ddl_dir {
2461 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2464 carp "No directory given, using ./\n";
2469 make_path ("$dir") # make_path does not like objects (i.e. Path::Class::Dir)
2471 $self->throw_exception(
2472 "Failed to create '$dir': " . ($! || $@ || 'error unknow')
2476 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2478 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2479 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2481 my $schema_version = $schema->schema_version || '1.x';
2482 $version ||= $schema_version;
2485 add_drop_table => 1,
2486 ignore_constraint_names => 1,
2487 ignore_index_names => 1,
2491 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2492 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2495 my $sqlt = SQL::Translator->new( $sqltargs );
2497 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2498 my $sqlt_schema = $sqlt->translate({ data => $schema })
2499 or $self->throw_exception ($sqlt->error);
2501 foreach my $db (@$databases) {
2503 $sqlt->{schema} = $sqlt_schema;
2504 $sqlt->producer($db);
2507 my $filename = $schema->ddl_filename($db, $version, $dir);
2508 if (-e $filename && ($version eq $schema_version )) {
2509 # if we are dumping the current version, overwrite the DDL
2510 carp "Overwriting existing DDL file - $filename";
2514 my $output = $sqlt->translate;
2516 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2519 if(!open($file, ">$filename")) {
2520 $self->throw_exception("Can't open $filename for writing ($!)");
2523 print $file $output;
2526 next unless ($preversion);
2528 require SQL::Translator::Diff;
2530 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2531 if(!-e $prefilename) {
2532 carp("No previous schema file found ($prefilename)");
2536 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2538 carp("Overwriting existing diff file - $difffile");
2544 my $t = SQL::Translator->new($sqltargs);
2549 or $self->throw_exception ($t->error);
2551 my $out = $t->translate( $prefilename )
2552 or $self->throw_exception ($t->error);
2554 $source_schema = $t->schema;
2556 $source_schema->name( $prefilename )
2557 unless ( $source_schema->name );
2560 # The "new" style of producers have sane normalization and can support
2561 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2562 # And we have to diff parsed SQL against parsed SQL.
2563 my $dest_schema = $sqlt_schema;
2565 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2566 my $t = SQL::Translator->new($sqltargs);
2571 or $self->throw_exception ($t->error);
2573 my $out = $t->translate( $filename )
2574 or $self->throw_exception ($t->error);
2576 $dest_schema = $t->schema;
2578 $dest_schema->name( $filename )
2579 unless $dest_schema->name;
2582 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2586 if(!open $file, ">$difffile") {
2587 $self->throw_exception("Can't write to $difffile ($!)");
2595 =head2 deployment_statements
2599 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2603 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2605 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2606 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2608 C<$directory> is used to return statements from files in a previously created
2609 L</create_ddl_dir> directory and is optional. The filenames are constructed
2610 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2612 If no C<$directory> is specified then the statements are constructed on the
2613 fly using L<SQL::Translator> and C<$version> is ignored.
2615 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2619 sub deployment_statements {
2620 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2621 $type ||= $self->sqlt_type;
2622 $version ||= $schema->schema_version || '1.x';
2624 my $filename = $schema->ddl_filename($type, $version, $dir);
2628 open($file, "<$filename")
2629 or $self->throw_exception("Can't open $filename ($!)");
2632 return join('', @rows);
2635 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2636 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2639 # sources needs to be a parser arg, but for simplicty allow at top level
2641 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2642 if exists $sqltargs->{sources};
2644 my $tr = SQL::Translator->new(
2645 producer => "SQL::Translator::Producer::${type}",
2647 parser => 'SQL::Translator::Parser::DBIx::Class',
2654 @ret = $tr->translate;
2657 $ret[0] = $tr->translate;
2660 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2661 unless (@ret && defined $ret[0]);
2663 return $wa ? @ret : $ret[0];
2667 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2670 return if($line =~ /^--/);
2672 # next if($line =~ /^DROP/m);
2673 return if($line =~ /^BEGIN TRANSACTION/m);
2674 return if($line =~ /^COMMIT/m);
2675 return if $line =~ /^\s+$/; # skip whitespace only
2676 $self->_query_start($line);
2678 # do a dbh_do cycle here, as we need some error checking in
2679 # place (even though we will ignore errors)
2680 $self->dbh_do (sub { $_[1]->do($line) });
2682 carp qq{$_ (running "${line}")};
2684 $self->_query_end($line);
2686 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2687 if (@statements > 1) {
2688 foreach my $statement (@statements) {
2689 $deploy->( $statement );
2692 elsif (@statements == 1) {
2693 foreach my $line ( split(";\n", $statements[0])) {
2699 =head2 datetime_parser
2701 Returns the datetime parser class
2705 sub datetime_parser {
2707 return $self->{datetime_parser} ||= do {
2708 $self->build_datetime_parser(@_);
2712 =head2 datetime_parser_type
2714 Defines (returns) the datetime parser class - currently hardwired to
2715 L<DateTime::Format::MySQL>
2719 sub datetime_parser_type { "DateTime::Format::MySQL"; }
2721 =head2 build_datetime_parser
2723 See L</datetime_parser>
2727 sub build_datetime_parser {
2729 my $type = $self->datetime_parser_type(@_);
2730 $self->ensure_class_loaded ($type);
2735 =head2 is_replicating
2737 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2738 replicate from a master database. Default is undef, which is the result
2739 returned by databases that don't support replication.
2743 sub is_replicating {
2748 =head2 lag_behind_master
2750 Returns a number that represents a certain amount of lag behind a master db
2751 when a given storage is replicating. The number is database dependent, but
2752 starts at zero and increases with the amount of lag. Default in undef
2756 sub lag_behind_master {
2760 =head2 relname_to_table_alias
2764 =item Arguments: $relname, $join_count
2768 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2771 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2772 way these aliases are named.
2774 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2775 otherwise C<"$relname">.
2779 sub relname_to_table_alias {
2780 my ($self, $relname, $join_count) = @_;
2782 my $alias = ($join_count && $join_count > 1 ?
2783 join('_', $relname, $join_count) : $relname);
2792 =head2 DBIx::Class and AutoCommit
2794 DBIx::Class can do some wonderful magic with handling exceptions,
2795 disconnections, and transactions when you use C<< AutoCommit => 1 >>
2796 (the default) combined with C<txn_do> for transaction support.
2798 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
2799 in an assumed transaction between commits, and you're telling us you'd
2800 like to manage that manually. A lot of the magic protections offered by
2801 this module will go away. We can't protect you from exceptions due to database
2802 disconnects because we don't know anything about how to restart your
2803 transactions. You're on your own for handling all sorts of exceptional
2804 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
2810 Matt S. Trout <mst@shadowcatsystems.co.uk>
2812 Andy Grundman <andy@hybridized.org>
2816 You may distribute this code under the same terms as Perl itself.