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 Context::Preserve 'preserve_context';
13 use SQL::Abstract qw(is_plain_value is_literal_value);
14 use DBIx::Class::ResultSource::FromSpec::Util 'fromspec_columns_info';
15 use DBIx::Class::_Util qw(
16 quote_sub perlstring serialize dump_value
17 dbic_internal_try dbic_internal_catch
18 detected_reinvoked_destructor scope_guard
19 mkdir_p UNRESOLVABLE_CONDITION
23 # default cursor class, overridable in connect_info attributes
24 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
26 __PACKAGE__->mk_group_accessors('inherited' => qw/
27 sql_limit_dialect sql_quote_char sql_name_sep
30 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
32 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
33 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
35 __PACKAGE__->sql_name_sep('.');
37 __PACKAGE__->mk_group_accessors('simple' => qw/
38 _connect_info _dbic_connect_attributes _driver_determined
39 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
40 _perform_autoinc_retrieval _autoinc_supplied_for_op
43 # the values for these accessors are picked out (and deleted) from
44 # the attribute hashref passed to connect_info
45 my @storage_options = qw/
46 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
47 disable_sth_caching unsafe auto_savepoint
49 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
52 # capability definitions, using a 2-tiered accessor system
55 # A driver/user may define _use_X, which blindly without any checks says:
56 # "(do not) use this capability", (use_dbms_capability is an "inherited"
59 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
60 # accessor, which in turn calls _determine_supports_X, and stores the return
61 # in a special slot on the storage object, which is wiped every time a $dbh
62 # reconnection takes place (it is not guaranteed that upon reconnection we
63 # will get the same rdbms version). _determine_supports_X does not need to
64 # exist on a driver, as we ->can for it before calling.
66 my @capabilities = (qw/
68 insert_returning_bound
77 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
78 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
80 # on by default, not strictly a capability (pending rewrite)
81 __PACKAGE__->_use_join_optimizer (1);
82 sub _determine_supports_join_optimizer { 1 };
84 # Each of these methods need _determine_driver called before itself
85 # in order to function reliably. We also need to separate accessors
86 # from plain old method calls, since an accessor called as a setter
87 # does *not* need the driver determination loop fired (and in fact
88 # can produce hard to find bugs, like e.g. losing on_connect_*
89 # semantics on fresh connections)
91 # The construct below is simply a parameterized around()
92 my $storage_accessor_idx = { map { $_ => 1 } qw(
99 for my $meth (keys %$storage_accessor_idx, qw(
100 deployment_statements
102 build_datetime_parser
114 with_deferred_fk_checks
116 get_use_dbms_capability
123 my $orig = __PACKAGE__->can ($meth)
124 or die "$meth is not a ::Storage::DBI method!";
126 my $possibly_a_setter = $storage_accessor_idx->{$meth} ? 1 : 0;
129 __PACKAGE__ ."::$meth", sprintf( <<'EOC', $possibly_a_setter, perlstring $meth ), { '$orig' => \$orig };
132 # if this is an actual *setter* - just set it, no need to connect
133 # and determine the driver
136 # only fire when invoked on an instance, a valid class-based invocation
137 # would e.g. be setting a default for an inherited accessor
140 ! $_[0]->{_driver_determined}
142 ! $_[0]->{_in_determine_driver}
144 # Only try to determine stuff if we have *something* that either is or can
145 # provide a DSN. Allows for bare $schema's generated with a plain ->connect()
146 # to still be marginally useful
147 $_[0]->_dbi_connect_info->[0]
149 $_[0]->_determine_driver;
151 # work around http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
152 goto $_[0]->can(%2$s) unless DBIx::Class::_ENV_::BROKEN_GOTO;
154 my $cref = $_[0]->can(%2$s);
164 DBIx::Class::Storage::DBI - DBI storage handler
168 my $schema = MySchema->connect('dbi:SQLite:my.db');
170 $schema->storage->debug(1);
172 my @stuff = $schema->storage->dbh_do(
174 my ($storage, $dbh, @args) = @_;
175 $dbh->do("DROP TABLE authors");
180 $schema->resultset('Book')->search({
181 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
186 This class represents the connection to an RDBMS via L<DBI>. See
187 L<DBIx::Class::Storage> for general information. This pod only
188 documents DBI-specific methods and behaviors.
195 my $new = shift->next::method(@_);
197 $new->_sql_maker_opts({});
198 $new->_dbh_details({});
199 $new->{_in_do_block} = 0;
201 # read below to see what this does
202 $new->_arm_global_destructor;
207 # This is hack to work around perl shooting stuff in random
208 # order on exit(). If we do not walk the remaining storage
209 # objects in an END block, there is a *small but real* chance
210 # of a fork()ed child to kill the parent's shared DBI handle,
211 # *before perl reaches the DESTROY in this package*
212 # Yes, it is ugly and effective.
213 # Additionally this registry is used by the CLONE method to
214 # make sure no handles are shared between threads
216 my %seek_and_destroy;
218 sub _arm_global_destructor {
220 # quick "garbage collection" pass - prevents the registry
221 # from slowly growing with a bunch of undef-valued keys
222 defined $seek_and_destroy{$_} or delete $seek_and_destroy{$_}
223 for keys %seek_and_destroy;
226 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
229 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
230 # collected before leaving this scope. Depending on the code above, this
231 # may very well be just a preventive measure guarding future modifications
238 ! DBIx::Class::_ENV_::BROKEN_FORK
240 my @instances = grep { defined $_ } values %seek_and_destroy
242 local $?; # just in case the DBI destructor changes it somehow
244 # disarm the handle if not native to this process (see comment on top)
245 $_->_verify_pid for @instances;
248 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
249 # collected before leaving this scope. Depending on the code above, this
250 # may very well be just a preventive measure guarding future modifications
254 sub DBIx::Class::__DBI_Storage_iThreads_handler__::CLONE {
255 # As per DBI's recommendation, DBIC disconnects all handles as
256 # soon as possible (DBIC will reconnect only on demand from within
258 my @instances = grep { defined $_ } values %seek_and_destroy;
259 %seek_and_destroy = ();
265 # properly renumber existing refs
266 $_->_arm_global_destructor
269 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
270 # collected before leaving this scope. Depending on the code above, this
271 # may very well be just a preventive measure guarding future modifications
277 return if &detected_reinvoked_destructor;
279 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
281 # some databases spew warnings on implicit disconnect
282 return unless defined $_[0]->_dbh;
284 local $SIG{__WARN__} = sub {};
286 # not calling ->disconnect here - we are being destroyed - nothing to reset
288 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
289 # collected before leaving this scope. Depending on the code above, this
290 # may very well be just a preventive measure guarding future modifications
294 # handle pid changes correctly - do not destroy parent's connection
297 my $pid = $_[0]->_conn_pid;
299 if( defined $pid and $pid != $$ and my $dbh = $_[0]->_dbh ) {
300 $dbh->{InactiveDestroy} = 1;
305 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
306 # collected before leaving this scope. Depending on the code above, this
307 # may very well be just a preventive measure guarding future modifications
313 This method is normally called by L<DBIx::Class::Schema/connection>, which
314 encapsulates its argument list in an arrayref before passing them here.
316 The argument list may contain:
322 The same 4-element argument set one would normally pass to
323 L<DBI/connect>, optionally followed by
324 L<extra attributes|/DBIx::Class specific connection attributes>
325 recognized by DBIx::Class:
327 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
331 A single code reference which returns a connected
332 L<DBI database handle|DBI/connect> optionally followed by
333 L<extra attributes|/DBIx::Class specific connection attributes> recognized
336 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
340 A single hashref with all the attributes and the dsn/user/password
343 $connect_info_args = [{
351 $connect_info_args = [{
352 dbh_maker => sub { DBI->connect (...) },
357 This is particularly useful for L<Catalyst> based applications, allowing the
358 following config (L<Config::General> style):
363 dsn dbi:mysql:database=test
370 The C<dsn>/C<user>/C<password> combination can be substituted by the
371 C<dbh_maker> key whose value is a coderef that returns a connected
372 L<DBI database handle|DBI/connect>
376 Please note that the L<DBI> docs recommend that you always explicitly
377 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
378 recommends that it be set to I<1>, and that you perform transactions
379 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
380 to I<1> if you do not do explicitly set it to zero. This is the default
381 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
383 =head3 DBIx::Class specific connection attributes
385 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
386 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
387 the following connection options. These options can be mixed in with your other
388 L<DBI> connection attributes, or placed in a separate hashref
389 (C<\%extra_attributes>) as shown above.
391 Every time C<connect_info> is invoked, any previous settings for
392 these options will be cleared before setting the new ones, regardless of
393 whether any options are specified in the new C<connect_info>.
400 Specifies things to do immediately after connecting or re-connecting to
401 the database. Its value may contain:
407 This contains one SQL statement to execute.
409 =item an array reference
411 This contains SQL statements to execute in order. Each element contains
412 a string or a code reference that returns a string.
414 =item a code reference
416 This contains some code to execute. Unlike code references within an
417 array reference, its return value is ignored.
421 =item on_disconnect_do
423 Takes arguments in the same form as L</on_connect_do> and executes them
424 immediately before disconnecting from the database.
426 Note, this only runs if you explicitly call L</disconnect> on the
429 =item on_connect_call
431 A more generalized form of L</on_connect_do> that calls the specified
432 C<connect_call_METHOD> methods in your storage driver.
434 on_connect_do => 'select 1'
438 on_connect_call => [ [ do_sql => 'select 1' ] ]
440 Its values may contain:
446 Will call the C<connect_call_METHOD> method.
448 =item a code reference
450 Will execute C<< $code->($storage) >>
452 =item an array reference
454 Each value can be a method name or code reference.
456 =item an array of arrays
458 For each array, the first item is taken to be the C<connect_call_> method name
459 or code reference, and the rest are parameters to it.
463 Some predefined storage methods you may use:
469 Executes a SQL string or a code reference that returns a SQL string. This is
470 what L</on_connect_do> and L</on_disconnect_do> use.
478 Will execute the scalar as SQL.
482 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
483 attributes hashref and bind values.
485 =item a code reference
487 Will execute C<< $code->($storage) >> and execute the return array refs as
494 Execute any statements necessary to initialize the database session to return
495 and accept datetime/timestamp values used with
496 L<DBIx::Class::InflateColumn::DateTime>.
498 Only necessary for some databases, see your specific storage driver for
499 implementation details.
503 =item on_disconnect_call
505 Takes arguments in the same form as L</on_connect_call> and executes them
506 immediately before disconnecting from the database.
508 Calls the C<disconnect_call_METHOD> methods as opposed to the
509 C<connect_call_METHOD> methods called by L</on_connect_call>.
511 Note, this only runs if you explicitly call L</disconnect> on the
514 =item disable_sth_caching
516 If set to a true value, this option will disable the caching of
517 statement handles via L<DBI/prepare_cached>.
521 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
522 default L</sql_limit_dialect> setting of the storage (if any). For a list
523 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
527 When true automatically sets L</quote_char> and L</name_sep> to the characters
528 appropriate for your particular RDBMS. This option is preferred over specifying
529 L</quote_char> directly.
533 Specifies what characters to use to quote table and column names.
535 C<quote_char> expects either a single character, in which case is it
536 is placed on either side of the table/column name, or an arrayref of length
537 2 in which case the table/column name is placed between the elements.
539 For example under MySQL you should use C<< quote_char => '`' >>, and for
540 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
544 This parameter is only useful in conjunction with C<quote_char>, and is used to
545 specify the character that separates elements (schemas, tables, columns) from
546 each other. If unspecified it defaults to the most commonly used C<.>.
550 This Storage driver normally installs its own C<HandleError>, sets
551 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
552 all database handles, including those supplied by a coderef. It does this
553 so that it can have consistent and useful error behavior.
555 If you set this option to a true value, Storage will not do its usual
556 modifications to the database handle's attributes, and instead relies on
557 the settings in your connect_info DBI options (or the values you set in
558 your connection coderef, in the case that you are connecting via coderef).
560 Note that your custom settings can cause Storage to malfunction,
561 especially if you set a C<HandleError> handler that suppresses exceptions
562 and/or disable C<RaiseError>.
566 If this option is true, L<DBIx::Class> will use savepoints when nesting
567 transactions, making it possible to recover from failure in the inner
568 transaction without having to abort all outer transactions.
572 Use this argument to supply a cursor class other than the default
573 L<DBIx::Class::Storage::DBI::Cursor>.
577 Some real-life examples of arguments to L</connect_info> and
578 L<DBIx::Class::Schema/connect>
580 # Simple SQLite connection
581 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
584 ->connect_info([ sub { DBI->connect(...) } ]);
586 # Connect via subref in hashref
588 dbh_maker => sub { DBI->connect(...) },
589 on_connect_do => 'alter session ...',
592 # A bit more complicated
599 { quote_char => q{"} },
603 # Equivalent to the previous example
609 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
613 # Same, but with hashref as argument
614 # See parse_connect_info for explanation
617 dsn => 'dbi:Pg:dbname=foo',
619 password => 'my_pg_password',
626 # Subref + DBIx::Class-specific connection options
629 sub { DBI->connect(...) },
633 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
634 disable_sth_caching => 1,
644 my ($self, $info) = @_;
646 return $self->_connect_info if !$info;
648 $self->_connect_info($info); # copy for _connect_info
650 $info = $self->_normalize_connect_info($info)
651 if ref $info eq 'ARRAY';
654 %{ $self->_default_dbi_connect_attributes || {} },
655 %{ $info->{attributes} || {} },
658 my @args = @{ $info->{arguments} };
660 if (keys %attrs and ref $args[0] ne 'CODE') {
662 'You provided explicit AutoCommit => 0 in your connection_info. '
663 . 'This is almost universally a bad idea (see the footnotes of '
664 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
665 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
667 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
669 push @args, \%attrs if keys %attrs;
672 # this is the authoritative "always an arrayref" thing fed to DBI->connect
673 # OR a single-element coderef-based $dbh factory
674 $self->_dbi_connect_info(\@args);
676 # extract the individual storage options
677 for my $storage_opt (keys %{ $info->{storage_options} }) {
678 my $value = $info->{storage_options}{$storage_opt};
680 $self->$storage_opt($value);
683 # Extract the individual sqlmaker options
685 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
686 # the new set of options
687 $self->_sql_maker(undef);
688 $self->_sql_maker_opts({});
690 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
691 my $value = $info->{sql_maker_options}{$sql_maker_opt};
693 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
697 # save attributes in a separate accessor so they are always
698 # introspectable, even in case of a CODE $dbhmaker
699 $self->_dbic_connect_attributes (\%attrs);
701 return $self->_connect_info;
704 sub _dbi_connect_info {
707 return $self->{_dbi_connect_info} = $_[0]
710 my $conninfo = $self->{_dbi_connect_info} || [];
712 # last ditch effort to grab a DSN
713 if ( ! defined $conninfo->[0] and $ENV{DBI_DSN} ) {
714 my @new_conninfo = @$conninfo;
715 $new_conninfo[0] = $ENV{DBI_DSN};
716 $conninfo = \@new_conninfo;
723 sub _normalize_connect_info {
724 my ($self, $info_arg) = @_;
727 my @args = @$info_arg; # take a shallow copy for further mutilation
729 # combine/pre-parse arguments depending on invocation style
732 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
733 %attrs = %{ $args[1] || {} };
736 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
737 %attrs = %{$args[0]};
739 if (my $code = delete $attrs{dbh_maker}) {
742 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
745 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
746 . "to the result of 'dbh_maker'",
748 join (', ', map { "'$_'" } (@ignored) ),
753 @args = delete @attrs{qw/dsn user password/};
756 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
758 % { $args[3] || {} },
759 % { $args[4] || {} },
761 @args = @args[0,1,2];
764 $info{arguments} = \@args;
766 my @storage_opts = grep exists $attrs{$_},
767 @storage_options, 'cursor_class';
769 @{ $info{storage_options} }{@storage_opts} =
770 delete @attrs{@storage_opts} if @storage_opts;
772 my @sql_maker_opts = grep exists $attrs{$_},
773 qw/limit_dialect quote_char name_sep quote_names/;
775 @{ $info{sql_maker_options} }{@sql_maker_opts} =
776 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
778 $info{attributes} = \%attrs if %attrs;
783 sub _default_dbi_connect_attributes () {
788 ShowErrorStatement => 1,
794 This method is deprecated in favour of setting via L</connect_info>.
798 =head2 on_disconnect_do
800 This method is deprecated in favour of setting via L</connect_info>.
804 sub _parse_connect_do {
805 my ($self, $type) = @_;
807 my $val = $self->$type;
808 return () if not defined $val;
813 push @res, [ 'do_sql', $val ];
814 } elsif (ref($val) eq 'CODE') {
816 } elsif (ref($val) eq 'ARRAY') {
817 push @res, map { [ 'do_sql', $_ ] } @$val;
819 $self->throw_exception("Invalid type for $type: ".ref($val));
827 Arguments: ($subref | $method_name), @extra_coderef_args?
829 Execute the given $subref or $method_name using the new exception-based
830 connection management.
832 The first two arguments will be the storage object that C<dbh_do> was called
833 on and a database handle to use. Any additional arguments will be passed
834 verbatim to the called subref as arguments 2 and onwards.
836 Using this (instead of $self->_dbh or $self->dbh) ensures correct
837 exception handling and reconnection (or failover in future subclasses).
839 Your subref should have no side-effects outside of the database, as
840 there is the potential for your subref to be partially double-executed
841 if the database connection was stale/dysfunctional.
845 my @stuff = $schema->storage->dbh_do(
847 my ($storage, $dbh, @cols) = @_;
848 my $cols = join(q{, }, @cols);
849 $dbh->selectrow_array("SELECT $cols FROM foo");
858 my $run_target = shift; # either a coderef or a method name
860 # short circuit when we know there is no need for a runner
862 # FIXME - assumption may be wrong
863 # the rationale for the txn_depth check is that if this block is a part
864 # of a larger transaction, everything up to that point is screwed anyway
865 return $self->$run_target($self->_get_dbh, @_)
866 if $self->{_in_do_block} or $self->transaction_depth;
868 # take a ref instead of a copy, to preserve @_ aliasing
869 # semantics within the coderef, but only if needed
870 # (pseudoforking doesn't like this trick much)
871 my $args = @_ ? \@_ : [];
873 DBIx::Class::Storage::BlockRunner->new(
876 retry_handler => sub {
877 $_[0]->failed_attempt_count == 1
879 ! $_[0]->storage->connected
882 $self->$run_target ($self->_get_dbh, @$args )
887 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
888 shift->next::method(@_);
893 Our C<disconnect> method also performs a rollback first if the
894 database is not in C<AutoCommit> mode.
901 # this physical disconnect below might very well throw
902 # in order to unambiguously reset the state - do the cleanup in guard
904 my $g = scope_guard {
906 defined( $self->_dbh )
907 and dbic_internal_try { $self->_dbh->disconnect };
910 $self->_dbh_details({});
911 $self->transaction_depth(undef);
912 $self->_dbh_autocommit(undef);
913 $self->savepoints([]);
915 # FIXME - this needs reenabling with the proper "no reset on same DSN" check
916 #$self->_sql_maker(undef); # this may also end up being different
921 $self->_do_connection_actions(disconnect_call_ => $_) for (
922 ( $self->on_disconnect_call || () ),
923 $self->_parse_connect_do ('on_disconnect_do')
926 # stops the "implicit rollback on disconnect" warning
927 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
930 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
931 # collected before leaving this scope. Depending on the code above, this
932 # may very well be just a preventive measure guarding future modifications
936 =head2 with_deferred_fk_checks
940 =item Arguments: C<$coderef>
942 =item Return Value: The return value of $coderef
946 Storage specific method to run the code ref with FK checks deferred or
947 in MySQL's case disabled entirely.
951 # Storage subclasses should override this
952 sub with_deferred_fk_checks {
953 #my ($self, $sub) = @_;
961 =item Arguments: none
963 =item Return Value: 1|0
967 Verifies that the current database handle is active and ready to execute
968 an SQL statement (e.g. the connection did not get stale, server is still
969 answering, etc.) This method is used internally by L</dbh>.
974 return 0 unless $_[0]->_seems_connected;
977 local $_[0]->_dbh->{RaiseError} = 1;
982 sub _seems_connected {
983 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
987 $_[0]->_dbh->FETCH('Active')
991 # explicitly reset all state
997 ($_[0]->_dbh || return 0)->ping;
1000 sub ensure_connected {
1001 $_[0]->connected || ( $_[0]->_populate_dbh && 1 );
1006 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
1007 is guaranteed to be healthy by implicitly calling L</connected>, and if
1008 necessary performing a reconnection before returning. Keep in mind that this
1009 is very B<expensive> on some database engines. Consider using L</dbh_do>
1015 # maybe save a ping call
1017 ? ( $_[0]->ensure_connected and $_[0]->_dbh )
1018 : $_[0]->_populate_dbh
1022 # this is the internal "get dbh or connect (don't check)" method
1024 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1025 $_[0]->_dbh || $_[0]->_populate_dbh;
1028 # *DELIBERATELY* not a setter (for the time being)
1029 # Too intertwined with everything else for any kind of sanity
1033 $self->throw_exception('sql_maker() is not a setter method') if @_;
1035 unless ($self->_sql_maker) {
1036 my $sql_maker_class = $self->sql_maker_class;
1038 my %opts = %{$self->_sql_maker_opts||{}};
1040 $opts{limit_dialect}
1042 $self->sql_limit_dialect
1045 my $s_class = (ref $self) || $self;
1047 "Your storage class ($s_class) does not set sql_limit_dialect and you "
1048 . 'have not supplied an explicit limit_dialect in your connection_info. '
1049 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
1050 . 'databases but can be (and often is) painfully slow. '
1051 . "Please file an RT ticket against '$s_class'"
1052 ) if $self->_dbi_connect_info->[0];
1058 my ($quote_char, $name_sep);
1060 if ($opts{quote_names}) {
1061 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1062 my $s_class = (ref $self) || $self;
1064 "You requested 'quote_names' but your storage class ($s_class) does "
1065 . 'not explicitly define a default sql_quote_char and you have not '
1066 . 'supplied a quote_char as part of your connection_info. DBIC will '
1067 .q{default to the ANSI SQL standard quote '"', which works most of }
1068 . "the time. Please file an RT ticket against '$s_class'."
1074 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1077 $self->_sql_maker($sql_maker_class->new(
1078 bindtype=>'columns',
1079 array_datatypes => 1,
1080 limit_dialect => $dialect,
1081 ($quote_char ? (quote_char => $quote_char) : ()),
1082 name_sep => ($name_sep || '.'),
1086 return $self->_sql_maker;
1089 # nothing to do by default
1095 # reset internal states
1096 # also in case ->connected failed we might get sent here
1099 $_[0]->_dbh($_[0]->_connect);
1101 $_[0]->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1103 $_[0]->_determine_driver;
1105 # Always set the transaction depth on connect, since
1106 # there is no transaction in progress by definition
1107 $_[0]->transaction_depth( $_[0]->_dbh_autocommit ? 0 : 1 );
1109 $_[0]->_run_connection_actions unless $_[0]->{_in_determine_driver};
1114 sub _run_connection_actions {
1116 $_[0]->_do_connection_actions(connect_call_ => $_) for (
1117 ( $_[0]->on_connect_call || () ),
1118 $_[0]->_parse_connect_do ('on_connect_do'),
1124 sub set_use_dbms_capability {
1125 $_[0]->set_inherited ($_[1], $_[2]);
1128 sub get_use_dbms_capability {
1129 my ($self, $capname) = @_;
1131 my $use = $self->get_inherited ($capname);
1134 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1138 sub set_dbms_capability {
1139 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1142 sub get_dbms_capability {
1143 my ($self, $capname) = @_;
1145 my $cap = $self->_dbh_details->{capability}{$capname};
1147 unless (defined $cap) {
1148 if (my $meth = $self->can ("_determine$capname")) {
1149 $cap = $self->$meth ? 1 : 0;
1155 $self->set_dbms_capability ($capname, $cap);
1164 # FIXME - ideally this needs to be an ||= assignment, and the final
1165 # assignment at the end of this do{} should be gone entirely. However
1166 # this confuses CXSA: https://rt.cpan.org/Ticket/Display.html?id=103296
1167 $self->_dbh_details->{info} || do {
1169 # this guarantees that problematic conninfo won't be hidden
1170 # by the try{} below
1171 $self->ensure_connected;
1175 my $server_version = dbic_internal_try {
1176 $self->_get_server_version
1177 } dbic_internal_catch {
1178 # driver determination *may* use this codepath
1179 # in which case we must rethrow
1180 $self->throw_exception($_) if $self->{_in_determine_driver};
1182 # $server_version on failure
1186 if (defined $server_version) {
1187 $info->{dbms_version} = $server_version;
1189 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1190 my @verparts = split (/\./, $numeric_version);
1196 # consider only up to 3 version parts, iff not more than 3 digits
1198 while (@verparts && @use_parts < 3) {
1199 my $p = shift @verparts;
1201 push @use_parts, $p;
1203 push @use_parts, 0 while @use_parts < 3;
1205 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1209 $self->_dbh_details->{info} = $info;
1213 sub _get_server_version {
1214 shift->_dbh_get_info('SQL_DBMS_VER');
1218 my ($self, $info) = @_;
1220 if ($info =~ /[^0-9]/) {
1221 require DBI::Const::GetInfoType;
1222 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1223 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1224 unless defined $info;
1227 $self->_get_dbh->get_info($info);
1230 sub _describe_connection {
1231 require DBI::Const::GetInfoReturn;
1237 $drv = $self->_extract_driver_from_connect_info;
1238 $self->ensure_connected;
1241 $drv = "DBD::$drv" if $drv;
1244 DBIC_DSN => $self->_dbi_connect_info->[0],
1245 DBI_VER => DBI->VERSION,
1246 DBIC_VER => DBIx::Class->VERSION,
1247 DBIC_DRIVER => ref $self,
1250 DBD_VER => dbic_internal_try { $drv->VERSION },
1254 # try to grab data even if we never managed to connect
1255 # will cover us in cases of an oddly broken half-connect
1257 #keys %DBI::Const::GetInfoType::GetInfoType,
1259 SQL_CURSOR_COMMIT_BEHAVIOR
1260 SQL_CURSOR_ROLLBACK_BEHAVIOR
1261 SQL_CURSOR_SENSITIVITY
1262 SQL_DATA_SOURCE_NAME
1265 SQL_DEFAULT_TXN_ISOLATION
1270 SQL_EXPRESSIONS_IN_ORDERBY
1273 SQL_IDENTIFIER_QUOTE_CHAR
1274 SQL_MAX_CATALOG_NAME_LEN
1275 SQL_MAX_COLUMN_NAME_LEN
1276 SQL_MAX_IDENTIFIER_LEN
1277 SQL_MAX_TABLE_NAME_LEN
1278 SQL_MULTIPLE_ACTIVE_TXN
1279 SQL_MULT_RESULT_SETS
1280 SQL_NEED_LONG_DATA_LEN
1281 SQL_NON_NULLABLE_COLUMNS
1283 SQL_QUALIFIER_NAME_SEPARATOR
1284 SQL_QUOTED_IDENTIFIER_CASE
1286 SQL_TXN_ISOLATION_OPTION
1289 # some drivers barf on things they do not know about instead
1290 # of returning undef
1291 my $v = dbic_internal_try { $self->_dbh_get_info($inf) };
1292 next unless defined $v;
1294 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1295 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1296 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1302 sub _determine_driver {
1305 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1306 my $started_connected = 0;
1308 local $self->{_in_determine_driver} = 1
1309 unless $self->{_in_determine_driver};
1311 if (ref($self) eq __PACKAGE__) {
1313 if ($self->_dbh) { # we are connected
1314 $driver = $self->_dbh->{Driver}{Name};
1315 $started_connected = 1;
1318 $driver = $self->_extract_driver_from_connect_info;
1322 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1323 if ($self->load_optional_class($storage_class)) {
1326 mro::set_mro($storage_class, 'c3') if
1328 ${"${storage_class}::__INITIAL_MRO_UPON_DBIC_LOAD__"}
1329 ||= mro::get_mro($storage_class)
1335 bless $self, $storage_class;
1339 $self->_warn_undetermined_driver(
1340 'This version of DBIC does not yet seem to supply a driver for '
1341 . "your particular RDBMS and/or connection method ('$driver')."
1346 $self->_warn_undetermined_driver(
1347 'Unable to extract a driver name from connect info - this '
1348 . 'should not have happened.'
1353 $self->_driver_determined(1);
1355 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1357 if ($self->can('source_bind_attributes')) {
1358 $self->throw_exception(
1359 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1360 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1361 . 'If you are not sure how to proceed please contact the development team via '
1362 . DBIx::Class::_ENV_::HELP_URL
1366 $self->_init; # run driver-specific initializations
1368 $self->_run_connection_actions
1369 if !$started_connected && defined $self->_dbh;
1373 sub _extract_driver_from_connect_info {
1378 # if connect_info is a CODEREF, we have no choice but to connect
1380 ref $self->_dbi_connect_info->[0]
1382 reftype $self->_dbi_connect_info->[0] eq 'CODE'
1384 $self->_populate_dbh;
1385 $drv = $self->_dbh->{Driver}{Name};
1388 # try to use dsn to not require being connected, the driver may still
1389 # force a connection later in _rebless to determine version
1390 # (dsn may not be supplied at all if all we do is make a mock-schema)
1392 # Use the same regex as the one used by DBI itself (even if the use of
1393 # \w is odd given unicode):
1394 # https://metacpan.org/source/TIMB/DBI-1.634/DBI.pm#L621
1396 # DO NOT use https://metacpan.org/source/TIMB/DBI-1.634/DBI.pm#L559-566
1397 # as there is a long-standing precedent of not loading DBI.pm until the
1398 # very moment we are actually connecting
1400 ($drv) = ($self->_dbi_connect_info->[0] || '') =~ /^dbi:(\w*)/i;
1401 $drv ||= $ENV{DBI_DRIVER};
1407 sub _determine_connector_driver {
1408 my ($self, $conn) = @_;
1410 my $dbtype = $self->_get_rdbms_name;
1413 $self->_warn_undetermined_driver(
1414 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1415 . "$conn connector - this should not have happened."
1420 $dbtype =~ s/\W/_/gi;
1422 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1423 return if $self->isa($subclass);
1425 if ($self->load_optional_class($subclass)) {
1426 bless $self, $subclass;
1430 $self->_warn_undetermined_driver(
1431 'This version of DBIC does not yet seem to supply a driver for '
1432 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1437 sub _get_rdbms_name { shift->_dbh_get_info('SQL_DBMS_NAME') }
1439 sub _warn_undetermined_driver {
1440 my ($self, $msg) = @_;
1442 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1443 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1444 . "does not go away, file a bugreport including the following info:\n"
1445 . dump_value $self->_describe_connection
1449 sub _do_connection_actions {
1450 my ($self, $method_prefix, $call, @args) = @_;
1453 if (not ref($call)) {
1454 my $method = $method_prefix . $call;
1455 $self->$method(@args);
1457 elsif (ref($call) eq 'CODE') {
1458 $self->$call(@args);
1460 elsif (ref($call) eq 'ARRAY') {
1461 if (ref($call->[0]) ne 'ARRAY') {
1462 $self->_do_connection_actions($method_prefix, $_) for @$call;
1465 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1469 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1472 dbic_internal_catch {
1473 if ( $method_prefix =~ /^connect/ ) {
1474 # this is an on_connect cycle - we can't just throw while leaving
1475 # a handle in an undefined state in our storage object
1476 # kill it with fire and rethrow
1478 $self->disconnect; # the $dbh is gone, but we still need to reset the rest
1479 $self->throw_exception( $_[0] );
1482 carp "Disconnect action failed: $_[0]";
1489 sub connect_call_do_sql {
1491 $self->_do_query(@_);
1494 sub disconnect_call_do_sql {
1496 $self->_do_query(@_);
1499 =head2 connect_call_datetime_setup
1501 A no-op stub method, provided so that one can always safely supply the
1502 L<connection option|/DBIx::Class specific connection attributes>
1504 on_connect_call => 'datetime_setup'
1506 This way one does not need to know in advance whether the underlying
1507 storage requires any sort of hand-holding when dealing with calendar
1512 sub connect_call_datetime_setup { 1 }
1515 my ($self, $action) = @_;
1517 if (ref $action eq 'CODE') {
1518 $action = $action->($self);
1519 $self->_do_query($_) foreach @$action;
1522 # Most debuggers expect ($sql, @bind), so we need to exclude
1523 # the attribute hash which is the second argument to $dbh->do
1524 # furthermore the bind values are usually to be presented
1525 # as named arrayref pairs, so wrap those here too
1526 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1527 my $sql = shift @do_args;
1528 my $attrs = shift @do_args;
1529 my @bind = map { [ undef, $_ ] } @do_args;
1532 $_[0]->_query_start($sql, \@bind);
1533 $_[1]->do($sql, $attrs, @do_args);
1534 $_[0]->_query_end($sql, \@bind);
1544 my $info = $self->_dbi_connect_info;
1546 $self->throw_exception("You did not provide any connection_info")
1547 unless defined $info->[0];
1549 my ($old_connect_via, $dbh);
1551 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1553 # this odd anonymous coderef dereference is in fact really
1554 # necessary to avoid the unwanted effect described in perl5
1557 # in addition the coderef itself can't reside inside the try{} block below
1558 # as it somehow triggers a leak under perl -d
1559 my $dbh_error_handler_installer = sub {
1560 weaken (my $weak_self = $_[0]);
1562 # the coderef is blessed so we can distinguish it from externally
1563 # supplied handles (which must be preserved)
1564 $_[1]->{HandleError} = bless sub {
1566 $weak_self->throw_exception("DBI Exception: $_[0]");
1569 # the handler may be invoked by something totally out of
1571 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1573 }, '__DBIC__DBH__ERROR__HANDLER__';
1577 if(ref $info->[0] eq 'CODE') {
1578 $dbh = $info->[0]->();
1582 $dbh = DBI->connect(@$info);
1585 die $DBI::errstr unless $dbh;
1587 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1588 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1590 ref $info->[0] eq 'CODE'
1591 ? "Connection coderef $info->[0] returned a"
1592 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1593 ) unless $dbh->FETCH('Active');
1595 # sanity checks unless asked otherwise
1596 unless ($self->unsafe) {
1598 $self->throw_exception(
1599 'Refusing clobbering of {HandleError} installed on externally supplied '
1600 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1601 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1603 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1604 # request, or an external handle. Complain and set anyway
1605 unless ($dbh->{RaiseError}) {
1606 carp( ref $info->[0] eq 'CODE'
1608 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1609 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1610 .'attribute has been supplied'
1612 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1613 .'unsafe => 1. Toggling RaiseError back to true'
1616 $dbh->{RaiseError} = 1;
1619 $dbh_error_handler_installer->($self, $dbh);
1622 dbic_internal_catch {
1623 $self->throw_exception("DBI Connection failed: $_")
1626 $self->_dbh_autocommit($dbh->{AutoCommit});
1631 # this means we have not yet connected and do not know the AC status
1632 # (e.g. coderef $dbh), need a full-fledged connection check
1633 if (! defined $_[0]->_dbh_autocommit) {
1634 $_[0]->ensure_connected;
1636 # Otherwise simply connect or re-connect on pid changes
1641 shift->next::method(@_);
1644 sub _exec_txn_begin {
1647 # if the user is utilizing txn_do - good for him, otherwise we need to
1648 # ensure that the $dbh is healthy on BEGIN.
1649 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1650 # will be replaced by a failure of begin_work itself (which will be
1651 # then retried on reconnect)
1652 if ($self->{_in_do_block}) {
1653 $self->_dbh->begin_work;
1655 $self->dbh_do(sub { $_[1]->begin_work });
1662 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1663 unless $self->_seems_connected;
1665 # esoteric case for folks using external $dbh handles
1666 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1667 carp "Storage transaction_depth 0 does not match "
1668 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1669 $self->transaction_depth(1);
1672 $self->next::method(@_);
1674 # if AutoCommit is disabled txn_depth never goes to 0
1675 # as a new txn is started immediately on commit
1676 $self->transaction_depth(1) if (
1677 !$self->transaction_depth
1679 defined $self->_dbh_autocommit
1681 ! $self->_dbh_autocommit
1685 sub _exec_txn_commit {
1686 shift->_dbh->commit;
1692 # do a minimal connectivity check due to weird shit like
1693 # https://rt.cpan.org/Public/Bug/Display.html?id=62370
1694 $self->throw_exception("lost connection to storage")
1695 unless $self->_seems_connected;
1697 # esoteric case for folks using external $dbh handles
1698 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1699 carp "Storage transaction_depth 0 does not match "
1700 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1701 $self->transaction_depth(1);
1704 $self->next::method(@_);
1706 # if AutoCommit is disabled txn_depth never goes to 0
1707 # as a new txn is started immediately on commit
1708 $self->transaction_depth(1) if (
1709 !$self->transaction_depth
1711 defined $self->_dbh_autocommit
1713 ! $self->_dbh_autocommit
1717 sub _exec_txn_rollback {
1718 shift->_dbh->rollback;
1721 # generate the DBI-specific stubs, which then fallback to ::Storage proper
1722 quote_sub __PACKAGE__ . "::$_" => sprintf (<<'EOS', $_) for qw(svp_begin svp_release svp_rollback);
1723 $_[0]->throw_exception('Unable to %s() on a disconnected storage')
1724 unless $_[0]->_seems_connected;
1725 shift->next::method(@_);
1728 # This used to be the top-half of _execute. It was split out to make it
1729 # easier to override in NoBindVars without duping the rest. It takes up
1730 # all of _execute's args, and emits $sql, @bind.
1731 sub _prep_for_execute {
1732 #my ($self, $op, $ident, $args) = @_;
1733 return shift->_gen_sql_bind(@_)
1737 my ($self, $op, $ident, $args) = @_;
1739 my ($colinfos, $from);
1740 if ( blessed($ident) ) {
1741 $from = $ident->from;
1742 $colinfos = $ident->columns_info;
1746 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1748 $bind = $self->_resolve_bindattrs(
1749 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1753 ! $ENV{DBIC_DT_SEARCH_OK}
1758 defined blessed($_->[1])
1760 $_->[1]->isa('DateTime')
1763 carp_unique 'DateTime objects passed to search() are not supported '
1764 . 'properly (InflateColumn::DateTime formats and settings are not '
1765 . 'respected.) See ".. format a DateTime object for searching?" in '
1766 . 'DBIx::Class::Manual::FAQ. To disable this warning for good '
1767 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1770 return( $sql, $bind );
1773 sub _resolve_bindattrs {
1774 my ($self, $ident, $bind, $colinfos) = @_;
1776 my $resolve_bindinfo = sub {
1777 #my $infohash = shift;
1779 # shallow copy to preempt autoviv
1780 $colinfos ||= { %{ fromspec_columns_info($ident) } };
1783 if (my $col = $_[0]->{dbic_colname}) {
1784 $ret = { %{$_[0]} };
1786 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1787 if $colinfos->{$col}{data_type};
1789 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1790 if $colinfos->{$col}{size};
1797 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1798 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1799 : (ref $_->[0] eq 'HASH') ? [(
1802 exists $_->[0]{dbd_attrs}
1804 $_->[0]{sqlt_datatype}
1806 : $resolve_bindinfo->($_->[0])
1809 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1810 : [ $resolve_bindinfo->(
1811 { dbic_colname => $_->[0] }
1816 sub _format_for_trace {
1817 #my ($self, $bind) = @_;
1819 ### Turn @bind from something like this:
1820 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1822 ### ( "'1'", "'3'" )
1825 defined( $_ && $_->[1] )
1826 ? sprintf( "'%s'", "$_->[1]" ) # because overload
1832 my ( $self, $sql, $bind ) = @_;
1834 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1839 my ( $self, $sql, $bind ) = @_;
1841 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1845 sub _dbi_attrs_for_bind {
1846 #my ($self, $ident, $bind) = @_;
1850 exists $_->{dbd_attrs} ? $_->{dbd_attrs}
1852 : ! $_->{sqlt_datatype} ? undef
1856 # cache the result in the dbh_details hash, as it (usually) can not change
1857 # unless we connect to something else
1858 # FIXME: for the time being Oracle is an exception, pending a rewrite of
1860 my $cache = $_[0]->_dbh_details->{_datatype_map_cache} ||= {};
1862 $cache->{$_->{sqlt_datatype}} = $_[0]->bind_attribute_by_data_type($_->{sqlt_datatype})
1863 if ! exists $cache->{$_->{sqlt_datatype}};
1865 $cache->{$_->{sqlt_datatype}};
1867 } } map { $_->[0] } @{$_[2]} ];
1871 my ($self, $op, $ident, @args) = @_;
1873 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1875 # not even a PID check - we do not care about the state of the _dbh.
1876 # All we need is to get the appropriate drivers loaded if they aren't
1877 # already so that the assumption in ad7c50fc26e holds
1878 $self->_populate_dbh unless $self->_dbh;
1880 $self->dbh_do( _dbh_execute => # retry over disconnects
1883 $self->_dbi_attrs_for_bind($ident, $bind),
1888 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1890 $self->_query_start( $sql, $bind );
1892 my $sth = $self->_bind_sth_params(
1893 $self->_prepare_sth($dbh, $sql),
1898 # Can this fail without throwing an exception anyways???
1899 my $rv = $sth->execute();
1900 $self->throw_exception(
1901 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1904 $self->_query_end( $sql, $bind );
1906 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1910 my ($self, $dbh, $sql) = @_;
1912 # 3 is the if_active parameter which avoids active sth re-use
1913 my $sth = $self->disable_sth_caching
1914 ? $dbh->prepare($sql)
1915 : $dbh->prepare_cached($sql, {}, 3);
1917 # XXX You would think RaiseError would make this impossible,
1918 # but apparently that's not true :(
1919 $self->throw_exception(
1922 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1923 .'an exception and/or setting $dbh->errstr',
1925 ? substr($sql, 0, 20) . '...'
1928 'DBD::' . $dbh->{Driver}{Name},
1935 sub _bind_sth_params {
1936 my ($self, $sth, $bind, $bind_attrs) = @_;
1938 for my $i (0 .. $#$bind) {
1939 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1940 $sth->bind_param_inout(
1941 $i + 1, # bind params counts are 1-based
1943 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1948 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
1949 my $v = ( length ref $bind->[$i][1] and is_plain_value $bind->[$i][1] )
1956 # The temp-var is CRUCIAL - DO NOT REMOVE IT, breaks older DBD::SQLite RT#79576
1966 sub _prefetch_autovalues {
1967 my ($self, $source, $colinfo, $to_insert) = @_;
1970 for my $col (keys %$colinfo) {
1972 $colinfo->{$col}{auto_nextval}
1975 ! exists $to_insert->{$col}
1977 is_literal_value($to_insert->{$col})
1980 $values{$col} = $self->_sequence_fetch(
1982 ( $colinfo->{$col}{sequence} ||=
1983 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1993 my ($self, $source, $to_insert) = @_;
1995 my $col_infos = $source->columns_info;
1997 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1999 # fuse the values, but keep a separate list of prefetched_values so that
2000 # they can be fused once again with the final return
2001 $to_insert = { %$to_insert, %$prefetched_values };
2003 my %pcols = map { $_ => 1 } $source->primary_columns;
2005 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
2007 for my $col ($source->columns) {
2009 # first autoinc wins - this is why ->columns() in-order iteration is important
2011 # FIXME - there ought to be a sanity-check for multiple is_auto_increment settings
2014 if ($col_infos->{$col}{is_auto_increment}) {
2016 # FIXME - we seem to assume undef values as non-supplied.
2018 # Investigate what does it take to s/defined/exists/
2019 # ( fails t/cdbi/copy.t amoong other things )
2020 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
2022 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
2025 # nothing to retrieve when explicit values are supplied
2027 # FIXME - we seem to assume undef values as non-supplied.
2029 # Investigate what does it take to s/defined/exists/
2030 # ( fails t/cdbi/copy.t amoong other things )
2031 defined $to_insert->{$col}
2034 # not a ref - cheaper to check before a call to is_literal_value()
2035 ! length ref $to_insert->{$col}
2037 # not a literal we *MAY* need to pull out ( see check below )
2038 ! is_literal_value( $to_insert->{$col} )
2042 # the 'scalar keys' is a trick to preserve the ->columns declaration order
2043 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
2046 $col_infos->{$col}{retrieve_on_insert}
2050 # corner case of a non-supplied PK which is *not* declared as autoinc
2054 ! defined $retrieve_autoinc_col
2056 # FIXME - first come-first serve, suboptimal...
2057 ($retrieve_autoinc_col) = ( grep
2061 ! $col_infos->{$_}{retrieve_on_insert}
2063 ! defined $col_infos->{$_}{is_auto_increment}
2066 { $retrieve_cols{$a} <=> $retrieve_cols{$b} }
2071 "Missing value for primary key column '$retrieve_autoinc_col' on "
2072 . "@{[ $source->source_name ]} - perhaps you forgot to set its "
2073 . "'is_auto_increment' attribute during add_columns()? Treating "
2074 . "'$retrieve_autoinc_col' implicitly as an autoinc, and attempting "
2079 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
2080 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
2082 my ($sqla_opts, @ir_container);
2083 if (%retrieve_cols and $self->_use_insert_returning) {
2084 $sqla_opts->{returning_container} = \@ir_container
2085 if $self->_use_insert_returning_bound;
2087 $sqla_opts->{returning} = [
2088 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
2092 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
2094 my %returned_cols = %$to_insert;
2095 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
2097 unless( @ir_container ) {
2100 # FIXME - need to investigate why Caelum silenced this in 4d4dc518
2101 local $SIG{__WARN__} = sub {};
2103 @ir_container = $sth->fetchrow_array;
2106 } dbic_internal_catch {
2107 # Evict the $sth from the cache in case we got here, since the finish()
2108 # is crucial, at least on older Firebirds, possibly on other engines too
2110 # It would be too complex to make this a proper subclass override,
2111 # and besides we already take the try{} penalty, adding a catch that
2112 # triggers infrequently is a no-brainer
2114 if( my $kids = $self->_dbh->{CachedKids} ) {
2115 $kids->{$_} == $sth and delete $kids->{$_}
2121 @returned_cols{@$retlist} = @ir_container if @ir_container;
2124 # pull in PK if needed and then everything else
2125 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
2127 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
2128 unless $self->can('last_insert_id');
2130 my @pri_values = $self->last_insert_id($source, @missing_pri);
2132 $self->throw_exception( "Can't get last insert id" )
2133 unless (@pri_values == @missing_pri);
2135 @returned_cols{@missing_pri} = @pri_values;
2136 delete @retrieve_cols{@missing_pri};
2139 # if there is more left to pull
2140 if (%retrieve_cols) {
2141 $self->throw_exception(
2142 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
2145 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
2147 my $cur = DBIx::Class::ResultSet->new($source, {
2148 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
2149 select => \@left_to_fetch,
2152 @returned_cols{@left_to_fetch} = $cur->next;
2154 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
2155 if scalar $cur->next;
2159 return { %$prefetched_values, %returned_cols };
2164 'insert_bulk() should have never been exposed as a public method and '
2165 . 'calling it is depecated as of Aug 2014. If you believe having a genuine '
2166 . 'use for this method please contact the development team via '
2167 . DBIx::Class::_ENV_::HELP_URL
2170 return '0E0' unless @{$_[3]||[]};
2172 shift->_insert_bulk(@_);
2176 my ($self, $source, $cols, $data) = @_;
2178 $self->throw_exception('Calling _insert_bulk without a dataset to process makes no sense')
2179 unless @{$data||[]};
2181 my $colinfos = $source->columns_info($cols);
2183 local $self->{_autoinc_supplied_for_op} =
2184 (grep { $_->{is_auto_increment} } values %$colinfos)
2189 # get a slice type index based on first row of data
2190 # a "column" in this context may refer to more than one bind value
2191 # e.g. \[ '?, ?', [...], [...] ]
2193 # construct the value type index - a description of values types for every
2194 # per-column slice of $data:
2196 # nonexistent - nonbind literal
2198 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2200 # also construct the column hash to pass to the SQL generator. For plain
2201 # (non literal) values - convert the members of the first row into a
2202 # literal+bind combo, with extra positional info in the bind attr hashref.
2203 # This will allow us to match the order properly, and is so contrived
2204 # because a user-supplied literal/bind (or something else specific to a
2205 # resultsource and/or storage driver) can inject extra binds along the
2206 # way, so one can't rely on "shift positions" ordering at all. Also we
2207 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2208 # can be later matched up by address), because we want to supply a real
2209 # value on which perhaps e.g. datatype checks will be performed
2210 my ($proto_data, $serialized_bind_type_by_col_idx);
2211 for my $col_idx (0..$#$cols) {
2212 my $colname = $cols->[$col_idx];
2213 if (ref $data->[0][$col_idx] eq 'SCALAR') {
2214 # no bind value at all - no type
2216 $proto_data->{$colname} = $data->[0][$col_idx];
2218 elsif (ref $data->[0][$col_idx] eq 'REF' and ref ${$data->[0][$col_idx]} eq 'ARRAY' ) {
2219 # repack, so we don't end up mangling the original \[]
2220 my ($sql, @bind) = @${$data->[0][$col_idx]};
2222 # normalization of user supplied stuff
2223 my $resolved_bind = $self->_resolve_bindattrs(
2224 $source, \@bind, $colinfos,
2227 # store value-less (attrs only) bind info - we will be comparing all
2228 # supplied binds against this for sanity
2229 $serialized_bind_type_by_col_idx->{$col_idx} = serialize [ map { $_->[0] } @$resolved_bind ];
2231 $proto_data->{$colname} = \[ $sql, map { [
2232 # inject slice order to use for $proto_bind construction
2233 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $col_idx, _literal_bind_subindex => $_+1 }
2235 $resolved_bind->[$_][1]
2240 $serialized_bind_type_by_col_idx->{$col_idx} = undef;
2242 $proto_data->{$colname} = \[ '?', [
2243 { dbic_colname => $colname, _bind_data_slice_idx => $col_idx }
2245 $data->[0][$col_idx]
2250 my ($sql, $proto_bind) = $self->_prep_for_execute (
2256 if (! @$proto_bind and keys %$serialized_bind_type_by_col_idx) {
2257 # if the bindlist is empty and we had some dynamic binds, this means the
2258 # storage ate them away (e.g. the NoBindVars component) and interpolated
2259 # them directly into the SQL. This obviously can't be good for multi-inserts
2260 $self->throw_exception('Unable to invoke fast-path insert without storage placeholder support');
2264 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2266 # use an error reporting closure for convenience (less to pass)
2267 my $bad_slice_report_cref = sub {
2268 my ($msg, $r_idx, $c_idx) = @_;
2269 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2273 local $Data::Dumper::Maxdepth = 5;
2275 map { $cols->[$_] =>
2283 for my $col_idx (0..$#$cols) {
2284 my $reference_val = $data->[0][$col_idx];
2286 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2287 my $val = $data->[$row_idx][$col_idx];
2289 if (! exists $serialized_bind_type_by_col_idx->{$col_idx}) { # literal no binds
2290 if (ref $val ne 'SCALAR') {
2291 $bad_slice_report_cref->(
2292 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2297 elsif ($$val ne $$reference_val) {
2298 $bad_slice_report_cref->(
2299 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2305 elsif (! defined $serialized_bind_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2306 if (is_literal_value($val)) {
2307 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2310 else { # binds from a \[], compare type and attrs
2311 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2312 $bad_slice_report_cref->(
2313 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2318 # start drilling down and bail out early on identical refs
2320 $reference_val != $val
2322 $$reference_val != $$val
2324 if (${$val}->[0] ne ${$reference_val}->[0]) {
2325 $bad_slice_report_cref->(
2326 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2331 # need to check the bind attrs - a bind will happen only once for
2332 # the entire dataset, so any changes further down will be ignored.
2334 $serialized_bind_type_by_col_idx->{$col_idx}
2339 @{$self->_resolve_bindattrs(
2340 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2344 $bad_slice_report_cref->(
2345 'Differing bind attributes on literal/bind values not supported',
2355 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2356 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2358 my $guard = $self->txn_scope_guard;
2360 $self->_query_start( $sql, @$proto_bind ? [[ {} => '__BULK_INSERT__' ]] : () );
2361 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2364 # proto bind contains the information on which pieces of $data to pull
2365 # $cols is passed in only for prettier error-reporting
2366 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2369 # bind_param_array doesn't work if there are no binds
2370 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2374 $self->_query_end( $sql, @$proto_bind ? [[ {} => '__BULK_INSERT__' ]] : () );
2378 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2381 # execute_for_fetch is capable of returning data just fine (it means it
2382 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2383 # is the void-populate fast-path we will just ignore this altogether
2384 # for the time being.
2385 sub _dbh_execute_for_fetch {
2386 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2388 # If we have any bind attributes to take care of, we will bind the
2389 # proto-bind data (which will never be used by execute_for_fetch)
2390 # However since column bindtypes are "sticky", this is sufficient
2391 # to get the DBD to apply the bindtype to all values later on
2392 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2394 for my $i (0 .. $#$proto_bind) {
2396 $i+1, # DBI bind indexes are 1-based
2397 $proto_bind->[$i][1],
2399 ) if defined $bind_attrs->[$i];
2402 # At this point $data slots named in the _bind_data_slice_idx of
2403 # each piece of $proto_bind are either \[]s or plain values to be
2404 # passed in. Construct the dispensing coderef. *NOTE* the order
2405 # of $data will differ from this of the ?s in the SQL (due to
2406 # alphabetical ordering by colname). We actually do want to
2407 # preserve this behavior so that prepare_cached has a better
2408 # chance of matching on unrelated calls
2410 my $fetch_row_idx = -1; # saner loop this way
2411 my $fetch_tuple = sub {
2412 return undef if ++$fetch_row_idx > $#$data;
2415 my $v = ! defined $_->{_literal_bind_subindex}
2417 ? $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2419 # There are no attributes to resolve here - we already did everything
2420 # when we constructed proto_bind. However we still want to sanity-check
2421 # what the user supplied, so pass stuff through to the resolver *anyway*
2422 : $self->_resolve_bindattrs (
2423 undef, # a fake rsrc
2424 [ ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}->[ $_->{_literal_bind_subindex} ] ],
2425 {}, # a fake column_info bag
2429 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
2430 # For the time being forcibly stringify whatever is stringifiable
2433 ( !length ref $v or ! ($vref = is_plain_value $v) ) ? $v
2434 : defined blessed( $$vref ) ? "$$vref"
2437 } map { $_->[0] } @$proto_bind ];
2440 my $tuple_status = [];
2443 $rv = $sth->execute_for_fetch(
2448 dbic_internal_catch {
2452 # Not all DBDs are create equal. Some throw on error, some return
2453 # an undef $rv, and some set $sth->err - try whatever we can
2454 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2457 ( !defined $rv or $sth->err )
2460 # Statement must finish even if there was an exception.
2464 dbic_internal_catch {
2465 $err = shift unless defined $err
2470 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2472 $self->throw_exception("Unexpected populate error: $err")
2473 if ($i > $#$tuple_status);
2475 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2476 ($tuple_status->[$i][1] || $err),
2477 dump_value { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) },
2484 sub _dbh_execute_inserts_with_no_binds {
2485 my ($self, $sth, $count) = @_;
2489 my $dbh = $self->_get_dbh;
2490 local $dbh->{RaiseError} = 1;
2491 local $dbh->{PrintError} = 0;
2493 $sth->execute foreach 1..$count;
2495 dbic_internal_catch {
2499 # Make sure statement is finished even if there was an exception.
2503 dbic_internal_catch {
2504 $err = shift unless defined $err;
2507 $self->throw_exception($err) if defined $err;
2513 #my ($self, $source, @args) = @_;
2514 shift->_execute('update', @_);
2519 #my ($self, $source, @args) = @_;
2520 shift->_execute('delete', @_);
2525 $self->_execute($self->_select_args(@_));
2528 sub _select_args_to_query {
2531 $self->throw_exception(
2532 "Unable to generate limited query representation with 'software_limit' enabled"
2533 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2535 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2536 # = $self->_select_args($ident, $select, $cond, $attrs);
2537 my ($op, $ident, @args) =
2538 $self->_select_args(@_);
2540 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2541 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2543 # reuse the bind arrayref
2544 unshift @{$bind}, "($sql)";
2549 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2551 # FIXME - that kind of caching would be nice to have
2552 # however currently we *may* pass the same $orig_attrs
2553 # with different ident/select/where
2554 # the whole interface needs to be rethought, since it
2555 # was centered around the flawed SQLA API. We can do
2556 # soooooo much better now. But that is also another
2559 # 'select', $orig_attrs->{!args_as_stored_at_the_end_of_this_method!}
2560 #) if $orig_attrs->{!args_as_stored_at_the_end_of_this_method!};
2562 my $sql_maker = $self->sql_maker;
2571 # MySQL actually recommends this approach. I cringe.
2572 $attrs->{rows} ||= $sql_maker->__max_int
2573 if $attrs->{offset};
2575 # see if we will need to tear the prefetch apart to satisfy group_by == select
2576 # this is *extremely tricky* to get right, I am still not sure I did
2578 my ($prefetch_needs_subquery, @limit_args);
2580 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2581 # we already know there is a valid group_by (we made it) and we know it is
2582 # intended to be based *only* on non-multi stuff
2583 # short circuit the group_by parsing below
2584 $prefetch_needs_subquery = 1;
2587 # The rationale is that even if we do *not* have collapse, we still
2588 # need to wrap the core grouped select/group_by in a subquery
2589 # so that databases that care about group_by/select equivalence
2590 # are happy (this includes MySQL in strict_mode)
2591 # If any of the other joined tables are referenced in the group_by
2592 # however - the user is on their own
2593 ( $prefetch_needs_subquery or ! $attrs->{_simple_passthrough_construction} )
2597 @{$attrs->{group_by}}
2599 my $grp_aliases = dbic_internal_try { # internal_try{} because $attrs->{from} may be unreadable
2600 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2603 # no aliases other than our own in group_by
2604 # if there are - do not allow subquery even if limit is present
2605 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2607 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2608 # active collapse with a limit - that one is a no-brainer unless
2609 # overruled by a group_by above
2610 $prefetch_needs_subquery = 1;
2613 if ($prefetch_needs_subquery) {
2614 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2616 elsif (! $attrs->{software_limit} ) {
2618 $attrs->{rows} || (),
2619 $attrs->{offset} || (),
2623 # try to simplify the joinmap further (prune unreferenced type-single joins)
2625 ! $prefetch_needs_subquery # already pruned
2629 reftype $attrs->{from} eq 'ARRAY'
2631 @{$attrs->{from}} != 1
2633 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2636 # FIXME this is a gross, inefficient, largely incorrect and fragile hack
2637 # during the result inflation stage we *need* to know what was the aliastype
2638 # map as sqla saw it when the final pieces of SQL were being assembled
2639 # Originally we simply carried around the entirety of $attrs, but this
2640 # resulted in resultsets that are being reused growing continuously, as
2641 # the hash in question grew deeper and deeper.
2642 # Instead hand-pick what to take with us here (we actually don't need much
2643 # at this point just the map itself)
2644 $orig_attrs->{_last_sqlmaker_alias_map} = $attrs->{_aliastypes};
2647 # This would be the point to deflate anything found in $attrs->{where}
2648 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2649 # expect a result object. And all we have is a resultsource (it is trivial
2650 # to extract deflator coderefs via $alias2source above).
2652 # I don't see a way forward other than changing the way deflators are
2653 # invoked, and that's just bad...
2656 return ( 'select', @{$attrs}{qw(from select where)}, $attrs, @limit_args );
2659 # Returns a counting SELECT for a simple count
2660 # query. Abstracted so that a storage could override
2661 # this to { count => 'firstcol' } or whatever makes
2662 # sense as a performance optimization
2664 #my ($self, $source, $rs_attrs) = @_;
2665 return { count => '*' };
2672 =item Arguments: $ident, $select, $condition, $attrs
2676 Handle a SQL select statement.
2682 my ($ident, $select, $condition, $attrs) = @_;
2683 return $self->cursor_class->new($self, \@_, $attrs);
2688 my ($rv, $sth, @bind) = $self->_select(@_);
2689 my @row = $sth->fetchrow_array;
2690 my @nextrow = $sth->fetchrow_array if @row;
2691 if(@row && @nextrow) {
2692 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2694 # Need to call finish() to work round broken DBDs
2699 =head2 sql_limit_dialect
2701 This is an accessor for the default SQL limit dialect used by a particular
2702 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2703 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2704 see L<DBIx::Class::SQLMaker::LimitDialects>.
2708 sub _dbh_columns_info_for {
2709 my ($self, $dbh, $table) = @_;
2713 if (! DBIx::Class::_ENV_::STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE and $dbh->can('column_info')) {
2715 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2716 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2718 while ( my $info = $sth->fetchrow_hashref() ){
2720 $column_info{data_type} = $info->{TYPE_NAME};
2721 $column_info{size} = $info->{COLUMN_SIZE};
2722 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2723 $column_info{default_value} = $info->{COLUMN_DEF};
2724 my $col_name = $info->{COLUMN_NAME};
2725 $col_name =~ s/^\"(.*)\"$/$1/;
2727 $result{$col_name} = \%column_info;
2729 } dbic_internal_catch {
2733 return \%result if keys %result;
2736 my $sth = $dbh->prepare(
2737 $self->sql_maker->select( $table, \'*', UNRESOLVABLE_CONDITION )
2741 ### The acrobatics with lc names is necessary to support both the legacy
2742 ### API that used NAME_lc exclusively, *AND* at the same time work properly
2743 ### with column names differing in cas eonly (thanks pg!)
2745 my ($columns, $seen_lcs);
2747 ++$seen_lcs->{lc($_)} and $columns->{$_} = {
2748 idx => scalar keys %$columns,
2751 } for @{$sth->{NAME}};
2753 $seen_lcs->{$_->{lc_name}} == 1
2755 $_->{name} = $_->{lc_name}
2756 for values %$columns;
2758 for ( values %$columns ) {
2760 data_type => $sth->{TYPE}->[$_->{idx}],
2761 size => $sth->{PRECISION}->[$_->{idx}],
2762 is_nullable => $sth->{NULLABLE}->[$_->{idx}] ? 1 : 0,
2765 if ($inf->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2766 @{$inf}{qw( data_type size)} = ($1, $2);
2769 $result{$_->{name}} = $inf;
2774 if ($dbh->can('type_info')) {
2775 for my $inf (values %result) {
2776 next if ! defined $inf->{data_type};
2778 $inf->{data_type} = (
2781 $dbh->type_info( $inf->{data_type} )
2792 # FIXME - this may be an artifact of the DBD::Pg implmentation alone
2793 # needs more testing in the future...
2794 $inf->{size} -= 4 if (
2795 ( $inf->{size}||0 > 4 )
2797 $inf->{data_type} =~ qr/^text$/i
2806 sub columns_info_for {
2807 my ($self, $table) = @_;
2808 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2811 =head2 last_insert_id
2813 Return the row id of the last insert.
2817 sub _dbh_last_insert_id {
2818 my ($self, $dbh, $source, $col) = @_;
2820 my $id = dbic_internal_try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2822 return $id if defined $id;
2824 my $class = ref $self;
2825 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2828 sub last_insert_id {
2830 $self->_dbh_last_insert_id ($self->_dbh, @_);
2833 =head2 _native_data_type
2837 =item Arguments: $type_name
2841 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2842 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2843 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2845 The default implementation returns C<undef>, implement in your Storage driver if
2846 you need this functionality.
2848 Should map types from other databases to the native RDBMS type, for example
2849 C<VARCHAR2> to C<VARCHAR>.
2851 Types with modifiers should map to the underlying data type. For example,
2852 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2854 Composite types should map to the container type, for example
2855 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2859 sub _native_data_type {
2860 #my ($self, $data_type) = @_;
2864 # Check if placeholders are supported at all
2865 sub _determine_supports_placeholders {
2867 my $dbh = $self->_get_dbh;
2869 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2870 # but it is inaccurate more often than not
2871 ( dbic_internal_try {
2872 local $dbh->{PrintError} = 0;
2873 local $dbh->{RaiseError} = 1;
2874 $dbh->do('select ?', {}, 1);
2882 # Check if placeholders bound to non-string types throw exceptions
2884 sub _determine_supports_typeless_placeholders {
2886 my $dbh = $self->_get_dbh;
2888 ( dbic_internal_try {
2889 local $dbh->{PrintError} = 0;
2890 local $dbh->{RaiseError} = 1;
2891 # this specifically tests a bind that is NOT a string
2892 $dbh->do('select 1 where 1 = ?', {}, 1);
2902 Returns the database driver name.
2907 shift->_get_dbh->{Driver}->{Name};
2910 =head2 bind_attribute_by_data_type
2912 Given a datatype from column info, returns a database specific bind
2913 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2914 let the database planner just handle it.
2916 This method is always called after the driver has been determined and a DBI
2917 connection has been established. Therefore you can refer to C<DBI::$constant>
2918 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2919 the correct modules.
2923 sub bind_attribute_by_data_type {
2927 =head2 is_datatype_numeric
2929 Given a datatype from column_info, returns a boolean value indicating if
2930 the current RDBMS considers it a numeric value. This controls how
2931 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2932 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2933 be performed instead of the usual C<eq>.
2937 sub is_datatype_numeric {
2938 #my ($self, $dt) = @_;
2940 return 0 unless $_[1];
2943 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2948 =head2 create_ddl_dir
2952 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2956 Creates a SQL file based on the Schema, for each of the specified
2957 database engines in C<\@databases> in the given directory.
2958 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2960 Given a previous version number, this will also create a file containing
2961 the ALTER TABLE statements to transform the previous schema into the
2962 current one. Note that these statements may contain C<DROP TABLE> or
2963 C<DROP COLUMN> statements that can potentially destroy data.
2965 The file names are created using the C<ddl_filename> method below, please
2966 override this method in your schema if you would like a different file
2967 name format. For the ALTER file, the same format is used, replacing
2968 $version in the name with "$preversion-$version".
2970 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2971 The most common value for this would be C<< { add_drop_table => 1 } >>
2972 to have the SQL produced include a C<DROP TABLE> statement for each table
2973 created. For quoting purposes supply C<quote_identifiers>.
2975 If no arguments are passed, then the following default values are assumed:
2979 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2981 =item version - $schema->schema_version
2983 =item directory - './'
2985 =item preversion - <none>
2989 By default, C<\%sqlt_args> will have
2991 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2993 merged with the hash passed in. To disable any of those features, pass in a
2994 hashref like the following
2996 { ignore_constraint_names => 0, # ... other options }
2999 WARNING: You are strongly advised to check all SQL files created, before applying
3004 sub create_ddl_dir {
3005 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
3007 require DBIx::Class::Optional::Dependencies;
3008 if (my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('deploy')) {
3009 $self->throw_exception("Can't create a ddl file without $missing");
3013 carp "No directory given, using ./\n";
3017 mkdir_p( $dir ) unless -d $dir;
3020 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
3021 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
3023 my $schema_version = $schema->schema_version || '1.x';
3024 $version ||= $schema_version;
3027 add_drop_table => 1,
3028 ignore_constraint_names => 1,
3029 ignore_index_names => 1,
3030 quote_identifiers => $self->sql_maker->_quoting_enabled,
3034 my $sqlt = SQL::Translator->new( $sqltargs );
3036 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
3037 my $sqlt_schema = $sqlt->translate({ data => $schema })
3038 or $self->throw_exception ($sqlt->error);
3040 foreach my $db (@$databases) {
3042 $sqlt->{schema} = $sqlt_schema;
3043 $sqlt->producer($db);
3046 my $filename = $schema->ddl_filename($db, $version, $dir);
3047 if (-e $filename && ($version eq $schema_version )) {
3048 # if we are dumping the current version, overwrite the DDL
3049 carp "Overwriting existing DDL file - $filename";
3053 my $output = $sqlt->translate;
3055 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
3058 if(!open($file, ">$filename")) {
3059 $self->throw_exception("Can't open $filename for writing ($!)");
3062 print $file $output;
3065 next unless ($preversion);
3067 require SQL::Translator::Diff;
3069 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
3070 if(!-e $prefilename) {
3071 carp("No previous schema file found ($prefilename)");
3075 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
3077 carp("Overwriting existing diff file - $difffile");
3083 my $t = SQL::Translator->new($sqltargs);
3088 or $self->throw_exception ($t->error);
3090 my $out = $t->translate( $prefilename )
3091 or $self->throw_exception ($t->error);
3093 $source_schema = $t->schema;
3095 $source_schema->name( $prefilename )
3096 unless ( $source_schema->name );
3099 # The "new" style of producers have sane normalization and can support
3100 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
3101 # And we have to diff parsed SQL against parsed SQL.
3102 my $dest_schema = $sqlt_schema;
3104 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
3105 my $t = SQL::Translator->new($sqltargs);
3110 or $self->throw_exception ($t->error);
3112 my $out = $t->translate( $filename )
3113 or $self->throw_exception ($t->error);
3115 $dest_schema = $t->schema;
3117 $dest_schema->name( $filename )
3118 unless $dest_schema->name;
3122 # FIXME - this is a terrible workaround for
3123 # https://github.com/dbsrgits/sql-translator/commit/2d23c1e
3124 # Fixing it in this sloppy manner so that we don't hve to
3125 # lockstep an SQLT release as well. Needs to be removed at
3126 # some point, and SQLT dep bumped
3127 local $SQL::Translator::Producer::SQLite::NO_QUOTES
3128 if $SQL::Translator::Producer::SQLite::NO_QUOTES;
3130 SQL::Translator::Diff::schema_diff($source_schema, $db,
3136 if(!open $file, ">$difffile") {
3137 $self->throw_exception("Can't write to $difffile ($!)");
3145 =head2 deployment_statements
3149 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
3153 Returns the statements used by L<DBIx::Class::Storage/deploy>
3154 and L<DBIx::Class::Schema/deploy>.
3156 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
3157 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
3159 C<$directory> is used to return statements from files in a previously created
3160 L</create_ddl_dir> directory and is optional. The filenames are constructed
3161 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
3163 If no C<$directory> is specified then the statements are constructed on the
3164 fly using L<SQL::Translator> and C<$version> is ignored.
3166 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
3170 sub deployment_statements {
3171 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
3173 $self->throw_exception(
3174 'Calling deployment_statements() in void context makes no sense'
3175 ) unless defined wantarray;
3177 $type ||= $self->sqlt_type;
3178 $version ||= $schema->schema_version || '1.x';
3180 my $filename = $schema->ddl_filename($type, $version, $dir);
3183 # FIXME replace this block when a proper sane sql parser is available
3185 open($file, "<$filename")
3186 or $self->throw_exception("Can't open $filename ($!)");
3189 return join('', @rows);
3192 require DBIx::Class::Optional::Dependencies;
3193 if (my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') ) {
3194 $self->throw_exception("Can't deploy without a pregenerated 'ddl_dir' directory or $missing");
3197 # sources needs to be a parser arg, but for simplicity allow at top level
3199 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
3200 if exists $sqltargs->{sources};
3202 $sqltargs->{quote_identifiers} = $self->sql_maker->_quoting_enabled
3203 unless exists $sqltargs->{quote_identifiers};
3205 my $tr = SQL::Translator->new(
3206 producer => "SQL::Translator::Producer::${type}",
3208 parser => 'SQL::Translator::Parser::DBIx::Class',
3212 return preserve_context {
3215 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
3216 unless defined $_[0];
3220 # FIXME deploy() currently does not accurately report sql errors
3221 # Will always return true while errors are warned
3223 my ($self, $schema, $type, $sqltargs, $dir) = @_;
3227 return if($line =~ /^--/);
3228 # next if($line =~ /^DROP/m);
3229 return if($line =~ /^BEGIN TRANSACTION/m);
3230 return if($line =~ /^COMMIT/m);
3231 return if $line =~ /^\s+$/; # skip whitespace only
3232 $self->_query_start($line);
3234 # do a dbh_do cycle here, as we need some error checking in
3235 # place (even though we will ignore errors)
3236 $self->dbh_do (sub { $_[1]->do($line) });
3237 } dbic_internal_catch {
3238 carp qq{$_ (running "${line}")};
3240 $self->_query_end($line);
3242 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
3243 if (@statements > 1) {
3244 foreach my $statement (@statements) {
3245 $deploy->( $statement );
3248 elsif (@statements == 1) {
3249 # split on single line comments and end of statements
3250 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3256 =head2 datetime_parser
3258 Returns the datetime parser class
3262 sub datetime_parser {
3264 return $self->{datetime_parser} ||= do {
3265 $self->build_datetime_parser(@_);
3269 =head2 datetime_parser_type
3271 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3273 =head2 build_datetime_parser
3275 See L</datetime_parser>
3279 sub build_datetime_parser {
3281 my $type = $self->datetime_parser_type(@_);
3286 =head2 is_replicating
3288 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3289 replicate from a master database. Default is undef, which is the result
3290 returned by databases that don't support replication.
3294 sub is_replicating {
3299 =head2 lag_behind_master
3301 Returns a number that represents a certain amount of lag behind a master db
3302 when a given storage is replicating. The number is database dependent, but
3303 starts at zero and increases with the amount of lag. Default in undef
3307 sub lag_behind_master {
3311 =head2 relname_to_table_alias
3315 =item Arguments: $relname, $join_count
3317 =item Return Value: $alias
3321 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3324 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3325 way these aliases are named.
3327 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3328 otherwise C<"$relname">.
3332 sub relname_to_table_alias {
3333 my ($self, $relname, $join_count) = @_;
3335 my $alias = ($join_count && $join_count > 1 ?
3336 join('_', $relname, $join_count) : $relname);
3341 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3342 # version and it may be necessary to amend or override it for a specific storage
3343 # if such binds are necessary.
3344 sub _max_column_bytesize {
3345 my ($self, $attr) = @_;
3349 if ($attr->{sqlt_datatype}) {
3350 my $data_type = lc($attr->{sqlt_datatype});
3352 if ($attr->{sqlt_size}) {
3354 # String/sized-binary types
3355 if ($data_type =~ /^(?:
3356 l? (?:var)? char(?:acter)? (?:\s*varying)?
3358 (?:var)? binary (?:\s*varying)?
3363 $max_size = $attr->{sqlt_size};
3365 # Other charset/unicode types, assume scale of 4
3366 elsif ($data_type =~ /^(?:
3367 national \s* character (?:\s*varying)?
3376 $max_size = $attr->{sqlt_size} * 4;
3380 if (!$max_size and !$self->_is_lob_type($data_type)) {
3381 $max_size = 100 # for all other (numeric?) datatypes
3385 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3388 # Determine if a data_type is some type of BLOB
3390 my ($self, $data_type) = @_;
3391 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3392 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3393 |varchar|character\s*varying|nvarchar
3394 |national\s*character\s*varying))?\z/xi);
3397 sub _is_binary_lob_type {
3398 my ($self, $data_type) = @_;
3399 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3400 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3403 sub _is_text_lob_type {
3404 my ($self, $data_type) = @_;
3405 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3406 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3407 |national\s*character\s*varying))\z/xi);
3410 # Determine if a data_type is some type of a binary type
3411 sub _is_binary_type {
3412 my ($self, $data_type) = @_;
3413 $data_type && ($self->_is_binary_lob_type($data_type)
3414 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3421 =head2 DBIx::Class and AutoCommit
3423 DBIx::Class can do some wonderful magic with handling exceptions,
3424 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3425 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3426 transaction support.
3428 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3429 in an assumed transaction between commits, and you're telling us you'd
3430 like to manage that manually. A lot of the magic protections offered by
3431 this module will go away. We can't protect you from exceptions due to database
3432 disconnects because we don't know anything about how to restart your
3433 transactions. You're on your own for handling all sorts of exceptional
3434 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3437 =head1 FURTHER QUESTIONS?
3439 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
3441 =head1 COPYRIGHT AND LICENSE
3443 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
3444 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
3445 redistribute it and/or modify it under the same terms as the
3446 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.