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
20 # default cursor class, overridable in connect_info attributes
21 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
23 __PACKAGE__->mk_group_accessors('inherited' => qw/
24 sql_limit_dialect sql_quote_char sql_name_sep
27 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
29 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
30 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
32 __PACKAGE__->sql_name_sep('.');
34 __PACKAGE__->mk_group_accessors('simple' => qw/
35 _connect_info _dbic_connect_attributes _driver_determined
36 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
37 _perform_autoinc_retrieval _autoinc_supplied_for_op
40 # the values for these accessors are picked out (and deleted) from
41 # the attribute hashref passed to connect_info
42 my @storage_options = qw/
43 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
44 disable_sth_caching unsafe auto_savepoint
46 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
49 # capability definitions, using a 2-tiered accessor system
52 # A driver/user may define _use_X, which blindly without any checks says:
53 # "(do not) use this capability", (use_dbms_capability is an "inherited"
56 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
57 # accessor, which in turn calls _determine_supports_X, and stores the return
58 # in a special slot on the storage object, which is wiped every time a $dbh
59 # reconnection takes place (it is not guaranteed that upon reconnection we
60 # will get the same rdbms version). _determine_supports_X does not need to
61 # exist on a driver, as we ->can for it before calling.
63 my @capabilities = (qw/
65 insert_returning_bound
74 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
75 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
77 # on by default, not strictly a capability (pending rewrite)
78 __PACKAGE__->_use_join_optimizer (1);
79 sub _determine_supports_join_optimizer { 1 };
81 # Each of these methods need _determine_driver called before itself
82 # in order to function reliably. This is a purely DRY optimization
84 # get_(use)_dbms_capability need to be called on the correct Storage
85 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
86 # _determine_supports_X which obv. needs a correct driver as well
87 my @rdbms_specific_methods = qw/
106 with_deferred_fk_checks
108 get_use_dbms_capability
115 for my $meth (@rdbms_specific_methods) {
117 my $orig = __PACKAGE__->can ($meth)
118 or die "$meth is not a ::Storage::DBI method!";
121 no warnings qw/redefine/;
122 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
124 # only fire when invoked on an instance, a valid class-based invocation
125 # would e.g. be setting a default for an inherited accessor
128 ! $_[0]->{_driver_determined}
130 ! $_[0]->{_in_determine_driver}
132 # Only try to determine stuff if we have *something* that either is or can
133 # provide a DSN. Allows for bare $schema's generated with a plain ->connect()
134 # to still be marginally useful
135 $_[0]->_dbi_connect_info->[0]
137 $_[0]->_determine_driver;
139 # This for some reason crashes and burns on perl 5.8.1
140 # IFF the method ends up throwing an exception
141 #goto $_[0]->can ($meth);
143 my $cref = $_[0]->can ($meth);
153 DBIx::Class::Storage::DBI - DBI storage handler
157 my $schema = MySchema->connect('dbi:SQLite:my.db');
159 $schema->storage->debug(1);
161 my @stuff = $schema->storage->dbh_do(
163 my ($storage, $dbh, @args) = @_;
164 $dbh->do("DROP TABLE authors");
169 $schema->resultset('Book')->search({
170 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
175 This class represents the connection to an RDBMS via L<DBI>. See
176 L<DBIx::Class::Storage> for general information. This pod only
177 documents DBI-specific methods and behaviors.
184 my $new = shift->next::method(@_);
186 $new->_sql_maker_opts({});
187 $new->_dbh_details({});
188 $new->{_in_do_block} = 0;
190 # read below to see what this does
191 $new->_arm_global_destructor;
196 # This is hack to work around perl shooting stuff in random
197 # order on exit(). If we do not walk the remaining storage
198 # objects in an END block, there is a *small but real* chance
199 # of a fork()ed child to kill the parent's shared DBI handle,
200 # *before perl reaches the DESTROY in this package*
201 # Yes, it is ugly and effective.
202 # Additionally this registry is used by the CLONE method to
203 # make sure no handles are shared between threads
205 my %seek_and_destroy;
207 sub _arm_global_destructor {
209 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
214 local $?; # just in case the DBI destructor changes it somehow
216 # destroy just the object if not native to this process
217 $_->_verify_pid for (grep
219 values %seek_and_destroy
224 # As per DBI's recommendation, DBIC disconnects all handles as
225 # soon as possible (DBIC will reconnect only on demand from within
227 my @instances = grep { defined $_ } values %seek_and_destroy;
228 %seek_and_destroy = ();
233 $_->transaction_depth(0);
236 # properly renumber existing refs
237 $_->_arm_global_destructor
245 # some databases spew warnings on implicit disconnect
246 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
247 local $SIG{__WARN__} = sub {};
250 # this op is necessary, since the very last perl runtime statement
251 # triggers a global destruction shootout, and the $SIG localization
252 # may very well be destroyed before perl actually gets to do the
257 # handle pid changes correctly - do not destroy parent's connection
261 my $pid = $self->_conn_pid;
262 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
263 $dbh->{InactiveDestroy} = 1;
265 $self->transaction_depth(0);
266 $self->savepoints([]);
274 This method is normally called by L<DBIx::Class::Schema/connection>, which
275 encapsulates its argument list in an arrayref before passing them here.
277 The argument list may contain:
283 The same 4-element argument set one would normally pass to
284 L<DBI/connect>, optionally followed by
285 L<extra attributes|/DBIx::Class specific connection attributes>
286 recognized by DBIx::Class:
288 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
292 A single code reference which returns a connected
293 L<DBI database handle|DBI/connect> optionally followed by
294 L<extra attributes|/DBIx::Class specific connection attributes> recognized
297 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
301 A single hashref with all the attributes and the dsn/user/password
304 $connect_info_args = [{
312 $connect_info_args = [{
313 dbh_maker => sub { DBI->connect (...) },
318 This is particularly useful for L<Catalyst> based applications, allowing the
319 following config (L<Config::General> style):
324 dsn dbi:mysql:database=test
331 The C<dsn>/C<user>/C<password> combination can be substituted by the
332 C<dbh_maker> key whose value is a coderef that returns a connected
333 L<DBI database handle|DBI/connect>
337 Please note that the L<DBI> docs recommend that you always explicitly
338 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
339 recommends that it be set to I<1>, and that you perform transactions
340 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
341 to I<1> if you do not do explicitly set it to zero. This is the default
342 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
344 =head3 DBIx::Class specific connection attributes
346 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
347 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
348 the following connection options. These options can be mixed in with your other
349 L<DBI> connection attributes, or placed in a separate hashref
350 (C<\%extra_attributes>) as shown above.
352 Every time C<connect_info> is invoked, any previous settings for
353 these options will be cleared before setting the new ones, regardless of
354 whether any options are specified in the new C<connect_info>.
361 Specifies things to do immediately after connecting or re-connecting to
362 the database. Its value may contain:
368 This contains one SQL statement to execute.
370 =item an array reference
372 This contains SQL statements to execute in order. Each element contains
373 a string or a code reference that returns a string.
375 =item a code reference
377 This contains some code to execute. Unlike code references within an
378 array reference, its return value is ignored.
382 =item on_disconnect_do
384 Takes arguments in the same form as L</on_connect_do> and executes them
385 immediately before disconnecting from the database.
387 Note, this only runs if you explicitly call L</disconnect> on the
390 =item on_connect_call
392 A more generalized form of L</on_connect_do> that calls the specified
393 C<connect_call_METHOD> methods in your storage driver.
395 on_connect_do => 'select 1'
399 on_connect_call => [ [ do_sql => 'select 1' ] ]
401 Its values may contain:
407 Will call the C<connect_call_METHOD> method.
409 =item a code reference
411 Will execute C<< $code->($storage) >>
413 =item an array reference
415 Each value can be a method name or code reference.
417 =item an array of arrays
419 For each array, the first item is taken to be the C<connect_call_> method name
420 or code reference, and the rest are parameters to it.
424 Some predefined storage methods you may use:
430 Executes a SQL string or a code reference that returns a SQL string. This is
431 what L</on_connect_do> and L</on_disconnect_do> use.
439 Will execute the scalar as SQL.
443 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
444 attributes hashref and bind values.
446 =item a code reference
448 Will execute C<< $code->($storage) >> and execute the return array refs as
455 Execute any statements necessary to initialize the database session to return
456 and accept datetime/timestamp values used with
457 L<DBIx::Class::InflateColumn::DateTime>.
459 Only necessary for some databases, see your specific storage driver for
460 implementation details.
464 =item on_disconnect_call
466 Takes arguments in the same form as L</on_connect_call> and executes them
467 immediately before disconnecting from the database.
469 Calls the C<disconnect_call_METHOD> methods as opposed to the
470 C<connect_call_METHOD> methods called by L</on_connect_call>.
472 Note, this only runs if you explicitly call L</disconnect> on the
475 =item disable_sth_caching
477 If set to a true value, this option will disable the caching of
478 statement handles via L<DBI/prepare_cached>.
482 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
483 default L</sql_limit_dialect> setting of the storage (if any). For a list
484 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
488 When true automatically sets L</quote_char> and L</name_sep> to the characters
489 appropriate for your particular RDBMS. This option is preferred over specifying
490 L</quote_char> directly.
494 Specifies what characters to use to quote table and column names.
496 C<quote_char> expects either a single character, in which case is it
497 is placed on either side of the table/column name, or an arrayref of length
498 2 in which case the table/column name is placed between the elements.
500 For example under MySQL you should use C<< quote_char => '`' >>, and for
501 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
505 This parameter is only useful in conjunction with C<quote_char>, and is used to
506 specify the character that separates elements (schemas, tables, columns) from
507 each other. If unspecified it defaults to the most commonly used C<.>.
511 This Storage driver normally installs its own C<HandleError>, sets
512 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
513 all database handles, including those supplied by a coderef. It does this
514 so that it can have consistent and useful error behavior.
516 If you set this option to a true value, Storage will not do its usual
517 modifications to the database handle's attributes, and instead relies on
518 the settings in your connect_info DBI options (or the values you set in
519 your connection coderef, in the case that you are connecting via coderef).
521 Note that your custom settings can cause Storage to malfunction,
522 especially if you set a C<HandleError> handler that suppresses exceptions
523 and/or disable C<RaiseError>.
527 If this option is true, L<DBIx::Class> will use savepoints when nesting
528 transactions, making it possible to recover from failure in the inner
529 transaction without having to abort all outer transactions.
533 Use this argument to supply a cursor class other than the default
534 L<DBIx::Class::Storage::DBI::Cursor>.
538 Some real-life examples of arguments to L</connect_info> and
539 L<DBIx::Class::Schema/connect>
541 # Simple SQLite connection
542 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
545 ->connect_info([ sub { DBI->connect(...) } ]);
547 # Connect via subref in hashref
549 dbh_maker => sub { DBI->connect(...) },
550 on_connect_do => 'alter session ...',
553 # A bit more complicated
560 { quote_char => q{"} },
564 # Equivalent to the previous example
570 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
574 # Same, but with hashref as argument
575 # See parse_connect_info for explanation
578 dsn => 'dbi:Pg:dbname=foo',
580 password => 'my_pg_password',
587 # Subref + DBIx::Class-specific connection options
590 sub { DBI->connect(...) },
594 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
595 disable_sth_caching => 1,
605 my ($self, $info) = @_;
607 return $self->_connect_info if !$info;
609 $self->_connect_info($info); # copy for _connect_info
611 $info = $self->_normalize_connect_info($info)
612 if ref $info eq 'ARRAY';
615 %{ $self->_default_dbi_connect_attributes || {} },
616 %{ $info->{attributes} || {} },
619 my @args = @{ $info->{arguments} };
621 if (keys %attrs and ref $args[0] ne 'CODE') {
623 'You provided explicit AutoCommit => 0 in your connection_info. '
624 . 'This is almost universally a bad idea (see the footnotes of '
625 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
626 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
628 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
630 push @args, \%attrs if keys %attrs;
633 # this is the authoritative "always an arrayref" thing fed to DBI->connect
634 # OR a single-element coderef-based $dbh factory
635 $self->_dbi_connect_info(\@args);
637 # extract the individual storage options
638 for my $storage_opt (keys %{ $info->{storage_options} }) {
639 my $value = $info->{storage_options}{$storage_opt};
641 $self->$storage_opt($value);
644 # Extract the individual sqlmaker options
646 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
647 # the new set of options
648 $self->_sql_maker(undef);
649 $self->_sql_maker_opts({});
651 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
652 my $value = $info->{sql_maker_options}{$sql_maker_opt};
654 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
658 # save attributes in a separate accessor so they are always
659 # introspectable, even in case of a CODE $dbhmaker
660 $self->_dbic_connect_attributes (\%attrs);
662 return $self->_connect_info;
665 sub _dbi_connect_info {
668 return $self->{_dbi_connect_info} = $_[0]
671 my $conninfo = $self->{_dbi_connect_info} || [];
673 # last ditch effort to grab a DSN
674 if ( ! defined $conninfo->[0] and $ENV{DBI_DSN} ) {
675 my @new_conninfo = @$conninfo;
676 $new_conninfo[0] = $ENV{DBI_DSN};
677 $conninfo = \@new_conninfo;
684 sub _normalize_connect_info {
685 my ($self, $info_arg) = @_;
688 my @args = @$info_arg; # take a shallow copy for further mutilation
690 # combine/pre-parse arguments depending on invocation style
693 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
694 %attrs = %{ $args[1] || {} };
697 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
698 %attrs = %{$args[0]};
700 if (my $code = delete $attrs{dbh_maker}) {
703 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
706 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
707 . "to the result of 'dbh_maker'",
709 join (', ', map { "'$_'" } (@ignored) ),
714 @args = delete @attrs{qw/dsn user password/};
717 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
719 % { $args[3] || {} },
720 % { $args[4] || {} },
722 @args = @args[0,1,2];
725 $info{arguments} = \@args;
727 my @storage_opts = grep exists $attrs{$_},
728 @storage_options, 'cursor_class';
730 @{ $info{storage_options} }{@storage_opts} =
731 delete @attrs{@storage_opts} if @storage_opts;
733 my @sql_maker_opts = grep exists $attrs{$_},
734 qw/limit_dialect quote_char name_sep quote_names/;
736 @{ $info{sql_maker_options} }{@sql_maker_opts} =
737 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
739 $info{attributes} = \%attrs if %attrs;
744 sub _default_dbi_connect_attributes () {
749 ShowErrorStatement => 1,
755 This method is deprecated in favour of setting via L</connect_info>.
759 =head2 on_disconnect_do
761 This method is deprecated in favour of setting via L</connect_info>.
765 sub _parse_connect_do {
766 my ($self, $type) = @_;
768 my $val = $self->$type;
769 return () if not defined $val;
774 push @res, [ 'do_sql', $val ];
775 } elsif (ref($val) eq 'CODE') {
777 } elsif (ref($val) eq 'ARRAY') {
778 push @res, map { [ 'do_sql', $_ ] } @$val;
780 $self->throw_exception("Invalid type for $type: ".ref($val));
788 Arguments: ($subref | $method_name), @extra_coderef_args?
790 Execute the given $subref or $method_name using the new exception-based
791 connection management.
793 The first two arguments will be the storage object that C<dbh_do> was called
794 on and a database handle to use. Any additional arguments will be passed
795 verbatim to the called subref as arguments 2 and onwards.
797 Using this (instead of $self->_dbh or $self->dbh) ensures correct
798 exception handling and reconnection (or failover in future subclasses).
800 Your subref should have no side-effects outside of the database, as
801 there is the potential for your subref to be partially double-executed
802 if the database connection was stale/dysfunctional.
806 my @stuff = $schema->storage->dbh_do(
808 my ($storage, $dbh, @cols) = @_;
809 my $cols = join(q{, }, @cols);
810 $dbh->selectrow_array("SELECT $cols FROM foo");
819 my $run_target = shift;
821 # short circuit when we know there is no need for a runner
823 # FIXME - assumption may be wrong
824 # the rationale for the txn_depth check is that if this block is a part
825 # of a larger transaction, everything up to that point is screwed anyway
826 return $self->$run_target($self->_get_dbh, @_)
827 if $self->{_in_do_block} or $self->transaction_depth;
829 # take a ref instead of a copy, to preserve @_ aliasing
830 # semantics within the coderef, but only if needed
831 # (pseudoforking doesn't like this trick much)
832 my $args = @_ ? \@_ : [];
834 DBIx::Class::Storage::BlockRunner->new(
836 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
838 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
843 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
844 shift->next::method(@_);
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 # stops the "implicit rollback on disconnect" warning
866 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
868 %{ $self->_dbh->{CachedKids} } = ();
869 $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->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
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->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
973 $self->_populate_dbh unless $self->_dbh;
979 unless ($self->_sql_maker) {
980 my $sql_maker_class = $self->sql_maker_class;
982 my %opts = %{$self->_sql_maker_opts||{}};
986 $self->sql_limit_dialect
989 my $s_class = (ref $self) || $self;
991 "Your storage class ($s_class) does not set sql_limit_dialect and you "
992 . 'have not supplied an explicit limit_dialect in your connection_info. '
993 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
994 . 'databases but can be (and often is) painfully slow. '
995 . "Please file an RT ticket against '$s_class'"
996 ) if $self->_dbi_connect_info->[0];
1002 my ($quote_char, $name_sep);
1004 if ($opts{quote_names}) {
1005 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1006 my $s_class = (ref $self) || $self;
1008 "You requested 'quote_names' but your storage class ($s_class) does "
1009 . 'not explicitly define a default sql_quote_char and you have not '
1010 . 'supplied a quote_char as part of your connection_info. DBIC will '
1011 .q{default to the ANSI SQL standard quote '"', which works most of }
1012 . "the time. Please file an RT ticket against '$s_class'."
1018 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1021 $self->_sql_maker($sql_maker_class->new(
1022 bindtype=>'columns',
1023 array_datatypes => 1,
1024 limit_dialect => $dialect,
1025 ($quote_char ? (quote_char => $quote_char) : ()),
1026 name_sep => ($name_sep || '.'),
1030 return $self->_sql_maker;
1033 # nothing to do by default
1040 $self->_dbh(undef); # in case ->connected failed we might get sent here
1041 $self->_dbh_details({}); # reset everything we know
1043 $self->_dbh($self->_connect);
1045 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1047 $self->_determine_driver;
1049 # Always set the transaction depth on connect, since
1050 # there is no transaction in progress by definition
1051 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1053 $self->_run_connection_actions unless $self->{_in_determine_driver};
1056 sub _run_connection_actions {
1060 push @actions, ( $self->on_connect_call || () );
1061 push @actions, $self->_parse_connect_do ('on_connect_do');
1063 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1068 sub set_use_dbms_capability {
1069 $_[0]->set_inherited ($_[1], $_[2]);
1072 sub get_use_dbms_capability {
1073 my ($self, $capname) = @_;
1075 my $use = $self->get_inherited ($capname);
1078 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1082 sub set_dbms_capability {
1083 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1086 sub get_dbms_capability {
1087 my ($self, $capname) = @_;
1089 my $cap = $self->_dbh_details->{capability}{$capname};
1091 unless (defined $cap) {
1092 if (my $meth = $self->can ("_determine$capname")) {
1093 $cap = $self->$meth ? 1 : 0;
1099 $self->set_dbms_capability ($capname, $cap);
1109 unless ($info = $self->_dbh_details->{info}) {
1113 my $server_version = try {
1114 $self->_get_server_version
1116 # driver determination *may* use this codepath
1117 # in which case we must rethrow
1118 $self->throw_exception($_) if $self->{_in_determine_driver};
1120 # $server_version on failure
1124 if (defined $server_version) {
1125 $info->{dbms_version} = $server_version;
1127 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1128 my @verparts = split (/\./, $numeric_version);
1134 # consider only up to 3 version parts, iff not more than 3 digits
1136 while (@verparts && @use_parts < 3) {
1137 my $p = shift @verparts;
1139 push @use_parts, $p;
1141 push @use_parts, 0 while @use_parts < 3;
1143 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1147 $self->_dbh_details->{info} = $info;
1153 sub _get_server_version {
1154 shift->_dbh_get_info('SQL_DBMS_VER');
1158 my ($self, $info) = @_;
1160 if ($info =~ /[^0-9]/) {
1161 require DBI::Const::GetInfoType;
1162 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1163 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1164 unless defined $info;
1167 $self->_get_dbh->get_info($info);
1170 sub _describe_connection {
1171 require DBI::Const::GetInfoReturn;
1177 $drv = $self->_extract_driver_from_connect_info;
1178 $self->ensure_connected;
1181 $drv = "DBD::$drv" if $drv;
1184 DBIC_DSN => $self->_dbi_connect_info->[0],
1185 DBI_VER => DBI->VERSION,
1186 DBIC_VER => DBIx::Class->VERSION,
1187 DBIC_DRIVER => ref $self,
1190 DBD_VER => try { $drv->VERSION },
1194 # try to grab data even if we never managed to connect
1195 # will cover us in cases of an oddly broken half-connect
1197 #keys %DBI::Const::GetInfoType::GetInfoType,
1199 SQL_CURSOR_COMMIT_BEHAVIOR
1200 SQL_CURSOR_ROLLBACK_BEHAVIOR
1201 SQL_CURSOR_SENSITIVITY
1202 SQL_DATA_SOURCE_NAME
1205 SQL_DEFAULT_TXN_ISOLATION
1210 SQL_EXPRESSIONS_IN_ORDERBY
1213 SQL_IDENTIFIER_QUOTE_CHAR
1214 SQL_MAX_CATALOG_NAME_LEN
1215 SQL_MAX_COLUMN_NAME_LEN
1216 SQL_MAX_IDENTIFIER_LEN
1217 SQL_MAX_TABLE_NAME_LEN
1218 SQL_MULTIPLE_ACTIVE_TXN
1219 SQL_MULT_RESULT_SETS
1220 SQL_NEED_LONG_DATA_LEN
1221 SQL_NON_NULLABLE_COLUMNS
1223 SQL_QUALIFIER_NAME_SEPARATOR
1224 SQL_QUOTED_IDENTIFIER_CASE
1226 SQL_TXN_ISOLATION_OPTION
1229 # some drivers barf on things they do not know about instead
1230 # of returning undef
1231 my $v = try { $self->_dbh_get_info($inf) };
1232 next unless defined $v;
1234 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1235 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1236 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1242 sub _determine_driver {
1245 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1246 my $started_connected = 0;
1247 local $self->{_in_determine_driver} = 1;
1249 if (ref($self) eq __PACKAGE__) {
1251 if ($self->_dbh) { # we are connected
1252 $driver = $self->_dbh->{Driver}{Name};
1253 $started_connected = 1;
1256 $driver = $self->_extract_driver_from_connect_info;
1260 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1261 if ($self->load_optional_class($storage_class)) {
1262 mro::set_mro($storage_class, 'c3');
1263 bless $self, $storage_class;
1267 $self->_warn_undetermined_driver(
1268 'This version of DBIC does not yet seem to supply a driver for '
1269 . "your particular RDBMS and/or connection method ('$driver')."
1274 $self->_warn_undetermined_driver(
1275 'Unable to extract a driver name from connect info - this '
1276 . 'should not have happened.'
1281 $self->_driver_determined(1);
1283 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1285 if ($self->can('source_bind_attributes')) {
1286 $self->throw_exception(
1287 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1288 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1289 . 'If you are not sure how to proceed please contact the development team via '
1290 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1294 $self->_init; # run driver-specific initializations
1296 $self->_run_connection_actions
1297 if !$started_connected && defined $self->_dbh;
1301 sub _extract_driver_from_connect_info {
1306 # if connect_info is a CODEREF, we have no choice but to connect
1308 ref $self->_dbi_connect_info->[0]
1310 reftype $self->_dbi_connect_info->[0] eq 'CODE'
1312 $self->_populate_dbh;
1313 $drv = $self->_dbh->{Driver}{Name};
1316 # try to use dsn to not require being connected, the driver may still
1317 # force a connection later in _rebless to determine version
1318 # (dsn may not be supplied at all if all we do is make a mock-schema)
1319 ($drv) = ($self->_dbi_connect_info->[0] || '') =~ /^dbi:([^:]+):/i;
1320 $drv ||= $ENV{DBI_DRIVER};
1326 sub _determine_connector_driver {
1327 my ($self, $conn) = @_;
1329 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1332 $self->_warn_undetermined_driver(
1333 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1334 . "$conn connector - this should not have happened."
1339 $dbtype =~ s/\W/_/gi;
1341 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1342 return if $self->isa($subclass);
1344 if ($self->load_optional_class($subclass)) {
1345 bless $self, $subclass;
1349 $self->_warn_undetermined_driver(
1350 'This version of DBIC does not yet seem to supply a driver for '
1351 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1356 sub _warn_undetermined_driver {
1357 my ($self, $msg) = @_;
1359 require Data::Dumper::Concise;
1361 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1362 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1363 . "does not go away, file a bugreport including the following info:\n"
1364 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1368 sub _do_connection_actions {
1370 my $method_prefix = shift;
1373 if (not ref($call)) {
1374 my $method = $method_prefix . $call;
1376 } elsif (ref($call) eq 'CODE') {
1378 } elsif (ref($call) eq 'ARRAY') {
1379 if (ref($call->[0]) ne 'ARRAY') {
1380 $self->_do_connection_actions($method_prefix, $_) for @$call;
1382 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1385 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1391 sub connect_call_do_sql {
1393 $self->_do_query(@_);
1396 sub disconnect_call_do_sql {
1398 $self->_do_query(@_);
1401 # override in db-specific backend when necessary
1402 sub connect_call_datetime_setup { 1 }
1405 my ($self, $action) = @_;
1407 if (ref $action eq 'CODE') {
1408 $action = $action->($self);
1409 $self->_do_query($_) foreach @$action;
1412 # Most debuggers expect ($sql, @bind), so we need to exclude
1413 # the attribute hash which is the second argument to $dbh->do
1414 # furthermore the bind values are usually to be presented
1415 # as named arrayref pairs, so wrap those here too
1416 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1417 my $sql = shift @do_args;
1418 my $attrs = shift @do_args;
1419 my @bind = map { [ undef, $_ ] } @do_args;
1422 $_[0]->_query_start($sql, \@bind);
1423 $_[1]->do($sql, $attrs, @do_args);
1424 $_[0]->_query_end($sql, \@bind);
1434 my $info = $self->_dbi_connect_info;
1436 $self->throw_exception("You did not provide any connection_info")
1437 unless defined $info->[0];
1439 my ($old_connect_via, $dbh);
1441 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1443 # this odd anonymous coderef dereference is in fact really
1444 # necessary to avoid the unwanted effect described in perl5
1447 # in addition the coderef itself can't reside inside the try{} block below
1448 # as it somehow triggers a leak under perl -d
1449 my $dbh_error_handler_installer = sub {
1450 weaken (my $weak_self = $_[0]);
1452 # the coderef is blessed so we can distinguish it from externally
1453 # supplied handles (which must be preserved)
1454 $_[1]->{HandleError} = bless sub {
1456 $weak_self->throw_exception("DBI Exception: $_[0]");
1459 # the handler may be invoked by something totally out of
1461 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1463 }, '__DBIC__DBH__ERROR__HANDLER__';
1467 if(ref $info->[0] eq 'CODE') {
1468 $dbh = $info->[0]->();
1472 $dbh = DBI->connect(@$info);
1475 die $DBI::errstr unless $dbh;
1477 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1478 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1480 ref $info->[0] eq 'CODE'
1481 ? "Connection coderef $info->[0] returned a"
1482 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1483 ) unless $dbh->FETCH('Active');
1485 # sanity checks unless asked otherwise
1486 unless ($self->unsafe) {
1488 $self->throw_exception(
1489 'Refusing clobbering of {HandleError} installed on externally supplied '
1490 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1491 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1493 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1494 # request, or an external handle. Complain and set anyway
1495 unless ($dbh->{RaiseError}) {
1496 carp( ref $info->[0] eq 'CODE'
1498 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1499 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1500 .'attribute has been supplied'
1502 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1503 .'unsafe => 1. Toggling RaiseError back to true'
1506 $dbh->{RaiseError} = 1;
1509 $dbh_error_handler_installer->($self, $dbh);
1513 $self->throw_exception("DBI Connection failed: $_")
1516 $self->_dbh_autocommit($dbh->{AutoCommit});
1523 # this means we have not yet connected and do not know the AC status
1524 # (e.g. coderef $dbh), need a full-fledged connection check
1525 if (! defined $self->_dbh_autocommit) {
1526 $self->ensure_connected;
1528 # Otherwise simply connect or re-connect on pid changes
1533 $self->next::method(@_);
1536 sub _exec_txn_begin {
1539 # if the user is utilizing txn_do - good for him, otherwise we need to
1540 # ensure that the $dbh is healthy on BEGIN.
1541 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1542 # will be replaced by a failure of begin_work itself (which will be
1543 # then retried on reconnect)
1544 if ($self->{_in_do_block}) {
1545 $self->_dbh->begin_work;
1547 $self->dbh_do(sub { $_[1]->begin_work });
1554 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1555 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1558 # esoteric case for folks using external $dbh handles
1559 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1560 carp "Storage transaction_depth 0 does not match "
1561 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1562 $self->transaction_depth(1);
1565 $self->next::method(@_);
1567 # if AutoCommit is disabled txn_depth never goes to 0
1568 # as a new txn is started immediately on commit
1569 $self->transaction_depth(1) if (
1570 !$self->transaction_depth
1572 defined $self->_dbh_autocommit
1574 ! $self->_dbh_autocommit
1578 sub _exec_txn_commit {
1579 shift->_dbh->commit;
1585 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1586 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1589 # esoteric case for folks using external $dbh handles
1590 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1591 carp "Storage transaction_depth 0 does not match "
1592 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1593 $self->transaction_depth(1);
1596 $self->next::method(@_);
1598 # if AutoCommit is disabled txn_depth never goes to 0
1599 # as a new txn is started immediately on commit
1600 $self->transaction_depth(1) if (
1601 !$self->transaction_depth
1603 defined $self->_dbh_autocommit
1605 ! $self->_dbh_autocommit
1609 sub _exec_txn_rollback {
1610 shift->_dbh->rollback;
1613 # generate some identical methods
1614 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1616 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1618 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1619 $self->throw_exception("Unable to $meth() on a disconnected storage")
1621 $self->next::method(@_);
1625 # This used to be the top-half of _execute. It was split out to make it
1626 # easier to override in NoBindVars without duping the rest. It takes up
1627 # all of _execute's args, and emits $sql, @bind.
1628 sub _prep_for_execute {
1629 #my ($self, $op, $ident, $args) = @_;
1630 return shift->_gen_sql_bind(@_)
1634 my ($self, $op, $ident, $args) = @_;
1636 my ($colinfos, $from);
1637 if ( blessed($ident) ) {
1638 $from = $ident->from;
1639 $colinfos = $ident->columns_info;
1643 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1645 $bind = $self->_resolve_bindattrs(
1646 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1650 ! $ENV{DBIC_DT_SEARCH_OK}
1659 $_->[1]->isa('DateTime')
1662 carp_unique 'DateTime objects passed to search() are not supported '
1663 . 'properly (InflateColumn::DateTime formats and settings are not '
1664 . 'respected.) See "Formatting DateTime objects in queries" in '
1665 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1666 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1669 return( $sql, $bind );
1672 sub _resolve_bindattrs {
1673 my ($self, $ident, $bind, $colinfos) = @_;
1677 my $resolve_bindinfo = sub {
1678 #my $infohash = shift;
1680 %$colinfos = %{ $self->_resolve_column_info($ident) }
1681 unless keys %$colinfos;
1684 if (my $col = $_[0]->{dbic_colname}) {
1685 $ret = { %{$_[0]} };
1687 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1688 if $colinfos->{$col}{data_type};
1690 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1691 if $colinfos->{$col}{size};
1699 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1700 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1701 : (ref $_->[0] eq 'HASH') ? [ (exists $_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype})
1703 : $resolve_bindinfo->($_->[0])
1705 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1706 : [ $resolve_bindinfo->(
1707 { dbic_colname => $_->[0] }
1712 ! exists $resolved->[0]{dbd_attrs}
1714 ! $resolved->[0]{sqlt_datatype}
1716 length ref $resolved->[1]
1718 ! overload::Method($resolved->[1], '""')
1720 require Data::Dumper;
1721 local $Data::Dumper::Maxdepth = 1;
1722 local $Data::Dumper::Terse = 1;
1723 local $Data::Dumper::Useqq = 1;
1724 local $Data::Dumper::Indent = 0;
1725 local $Data::Dumper::Pad = ' ';
1726 $self->throw_exception(
1727 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1728 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1737 sub _format_for_trace {
1738 #my ($self, $bind) = @_;
1740 ### Turn @bind from something like this:
1741 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1743 ### ( "'1'", "'3'" )
1746 defined( $_ && $_->[1] )
1753 my ( $self, $sql, $bind ) = @_;
1755 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1760 my ( $self, $sql, $bind ) = @_;
1762 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1766 sub _dbi_attrs_for_bind {
1767 my ($self, $ident, $bind) = @_;
1771 for (map { $_->[0] } @$bind) {
1773 if (exists $_->{dbd_attrs}) {
1776 elsif($_->{sqlt_datatype}) {
1777 # cache the result in the dbh_details hash, as it can not change unless
1778 # we connect to something else
1779 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1780 if (not exists $cache->{$_->{sqlt_datatype}}) {
1781 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1783 $cache->{$_->{sqlt_datatype}};
1786 undef; # always push something at this position
1795 my ($self, $op, $ident, @args) = @_;
1797 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1799 # not even a PID check - we do not care about the state of the _dbh.
1800 # All we need is to get the appropriate drivers loaded if they aren't
1801 # already so that the assumption in ad7c50fc26e holds
1802 $self->_populate_dbh unless $self->_dbh;
1804 $self->dbh_do( _dbh_execute => # retry over disconnects
1807 $self->_dbi_attrs_for_bind($ident, $bind),
1812 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1814 $self->_query_start( $sql, $bind );
1816 my $sth = $self->_bind_sth_params(
1817 $self->_prepare_sth($dbh, $sql),
1822 # Can this fail without throwing an exception anyways???
1823 my $rv = $sth->execute();
1824 $self->throw_exception(
1825 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1828 $self->_query_end( $sql, $bind );
1830 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1834 my ($self, $dbh, $sql) = @_;
1836 # 3 is the if_active parameter which avoids active sth re-use
1837 my $sth = $self->disable_sth_caching
1838 ? $dbh->prepare($sql)
1839 : $dbh->prepare_cached($sql, {}, 3);
1841 # XXX You would think RaiseError would make this impossible,
1842 # but apparently that's not true :(
1843 $self->throw_exception(
1846 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1847 .'an exception and/or setting $dbh->errstr',
1849 ? substr($sql, 0, 20) . '...'
1852 'DBD::' . $dbh->{Driver}{Name},
1859 sub _bind_sth_params {
1860 my ($self, $sth, $bind, $bind_attrs) = @_;
1862 for my $i (0 .. $#$bind) {
1863 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1864 $sth->bind_param_inout(
1865 $i + 1, # bind params counts are 1-based
1867 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1872 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1873 # confirm with dbi-dev whether explicit stringification is needed
1874 my $v = ( length ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""') )
1889 sub _prefetch_autovalues {
1890 my ($self, $source, $colinfo, $to_insert) = @_;
1893 for my $col (keys %$colinfo) {
1895 $colinfo->{$col}{auto_nextval}
1898 ! exists $to_insert->{$col}
1900 ref $to_insert->{$col} eq 'SCALAR'
1902 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1905 $values{$col} = $self->_sequence_fetch(
1907 ( $colinfo->{$col}{sequence} ||=
1908 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1918 my ($self, $source, $to_insert) = @_;
1920 my $col_infos = $source->columns_info;
1922 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1924 # fuse the values, but keep a separate list of prefetched_values so that
1925 # they can be fused once again with the final return
1926 $to_insert = { %$to_insert, %$prefetched_values };
1928 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1929 # Investigate what does it take to s/defined/exists/
1930 my %pcols = map { $_ => 1 } $source->primary_columns;
1931 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1932 for my $col ($source->columns) {
1933 if ($col_infos->{$col}{is_auto_increment}) {
1934 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1935 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1938 # nothing to retrieve when explicit values are supplied
1939 next if (defined $to_insert->{$col} and ! (
1940 ref $to_insert->{$col} eq 'SCALAR'
1942 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1945 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1946 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1949 $col_infos->{$col}{retrieve_on_insert}
1953 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1954 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1956 my ($sqla_opts, @ir_container);
1957 if (%retrieve_cols and $self->_use_insert_returning) {
1958 $sqla_opts->{returning_container} = \@ir_container
1959 if $self->_use_insert_returning_bound;
1961 $sqla_opts->{returning} = [
1962 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1966 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1968 my %returned_cols = %$to_insert;
1969 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1970 @ir_container = try {
1971 local $SIG{__WARN__} = sub {};
1972 my @r = $sth->fetchrow_array;
1975 } unless @ir_container;
1977 @returned_cols{@$retlist} = @ir_container if @ir_container;
1980 # pull in PK if needed and then everything else
1981 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1983 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1984 unless $self->can('last_insert_id');
1986 my @pri_values = $self->last_insert_id($source, @missing_pri);
1988 $self->throw_exception( "Can't get last insert id" )
1989 unless (@pri_values == @missing_pri);
1991 @returned_cols{@missing_pri} = @pri_values;
1992 delete @retrieve_cols{@missing_pri};
1995 # if there is more left to pull
1996 if (%retrieve_cols) {
1997 $self->throw_exception(
1998 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
2001 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
2003 my $cur = DBIx::Class::ResultSet->new($source, {
2004 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
2005 select => \@left_to_fetch,
2008 @returned_cols{@left_to_fetch} = $cur->next;
2010 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
2011 if scalar $cur->next;
2015 return { %$prefetched_values, %returned_cols };
2019 my ($self, $source, $cols, $data) = @_;
2021 my @col_range = (0..$#$cols);
2023 # FIXME SUBOPTIMAL - most likely this is not necessary at all
2024 # confirm with dbi-dev whether explicit stringification is needed
2026 # forcibly stringify whatever is stringifiable
2027 # ResultSet::populate() hands us a copy - safe to mangle
2028 for my $r (0 .. $#$data) {
2029 for my $c (0 .. $#{$data->[$r]}) {
2030 $data->[$r][$c] = "$data->[$r][$c]"
2031 if ( length ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
2035 my $colinfos = $source->columns_info($cols);
2037 local $self->{_autoinc_supplied_for_op} =
2038 (first { $_->{is_auto_increment} } values %$colinfos)
2043 # get a slice type index based on first row of data
2044 # a "column" in this context may refer to more than one bind value
2045 # e.g. \[ '?, ?', [...], [...] ]
2047 # construct the value type index - a description of values types for every
2048 # per-column slice of $data:
2050 # nonexistent - nonbind literal
2052 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2054 # also construct the column hash to pass to the SQL generator. For plain
2055 # (non literal) values - convert the members of the first row into a
2056 # literal+bind combo, with extra positional info in the bind attr hashref.
2057 # This will allow us to match the order properly, and is so contrived
2058 # because a user-supplied literal/bind (or something else specific to a
2059 # resultsource and/or storage driver) can inject extra binds along the
2060 # way, so one can't rely on "shift positions" ordering at all. Also we
2061 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2062 # can be later matched up by address), because we want to supply a real
2063 # value on which perhaps e.g. datatype checks will be performed
2064 my ($proto_data, $value_type_by_col_idx);
2065 for my $i (@col_range) {
2066 my $colname = $cols->[$i];
2067 if (ref $data->[0][$i] eq 'SCALAR') {
2068 # no bind value at all - no type
2070 $proto_data->{$colname} = $data->[0][$i];
2072 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
2073 # repack, so we don't end up mangling the original \[]
2074 my ($sql, @bind) = @${$data->[0][$i]};
2076 # normalization of user supplied stuff
2077 my $resolved_bind = $self->_resolve_bindattrs(
2078 $source, \@bind, $colinfos,
2081 # store value-less (attrs only) bind info - we will be comparing all
2082 # supplied binds against this for sanity
2083 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
2085 $proto_data->{$colname} = \[ $sql, map { [
2086 # inject slice order to use for $proto_bind construction
2087 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
2089 $resolved_bind->[$_][1]
2094 $value_type_by_col_idx->{$i} = undef;
2096 $proto_data->{$colname} = \[ '?', [
2097 { dbic_colname => $colname, _bind_data_slice_idx => $i }
2104 my ($sql, $proto_bind) = $self->_prep_for_execute (
2110 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2111 # if the bindlist is empty and we had some dynamic binds, this means the
2112 # storage ate them away (e.g. the NoBindVars component) and interpolated
2113 # them directly into the SQL. This obviously can't be good for multi-inserts
2114 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2118 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2120 # use an error reporting closure for convenience (less to pass)
2121 my $bad_slice_report_cref = sub {
2122 my ($msg, $r_idx, $c_idx) = @_;
2123 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2127 require Data::Dumper::Concise;
2128 local $Data::Dumper::Maxdepth = 5;
2129 Data::Dumper::Concise::Dumper ({
2130 map { $cols->[$_] =>
2138 for my $col_idx (@col_range) {
2139 my $reference_val = $data->[0][$col_idx];
2141 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2142 my $val = $data->[$row_idx][$col_idx];
2144 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2145 if (ref $val ne 'SCALAR') {
2146 $bad_slice_report_cref->(
2147 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2152 elsif ($$val ne $$reference_val) {
2153 $bad_slice_report_cref->(
2154 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2160 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2161 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2162 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2165 else { # binds from a \[], compare type and attrs
2166 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2167 $bad_slice_report_cref->(
2168 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2173 # start drilling down and bail out early on identical refs
2175 $reference_val != $val
2177 $$reference_val != $$val
2179 if (${$val}->[0] ne ${$reference_val}->[0]) {
2180 $bad_slice_report_cref->(
2181 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2186 # need to check the bind attrs - a bind will happen only once for
2187 # the entire dataset, so any changes further down will be ignored.
2188 elsif (! Data::Compare::Compare(
2189 $value_type_by_col_idx->{$col_idx},
2193 @{$self->_resolve_bindattrs(
2194 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2198 $bad_slice_report_cref->(
2199 'Differing bind attributes on literal/bind values not supported',
2209 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2210 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2212 my $guard = $self->txn_scope_guard;
2214 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2215 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2218 # proto bind contains the information on which pieces of $data to pull
2219 # $cols is passed in only for prettier error-reporting
2220 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2223 # bind_param_array doesn't work if there are no binds
2224 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2228 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2232 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2235 # execute_for_fetch is capable of returning data just fine (it means it
2236 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2237 # is the void-populate fast-path we will just ignore this altogether
2238 # for the time being.
2239 sub _dbh_execute_for_fetch {
2240 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2242 my @idx_range = ( 0 .. $#$proto_bind );
2244 # If we have any bind attributes to take care of, we will bind the
2245 # proto-bind data (which will never be used by execute_for_fetch)
2246 # However since column bindtypes are "sticky", this is sufficient
2247 # to get the DBD to apply the bindtype to all values later on
2249 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2251 for my $i (@idx_range) {
2253 $i+1, # DBI bind indexes are 1-based
2254 $proto_bind->[$i][1],
2256 ) if defined $bind_attrs->[$i];
2259 # At this point $data slots named in the _bind_data_slice_idx of
2260 # each piece of $proto_bind are either \[]s or plain values to be
2261 # passed in. Construct the dispensing coderef. *NOTE* the order
2262 # of $data will differ from this of the ?s in the SQL (due to
2263 # alphabetical ordering by colname). We actually do want to
2264 # preserve this behavior so that prepare_cached has a better
2265 # chance of matching on unrelated calls
2267 my $fetch_row_idx = -1; # saner loop this way
2268 my $fetch_tuple = sub {
2269 return undef if ++$fetch_row_idx > $#$data;
2271 return [ map { defined $_->{_literal_bind_subindex}
2272 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2273 ->[ $_->{_literal_bind_subindex} ]
2275 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2276 } map { $_->[0] } @$proto_bind];
2279 my $tuple_status = [];
2282 $rv = $sth->execute_for_fetch(
2291 # Not all DBDs are create equal. Some throw on error, some return
2292 # an undef $rv, and some set $sth->err - try whatever we can
2293 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2296 ( !defined $rv or $sth->err )
2299 # Statement must finish even if there was an exception.
2304 $err = shift unless defined $err
2309 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2311 $self->throw_exception("Unexpected populate error: $err")
2312 if ($i > $#$tuple_status);
2314 require Data::Dumper::Concise;
2315 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2316 ($tuple_status->[$i][1] || $err),
2317 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2324 sub _dbh_execute_inserts_with_no_binds {
2325 my ($self, $sth, $count) = @_;
2329 my $dbh = $self->_get_dbh;
2330 local $dbh->{RaiseError} = 1;
2331 local $dbh->{PrintError} = 0;
2333 $sth->execute foreach 1..$count;
2339 # Make sure statement is finished even if there was an exception.
2344 $err = shift unless defined $err;
2347 $self->throw_exception($err) if defined $err;
2353 #my ($self, $source, @args) = @_;
2354 shift->_execute('update', @_);
2359 #my ($self, $source, @args) = @_;
2360 shift->_execute('delete', @_);
2365 $self->_execute($self->_select_args(@_));
2368 sub _select_args_to_query {
2371 $self->throw_exception(
2372 "Unable to generate limited query representation with 'software_limit' enabled"
2373 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2375 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2376 # = $self->_select_args($ident, $select, $cond, $attrs);
2377 my ($op, $ident, @args) =
2378 $self->_select_args(@_);
2380 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2381 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2383 # reuse the bind arrayref
2384 unshift @{$bind}, "($sql)";
2389 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2391 # FIXME - that kind of caching would be nice to have
2392 # however currently we *may* pass the same $orig_attrs
2393 # with different ident/select/where
2394 # the whole interface needs to be rethought, since it
2395 # was centered around the flawed SQLA API. We can do
2396 # soooooo much better now. But that is also another
2399 # 'select', @{$orig_attrs->{_sqlmaker_select_args}}
2400 #) if $orig_attrs->{_sqlmaker_select_args};
2402 my $sql_maker = $self->sql_maker;
2403 my $alias2source = $self->_resolve_ident_sources ($ident);
2411 # limit dialects use this stuff
2412 # yes, some CDBICompat crap does not supply an {alias} >.<
2413 ( $orig_attrs->{alias} and $alias2source->{$orig_attrs->{alias}} )
2414 ? ( _rsroot_rsrc => $alias2source->{$orig_attrs->{alias}} )
2419 # Sanity check the attributes (SQLMaker does it too, but
2420 # in case of a software_limit we'll never reach there)
2421 if (defined $attrs->{offset}) {
2422 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2423 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2426 if (defined $attrs->{rows}) {
2427 $self->throw_exception("The rows attribute must be a positive integer if present")
2428 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2430 elsif ($attrs->{offset}) {
2431 # MySQL actually recommends this approach. I cringe.
2432 $attrs->{rows} = $sql_maker->__max_int;
2435 # see if we will need to tear the prefetch apart to satisfy group_by == select
2436 # this is *extremely tricky* to get right, I am still not sure I did
2438 my ($prefetch_needs_subquery, @limit_args);
2440 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2441 # we already know there is a valid group_by (we made it) and we know it is
2442 # intended to be based *only* on non-multi stuff
2443 # short circuit the group_by parsing below
2444 $prefetch_needs_subquery = 1;
2447 # The rationale is that even if we do *not* have collapse, we still
2448 # need to wrap the core grouped select/group_by in a subquery
2449 # so that databases that care about group_by/select equivalence
2450 # are happy (this includes MySQL in strict_mode)
2451 # If any of the other joined tables are referenced in the group_by
2452 # however - the user is on their own
2453 ( $prefetch_needs_subquery or $attrs->{_related_results_construction} )
2457 @{$attrs->{group_by}}
2459 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2460 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2463 # no aliases other than our own in group_by
2464 # if there are - do not allow subquery even if limit is present
2465 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2467 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2468 # active collapse with a limit - that one is a no-brainer unless
2469 # overruled by a group_by above
2470 $prefetch_needs_subquery = 1;
2473 if ($prefetch_needs_subquery) {
2474 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2476 elsif (! $attrs->{software_limit} ) {
2478 $attrs->{rows} || (),
2479 $attrs->{offset} || (),
2483 # try to simplify the joinmap further (prune unreferenced type-single joins)
2485 ! $prefetch_needs_subquery # already pruned
2489 reftype $attrs->{from} eq 'ARRAY'
2491 @{$attrs->{from}} != 1
2493 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2497 # This would be the point to deflate anything found in $attrs->{where}
2498 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2499 # expect a result object. And all we have is a resultsource (it is trivial
2500 # to extract deflator coderefs via $alias2source above).
2502 # I don't see a way forward other than changing the way deflators are
2503 # invoked, and that's just bad...
2506 return ( 'select', @{ $orig_attrs->{_sqlmaker_select_args} = [
2507 @{$attrs}{qw(from select where)}, $attrs, @limit_args
2511 # Returns a counting SELECT for a simple count
2512 # query. Abstracted so that a storage could override
2513 # this to { count => 'firstcol' } or whatever makes
2514 # sense as a performance optimization
2516 #my ($self, $source, $rs_attrs) = @_;
2517 return { count => '*' };
2524 =item Arguments: $ident, $select, $condition, $attrs
2528 Handle a SQL select statement.
2534 my ($ident, $select, $condition, $attrs) = @_;
2535 return $self->cursor_class->new($self, \@_, $attrs);
2540 my ($rv, $sth, @bind) = $self->_select(@_);
2541 my @row = $sth->fetchrow_array;
2542 my @nextrow = $sth->fetchrow_array if @row;
2543 if(@row && @nextrow) {
2544 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2546 # Need to call finish() to work round broken DBDs
2551 =head2 sql_limit_dialect
2553 This is an accessor for the default SQL limit dialect used by a particular
2554 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2555 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2556 see L<DBIx::Class::SQLMaker::LimitDialects>.
2560 sub _dbh_columns_info_for {
2561 my ($self, $dbh, $table) = @_;
2563 if ($dbh->can('column_info')) {
2567 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2568 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2570 while ( my $info = $sth->fetchrow_hashref() ){
2572 $column_info{data_type} = $info->{TYPE_NAME};
2573 $column_info{size} = $info->{COLUMN_SIZE};
2574 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2575 $column_info{default_value} = $info->{COLUMN_DEF};
2576 my $col_name = $info->{COLUMN_NAME};
2577 $col_name =~ s/^\"(.*)\"$/$1/;
2579 $result{$col_name} = \%column_info;
2584 return \%result if !$caught && scalar keys %result;
2588 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2590 my @columns = @{$sth->{NAME_lc}};
2591 for my $i ( 0 .. $#columns ){
2593 $column_info{data_type} = $sth->{TYPE}->[$i];
2594 $column_info{size} = $sth->{PRECISION}->[$i];
2595 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2597 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2598 $column_info{data_type} = $1;
2599 $column_info{size} = $2;
2602 $result{$columns[$i]} = \%column_info;
2606 foreach my $col (keys %result) {
2607 my $colinfo = $result{$col};
2608 my $type_num = $colinfo->{data_type};
2610 if(defined $type_num && $dbh->can('type_info')) {
2611 my $type_info = $dbh->type_info($type_num);
2612 $type_name = $type_info->{TYPE_NAME} if $type_info;
2613 $colinfo->{data_type} = $type_name if $type_name;
2620 sub columns_info_for {
2621 my ($self, $table) = @_;
2622 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2625 =head2 last_insert_id
2627 Return the row id of the last insert.
2631 sub _dbh_last_insert_id {
2632 my ($self, $dbh, $source, $col) = @_;
2634 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2636 return $id if defined $id;
2638 my $class = ref $self;
2639 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2642 sub last_insert_id {
2644 $self->_dbh_last_insert_id ($self->_dbh, @_);
2647 =head2 _native_data_type
2651 =item Arguments: $type_name
2655 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2656 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2657 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2659 The default implementation returns C<undef>, implement in your Storage driver if
2660 you need this functionality.
2662 Should map types from other databases to the native RDBMS type, for example
2663 C<VARCHAR2> to C<VARCHAR>.
2665 Types with modifiers should map to the underlying data type. For example,
2666 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2668 Composite types should map to the container type, for example
2669 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2673 sub _native_data_type {
2674 #my ($self, $data_type) = @_;
2678 # Check if placeholders are supported at all
2679 sub _determine_supports_placeholders {
2681 my $dbh = $self->_get_dbh;
2683 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2684 # but it is inaccurate more often than not
2686 local $dbh->{PrintError} = 0;
2687 local $dbh->{RaiseError} = 1;
2688 $dbh->do('select ?', {}, 1);
2696 # Check if placeholders bound to non-string types throw exceptions
2698 sub _determine_supports_typeless_placeholders {
2700 my $dbh = $self->_get_dbh;
2703 local $dbh->{PrintError} = 0;
2704 local $dbh->{RaiseError} = 1;
2705 # this specifically tests a bind that is NOT a string
2706 $dbh->do('select 1 where 1 = ?', {}, 1);
2716 Returns the database driver name.
2721 shift->_get_dbh->{Driver}->{Name};
2724 =head2 bind_attribute_by_data_type
2726 Given a datatype from column info, returns a database specific bind
2727 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2728 let the database planner just handle it.
2730 This method is always called after the driver has been determined and a DBI
2731 connection has been established. Therefore you can refer to C<DBI::$constant>
2732 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2733 the correct modules.
2737 sub bind_attribute_by_data_type {
2741 =head2 is_datatype_numeric
2743 Given a datatype from column_info, returns a boolean value indicating if
2744 the current RDBMS considers it a numeric value. This controls how
2745 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2746 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2747 be performed instead of the usual C<eq>.
2751 sub is_datatype_numeric {
2752 #my ($self, $dt) = @_;
2754 return 0 unless $_[1];
2757 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2762 =head2 create_ddl_dir
2766 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2770 Creates a SQL file based on the Schema, for each of the specified
2771 database engines in C<\@databases> in the given directory.
2772 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2774 Given a previous version number, this will also create a file containing
2775 the ALTER TABLE statements to transform the previous schema into the
2776 current one. Note that these statements may contain C<DROP TABLE> or
2777 C<DROP COLUMN> statements that can potentially destroy data.
2779 The file names are created using the C<ddl_filename> method below, please
2780 override this method in your schema if you would like a different file
2781 name format. For the ALTER file, the same format is used, replacing
2782 $version in the name with "$preversion-$version".
2784 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2785 The most common value for this would be C<< { add_drop_table => 1 } >>
2786 to have the SQL produced include a C<DROP TABLE> statement for each table
2787 created. For quoting purposes supply C<quote_identifiers>.
2789 If no arguments are passed, then the following default values are assumed:
2793 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2795 =item version - $schema->schema_version
2797 =item directory - './'
2799 =item preversion - <none>
2803 By default, C<\%sqlt_args> will have
2805 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2807 merged with the hash passed in. To disable any of those features, pass in a
2808 hashref like the following
2810 { ignore_constraint_names => 0, # ... other options }
2813 WARNING: You are strongly advised to check all SQL files created, before applying
2818 sub create_ddl_dir {
2819 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2822 carp "No directory given, using ./\n";
2827 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2829 $self->throw_exception(
2830 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2834 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2836 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2837 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2839 my $schema_version = $schema->schema_version || '1.x';
2840 $version ||= $schema_version;
2843 add_drop_table => 1,
2844 ignore_constraint_names => 1,
2845 ignore_index_names => 1,
2849 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2850 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2853 my $sqlt = SQL::Translator->new( $sqltargs );
2855 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2856 my $sqlt_schema = $sqlt->translate({ data => $schema })
2857 or $self->throw_exception ($sqlt->error);
2859 foreach my $db (@$databases) {
2861 $sqlt->{schema} = $sqlt_schema;
2862 $sqlt->producer($db);
2865 my $filename = $schema->ddl_filename($db, $version, $dir);
2866 if (-e $filename && ($version eq $schema_version )) {
2867 # if we are dumping the current version, overwrite the DDL
2868 carp "Overwriting existing DDL file - $filename";
2872 my $output = $sqlt->translate;
2874 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2877 if(!open($file, ">$filename")) {
2878 $self->throw_exception("Can't open $filename for writing ($!)");
2881 print $file $output;
2884 next unless ($preversion);
2886 require SQL::Translator::Diff;
2888 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2889 if(!-e $prefilename) {
2890 carp("No previous schema file found ($prefilename)");
2894 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2896 carp("Overwriting existing diff file - $difffile");
2902 my $t = SQL::Translator->new($sqltargs);
2907 or $self->throw_exception ($t->error);
2909 my $out = $t->translate( $prefilename )
2910 or $self->throw_exception ($t->error);
2912 $source_schema = $t->schema;
2914 $source_schema->name( $prefilename )
2915 unless ( $source_schema->name );
2918 # The "new" style of producers have sane normalization and can support
2919 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2920 # And we have to diff parsed SQL against parsed SQL.
2921 my $dest_schema = $sqlt_schema;
2923 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2924 my $t = SQL::Translator->new($sqltargs);
2929 or $self->throw_exception ($t->error);
2931 my $out = $t->translate( $filename )
2932 or $self->throw_exception ($t->error);
2934 $dest_schema = $t->schema;
2936 $dest_schema->name( $filename )
2937 unless $dest_schema->name;
2940 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2944 if(!open $file, ">$difffile") {
2945 $self->throw_exception("Can't write to $difffile ($!)");
2953 =head2 deployment_statements
2957 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2961 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2963 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2964 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2966 C<$directory> is used to return statements from files in a previously created
2967 L</create_ddl_dir> directory and is optional. The filenames are constructed
2968 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2970 If no C<$directory> is specified then the statements are constructed on the
2971 fly using L<SQL::Translator> and C<$version> is ignored.
2973 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2977 sub deployment_statements {
2978 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2979 $type ||= $self->sqlt_type;
2980 $version ||= $schema->schema_version || '1.x';
2982 my $filename = $schema->ddl_filename($type, $version, $dir);
2985 # FIXME replace this block when a proper sane sql parser is available
2987 open($file, "<$filename")
2988 or $self->throw_exception("Can't open $filename ($!)");
2991 return join('', @rows);
2994 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2995 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2998 # sources needs to be a parser arg, but for simplicity allow at top level
3000 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
3001 if exists $sqltargs->{sources};
3003 my $tr = SQL::Translator->new(
3004 producer => "SQL::Translator::Producer::${type}",
3006 parser => 'SQL::Translator::Parser::DBIx::Class',
3010 return preserve_context {
3013 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
3014 unless defined $_[0];
3018 # FIXME deploy() currently does not accurately report sql errors
3019 # Will always return true while errors are warned
3021 my ($self, $schema, $type, $sqltargs, $dir) = @_;
3025 return if($line =~ /^--/);
3026 # next if($line =~ /^DROP/m);
3027 return if($line =~ /^BEGIN TRANSACTION/m);
3028 return if($line =~ /^COMMIT/m);
3029 return if $line =~ /^\s+$/; # skip whitespace only
3030 $self->_query_start($line);
3032 # do a dbh_do cycle here, as we need some error checking in
3033 # place (even though we will ignore errors)
3034 $self->dbh_do (sub { $_[1]->do($line) });
3036 carp qq{$_ (running "${line}")};
3038 $self->_query_end($line);
3040 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
3041 if (@statements > 1) {
3042 foreach my $statement (@statements) {
3043 $deploy->( $statement );
3046 elsif (@statements == 1) {
3047 # split on single line comments and end of statements
3048 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3054 =head2 datetime_parser
3056 Returns the datetime parser class
3060 sub datetime_parser {
3062 return $self->{datetime_parser} ||= do {
3063 $self->build_datetime_parser(@_);
3067 =head2 datetime_parser_type
3069 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3071 =head2 build_datetime_parser
3073 See L</datetime_parser>
3077 sub build_datetime_parser {
3079 my $type = $self->datetime_parser_type(@_);
3084 =head2 is_replicating
3086 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3087 replicate from a master database. Default is undef, which is the result
3088 returned by databases that don't support replication.
3092 sub is_replicating {
3097 =head2 lag_behind_master
3099 Returns a number that represents a certain amount of lag behind a master db
3100 when a given storage is replicating. The number is database dependent, but
3101 starts at zero and increases with the amount of lag. Default in undef
3105 sub lag_behind_master {
3109 =head2 relname_to_table_alias
3113 =item Arguments: $relname, $join_count
3115 =item Return Value: $alias
3119 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3122 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3123 way these aliases are named.
3125 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3126 otherwise C<"$relname">.
3130 sub relname_to_table_alias {
3131 my ($self, $relname, $join_count) = @_;
3133 my $alias = ($join_count && $join_count > 1 ?
3134 join('_', $relname, $join_count) : $relname);
3139 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3140 # version and it may be necessary to amend or override it for a specific storage
3141 # if such binds are necessary.
3142 sub _max_column_bytesize {
3143 my ($self, $attr) = @_;
3147 if ($attr->{sqlt_datatype}) {
3148 my $data_type = lc($attr->{sqlt_datatype});
3150 if ($attr->{sqlt_size}) {
3152 # String/sized-binary types
3153 if ($data_type =~ /^(?:
3154 l? (?:var)? char(?:acter)? (?:\s*varying)?
3156 (?:var)? binary (?:\s*varying)?
3161 $max_size = $attr->{sqlt_size};
3163 # Other charset/unicode types, assume scale of 4
3164 elsif ($data_type =~ /^(?:
3165 national \s* character (?:\s*varying)?
3174 $max_size = $attr->{sqlt_size} * 4;
3178 if (!$max_size and !$self->_is_lob_type($data_type)) {
3179 $max_size = 100 # for all other (numeric?) datatypes
3183 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3186 # Determine if a data_type is some type of BLOB
3188 my ($self, $data_type) = @_;
3189 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3190 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3191 |varchar|character\s*varying|nvarchar
3192 |national\s*character\s*varying))?\z/xi);
3195 sub _is_binary_lob_type {
3196 my ($self, $data_type) = @_;
3197 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3198 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3201 sub _is_text_lob_type {
3202 my ($self, $data_type) = @_;
3203 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3204 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3205 |national\s*character\s*varying))\z/xi);
3208 # Determine if a data_type is some type of a binary type
3209 sub _is_binary_type {
3210 my ($self, $data_type) = @_;
3211 $data_type && ($self->_is_binary_lob_type($data_type)
3212 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3219 =head2 DBIx::Class and AutoCommit
3221 DBIx::Class can do some wonderful magic with handling exceptions,
3222 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3223 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3224 transaction support.
3226 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3227 in an assumed transaction between commits, and you're telling us you'd
3228 like to manage that manually. A lot of the magic protections offered by
3229 this module will go away. We can't protect you from exceptions due to database
3230 disconnects because we don't know anything about how to restart your
3231 transactions. You're on your own for handling all sorts of exceptional
3232 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3236 =head1 AUTHOR AND CONTRIBUTORS
3238 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3242 You may distribute this code under the same terms as Perl itself.