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 DBIx::Class::Carp;
11 use Scalar::Util qw/refaddr weaken reftype blessed/;
12 use List::Util qw/first/;
13 use Sub::Name 'subname';
14 use Context::Preserve 'preserve_context';
17 use Data::Compare (); # no imports!!! guard against insane architecture
18 use DBI::Const::GetInfoType (); # no import of retarded global hash
21 # default cursor class, overridable in connect_info attributes
22 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
24 __PACKAGE__->mk_group_accessors('inherited' => qw/
25 sql_limit_dialect sql_quote_char sql_name_sep
28 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
30 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
31 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
33 __PACKAGE__->sql_name_sep('.');
35 __PACKAGE__->mk_group_accessors('simple' => qw/
36 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
37 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
38 _perform_autoinc_retrieval _autoinc_supplied_for_op
41 # the values for these accessors are picked out (and deleted) from
42 # the attribute hashref passed to connect_info
43 my @storage_options = qw/
44 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
45 disable_sth_caching unsafe auto_savepoint
47 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
50 # capability definitions, using a 2-tiered accessor system
53 # A driver/user may define _use_X, which blindly without any checks says:
54 # "(do not) use this capability", (use_dbms_capability is an "inherited"
57 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
58 # accessor, which in turn calls _determine_supports_X, and stores the return
59 # in a special slot on the storage object, which is wiped every time a $dbh
60 # reconnection takes place (it is not guaranteed that upon reconnection we
61 # will get the same rdbms version). _determine_supports_X does not need to
62 # exist on a driver, as we ->can for it before calling.
64 my @capabilities = (qw/
66 insert_returning_bound
75 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
76 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
78 # on by default, not strictly a capability (pending rewrite)
79 __PACKAGE__->_use_join_optimizer (1);
80 sub _determine_supports_join_optimizer { 1 };
82 # Each of these methods need _determine_driver called before itself
83 # in order to function reliably. This is a purely DRY optimization
85 # get_(use)_dbms_capability need to be called on the correct Storage
86 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
87 # _determine_supports_X which obv. needs a correct driver as well
88 my @rdbms_specific_methods = qw/
101 with_deferred_fk_checks
103 get_use_dbms_capability
110 for my $meth (@rdbms_specific_methods) {
112 my $orig = __PACKAGE__->can ($meth)
113 or die "$meth is not a ::Storage::DBI method!";
116 no warnings qw/redefine/;
117 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
119 # only fire when invoked on an instance, a valid class-based invocation
120 # would e.g. be setting a default for an inherited accessor
123 ! $_[0]->_driver_determined
125 ! $_[0]->{_in_determine_driver}
127 $_[0]->_determine_driver;
129 # This for some reason crashes and burns on perl 5.8.1
130 # IFF the method ends up throwing an exception
131 #goto $_[0]->can ($meth);
133 my $cref = $_[0]->can ($meth);
143 DBIx::Class::Storage::DBI - DBI storage handler
147 my $schema = MySchema->connect('dbi:SQLite:my.db');
149 $schema->storage->debug(1);
151 my @stuff = $schema->storage->dbh_do(
153 my ($storage, $dbh, @args) = @_;
154 $dbh->do("DROP TABLE authors");
159 $schema->resultset('Book')->search({
160 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
165 This class represents the connection to an RDBMS via L<DBI>. See
166 L<DBIx::Class::Storage> for general information. This pod only
167 documents DBI-specific methods and behaviors.
174 my $new = shift->next::method(@_);
176 $new->_sql_maker_opts({});
177 $new->_dbh_details({});
178 $new->{_in_do_block} = 0;
180 # read below to see what this does
181 $new->_arm_global_destructor;
186 # This is hack to work around perl shooting stuff in random
187 # order on exit(). If we do not walk the remaining storage
188 # objects in an END block, there is a *small but real* chance
189 # of a fork()ed child to kill the parent's shared DBI handle,
190 # *before perl reaches the DESTROY in this package*
191 # Yes, it is ugly and effective.
192 # Additionally this registry is used by the CLONE method to
193 # make sure no handles are shared between threads
195 my %seek_and_destroy;
197 sub _arm_global_destructor {
199 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
204 local $?; # just in case the DBI destructor changes it somehow
206 # destroy just the object if not native to this process
207 $_->_verify_pid for (grep
209 values %seek_and_destroy
214 # As per DBI's recommendation, DBIC disconnects all handles as
215 # soon as possible (DBIC will reconnect only on demand from within
217 my @instances = grep { defined $_ } values %seek_and_destroy;
218 %seek_and_destroy = ();
223 $_->transaction_depth(0);
226 # properly renumber existing refs
227 $_->_arm_global_destructor
235 # some databases spew warnings on implicit disconnect
236 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
237 local $SIG{__WARN__} = sub {};
240 # this op is necessary, since the very last perl runtime statement
241 # triggers a global destruction shootout, and the $SIG localization
242 # may very well be destroyed before perl actually gets to do the
247 # handle pid changes correctly - do not destroy parent's connection
251 my $pid = $self->_conn_pid;
252 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
253 $dbh->{InactiveDestroy} = 1;
255 $self->transaction_depth(0);
256 $self->savepoints([]);
264 This method is normally called by L<DBIx::Class::Schema/connection>, which
265 encapsulates its argument list in an arrayref before passing them here.
267 The argument list may contain:
273 The same 4-element argument set one would normally pass to
274 L<DBI/connect>, optionally followed by
275 L<extra attributes|/DBIx::Class specific connection attributes>
276 recognized by DBIx::Class:
278 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
282 A single code reference which returns a connected
283 L<DBI database handle|DBI/connect> optionally followed by
284 L<extra attributes|/DBIx::Class specific connection attributes> recognized
287 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
291 A single hashref with all the attributes and the dsn/user/password
294 $connect_info_args = [{
302 $connect_info_args = [{
303 dbh_maker => sub { DBI->connect (...) },
308 This is particularly useful for L<Catalyst> based applications, allowing the
309 following config (L<Config::General> style):
314 dsn dbi:mysql:database=test
321 The C<dsn>/C<user>/C<password> combination can be substituted by the
322 C<dbh_maker> key whose value is a coderef that returns a connected
323 L<DBI database handle|DBI/connect>
327 Please note that the L<DBI> docs recommend that you always explicitly
328 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
329 recommends that it be set to I<1>, and that you perform transactions
330 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
331 to I<1> if you do not do explicitly set it to zero. This is the default
332 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
334 =head3 DBIx::Class specific connection attributes
336 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
337 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
338 the following connection options. These options can be mixed in with your other
339 L<DBI> connection attributes, or placed in a separate hashref
340 (C<\%extra_attributes>) as shown above.
342 Every time C<connect_info> is invoked, any previous settings for
343 these options will be cleared before setting the new ones, regardless of
344 whether any options are specified in the new C<connect_info>.
351 Specifies things to do immediately after connecting or re-connecting to
352 the database. Its value may contain:
358 This contains one SQL statement to execute.
360 =item an array reference
362 This contains SQL statements to execute in order. Each element contains
363 a string or a code reference that returns a string.
365 =item a code reference
367 This contains some code to execute. Unlike code references within an
368 array reference, its return value is ignored.
372 =item on_disconnect_do
374 Takes arguments in the same form as L</on_connect_do> and executes them
375 immediately before disconnecting from the database.
377 Note, this only runs if you explicitly call L</disconnect> on the
380 =item on_connect_call
382 A more generalized form of L</on_connect_do> that calls the specified
383 C<connect_call_METHOD> methods in your storage driver.
385 on_connect_do => 'select 1'
389 on_connect_call => [ [ do_sql => 'select 1' ] ]
391 Its values may contain:
397 Will call the C<connect_call_METHOD> method.
399 =item a code reference
401 Will execute C<< $code->($storage) >>
403 =item an array reference
405 Each value can be a method name or code reference.
407 =item an array of arrays
409 For each array, the first item is taken to be the C<connect_call_> method name
410 or code reference, and the rest are parameters to it.
414 Some predefined storage methods you may use:
420 Executes a SQL string or a code reference that returns a SQL string. This is
421 what L</on_connect_do> and L</on_disconnect_do> use.
429 Will execute the scalar as SQL.
433 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
434 attributes hashref and bind values.
436 =item a code reference
438 Will execute C<< $code->($storage) >> and execute the return array refs as
445 Execute any statements necessary to initialize the database session to return
446 and accept datetime/timestamp values used with
447 L<DBIx::Class::InflateColumn::DateTime>.
449 Only necessary for some databases, see your specific storage driver for
450 implementation details.
454 =item on_disconnect_call
456 Takes arguments in the same form as L</on_connect_call> and executes them
457 immediately before disconnecting from the database.
459 Calls the C<disconnect_call_METHOD> methods as opposed to the
460 C<connect_call_METHOD> methods called by L</on_connect_call>.
462 Note, this only runs if you explicitly call L</disconnect> on the
465 =item disable_sth_caching
467 If set to a true value, this option will disable the caching of
468 statement handles via L<DBI/prepare_cached>.
472 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
473 default L</sql_limit_dialect> setting of the storage (if any). For a list
474 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
478 When true automatically sets L</quote_char> and L</name_sep> to the characters
479 appropriate for your particular RDBMS. This option is preferred over specifying
480 L</quote_char> directly.
484 Specifies what characters to use to quote table and column names.
486 C<quote_char> expects either a single character, in which case is it
487 is placed on either side of the table/column name, or an arrayref of length
488 2 in which case the table/column name is placed between the elements.
490 For example under MySQL you should use C<< quote_char => '`' >>, and for
491 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
495 This parameter is only useful in conjunction with C<quote_char>, and is used to
496 specify the character that separates elements (schemas, tables, columns) from
497 each other. If unspecified it defaults to the most commonly used C<.>.
501 This Storage driver normally installs its own C<HandleError>, sets
502 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
503 all database handles, including those supplied by a coderef. It does this
504 so that it can have consistent and useful error behavior.
506 If you set this option to a true value, Storage will not do its usual
507 modifications to the database handle's attributes, and instead relies on
508 the settings in your connect_info DBI options (or the values you set in
509 your connection coderef, in the case that you are connecting via coderef).
511 Note that your custom settings can cause Storage to malfunction,
512 especially if you set a C<HandleError> handler that suppresses exceptions
513 and/or disable C<RaiseError>.
517 If this option is true, L<DBIx::Class> will use savepoints when nesting
518 transactions, making it possible to recover from failure in the inner
519 transaction without having to abort all outer transactions.
523 Use this argument to supply a cursor class other than the default
524 L<DBIx::Class::Storage::DBI::Cursor>.
528 Some real-life examples of arguments to L</connect_info> and
529 L<DBIx::Class::Schema/connect>
531 # Simple SQLite connection
532 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
535 ->connect_info([ sub { DBI->connect(...) } ]);
537 # Connect via subref in hashref
539 dbh_maker => sub { DBI->connect(...) },
540 on_connect_do => 'alter session ...',
543 # A bit more complicated
550 { quote_char => q{"} },
554 # Equivalent to the previous example
560 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
564 # Same, but with hashref as argument
565 # See parse_connect_info for explanation
568 dsn => 'dbi:Pg:dbname=foo',
570 password => 'my_pg_password',
577 # Subref + DBIx::Class-specific connection options
580 sub { DBI->connect(...) },
584 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
585 disable_sth_caching => 1,
595 my ($self, $info) = @_;
597 return $self->_connect_info if !$info;
599 $self->_connect_info($info); # copy for _connect_info
601 $info = $self->_normalize_connect_info($info)
602 if ref $info eq 'ARRAY';
604 for my $storage_opt (keys %{ $info->{storage_options} }) {
605 my $value = $info->{storage_options}{$storage_opt};
607 $self->$storage_opt($value);
610 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
611 # the new set of options
612 $self->_sql_maker(undef);
613 $self->_sql_maker_opts({});
615 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
616 my $value = $info->{sql_maker_options}{$sql_maker_opt};
618 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
622 %{ $self->_default_dbi_connect_attributes || {} },
623 %{ $info->{attributes} || {} },
626 my @args = @{ $info->{arguments} };
628 if (keys %attrs and ref $args[0] ne 'CODE') {
630 'You provided explicit AutoCommit => 0 in your connection_info. '
631 . 'This is almost universally a bad idea (see the footnotes of '
632 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
633 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
635 if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
637 push @args, \%attrs if keys %attrs;
639 $self->_dbi_connect_info(\@args);
642 # save attributes them in a separate accessor so they are always
643 # introspectable, even in case of a CODE $dbhmaker
644 $self->_dbic_connect_attributes (\%attrs);
646 return $self->_connect_info;
649 sub _normalize_connect_info {
650 my ($self, $info_arg) = @_;
653 my @args = @$info_arg; # take a shallow copy for further mutilation
655 # combine/pre-parse arguments depending on invocation style
658 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
659 %attrs = %{ $args[1] || {} };
662 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
663 %attrs = %{$args[0]};
665 if (my $code = delete $attrs{dbh_maker}) {
668 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
671 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
672 . "to the result of 'dbh_maker'",
674 join (', ', map { "'$_'" } (@ignored) ),
679 @args = delete @attrs{qw/dsn user password/};
682 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
684 % { $args[3] || {} },
685 % { $args[4] || {} },
687 @args = @args[0,1,2];
690 $info{arguments} = \@args;
692 my @storage_opts = grep exists $attrs{$_},
693 @storage_options, 'cursor_class';
695 @{ $info{storage_options} }{@storage_opts} =
696 delete @attrs{@storage_opts} if @storage_opts;
698 my @sql_maker_opts = grep exists $attrs{$_},
699 qw/limit_dialect quote_char name_sep quote_names/;
701 @{ $info{sql_maker_options} }{@sql_maker_opts} =
702 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
704 $info{attributes} = \%attrs if %attrs;
709 sub _default_dbi_connect_attributes () {
714 ShowErrorStatement => 1,
720 This method is deprecated in favour of setting via L</connect_info>.
724 =head2 on_disconnect_do
726 This method is deprecated in favour of setting via L</connect_info>.
730 sub _parse_connect_do {
731 my ($self, $type) = @_;
733 my $val = $self->$type;
734 return () if not defined $val;
739 push @res, [ 'do_sql', $val ];
740 } elsif (ref($val) eq 'CODE') {
742 } elsif (ref($val) eq 'ARRAY') {
743 push @res, map { [ 'do_sql', $_ ] } @$val;
745 $self->throw_exception("Invalid type for $type: ".ref($val));
753 Arguments: ($subref | $method_name), @extra_coderef_args?
755 Execute the given $subref or $method_name using the new exception-based
756 connection management.
758 The first two arguments will be the storage object that C<dbh_do> was called
759 on and a database handle to use. Any additional arguments will be passed
760 verbatim to the called subref as arguments 2 and onwards.
762 Using this (instead of $self->_dbh or $self->dbh) ensures correct
763 exception handling and reconnection (or failover in future subclasses).
765 Your subref should have no side-effects outside of the database, as
766 there is the potential for your subref to be partially double-executed
767 if the database connection was stale/dysfunctional.
771 my @stuff = $schema->storage->dbh_do(
773 my ($storage, $dbh, @cols) = @_;
774 my $cols = join(q{, }, @cols);
775 $dbh->selectrow_array("SELECT $cols FROM foo");
784 my $run_target = shift;
786 # short circuit when we know there is no need for a runner
788 # FIXME - asumption may be wrong
789 # the rationale for the txn_depth check is that if this block is a part
790 # of a larger transaction, everything up to that point is screwed anyway
791 return $self->$run_target($self->_get_dbh, @_)
792 if $self->{_in_do_block} or $self->transaction_depth;
794 # take a ref instead of a copy, to preserve @_ aliasing
795 # semantics within the coderef, but only if needed
796 # (pseudoforking doesn't like this trick much)
797 my $args = @_ ? \@_ : [];
799 DBIx::Class::Storage::BlockRunner->new(
801 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
803 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
808 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
809 shift->next::method(@_);
814 Our C<disconnect> method also performs a rollback first if the
815 database is not in C<AutoCommit> mode.
825 push @actions, ( $self->on_disconnect_call || () );
826 push @actions, $self->_parse_connect_do ('on_disconnect_do');
828 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
830 # stops the "implicit rollback on disconnect" warning
831 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
833 %{ $self->_dbh->{CachedKids} } = ();
834 $self->_dbh->disconnect;
839 =head2 with_deferred_fk_checks
843 =item Arguments: C<$coderef>
845 =item Return Value: The return value of $coderef
849 Storage specific method to run the code ref with FK checks deferred or
850 in MySQL's case disabled entirely.
854 # Storage subclasses should override this
855 sub with_deferred_fk_checks {
856 my ($self, $sub) = @_;
864 =item Arguments: none
866 =item Return Value: 1|0
870 Verifies that the current database handle is active and ready to execute
871 an SQL statement (e.g. the connection did not get stale, server is still
872 answering, etc.) This method is used internally by L</dbh>.
878 return 0 unless $self->_seems_connected;
881 local $self->_dbh->{RaiseError} = 1;
886 sub _seems_connected {
889 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
891 my $dbh = $self->_dbh
894 return $dbh->FETCH('Active');
900 my $dbh = $self->_dbh or return 0;
905 sub ensure_connected {
908 unless ($self->connected) {
909 $self->_populate_dbh;
915 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
916 is guaranteed to be healthy by implicitly calling L</connected>, and if
917 necessary performing a reconnection before returning. Keep in mind that this
918 is very B<expensive> on some database engines. Consider using L</dbh_do>
926 if (not $self->_dbh) {
927 $self->_populate_dbh;
929 $self->ensure_connected;
934 # this is the internal "get dbh or connect (don't check)" method
937 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
938 $self->_populate_dbh unless $self->_dbh;
944 unless ($self->_sql_maker) {
945 my $sql_maker_class = $self->sql_maker_class;
947 my %opts = %{$self->_sql_maker_opts||{}};
951 $self->sql_limit_dialect
954 my $s_class = (ref $self) || $self;
956 "Your storage class ($s_class) does not set sql_limit_dialect and you "
957 . 'have not supplied an explicit limit_dialect in your connection_info. '
958 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
959 . 'databases but can be (and often is) painfully slow. '
960 . "Please file an RT ticket against '$s_class' ."
967 my ($quote_char, $name_sep);
969 if ($opts{quote_names}) {
970 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
971 my $s_class = (ref $self) || $self;
973 "You requested 'quote_names' but your storage class ($s_class) does "
974 . 'not explicitly define a default sql_quote_char and you have not '
975 . 'supplied a quote_char as part of your connection_info. DBIC will '
976 .q{default to the ANSI SQL standard quote '"', which works most of }
977 . "the time. Please file an RT ticket against '$s_class'."
983 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
986 $self->_sql_maker($sql_maker_class->new(
988 array_datatypes => 1,
989 limit_dialect => $dialect,
990 ($quote_char ? (quote_char => $quote_char) : ()),
991 name_sep => ($name_sep || '.'),
995 return $self->_sql_maker;
998 # nothing to do by default
1005 my @info = @{$self->_dbi_connect_info || []};
1006 $self->_dbh(undef); # in case ->connected failed we might get sent here
1007 $self->_dbh_details({}); # reset everything we know
1009 $self->_dbh($self->_connect(@info));
1011 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1013 $self->_determine_driver;
1015 # Always set the transaction depth on connect, since
1016 # there is no transaction in progress by definition
1017 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1019 $self->_run_connection_actions unless $self->{_in_determine_driver};
1022 sub _run_connection_actions {
1026 push @actions, ( $self->on_connect_call || () );
1027 push @actions, $self->_parse_connect_do ('on_connect_do');
1029 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1034 sub set_use_dbms_capability {
1035 $_[0]->set_inherited ($_[1], $_[2]);
1038 sub get_use_dbms_capability {
1039 my ($self, $capname) = @_;
1041 my $use = $self->get_inherited ($capname);
1044 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1048 sub set_dbms_capability {
1049 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1052 sub get_dbms_capability {
1053 my ($self, $capname) = @_;
1055 my $cap = $self->_dbh_details->{capability}{$capname};
1057 unless (defined $cap) {
1058 if (my $meth = $self->can ("_determine$capname")) {
1059 $cap = $self->$meth ? 1 : 0;
1065 $self->set_dbms_capability ($capname, $cap);
1075 unless ($info = $self->_dbh_details->{info}) {
1079 my $server_version = try {
1080 $self->_get_server_version
1082 # driver determination *may* use this codepath
1083 # in which case we must rethrow
1084 $self->throw_exception($_) if $self->{_in_determine_driver};
1086 # $server_version on failure
1090 if (defined $server_version) {
1091 $info->{dbms_version} = $server_version;
1093 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1094 my @verparts = split (/\./, $numeric_version);
1100 # consider only up to 3 version parts, iff not more than 3 digits
1102 while (@verparts && @use_parts < 3) {
1103 my $p = shift @verparts;
1105 push @use_parts, $p;
1107 push @use_parts, 0 while @use_parts < 3;
1109 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1113 $self->_dbh_details->{info} = $info;
1119 sub _get_server_version {
1120 shift->_dbh_get_info('SQL_DBMS_VER');
1124 my ($self, $info) = @_;
1126 if ($info =~ /[^0-9]/) {
1127 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1128 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1129 unless defined $info;
1132 return $self->_get_dbh->get_info($info);
1135 sub _describe_connection {
1136 require DBI::Const::GetInfoReturn;
1139 $self->ensure_connected;
1142 DBIC_DSN => $self->_dbi_connect_info->[0],
1143 DBI_VER => DBI->VERSION,
1144 DBIC_VER => DBIx::Class->VERSION,
1145 DBIC_DRIVER => ref $self,
1149 #keys %DBI::Const::GetInfoType::GetInfoType,
1151 SQL_CURSOR_COMMIT_BEHAVIOR
1152 SQL_CURSOR_ROLLBACK_BEHAVIOR
1153 SQL_CURSOR_SENSITIVITY
1154 SQL_DATA_SOURCE_NAME
1157 SQL_DEFAULT_TXN_ISOLATION
1162 SQL_EXPRESSIONS_IN_ORDERBY
1165 SQL_IDENTIFIER_QUOTE_CHAR
1166 SQL_MAX_CATALOG_NAME_LEN
1167 SQL_MAX_COLUMN_NAME_LEN
1168 SQL_MAX_IDENTIFIER_LEN
1169 SQL_MAX_TABLE_NAME_LEN
1170 SQL_MULTIPLE_ACTIVE_TXN
1171 SQL_MULT_RESULT_SETS
1172 SQL_NEED_LONG_DATA_LEN
1173 SQL_NON_NULLABLE_COLUMNS
1175 SQL_QUALIFIER_NAME_SEPARATOR
1176 SQL_QUOTED_IDENTIFIER_CASE
1178 SQL_TXN_ISOLATION_OPTION
1181 # some drivers barf on things they do not know about instead
1182 # of returning undef
1183 my $v = try { $self->_dbh_get_info($inf) };
1184 next unless defined $v;
1186 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1187 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1188 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1194 sub _determine_driver {
1197 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1198 my $started_connected = 0;
1199 local $self->{_in_determine_driver} = 1;
1201 if (ref($self) eq __PACKAGE__) {
1203 if ($self->_dbh) { # we are connected
1204 $driver = $self->_dbh->{Driver}{Name};
1205 $started_connected = 1;
1208 # if connect_info is a CODEREF, we have no choice but to connect
1209 if (ref $self->_dbi_connect_info->[0] &&
1210 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1211 $self->_populate_dbh;
1212 $driver = $self->_dbh->{Driver}{Name};
1215 # try to use dsn to not require being connected, the driver may still
1216 # force a connection in _rebless to determine version
1217 # (dsn may not be supplied at all if all we do is make a mock-schema)
1218 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1219 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1220 $driver ||= $ENV{DBI_DRIVER};
1225 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1226 if ($self->load_optional_class($storage_class)) {
1227 mro::set_mro($storage_class, 'c3');
1228 bless $self, $storage_class;
1232 $self->_warn_undetermined_driver(
1233 'This version of DBIC does not yet seem to supply a driver for '
1234 . "your particular RDBMS and/or connection method ('$driver')."
1239 $self->_warn_undetermined_driver(
1240 'Unable to extract a driver name from connect info - this '
1241 . 'should not have happened.'
1246 $self->_driver_determined(1);
1248 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1250 if ($self->can('source_bind_attributes')) {
1251 $self->throw_exception(
1252 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1253 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1254 . 'If you are not sure how to proceed please contact the development team via '
1255 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1259 $self->_init; # run driver-specific initializations
1261 $self->_run_connection_actions
1262 if !$started_connected && defined $self->_dbh;
1266 sub _determine_connector_driver {
1267 my ($self, $conn) = @_;
1269 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1272 $self->_warn_undetermined_driver(
1273 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1274 . "$conn connector - this should not have happened."
1279 $dbtype =~ s/\W/_/gi;
1281 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1282 return if $self->isa($subclass);
1284 if ($self->load_optional_class($subclass)) {
1285 bless $self, $subclass;
1289 $self->_warn_undetermined_driver(
1290 'This version of DBIC does not yet seem to supply a driver for '
1291 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1296 sub _warn_undetermined_driver {
1297 my ($self, $msg) = @_;
1299 require Data::Dumper::Concise;
1301 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1302 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1303 . "does not go away, file a bugreport including the following info:\n"
1304 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1308 sub _do_connection_actions {
1310 my $method_prefix = shift;
1313 if (not ref($call)) {
1314 my $method = $method_prefix . $call;
1316 } elsif (ref($call) eq 'CODE') {
1318 } elsif (ref($call) eq 'ARRAY') {
1319 if (ref($call->[0]) ne 'ARRAY') {
1320 $self->_do_connection_actions($method_prefix, $_) for @$call;
1322 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1325 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1331 sub connect_call_do_sql {
1333 $self->_do_query(@_);
1336 sub disconnect_call_do_sql {
1338 $self->_do_query(@_);
1341 # override in db-specific backend when necessary
1342 sub connect_call_datetime_setup { 1 }
1345 my ($self, $action) = @_;
1347 if (ref $action eq 'CODE') {
1348 $action = $action->($self);
1349 $self->_do_query($_) foreach @$action;
1352 # Most debuggers expect ($sql, @bind), so we need to exclude
1353 # the attribute hash which is the second argument to $dbh->do
1354 # furthermore the bind values are usually to be presented
1355 # as named arrayref pairs, so wrap those here too
1356 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1357 my $sql = shift @do_args;
1358 my $attrs = shift @do_args;
1359 my @bind = map { [ undef, $_ ] } @do_args;
1362 $_[0]->_query_start($sql, \@bind);
1363 $_[1]->do($sql, $attrs, @do_args);
1364 $_[0]->_query_end($sql, \@bind);
1372 my ($self, @info) = @_;
1374 $self->throw_exception("You failed to provide any connection info")
1377 my ($old_connect_via, $dbh);
1379 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1382 if(ref $info[0] eq 'CODE') {
1383 $dbh = $info[0]->();
1387 $dbh = DBI->connect(@info);
1390 die $DBI::errstr unless $dbh;
1392 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1393 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1395 ref $info[0] eq 'CODE'
1396 ? "Connection coderef $info[0] returned a"
1397 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1398 ) unless $dbh->FETCH('Active');
1400 # sanity checks unless asked otherwise
1401 unless ($self->unsafe) {
1403 $self->throw_exception(
1404 'Refusing clobbering of {HandleError} installed on externally supplied '
1405 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1406 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1408 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1409 # request, or an external handle. Complain and set anyway
1410 unless ($dbh->{RaiseError}) {
1411 carp( ref $info[0] eq 'CODE'
1413 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1414 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1415 .'attribute has been supplied'
1417 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1418 .'unsafe => 1. Toggling RaiseError back to true'
1421 $dbh->{RaiseError} = 1;
1424 # this odd anonymous coderef dereference is in fact really
1425 # necessary to avoid the unwanted effect described in perl5
1428 my $weak_self = $_[0];
1431 # the coderef is blessed so we can distinguish it from externally
1432 # supplied handles (which must be preserved)
1433 $_[1]->{HandleError} = bless sub {
1435 $weak_self->throw_exception("DBI Exception: $_[0]");
1438 # the handler may be invoked by something totally out of
1440 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1442 }, '__DBIC__DBH__ERROR__HANDLER__';
1447 $self->throw_exception("DBI Connection failed: $_")
1450 $self->_dbh_autocommit($dbh->{AutoCommit});
1457 # this means we have not yet connected and do not know the AC status
1458 # (e.g. coderef $dbh), need a full-fledged connection check
1459 if (! defined $self->_dbh_autocommit) {
1460 $self->ensure_connected;
1462 # Otherwise simply connect or re-connect on pid changes
1467 $self->next::method(@_);
1470 sub _exec_txn_begin {
1473 # if the user is utilizing txn_do - good for him, otherwise we need to
1474 # ensure that the $dbh is healthy on BEGIN.
1475 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1476 # will be replaced by a failure of begin_work itself (which will be
1477 # then retried on reconnect)
1478 if ($self->{_in_do_block}) {
1479 $self->_dbh->begin_work;
1481 $self->dbh_do(sub { $_[1]->begin_work });
1488 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1489 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1492 # esoteric case for folks using external $dbh handles
1493 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1494 carp "Storage transaction_depth 0 does not match "
1495 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1496 $self->transaction_depth(1);
1499 $self->next::method(@_);
1501 # if AutoCommit is disabled txn_depth never goes to 0
1502 # as a new txn is started immediately on commit
1503 $self->transaction_depth(1) if (
1504 !$self->transaction_depth
1506 defined $self->_dbh_autocommit
1508 ! $self->_dbh_autocommit
1512 sub _exec_txn_commit {
1513 shift->_dbh->commit;
1519 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1520 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1523 # esoteric case for folks using external $dbh handles
1524 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1525 carp "Storage transaction_depth 0 does not match "
1526 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1527 $self->transaction_depth(1);
1530 $self->next::method(@_);
1532 # if AutoCommit is disabled txn_depth never goes to 0
1533 # as a new txn is started immediately on commit
1534 $self->transaction_depth(1) if (
1535 !$self->transaction_depth
1537 defined $self->_dbh_autocommit
1539 ! $self->_dbh_autocommit
1543 sub _exec_txn_rollback {
1544 shift->_dbh->rollback;
1547 # generate some identical methods
1548 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1550 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1552 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1553 $self->throw_exception("Unable to $meth() on a disconnected storage")
1555 $self->next::method(@_);
1559 # This used to be the top-half of _execute. It was split out to make it
1560 # easier to override in NoBindVars without duping the rest. It takes up
1561 # all of _execute's args, and emits $sql, @bind.
1562 sub _prep_for_execute {
1563 #my ($self, $op, $ident, $args) = @_;
1564 return shift->_gen_sql_bind(@_)
1568 my ($self, $op, $ident, $args) = @_;
1570 my ($colinfos, $from);
1571 if ( blessed($ident) ) {
1572 $from = $ident->from;
1573 $colinfos = $ident->columns_info;
1576 my ($sql, @bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1579 ! $ENV{DBIC_DT_SEARCH_OK}
1583 first { blessed($_->[1]) && $_->[1]->isa('DateTime') } @bind
1585 carp_unique 'DateTime objects passed to search() are not supported '
1586 . 'properly (InflateColumn::DateTime formats and settings are not '
1587 . 'respected.) See "Formatting DateTime objects in queries" in '
1588 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1589 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1592 return( $sql, $self->_resolve_bindattrs(
1593 $ident, [ @{$args->[2]{bind}||[]}, @bind ], $colinfos
1597 sub _resolve_bindattrs {
1598 my ($self, $ident, $bind, $colinfos) = @_;
1602 my $resolve_bindinfo = sub {
1603 #my $infohash = shift;
1605 %$colinfos = %{ $self->_resolve_column_info($ident) }
1606 unless keys %$colinfos;
1609 if (my $col = $_[0]->{dbic_colname}) {
1610 $ret = { %{$_[0]} };
1612 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1613 if $colinfos->{$col}{data_type};
1615 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1616 if $colinfos->{$col}{size};
1623 if (ref $_ ne 'ARRAY') {
1626 elsif (! defined $_->[0]) {
1629 elsif (ref $_->[0] eq 'HASH') {
1631 ($_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype}) ? $_->[0] : $resolve_bindinfo->($_->[0]),
1635 elsif (ref $_->[0] eq 'SCALAR') {
1636 [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1639 [ $resolve_bindinfo->({ dbic_colname => $_->[0] }), $_->[1] ]
1644 sub _format_for_trace {
1645 #my ($self, $bind) = @_;
1647 ### Turn @bind from something like this:
1648 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1650 ### ( "'1'", "'3'" )
1653 defined( $_ && $_->[1] )
1660 my ( $self, $sql, $bind ) = @_;
1662 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1667 my ( $self, $sql, $bind ) = @_;
1669 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1673 sub _dbi_attrs_for_bind {
1674 my ($self, $ident, $bind) = @_;
1678 for (map { $_->[0] } @$bind) {
1680 if (exists $_->{dbd_attrs}) {
1683 elsif($_->{sqlt_datatype}) {
1684 # cache the result in the dbh_details hash, as it can not change unless
1685 # we connect to something else
1686 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1687 if (not exists $cache->{$_->{sqlt_datatype}}) {
1688 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1690 $cache->{$_->{sqlt_datatype}};
1693 undef; # always push something at this position
1702 my ($self, $op, $ident, @args) = @_;
1704 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1706 shift->dbh_do( # retry over disconnects
1715 my ($self, undef, $sql, $bind, $ident) = @_;
1717 $self->_query_start( $sql, $bind );
1719 my $bind_attrs = $self->_dbi_attrs_for_bind($ident, $bind);
1721 my $sth = $self->_sth($sql);
1723 for my $i (0 .. $#$bind) {
1724 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1725 $sth->bind_param_inout(
1726 $i + 1, # bind params counts are 1-based
1728 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1735 (ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""'))
1744 # Can this fail without throwing an exception anyways???
1745 my $rv = $sth->execute();
1746 $self->throw_exception(
1747 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1750 $self->_query_end( $sql, $bind );
1752 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1755 sub _prefetch_autovalues {
1756 my ($self, $source, $colinfo, $to_insert) = @_;
1759 for my $col (keys %$colinfo) {
1761 $colinfo->{$col}{auto_nextval}
1764 ! exists $to_insert->{$col}
1766 ref $to_insert->{$col} eq 'SCALAR'
1768 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1771 $values{$col} = $self->_sequence_fetch(
1773 ( $colinfo->{$col}{sequence} ||=
1774 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1784 my ($self, $source, $to_insert) = @_;
1786 my $col_infos = $source->columns_info;
1788 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1790 # fuse the values, but keep a separate list of prefetched_values so that
1791 # they can be fused once again with the final return
1792 $to_insert = { %$to_insert, %$prefetched_values };
1794 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1795 # Investigate what does it take to s/defined/exists/
1796 my %pcols = map { $_ => 1 } $source->primary_columns;
1797 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1798 for my $col ($source->columns) {
1799 if ($col_infos->{$col}{is_auto_increment}) {
1800 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1801 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1804 # nothing to retrieve when explicit values are supplied
1805 next if (defined $to_insert->{$col} and ! (
1806 ref $to_insert->{$col} eq 'SCALAR'
1808 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1811 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1812 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1815 $col_infos->{$col}{retrieve_on_insert}
1819 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1820 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1822 my ($sqla_opts, @ir_container);
1823 if (%retrieve_cols and $self->_use_insert_returning) {
1824 $sqla_opts->{returning_container} = \@ir_container
1825 if $self->_use_insert_returning_bound;
1827 $sqla_opts->{returning} = [
1828 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1832 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1834 my %returned_cols = %$to_insert;
1835 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1836 @ir_container = try {
1837 local $SIG{__WARN__} = sub {};
1838 my @r = $sth->fetchrow_array;
1841 } unless @ir_container;
1843 @returned_cols{@$retlist} = @ir_container if @ir_container;
1846 # pull in PK if needed and then everything else
1847 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1849 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1850 unless $self->can('last_insert_id');
1852 my @pri_values = $self->last_insert_id($source, @missing_pri);
1854 $self->throw_exception( "Can't get last insert id" )
1855 unless (@pri_values == @missing_pri);
1857 @returned_cols{@missing_pri} = @pri_values;
1858 delete $retrieve_cols{$_} for @missing_pri;
1861 # if there is more left to pull
1862 if (%retrieve_cols) {
1863 $self->throw_exception(
1864 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1867 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1869 my $cur = DBIx::Class::ResultSet->new($source, {
1870 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1871 select => \@left_to_fetch,
1874 @returned_cols{@left_to_fetch} = $cur->next;
1876 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1877 if scalar $cur->next;
1881 return { %$prefetched_values, %returned_cols };
1885 my ($self, $source, $cols, $data) = @_;
1887 my @col_range = (0..$#$cols);
1889 # FIXME - perhaps this is not even needed? does DBI stringify?
1891 # forcibly stringify whatever is stringifiable
1892 # ResultSet::populate() hands us a copy - safe to mangle
1893 for my $r (0 .. $#$data) {
1894 for my $c (0 .. $#{$data->[$r]}) {
1895 $data->[$r][$c] = "$data->[$r][$c]"
1896 if ( ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1900 my $colinfos = $source->columns_info($cols);
1902 local $self->{_autoinc_supplied_for_op} =
1903 (first { $_->{is_auto_increment} } values %$colinfos)
1908 # get a slice type index based on first row of data
1909 # a "column" in this context may refer to more than one bind value
1910 # e.g. \[ '?, ?', [...], [...] ]
1912 # construct the value type index - a description of values types for every
1913 # per-column slice of $data:
1915 # nonexistent - nonbind literal
1917 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1919 # also construct the column hash to pass to the SQL generator. For plain
1920 # (non literal) values - convert the members of the first row into a
1921 # literal+bind combo, with extra positional info in the bind attr hashref.
1922 # This will allow us to match the order properly, and is so contrived
1923 # because a user-supplied literal/bind (or something else specific to a
1924 # resultsource and/or storage driver) can inject extra binds along the
1925 # way, so one can't rely on "shift positions" ordering at all. Also we
1926 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1927 # can be later matched up by address), because we want to supply a real
1928 # value on which perhaps e.g. datatype checks will be performed
1929 my ($proto_data, $value_type_by_col_idx);
1930 for my $i (@col_range) {
1931 my $colname = $cols->[$i];
1932 if (ref $data->[0][$i] eq 'SCALAR') {
1933 # no bind value at all - no type
1935 $proto_data->{$colname} = $data->[0][$i];
1937 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
1938 # repack, so we don't end up mangling the original \[]
1939 my ($sql, @bind) = @${$data->[0][$i]};
1941 # normalization of user supplied stuff
1942 my $resolved_bind = $self->_resolve_bindattrs(
1943 $source, \@bind, $colinfos,
1946 # store value-less (attrs only) bind info - we will be comparing all
1947 # supplied binds against this for sanity
1948 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
1950 $proto_data->{$colname} = \[ $sql, map { [
1951 # inject slice order to use for $proto_bind construction
1952 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
1954 $resolved_bind->[$_][1]
1959 $value_type_by_col_idx->{$i} = undef;
1961 $proto_data->{$colname} = \[ '?', [
1962 { dbic_colname => $colname, _bind_data_slice_idx => $i }
1969 my ($sql, $proto_bind) = $self->_prep_for_execute (
1975 if (! @$proto_bind and keys %$value_type_by_col_idx) {
1976 # if the bindlist is empty and we had some dynamic binds, this means the
1977 # storage ate them away (e.g. the NoBindVars component) and interpolated
1978 # them directly into the SQL. This obviously can't be good for multi-inserts
1979 $self->throw_exception('Cannot insert_bulk without support for placeholders');
1983 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
1985 # use an error reporting closure for convenience (less to pass)
1986 my $bad_slice_report_cref = sub {
1987 my ($msg, $r_idx, $c_idx) = @_;
1988 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1992 require Data::Dumper::Concise;
1993 local $Data::Dumper::Maxdepth = 5;
1994 Data::Dumper::Concise::Dumper ({
1995 map { $cols->[$_] =>
2003 for my $col_idx (@col_range) {
2004 my $reference_val = $data->[0][$col_idx];
2006 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2007 my $val = $data->[$row_idx][$col_idx];
2009 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2010 if (ref $val ne 'SCALAR') {
2011 $bad_slice_report_cref->(
2012 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2017 elsif ($$val ne $$reference_val) {
2018 $bad_slice_report_cref->(
2019 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2025 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2026 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2027 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2030 else { # binds from a \[], compare type and attrs
2031 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2032 $bad_slice_report_cref->(
2033 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2038 # start drilling down and bail out early on identical refs
2040 $reference_val != $val
2042 $$reference_val != $$val
2044 if (${$val}->[0] ne ${$reference_val}->[0]) {
2045 $bad_slice_report_cref->(
2046 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2051 # need to check the bind attrs - a bind will happen only once for
2052 # the entire dataset, so any changes further down will be ignored.
2053 elsif (! Data::Compare::Compare(
2054 $value_type_by_col_idx->{$col_idx},
2058 @{$self->_resolve_bindattrs(
2059 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2063 $bad_slice_report_cref->(
2064 'Differing bind attributes on literal/bind values not supported',
2074 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2075 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2077 my $guard = $self->txn_scope_guard;
2079 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2080 my $sth = $self->_sth($sql);
2083 # proto bind contains the information on which pieces of $data to pull
2084 # $cols is passed in only for prettier error-reporting
2085 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2088 # bind_param_array doesn't work if there are no binds
2089 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2093 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2097 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2100 # execute_for_fetch is capable of returning data just fine (it means it
2101 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2102 # is the void-populate fast-path we will just ignore this altogether
2103 # for the time being.
2104 sub _dbh_execute_for_fetch {
2105 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2107 my @idx_range = ( 0 .. $#$proto_bind );
2109 # If we have any bind attributes to take care of, we will bind the
2110 # proto-bind data (which will never be used by execute_for_fetch)
2111 # However since column bindtypes are "sticky", this is sufficient
2112 # to get the DBD to apply the bindtype to all values later on
2114 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2116 for my $i (@idx_range) {
2118 $i+1, # DBI bind indexes are 1-based
2119 $proto_bind->[$i][1],
2121 ) if defined $bind_attrs->[$i];
2124 # At this point $data slots named in the _bind_data_slice_idx of
2125 # each piece of $proto_bind are either \[]s or plain values to be
2126 # passed in. Construct the dispensing coderef. *NOTE* the order
2127 # of $data will differ from this of the ?s in the SQL (due to
2128 # alphabetical ordering by colname). We actually do want to
2129 # preserve this behavior so that prepare_cached has a better
2130 # chance of matching on unrelated calls
2132 my $fetch_row_idx = -1; # saner loop this way
2133 my $fetch_tuple = sub {
2134 return undef if ++$fetch_row_idx > $#$data;
2136 return [ map { defined $_->{_literal_bind_subindex}
2137 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2138 ->[ $_->{_literal_bind_subindex} ]
2140 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2141 } map { $_->[0] } @$proto_bind];
2144 my $tuple_status = [];
2147 $rv = $sth->execute_for_fetch(
2156 # Not all DBDs are create equal. Some throw on error, some return
2157 # an undef $rv, and some set $sth->err - try whatever we can
2158 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2161 ( !defined $rv or $sth->err )
2164 # Statement must finish even if there was an exception.
2169 $err = shift unless defined $err
2174 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2176 $self->throw_exception("Unexpected populate error: $err")
2177 if ($i > $#$tuple_status);
2179 require Data::Dumper::Concise;
2180 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2181 ($tuple_status->[$i][1] || $err),
2182 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2189 sub _dbh_execute_inserts_with_no_binds {
2190 my ($self, $sth, $count) = @_;
2194 my $dbh = $self->_get_dbh;
2195 local $dbh->{RaiseError} = 1;
2196 local $dbh->{PrintError} = 0;
2198 $sth->execute foreach 1..$count;
2204 # Make sure statement is finished even if there was an exception.
2209 $err = shift unless defined $err;
2212 $self->throw_exception($err) if defined $err;
2218 #my ($self, $source, @args) = @_;
2219 shift->_execute('update', @_);
2224 #my ($self, $source, @args) = @_;
2225 shift->_execute('delete', @_);
2230 $self->_execute($self->_select_args(@_));
2233 sub _select_args_to_query {
2236 $self->throw_exception(
2237 "Unable to generate limited query representation with 'software_limit' enabled"
2238 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2240 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2241 # = $self->_select_args($ident, $select, $cond, $attrs);
2242 my ($op, $ident, @args) =
2243 $self->_select_args(@_);
2245 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2246 my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, \@args);
2247 $prepared_bind ||= [];
2250 ? ($sql, $prepared_bind)
2251 : \[ "($sql)", @$prepared_bind ]
2256 my ($self, $ident, $select, $where, $attrs) = @_;
2258 my $sql_maker = $self->sql_maker;
2259 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2266 $rs_alias && $alias2source->{$rs_alias}
2267 ? ( _rsroot_rsrc => $alias2source->{$rs_alias} )
2272 # Sanity check the attributes (SQLMaker does it too, but
2273 # in case of a software_limit we'll never reach there)
2274 if (defined $attrs->{offset}) {
2275 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2276 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2279 if (defined $attrs->{rows}) {
2280 $self->throw_exception("The rows attribute must be a positive integer if present")
2281 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2283 elsif ($attrs->{offset}) {
2284 # MySQL actually recommends this approach. I cringe.
2285 $attrs->{rows} = $sql_maker->__max_int;
2288 my ($complex_prefetch, @limit);
2290 # see if we will need to tear the prefetch apart to satisfy group_by == select
2291 # this is *extremely tricky* to get right
2293 # Follows heavy but necessary analyzis of the group_by - if it refers to any
2294 # sort of non-root column assume the user knows what they are doing and do
2295 # not try to be clever
2297 $attrs->{_related_results_construction}
2301 @{$attrs->{group_by}}
2303 my $grp_aliases = try {
2304 $self->_resolve_aliastypes_from_select_args( $attrs->{from}, undef, undef, { group_by => $attrs->{group_by} } )
2307 $complex_prefetch = ! defined first { $_ ne $rs_alias } keys %{ $grp_aliases->{grouping} || {} };
2310 $complex_prefetch ||= ( $attrs->{rows} && $attrs->{collapse} );
2312 if ($complex_prefetch) {
2313 ($ident, $select, $where, $attrs) =
2314 $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2316 elsif (! $attrs->{software_limit} ) {
2318 $attrs->{rows} || (),
2319 $attrs->{offset} || (),
2323 # try to simplify the joinmap further (prune unreferenced type-single joins)
2329 reftype $ident eq 'ARRAY'
2333 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2337 # This would be the point to deflate anything found in $where
2338 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2339 # expect a result object. And all we have is a resultsource (it is trivial
2340 # to extract deflator coderefs via $alias2source above).
2342 # I don't see a way forward other than changing the way deflators are
2343 # invoked, and that's just bad...
2346 return ('select', $ident, $select, $where, $attrs, @limit);
2349 # Returns a counting SELECT for a simple count
2350 # query. Abstracted so that a storage could override
2351 # this to { count => 'firstcol' } or whatever makes
2352 # sense as a performance optimization
2354 #my ($self, $source, $rs_attrs) = @_;
2355 return { count => '*' };
2362 =item Arguments: $ident, $select, $condition, $attrs
2366 Handle a SQL select statement.
2372 my ($ident, $select, $condition, $attrs) = @_;
2373 return $self->cursor_class->new($self, \@_, $attrs);
2378 my ($rv, $sth, @bind) = $self->_select(@_);
2379 my @row = $sth->fetchrow_array;
2380 my @nextrow = $sth->fetchrow_array if @row;
2381 if(@row && @nextrow) {
2382 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2384 # Need to call finish() to work round broken DBDs
2389 =head2 sql_limit_dialect
2391 This is an accessor for the default SQL limit dialect used by a particular
2392 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2393 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2394 see L<DBIx::Class::SQLMaker::LimitDialects>.
2399 my ($self, $dbh, $sql) = @_;
2401 # 3 is the if_active parameter which avoids active sth re-use
2402 my $sth = $self->disable_sth_caching
2403 ? $dbh->prepare($sql)
2404 : $dbh->prepare_cached($sql, {}, 3);
2406 # XXX You would think RaiseError would make this impossible,
2407 # but apparently that's not true :(
2408 $self->throw_exception(
2411 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
2412 .'an exception and/or setting $dbh->errstr',
2414 ? substr($sql, 0, 20) . '...'
2417 'DBD::' . $dbh->{Driver}{Name},
2425 carp_unique 'sth was mistakenly marked/documented as public, stop calling it (will be removed before DBIC v0.09)';
2430 my ($self, $sql) = @_;
2431 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2434 sub _dbh_columns_info_for {
2435 my ($self, $dbh, $table) = @_;
2437 if ($dbh->can('column_info')) {
2441 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2442 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2444 while ( my $info = $sth->fetchrow_hashref() ){
2446 $column_info{data_type} = $info->{TYPE_NAME};
2447 $column_info{size} = $info->{COLUMN_SIZE};
2448 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2449 $column_info{default_value} = $info->{COLUMN_DEF};
2450 my $col_name = $info->{COLUMN_NAME};
2451 $col_name =~ s/^\"(.*)\"$/$1/;
2453 $result{$col_name} = \%column_info;
2458 return \%result if !$caught && scalar keys %result;
2462 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2464 my @columns = @{$sth->{NAME_lc}};
2465 for my $i ( 0 .. $#columns ){
2467 $column_info{data_type} = $sth->{TYPE}->[$i];
2468 $column_info{size} = $sth->{PRECISION}->[$i];
2469 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2471 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2472 $column_info{data_type} = $1;
2473 $column_info{size} = $2;
2476 $result{$columns[$i]} = \%column_info;
2480 foreach my $col (keys %result) {
2481 my $colinfo = $result{$col};
2482 my $type_num = $colinfo->{data_type};
2484 if(defined $type_num && $dbh->can('type_info')) {
2485 my $type_info = $dbh->type_info($type_num);
2486 $type_name = $type_info->{TYPE_NAME} if $type_info;
2487 $colinfo->{data_type} = $type_name if $type_name;
2494 sub columns_info_for {
2495 my ($self, $table) = @_;
2496 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2499 =head2 last_insert_id
2501 Return the row id of the last insert.
2505 sub _dbh_last_insert_id {
2506 my ($self, $dbh, $source, $col) = @_;
2508 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2510 return $id if defined $id;
2512 my $class = ref $self;
2513 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2516 sub last_insert_id {
2518 $self->_dbh_last_insert_id ($self->_dbh, @_);
2521 =head2 _native_data_type
2525 =item Arguments: $type_name
2529 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2530 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2531 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2533 The default implementation returns C<undef>, implement in your Storage driver if
2534 you need this functionality.
2536 Should map types from other databases to the native RDBMS type, for example
2537 C<VARCHAR2> to C<VARCHAR>.
2539 Types with modifiers should map to the underlying data type. For example,
2540 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2542 Composite types should map to the container type, for example
2543 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2547 sub _native_data_type {
2548 #my ($self, $data_type) = @_;
2552 # Check if placeholders are supported at all
2553 sub _determine_supports_placeholders {
2555 my $dbh = $self->_get_dbh;
2557 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2558 # but it is inaccurate more often than not
2560 local $dbh->{PrintError} = 0;
2561 local $dbh->{RaiseError} = 1;
2562 $dbh->do('select ?', {}, 1);
2570 # Check if placeholders bound to non-string types throw exceptions
2572 sub _determine_supports_typeless_placeholders {
2574 my $dbh = $self->_get_dbh;
2577 local $dbh->{PrintError} = 0;
2578 local $dbh->{RaiseError} = 1;
2579 # this specifically tests a bind that is NOT a string
2580 $dbh->do('select 1 where 1 = ?', {}, 1);
2590 Returns the database driver name.
2595 shift->_get_dbh->{Driver}->{Name};
2598 =head2 bind_attribute_by_data_type
2600 Given a datatype from column info, returns a database specific bind
2601 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2602 let the database planner just handle it.
2604 This method is always called after the driver has been determined and a DBI
2605 connection has been established. Therefore you can refer to C<DBI::$constant>
2606 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2607 the correct modules.
2611 sub bind_attribute_by_data_type {
2615 =head2 is_datatype_numeric
2617 Given a datatype from column_info, returns a boolean value indicating if
2618 the current RDBMS considers it a numeric value. This controls how
2619 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2620 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2621 be performed instead of the usual C<eq>.
2625 sub is_datatype_numeric {
2626 #my ($self, $dt) = @_;
2628 return 0 unless $_[1];
2631 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2636 =head2 create_ddl_dir
2640 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2644 Creates a SQL file based on the Schema, for each of the specified
2645 database engines in C<\@databases> in the given directory.
2646 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2648 Given a previous version number, this will also create a file containing
2649 the ALTER TABLE statements to transform the previous schema into the
2650 current one. Note that these statements may contain C<DROP TABLE> or
2651 C<DROP COLUMN> statements that can potentially destroy data.
2653 The file names are created using the C<ddl_filename> method below, please
2654 override this method in your schema if you would like a different file
2655 name format. For the ALTER file, the same format is used, replacing
2656 $version in the name with "$preversion-$version".
2658 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2659 The most common value for this would be C<< { add_drop_table => 1 } >>
2660 to have the SQL produced include a C<DROP TABLE> statement for each table
2661 created. For quoting purposes supply C<quote_table_names> and
2662 C<quote_field_names>.
2664 If no arguments are passed, then the following default values are assumed:
2668 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2670 =item version - $schema->schema_version
2672 =item directory - './'
2674 =item preversion - <none>
2678 By default, C<\%sqlt_args> will have
2680 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2682 merged with the hash passed in. To disable any of those features, pass in a
2683 hashref like the following
2685 { ignore_constraint_names => 0, # ... other options }
2688 WARNING: You are strongly advised to check all SQL files created, before applying
2693 sub create_ddl_dir {
2694 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2697 carp "No directory given, using ./\n";
2702 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2704 $self->throw_exception(
2705 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2709 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2711 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2712 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2714 my $schema_version = $schema->schema_version || '1.x';
2715 $version ||= $schema_version;
2718 add_drop_table => 1,
2719 ignore_constraint_names => 1,
2720 ignore_index_names => 1,
2724 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2725 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2728 my $sqlt = SQL::Translator->new( $sqltargs );
2730 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2731 my $sqlt_schema = $sqlt->translate({ data => $schema })
2732 or $self->throw_exception ($sqlt->error);
2734 foreach my $db (@$databases) {
2736 $sqlt->{schema} = $sqlt_schema;
2737 $sqlt->producer($db);
2740 my $filename = $schema->ddl_filename($db, $version, $dir);
2741 if (-e $filename && ($version eq $schema_version )) {
2742 # if we are dumping the current version, overwrite the DDL
2743 carp "Overwriting existing DDL file - $filename";
2747 my $output = $sqlt->translate;
2749 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2752 if(!open($file, ">$filename")) {
2753 $self->throw_exception("Can't open $filename for writing ($!)");
2756 print $file $output;
2759 next unless ($preversion);
2761 require SQL::Translator::Diff;
2763 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2764 if(!-e $prefilename) {
2765 carp("No previous schema file found ($prefilename)");
2769 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2771 carp("Overwriting existing diff file - $difffile");
2777 my $t = SQL::Translator->new($sqltargs);
2782 or $self->throw_exception ($t->error);
2784 my $out = $t->translate( $prefilename )
2785 or $self->throw_exception ($t->error);
2787 $source_schema = $t->schema;
2789 $source_schema->name( $prefilename )
2790 unless ( $source_schema->name );
2793 # The "new" style of producers have sane normalization and can support
2794 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2795 # And we have to diff parsed SQL against parsed SQL.
2796 my $dest_schema = $sqlt_schema;
2798 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2799 my $t = SQL::Translator->new($sqltargs);
2804 or $self->throw_exception ($t->error);
2806 my $out = $t->translate( $filename )
2807 or $self->throw_exception ($t->error);
2809 $dest_schema = $t->schema;
2811 $dest_schema->name( $filename )
2812 unless $dest_schema->name;
2815 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2819 if(!open $file, ">$difffile") {
2820 $self->throw_exception("Can't write to $difffile ($!)");
2828 =head2 deployment_statements
2832 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2836 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2838 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2839 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2841 C<$directory> is used to return statements from files in a previously created
2842 L</create_ddl_dir> directory and is optional. The filenames are constructed
2843 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2845 If no C<$directory> is specified then the statements are constructed on the
2846 fly using L<SQL::Translator> and C<$version> is ignored.
2848 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2852 sub deployment_statements {
2853 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2854 $type ||= $self->sqlt_type;
2855 $version ||= $schema->schema_version || '1.x';
2857 my $filename = $schema->ddl_filename($type, $version, $dir);
2860 # FIXME replace this block when a proper sane sql parser is available
2862 open($file, "<$filename")
2863 or $self->throw_exception("Can't open $filename ($!)");
2866 return join('', @rows);
2869 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2870 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2873 # sources needs to be a parser arg, but for simplicty allow at top level
2875 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2876 if exists $sqltargs->{sources};
2878 my $tr = SQL::Translator->new(
2879 producer => "SQL::Translator::Producer::${type}",
2881 parser => 'SQL::Translator::Parser::DBIx::Class',
2885 return preserve_context {
2888 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2889 unless defined $_[0];
2893 # FIXME deploy() currently does not accurately report sql errors
2894 # Will always return true while errors are warned
2896 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2900 return if($line =~ /^--/);
2901 # next if($line =~ /^DROP/m);
2902 return if($line =~ /^BEGIN TRANSACTION/m);
2903 return if($line =~ /^COMMIT/m);
2904 return if $line =~ /^\s+$/; # skip whitespace only
2905 $self->_query_start($line);
2907 # do a dbh_do cycle here, as we need some error checking in
2908 # place (even though we will ignore errors)
2909 $self->dbh_do (sub { $_[1]->do($line) });
2911 carp qq{$_ (running "${line}")};
2913 $self->_query_end($line);
2915 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2916 if (@statements > 1) {
2917 foreach my $statement (@statements) {
2918 $deploy->( $statement );
2921 elsif (@statements == 1) {
2922 # split on single line comments and end of statements
2923 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2929 =head2 datetime_parser
2931 Returns the datetime parser class
2935 sub datetime_parser {
2937 return $self->{datetime_parser} ||= do {
2938 $self->build_datetime_parser(@_);
2942 =head2 datetime_parser_type
2944 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
2946 =head2 build_datetime_parser
2948 See L</datetime_parser>
2952 sub build_datetime_parser {
2954 my $type = $self->datetime_parser_type(@_);
2959 =head2 is_replicating
2961 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2962 replicate from a master database. Default is undef, which is the result
2963 returned by databases that don't support replication.
2967 sub is_replicating {
2972 =head2 lag_behind_master
2974 Returns a number that represents a certain amount of lag behind a master db
2975 when a given storage is replicating. The number is database dependent, but
2976 starts at zero and increases with the amount of lag. Default in undef
2980 sub lag_behind_master {
2984 =head2 relname_to_table_alias
2988 =item Arguments: $relname, $join_count
2990 =item Return Value: $alias
2994 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2997 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2998 way these aliases are named.
3000 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3001 otherwise C<"$relname">.
3005 sub relname_to_table_alias {
3006 my ($self, $relname, $join_count) = @_;
3008 my $alias = ($join_count && $join_count > 1 ?
3009 join('_', $relname, $join_count) : $relname);
3014 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3015 # version and it may be necessary to amend or override it for a specific storage
3016 # if such binds are necessary.
3017 sub _max_column_bytesize {
3018 my ($self, $attr) = @_;
3022 if ($attr->{sqlt_datatype}) {
3023 my $data_type = lc($attr->{sqlt_datatype});
3025 if ($attr->{sqlt_size}) {
3027 # String/sized-binary types
3028 if ($data_type =~ /^(?:
3029 l? (?:var)? char(?:acter)? (?:\s*varying)?
3031 (?:var)? binary (?:\s*varying)?
3036 $max_size = $attr->{sqlt_size};
3038 # Other charset/unicode types, assume scale of 4
3039 elsif ($data_type =~ /^(?:
3040 national \s* character (?:\s*varying)?
3049 $max_size = $attr->{sqlt_size} * 4;
3053 if (!$max_size and !$self->_is_lob_type($data_type)) {
3054 $max_size = 100 # for all other (numeric?) datatypes
3058 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3061 # Determine if a data_type is some type of BLOB
3063 my ($self, $data_type) = @_;
3064 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3065 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3066 |varchar|character\s*varying|nvarchar
3067 |national\s*character\s*varying))?\z/xi);
3070 sub _is_binary_lob_type {
3071 my ($self, $data_type) = @_;
3072 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3073 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3076 sub _is_text_lob_type {
3077 my ($self, $data_type) = @_;
3078 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3079 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3080 |national\s*character\s*varying))\z/xi);
3083 # Determine if a data_type is some type of a binary type
3084 sub _is_binary_type {
3085 my ($self, $data_type) = @_;
3086 $data_type && ($self->_is_binary_lob_type($data_type)
3087 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3094 =head2 DBIx::Class and AutoCommit
3096 DBIx::Class can do some wonderful magic with handling exceptions,
3097 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3098 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3099 transaction support.
3101 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3102 in an assumed transaction between commits, and you're telling us you'd
3103 like to manage that manually. A lot of the magic protections offered by
3104 this module will go away. We can't protect you from exceptions due to database
3105 disconnects because we don't know anything about how to restart your
3106 transactions. You're on your own for handling all sorts of exceptional
3107 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3111 =head1 AUTHOR AND CONTRIBUTORS
3113 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3117 You may distribute this code under the same terms as Perl itself.