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
257 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
258 # some databases spew warnings on implicit disconnect
259 local $SIG{__WARN__} = sub {};
262 # this op is necessary, since the very last perl runtime statement
263 # triggers a global destruction shootout, and the $SIG localization
264 # may very well be destroyed before perl actually gets to do the
269 # handle pid changes correctly - do not destroy parent's connection
272 my $pid = $_[0]->_conn_pid;
274 if( defined $pid and $pid != $$ and my $dbh = $_[0]->_dbh ) {
275 $dbh->{InactiveDestroy} = 1;
277 $_[0]->transaction_depth(0);
278 $_[0]->savepoints([]);
286 This method is normally called by L<DBIx::Class::Schema/connection>, which
287 encapsulates its argument list in an arrayref before passing them here.
289 The argument list may contain:
295 The same 4-element argument set one would normally pass to
296 L<DBI/connect>, optionally followed by
297 L<extra attributes|/DBIx::Class specific connection attributes>
298 recognized by DBIx::Class:
300 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
304 A single code reference which returns a connected
305 L<DBI database handle|DBI/connect> optionally followed by
306 L<extra attributes|/DBIx::Class specific connection attributes> recognized
309 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
313 A single hashref with all the attributes and the dsn/user/password
316 $connect_info_args = [{
324 $connect_info_args = [{
325 dbh_maker => sub { DBI->connect (...) },
330 This is particularly useful for L<Catalyst> based applications, allowing the
331 following config (L<Config::General> style):
336 dsn dbi:mysql:database=test
343 The C<dsn>/C<user>/C<password> combination can be substituted by the
344 C<dbh_maker> key whose value is a coderef that returns a connected
345 L<DBI database handle|DBI/connect>
349 Please note that the L<DBI> docs recommend that you always explicitly
350 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
351 recommends that it be set to I<1>, and that you perform transactions
352 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
353 to I<1> if you do not do explicitly set it to zero. This is the default
354 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
356 =head3 DBIx::Class specific connection attributes
358 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
359 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
360 the following connection options. These options can be mixed in with your other
361 L<DBI> connection attributes, or placed in a separate hashref
362 (C<\%extra_attributes>) as shown above.
364 Every time C<connect_info> is invoked, any previous settings for
365 these options will be cleared before setting the new ones, regardless of
366 whether any options are specified in the new C<connect_info>.
373 Specifies things to do immediately after connecting or re-connecting to
374 the database. Its value may contain:
380 This contains one SQL statement to execute.
382 =item an array reference
384 This contains SQL statements to execute in order. Each element contains
385 a string or a code reference that returns a string.
387 =item a code reference
389 This contains some code to execute. Unlike code references within an
390 array reference, its return value is ignored.
394 =item on_disconnect_do
396 Takes arguments in the same form as L</on_connect_do> and executes them
397 immediately before disconnecting from the database.
399 Note, this only runs if you explicitly call L</disconnect> on the
402 =item on_connect_call
404 A more generalized form of L</on_connect_do> that calls the specified
405 C<connect_call_METHOD> methods in your storage driver.
407 on_connect_do => 'select 1'
411 on_connect_call => [ [ do_sql => 'select 1' ] ]
413 Its values may contain:
419 Will call the C<connect_call_METHOD> method.
421 =item a code reference
423 Will execute C<< $code->($storage) >>
425 =item an array reference
427 Each value can be a method name or code reference.
429 =item an array of arrays
431 For each array, the first item is taken to be the C<connect_call_> method name
432 or code reference, and the rest are parameters to it.
436 Some predefined storage methods you may use:
442 Executes a SQL string or a code reference that returns a SQL string. This is
443 what L</on_connect_do> and L</on_disconnect_do> use.
451 Will execute the scalar as SQL.
455 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
456 attributes hashref and bind values.
458 =item a code reference
460 Will execute C<< $code->($storage) >> and execute the return array refs as
467 Execute any statements necessary to initialize the database session to return
468 and accept datetime/timestamp values used with
469 L<DBIx::Class::InflateColumn::DateTime>.
471 Only necessary for some databases, see your specific storage driver for
472 implementation details.
476 =item on_disconnect_call
478 Takes arguments in the same form as L</on_connect_call> and executes them
479 immediately before disconnecting from the database.
481 Calls the C<disconnect_call_METHOD> methods as opposed to the
482 C<connect_call_METHOD> methods called by L</on_connect_call>.
484 Note, this only runs if you explicitly call L</disconnect> on the
487 =item disable_sth_caching
489 If set to a true value, this option will disable the caching of
490 statement handles via L<DBI/prepare_cached>.
494 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
495 default L</sql_limit_dialect> setting of the storage (if any). For a list
496 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
500 When true automatically sets L</quote_char> and L</name_sep> to the characters
501 appropriate for your particular RDBMS. This option is preferred over specifying
502 L</quote_char> directly.
506 Specifies what characters to use to quote table and column names.
508 C<quote_char> expects either a single character, in which case is it
509 is placed on either side of the table/column name, or an arrayref of length
510 2 in which case the table/column name is placed between the elements.
512 For example under MySQL you should use C<< quote_char => '`' >>, and for
513 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
517 This parameter is only useful in conjunction with C<quote_char>, and is used to
518 specify the character that separates elements (schemas, tables, columns) from
519 each other. If unspecified it defaults to the most commonly used C<.>.
523 This Storage driver normally installs its own C<HandleError>, sets
524 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
525 all database handles, including those supplied by a coderef. It does this
526 so that it can have consistent and useful error behavior.
528 If you set this option to a true value, Storage will not do its usual
529 modifications to the database handle's attributes, and instead relies on
530 the settings in your connect_info DBI options (or the values you set in
531 your connection coderef, in the case that you are connecting via coderef).
533 Note that your custom settings can cause Storage to malfunction,
534 especially if you set a C<HandleError> handler that suppresses exceptions
535 and/or disable C<RaiseError>.
539 If this option is true, L<DBIx::Class> will use savepoints when nesting
540 transactions, making it possible to recover from failure in the inner
541 transaction without having to abort all outer transactions.
545 Use this argument to supply a cursor class other than the default
546 L<DBIx::Class::Storage::DBI::Cursor>.
550 Some real-life examples of arguments to L</connect_info> and
551 L<DBIx::Class::Schema/connect>
553 # Simple SQLite connection
554 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
557 ->connect_info([ sub { DBI->connect(...) } ]);
559 # Connect via subref in hashref
561 dbh_maker => sub { DBI->connect(...) },
562 on_connect_do => 'alter session ...',
565 # A bit more complicated
572 { quote_char => q{"} },
576 # Equivalent to the previous example
582 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
586 # Same, but with hashref as argument
587 # See parse_connect_info for explanation
590 dsn => 'dbi:Pg:dbname=foo',
592 password => 'my_pg_password',
599 # Subref + DBIx::Class-specific connection options
602 sub { DBI->connect(...) },
606 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
607 disable_sth_caching => 1,
617 my ($self, $info) = @_;
619 return $self->_connect_info if !$info;
621 $self->_connect_info($info); # copy for _connect_info
623 $info = $self->_normalize_connect_info($info)
624 if ref $info eq 'ARRAY';
627 %{ $self->_default_dbi_connect_attributes || {} },
628 %{ $info->{attributes} || {} },
631 my @args = @{ $info->{arguments} };
633 if (keys %attrs and ref $args[0] ne 'CODE') {
635 'You provided explicit AutoCommit => 0 in your connection_info. '
636 . 'This is almost universally a bad idea (see the footnotes of '
637 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
638 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
640 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
642 push @args, \%attrs if keys %attrs;
645 # this is the authoritative "always an arrayref" thing fed to DBI->connect
646 # OR a single-element coderef-based $dbh factory
647 $self->_dbi_connect_info(\@args);
649 # extract the individual storage options
650 for my $storage_opt (keys %{ $info->{storage_options} }) {
651 my $value = $info->{storage_options}{$storage_opt};
653 $self->$storage_opt($value);
656 # Extract the individual sqlmaker options
658 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
659 # the new set of options
660 $self->_sql_maker(undef);
661 $self->_sql_maker_opts({});
663 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
664 my $value = $info->{sql_maker_options}{$sql_maker_opt};
666 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
670 # save attributes in a separate accessor so they are always
671 # introspectable, even in case of a CODE $dbhmaker
672 $self->_dbic_connect_attributes (\%attrs);
674 return $self->_connect_info;
677 sub _dbi_connect_info {
680 return $self->{_dbi_connect_info} = $_[0]
683 my $conninfo = $self->{_dbi_connect_info} || [];
685 # last ditch effort to grab a DSN
686 if ( ! defined $conninfo->[0] and $ENV{DBI_DSN} ) {
687 my @new_conninfo = @$conninfo;
688 $new_conninfo[0] = $ENV{DBI_DSN};
689 $conninfo = \@new_conninfo;
696 sub _normalize_connect_info {
697 my ($self, $info_arg) = @_;
700 my @args = @$info_arg; # take a shallow copy for further mutilation
702 # combine/pre-parse arguments depending on invocation style
705 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
706 %attrs = %{ $args[1] || {} };
709 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
710 %attrs = %{$args[0]};
712 if (my $code = delete $attrs{dbh_maker}) {
715 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
718 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
719 . "to the result of 'dbh_maker'",
721 join (', ', map { "'$_'" } (@ignored) ),
726 @args = delete @attrs{qw/dsn user password/};
729 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
731 % { $args[3] || {} },
732 % { $args[4] || {} },
734 @args = @args[0,1,2];
737 $info{arguments} = \@args;
739 my @storage_opts = grep exists $attrs{$_},
740 @storage_options, 'cursor_class';
742 @{ $info{storage_options} }{@storage_opts} =
743 delete @attrs{@storage_opts} if @storage_opts;
745 my @sql_maker_opts = grep exists $attrs{$_},
746 qw/limit_dialect quote_char name_sep quote_names/;
748 @{ $info{sql_maker_options} }{@sql_maker_opts} =
749 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
751 $info{attributes} = \%attrs if %attrs;
756 sub _default_dbi_connect_attributes () {
761 ShowErrorStatement => 1,
767 This method is deprecated in favour of setting via L</connect_info>.
771 =head2 on_disconnect_do
773 This method is deprecated in favour of setting via L</connect_info>.
777 sub _parse_connect_do {
778 my ($self, $type) = @_;
780 my $val = $self->$type;
781 return () if not defined $val;
786 push @res, [ 'do_sql', $val ];
787 } elsif (ref($val) eq 'CODE') {
789 } elsif (ref($val) eq 'ARRAY') {
790 push @res, map { [ 'do_sql', $_ ] } @$val;
792 $self->throw_exception("Invalid type for $type: ".ref($val));
800 Arguments: ($subref | $method_name), @extra_coderef_args?
802 Execute the given $subref or $method_name using the new exception-based
803 connection management.
805 The first two arguments will be the storage object that C<dbh_do> was called
806 on and a database handle to use. Any additional arguments will be passed
807 verbatim to the called subref as arguments 2 and onwards.
809 Using this (instead of $self->_dbh or $self->dbh) ensures correct
810 exception handling and reconnection (or failover in future subclasses).
812 Your subref should have no side-effects outside of the database, as
813 there is the potential for your subref to be partially double-executed
814 if the database connection was stale/dysfunctional.
818 my @stuff = $schema->storage->dbh_do(
820 my ($storage, $dbh, @cols) = @_;
821 my $cols = join(q{, }, @cols);
822 $dbh->selectrow_array("SELECT $cols FROM foo");
831 my $run_target = shift; # either a coderef or a method name
833 # short circuit when we know there is no need for a runner
835 # FIXME - assumption may be wrong
836 # the rationale for the txn_depth check is that if this block is a part
837 # of a larger transaction, everything up to that point is screwed anyway
838 return $self->$run_target($self->_get_dbh, @_)
839 if $self->{_in_do_block} or $self->transaction_depth;
841 # take a ref instead of a copy, to preserve @_ aliasing
842 # semantics within the coderef, but only if needed
843 # (pseudoforking doesn't like this trick much)
844 my $args = @_ ? \@_ : [];
846 DBIx::Class::Storage::BlockRunner->new(
849 retry_handler => sub {
850 $_[0]->failed_attempt_count == 1
852 ! $_[0]->storage->connected
855 $self->$run_target ($self->_get_dbh, @$args )
860 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
861 shift->next::method(@_);
866 Our C<disconnect> method also performs a rollback first if the
867 database is not in C<AutoCommit> mode.
873 if( my $dbh = $_[0]->_dbh ) {
875 $_[0]->_do_connection_actions(disconnect_call_ => $_) for (
876 ( $_[0]->on_disconnect_call || () ),
877 $_[0]->_parse_connect_do ('on_disconnect_do')
880 # stops the "implicit rollback on disconnect" warning
881 $_[0]->_exec_txn_rollback unless $_[0]->_dbh_autocommit;
883 %{ $dbh->{CachedKids} } = ();
889 =head2 with_deferred_fk_checks
893 =item Arguments: C<$coderef>
895 =item Return Value: The return value of $coderef
899 Storage specific method to run the code ref with FK checks deferred or
900 in MySQL's case disabled entirely.
904 # Storage subclasses should override this
905 sub with_deferred_fk_checks {
906 #my ($self, $sub) = @_;
914 =item Arguments: none
916 =item Return Value: 1|0
920 Verifies that the current database handle is active and ready to execute
921 an SQL statement (e.g. the connection did not get stale, server is still
922 answering, etc.) This method is used internally by L</dbh>.
927 return 0 unless $_[0]->_seems_connected;
930 local $_[0]->_dbh->{RaiseError} = 1;
935 sub _seems_connected {
936 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
938 ($_[0]->_dbh || return 0)->FETCH('Active');
942 ($_[0]->_dbh || return 0)->ping;
945 sub ensure_connected {
946 $_[0]->connected || ( $_[0]->_populate_dbh && 1 );
951 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
952 is guaranteed to be healthy by implicitly calling L</connected>, and if
953 necessary performing a reconnection before returning. Keep in mind that this
954 is very B<expensive> on some database engines. Consider using L</dbh_do>
960 # maybe save a ping call
962 ? ( $_[0]->ensure_connected and $_[0]->_dbh )
963 : $_[0]->_populate_dbh
967 # this is the internal "get dbh or connect (don't check)" method
969 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
970 $_[0]->_dbh || $_[0]->_populate_dbh;
973 # *DELIBERATELY* not a setter (for the time being)
974 # Too intertwined with everything else for any kind of sanity
978 $self->throw_exception('sql_maker() is not a setter method') if @_;
980 unless ($self->_sql_maker) {
981 my $sql_maker_class = $self->sql_maker_class;
983 my %opts = %{$self->_sql_maker_opts||{}};
987 $self->sql_limit_dialect
990 my $s_class = (ref $self) || $self;
992 "Your storage class ($s_class) does not set sql_limit_dialect and you "
993 . 'have not supplied an explicit limit_dialect in your connection_info. '
994 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
995 . 'databases but can be (and often is) painfully slow. '
996 . "Please file an RT ticket against '$s_class'"
997 ) if $self->_dbi_connect_info->[0];
1003 my ($quote_char, $name_sep);
1005 if ($opts{quote_names}) {
1006 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1007 my $s_class = (ref $self) || $self;
1009 "You requested 'quote_names' but your storage class ($s_class) does "
1010 . 'not explicitly define a default sql_quote_char and you have not '
1011 . 'supplied a quote_char as part of your connection_info. DBIC will '
1012 .q{default to the ANSI SQL standard quote '"', which works most of }
1013 . "the time. Please file an RT ticket against '$s_class'."
1019 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1022 $self->_sql_maker($sql_maker_class->new(
1023 bindtype=>'columns',
1024 array_datatypes => 1,
1025 limit_dialect => $dialect,
1026 ($quote_char ? (quote_char => $quote_char) : ()),
1027 name_sep => ($name_sep || '.'),
1031 return $self->_sql_maker;
1034 # nothing to do by default
1040 $_[0]->_dbh(undef); # in case ->connected failed we might get sent here
1042 $_[0]->_dbh_details({}); # reset everything we know
1044 # FIXME - this needs reenabling with the proper "no reset on same DSN" check
1045 #$_[0]->_sql_maker(undef); # this may also end up being different
1047 $_[0]->_dbh($_[0]->_connect);
1049 $_[0]->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1051 $_[0]->_determine_driver;
1053 # Always set the transaction depth on connect, since
1054 # there is no transaction in progress by definition
1055 $_[0]->{transaction_depth} = $_[0]->_dbh_autocommit ? 0 : 1;
1057 $_[0]->_run_connection_actions unless $_[0]->{_in_determine_driver};
1062 sub _run_connection_actions {
1064 $_[0]->_do_connection_actions(connect_call_ => $_) for (
1065 ( $_[0]->on_connect_call || () ),
1066 $_[0]->_parse_connect_do ('on_connect_do'),
1072 sub set_use_dbms_capability {
1073 $_[0]->set_inherited ($_[1], $_[2]);
1076 sub get_use_dbms_capability {
1077 my ($self, $capname) = @_;
1079 my $use = $self->get_inherited ($capname);
1082 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1086 sub set_dbms_capability {
1087 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1090 sub get_dbms_capability {
1091 my ($self, $capname) = @_;
1093 my $cap = $self->_dbh_details->{capability}{$capname};
1095 unless (defined $cap) {
1096 if (my $meth = $self->can ("_determine$capname")) {
1097 $cap = $self->$meth ? 1 : 0;
1103 $self->set_dbms_capability ($capname, $cap);
1113 unless ($info = $self->_dbh_details->{info}) {
1117 my $server_version = try {
1118 $self->_get_server_version
1120 # driver determination *may* use this codepath
1121 # in which case we must rethrow
1122 $self->throw_exception($_) if $self->{_in_determine_driver};
1124 # $server_version on failure
1128 if (defined $server_version) {
1129 $info->{dbms_version} = $server_version;
1131 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1132 my @verparts = split (/\./, $numeric_version);
1138 # consider only up to 3 version parts, iff not more than 3 digits
1140 while (@verparts && @use_parts < 3) {
1141 my $p = shift @verparts;
1143 push @use_parts, $p;
1145 push @use_parts, 0 while @use_parts < 3;
1147 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1151 $self->_dbh_details->{info} = $info;
1157 sub _get_server_version {
1158 shift->_dbh_get_info('SQL_DBMS_VER');
1162 my ($self, $info) = @_;
1164 if ($info =~ /[^0-9]/) {
1165 require DBI::Const::GetInfoType;
1166 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1167 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1168 unless defined $info;
1171 $self->_get_dbh->get_info($info);
1174 sub _describe_connection {
1175 require DBI::Const::GetInfoReturn;
1181 $drv = $self->_extract_driver_from_connect_info;
1182 $self->ensure_connected;
1185 $drv = "DBD::$drv" if $drv;
1188 DBIC_DSN => $self->_dbi_connect_info->[0],
1189 DBI_VER => DBI->VERSION,
1190 DBIC_VER => DBIx::Class->VERSION,
1191 DBIC_DRIVER => ref $self,
1194 DBD_VER => try { $drv->VERSION },
1198 # try to grab data even if we never managed to connect
1199 # will cover us in cases of an oddly broken half-connect
1201 #keys %DBI::Const::GetInfoType::GetInfoType,
1203 SQL_CURSOR_COMMIT_BEHAVIOR
1204 SQL_CURSOR_ROLLBACK_BEHAVIOR
1205 SQL_CURSOR_SENSITIVITY
1206 SQL_DATA_SOURCE_NAME
1209 SQL_DEFAULT_TXN_ISOLATION
1214 SQL_EXPRESSIONS_IN_ORDERBY
1217 SQL_IDENTIFIER_QUOTE_CHAR
1218 SQL_MAX_CATALOG_NAME_LEN
1219 SQL_MAX_COLUMN_NAME_LEN
1220 SQL_MAX_IDENTIFIER_LEN
1221 SQL_MAX_TABLE_NAME_LEN
1222 SQL_MULTIPLE_ACTIVE_TXN
1223 SQL_MULT_RESULT_SETS
1224 SQL_NEED_LONG_DATA_LEN
1225 SQL_NON_NULLABLE_COLUMNS
1227 SQL_QUALIFIER_NAME_SEPARATOR
1228 SQL_QUOTED_IDENTIFIER_CASE
1230 SQL_TXN_ISOLATION_OPTION
1233 # some drivers barf on things they do not know about instead
1234 # of returning undef
1235 my $v = try { $self->_dbh_get_info($inf) };
1236 next unless defined $v;
1238 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1239 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1240 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1246 sub _determine_driver {
1249 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1250 my $started_connected = 0;
1251 local $self->{_in_determine_driver} = 1;
1253 if (ref($self) eq __PACKAGE__) {
1255 if ($self->_dbh) { # we are connected
1256 $driver = $self->_dbh->{Driver}{Name};
1257 $started_connected = 1;
1260 $driver = $self->_extract_driver_from_connect_info;
1264 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1265 if ($self->load_optional_class($storage_class)) {
1266 mro::set_mro($storage_class, 'c3');
1267 bless $self, $storage_class;
1271 $self->_warn_undetermined_driver(
1272 'This version of DBIC does not yet seem to supply a driver for '
1273 . "your particular RDBMS and/or connection method ('$driver')."
1278 $self->_warn_undetermined_driver(
1279 'Unable to extract a driver name from connect info - this '
1280 . 'should not have happened.'
1285 $self->_driver_determined(1);
1287 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1289 if ($self->can('source_bind_attributes')) {
1290 $self->throw_exception(
1291 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1292 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1293 . 'If you are not sure how to proceed please contact the development team via '
1294 . DBIx::Class::_ENV_::HELP_URL
1298 $self->_init; # run driver-specific initializations
1300 $self->_run_connection_actions
1301 if !$started_connected && defined $self->_dbh;
1305 sub _extract_driver_from_connect_info {
1310 # if connect_info is a CODEREF, we have no choice but to connect
1312 ref $self->_dbi_connect_info->[0]
1314 reftype $self->_dbi_connect_info->[0] eq 'CODE'
1316 $self->_populate_dbh;
1317 $drv = $self->_dbh->{Driver}{Name};
1320 # try to use dsn to not require being connected, the driver may still
1321 # force a connection later in _rebless to determine version
1322 # (dsn may not be supplied at all if all we do is make a mock-schema)
1323 ($drv) = ($self->_dbi_connect_info->[0] || '') =~ /^dbi:([^:]+):/i;
1324 $drv ||= $ENV{DBI_DRIVER};
1330 sub _determine_connector_driver {
1331 my ($self, $conn) = @_;
1333 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1336 $self->_warn_undetermined_driver(
1337 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1338 . "$conn connector - this should not have happened."
1343 $dbtype =~ s/\W/_/gi;
1345 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1346 return if $self->isa($subclass);
1348 if ($self->load_optional_class($subclass)) {
1349 bless $self, $subclass;
1353 $self->_warn_undetermined_driver(
1354 'This version of DBIC does not yet seem to supply a driver for '
1355 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1360 sub _warn_undetermined_driver {
1361 my ($self, $msg) = @_;
1363 require Data::Dumper::Concise;
1365 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1366 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1367 . "does not go away, file a bugreport including the following info:\n"
1368 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1372 sub _do_connection_actions {
1374 my $method_prefix = shift;
1377 if (not ref($call)) {
1378 my $method = $method_prefix . $call;
1380 } elsif (ref($call) eq 'CODE') {
1382 } elsif (ref($call) eq 'ARRAY') {
1383 if (ref($call->[0]) ne 'ARRAY') {
1384 $self->_do_connection_actions($method_prefix, $_) for @$call;
1386 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1389 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1395 sub connect_call_do_sql {
1397 $self->_do_query(@_);
1400 sub disconnect_call_do_sql {
1402 $self->_do_query(@_);
1405 # override in db-specific backend when necessary
1406 sub connect_call_datetime_setup { 1 }
1409 my ($self, $action) = @_;
1411 if (ref $action eq 'CODE') {
1412 $action = $action->($self);
1413 $self->_do_query($_) foreach @$action;
1416 # Most debuggers expect ($sql, @bind), so we need to exclude
1417 # the attribute hash which is the second argument to $dbh->do
1418 # furthermore the bind values are usually to be presented
1419 # as named arrayref pairs, so wrap those here too
1420 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1421 my $sql = shift @do_args;
1422 my $attrs = shift @do_args;
1423 my @bind = map { [ undef, $_ ] } @do_args;
1426 $_[0]->_query_start($sql, \@bind);
1427 $_[1]->do($sql, $attrs, @do_args);
1428 $_[0]->_query_end($sql, \@bind);
1438 my $info = $self->_dbi_connect_info;
1440 $self->throw_exception("You did not provide any connection_info")
1441 unless defined $info->[0];
1443 my ($old_connect_via, $dbh);
1445 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1447 # this odd anonymous coderef dereference is in fact really
1448 # necessary to avoid the unwanted effect described in perl5
1451 # in addition the coderef itself can't reside inside the try{} block below
1452 # as it somehow triggers a leak under perl -d
1453 my $dbh_error_handler_installer = sub {
1454 weaken (my $weak_self = $_[0]);
1456 # the coderef is blessed so we can distinguish it from externally
1457 # supplied handles (which must be preserved)
1458 $_[1]->{HandleError} = bless sub {
1460 $weak_self->throw_exception("DBI Exception: $_[0]");
1463 # the handler may be invoked by something totally out of
1465 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1467 }, '__DBIC__DBH__ERROR__HANDLER__';
1471 if(ref $info->[0] eq 'CODE') {
1472 $dbh = $info->[0]->();
1476 $dbh = DBI->connect(@$info);
1479 die $DBI::errstr unless $dbh;
1481 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1482 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1484 ref $info->[0] eq 'CODE'
1485 ? "Connection coderef $info->[0] returned a"
1486 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1487 ) unless $dbh->FETCH('Active');
1489 # sanity checks unless asked otherwise
1490 unless ($self->unsafe) {
1492 $self->throw_exception(
1493 'Refusing clobbering of {HandleError} installed on externally supplied '
1494 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1495 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1497 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1498 # request, or an external handle. Complain and set anyway
1499 unless ($dbh->{RaiseError}) {
1500 carp( ref $info->[0] eq 'CODE'
1502 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1503 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1504 .'attribute has been supplied'
1506 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1507 .'unsafe => 1. Toggling RaiseError back to true'
1510 $dbh->{RaiseError} = 1;
1513 $dbh_error_handler_installer->($self, $dbh);
1517 $self->throw_exception("DBI Connection failed: $_")
1520 $self->_dbh_autocommit($dbh->{AutoCommit});
1525 # this means we have not yet connected and do not know the AC status
1526 # (e.g. coderef $dbh), need a full-fledged connection check
1527 if (! defined $_[0]->_dbh_autocommit) {
1528 $_[0]->ensure_connected;
1530 # Otherwise simply connect or re-connect on pid changes
1535 shift->next::method(@_);
1538 sub _exec_txn_begin {
1541 # if the user is utilizing txn_do - good for him, otherwise we need to
1542 # ensure that the $dbh is healthy on BEGIN.
1543 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1544 # will be replaced by a failure of begin_work itself (which will be
1545 # then retried on reconnect)
1546 if ($self->{_in_do_block}) {
1547 $self->_dbh->begin_work;
1549 $self->dbh_do(sub { $_[1]->begin_work });
1556 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1557 unless $self->_seems_connected;
1559 # esoteric case for folks using external $dbh handles
1560 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1561 carp "Storage transaction_depth 0 does not match "
1562 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1563 $self->transaction_depth(1);
1566 $self->next::method(@_);
1568 # if AutoCommit is disabled txn_depth never goes to 0
1569 # as a new txn is started immediately on commit
1570 $self->transaction_depth(1) if (
1571 !$self->transaction_depth
1573 defined $self->_dbh_autocommit
1575 ! $self->_dbh_autocommit
1579 sub _exec_txn_commit {
1580 shift->_dbh->commit;
1586 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1587 unless $self->_seems_connected;
1589 # esoteric case for folks using external $dbh handles
1590 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1591 carp "Storage transaction_depth 0 does not match "
1592 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1593 $self->transaction_depth(1);
1596 $self->next::method(@_);
1598 # if AutoCommit is disabled txn_depth never goes to 0
1599 # as a new txn is started immediately on commit
1600 $self->transaction_depth(1) if (
1601 !$self->transaction_depth
1603 defined $self->_dbh_autocommit
1605 ! $self->_dbh_autocommit
1609 sub _exec_txn_rollback {
1610 shift->_dbh->rollback;
1613 # generate the DBI-specific stubs, which then fallback to ::Storage proper
1614 quote_sub __PACKAGE__ . "::$_" => sprintf (<<'EOS', $_) for qw(svp_begin svp_release svp_rollback);
1615 $_[0]->throw_exception('Unable to %s() on a disconnected storage')
1616 unless $_[0]->_seems_connected;
1617 shift->next::method(@_);
1620 # This used to be the top-half of _execute. It was split out to make it
1621 # easier to override in NoBindVars without duping the rest. It takes up
1622 # all of _execute's args, and emits $sql, @bind.
1623 sub _prep_for_execute {
1624 #my ($self, $op, $ident, $args) = @_;
1625 return shift->_gen_sql_bind(@_)
1629 my ($self, $op, $ident, $args) = @_;
1631 my ($colinfos, $from);
1632 if ( blessed($ident) ) {
1633 $from = $ident->from;
1634 $colinfos = $ident->columns_info;
1638 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1640 $bind = $self->_resolve_bindattrs(
1641 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1645 ! $ENV{DBIC_DT_SEARCH_OK}
1654 $_->[1]->isa('DateTime')
1657 carp_unique 'DateTime objects passed to search() are not supported '
1658 . 'properly (InflateColumn::DateTime formats and settings are not '
1659 . 'respected.) See "Formatting DateTime objects in queries" in '
1660 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1661 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1664 return( $sql, $bind );
1667 sub _resolve_bindattrs {
1668 my ($self, $ident, $bind, $colinfos) = @_;
1670 my $resolve_bindinfo = sub {
1671 #my $infohash = shift;
1673 $colinfos ||= { %{ $self->_resolve_column_info($ident) } };
1676 if (my $col = $_[0]->{dbic_colname}) {
1677 $ret = { %{$_[0]} };
1679 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1680 if $colinfos->{$col}{data_type};
1682 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1683 if $colinfos->{$col}{size};
1691 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1692 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1693 : (ref $_->[0] eq 'HASH') ? [(
1696 exists $_->[0]{dbd_attrs}
1698 $_->[0]{sqlt_datatype}
1700 : $resolve_bindinfo->($_->[0])
1703 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1704 : [ $resolve_bindinfo->(
1705 { dbic_colname => $_->[0] }
1710 ! exists $resolved->[0]{dbd_attrs}
1712 ! $resolved->[0]{sqlt_datatype}
1714 length ref $resolved->[1]
1716 ! is_plain_value $resolved->[1]
1718 require Data::Dumper;
1719 local $Data::Dumper::Maxdepth = 1;
1720 local $Data::Dumper::Terse = 1;
1721 local $Data::Dumper::Useqq = 1;
1722 local $Data::Dumper::Indent = 0;
1723 local $Data::Dumper::Pad = ' ';
1724 $self->throw_exception(
1725 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1726 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1735 sub _format_for_trace {
1736 #my ($self, $bind) = @_;
1738 ### Turn @bind from something like this:
1739 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1741 ### ( "'1'", "'3'" )
1744 defined( $_ && $_->[1] )
1751 my ( $self, $sql, $bind ) = @_;
1753 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1758 my ( $self, $sql, $bind ) = @_;
1760 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1764 sub _dbi_attrs_for_bind {
1765 my ($self, $ident, $bind) = @_;
1769 for (map { $_->[0] } @$bind) {
1771 if (exists $_->{dbd_attrs}) {
1774 elsif($_->{sqlt_datatype}) {
1775 # cache the result in the dbh_details hash, as it can not change unless
1776 # we connect to something else
1777 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1778 if (not exists $cache->{$_->{sqlt_datatype}}) {
1779 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1781 $cache->{$_->{sqlt_datatype}};
1784 undef; # always push something at this position
1793 my ($self, $op, $ident, @args) = @_;
1795 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1797 # not even a PID check - we do not care about the state of the _dbh.
1798 # All we need is to get the appropriate drivers loaded if they aren't
1799 # already so that the assumption in ad7c50fc26e holds
1800 $self->_populate_dbh unless $self->_dbh;
1802 $self->dbh_do( _dbh_execute => # retry over disconnects
1805 $self->_dbi_attrs_for_bind($ident, $bind),
1810 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1812 $self->_query_start( $sql, $bind );
1814 my $sth = $self->_bind_sth_params(
1815 $self->_prepare_sth($dbh, $sql),
1820 # Can this fail without throwing an exception anyways???
1821 my $rv = $sth->execute();
1822 $self->throw_exception(
1823 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1826 $self->_query_end( $sql, $bind );
1828 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1832 my ($self, $dbh, $sql) = @_;
1834 # 3 is the if_active parameter which avoids active sth re-use
1835 my $sth = $self->disable_sth_caching
1836 ? $dbh->prepare($sql)
1837 : $dbh->prepare_cached($sql, {}, 3);
1839 # XXX You would think RaiseError would make this impossible,
1840 # but apparently that's not true :(
1841 $self->throw_exception(
1844 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1845 .'an exception and/or setting $dbh->errstr',
1847 ? substr($sql, 0, 20) . '...'
1850 'DBD::' . $dbh->{Driver}{Name},
1857 sub _bind_sth_params {
1858 my ($self, $sth, $bind, $bind_attrs) = @_;
1860 for my $i (0 .. $#$bind) {
1861 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1862 $sth->bind_param_inout(
1863 $i + 1, # bind params counts are 1-based
1865 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1870 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
1871 my $v = ( length ref $bind->[$i][1] and is_plain_value $bind->[$i][1] )
1878 # The temp-var is CRUCIAL - DO NOT REMOVE IT, breaks older DBD::SQLite RT#79576
1888 sub _prefetch_autovalues {
1889 my ($self, $source, $colinfo, $to_insert) = @_;
1892 for my $col (keys %$colinfo) {
1894 $colinfo->{$col}{auto_nextval}
1897 ! exists $to_insert->{$col}
1899 is_literal_value($to_insert->{$col})
1902 $values{$col} = $self->_sequence_fetch(
1904 ( $colinfo->{$col}{sequence} ||=
1905 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1915 my ($self, $source, $to_insert) = @_;
1917 my $col_infos = $source->columns_info;
1919 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1921 # fuse the values, but keep a separate list of prefetched_values so that
1922 # they can be fused once again with the final return
1923 $to_insert = { %$to_insert, %$prefetched_values };
1925 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1926 # Investigate what does it take to s/defined/exists/
1927 my %pcols = map { $_ => 1 } $source->primary_columns;
1928 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1929 for my $col ($source->columns) {
1930 if ($col_infos->{$col}{is_auto_increment}) {
1931 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1932 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1935 # nothing to retrieve when explicit values are supplied
1937 defined $to_insert->{$col} and ! is_literal_value($to_insert->{$col})
1940 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1941 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1944 $col_infos->{$col}{retrieve_on_insert}
1948 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1949 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1951 my ($sqla_opts, @ir_container);
1952 if (%retrieve_cols and $self->_use_insert_returning) {
1953 $sqla_opts->{returning_container} = \@ir_container
1954 if $self->_use_insert_returning_bound;
1956 $sqla_opts->{returning} = [
1957 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1961 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1963 my %returned_cols = %$to_insert;
1964 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1965 @ir_container = try {
1966 local $SIG{__WARN__} = sub {};
1967 my @r = $sth->fetchrow_array;
1970 } unless @ir_container;
1972 @returned_cols{@$retlist} = @ir_container if @ir_container;
1975 # pull in PK if needed and then everything else
1976 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1978 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1979 unless $self->can('last_insert_id');
1981 my @pri_values = $self->last_insert_id($source, @missing_pri);
1983 $self->throw_exception( "Can't get last insert id" )
1984 unless (@pri_values == @missing_pri);
1986 @returned_cols{@missing_pri} = @pri_values;
1987 delete @retrieve_cols{@missing_pri};
1990 # if there is more left to pull
1991 if (%retrieve_cols) {
1992 $self->throw_exception(
1993 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1996 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1998 my $cur = DBIx::Class::ResultSet->new($source, {
1999 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
2000 select => \@left_to_fetch,
2003 @returned_cols{@left_to_fetch} = $cur->next;
2005 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
2006 if scalar $cur->next;
2010 return { %$prefetched_values, %returned_cols };
2015 'insert_bulk() should have never been exposed as a public method and '
2016 . 'calling it is depecated as of Aug 2014. If you believe having a genuine '
2017 . 'use for this method please contact the development team via '
2018 . DBIx::Class::_ENV_::HELP_URL
2021 return '0E0' unless @{$_[3]||[]};
2023 shift->_insert_bulk(@_);
2027 my ($self, $source, $cols, $data) = @_;
2029 $self->throw_exception('Calling _insert_bulk without a dataset to process makes no sense')
2030 unless @{$data||[]};
2032 my $colinfos = $source->columns_info($cols);
2034 local $self->{_autoinc_supplied_for_op} =
2035 (grep { $_->{is_auto_increment} } values %$colinfos)
2040 # get a slice type index based on first row of data
2041 # a "column" in this context may refer to more than one bind value
2042 # e.g. \[ '?, ?', [...], [...] ]
2044 # construct the value type index - a description of values types for every
2045 # per-column slice of $data:
2047 # nonexistent - nonbind literal
2049 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2051 # also construct the column hash to pass to the SQL generator. For plain
2052 # (non literal) values - convert the members of the first row into a
2053 # literal+bind combo, with extra positional info in the bind attr hashref.
2054 # This will allow us to match the order properly, and is so contrived
2055 # because a user-supplied literal/bind (or something else specific to a
2056 # resultsource and/or storage driver) can inject extra binds along the
2057 # way, so one can't rely on "shift positions" ordering at all. Also we
2058 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2059 # can be later matched up by address), because we want to supply a real
2060 # value on which perhaps e.g. datatype checks will be performed
2061 my ($proto_data, $value_type_by_col_idx);
2062 for my $col_idx (0..$#$cols) {
2063 my $colname = $cols->[$col_idx];
2064 if (ref $data->[0][$col_idx] eq 'SCALAR') {
2065 # no bind value at all - no type
2067 $proto_data->{$colname} = $data->[0][$col_idx];
2069 elsif (ref $data->[0][$col_idx] eq 'REF' and ref ${$data->[0][$col_idx]} eq 'ARRAY' ) {
2070 # repack, so we don't end up mangling the original \[]
2071 my ($sql, @bind) = @${$data->[0][$col_idx]};
2073 # normalization of user supplied stuff
2074 my $resolved_bind = $self->_resolve_bindattrs(
2075 $source, \@bind, $colinfos,
2078 # store value-less (attrs only) bind info - we will be comparing all
2079 # supplied binds against this for sanity
2080 $value_type_by_col_idx->{$col_idx} = [ map { $_->[0] } @$resolved_bind ];
2082 $proto_data->{$colname} = \[ $sql, map { [
2083 # inject slice order to use for $proto_bind construction
2084 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $col_idx, _literal_bind_subindex => $_+1 }
2086 $resolved_bind->[$_][1]
2091 $value_type_by_col_idx->{$col_idx} = undef;
2093 $proto_data->{$colname} = \[ '?', [
2094 { dbic_colname => $colname, _bind_data_slice_idx => $col_idx }
2096 $data->[0][$col_idx]
2101 my ($sql, $proto_bind) = $self->_prep_for_execute (
2107 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2108 # if the bindlist is empty and we had some dynamic binds, this means the
2109 # storage ate them away (e.g. the NoBindVars component) and interpolated
2110 # them directly into the SQL. This obviously can't be good for multi-inserts
2111 $self->throw_exception('Unable to invoke fast-path insert without storage placeholder support');
2115 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2117 # use an error reporting closure for convenience (less to pass)
2118 my $bad_slice_report_cref = sub {
2119 my ($msg, $r_idx, $c_idx) = @_;
2120 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2124 require Data::Dumper::Concise;
2125 local $Data::Dumper::Maxdepth = 5;
2126 Data::Dumper::Concise::Dumper ({
2127 map { $cols->[$_] =>
2135 for my $col_idx (0..$#$cols) {
2136 my $reference_val = $data->[0][$col_idx];
2138 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2139 my $val = $data->[$row_idx][$col_idx];
2141 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2142 if (ref $val ne 'SCALAR') {
2143 $bad_slice_report_cref->(
2144 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2149 elsif ($$val ne $$reference_val) {
2150 $bad_slice_report_cref->(
2151 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2157 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2158 if (is_literal_value($val)) {
2159 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2162 else { # binds from a \[], compare type and attrs
2163 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2164 $bad_slice_report_cref->(
2165 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2170 # start drilling down and bail out early on identical refs
2172 $reference_val != $val
2174 $$reference_val != $$val
2176 if (${$val}->[0] ne ${$reference_val}->[0]) {
2177 $bad_slice_report_cref->(
2178 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2183 # need to check the bind attrs - a bind will happen only once for
2184 # the entire dataset, so any changes further down will be ignored.
2185 elsif (! Data::Compare::Compare(
2186 $value_type_by_col_idx->{$col_idx},
2190 @{$self->_resolve_bindattrs(
2191 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2195 $bad_slice_report_cref->(
2196 'Differing bind attributes on literal/bind values not supported',
2206 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2207 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2209 my $guard = $self->txn_scope_guard;
2211 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2212 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2215 # proto bind contains the information on which pieces of $data to pull
2216 # $cols is passed in only for prettier error-reporting
2217 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2220 # bind_param_array doesn't work if there are no binds
2221 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2225 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2229 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2232 # execute_for_fetch is capable of returning data just fine (it means it
2233 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2234 # is the void-populate fast-path we will just ignore this altogether
2235 # for the time being.
2236 sub _dbh_execute_for_fetch {
2237 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2239 # If we have any bind attributes to take care of, we will bind the
2240 # proto-bind data (which will never be used by execute_for_fetch)
2241 # However since column bindtypes are "sticky", this is sufficient
2242 # to get the DBD to apply the bindtype to all values later on
2243 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2245 for my $i (0 .. $#$proto_bind) {
2247 $i+1, # DBI bind indexes are 1-based
2248 $proto_bind->[$i][1],
2250 ) if defined $bind_attrs->[$i];
2253 # At this point $data slots named in the _bind_data_slice_idx of
2254 # each piece of $proto_bind are either \[]s or plain values to be
2255 # passed in. Construct the dispensing coderef. *NOTE* the order
2256 # of $data will differ from this of the ?s in the SQL (due to
2257 # alphabetical ordering by colname). We actually do want to
2258 # preserve this behavior so that prepare_cached has a better
2259 # chance of matching on unrelated calls
2261 my $fetch_row_idx = -1; # saner loop this way
2262 my $fetch_tuple = sub {
2263 return undef if ++$fetch_row_idx > $#$data;
2266 my $v = ! defined $_->{_literal_bind_subindex}
2268 ? $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2270 # There are no attributes to resolve here - we already did everything
2271 # when we constructed proto_bind. However we still want to sanity-check
2272 # what the user supplied, so pass stuff through to the resolver *anyway*
2273 : $self->_resolve_bindattrs (
2274 undef, # a fake rsrc
2275 [ ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}->[ $_->{_literal_bind_subindex} ] ],
2276 {}, # a fake column_info bag
2280 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
2281 # For the time being forcibly stringify whatever is stringifiable
2282 (length ref $v and is_plain_value $v)
2286 } map { $_->[0] } @$proto_bind ];
2289 my $tuple_status = [];
2292 $rv = $sth->execute_for_fetch(
2301 # Not all DBDs are create equal. Some throw on error, some return
2302 # an undef $rv, and some set $sth->err - try whatever we can
2303 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2306 ( !defined $rv or $sth->err )
2309 # Statement must finish even if there was an exception.
2314 $err = shift unless defined $err
2319 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2321 $self->throw_exception("Unexpected populate error: $err")
2322 if ($i > $#$tuple_status);
2324 require Data::Dumper::Concise;
2325 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2326 ($tuple_status->[$i][1] || $err),
2327 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2334 sub _dbh_execute_inserts_with_no_binds {
2335 my ($self, $sth, $count) = @_;
2339 my $dbh = $self->_get_dbh;
2340 local $dbh->{RaiseError} = 1;
2341 local $dbh->{PrintError} = 0;
2343 $sth->execute foreach 1..$count;
2349 # Make sure statement is finished even if there was an exception.
2354 $err = shift unless defined $err;
2357 $self->throw_exception($err) if defined $err;
2363 #my ($self, $source, @args) = @_;
2364 shift->_execute('update', @_);
2369 #my ($self, $source, @args) = @_;
2370 shift->_execute('delete', @_);
2375 $self->_execute($self->_select_args(@_));
2378 sub _select_args_to_query {
2381 $self->throw_exception(
2382 "Unable to generate limited query representation with 'software_limit' enabled"
2383 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2385 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2386 # = $self->_select_args($ident, $select, $cond, $attrs);
2387 my ($op, $ident, @args) =
2388 $self->_select_args(@_);
2390 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2391 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2393 # reuse the bind arrayref
2394 unshift @{$bind}, "($sql)";
2399 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2401 # FIXME - that kind of caching would be nice to have
2402 # however currently we *may* pass the same $orig_attrs
2403 # with different ident/select/where
2404 # the whole interface needs to be rethought, since it
2405 # was centered around the flawed SQLA API. We can do
2406 # soooooo much better now. But that is also another
2409 # 'select', $orig_attrs->{!args_as_stored_at_the_end_of_this_method!}
2410 #) if $orig_attrs->{!args_as_stored_at_the_end_of_this_method!};
2412 my $sql_maker = $self->sql_maker;
2421 # Sanity check the attributes (SQLMaker does it too, but
2422 # in case of a software_limit we'll never reach there)
2423 if (defined $attrs->{offset}) {
2424 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2425 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2428 if (defined $attrs->{rows}) {
2429 $self->throw_exception("The rows attribute must be a positive integer if present")
2430 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2432 elsif ($attrs->{offset}) {
2433 # MySQL actually recommends this approach. I cringe.
2434 $attrs->{rows} = $sql_maker->__max_int;
2437 # see if we will need to tear the prefetch apart to satisfy group_by == select
2438 # this is *extremely tricky* to get right, I am still not sure I did
2440 my ($prefetch_needs_subquery, @limit_args);
2442 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2443 # we already know there is a valid group_by (we made it) and we know it is
2444 # intended to be based *only* on non-multi stuff
2445 # short circuit the group_by parsing below
2446 $prefetch_needs_subquery = 1;
2449 # The rationale is that even if we do *not* have collapse, we still
2450 # need to wrap the core grouped select/group_by in a subquery
2451 # so that databases that care about group_by/select equivalence
2452 # are happy (this includes MySQL in strict_mode)
2453 # If any of the other joined tables are referenced in the group_by
2454 # however - the user is on their own
2455 ( $prefetch_needs_subquery or ! $attrs->{_simple_passthrough_construction} )
2459 @{$attrs->{group_by}}
2461 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2462 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2465 # no aliases other than our own in group_by
2466 # if there are - do not allow subquery even if limit is present
2467 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2469 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2470 # active collapse with a limit - that one is a no-brainer unless
2471 # overruled by a group_by above
2472 $prefetch_needs_subquery = 1;
2475 if ($prefetch_needs_subquery) {
2476 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2478 elsif (! $attrs->{software_limit} ) {
2480 $attrs->{rows} || (),
2481 $attrs->{offset} || (),
2485 # try to simplify the joinmap further (prune unreferenced type-single joins)
2487 ! $prefetch_needs_subquery # already pruned
2491 reftype $attrs->{from} eq 'ARRAY'
2493 @{$attrs->{from}} != 1
2495 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2498 # FIXME this is a gross, inefficient, largely incorrect and fragile hack
2499 # during the result inflation stage we *need* to know what was the aliastype
2500 # map as sqla saw it when the final pieces of SQL were being assembled
2501 # Originally we simply carried around the entirety of $attrs, but this
2502 # resulted in resultsets that are being reused growing continuously, as
2503 # the hash in question grew deeper and deeper.
2504 # Instead hand-pick what to take with us here (we actually don't need much
2505 # at this point just the map itself)
2506 $orig_attrs->{_last_sqlmaker_alias_map} = $attrs->{_aliastypes};
2509 # my $alias2source = $self->_resolve_ident_sources ($ident);
2511 # This would be the point to deflate anything found in $attrs->{where}
2512 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2513 # expect a result object. And all we have is a resultsource (it is trivial
2514 # to extract deflator coderefs via $alias2source above).
2516 # I don't see a way forward other than changing the way deflators are
2517 # invoked, and that's just bad...
2520 return ( 'select', @{$attrs}{qw(from select where)}, $attrs, @limit_args );
2523 # Returns a counting SELECT for a simple count
2524 # query. Abstracted so that a storage could override
2525 # this to { count => 'firstcol' } or whatever makes
2526 # sense as a performance optimization
2528 #my ($self, $source, $rs_attrs) = @_;
2529 return { count => '*' };
2536 =item Arguments: $ident, $select, $condition, $attrs
2540 Handle a SQL select statement.
2546 my ($ident, $select, $condition, $attrs) = @_;
2547 return $self->cursor_class->new($self, \@_, $attrs);
2552 my ($rv, $sth, @bind) = $self->_select(@_);
2553 my @row = $sth->fetchrow_array;
2554 my @nextrow = $sth->fetchrow_array if @row;
2555 if(@row && @nextrow) {
2556 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2558 # Need to call finish() to work round broken DBDs
2563 =head2 sql_limit_dialect
2565 This is an accessor for the default SQL limit dialect used by a particular
2566 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2567 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2568 see L<DBIx::Class::SQLMaker::LimitDialects>.
2572 sub _dbh_columns_info_for {
2573 my ($self, $dbh, $table) = @_;
2575 if ($dbh->can('column_info')) {
2579 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2580 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2582 while ( my $info = $sth->fetchrow_hashref() ){
2584 $column_info{data_type} = $info->{TYPE_NAME};
2585 $column_info{size} = $info->{COLUMN_SIZE};
2586 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2587 $column_info{default_value} = $info->{COLUMN_DEF};
2588 my $col_name = $info->{COLUMN_NAME};
2589 $col_name =~ s/^\"(.*)\"$/$1/;
2591 $result{$col_name} = \%column_info;
2596 return \%result if !$caught && scalar keys %result;
2600 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2602 my @columns = @{$sth->{NAME_lc}};
2603 for my $i ( 0 .. $#columns ){
2605 $column_info{data_type} = $sth->{TYPE}->[$i];
2606 $column_info{size} = $sth->{PRECISION}->[$i];
2607 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2609 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2610 $column_info{data_type} = $1;
2611 $column_info{size} = $2;
2614 $result{$columns[$i]} = \%column_info;
2618 foreach my $col (keys %result) {
2619 my $colinfo = $result{$col};
2620 my $type_num = $colinfo->{data_type};
2622 if(defined $type_num && $dbh->can('type_info')) {
2623 my $type_info = $dbh->type_info($type_num);
2624 $type_name = $type_info->{TYPE_NAME} if $type_info;
2625 $colinfo->{data_type} = $type_name if $type_name;
2632 sub columns_info_for {
2633 my ($self, $table) = @_;
2634 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2637 =head2 last_insert_id
2639 Return the row id of the last insert.
2643 sub _dbh_last_insert_id {
2644 my ($self, $dbh, $source, $col) = @_;
2646 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2648 return $id if defined $id;
2650 my $class = ref $self;
2651 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2654 sub last_insert_id {
2656 $self->_dbh_last_insert_id ($self->_dbh, @_);
2659 =head2 _native_data_type
2663 =item Arguments: $type_name
2667 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2668 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2669 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2671 The default implementation returns C<undef>, implement in your Storage driver if
2672 you need this functionality.
2674 Should map types from other databases to the native RDBMS type, for example
2675 C<VARCHAR2> to C<VARCHAR>.
2677 Types with modifiers should map to the underlying data type. For example,
2678 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2680 Composite types should map to the container type, for example
2681 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2685 sub _native_data_type {
2686 #my ($self, $data_type) = @_;
2690 # Check if placeholders are supported at all
2691 sub _determine_supports_placeholders {
2693 my $dbh = $self->_get_dbh;
2695 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2696 # but it is inaccurate more often than not
2698 local $dbh->{PrintError} = 0;
2699 local $dbh->{RaiseError} = 1;
2700 $dbh->do('select ?', {}, 1);
2708 # Check if placeholders bound to non-string types throw exceptions
2710 sub _determine_supports_typeless_placeholders {
2712 my $dbh = $self->_get_dbh;
2715 local $dbh->{PrintError} = 0;
2716 local $dbh->{RaiseError} = 1;
2717 # this specifically tests a bind that is NOT a string
2718 $dbh->do('select 1 where 1 = ?', {}, 1);
2728 Returns the database driver name.
2733 shift->_get_dbh->{Driver}->{Name};
2736 =head2 bind_attribute_by_data_type
2738 Given a datatype from column info, returns a database specific bind
2739 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2740 let the database planner just handle it.
2742 This method is always called after the driver has been determined and a DBI
2743 connection has been established. Therefore you can refer to C<DBI::$constant>
2744 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2745 the correct modules.
2749 sub bind_attribute_by_data_type {
2753 =head2 is_datatype_numeric
2755 Given a datatype from column_info, returns a boolean value indicating if
2756 the current RDBMS considers it a numeric value. This controls how
2757 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2758 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2759 be performed instead of the usual C<eq>.
2763 sub is_datatype_numeric {
2764 #my ($self, $dt) = @_;
2766 return 0 unless $_[1];
2769 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2774 =head2 create_ddl_dir
2778 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2782 Creates a SQL file based on the Schema, for each of the specified
2783 database engines in C<\@databases> in the given directory.
2784 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2786 Given a previous version number, this will also create a file containing
2787 the ALTER TABLE statements to transform the previous schema into the
2788 current one. Note that these statements may contain C<DROP TABLE> or
2789 C<DROP COLUMN> statements that can potentially destroy data.
2791 The file names are created using the C<ddl_filename> method below, please
2792 override this method in your schema if you would like a different file
2793 name format. For the ALTER file, the same format is used, replacing
2794 $version in the name with "$preversion-$version".
2796 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2797 The most common value for this would be C<< { add_drop_table => 1 } >>
2798 to have the SQL produced include a C<DROP TABLE> statement for each table
2799 created. For quoting purposes supply C<quote_identifiers>.
2801 If no arguments are passed, then the following default values are assumed:
2805 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2807 =item version - $schema->schema_version
2809 =item directory - './'
2811 =item preversion - <none>
2815 By default, C<\%sqlt_args> will have
2817 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2819 merged with the hash passed in. To disable any of those features, pass in a
2820 hashref like the following
2822 { ignore_constraint_names => 0, # ... other options }
2825 WARNING: You are strongly advised to check all SQL files created, before applying
2830 sub create_ddl_dir {
2831 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2834 carp "No directory given, using ./\n";
2839 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2841 $self->throw_exception(
2842 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2846 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2848 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2849 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2851 my $schema_version = $schema->schema_version || '1.x';
2852 $version ||= $schema_version;
2855 add_drop_table => 1,
2856 ignore_constraint_names => 1,
2857 ignore_index_names => 1,
2858 quote_identifiers => $self->sql_maker->_quoting_enabled,
2862 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2863 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2866 my $sqlt = SQL::Translator->new( $sqltargs );
2868 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2869 my $sqlt_schema = $sqlt->translate({ data => $schema })
2870 or $self->throw_exception ($sqlt->error);
2872 foreach my $db (@$databases) {
2874 $sqlt->{schema} = $sqlt_schema;
2875 $sqlt->producer($db);
2878 my $filename = $schema->ddl_filename($db, $version, $dir);
2879 if (-e $filename && ($version eq $schema_version )) {
2880 # if we are dumping the current version, overwrite the DDL
2881 carp "Overwriting existing DDL file - $filename";
2885 my $output = $sqlt->translate;
2887 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2890 if(!open($file, ">$filename")) {
2891 $self->throw_exception("Can't open $filename for writing ($!)");
2894 print $file $output;
2897 next unless ($preversion);
2899 require SQL::Translator::Diff;
2901 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2902 if(!-e $prefilename) {
2903 carp("No previous schema file found ($prefilename)");
2907 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2909 carp("Overwriting existing diff file - $difffile");
2915 my $t = SQL::Translator->new($sqltargs);
2920 or $self->throw_exception ($t->error);
2922 my $out = $t->translate( $prefilename )
2923 or $self->throw_exception ($t->error);
2925 $source_schema = $t->schema;
2927 $source_schema->name( $prefilename )
2928 unless ( $source_schema->name );
2931 # The "new" style of producers have sane normalization and can support
2932 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2933 # And we have to diff parsed SQL against parsed SQL.
2934 my $dest_schema = $sqlt_schema;
2936 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2937 my $t = SQL::Translator->new($sqltargs);
2942 or $self->throw_exception ($t->error);
2944 my $out = $t->translate( $filename )
2945 or $self->throw_exception ($t->error);
2947 $dest_schema = $t->schema;
2949 $dest_schema->name( $filename )
2950 unless $dest_schema->name;
2954 # FIXME - this is a terrible workaround for
2955 # https://github.com/dbsrgits/sql-translator/commit/2d23c1e
2956 # Fixing it in this sloppy manner so that we don't hve to
2957 # lockstep an SQLT release as well. Needs to be removed at
2958 # some point, and SQLT dep bumped
2959 local $SQL::Translator::Producer::SQLite::NO_QUOTES
2960 if $SQL::Translator::Producer::SQLite::NO_QUOTES;
2962 SQL::Translator::Diff::schema_diff($source_schema, $db,
2968 if(!open $file, ">$difffile") {
2969 $self->throw_exception("Can't write to $difffile ($!)");
2977 =head2 deployment_statements
2981 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2985 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2987 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2988 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2990 C<$directory> is used to return statements from files in a previously created
2991 L</create_ddl_dir> directory and is optional. The filenames are constructed
2992 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2994 If no C<$directory> is specified then the statements are constructed on the
2995 fly using L<SQL::Translator> and C<$version> is ignored.
2997 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
3001 sub deployment_statements {
3002 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
3003 $type ||= $self->sqlt_type;
3004 $version ||= $schema->schema_version || '1.x';
3006 my $filename = $schema->ddl_filename($type, $version, $dir);
3009 # FIXME replace this block when a proper sane sql parser is available
3011 open($file, "<$filename")
3012 or $self->throw_exception("Can't open $filename ($!)");
3015 return join('', @rows);
3018 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
3019 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
3022 # sources needs to be a parser arg, but for simplicity allow at top level
3024 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
3025 if exists $sqltargs->{sources};
3027 $sqltargs->{quote_identifiers} = $self->sql_maker->_quoting_enabled
3028 unless exists $sqltargs->{quote_identifiers};
3030 my $tr = SQL::Translator->new(
3031 producer => "SQL::Translator::Producer::${type}",
3033 parser => 'SQL::Translator::Parser::DBIx::Class',
3037 return preserve_context {
3040 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
3041 unless defined $_[0];
3045 # FIXME deploy() currently does not accurately report sql errors
3046 # Will always return true while errors are warned
3048 my ($self, $schema, $type, $sqltargs, $dir) = @_;
3052 return if($line =~ /^--/);
3053 # next if($line =~ /^DROP/m);
3054 return if($line =~ /^BEGIN TRANSACTION/m);
3055 return if($line =~ /^COMMIT/m);
3056 return if $line =~ /^\s+$/; # skip whitespace only
3057 $self->_query_start($line);
3059 # do a dbh_do cycle here, as we need some error checking in
3060 # place (even though we will ignore errors)
3061 $self->dbh_do (sub { $_[1]->do($line) });
3063 carp qq{$_ (running "${line}")};
3065 $self->_query_end($line);
3067 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
3068 if (@statements > 1) {
3069 foreach my $statement (@statements) {
3070 $deploy->( $statement );
3073 elsif (@statements == 1) {
3074 # split on single line comments and end of statements
3075 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3081 =head2 datetime_parser
3083 Returns the datetime parser class
3087 sub datetime_parser {
3089 return $self->{datetime_parser} ||= do {
3090 $self->build_datetime_parser(@_);
3094 =head2 datetime_parser_type
3096 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3098 =head2 build_datetime_parser
3100 See L</datetime_parser>
3104 sub build_datetime_parser {
3106 my $type = $self->datetime_parser_type(@_);
3111 =head2 is_replicating
3113 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3114 replicate from a master database. Default is undef, which is the result
3115 returned by databases that don't support replication.
3119 sub is_replicating {
3124 =head2 lag_behind_master
3126 Returns a number that represents a certain amount of lag behind a master db
3127 when a given storage is replicating. The number is database dependent, but
3128 starts at zero and increases with the amount of lag. Default in undef
3132 sub lag_behind_master {
3136 =head2 relname_to_table_alias
3140 =item Arguments: $relname, $join_count
3142 =item Return Value: $alias
3146 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3149 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3150 way these aliases are named.
3152 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3153 otherwise C<"$relname">.
3157 sub relname_to_table_alias {
3158 my ($self, $relname, $join_count) = @_;
3160 my $alias = ($join_count && $join_count > 1 ?
3161 join('_', $relname, $join_count) : $relname);
3166 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3167 # version and it may be necessary to amend or override it for a specific storage
3168 # if such binds are necessary.
3169 sub _max_column_bytesize {
3170 my ($self, $attr) = @_;
3174 if ($attr->{sqlt_datatype}) {
3175 my $data_type = lc($attr->{sqlt_datatype});
3177 if ($attr->{sqlt_size}) {
3179 # String/sized-binary types
3180 if ($data_type =~ /^(?:
3181 l? (?:var)? char(?:acter)? (?:\s*varying)?
3183 (?:var)? binary (?:\s*varying)?
3188 $max_size = $attr->{sqlt_size};
3190 # Other charset/unicode types, assume scale of 4
3191 elsif ($data_type =~ /^(?:
3192 national \s* character (?:\s*varying)?
3201 $max_size = $attr->{sqlt_size} * 4;
3205 if (!$max_size and !$self->_is_lob_type($data_type)) {
3206 $max_size = 100 # for all other (numeric?) datatypes
3210 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3213 # Determine if a data_type is some type of BLOB
3215 my ($self, $data_type) = @_;
3216 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3217 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3218 |varchar|character\s*varying|nvarchar
3219 |national\s*character\s*varying))?\z/xi);
3222 sub _is_binary_lob_type {
3223 my ($self, $data_type) = @_;
3224 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3225 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3228 sub _is_text_lob_type {
3229 my ($self, $data_type) = @_;
3230 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3231 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3232 |national\s*character\s*varying))\z/xi);
3235 # Determine if a data_type is some type of a binary type
3236 sub _is_binary_type {
3237 my ($self, $data_type) = @_;
3238 $data_type && ($self->_is_binary_lob_type($data_type)
3239 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3246 =head2 DBIx::Class and AutoCommit
3248 DBIx::Class can do some wonderful magic with handling exceptions,
3249 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3250 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3251 transaction support.
3253 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3254 in an assumed transaction between commits, and you're telling us you'd
3255 like to manage that manually. A lot of the magic protections offered by
3256 this module will go away. We can't protect you from exceptions due to database
3257 disconnects because we don't know anything about how to restart your
3258 transactions. You're on your own for handling all sorts of exceptional
3259 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3263 =head1 AUTHOR AND CONTRIBUTORS
3265 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3269 You may distribute this code under the same terms as Perl itself.