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(
111 with_deferred_fk_checks
113 get_use_dbms_capability
120 my $orig = __PACKAGE__->can ($meth)
121 or die "$meth is not a ::Storage::DBI method!";
123 my $is_getter = $storage_accessor_idx->{$meth} ? 0 : 1;
126 __PACKAGE__ ."::$meth", sprintf( <<'EOC', $is_getter, perlstring $meth ), { '$orig' => \$orig };
129 # only fire when invoked on an instance, a valid class-based invocation
130 # would e.g. be setting a default for an inherited accessor
133 ! $_[0]->{_driver_determined}
135 ! $_[0]->{_in_determine_driver}
137 # if this is a known *setter* - just set it, no need to connect
138 # and determine the driver
141 # Only try to determine stuff if we have *something* that either is or can
142 # provide a DSN. Allows for bare $schema's generated with a plain ->connect()
143 # to still be marginally useful
144 $_[0]->_dbi_connect_info->[0]
146 $_[0]->_determine_driver;
148 # work around http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
149 goto $_[0]->can(%2$s) unless DBIx::Class::_ENV_::BROKEN_GOTO;
151 my $cref = $_[0]->can(%2$s);
161 DBIx::Class::Storage::DBI - DBI storage handler
165 my $schema = MySchema->connect('dbi:SQLite:my.db');
167 $schema->storage->debug(1);
169 my @stuff = $schema->storage->dbh_do(
171 my ($storage, $dbh, @args) = @_;
172 $dbh->do("DROP TABLE authors");
177 $schema->resultset('Book')->search({
178 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
183 This class represents the connection to an RDBMS via L<DBI>. See
184 L<DBIx::Class::Storage> for general information. This pod only
185 documents DBI-specific methods and behaviors.
192 my $new = shift->next::method(@_);
194 $new->_sql_maker_opts({});
195 $new->_dbh_details({});
196 $new->{_in_do_block} = 0;
198 # read below to see what this does
199 $new->_arm_global_destructor;
204 # This is hack to work around perl shooting stuff in random
205 # order on exit(). If we do not walk the remaining storage
206 # objects in an END block, there is a *small but real* chance
207 # of a fork()ed child to kill the parent's shared DBI handle,
208 # *before perl reaches the DESTROY in this package*
209 # Yes, it is ugly and effective.
210 # Additionally this registry is used by the CLONE method to
211 # make sure no handles are shared between threads
213 my %seek_and_destroy;
215 sub _arm_global_destructor {
217 # quick "garbage collection" pass - prevents the registry
218 # from slowly growing with a bunch of undef-valued keys
219 defined $seek_and_destroy{$_} or delete $seek_and_destroy{$_}
220 for keys %seek_and_destroy;
223 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
228 local $?; # just in case the DBI destructor changes it somehow
230 # destroy just the object if not native to this process
231 $_->_verify_pid for (grep
233 values %seek_and_destroy
238 # As per DBI's recommendation, DBIC disconnects all handles as
239 # soon as possible (DBIC will reconnect only on demand from within
241 my @instances = grep { defined $_ } values %seek_and_destroy;
242 %seek_and_destroy = ();
247 $_->transaction_depth(0);
250 # properly renumber existing refs
251 $_->_arm_global_destructor
259 # some databases spew warnings on implicit disconnect
260 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
261 local $SIG{__WARN__} = sub {};
264 # this op is necessary, since the very last perl runtime statement
265 # triggers a global destruction shootout, and the $SIG localization
266 # may very well be destroyed before perl actually gets to do the
271 # handle pid changes correctly - do not destroy parent's connection
275 my $pid = $self->_conn_pid;
276 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
277 $dbh->{InactiveDestroy} = 1;
279 $self->transaction_depth(0);
280 $self->savepoints([]);
288 This method is normally called by L<DBIx::Class::Schema/connection>, which
289 encapsulates its argument list in an arrayref before passing them here.
291 The argument list may contain:
297 The same 4-element argument set one would normally pass to
298 L<DBI/connect>, optionally followed by
299 L<extra attributes|/DBIx::Class specific connection attributes>
300 recognized by DBIx::Class:
302 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
306 A single code reference which returns a connected
307 L<DBI database handle|DBI/connect> optionally followed by
308 L<extra attributes|/DBIx::Class specific connection attributes> recognized
311 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
315 A single hashref with all the attributes and the dsn/user/password
318 $connect_info_args = [{
326 $connect_info_args = [{
327 dbh_maker => sub { DBI->connect (...) },
332 This is particularly useful for L<Catalyst> based applications, allowing the
333 following config (L<Config::General> style):
338 dsn dbi:mysql:database=test
345 The C<dsn>/C<user>/C<password> combination can be substituted by the
346 C<dbh_maker> key whose value is a coderef that returns a connected
347 L<DBI database handle|DBI/connect>
351 Please note that the L<DBI> docs recommend that you always explicitly
352 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
353 recommends that it be set to I<1>, and that you perform transactions
354 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
355 to I<1> if you do not do explicitly set it to zero. This is the default
356 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
358 =head3 DBIx::Class specific connection attributes
360 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
361 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
362 the following connection options. These options can be mixed in with your other
363 L<DBI> connection attributes, or placed in a separate hashref
364 (C<\%extra_attributes>) as shown above.
366 Every time C<connect_info> is invoked, any previous settings for
367 these options will be cleared before setting the new ones, regardless of
368 whether any options are specified in the new C<connect_info>.
375 Specifies things to do immediately after connecting or re-connecting to
376 the database. Its value may contain:
382 This contains one SQL statement to execute.
384 =item an array reference
386 This contains SQL statements to execute in order. Each element contains
387 a string or a code reference that returns a string.
389 =item a code reference
391 This contains some code to execute. Unlike code references within an
392 array reference, its return value is ignored.
396 =item on_disconnect_do
398 Takes arguments in the same form as L</on_connect_do> and executes them
399 immediately before disconnecting from the database.
401 Note, this only runs if you explicitly call L</disconnect> on the
404 =item on_connect_call
406 A more generalized form of L</on_connect_do> that calls the specified
407 C<connect_call_METHOD> methods in your storage driver.
409 on_connect_do => 'select 1'
413 on_connect_call => [ [ do_sql => 'select 1' ] ]
415 Its values may contain:
421 Will call the C<connect_call_METHOD> method.
423 =item a code reference
425 Will execute C<< $code->($storage) >>
427 =item an array reference
429 Each value can be a method name or code reference.
431 =item an array of arrays
433 For each array, the first item is taken to be the C<connect_call_> method name
434 or code reference, and the rest are parameters to it.
438 Some predefined storage methods you may use:
444 Executes a SQL string or a code reference that returns a SQL string. This is
445 what L</on_connect_do> and L</on_disconnect_do> use.
453 Will execute the scalar as SQL.
457 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
458 attributes hashref and bind values.
460 =item a code reference
462 Will execute C<< $code->($storage) >> and execute the return array refs as
469 Execute any statements necessary to initialize the database session to return
470 and accept datetime/timestamp values used with
471 L<DBIx::Class::InflateColumn::DateTime>.
473 Only necessary for some databases, see your specific storage driver for
474 implementation details.
478 =item on_disconnect_call
480 Takes arguments in the same form as L</on_connect_call> and executes them
481 immediately before disconnecting from the database.
483 Calls the C<disconnect_call_METHOD> methods as opposed to the
484 C<connect_call_METHOD> methods called by L</on_connect_call>.
486 Note, this only runs if you explicitly call L</disconnect> on the
489 =item disable_sth_caching
491 If set to a true value, this option will disable the caching of
492 statement handles via L<DBI/prepare_cached>.
496 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
497 default L</sql_limit_dialect> setting of the storage (if any). For a list
498 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
502 When true automatically sets L</quote_char> and L</name_sep> to the characters
503 appropriate for your particular RDBMS. This option is preferred over specifying
504 L</quote_char> directly.
508 Specifies what characters to use to quote table and column names.
510 C<quote_char> expects either a single character, in which case is it
511 is placed on either side of the table/column name, or an arrayref of length
512 2 in which case the table/column name is placed between the elements.
514 For example under MySQL you should use C<< quote_char => '`' >>, and for
515 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
519 This parameter is only useful in conjunction with C<quote_char>, and is used to
520 specify the character that separates elements (schemas, tables, columns) from
521 each other. If unspecified it defaults to the most commonly used C<.>.
525 This Storage driver normally installs its own C<HandleError>, sets
526 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
527 all database handles, including those supplied by a coderef. It does this
528 so that it can have consistent and useful error behavior.
530 If you set this option to a true value, Storage will not do its usual
531 modifications to the database handle's attributes, and instead relies on
532 the settings in your connect_info DBI options (or the values you set in
533 your connection coderef, in the case that you are connecting via coderef).
535 Note that your custom settings can cause Storage to malfunction,
536 especially if you set a C<HandleError> handler that suppresses exceptions
537 and/or disable C<RaiseError>.
541 If this option is true, L<DBIx::Class> will use savepoints when nesting
542 transactions, making it possible to recover from failure in the inner
543 transaction without having to abort all outer transactions.
547 Use this argument to supply a cursor class other than the default
548 L<DBIx::Class::Storage::DBI::Cursor>.
552 Some real-life examples of arguments to L</connect_info> and
553 L<DBIx::Class::Schema/connect>
555 # Simple SQLite connection
556 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
559 ->connect_info([ sub { DBI->connect(...) } ]);
561 # Connect via subref in hashref
563 dbh_maker => sub { DBI->connect(...) },
564 on_connect_do => 'alter session ...',
567 # A bit more complicated
574 { quote_char => q{"} },
578 # Equivalent to the previous example
584 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
588 # Same, but with hashref as argument
589 # See parse_connect_info for explanation
592 dsn => 'dbi:Pg:dbname=foo',
594 password => 'my_pg_password',
601 # Subref + DBIx::Class-specific connection options
604 sub { DBI->connect(...) },
608 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
609 disable_sth_caching => 1,
619 my ($self, $info) = @_;
621 return $self->_connect_info if !$info;
623 $self->_connect_info($info); # copy for _connect_info
625 $info = $self->_normalize_connect_info($info)
626 if ref $info eq 'ARRAY';
629 %{ $self->_default_dbi_connect_attributes || {} },
630 %{ $info->{attributes} || {} },
633 my @args = @{ $info->{arguments} };
635 if (keys %attrs and ref $args[0] ne 'CODE') {
637 'You provided explicit AutoCommit => 0 in your connection_info. '
638 . 'This is almost universally a bad idea (see the footnotes of '
639 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
640 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
642 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
644 push @args, \%attrs if keys %attrs;
647 # this is the authoritative "always an arrayref" thing fed to DBI->connect
648 # OR a single-element coderef-based $dbh factory
649 $self->_dbi_connect_info(\@args);
651 # extract the individual storage options
652 for my $storage_opt (keys %{ $info->{storage_options} }) {
653 my $value = $info->{storage_options}{$storage_opt};
655 $self->$storage_opt($value);
658 # Extract the individual sqlmaker options
660 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
661 # the new set of options
662 $self->_sql_maker(undef);
663 $self->_sql_maker_opts({});
665 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
666 my $value = $info->{sql_maker_options}{$sql_maker_opt};
668 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
672 # save attributes in a separate accessor so they are always
673 # introspectable, even in case of a CODE $dbhmaker
674 $self->_dbic_connect_attributes (\%attrs);
676 return $self->_connect_info;
679 sub _dbi_connect_info {
682 return $self->{_dbi_connect_info} = $_[0]
685 my $conninfo = $self->{_dbi_connect_info} || [];
687 # last ditch effort to grab a DSN
688 if ( ! defined $conninfo->[0] and $ENV{DBI_DSN} ) {
689 my @new_conninfo = @$conninfo;
690 $new_conninfo[0] = $ENV{DBI_DSN};
691 $conninfo = \@new_conninfo;
698 sub _normalize_connect_info {
699 my ($self, $info_arg) = @_;
702 my @args = @$info_arg; # take a shallow copy for further mutilation
704 # combine/pre-parse arguments depending on invocation style
707 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
708 %attrs = %{ $args[1] || {} };
711 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
712 %attrs = %{$args[0]};
714 if (my $code = delete $attrs{dbh_maker}) {
717 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
720 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
721 . "to the result of 'dbh_maker'",
723 join (', ', map { "'$_'" } (@ignored) ),
728 @args = delete @attrs{qw/dsn user password/};
731 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
733 % { $args[3] || {} },
734 % { $args[4] || {} },
736 @args = @args[0,1,2];
739 $info{arguments} = \@args;
741 my @storage_opts = grep exists $attrs{$_},
742 @storage_options, 'cursor_class';
744 @{ $info{storage_options} }{@storage_opts} =
745 delete @attrs{@storage_opts} if @storage_opts;
747 my @sql_maker_opts = grep exists $attrs{$_},
748 qw/limit_dialect quote_char name_sep quote_names/;
750 @{ $info{sql_maker_options} }{@sql_maker_opts} =
751 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
753 $info{attributes} = \%attrs if %attrs;
758 sub _default_dbi_connect_attributes () {
763 ShowErrorStatement => 1,
769 This method is deprecated in favour of setting via L</connect_info>.
773 =head2 on_disconnect_do
775 This method is deprecated in favour of setting via L</connect_info>.
779 sub _parse_connect_do {
780 my ($self, $type) = @_;
782 my $val = $self->$type;
783 return () if not defined $val;
788 push @res, [ 'do_sql', $val ];
789 } elsif (ref($val) eq 'CODE') {
791 } elsif (ref($val) eq 'ARRAY') {
792 push @res, map { [ 'do_sql', $_ ] } @$val;
794 $self->throw_exception("Invalid type for $type: ".ref($val));
802 Arguments: ($subref | $method_name), @extra_coderef_args?
804 Execute the given $subref or $method_name using the new exception-based
805 connection management.
807 The first two arguments will be the storage object that C<dbh_do> was called
808 on and a database handle to use. Any additional arguments will be passed
809 verbatim to the called subref as arguments 2 and onwards.
811 Using this (instead of $self->_dbh or $self->dbh) ensures correct
812 exception handling and reconnection (or failover in future subclasses).
814 Your subref should have no side-effects outside of the database, as
815 there is the potential for your subref to be partially double-executed
816 if the database connection was stale/dysfunctional.
820 my @stuff = $schema->storage->dbh_do(
822 my ($storage, $dbh, @cols) = @_;
823 my $cols = join(q{, }, @cols);
824 $dbh->selectrow_array("SELECT $cols FROM foo");
833 my $run_target = shift; # either a coderef or a method name
835 # short circuit when we know there is no need for a runner
837 # FIXME - assumption may be wrong
838 # the rationale for the txn_depth check is that if this block is a part
839 # of a larger transaction, everything up to that point is screwed anyway
840 return $self->$run_target($self->_get_dbh, @_)
841 if $self->{_in_do_block} or $self->transaction_depth;
843 # take a ref instead of a copy, to preserve @_ aliasing
844 # semantics within the coderef, but only if needed
845 # (pseudoforking doesn't like this trick much)
846 my $args = @_ ? \@_ : [];
848 DBIx::Class::Storage::BlockRunner->new(
851 retry_handler => sub {
852 $_[0]->failed_attempt_count == 1
854 ! $_[0]->storage->connected
857 $self->$run_target ($self->_get_dbh, @$args )
862 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
863 shift->next::method(@_);
868 Our C<disconnect> method also performs a rollback first if the
869 database is not in C<AutoCommit> mode.
879 push @actions, ( $self->on_disconnect_call || () );
880 push @actions, $self->_parse_connect_do ('on_disconnect_do');
882 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
884 # stops the "implicit rollback on disconnect" warning
885 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
887 %{ $self->_dbh->{CachedKids} } = ();
888 $self->_dbh->disconnect;
893 =head2 with_deferred_fk_checks
897 =item Arguments: C<$coderef>
899 =item Return Value: The return value of $coderef
903 Storage specific method to run the code ref with FK checks deferred or
904 in MySQL's case disabled entirely.
908 # Storage subclasses should override this
909 sub with_deferred_fk_checks {
910 my ($self, $sub) = @_;
918 =item Arguments: none
920 =item Return Value: 1|0
924 Verifies that the current database handle is active and ready to execute
925 an SQL statement (e.g. the connection did not get stale, server is still
926 answering, etc.) This method is used internally by L</dbh>.
932 return 0 unless $self->_seems_connected;
935 local $self->_dbh->{RaiseError} = 1;
940 sub _seems_connected {
943 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
945 my $dbh = $self->_dbh
948 return $dbh->FETCH('Active');
954 my $dbh = $self->_dbh or return 0;
959 sub ensure_connected {
962 unless ($self->connected) {
963 $self->_populate_dbh;
969 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
970 is guaranteed to be healthy by implicitly calling L</connected>, and if
971 necessary performing a reconnection before returning. Keep in mind that this
972 is very B<expensive> on some database engines. Consider using L</dbh_do>
980 if (not $self->_dbh) {
981 $self->_populate_dbh;
983 $self->ensure_connected;
988 # this is the internal "get dbh or connect (don't check)" method
991 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
992 $self->_populate_dbh unless $self->_dbh;
996 # *DELIBERATELY* not a setter (for the time being)
997 # Too intertwined with everything else for any kind of sanity
1001 $self->throw_exception('sql_maker() is not a setter method') if @_;
1003 unless ($self->_sql_maker) {
1004 my $sql_maker_class = $self->sql_maker_class;
1006 my %opts = %{$self->_sql_maker_opts||{}};
1008 $opts{limit_dialect}
1010 $self->sql_limit_dialect
1013 my $s_class = (ref $self) || $self;
1015 "Your storage class ($s_class) does not set sql_limit_dialect and you "
1016 . 'have not supplied an explicit limit_dialect in your connection_info. '
1017 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
1018 . 'databases but can be (and often is) painfully slow. '
1019 . "Please file an RT ticket against '$s_class'"
1020 ) if $self->_dbi_connect_info->[0];
1026 my ($quote_char, $name_sep);
1028 if ($opts{quote_names}) {
1029 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1030 my $s_class = (ref $self) || $self;
1032 "You requested 'quote_names' but your storage class ($s_class) does "
1033 . 'not explicitly define a default sql_quote_char and you have not '
1034 . 'supplied a quote_char as part of your connection_info. DBIC will '
1035 .q{default to the ANSI SQL standard quote '"', which works most of }
1036 . "the time. Please file an RT ticket against '$s_class'."
1042 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1045 $self->_sql_maker($sql_maker_class->new(
1046 bindtype=>'columns',
1047 array_datatypes => 1,
1048 limit_dialect => $dialect,
1049 ($quote_char ? (quote_char => $quote_char) : ()),
1050 name_sep => ($name_sep || '.'),
1054 return $self->_sql_maker;
1057 # nothing to do by default
1064 $self->_dbh(undef); # in case ->connected failed we might get sent here
1065 $self->_dbh_details({}); # reset everything we know
1066 $self->_sql_maker(undef); # this may also end up being different
1068 $self->_dbh($self->_connect);
1070 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1072 $self->_determine_driver;
1074 # Always set the transaction depth on connect, since
1075 # there is no transaction in progress by definition
1076 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1078 $self->_run_connection_actions unless $self->{_in_determine_driver};
1081 sub _run_connection_actions {
1085 push @actions, ( $self->on_connect_call || () );
1086 push @actions, $self->_parse_connect_do ('on_connect_do');
1088 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1093 sub set_use_dbms_capability {
1094 $_[0]->set_inherited ($_[1], $_[2]);
1097 sub get_use_dbms_capability {
1098 my ($self, $capname) = @_;
1100 my $use = $self->get_inherited ($capname);
1103 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1107 sub set_dbms_capability {
1108 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1111 sub get_dbms_capability {
1112 my ($self, $capname) = @_;
1114 my $cap = $self->_dbh_details->{capability}{$capname};
1116 unless (defined $cap) {
1117 if (my $meth = $self->can ("_determine$capname")) {
1118 $cap = $self->$meth ? 1 : 0;
1124 $self->set_dbms_capability ($capname, $cap);
1134 unless ($info = $self->_dbh_details->{info}) {
1138 my $server_version = try {
1139 $self->_get_server_version
1141 # driver determination *may* use this codepath
1142 # in which case we must rethrow
1143 $self->throw_exception($_) if $self->{_in_determine_driver};
1145 # $server_version on failure
1149 if (defined $server_version) {
1150 $info->{dbms_version} = $server_version;
1152 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1153 my @verparts = split (/\./, $numeric_version);
1159 # consider only up to 3 version parts, iff not more than 3 digits
1161 while (@verparts && @use_parts < 3) {
1162 my $p = shift @verparts;
1164 push @use_parts, $p;
1166 push @use_parts, 0 while @use_parts < 3;
1168 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1172 $self->_dbh_details->{info} = $info;
1178 sub _get_server_version {
1179 shift->_dbh_get_info('SQL_DBMS_VER');
1183 my ($self, $info) = @_;
1185 if ($info =~ /[^0-9]/) {
1186 require DBI::Const::GetInfoType;
1187 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1188 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1189 unless defined $info;
1192 $self->_get_dbh->get_info($info);
1195 sub _describe_connection {
1196 require DBI::Const::GetInfoReturn;
1202 $drv = $self->_extract_driver_from_connect_info;
1203 $self->ensure_connected;
1206 $drv = "DBD::$drv" if $drv;
1209 DBIC_DSN => $self->_dbi_connect_info->[0],
1210 DBI_VER => DBI->VERSION,
1211 DBIC_VER => DBIx::Class->VERSION,
1212 DBIC_DRIVER => ref $self,
1215 DBD_VER => try { $drv->VERSION },
1219 # try to grab data even if we never managed to connect
1220 # will cover us in cases of an oddly broken half-connect
1222 #keys %DBI::Const::GetInfoType::GetInfoType,
1224 SQL_CURSOR_COMMIT_BEHAVIOR
1225 SQL_CURSOR_ROLLBACK_BEHAVIOR
1226 SQL_CURSOR_SENSITIVITY
1227 SQL_DATA_SOURCE_NAME
1230 SQL_DEFAULT_TXN_ISOLATION
1235 SQL_EXPRESSIONS_IN_ORDERBY
1238 SQL_IDENTIFIER_QUOTE_CHAR
1239 SQL_MAX_CATALOG_NAME_LEN
1240 SQL_MAX_COLUMN_NAME_LEN
1241 SQL_MAX_IDENTIFIER_LEN
1242 SQL_MAX_TABLE_NAME_LEN
1243 SQL_MULTIPLE_ACTIVE_TXN
1244 SQL_MULT_RESULT_SETS
1245 SQL_NEED_LONG_DATA_LEN
1246 SQL_NON_NULLABLE_COLUMNS
1248 SQL_QUALIFIER_NAME_SEPARATOR
1249 SQL_QUOTED_IDENTIFIER_CASE
1251 SQL_TXN_ISOLATION_OPTION
1254 # some drivers barf on things they do not know about instead
1255 # of returning undef
1256 my $v = try { $self->_dbh_get_info($inf) };
1257 next unless defined $v;
1259 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1260 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1261 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1267 sub _determine_driver {
1270 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1271 my $started_connected = 0;
1272 local $self->{_in_determine_driver} = 1;
1274 if (ref($self) eq __PACKAGE__) {
1276 if ($self->_dbh) { # we are connected
1277 $driver = $self->_dbh->{Driver}{Name};
1278 $started_connected = 1;
1281 $driver = $self->_extract_driver_from_connect_info;
1285 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1286 if ($self->load_optional_class($storage_class)) {
1287 mro::set_mro($storage_class, 'c3');
1288 bless $self, $storage_class;
1292 $self->_warn_undetermined_driver(
1293 'This version of DBIC does not yet seem to supply a driver for '
1294 . "your particular RDBMS and/or connection method ('$driver')."
1299 $self->_warn_undetermined_driver(
1300 'Unable to extract a driver name from connect info - this '
1301 . 'should not have happened.'
1306 $self->_driver_determined(1);
1308 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1310 if ($self->can('source_bind_attributes')) {
1311 $self->throw_exception(
1312 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1313 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1314 . 'If you are not sure how to proceed please contact the development team via '
1315 . DBIx::Class::_ENV_::HELP_URL
1319 $self->_init; # run driver-specific initializations
1321 $self->_run_connection_actions
1322 if !$started_connected && defined $self->_dbh;
1326 sub _extract_driver_from_connect_info {
1331 # if connect_info is a CODEREF, we have no choice but to connect
1333 ref $self->_dbi_connect_info->[0]
1335 reftype $self->_dbi_connect_info->[0] eq 'CODE'
1337 $self->_populate_dbh;
1338 $drv = $self->_dbh->{Driver}{Name};
1341 # try to use dsn to not require being connected, the driver may still
1342 # force a connection later in _rebless to determine version
1343 # (dsn may not be supplied at all if all we do is make a mock-schema)
1344 ($drv) = ($self->_dbi_connect_info->[0] || '') =~ /^dbi:([^:]+):/i;
1345 $drv ||= $ENV{DBI_DRIVER};
1351 sub _determine_connector_driver {
1352 my ($self, $conn) = @_;
1354 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1357 $self->_warn_undetermined_driver(
1358 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1359 . "$conn connector - this should not have happened."
1364 $dbtype =~ s/\W/_/gi;
1366 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1367 return if $self->isa($subclass);
1369 if ($self->load_optional_class($subclass)) {
1370 bless $self, $subclass;
1374 $self->_warn_undetermined_driver(
1375 'This version of DBIC does not yet seem to supply a driver for '
1376 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1381 sub _warn_undetermined_driver {
1382 my ($self, $msg) = @_;
1384 require Data::Dumper::Concise;
1386 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1387 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1388 . "does not go away, file a bugreport including the following info:\n"
1389 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1393 sub _do_connection_actions {
1395 my $method_prefix = shift;
1398 if (not ref($call)) {
1399 my $method = $method_prefix . $call;
1401 } elsif (ref($call) eq 'CODE') {
1403 } elsif (ref($call) eq 'ARRAY') {
1404 if (ref($call->[0]) ne 'ARRAY') {
1405 $self->_do_connection_actions($method_prefix, $_) for @$call;
1407 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1410 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1416 sub connect_call_do_sql {
1418 $self->_do_query(@_);
1421 sub disconnect_call_do_sql {
1423 $self->_do_query(@_);
1426 # override in db-specific backend when necessary
1427 sub connect_call_datetime_setup { 1 }
1430 my ($self, $action) = @_;
1432 if (ref $action eq 'CODE') {
1433 $action = $action->($self);
1434 $self->_do_query($_) foreach @$action;
1437 # Most debuggers expect ($sql, @bind), so we need to exclude
1438 # the attribute hash which is the second argument to $dbh->do
1439 # furthermore the bind values are usually to be presented
1440 # as named arrayref pairs, so wrap those here too
1441 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1442 my $sql = shift @do_args;
1443 my $attrs = shift @do_args;
1444 my @bind = map { [ undef, $_ ] } @do_args;
1447 $_[0]->_query_start($sql, \@bind);
1448 $_[1]->do($sql, $attrs, @do_args);
1449 $_[0]->_query_end($sql, \@bind);
1459 my $info = $self->_dbi_connect_info;
1461 $self->throw_exception("You did not provide any connection_info")
1462 unless defined $info->[0];
1464 my ($old_connect_via, $dbh);
1466 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1468 # this odd anonymous coderef dereference is in fact really
1469 # necessary to avoid the unwanted effect described in perl5
1472 # in addition the coderef itself can't reside inside the try{} block below
1473 # as it somehow triggers a leak under perl -d
1474 my $dbh_error_handler_installer = sub {
1475 weaken (my $weak_self = $_[0]);
1477 # the coderef is blessed so we can distinguish it from externally
1478 # supplied handles (which must be preserved)
1479 $_[1]->{HandleError} = bless sub {
1481 $weak_self->throw_exception("DBI Exception: $_[0]");
1484 # the handler may be invoked by something totally out of
1486 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1488 }, '__DBIC__DBH__ERROR__HANDLER__';
1492 if(ref $info->[0] eq 'CODE') {
1493 $dbh = $info->[0]->();
1497 $dbh = DBI->connect(@$info);
1500 die $DBI::errstr unless $dbh;
1502 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1503 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1505 ref $info->[0] eq 'CODE'
1506 ? "Connection coderef $info->[0] returned a"
1507 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1508 ) unless $dbh->FETCH('Active');
1510 # sanity checks unless asked otherwise
1511 unless ($self->unsafe) {
1513 $self->throw_exception(
1514 'Refusing clobbering of {HandleError} installed on externally supplied '
1515 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1516 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1518 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1519 # request, or an external handle. Complain and set anyway
1520 unless ($dbh->{RaiseError}) {
1521 carp( ref $info->[0] eq 'CODE'
1523 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1524 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1525 .'attribute has been supplied'
1527 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1528 .'unsafe => 1. Toggling RaiseError back to true'
1531 $dbh->{RaiseError} = 1;
1534 $dbh_error_handler_installer->($self, $dbh);
1538 $self->throw_exception("DBI Connection failed: $_")
1541 $self->_dbh_autocommit($dbh->{AutoCommit});
1548 # this means we have not yet connected and do not know the AC status
1549 # (e.g. coderef $dbh), need a full-fledged connection check
1550 if (! defined $self->_dbh_autocommit) {
1551 $self->ensure_connected;
1553 # Otherwise simply connect or re-connect on pid changes
1558 $self->next::method(@_);
1561 sub _exec_txn_begin {
1564 # if the user is utilizing txn_do - good for him, otherwise we need to
1565 # ensure that the $dbh is healthy on BEGIN.
1566 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1567 # will be replaced by a failure of begin_work itself (which will be
1568 # then retried on reconnect)
1569 if ($self->{_in_do_block}) {
1570 $self->_dbh->begin_work;
1572 $self->dbh_do(sub { $_[1]->begin_work });
1579 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1580 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1583 # esoteric case for folks using external $dbh handles
1584 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1585 carp "Storage transaction_depth 0 does not match "
1586 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1587 $self->transaction_depth(1);
1590 $self->next::method(@_);
1592 # if AutoCommit is disabled txn_depth never goes to 0
1593 # as a new txn is started immediately on commit
1594 $self->transaction_depth(1) if (
1595 !$self->transaction_depth
1597 defined $self->_dbh_autocommit
1599 ! $self->_dbh_autocommit
1603 sub _exec_txn_commit {
1604 shift->_dbh->commit;
1610 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1611 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1614 # esoteric case for folks using external $dbh handles
1615 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1616 carp "Storage transaction_depth 0 does not match "
1617 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1618 $self->transaction_depth(1);
1621 $self->next::method(@_);
1623 # if AutoCommit is disabled txn_depth never goes to 0
1624 # as a new txn is started immediately on commit
1625 $self->transaction_depth(1) if (
1626 !$self->transaction_depth
1628 defined $self->_dbh_autocommit
1630 ! $self->_dbh_autocommit
1634 sub _exec_txn_rollback {
1635 shift->_dbh->rollback;
1638 # generate the DBI-specific stubs, which then fallback to ::Storage proper
1639 quote_sub __PACKAGE__ . "::$_" => sprintf (<<'EOS', $_) for qw(svp_begin svp_release svp_rollback);
1640 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1641 $_[0]->throw_exception('Unable to %s() on a disconnected storage')
1643 shift->next::method(@_);
1646 # This used to be the top-half of _execute. It was split out to make it
1647 # easier to override in NoBindVars without duping the rest. It takes up
1648 # all of _execute's args, and emits $sql, @bind.
1649 sub _prep_for_execute {
1650 #my ($self, $op, $ident, $args) = @_;
1651 return shift->_gen_sql_bind(@_)
1655 my ($self, $op, $ident, $args) = @_;
1657 my ($colinfos, $from);
1658 if ( blessed($ident) ) {
1659 $from = $ident->from;
1660 $colinfos = $ident->columns_info;
1664 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1666 $bind = $self->_resolve_bindattrs(
1667 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1671 ! $ENV{DBIC_DT_SEARCH_OK}
1680 $_->[1]->isa('DateTime')
1683 carp_unique 'DateTime objects passed to search() are not supported '
1684 . 'properly (InflateColumn::DateTime formats and settings are not '
1685 . 'respected.) See "Formatting DateTime objects in queries" in '
1686 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1687 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1690 return( $sql, $bind );
1693 sub _resolve_bindattrs {
1694 my ($self, $ident, $bind, $colinfos) = @_;
1696 my $resolve_bindinfo = sub {
1697 #my $infohash = shift;
1699 $colinfos ||= { %{ $self->_resolve_column_info($ident) } };
1702 if (my $col = $_[0]->{dbic_colname}) {
1703 $ret = { %{$_[0]} };
1705 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1706 if $colinfos->{$col}{data_type};
1708 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1709 if $colinfos->{$col}{size};
1717 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1718 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1719 : (ref $_->[0] eq 'HASH') ? [(
1722 exists $_->[0]{dbd_attrs}
1724 $_->[0]{sqlt_datatype}
1726 : $resolve_bindinfo->($_->[0])
1729 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1730 : [ $resolve_bindinfo->(
1731 { dbic_colname => $_->[0] }
1736 ! exists $resolved->[0]{dbd_attrs}
1738 ! $resolved->[0]{sqlt_datatype}
1740 length ref $resolved->[1]
1742 ! is_plain_value $resolved->[1]
1744 require Data::Dumper;
1745 local $Data::Dumper::Maxdepth = 1;
1746 local $Data::Dumper::Terse = 1;
1747 local $Data::Dumper::Useqq = 1;
1748 local $Data::Dumper::Indent = 0;
1749 local $Data::Dumper::Pad = ' ';
1750 $self->throw_exception(
1751 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1752 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1761 sub _format_for_trace {
1762 #my ($self, $bind) = @_;
1764 ### Turn @bind from something like this:
1765 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1767 ### ( "'1'", "'3'" )
1770 defined( $_ && $_->[1] )
1777 my ( $self, $sql, $bind ) = @_;
1779 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1784 my ( $self, $sql, $bind ) = @_;
1786 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1790 sub _dbi_attrs_for_bind {
1791 my ($self, $ident, $bind) = @_;
1795 for (map { $_->[0] } @$bind) {
1797 if (exists $_->{dbd_attrs}) {
1800 elsif($_->{sqlt_datatype}) {
1801 # cache the result in the dbh_details hash, as it can not change unless
1802 # we connect to something else
1803 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1804 if (not exists $cache->{$_->{sqlt_datatype}}) {
1805 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1807 $cache->{$_->{sqlt_datatype}};
1810 undef; # always push something at this position
1819 my ($self, $op, $ident, @args) = @_;
1821 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1823 # not even a PID check - we do not care about the state of the _dbh.
1824 # All we need is to get the appropriate drivers loaded if they aren't
1825 # already so that the assumption in ad7c50fc26e holds
1826 $self->_populate_dbh unless $self->_dbh;
1828 $self->dbh_do( _dbh_execute => # retry over disconnects
1831 $self->_dbi_attrs_for_bind($ident, $bind),
1836 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1838 $self->_query_start( $sql, $bind );
1840 my $sth = $self->_bind_sth_params(
1841 $self->_prepare_sth($dbh, $sql),
1846 # Can this fail without throwing an exception anyways???
1847 my $rv = $sth->execute();
1848 $self->throw_exception(
1849 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1852 $self->_query_end( $sql, $bind );
1854 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1858 my ($self, $dbh, $sql) = @_;
1860 # 3 is the if_active parameter which avoids active sth re-use
1861 my $sth = $self->disable_sth_caching
1862 ? $dbh->prepare($sql)
1863 : $dbh->prepare_cached($sql, {}, 3);
1865 # XXX You would think RaiseError would make this impossible,
1866 # but apparently that's not true :(
1867 $self->throw_exception(
1870 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1871 .'an exception and/or setting $dbh->errstr',
1873 ? substr($sql, 0, 20) . '...'
1876 'DBD::' . $dbh->{Driver}{Name},
1883 sub _bind_sth_params {
1884 my ($self, $sth, $bind, $bind_attrs) = @_;
1886 for my $i (0 .. $#$bind) {
1887 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1888 $sth->bind_param_inout(
1889 $i + 1, # bind params counts are 1-based
1891 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1896 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
1897 my $v = ( length ref $bind->[$i][1] and is_plain_value $bind->[$i][1] )
1904 # The temp-var is CRUCIAL - DO NOT REMOVE IT, breaks older DBD::SQLite RT#79576
1914 sub _prefetch_autovalues {
1915 my ($self, $source, $colinfo, $to_insert) = @_;
1918 for my $col (keys %$colinfo) {
1920 $colinfo->{$col}{auto_nextval}
1923 ! exists $to_insert->{$col}
1925 is_literal_value($to_insert->{$col})
1928 $values{$col} = $self->_sequence_fetch(
1930 ( $colinfo->{$col}{sequence} ||=
1931 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1941 my ($self, $source, $to_insert) = @_;
1943 my $col_infos = $source->columns_info;
1945 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1947 # fuse the values, but keep a separate list of prefetched_values so that
1948 # they can be fused once again with the final return
1949 $to_insert = { %$to_insert, %$prefetched_values };
1951 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1952 # Investigate what does it take to s/defined/exists/
1953 my %pcols = map { $_ => 1 } $source->primary_columns;
1954 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1955 for my $col ($source->columns) {
1956 if ($col_infos->{$col}{is_auto_increment}) {
1957 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1958 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1961 # nothing to retrieve when explicit values are supplied
1963 defined $to_insert->{$col} and ! is_literal_value($to_insert->{$col})
1966 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1967 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1970 $col_infos->{$col}{retrieve_on_insert}
1974 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1975 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1977 my ($sqla_opts, @ir_container);
1978 if (%retrieve_cols and $self->_use_insert_returning) {
1979 $sqla_opts->{returning_container} = \@ir_container
1980 if $self->_use_insert_returning_bound;
1982 $sqla_opts->{returning} = [
1983 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1987 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1989 my %returned_cols = %$to_insert;
1990 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1991 @ir_container = try {
1992 local $SIG{__WARN__} = sub {};
1993 my @r = $sth->fetchrow_array;
1996 } unless @ir_container;
1998 @returned_cols{@$retlist} = @ir_container if @ir_container;
2001 # pull in PK if needed and then everything else
2002 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
2004 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
2005 unless $self->can('last_insert_id');
2007 my @pri_values = $self->last_insert_id($source, @missing_pri);
2009 $self->throw_exception( "Can't get last insert id" )
2010 unless (@pri_values == @missing_pri);
2012 @returned_cols{@missing_pri} = @pri_values;
2013 delete @retrieve_cols{@missing_pri};
2016 # if there is more left to pull
2017 if (%retrieve_cols) {
2018 $self->throw_exception(
2019 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
2022 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
2024 my $cur = DBIx::Class::ResultSet->new($source, {
2025 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
2026 select => \@left_to_fetch,
2029 @returned_cols{@left_to_fetch} = $cur->next;
2031 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
2032 if scalar $cur->next;
2036 return { %$prefetched_values, %returned_cols };
2041 'insert_bulk() should have never been exposed as a public method and '
2042 . 'calling it is depecated as of Aug 2014. If you believe having a genuine '
2043 . 'use for this method please contact the development team via '
2044 . DBIx::Class::_ENV_::HELP_URL
2047 return '0E0' unless @{$_[3]||[]};
2049 shift->_insert_bulk(@_);
2053 my ($self, $source, $cols, $data) = @_;
2055 $self->throw_exception('Calling _insert_bulk without a dataset to process makes no sense')
2056 unless @{$data||[]};
2058 my $colinfos = $source->columns_info($cols);
2060 local $self->{_autoinc_supplied_for_op} =
2061 (grep { $_->{is_auto_increment} } values %$colinfos)
2066 # get a slice type index based on first row of data
2067 # a "column" in this context may refer to more than one bind value
2068 # e.g. \[ '?, ?', [...], [...] ]
2070 # construct the value type index - a description of values types for every
2071 # per-column slice of $data:
2073 # nonexistent - nonbind literal
2075 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2077 # also construct the column hash to pass to the SQL generator. For plain
2078 # (non literal) values - convert the members of the first row into a
2079 # literal+bind combo, with extra positional info in the bind attr hashref.
2080 # This will allow us to match the order properly, and is so contrived
2081 # because a user-supplied literal/bind (or something else specific to a
2082 # resultsource and/or storage driver) can inject extra binds along the
2083 # way, so one can't rely on "shift positions" ordering at all. Also we
2084 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2085 # can be later matched up by address), because we want to supply a real
2086 # value on which perhaps e.g. datatype checks will be performed
2087 my ($proto_data, $value_type_by_col_idx);
2088 for my $col_idx (0..$#$cols) {
2089 my $colname = $cols->[$col_idx];
2090 if (ref $data->[0][$col_idx] eq 'SCALAR') {
2091 # no bind value at all - no type
2093 $proto_data->{$colname} = $data->[0][$col_idx];
2095 elsif (ref $data->[0][$col_idx] eq 'REF' and ref ${$data->[0][$col_idx]} eq 'ARRAY' ) {
2096 # repack, so we don't end up mangling the original \[]
2097 my ($sql, @bind) = @${$data->[0][$col_idx]};
2099 # normalization of user supplied stuff
2100 my $resolved_bind = $self->_resolve_bindattrs(
2101 $source, \@bind, $colinfos,
2104 # store value-less (attrs only) bind info - we will be comparing all
2105 # supplied binds against this for sanity
2106 $value_type_by_col_idx->{$col_idx} = [ map { $_->[0] } @$resolved_bind ];
2108 $proto_data->{$colname} = \[ $sql, map { [
2109 # inject slice order to use for $proto_bind construction
2110 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $col_idx, _literal_bind_subindex => $_+1 }
2112 $resolved_bind->[$_][1]
2117 $value_type_by_col_idx->{$col_idx} = undef;
2119 $proto_data->{$colname} = \[ '?', [
2120 { dbic_colname => $colname, _bind_data_slice_idx => $col_idx }
2122 $data->[0][$col_idx]
2127 my ($sql, $proto_bind) = $self->_prep_for_execute (
2133 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2134 # if the bindlist is empty and we had some dynamic binds, this means the
2135 # storage ate them away (e.g. the NoBindVars component) and interpolated
2136 # them directly into the SQL. This obviously can't be good for multi-inserts
2137 $self->throw_exception('Unable to invoke fast-path insert without storage placeholder support');
2141 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2143 # use an error reporting closure for convenience (less to pass)
2144 my $bad_slice_report_cref = sub {
2145 my ($msg, $r_idx, $c_idx) = @_;
2146 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2150 require Data::Dumper::Concise;
2151 local $Data::Dumper::Maxdepth = 5;
2152 Data::Dumper::Concise::Dumper ({
2153 map { $cols->[$_] =>
2161 for my $col_idx (0..$#$cols) {
2162 my $reference_val = $data->[0][$col_idx];
2164 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2165 my $val = $data->[$row_idx][$col_idx];
2167 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2168 if (ref $val ne 'SCALAR') {
2169 $bad_slice_report_cref->(
2170 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2175 elsif ($$val ne $$reference_val) {
2176 $bad_slice_report_cref->(
2177 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2183 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2184 if (is_literal_value($val)) {
2185 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2188 else { # binds from a \[], compare type and attrs
2189 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2190 $bad_slice_report_cref->(
2191 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2196 # start drilling down and bail out early on identical refs
2198 $reference_val != $val
2200 $$reference_val != $$val
2202 if (${$val}->[0] ne ${$reference_val}->[0]) {
2203 $bad_slice_report_cref->(
2204 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2209 # need to check the bind attrs - a bind will happen only once for
2210 # the entire dataset, so any changes further down will be ignored.
2211 elsif (! Data::Compare::Compare(
2212 $value_type_by_col_idx->{$col_idx},
2216 @{$self->_resolve_bindattrs(
2217 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2221 $bad_slice_report_cref->(
2222 'Differing bind attributes on literal/bind values not supported',
2232 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2233 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2235 my $guard = $self->txn_scope_guard;
2237 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2238 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2241 # proto bind contains the information on which pieces of $data to pull
2242 # $cols is passed in only for prettier error-reporting
2243 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2246 # bind_param_array doesn't work if there are no binds
2247 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2251 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2255 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2258 # execute_for_fetch is capable of returning data just fine (it means it
2259 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2260 # is the void-populate fast-path we will just ignore this altogether
2261 # for the time being.
2262 sub _dbh_execute_for_fetch {
2263 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2265 # If we have any bind attributes to take care of, we will bind the
2266 # proto-bind data (which will never be used by execute_for_fetch)
2267 # However since column bindtypes are "sticky", this is sufficient
2268 # to get the DBD to apply the bindtype to all values later on
2269 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2271 for my $i (0 .. $#$proto_bind) {
2273 $i+1, # DBI bind indexes are 1-based
2274 $proto_bind->[$i][1],
2276 ) if defined $bind_attrs->[$i];
2279 # At this point $data slots named in the _bind_data_slice_idx of
2280 # each piece of $proto_bind are either \[]s or plain values to be
2281 # passed in. Construct the dispensing coderef. *NOTE* the order
2282 # of $data will differ from this of the ?s in the SQL (due to
2283 # alphabetical ordering by colname). We actually do want to
2284 # preserve this behavior so that prepare_cached has a better
2285 # chance of matching on unrelated calls
2287 my $fetch_row_idx = -1; # saner loop this way
2288 my $fetch_tuple = sub {
2289 return undef if ++$fetch_row_idx > $#$data;
2292 my $v = ! defined $_->{_literal_bind_subindex}
2294 ? $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2296 # There are no attributes to resolve here - we already did everything
2297 # when we constructed proto_bind. However we still want to sanity-check
2298 # what the user supplied, so pass stuff through to the resolver *anyway*
2299 : $self->_resolve_bindattrs (
2300 undef, # a fake rsrc
2301 [ ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}->[ $_->{_literal_bind_subindex} ] ],
2302 {}, # a fake column_info bag
2306 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
2307 # For the time being forcibly stringify whatever is stringifiable
2308 (length ref $v and is_plain_value $v)
2312 } map { $_->[0] } @$proto_bind ];
2315 my $tuple_status = [];
2318 $rv = $sth->execute_for_fetch(
2327 # Not all DBDs are create equal. Some throw on error, some return
2328 # an undef $rv, and some set $sth->err - try whatever we can
2329 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2332 ( !defined $rv or $sth->err )
2335 # Statement must finish even if there was an exception.
2340 $err = shift unless defined $err
2345 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2347 $self->throw_exception("Unexpected populate error: $err")
2348 if ($i > $#$tuple_status);
2350 require Data::Dumper::Concise;
2351 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2352 ($tuple_status->[$i][1] || $err),
2353 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2360 sub _dbh_execute_inserts_with_no_binds {
2361 my ($self, $sth, $count) = @_;
2365 my $dbh = $self->_get_dbh;
2366 local $dbh->{RaiseError} = 1;
2367 local $dbh->{PrintError} = 0;
2369 $sth->execute foreach 1..$count;
2375 # Make sure statement is finished even if there was an exception.
2380 $err = shift unless defined $err;
2383 $self->throw_exception($err) if defined $err;
2389 #my ($self, $source, @args) = @_;
2390 shift->_execute('update', @_);
2395 #my ($self, $source, @args) = @_;
2396 shift->_execute('delete', @_);
2401 $self->_execute($self->_select_args(@_));
2404 sub _select_args_to_query {
2407 $self->throw_exception(
2408 "Unable to generate limited query representation with 'software_limit' enabled"
2409 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2411 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2412 # = $self->_select_args($ident, $select, $cond, $attrs);
2413 my ($op, $ident, @args) =
2414 $self->_select_args(@_);
2416 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2417 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2419 # reuse the bind arrayref
2420 unshift @{$bind}, "($sql)";
2425 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2427 # FIXME - that kind of caching would be nice to have
2428 # however currently we *may* pass the same $orig_attrs
2429 # with different ident/select/where
2430 # the whole interface needs to be rethought, since it
2431 # was centered around the flawed SQLA API. We can do
2432 # soooooo much better now. But that is also another
2435 # 'select', $orig_attrs->{!args_as_stored_at_the_end_of_this_method!}
2436 #) if $orig_attrs->{!args_as_stored_at_the_end_of_this_method!};
2438 my $sql_maker = $self->sql_maker;
2447 # Sanity check the attributes (SQLMaker does it too, but
2448 # in case of a software_limit we'll never reach there)
2449 if (defined $attrs->{offset}) {
2450 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2451 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2454 if (defined $attrs->{rows}) {
2455 $self->throw_exception("The rows attribute must be a positive integer if present")
2456 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2458 elsif ($attrs->{offset}) {
2459 # MySQL actually recommends this approach. I cringe.
2460 $attrs->{rows} = $sql_maker->__max_int;
2463 # see if we will need to tear the prefetch apart to satisfy group_by == select
2464 # this is *extremely tricky* to get right, I am still not sure I did
2466 my ($prefetch_needs_subquery, @limit_args);
2468 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2469 # we already know there is a valid group_by (we made it) and we know it is
2470 # intended to be based *only* on non-multi stuff
2471 # short circuit the group_by parsing below
2472 $prefetch_needs_subquery = 1;
2475 # The rationale is that even if we do *not* have collapse, we still
2476 # need to wrap the core grouped select/group_by in a subquery
2477 # so that databases that care about group_by/select equivalence
2478 # are happy (this includes MySQL in strict_mode)
2479 # If any of the other joined tables are referenced in the group_by
2480 # however - the user is on their own
2481 ( $prefetch_needs_subquery or ! $attrs->{_simple_passthrough_construction} )
2485 @{$attrs->{group_by}}
2487 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2488 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2491 # no aliases other than our own in group_by
2492 # if there are - do not allow subquery even if limit is present
2493 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2495 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2496 # active collapse with a limit - that one is a no-brainer unless
2497 # overruled by a group_by above
2498 $prefetch_needs_subquery = 1;
2501 if ($prefetch_needs_subquery) {
2502 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2504 elsif (! $attrs->{software_limit} ) {
2506 $attrs->{rows} || (),
2507 $attrs->{offset} || (),
2511 # try to simplify the joinmap further (prune unreferenced type-single joins)
2513 ! $prefetch_needs_subquery # already pruned
2517 reftype $attrs->{from} eq 'ARRAY'
2519 @{$attrs->{from}} != 1
2521 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2524 # FIXME this is a gross, inefficient, largely incorrect and fragile hack
2525 # during the result inflation stage we *need* to know what was the aliastype
2526 # map as sqla saw it when the final pieces of SQL were being assembled
2527 # Originally we simply carried around the entirety of $attrs, but this
2528 # resulted in resultsets that are being reused growing continuously, as
2529 # the hash in question grew deeper and deeper.
2530 # Instead hand-pick what to take with us here (we actually don't need much
2531 # at this point just the map itself)
2532 $orig_attrs->{_last_sqlmaker_alias_map} = $attrs->{_aliastypes};
2535 # my $alias2source = $self->_resolve_ident_sources ($ident);
2537 # This would be the point to deflate anything found in $attrs->{where}
2538 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2539 # expect a result object. And all we have is a resultsource (it is trivial
2540 # to extract deflator coderefs via $alias2source above).
2542 # I don't see a way forward other than changing the way deflators are
2543 # invoked, and that's just bad...
2546 return ( 'select', @{$attrs}{qw(from select where)}, $attrs, @limit_args );
2549 # Returns a counting SELECT for a simple count
2550 # query. Abstracted so that a storage could override
2551 # this to { count => 'firstcol' } or whatever makes
2552 # sense as a performance optimization
2554 #my ($self, $source, $rs_attrs) = @_;
2555 return { count => '*' };
2562 =item Arguments: $ident, $select, $condition, $attrs
2566 Handle a SQL select statement.
2572 my ($ident, $select, $condition, $attrs) = @_;
2573 return $self->cursor_class->new($self, \@_, $attrs);
2578 my ($rv, $sth, @bind) = $self->_select(@_);
2579 my @row = $sth->fetchrow_array;
2580 my @nextrow = $sth->fetchrow_array if @row;
2581 if(@row && @nextrow) {
2582 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2584 # Need to call finish() to work round broken DBDs
2589 =head2 sql_limit_dialect
2591 This is an accessor for the default SQL limit dialect used by a particular
2592 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2593 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2594 see L<DBIx::Class::SQLMaker::LimitDialects>.
2598 sub _dbh_columns_info_for {
2599 my ($self, $dbh, $table) = @_;
2601 if ($dbh->can('column_info')) {
2605 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2606 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2608 while ( my $info = $sth->fetchrow_hashref() ){
2610 $column_info{data_type} = $info->{TYPE_NAME};
2611 $column_info{size} = $info->{COLUMN_SIZE};
2612 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2613 $column_info{default_value} = $info->{COLUMN_DEF};
2614 my $col_name = $info->{COLUMN_NAME};
2615 $col_name =~ s/^\"(.*)\"$/$1/;
2617 $result{$col_name} = \%column_info;
2622 return \%result if !$caught && scalar keys %result;
2626 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2628 my @columns = @{$sth->{NAME_lc}};
2629 for my $i ( 0 .. $#columns ){
2631 $column_info{data_type} = $sth->{TYPE}->[$i];
2632 $column_info{size} = $sth->{PRECISION}->[$i];
2633 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2635 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2636 $column_info{data_type} = $1;
2637 $column_info{size} = $2;
2640 $result{$columns[$i]} = \%column_info;
2644 foreach my $col (keys %result) {
2645 my $colinfo = $result{$col};
2646 my $type_num = $colinfo->{data_type};
2648 if(defined $type_num && $dbh->can('type_info')) {
2649 my $type_info = $dbh->type_info($type_num);
2650 $type_name = $type_info->{TYPE_NAME} if $type_info;
2651 $colinfo->{data_type} = $type_name if $type_name;
2658 sub columns_info_for {
2659 my ($self, $table) = @_;
2660 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2663 =head2 last_insert_id
2665 Return the row id of the last insert.
2669 sub _dbh_last_insert_id {
2670 my ($self, $dbh, $source, $col) = @_;
2672 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2674 return $id if defined $id;
2676 my $class = ref $self;
2677 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2680 sub last_insert_id {
2682 $self->_dbh_last_insert_id ($self->_dbh, @_);
2685 =head2 _native_data_type
2689 =item Arguments: $type_name
2693 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2694 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2695 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2697 The default implementation returns C<undef>, implement in your Storage driver if
2698 you need this functionality.
2700 Should map types from other databases to the native RDBMS type, for example
2701 C<VARCHAR2> to C<VARCHAR>.
2703 Types with modifiers should map to the underlying data type. For example,
2704 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2706 Composite types should map to the container type, for example
2707 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2711 sub _native_data_type {
2712 #my ($self, $data_type) = @_;
2716 # Check if placeholders are supported at all
2717 sub _determine_supports_placeholders {
2719 my $dbh = $self->_get_dbh;
2721 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2722 # but it is inaccurate more often than not
2724 local $dbh->{PrintError} = 0;
2725 local $dbh->{RaiseError} = 1;
2726 $dbh->do('select ?', {}, 1);
2734 # Check if placeholders bound to non-string types throw exceptions
2736 sub _determine_supports_typeless_placeholders {
2738 my $dbh = $self->_get_dbh;
2741 local $dbh->{PrintError} = 0;
2742 local $dbh->{RaiseError} = 1;
2743 # this specifically tests a bind that is NOT a string
2744 $dbh->do('select 1 where 1 = ?', {}, 1);
2754 Returns the database driver name.
2759 shift->_get_dbh->{Driver}->{Name};
2762 =head2 bind_attribute_by_data_type
2764 Given a datatype from column info, returns a database specific bind
2765 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2766 let the database planner just handle it.
2768 This method is always called after the driver has been determined and a DBI
2769 connection has been established. Therefore you can refer to C<DBI::$constant>
2770 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2771 the correct modules.
2775 sub bind_attribute_by_data_type {
2779 =head2 is_datatype_numeric
2781 Given a datatype from column_info, returns a boolean value indicating if
2782 the current RDBMS considers it a numeric value. This controls how
2783 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2784 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2785 be performed instead of the usual C<eq>.
2789 sub is_datatype_numeric {
2790 #my ($self, $dt) = @_;
2792 return 0 unless $_[1];
2795 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2800 =head2 create_ddl_dir
2804 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2808 Creates a SQL file based on the Schema, for each of the specified
2809 database engines in C<\@databases> in the given directory.
2810 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2812 Given a previous version number, this will also create a file containing
2813 the ALTER TABLE statements to transform the previous schema into the
2814 current one. Note that these statements may contain C<DROP TABLE> or
2815 C<DROP COLUMN> statements that can potentially destroy data.
2817 The file names are created using the C<ddl_filename> method below, please
2818 override this method in your schema if you would like a different file
2819 name format. For the ALTER file, the same format is used, replacing
2820 $version in the name with "$preversion-$version".
2822 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2823 The most common value for this would be C<< { add_drop_table => 1 } >>
2824 to have the SQL produced include a C<DROP TABLE> statement for each table
2825 created. For quoting purposes supply C<quote_identifiers>.
2827 If no arguments are passed, then the following default values are assumed:
2831 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2833 =item version - $schema->schema_version
2835 =item directory - './'
2837 =item preversion - <none>
2841 By default, C<\%sqlt_args> will have
2843 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2845 merged with the hash passed in. To disable any of those features, pass in a
2846 hashref like the following
2848 { ignore_constraint_names => 0, # ... other options }
2851 WARNING: You are strongly advised to check all SQL files created, before applying
2856 sub create_ddl_dir {
2857 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2860 carp "No directory given, using ./\n";
2865 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2867 $self->throw_exception(
2868 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2872 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2874 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2875 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2877 my $schema_version = $schema->schema_version || '1.x';
2878 $version ||= $schema_version;
2881 add_drop_table => 1,
2882 ignore_constraint_names => 1,
2883 ignore_index_names => 1,
2884 quote_identifiers => $self->sql_maker->_quoting_enabled,
2888 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2889 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2892 my $sqlt = SQL::Translator->new( $sqltargs );
2894 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2895 my $sqlt_schema = $sqlt->translate({ data => $schema })
2896 or $self->throw_exception ($sqlt->error);
2898 foreach my $db (@$databases) {
2900 $sqlt->{schema} = $sqlt_schema;
2901 $sqlt->producer($db);
2904 my $filename = $schema->ddl_filename($db, $version, $dir);
2905 if (-e $filename && ($version eq $schema_version )) {
2906 # if we are dumping the current version, overwrite the DDL
2907 carp "Overwriting existing DDL file - $filename";
2911 my $output = $sqlt->translate;
2913 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2916 if(!open($file, ">$filename")) {
2917 $self->throw_exception("Can't open $filename for writing ($!)");
2920 print $file $output;
2923 next unless ($preversion);
2925 require SQL::Translator::Diff;
2927 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2928 if(!-e $prefilename) {
2929 carp("No previous schema file found ($prefilename)");
2933 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2935 carp("Overwriting existing diff file - $difffile");
2941 my $t = SQL::Translator->new($sqltargs);
2946 or $self->throw_exception ($t->error);
2948 my $out = $t->translate( $prefilename )
2949 or $self->throw_exception ($t->error);
2951 $source_schema = $t->schema;
2953 $source_schema->name( $prefilename )
2954 unless ( $source_schema->name );
2957 # The "new" style of producers have sane normalization and can support
2958 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2959 # And we have to diff parsed SQL against parsed SQL.
2960 my $dest_schema = $sqlt_schema;
2962 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2963 my $t = SQL::Translator->new($sqltargs);
2968 or $self->throw_exception ($t->error);
2970 my $out = $t->translate( $filename )
2971 or $self->throw_exception ($t->error);
2973 $dest_schema = $t->schema;
2975 $dest_schema->name( $filename )
2976 unless $dest_schema->name;
2980 # FIXME - this is a terrible workaround for
2981 # https://github.com/dbsrgits/sql-translator/commit/2d23c1e
2982 # Fixing it in this sloppy manner so that we don't hve to
2983 # lockstep an SQLT release as well. Needs to be removed at
2984 # some point, and SQLT dep bumped
2985 local $SQL::Translator::Producer::SQLite::NO_QUOTES
2986 if $SQL::Translator::Producer::SQLite::NO_QUOTES;
2988 SQL::Translator::Diff::schema_diff($source_schema, $db,
2994 if(!open $file, ">$difffile") {
2995 $self->throw_exception("Can't write to $difffile ($!)");
3003 =head2 deployment_statements
3007 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
3011 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
3013 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
3014 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
3016 C<$directory> is used to return statements from files in a previously created
3017 L</create_ddl_dir> directory and is optional. The filenames are constructed
3018 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
3020 If no C<$directory> is specified then the statements are constructed on the
3021 fly using L<SQL::Translator> and C<$version> is ignored.
3023 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
3027 sub deployment_statements {
3028 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
3029 $type ||= $self->sqlt_type;
3030 $version ||= $schema->schema_version || '1.x';
3032 my $filename = $schema->ddl_filename($type, $version, $dir);
3035 # FIXME replace this block when a proper sane sql parser is available
3037 open($file, "<$filename")
3038 or $self->throw_exception("Can't open $filename ($!)");
3041 return join('', @rows);
3044 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
3045 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
3048 # sources needs to be a parser arg, but for simplicity allow at top level
3050 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
3051 if exists $sqltargs->{sources};
3053 $sqltargs->{quote_identifiers} = $self->sql_maker->_quoting_enabled
3054 unless exists $sqltargs->{quote_identifiers};
3056 my $tr = SQL::Translator->new(
3057 producer => "SQL::Translator::Producer::${type}",
3059 parser => 'SQL::Translator::Parser::DBIx::Class',
3063 return preserve_context {
3066 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
3067 unless defined $_[0];
3071 # FIXME deploy() currently does not accurately report sql errors
3072 # Will always return true while errors are warned
3074 my ($self, $schema, $type, $sqltargs, $dir) = @_;
3078 return if($line =~ /^--/);
3079 # next if($line =~ /^DROP/m);
3080 return if($line =~ /^BEGIN TRANSACTION/m);
3081 return if($line =~ /^COMMIT/m);
3082 return if $line =~ /^\s+$/; # skip whitespace only
3083 $self->_query_start($line);
3085 # do a dbh_do cycle here, as we need some error checking in
3086 # place (even though we will ignore errors)
3087 $self->dbh_do (sub { $_[1]->do($line) });
3089 carp qq{$_ (running "${line}")};
3091 $self->_query_end($line);
3093 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
3094 if (@statements > 1) {
3095 foreach my $statement (@statements) {
3096 $deploy->( $statement );
3099 elsif (@statements == 1) {
3100 # split on single line comments and end of statements
3101 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3107 =head2 datetime_parser
3109 Returns the datetime parser class
3113 sub datetime_parser {
3115 return $self->{datetime_parser} ||= do {
3116 $self->build_datetime_parser(@_);
3120 =head2 datetime_parser_type
3122 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3124 =head2 build_datetime_parser
3126 See L</datetime_parser>
3130 sub build_datetime_parser {
3132 my $type = $self->datetime_parser_type(@_);
3137 =head2 is_replicating
3139 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3140 replicate from a master database. Default is undef, which is the result
3141 returned by databases that don't support replication.
3145 sub is_replicating {
3150 =head2 lag_behind_master
3152 Returns a number that represents a certain amount of lag behind a master db
3153 when a given storage is replicating. The number is database dependent, but
3154 starts at zero and increases with the amount of lag. Default in undef
3158 sub lag_behind_master {
3162 =head2 relname_to_table_alias
3166 =item Arguments: $relname, $join_count
3168 =item Return Value: $alias
3172 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3175 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3176 way these aliases are named.
3178 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3179 otherwise C<"$relname">.
3183 sub relname_to_table_alias {
3184 my ($self, $relname, $join_count) = @_;
3186 my $alias = ($join_count && $join_count > 1 ?
3187 join('_', $relname, $join_count) : $relname);
3192 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3193 # version and it may be necessary to amend or override it for a specific storage
3194 # if such binds are necessary.
3195 sub _max_column_bytesize {
3196 my ($self, $attr) = @_;
3200 if ($attr->{sqlt_datatype}) {
3201 my $data_type = lc($attr->{sqlt_datatype});
3203 if ($attr->{sqlt_size}) {
3205 # String/sized-binary types
3206 if ($data_type =~ /^(?:
3207 l? (?:var)? char(?:acter)? (?:\s*varying)?
3209 (?:var)? binary (?:\s*varying)?
3214 $max_size = $attr->{sqlt_size};
3216 # Other charset/unicode types, assume scale of 4
3217 elsif ($data_type =~ /^(?:
3218 national \s* character (?:\s*varying)?
3227 $max_size = $attr->{sqlt_size} * 4;
3231 if (!$max_size and !$self->_is_lob_type($data_type)) {
3232 $max_size = 100 # for all other (numeric?) datatypes
3236 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3239 # Determine if a data_type is some type of BLOB
3241 my ($self, $data_type) = @_;
3242 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3243 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3244 |varchar|character\s*varying|nvarchar
3245 |national\s*character\s*varying))?\z/xi);
3248 sub _is_binary_lob_type {
3249 my ($self, $data_type) = @_;
3250 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3251 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3254 sub _is_text_lob_type {
3255 my ($self, $data_type) = @_;
3256 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3257 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3258 |national\s*character\s*varying))\z/xi);
3261 # Determine if a data_type is some type of a binary type
3262 sub _is_binary_type {
3263 my ($self, $data_type) = @_;
3264 $data_type && ($self->_is_binary_lob_type($data_type)
3265 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3272 =head2 DBIx::Class and AutoCommit
3274 DBIx::Class can do some wonderful magic with handling exceptions,
3275 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3276 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3277 transaction support.
3279 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3280 in an assumed transaction between commits, and you're telling us you'd
3281 like to manage that manually. A lot of the magic protections offered by
3282 this module will go away. We can't protect you from exceptions due to database
3283 disconnects because we don't know anything about how to restart your
3284 transactions. You're on your own for handling all sorts of exceptional
3285 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3289 =head1 AUTHOR AND CONTRIBUTORS
3291 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3295 You may distribute this code under the same terms as Perl itself.