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 Context::Preserve 'preserve_context';
15 use Data::Compare (); # no imports!!! guard against insane architecture
16 use SQL::Abstract qw(is_plain_value is_literal_value);
17 use DBIx::Class::_Util qw(quote_sub perlstring);
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. We also need to separate accessors
83 # from plain old method calls, since an accessor called as a setter
84 # does *not* need the driver determination loop fired (and in fact
85 # can produce hard to find bugs, like e.g. losing on_connect_*
86 # semantics on fresh connections)
88 # The construct below is simply a parameterized around()
89 my $storage_accessor_idx = { map { $_ => 1 } qw(
96 for my $meth (keys %$storage_accessor_idx, qw(
110 with_deferred_fk_checks
112 get_use_dbms_capability
119 my $orig = __PACKAGE__->can ($meth)
120 or die "$meth is not a ::Storage::DBI method!";
122 my $is_getter = $storage_accessor_idx->{$meth} ? 0 : 1;
125 __PACKAGE__ ."::$meth", sprintf( <<'EOC', $is_getter, perlstring $meth ), { '$orig' => \$orig };
128 # only fire when invoked on an instance, a valid class-based invocation
129 # would e.g. be setting a default for an inherited accessor
132 ! $_[0]->{_driver_determined}
134 ! $_[0]->{_in_determine_driver}
136 # if this is a known *setter* - just set it, no need to connect
137 # and determine the driver
140 # Only try to determine stuff if we have *something* that either is or can
141 # provide a DSN. Allows for bare $schema's generated with a plain ->connect()
142 # to still be marginally useful
143 $_[0]->_dbi_connect_info->[0]
145 $_[0]->_determine_driver;
147 # work around http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
148 goto $_[0]->can(%2$s) unless DBIx::Class::_ENV_::BROKEN_GOTO;
150 my $cref = $_[0]->can(%2$s);
160 DBIx::Class::Storage::DBI - DBI storage handler
164 my $schema = MySchema->connect('dbi:SQLite:my.db');
166 $schema->storage->debug(1);
168 my @stuff = $schema->storage->dbh_do(
170 my ($storage, $dbh, @args) = @_;
171 $dbh->do("DROP TABLE authors");
176 $schema->resultset('Book')->search({
177 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
182 This class represents the connection to an RDBMS via L<DBI>. See
183 L<DBIx::Class::Storage> for general information. This pod only
184 documents DBI-specific methods and behaviors.
191 my $new = shift->next::method(@_);
193 $new->_sql_maker_opts({});
194 $new->_dbh_details({});
195 $new->{_in_do_block} = 0;
197 # read below to see what this does
198 $new->_arm_global_destructor;
203 # This is hack to work around perl shooting stuff in random
204 # order on exit(). If we do not walk the remaining storage
205 # objects in an END block, there is a *small but real* chance
206 # of a fork()ed child to kill the parent's shared DBI handle,
207 # *before perl reaches the DESTROY in this package*
208 # Yes, it is ugly and effective.
209 # Additionally this registry is used by the CLONE method to
210 # make sure no handles are shared between threads
212 my %seek_and_destroy;
214 sub _arm_global_destructor {
216 # quick "garbage collection" pass - prevents the registry
217 # from slowly growing with a bunch of undef-valued keys
218 defined $seek_and_destroy{$_} or delete $seek_and_destroy{$_}
219 for keys %seek_and_destroy;
222 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
227 local $?; # just in case the DBI destructor changes it somehow
229 # destroy just the object if not native to this process
230 $_->_verify_pid for (grep
232 values %seek_and_destroy
237 # As per DBI's recommendation, DBIC disconnects all handles as
238 # soon as possible (DBIC will reconnect only on demand from within
240 my @instances = grep { defined $_ } values %seek_and_destroy;
241 %seek_and_destroy = ();
246 $_->transaction_depth(0);
249 # properly renumber existing refs
250 $_->_arm_global_destructor
258 # some databases spew warnings on implicit disconnect
259 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
260 local $SIG{__WARN__} = sub {};
263 # this op is necessary, since the very last perl runtime statement
264 # triggers a global destruction shootout, and the $SIG localization
265 # may very well be destroyed before perl actually gets to do the
270 # handle pid changes correctly - do not destroy parent's connection
274 my $pid = $self->_conn_pid;
275 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
276 $dbh->{InactiveDestroy} = 1;
278 $self->transaction_depth(0);
279 $self->savepoints([]);
287 This method is normally called by L<DBIx::Class::Schema/connection>, which
288 encapsulates its argument list in an arrayref before passing them here.
290 The argument list may contain:
296 The same 4-element argument set one would normally pass to
297 L<DBI/connect>, optionally followed by
298 L<extra attributes|/DBIx::Class specific connection attributes>
299 recognized by DBIx::Class:
301 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
305 A single code reference which returns a connected
306 L<DBI database handle|DBI/connect> optionally followed by
307 L<extra attributes|/DBIx::Class specific connection attributes> recognized
310 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
314 A single hashref with all the attributes and the dsn/user/password
317 $connect_info_args = [{
325 $connect_info_args = [{
326 dbh_maker => sub { DBI->connect (...) },
331 This is particularly useful for L<Catalyst> based applications, allowing the
332 following config (L<Config::General> style):
337 dsn dbi:mysql:database=test
344 The C<dsn>/C<user>/C<password> combination can be substituted by the
345 C<dbh_maker> key whose value is a coderef that returns a connected
346 L<DBI database handle|DBI/connect>
350 Please note that the L<DBI> docs recommend that you always explicitly
351 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
352 recommends that it be set to I<1>, and that you perform transactions
353 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
354 to I<1> if you do not do explicitly set it to zero. This is the default
355 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
357 =head3 DBIx::Class specific connection attributes
359 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
360 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
361 the following connection options. These options can be mixed in with your other
362 L<DBI> connection attributes, or placed in a separate hashref
363 (C<\%extra_attributes>) as shown above.
365 Every time C<connect_info> is invoked, any previous settings for
366 these options will be cleared before setting the new ones, regardless of
367 whether any options are specified in the new C<connect_info>.
374 Specifies things to do immediately after connecting or re-connecting to
375 the database. Its value may contain:
381 This contains one SQL statement to execute.
383 =item an array reference
385 This contains SQL statements to execute in order. Each element contains
386 a string or a code reference that returns a string.
388 =item a code reference
390 This contains some code to execute. Unlike code references within an
391 array reference, its return value is ignored.
395 =item on_disconnect_do
397 Takes arguments in the same form as L</on_connect_do> and executes them
398 immediately before disconnecting from the database.
400 Note, this only runs if you explicitly call L</disconnect> on the
403 =item on_connect_call
405 A more generalized form of L</on_connect_do> that calls the specified
406 C<connect_call_METHOD> methods in your storage driver.
408 on_connect_do => 'select 1'
412 on_connect_call => [ [ do_sql => 'select 1' ] ]
414 Its values may contain:
420 Will call the C<connect_call_METHOD> method.
422 =item a code reference
424 Will execute C<< $code->($storage) >>
426 =item an array reference
428 Each value can be a method name or code reference.
430 =item an array of arrays
432 For each array, the first item is taken to be the C<connect_call_> method name
433 or code reference, and the rest are parameters to it.
437 Some predefined storage methods you may use:
443 Executes a SQL string or a code reference that returns a SQL string. This is
444 what L</on_connect_do> and L</on_disconnect_do> use.
452 Will execute the scalar as SQL.
456 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
457 attributes hashref and bind values.
459 =item a code reference
461 Will execute C<< $code->($storage) >> and execute the return array refs as
468 Execute any statements necessary to initialize the database session to return
469 and accept datetime/timestamp values used with
470 L<DBIx::Class::InflateColumn::DateTime>.
472 Only necessary for some databases, see your specific storage driver for
473 implementation details.
477 =item on_disconnect_call
479 Takes arguments in the same form as L</on_connect_call> and executes them
480 immediately before disconnecting from the database.
482 Calls the C<disconnect_call_METHOD> methods as opposed to the
483 C<connect_call_METHOD> methods called by L</on_connect_call>.
485 Note, this only runs if you explicitly call L</disconnect> on the
488 =item disable_sth_caching
490 If set to a true value, this option will disable the caching of
491 statement handles via L<DBI/prepare_cached>.
495 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
496 default L</sql_limit_dialect> setting of the storage (if any). For a list
497 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
501 When true automatically sets L</quote_char> and L</name_sep> to the characters
502 appropriate for your particular RDBMS. This option is preferred over specifying
503 L</quote_char> directly.
507 Specifies what characters to use to quote table and column names.
509 C<quote_char> expects either a single character, in which case is it
510 is placed on either side of the table/column name, or an arrayref of length
511 2 in which case the table/column name is placed between the elements.
513 For example under MySQL you should use C<< quote_char => '`' >>, and for
514 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
518 This parameter is only useful in conjunction with C<quote_char>, and is used to
519 specify the character that separates elements (schemas, tables, columns) from
520 each other. If unspecified it defaults to the most commonly used C<.>.
524 This Storage driver normally installs its own C<HandleError>, sets
525 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
526 all database handles, including those supplied by a coderef. It does this
527 so that it can have consistent and useful error behavior.
529 If you set this option to a true value, Storage will not do its usual
530 modifications to the database handle's attributes, and instead relies on
531 the settings in your connect_info DBI options (or the values you set in
532 your connection coderef, in the case that you are connecting via coderef).
534 Note that your custom settings can cause Storage to malfunction,
535 especially if you set a C<HandleError> handler that suppresses exceptions
536 and/or disable C<RaiseError>.
540 If this option is true, L<DBIx::Class> will use savepoints when nesting
541 transactions, making it possible to recover from failure in the inner
542 transaction without having to abort all outer transactions.
546 Use this argument to supply a cursor class other than the default
547 L<DBIx::Class::Storage::DBI::Cursor>.
551 Some real-life examples of arguments to L</connect_info> and
552 L<DBIx::Class::Schema/connect>
554 # Simple SQLite connection
555 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
558 ->connect_info([ sub { DBI->connect(...) } ]);
560 # Connect via subref in hashref
562 dbh_maker => sub { DBI->connect(...) },
563 on_connect_do => 'alter session ...',
566 # A bit more complicated
573 { quote_char => q{"} },
577 # Equivalent to the previous example
583 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
587 # Same, but with hashref as argument
588 # See parse_connect_info for explanation
591 dsn => 'dbi:Pg:dbname=foo',
593 password => 'my_pg_password',
600 # Subref + DBIx::Class-specific connection options
603 sub { DBI->connect(...) },
607 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
608 disable_sth_caching => 1,
618 my ($self, $info) = @_;
620 return $self->_connect_info if !$info;
622 $self->_connect_info($info); # copy for _connect_info
624 $info = $self->_normalize_connect_info($info)
625 if ref $info eq 'ARRAY';
628 %{ $self->_default_dbi_connect_attributes || {} },
629 %{ $info->{attributes} || {} },
632 my @args = @{ $info->{arguments} };
634 if (keys %attrs and ref $args[0] ne 'CODE') {
636 'You provided explicit AutoCommit => 0 in your connection_info. '
637 . 'This is almost universally a bad idea (see the footnotes of '
638 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
639 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
641 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
643 push @args, \%attrs if keys %attrs;
646 # this is the authoritative "always an arrayref" thing fed to DBI->connect
647 # OR a single-element coderef-based $dbh factory
648 $self->_dbi_connect_info(\@args);
650 # extract the individual storage options
651 for my $storage_opt (keys %{ $info->{storage_options} }) {
652 my $value = $info->{storage_options}{$storage_opt};
654 $self->$storage_opt($value);
657 # Extract the individual sqlmaker options
659 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
660 # the new set of options
661 $self->_sql_maker(undef);
662 $self->_sql_maker_opts({});
664 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
665 my $value = $info->{sql_maker_options}{$sql_maker_opt};
667 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
671 # save attributes in a separate accessor so they are always
672 # introspectable, even in case of a CODE $dbhmaker
673 $self->_dbic_connect_attributes (\%attrs);
675 return $self->_connect_info;
678 sub _dbi_connect_info {
681 return $self->{_dbi_connect_info} = $_[0]
684 my $conninfo = $self->{_dbi_connect_info} || [];
686 # last ditch effort to grab a DSN
687 if ( ! defined $conninfo->[0] and $ENV{DBI_DSN} ) {
688 my @new_conninfo = @$conninfo;
689 $new_conninfo[0] = $ENV{DBI_DSN};
690 $conninfo = \@new_conninfo;
697 sub _normalize_connect_info {
698 my ($self, $info_arg) = @_;
701 my @args = @$info_arg; # take a shallow copy for further mutilation
703 # combine/pre-parse arguments depending on invocation style
706 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
707 %attrs = %{ $args[1] || {} };
710 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
711 %attrs = %{$args[0]};
713 if (my $code = delete $attrs{dbh_maker}) {
716 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
719 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
720 . "to the result of 'dbh_maker'",
722 join (', ', map { "'$_'" } (@ignored) ),
727 @args = delete @attrs{qw/dsn user password/};
730 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
732 % { $args[3] || {} },
733 % { $args[4] || {} },
735 @args = @args[0,1,2];
738 $info{arguments} = \@args;
740 my @storage_opts = grep exists $attrs{$_},
741 @storage_options, 'cursor_class';
743 @{ $info{storage_options} }{@storage_opts} =
744 delete @attrs{@storage_opts} if @storage_opts;
746 my @sql_maker_opts = grep exists $attrs{$_},
747 qw/limit_dialect quote_char name_sep quote_names/;
749 @{ $info{sql_maker_options} }{@sql_maker_opts} =
750 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
752 $info{attributes} = \%attrs if %attrs;
757 sub _default_dbi_connect_attributes () {
762 ShowErrorStatement => 1,
768 This method is deprecated in favour of setting via L</connect_info>.
772 =head2 on_disconnect_do
774 This method is deprecated in favour of setting via L</connect_info>.
778 sub _parse_connect_do {
779 my ($self, $type) = @_;
781 my $val = $self->$type;
782 return () if not defined $val;
787 push @res, [ 'do_sql', $val ];
788 } elsif (ref($val) eq 'CODE') {
790 } elsif (ref($val) eq 'ARRAY') {
791 push @res, map { [ 'do_sql', $_ ] } @$val;
793 $self->throw_exception("Invalid type for $type: ".ref($val));
801 Arguments: ($subref | $method_name), @extra_coderef_args?
803 Execute the given $subref or $method_name using the new exception-based
804 connection management.
806 The first two arguments will be the storage object that C<dbh_do> was called
807 on and a database handle to use. Any additional arguments will be passed
808 verbatim to the called subref as arguments 2 and onwards.
810 Using this (instead of $self->_dbh or $self->dbh) ensures correct
811 exception handling and reconnection (or failover in future subclasses).
813 Your subref should have no side-effects outside of the database, as
814 there is the potential for your subref to be partially double-executed
815 if the database connection was stale/dysfunctional.
819 my @stuff = $schema->storage->dbh_do(
821 my ($storage, $dbh, @cols) = @_;
822 my $cols = join(q{, }, @cols);
823 $dbh->selectrow_array("SELECT $cols FROM foo");
832 my $run_target = shift; # either a coderef or a method name
834 # short circuit when we know there is no need for a runner
836 # FIXME - assumption may be wrong
837 # the rationale for the txn_depth check is that if this block is a part
838 # of a larger transaction, everything up to that point is screwed anyway
839 return $self->$run_target($self->_get_dbh, @_)
840 if $self->{_in_do_block} or $self->transaction_depth;
842 # take a ref instead of a copy, to preserve @_ aliasing
843 # semantics within the coderef, but only if needed
844 # (pseudoforking doesn't like this trick much)
845 my $args = @_ ? \@_ : [];
847 DBIx::Class::Storage::BlockRunner->new(
850 retry_handler => sub {
851 $_[0]->failed_attempt_count == 1
853 ! $_[0]->storage->connected
856 $self->$run_target ($self->_get_dbh, @$args )
861 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
862 shift->next::method(@_);
867 Our C<disconnect> method also performs a rollback first if the
868 database is not in C<AutoCommit> mode.
878 push @actions, ( $self->on_disconnect_call || () );
879 push @actions, $self->_parse_connect_do ('on_disconnect_do');
881 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
883 # stops the "implicit rollback on disconnect" warning
884 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
886 %{ $self->_dbh->{CachedKids} } = ();
887 $self->_dbh->disconnect;
892 =head2 with_deferred_fk_checks
896 =item Arguments: C<$coderef>
898 =item Return Value: The return value of $coderef
902 Storage specific method to run the code ref with FK checks deferred or
903 in MySQL's case disabled entirely.
907 # Storage subclasses should override this
908 sub with_deferred_fk_checks {
909 my ($self, $sub) = @_;
917 =item Arguments: none
919 =item Return Value: 1|0
923 Verifies that the current database handle is active and ready to execute
924 an SQL statement (e.g. the connection did not get stale, server is still
925 answering, etc.) This method is used internally by L</dbh>.
931 return 0 unless $self->_seems_connected;
934 local $self->_dbh->{RaiseError} = 1;
939 sub _seems_connected {
942 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
944 my $dbh = $self->_dbh
947 return $dbh->FETCH('Active');
953 my $dbh = $self->_dbh or return 0;
958 sub ensure_connected {
961 unless ($self->connected) {
962 $self->_populate_dbh;
968 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
969 is guaranteed to be healthy by implicitly calling L</connected>, and if
970 necessary performing a reconnection before returning. Keep in mind that this
971 is very B<expensive> on some database engines. Consider using L</dbh_do>
979 if (not $self->_dbh) {
980 $self->_populate_dbh;
982 $self->ensure_connected;
987 # this is the internal "get dbh or connect (don't check)" method
990 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
991 $self->_populate_dbh unless $self->_dbh;
995 # *DELIBERATELY* not a setter (for the time being)
996 # Too intertwined with everything else for any kind of sanity
1000 $self->throw_exception('sql_maker() is not a setter method') if @_;
1002 unless ($self->_sql_maker) {
1003 my $sql_maker_class = $self->sql_maker_class;
1005 my %opts = %{$self->_sql_maker_opts||{}};
1007 $opts{limit_dialect}
1009 $self->sql_limit_dialect
1012 my $s_class = (ref $self) || $self;
1014 "Your storage class ($s_class) does not set sql_limit_dialect and you "
1015 . 'have not supplied an explicit limit_dialect in your connection_info. '
1016 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
1017 . 'databases but can be (and often is) painfully slow. '
1018 . "Please file an RT ticket against '$s_class'"
1019 ) if $self->_dbi_connect_info->[0];
1025 my ($quote_char, $name_sep);
1027 if ($opts{quote_names}) {
1028 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1029 my $s_class = (ref $self) || $self;
1031 "You requested 'quote_names' but your storage class ($s_class) does "
1032 . 'not explicitly define a default sql_quote_char and you have not '
1033 . 'supplied a quote_char as part of your connection_info. DBIC will '
1034 .q{default to the ANSI SQL standard quote '"', which works most of }
1035 . "the time. Please file an RT ticket against '$s_class'."
1041 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1044 $self->_sql_maker($sql_maker_class->new(
1045 bindtype=>'columns',
1046 array_datatypes => 1,
1047 limit_dialect => $dialect,
1048 ($quote_char ? (quote_char => $quote_char) : ()),
1049 name_sep => ($name_sep || '.'),
1053 return $self->_sql_maker;
1056 # nothing to do by default
1063 $self->_dbh(undef); # in case ->connected failed we might get sent here
1064 $self->_dbh_details({}); # reset everything we know
1065 $self->_sql_maker(undef); # this may also end up being different
1067 $self->_dbh($self->_connect);
1069 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1071 $self->_determine_driver;
1073 # Always set the transaction depth on connect, since
1074 # there is no transaction in progress by definition
1075 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1077 $self->_run_connection_actions unless $self->{_in_determine_driver};
1080 sub _run_connection_actions {
1084 push @actions, ( $self->on_connect_call || () );
1085 push @actions, $self->_parse_connect_do ('on_connect_do');
1087 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1092 sub set_use_dbms_capability {
1093 $_[0]->set_inherited ($_[1], $_[2]);
1096 sub get_use_dbms_capability {
1097 my ($self, $capname) = @_;
1099 my $use = $self->get_inherited ($capname);
1102 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1106 sub set_dbms_capability {
1107 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1110 sub get_dbms_capability {
1111 my ($self, $capname) = @_;
1113 my $cap = $self->_dbh_details->{capability}{$capname};
1115 unless (defined $cap) {
1116 if (my $meth = $self->can ("_determine$capname")) {
1117 $cap = $self->$meth ? 1 : 0;
1123 $self->set_dbms_capability ($capname, $cap);
1133 unless ($info = $self->_dbh_details->{info}) {
1137 my $server_version = try {
1138 $self->_get_server_version
1140 # driver determination *may* use this codepath
1141 # in which case we must rethrow
1142 $self->throw_exception($_) if $self->{_in_determine_driver};
1144 # $server_version on failure
1148 if (defined $server_version) {
1149 $info->{dbms_version} = $server_version;
1151 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1152 my @verparts = split (/\./, $numeric_version);
1158 # consider only up to 3 version parts, iff not more than 3 digits
1160 while (@verparts && @use_parts < 3) {
1161 my $p = shift @verparts;
1163 push @use_parts, $p;
1165 push @use_parts, 0 while @use_parts < 3;
1167 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1171 $self->_dbh_details->{info} = $info;
1177 sub _get_server_version {
1178 shift->_dbh_get_info('SQL_DBMS_VER');
1182 my ($self, $info) = @_;
1184 if ($info =~ /[^0-9]/) {
1185 require DBI::Const::GetInfoType;
1186 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1187 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1188 unless defined $info;
1191 $self->_get_dbh->get_info($info);
1194 sub _describe_connection {
1195 require DBI::Const::GetInfoReturn;
1201 $drv = $self->_extract_driver_from_connect_info;
1202 $self->ensure_connected;
1205 $drv = "DBD::$drv" if $drv;
1208 DBIC_DSN => $self->_dbi_connect_info->[0],
1209 DBI_VER => DBI->VERSION,
1210 DBIC_VER => DBIx::Class->VERSION,
1211 DBIC_DRIVER => ref $self,
1214 DBD_VER => try { $drv->VERSION },
1218 # try to grab data even if we never managed to connect
1219 # will cover us in cases of an oddly broken half-connect
1221 #keys %DBI::Const::GetInfoType::GetInfoType,
1223 SQL_CURSOR_COMMIT_BEHAVIOR
1224 SQL_CURSOR_ROLLBACK_BEHAVIOR
1225 SQL_CURSOR_SENSITIVITY
1226 SQL_DATA_SOURCE_NAME
1229 SQL_DEFAULT_TXN_ISOLATION
1234 SQL_EXPRESSIONS_IN_ORDERBY
1237 SQL_IDENTIFIER_QUOTE_CHAR
1238 SQL_MAX_CATALOG_NAME_LEN
1239 SQL_MAX_COLUMN_NAME_LEN
1240 SQL_MAX_IDENTIFIER_LEN
1241 SQL_MAX_TABLE_NAME_LEN
1242 SQL_MULTIPLE_ACTIVE_TXN
1243 SQL_MULT_RESULT_SETS
1244 SQL_NEED_LONG_DATA_LEN
1245 SQL_NON_NULLABLE_COLUMNS
1247 SQL_QUALIFIER_NAME_SEPARATOR
1248 SQL_QUOTED_IDENTIFIER_CASE
1250 SQL_TXN_ISOLATION_OPTION
1253 # some drivers barf on things they do not know about instead
1254 # of returning undef
1255 my $v = try { $self->_dbh_get_info($inf) };
1256 next unless defined $v;
1258 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1259 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1260 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1266 sub _determine_driver {
1269 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1270 my $started_connected = 0;
1271 local $self->{_in_determine_driver} = 1;
1273 if (ref($self) eq __PACKAGE__) {
1275 if ($self->_dbh) { # we are connected
1276 $driver = $self->_dbh->{Driver}{Name};
1277 $started_connected = 1;
1280 $driver = $self->_extract_driver_from_connect_info;
1284 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1285 if ($self->load_optional_class($storage_class)) {
1286 mro::set_mro($storage_class, 'c3');
1287 bless $self, $storage_class;
1291 $self->_warn_undetermined_driver(
1292 'This version of DBIC does not yet seem to supply a driver for '
1293 . "your particular RDBMS and/or connection method ('$driver')."
1298 $self->_warn_undetermined_driver(
1299 'Unable to extract a driver name from connect info - this '
1300 . 'should not have happened.'
1305 $self->_driver_determined(1);
1307 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1309 if ($self->can('source_bind_attributes')) {
1310 $self->throw_exception(
1311 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1312 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1313 . 'If you are not sure how to proceed please contact the development team via '
1314 . DBIx::Class::_ENV_::HELP_URL
1318 $self->_init; # run driver-specific initializations
1320 $self->_run_connection_actions
1321 if !$started_connected && defined $self->_dbh;
1325 sub _extract_driver_from_connect_info {
1330 # if connect_info is a CODEREF, we have no choice but to connect
1332 ref $self->_dbi_connect_info->[0]
1334 reftype $self->_dbi_connect_info->[0] eq 'CODE'
1336 $self->_populate_dbh;
1337 $drv = $self->_dbh->{Driver}{Name};
1340 # try to use dsn to not require being connected, the driver may still
1341 # force a connection later in _rebless to determine version
1342 # (dsn may not be supplied at all if all we do is make a mock-schema)
1343 ($drv) = ($self->_dbi_connect_info->[0] || '') =~ /^dbi:([^:]+):/i;
1344 $drv ||= $ENV{DBI_DRIVER};
1350 sub _determine_connector_driver {
1351 my ($self, $conn) = @_;
1353 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1356 $self->_warn_undetermined_driver(
1357 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1358 . "$conn connector - this should not have happened."
1363 $dbtype =~ s/\W/_/gi;
1365 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1366 return if $self->isa($subclass);
1368 if ($self->load_optional_class($subclass)) {
1369 bless $self, $subclass;
1373 $self->_warn_undetermined_driver(
1374 'This version of DBIC does not yet seem to supply a driver for '
1375 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1380 sub _warn_undetermined_driver {
1381 my ($self, $msg) = @_;
1383 require Data::Dumper::Concise;
1385 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1386 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1387 . "does not go away, file a bugreport including the following info:\n"
1388 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1392 sub _do_connection_actions {
1394 my $method_prefix = shift;
1397 if (not ref($call)) {
1398 my $method = $method_prefix . $call;
1400 } elsif (ref($call) eq 'CODE') {
1402 } elsif (ref($call) eq 'ARRAY') {
1403 if (ref($call->[0]) ne 'ARRAY') {
1404 $self->_do_connection_actions($method_prefix, $_) for @$call;
1406 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1409 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1415 sub connect_call_do_sql {
1417 $self->_do_query(@_);
1420 sub disconnect_call_do_sql {
1422 $self->_do_query(@_);
1425 # override in db-specific backend when necessary
1426 sub connect_call_datetime_setup { 1 }
1429 my ($self, $action) = @_;
1431 if (ref $action eq 'CODE') {
1432 $action = $action->($self);
1433 $self->_do_query($_) foreach @$action;
1436 # Most debuggers expect ($sql, @bind), so we need to exclude
1437 # the attribute hash which is the second argument to $dbh->do
1438 # furthermore the bind values are usually to be presented
1439 # as named arrayref pairs, so wrap those here too
1440 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1441 my $sql = shift @do_args;
1442 my $attrs = shift @do_args;
1443 my @bind = map { [ undef, $_ ] } @do_args;
1446 $_[0]->_query_start($sql, \@bind);
1447 $_[1]->do($sql, $attrs, @do_args);
1448 $_[0]->_query_end($sql, \@bind);
1458 my $info = $self->_dbi_connect_info;
1460 $self->throw_exception("You did not provide any connection_info")
1461 unless defined $info->[0];
1463 my ($old_connect_via, $dbh);
1465 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1467 # this odd anonymous coderef dereference is in fact really
1468 # necessary to avoid the unwanted effect described in perl5
1471 # in addition the coderef itself can't reside inside the try{} block below
1472 # as it somehow triggers a leak under perl -d
1473 my $dbh_error_handler_installer = sub {
1474 weaken (my $weak_self = $_[0]);
1476 # the coderef is blessed so we can distinguish it from externally
1477 # supplied handles (which must be preserved)
1478 $_[1]->{HandleError} = bless sub {
1480 $weak_self->throw_exception("DBI Exception: $_[0]");
1483 # the handler may be invoked by something totally out of
1485 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1487 }, '__DBIC__DBH__ERROR__HANDLER__';
1491 if(ref $info->[0] eq 'CODE') {
1492 $dbh = $info->[0]->();
1496 $dbh = DBI->connect(@$info);
1499 die $DBI::errstr unless $dbh;
1501 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1502 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1504 ref $info->[0] eq 'CODE'
1505 ? "Connection coderef $info->[0] returned a"
1506 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1507 ) unless $dbh->FETCH('Active');
1509 # sanity checks unless asked otherwise
1510 unless ($self->unsafe) {
1512 $self->throw_exception(
1513 'Refusing clobbering of {HandleError} installed on externally supplied '
1514 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1515 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1517 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1518 # request, or an external handle. Complain and set anyway
1519 unless ($dbh->{RaiseError}) {
1520 carp( ref $info->[0] eq 'CODE'
1522 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1523 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1524 .'attribute has been supplied'
1526 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1527 .'unsafe => 1. Toggling RaiseError back to true'
1530 $dbh->{RaiseError} = 1;
1533 $dbh_error_handler_installer->($self, $dbh);
1537 $self->throw_exception("DBI Connection failed: $_")
1540 $self->_dbh_autocommit($dbh->{AutoCommit});
1547 # this means we have not yet connected and do not know the AC status
1548 # (e.g. coderef $dbh), need a full-fledged connection check
1549 if (! defined $self->_dbh_autocommit) {
1550 $self->ensure_connected;
1552 # Otherwise simply connect or re-connect on pid changes
1557 $self->next::method(@_);
1560 sub _exec_txn_begin {
1563 # if the user is utilizing txn_do - good for him, otherwise we need to
1564 # ensure that the $dbh is healthy on BEGIN.
1565 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1566 # will be replaced by a failure of begin_work itself (which will be
1567 # then retried on reconnect)
1568 if ($self->{_in_do_block}) {
1569 $self->_dbh->begin_work;
1571 $self->dbh_do(sub { $_[1]->begin_work });
1578 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1579 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1582 # esoteric case for folks using external $dbh handles
1583 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1584 carp "Storage transaction_depth 0 does not match "
1585 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1586 $self->transaction_depth(1);
1589 $self->next::method(@_);
1591 # if AutoCommit is disabled txn_depth never goes to 0
1592 # as a new txn is started immediately on commit
1593 $self->transaction_depth(1) if (
1594 !$self->transaction_depth
1596 defined $self->_dbh_autocommit
1598 ! $self->_dbh_autocommit
1602 sub _exec_txn_commit {
1603 shift->_dbh->commit;
1609 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1610 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1613 # esoteric case for folks using external $dbh handles
1614 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1615 carp "Storage transaction_depth 0 does not match "
1616 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1617 $self->transaction_depth(1);
1620 $self->next::method(@_);
1622 # if AutoCommit is disabled txn_depth never goes to 0
1623 # as a new txn is started immediately on commit
1624 $self->transaction_depth(1) if (
1625 !$self->transaction_depth
1627 defined $self->_dbh_autocommit
1629 ! $self->_dbh_autocommit
1633 sub _exec_txn_rollback {
1634 shift->_dbh->rollback;
1637 # generate the DBI-specific stubs, which then fallback to ::Storage proper
1638 quote_sub __PACKAGE__ . "::$_" => sprintf (<<'EOS', $_) for qw(svp_begin svp_release svp_rollback);
1639 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1640 $_[0]->throw_exception('Unable to %s() on a disconnected storage')
1642 shift->next::method(@_);
1645 # This used to be the top-half of _execute. It was split out to make it
1646 # easier to override in NoBindVars without duping the rest. It takes up
1647 # all of _execute's args, and emits $sql, @bind.
1648 sub _prep_for_execute {
1649 #my ($self, $op, $ident, $args) = @_;
1650 return shift->_gen_sql_bind(@_)
1654 my ($self, $op, $ident, $args) = @_;
1656 my ($colinfos, $from);
1657 if ( blessed($ident) ) {
1658 $from = $ident->from;
1659 $colinfos = $ident->columns_info;
1663 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1665 $bind = $self->_resolve_bindattrs(
1666 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1670 ! $ENV{DBIC_DT_SEARCH_OK}
1679 $_->[1]->isa('DateTime')
1682 carp_unique 'DateTime objects passed to search() are not supported '
1683 . 'properly (InflateColumn::DateTime formats and settings are not '
1684 . 'respected.) See "Formatting DateTime objects in queries" in '
1685 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1686 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1689 return( $sql, $bind );
1692 sub _resolve_bindattrs {
1693 my ($self, $ident, $bind, $colinfos) = @_;
1695 my $resolve_bindinfo = sub {
1696 #my $infohash = shift;
1698 $colinfos ||= { %{ $self->_resolve_column_info($ident) } };
1701 if (my $col = $_[0]->{dbic_colname}) {
1702 $ret = { %{$_[0]} };
1704 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1705 if $colinfos->{$col}{data_type};
1707 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1708 if $colinfos->{$col}{size};
1716 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1717 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1718 : (ref $_->[0] eq 'HASH') ? [(
1721 exists $_->[0]{dbd_attrs}
1723 $_->[0]{sqlt_datatype}
1725 : $resolve_bindinfo->($_->[0])
1728 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1729 : [ $resolve_bindinfo->(
1730 { dbic_colname => $_->[0] }
1735 ! exists $resolved->[0]{dbd_attrs}
1737 ! $resolved->[0]{sqlt_datatype}
1739 length ref $resolved->[1]
1741 ! is_plain_value $resolved->[1]
1743 require Data::Dumper;
1744 local $Data::Dumper::Maxdepth = 1;
1745 local $Data::Dumper::Terse = 1;
1746 local $Data::Dumper::Useqq = 1;
1747 local $Data::Dumper::Indent = 0;
1748 local $Data::Dumper::Pad = ' ';
1749 $self->throw_exception(
1750 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1751 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1760 sub _format_for_trace {
1761 #my ($self, $bind) = @_;
1763 ### Turn @bind from something like this:
1764 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1766 ### ( "'1'", "'3'" )
1769 defined( $_ && $_->[1] )
1776 my ( $self, $sql, $bind ) = @_;
1778 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1783 my ( $self, $sql, $bind ) = @_;
1785 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1789 sub _dbi_attrs_for_bind {
1790 my ($self, $ident, $bind) = @_;
1794 for (map { $_->[0] } @$bind) {
1796 if (exists $_->{dbd_attrs}) {
1799 elsif($_->{sqlt_datatype}) {
1800 # cache the result in the dbh_details hash, as it can not change unless
1801 # we connect to something else
1802 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1803 if (not exists $cache->{$_->{sqlt_datatype}}) {
1804 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1806 $cache->{$_->{sqlt_datatype}};
1809 undef; # always push something at this position
1818 my ($self, $op, $ident, @args) = @_;
1820 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1822 # not even a PID check - we do not care about the state of the _dbh.
1823 # All we need is to get the appropriate drivers loaded if they aren't
1824 # already so that the assumption in ad7c50fc26e holds
1825 $self->_populate_dbh unless $self->_dbh;
1827 $self->dbh_do( _dbh_execute => # retry over disconnects
1830 $self->_dbi_attrs_for_bind($ident, $bind),
1835 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1837 $self->_query_start( $sql, $bind );
1839 my $sth = $self->_bind_sth_params(
1840 $self->_prepare_sth($dbh, $sql),
1845 # Can this fail without throwing an exception anyways???
1846 my $rv = $sth->execute();
1847 $self->throw_exception(
1848 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1851 $self->_query_end( $sql, $bind );
1853 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1857 my ($self, $dbh, $sql) = @_;
1859 # 3 is the if_active parameter which avoids active sth re-use
1860 my $sth = $self->disable_sth_caching
1861 ? $dbh->prepare($sql)
1862 : $dbh->prepare_cached($sql, {}, 3);
1864 # XXX You would think RaiseError would make this impossible,
1865 # but apparently that's not true :(
1866 $self->throw_exception(
1869 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1870 .'an exception and/or setting $dbh->errstr',
1872 ? substr($sql, 0, 20) . '...'
1875 'DBD::' . $dbh->{Driver}{Name},
1882 sub _bind_sth_params {
1883 my ($self, $sth, $bind, $bind_attrs) = @_;
1885 for my $i (0 .. $#$bind) {
1886 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1887 $sth->bind_param_inout(
1888 $i + 1, # bind params counts are 1-based
1890 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1895 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
1896 my $v = ( length ref $bind->[$i][1] and is_plain_value $bind->[$i][1] )
1903 # The temp-var is CRUCIAL - DO NOT REMOVE IT, breaks older DBD::SQLite RT#79576
1913 sub _prefetch_autovalues {
1914 my ($self, $source, $colinfo, $to_insert) = @_;
1917 for my $col (keys %$colinfo) {
1919 $colinfo->{$col}{auto_nextval}
1922 ! exists $to_insert->{$col}
1924 is_literal_value($to_insert->{$col})
1927 $values{$col} = $self->_sequence_fetch(
1929 ( $colinfo->{$col}{sequence} ||=
1930 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1940 my ($self, $source, $to_insert) = @_;
1942 my $col_infos = $source->columns_info;
1944 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1946 # fuse the values, but keep a separate list of prefetched_values so that
1947 # they can be fused once again with the final return
1948 $to_insert = { %$to_insert, %$prefetched_values };
1950 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1951 # Investigate what does it take to s/defined/exists/
1952 my %pcols = map { $_ => 1 } $source->primary_columns;
1953 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1954 for my $col ($source->columns) {
1955 if ($col_infos->{$col}{is_auto_increment}) {
1956 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1957 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1960 # nothing to retrieve when explicit values are supplied
1962 defined $to_insert->{$col} and ! is_literal_value($to_insert->{$col})
1965 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1966 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1969 $col_infos->{$col}{retrieve_on_insert}
1973 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1974 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1976 my ($sqla_opts, @ir_container);
1977 if (%retrieve_cols and $self->_use_insert_returning) {
1978 $sqla_opts->{returning_container} = \@ir_container
1979 if $self->_use_insert_returning_bound;
1981 $sqla_opts->{returning} = [
1982 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1986 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1988 my %returned_cols = %$to_insert;
1989 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1990 @ir_container = try {
1991 local $SIG{__WARN__} = sub {};
1992 my @r = $sth->fetchrow_array;
1995 } unless @ir_container;
1997 @returned_cols{@$retlist} = @ir_container if @ir_container;
2000 # pull in PK if needed and then everything else
2001 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
2003 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
2004 unless $self->can('last_insert_id');
2006 my @pri_values = $self->last_insert_id($source, @missing_pri);
2008 $self->throw_exception( "Can't get last insert id" )
2009 unless (@pri_values == @missing_pri);
2011 @returned_cols{@missing_pri} = @pri_values;
2012 delete @retrieve_cols{@missing_pri};
2015 # if there is more left to pull
2016 if (%retrieve_cols) {
2017 $self->throw_exception(
2018 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
2021 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
2023 my $cur = DBIx::Class::ResultSet->new($source, {
2024 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
2025 select => \@left_to_fetch,
2028 @returned_cols{@left_to_fetch} = $cur->next;
2030 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
2031 if scalar $cur->next;
2035 return { %$prefetched_values, %returned_cols };
2039 my ($self, $source, $cols, $data) = @_;
2041 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
2042 # For the time being forcibly stringify whatever is stringifiable
2043 # ResultSet::populate() hands us a copy - safe to mangle
2044 for my $r (0 .. $#$data) {
2045 for my $c (0 .. $#{$data->[$r]}) {
2046 $data->[$r][$c] = "$data->[$r][$c]"
2047 if ( length ref $data->[$r][$c] and is_plain_value $data->[$r][$c] );
2051 my $colinfos = $source->columns_info($cols);
2053 local $self->{_autoinc_supplied_for_op} =
2054 (grep { $_->{is_auto_increment} } values %$colinfos)
2059 # get a slice type index based on first row of data
2060 # a "column" in this context may refer to more than one bind value
2061 # e.g. \[ '?, ?', [...], [...] ]
2063 # construct the value type index - a description of values types for every
2064 # per-column slice of $data:
2066 # nonexistent - nonbind literal
2068 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2070 # also construct the column hash to pass to the SQL generator. For plain
2071 # (non literal) values - convert the members of the first row into a
2072 # literal+bind combo, with extra positional info in the bind attr hashref.
2073 # This will allow us to match the order properly, and is so contrived
2074 # because a user-supplied literal/bind (or something else specific to a
2075 # resultsource and/or storage driver) can inject extra binds along the
2076 # way, so one can't rely on "shift positions" ordering at all. Also we
2077 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2078 # can be later matched up by address), because we want to supply a real
2079 # value on which perhaps e.g. datatype checks will be performed
2080 my ($proto_data, $value_type_by_col_idx);
2081 for my $col_idx (0..$#$cols) {
2082 my $colname = $cols->[$col_idx];
2083 if (ref $data->[0][$col_idx] eq 'SCALAR') {
2084 # no bind value at all - no type
2086 $proto_data->{$colname} = $data->[0][$col_idx];
2088 elsif (ref $data->[0][$col_idx] eq 'REF' and ref ${$data->[0][$col_idx]} eq 'ARRAY' ) {
2089 # repack, so we don't end up mangling the original \[]
2090 my ($sql, @bind) = @${$data->[0][$col_idx]};
2092 # normalization of user supplied stuff
2093 my $resolved_bind = $self->_resolve_bindattrs(
2094 $source, \@bind, $colinfos,
2097 # store value-less (attrs only) bind info - we will be comparing all
2098 # supplied binds against this for sanity
2099 $value_type_by_col_idx->{$col_idx} = [ map { $_->[0] } @$resolved_bind ];
2101 $proto_data->{$colname} = \[ $sql, map { [
2102 # inject slice order to use for $proto_bind construction
2103 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $col_idx, _literal_bind_subindex => $_+1 }
2105 $resolved_bind->[$_][1]
2110 $value_type_by_col_idx->{$col_idx} = undef;
2112 $proto_data->{$colname} = \[ '?', [
2113 { dbic_colname => $colname, _bind_data_slice_idx => $col_idx }
2115 $data->[0][$col_idx]
2120 my ($sql, $proto_bind) = $self->_prep_for_execute (
2126 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2127 # if the bindlist is empty and we had some dynamic binds, this means the
2128 # storage ate them away (e.g. the NoBindVars component) and interpolated
2129 # them directly into the SQL. This obviously can't be good for multi-inserts
2130 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2134 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2136 # use an error reporting closure for convenience (less to pass)
2137 my $bad_slice_report_cref = sub {
2138 my ($msg, $r_idx, $c_idx) = @_;
2139 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2143 require Data::Dumper::Concise;
2144 local $Data::Dumper::Maxdepth = 5;
2145 Data::Dumper::Concise::Dumper ({
2146 map { $cols->[$_] =>
2154 for my $col_idx (0..$#$cols) {
2155 my $reference_val = $data->[0][$col_idx];
2157 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2158 my $val = $data->[$row_idx][$col_idx];
2160 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2161 if (ref $val ne 'SCALAR') {
2162 $bad_slice_report_cref->(
2163 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2168 elsif ($$val ne $$reference_val) {
2169 $bad_slice_report_cref->(
2170 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2176 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2177 if (is_literal_value($val)) {
2178 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2181 else { # binds from a \[], compare type and attrs
2182 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2183 $bad_slice_report_cref->(
2184 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2189 # start drilling down and bail out early on identical refs
2191 $reference_val != $val
2193 $$reference_val != $$val
2195 if (${$val}->[0] ne ${$reference_val}->[0]) {
2196 $bad_slice_report_cref->(
2197 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2202 # need to check the bind attrs - a bind will happen only once for
2203 # the entire dataset, so any changes further down will be ignored.
2204 elsif (! Data::Compare::Compare(
2205 $value_type_by_col_idx->{$col_idx},
2209 @{$self->_resolve_bindattrs(
2210 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2214 $bad_slice_report_cref->(
2215 'Differing bind attributes on literal/bind values not supported',
2225 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2226 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2228 my $guard = $self->txn_scope_guard;
2230 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2231 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2234 # proto bind contains the information on which pieces of $data to pull
2235 # $cols is passed in only for prettier error-reporting
2236 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2239 # bind_param_array doesn't work if there are no binds
2240 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2244 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2248 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2251 # execute_for_fetch is capable of returning data just fine (it means it
2252 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2253 # is the void-populate fast-path we will just ignore this altogether
2254 # for the time being.
2255 sub _dbh_execute_for_fetch {
2256 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2258 # If we have any bind attributes to take care of, we will bind the
2259 # proto-bind data (which will never be used by execute_for_fetch)
2260 # However since column bindtypes are "sticky", this is sufficient
2261 # to get the DBD to apply the bindtype to all values later on
2262 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2264 for my $i (0 .. $#$proto_bind) {
2266 $i+1, # DBI bind indexes are 1-based
2267 $proto_bind->[$i][1],
2269 ) if defined $bind_attrs->[$i];
2272 # At this point $data slots named in the _bind_data_slice_idx of
2273 # each piece of $proto_bind are either \[]s or plain values to be
2274 # passed in. Construct the dispensing coderef. *NOTE* the order
2275 # of $data will differ from this of the ?s in the SQL (due to
2276 # alphabetical ordering by colname). We actually do want to
2277 # preserve this behavior so that prepare_cached has a better
2278 # chance of matching on unrelated calls
2280 my $fetch_row_idx = -1; # saner loop this way
2281 my $fetch_tuple = sub {
2282 return undef if ++$fetch_row_idx > $#$data;
2285 ! defined $_->{_literal_bind_subindex}
2287 ? $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2289 # There are no attributes to resolve here - we already did everything
2290 # when we constructed proto_bind. However we still want to sanity-check
2291 # what the user supplied, so pass stuff through to the resolver *anyway*
2292 : $self->_resolve_bindattrs (
2293 undef, # a fake rsrc
2294 [ ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}->[ $_->{_literal_bind_subindex} ] ],
2295 {}, # a fake column_info bag
2298 } map { $_->[0] } @$proto_bind ];
2301 my $tuple_status = [];
2304 $rv = $sth->execute_for_fetch(
2313 # Not all DBDs are create equal. Some throw on error, some return
2314 # an undef $rv, and some set $sth->err - try whatever we can
2315 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2318 ( !defined $rv or $sth->err )
2321 # Statement must finish even if there was an exception.
2326 $err = shift unless defined $err
2331 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2333 $self->throw_exception("Unexpected populate error: $err")
2334 if ($i > $#$tuple_status);
2336 require Data::Dumper::Concise;
2337 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2338 ($tuple_status->[$i][1] || $err),
2339 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2346 sub _dbh_execute_inserts_with_no_binds {
2347 my ($self, $sth, $count) = @_;
2351 my $dbh = $self->_get_dbh;
2352 local $dbh->{RaiseError} = 1;
2353 local $dbh->{PrintError} = 0;
2355 $sth->execute foreach 1..$count;
2361 # Make sure statement is finished even if there was an exception.
2366 $err = shift unless defined $err;
2369 $self->throw_exception($err) if defined $err;
2375 #my ($self, $source, @args) = @_;
2376 shift->_execute('update', @_);
2381 #my ($self, $source, @args) = @_;
2382 shift->_execute('delete', @_);
2387 $self->_execute($self->_select_args(@_));
2390 sub _select_args_to_query {
2393 $self->throw_exception(
2394 "Unable to generate limited query representation with 'software_limit' enabled"
2395 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2397 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2398 # = $self->_select_args($ident, $select, $cond, $attrs);
2399 my ($op, $ident, @args) =
2400 $self->_select_args(@_);
2402 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2403 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2405 # reuse the bind arrayref
2406 unshift @{$bind}, "($sql)";
2411 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2413 # FIXME - that kind of caching would be nice to have
2414 # however currently we *may* pass the same $orig_attrs
2415 # with different ident/select/where
2416 # the whole interface needs to be rethought, since it
2417 # was centered around the flawed SQLA API. We can do
2418 # soooooo much better now. But that is also another
2421 # 'select', $orig_attrs->{!args_as_stored_at_the_end_of_this_method!}
2422 #) if $orig_attrs->{!args_as_stored_at_the_end_of_this_method!};
2424 my $sql_maker = $self->sql_maker;
2433 # Sanity check the attributes (SQLMaker does it too, but
2434 # in case of a software_limit we'll never reach there)
2435 if (defined $attrs->{offset}) {
2436 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2437 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2440 if (defined $attrs->{rows}) {
2441 $self->throw_exception("The rows attribute must be a positive integer if present")
2442 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2444 elsif ($attrs->{offset}) {
2445 # MySQL actually recommends this approach. I cringe.
2446 $attrs->{rows} = $sql_maker->__max_int;
2449 # see if we will need to tear the prefetch apart to satisfy group_by == select
2450 # this is *extremely tricky* to get right, I am still not sure I did
2452 my ($prefetch_needs_subquery, @limit_args);
2454 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2455 # we already know there is a valid group_by (we made it) and we know it is
2456 # intended to be based *only* on non-multi stuff
2457 # short circuit the group_by parsing below
2458 $prefetch_needs_subquery = 1;
2461 # The rationale is that even if we do *not* have collapse, we still
2462 # need to wrap the core grouped select/group_by in a subquery
2463 # so that databases that care about group_by/select equivalence
2464 # are happy (this includes MySQL in strict_mode)
2465 # If any of the other joined tables are referenced in the group_by
2466 # however - the user is on their own
2467 ( $prefetch_needs_subquery or ! $attrs->{_simple_passthrough_construction} )
2471 @{$attrs->{group_by}}
2473 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2474 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2477 # no aliases other than our own in group_by
2478 # if there are - do not allow subquery even if limit is present
2479 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2481 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2482 # active collapse with a limit - that one is a no-brainer unless
2483 # overruled by a group_by above
2484 $prefetch_needs_subquery = 1;
2487 if ($prefetch_needs_subquery) {
2488 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2490 elsif (! $attrs->{software_limit} ) {
2492 $attrs->{rows} || (),
2493 $attrs->{offset} || (),
2497 # try to simplify the joinmap further (prune unreferenced type-single joins)
2499 ! $prefetch_needs_subquery # already pruned
2503 reftype $attrs->{from} eq 'ARRAY'
2505 @{$attrs->{from}} != 1
2507 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2510 # FIXME this is a gross, inefficient, largely incorrect and fragile hack
2511 # during the result inflation stage we *need* to know what was the aliastype
2512 # map as sqla saw it when the final pieces of SQL were being assembled
2513 # Originally we simply carried around the entirety of $attrs, but this
2514 # resulted in resultsets that are being reused growing continuously, as
2515 # the hash in question grew deeper and deeper.
2516 # Instead hand-pick what to take with us here (we actually don't need much
2517 # at this point just the map itself)
2518 $orig_attrs->{_last_sqlmaker_alias_map} = $attrs->{_aliastypes};
2521 # my $alias2source = $self->_resolve_ident_sources ($ident);
2523 # This would be the point to deflate anything found in $attrs->{where}
2524 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2525 # expect a result object. And all we have is a resultsource (it is trivial
2526 # to extract deflator coderefs via $alias2source above).
2528 # I don't see a way forward other than changing the way deflators are
2529 # invoked, and that's just bad...
2532 return ( 'select', @{$attrs}{qw(from select where)}, $attrs, @limit_args );
2535 # Returns a counting SELECT for a simple count
2536 # query. Abstracted so that a storage could override
2537 # this to { count => 'firstcol' } or whatever makes
2538 # sense as a performance optimization
2540 #my ($self, $source, $rs_attrs) = @_;
2541 return { count => '*' };
2548 =item Arguments: $ident, $select, $condition, $attrs
2552 Handle a SQL select statement.
2558 my ($ident, $select, $condition, $attrs) = @_;
2559 return $self->cursor_class->new($self, \@_, $attrs);
2564 my ($rv, $sth, @bind) = $self->_select(@_);
2565 my @row = $sth->fetchrow_array;
2566 my @nextrow = $sth->fetchrow_array if @row;
2567 if(@row && @nextrow) {
2568 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2570 # Need to call finish() to work round broken DBDs
2575 =head2 sql_limit_dialect
2577 This is an accessor for the default SQL limit dialect used by a particular
2578 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2579 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2580 see L<DBIx::Class::SQLMaker::LimitDialects>.
2584 sub _dbh_columns_info_for {
2585 my ($self, $dbh, $table) = @_;
2587 if ($dbh->can('column_info')) {
2591 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2592 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2594 while ( my $info = $sth->fetchrow_hashref() ){
2596 $column_info{data_type} = $info->{TYPE_NAME};
2597 $column_info{size} = $info->{COLUMN_SIZE};
2598 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2599 $column_info{default_value} = $info->{COLUMN_DEF};
2600 my $col_name = $info->{COLUMN_NAME};
2601 $col_name =~ s/^\"(.*)\"$/$1/;
2603 $result{$col_name} = \%column_info;
2608 return \%result if !$caught && scalar keys %result;
2612 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2614 my @columns = @{$sth->{NAME_lc}};
2615 for my $i ( 0 .. $#columns ){
2617 $column_info{data_type} = $sth->{TYPE}->[$i];
2618 $column_info{size} = $sth->{PRECISION}->[$i];
2619 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2621 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2622 $column_info{data_type} = $1;
2623 $column_info{size} = $2;
2626 $result{$columns[$i]} = \%column_info;
2630 foreach my $col (keys %result) {
2631 my $colinfo = $result{$col};
2632 my $type_num = $colinfo->{data_type};
2634 if(defined $type_num && $dbh->can('type_info')) {
2635 my $type_info = $dbh->type_info($type_num);
2636 $type_name = $type_info->{TYPE_NAME} if $type_info;
2637 $colinfo->{data_type} = $type_name if $type_name;
2644 sub columns_info_for {
2645 my ($self, $table) = @_;
2646 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2649 =head2 last_insert_id
2651 Return the row id of the last insert.
2655 sub _dbh_last_insert_id {
2656 my ($self, $dbh, $source, $col) = @_;
2658 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2660 return $id if defined $id;
2662 my $class = ref $self;
2663 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2666 sub last_insert_id {
2668 $self->_dbh_last_insert_id ($self->_dbh, @_);
2671 =head2 _native_data_type
2675 =item Arguments: $type_name
2679 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2680 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2681 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2683 The default implementation returns C<undef>, implement in your Storage driver if
2684 you need this functionality.
2686 Should map types from other databases to the native RDBMS type, for example
2687 C<VARCHAR2> to C<VARCHAR>.
2689 Types with modifiers should map to the underlying data type. For example,
2690 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2692 Composite types should map to the container type, for example
2693 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2697 sub _native_data_type {
2698 #my ($self, $data_type) = @_;
2702 # Check if placeholders are supported at all
2703 sub _determine_supports_placeholders {
2705 my $dbh = $self->_get_dbh;
2707 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2708 # but it is inaccurate more often than not
2710 local $dbh->{PrintError} = 0;
2711 local $dbh->{RaiseError} = 1;
2712 $dbh->do('select ?', {}, 1);
2720 # Check if placeholders bound to non-string types throw exceptions
2722 sub _determine_supports_typeless_placeholders {
2724 my $dbh = $self->_get_dbh;
2727 local $dbh->{PrintError} = 0;
2728 local $dbh->{RaiseError} = 1;
2729 # this specifically tests a bind that is NOT a string
2730 $dbh->do('select 1 where 1 = ?', {}, 1);
2740 Returns the database driver name.
2745 shift->_get_dbh->{Driver}->{Name};
2748 =head2 bind_attribute_by_data_type
2750 Given a datatype from column info, returns a database specific bind
2751 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2752 let the database planner just handle it.
2754 This method is always called after the driver has been determined and a DBI
2755 connection has been established. Therefore you can refer to C<DBI::$constant>
2756 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2757 the correct modules.
2761 sub bind_attribute_by_data_type {
2765 =head2 is_datatype_numeric
2767 Given a datatype from column_info, returns a boolean value indicating if
2768 the current RDBMS considers it a numeric value. This controls how
2769 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2770 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2771 be performed instead of the usual C<eq>.
2775 sub is_datatype_numeric {
2776 #my ($self, $dt) = @_;
2778 return 0 unless $_[1];
2781 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2786 =head2 create_ddl_dir
2790 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2794 Creates a SQL file based on the Schema, for each of the specified
2795 database engines in C<\@databases> in the given directory.
2796 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2798 Given a previous version number, this will also create a file containing
2799 the ALTER TABLE statements to transform the previous schema into the
2800 current one. Note that these statements may contain C<DROP TABLE> or
2801 C<DROP COLUMN> statements that can potentially destroy data.
2803 The file names are created using the C<ddl_filename> method below, please
2804 override this method in your schema if you would like a different file
2805 name format. For the ALTER file, the same format is used, replacing
2806 $version in the name with "$preversion-$version".
2808 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2809 The most common value for this would be C<< { add_drop_table => 1 } >>
2810 to have the SQL produced include a C<DROP TABLE> statement for each table
2811 created. For quoting purposes supply C<quote_identifiers>.
2813 If no arguments are passed, then the following default values are assumed:
2817 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2819 =item version - $schema->schema_version
2821 =item directory - './'
2823 =item preversion - <none>
2827 By default, C<\%sqlt_args> will have
2829 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2831 merged with the hash passed in. To disable any of those features, pass in a
2832 hashref like the following
2834 { ignore_constraint_names => 0, # ... other options }
2837 WARNING: You are strongly advised to check all SQL files created, before applying
2842 sub create_ddl_dir {
2843 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2846 carp "No directory given, using ./\n";
2851 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2853 $self->throw_exception(
2854 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2858 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2860 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2861 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2863 my $schema_version = $schema->schema_version || '1.x';
2864 $version ||= $schema_version;
2867 add_drop_table => 1,
2868 ignore_constraint_names => 1,
2869 ignore_index_names => 1,
2870 quote_identifiers => $self->sql_maker->_quoting_enabled,
2874 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2875 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2878 my $sqlt = SQL::Translator->new( $sqltargs );
2880 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2881 my $sqlt_schema = $sqlt->translate({ data => $schema })
2882 or $self->throw_exception ($sqlt->error);
2884 foreach my $db (@$databases) {
2886 $sqlt->{schema} = $sqlt_schema;
2887 $sqlt->producer($db);
2890 my $filename = $schema->ddl_filename($db, $version, $dir);
2891 if (-e $filename && ($version eq $schema_version )) {
2892 # if we are dumping the current version, overwrite the DDL
2893 carp "Overwriting existing DDL file - $filename";
2897 my $output = $sqlt->translate;
2899 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2902 if(!open($file, ">$filename")) {
2903 $self->throw_exception("Can't open $filename for writing ($!)");
2906 print $file $output;
2909 next unless ($preversion);
2911 require SQL::Translator::Diff;
2913 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2914 if(!-e $prefilename) {
2915 carp("No previous schema file found ($prefilename)");
2919 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2921 carp("Overwriting existing diff file - $difffile");
2927 my $t = SQL::Translator->new($sqltargs);
2932 or $self->throw_exception ($t->error);
2934 my $out = $t->translate( $prefilename )
2935 or $self->throw_exception ($t->error);
2937 $source_schema = $t->schema;
2939 $source_schema->name( $prefilename )
2940 unless ( $source_schema->name );
2943 # The "new" style of producers have sane normalization and can support
2944 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2945 # And we have to diff parsed SQL against parsed SQL.
2946 my $dest_schema = $sqlt_schema;
2948 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2949 my $t = SQL::Translator->new($sqltargs);
2954 or $self->throw_exception ($t->error);
2956 my $out = $t->translate( $filename )
2957 or $self->throw_exception ($t->error);
2959 $dest_schema = $t->schema;
2961 $dest_schema->name( $filename )
2962 unless $dest_schema->name;
2966 # FIXME - this is a terrible workaround for
2967 # https://github.com/dbsrgits/sql-translator/commit/2d23c1e
2968 # Fixing it in this sloppy manner so that we don't hve to
2969 # lockstep an SQLT release as well. Needs to be removed at
2970 # some point, and SQLT dep bumped
2971 local $SQL::Translator::Producer::SQLite::NO_QUOTES
2972 if $SQL::Translator::Producer::SQLite::NO_QUOTES;
2974 SQL::Translator::Diff::schema_diff($source_schema, $db,
2980 if(!open $file, ">$difffile") {
2981 $self->throw_exception("Can't write to $difffile ($!)");
2989 =head2 deployment_statements
2993 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2997 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2999 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
3000 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
3002 C<$directory> is used to return statements from files in a previously created
3003 L</create_ddl_dir> directory and is optional. The filenames are constructed
3004 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
3006 If no C<$directory> is specified then the statements are constructed on the
3007 fly using L<SQL::Translator> and C<$version> is ignored.
3009 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
3013 sub deployment_statements {
3014 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
3015 $type ||= $self->sqlt_type;
3016 $version ||= $schema->schema_version || '1.x';
3018 my $filename = $schema->ddl_filename($type, $version, $dir);
3021 # FIXME replace this block when a proper sane sql parser is available
3023 open($file, "<$filename")
3024 or $self->throw_exception("Can't open $filename ($!)");
3027 return join('', @rows);
3030 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
3031 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
3034 # sources needs to be a parser arg, but for simplicity allow at top level
3036 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
3037 if exists $sqltargs->{sources};
3039 $sqltargs->{quote_identifiers} = $self->sql_maker->_quoting_enabled
3040 unless exists $sqltargs->{quote_identifiers};
3042 my $tr = SQL::Translator->new(
3043 producer => "SQL::Translator::Producer::${type}",
3045 parser => 'SQL::Translator::Parser::DBIx::Class',
3049 return preserve_context {
3052 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
3053 unless defined $_[0];
3057 # FIXME deploy() currently does not accurately report sql errors
3058 # Will always return true while errors are warned
3060 my ($self, $schema, $type, $sqltargs, $dir) = @_;
3064 return if($line =~ /^--/);
3065 # next if($line =~ /^DROP/m);
3066 return if($line =~ /^BEGIN TRANSACTION/m);
3067 return if($line =~ /^COMMIT/m);
3068 return if $line =~ /^\s+$/; # skip whitespace only
3069 $self->_query_start($line);
3071 # do a dbh_do cycle here, as we need some error checking in
3072 # place (even though we will ignore errors)
3073 $self->dbh_do (sub { $_[1]->do($line) });
3075 carp qq{$_ (running "${line}")};
3077 $self->_query_end($line);
3079 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
3080 if (@statements > 1) {
3081 foreach my $statement (@statements) {
3082 $deploy->( $statement );
3085 elsif (@statements == 1) {
3086 # split on single line comments and end of statements
3087 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3093 =head2 datetime_parser
3095 Returns the datetime parser class
3099 sub datetime_parser {
3101 return $self->{datetime_parser} ||= do {
3102 $self->build_datetime_parser(@_);
3106 =head2 datetime_parser_type
3108 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3110 =head2 build_datetime_parser
3112 See L</datetime_parser>
3116 sub build_datetime_parser {
3118 my $type = $self->datetime_parser_type(@_);
3123 =head2 is_replicating
3125 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3126 replicate from a master database. Default is undef, which is the result
3127 returned by databases that don't support replication.
3131 sub is_replicating {
3136 =head2 lag_behind_master
3138 Returns a number that represents a certain amount of lag behind a master db
3139 when a given storage is replicating. The number is database dependent, but
3140 starts at zero and increases with the amount of lag. Default in undef
3144 sub lag_behind_master {
3148 =head2 relname_to_table_alias
3152 =item Arguments: $relname, $join_count
3154 =item Return Value: $alias
3158 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3161 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3162 way these aliases are named.
3164 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3165 otherwise C<"$relname">.
3169 sub relname_to_table_alias {
3170 my ($self, $relname, $join_count) = @_;
3172 my $alias = ($join_count && $join_count > 1 ?
3173 join('_', $relname, $join_count) : $relname);
3178 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3179 # version and it may be necessary to amend or override it for a specific storage
3180 # if such binds are necessary.
3181 sub _max_column_bytesize {
3182 my ($self, $attr) = @_;
3186 if ($attr->{sqlt_datatype}) {
3187 my $data_type = lc($attr->{sqlt_datatype});
3189 if ($attr->{sqlt_size}) {
3191 # String/sized-binary types
3192 if ($data_type =~ /^(?:
3193 l? (?:var)? char(?:acter)? (?:\s*varying)?
3195 (?:var)? binary (?:\s*varying)?
3200 $max_size = $attr->{sqlt_size};
3202 # Other charset/unicode types, assume scale of 4
3203 elsif ($data_type =~ /^(?:
3204 national \s* character (?:\s*varying)?
3213 $max_size = $attr->{sqlt_size} * 4;
3217 if (!$max_size and !$self->_is_lob_type($data_type)) {
3218 $max_size = 100 # for all other (numeric?) datatypes
3222 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3225 # Determine if a data_type is some type of BLOB
3227 my ($self, $data_type) = @_;
3228 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3229 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3230 |varchar|character\s*varying|nvarchar
3231 |national\s*character\s*varying))?\z/xi);
3234 sub _is_binary_lob_type {
3235 my ($self, $data_type) = @_;
3236 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3237 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3240 sub _is_text_lob_type {
3241 my ($self, $data_type) = @_;
3242 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3243 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3244 |national\s*character\s*varying))\z/xi);
3247 # Determine if a data_type is some type of a binary type
3248 sub _is_binary_type {
3249 my ($self, $data_type) = @_;
3250 $data_type && ($self->_is_binary_lob_type($data_type)
3251 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3258 =head2 DBIx::Class and AutoCommit
3260 DBIx::Class can do some wonderful magic with handling exceptions,
3261 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3262 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3263 transaction support.
3265 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3266 in an assumed transaction between commits, and you're telling us you'd
3267 like to manage that manually. A lot of the magic protections offered by
3268 this module will go away. We can't protect you from exceptions due to database
3269 disconnects because we don't know anything about how to restart your
3270 transactions. You're on your own for handling all sorts of exceptional
3271 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3275 =head1 AUTHOR AND CONTRIBUTORS
3277 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3281 You may distribute this code under the same terms as Perl itself.