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 SQL::Abstract qw(is_plain_value is_literal_value);
16 use DBIx::Class::_Util qw(quote_sub perlstring serialize);
19 # default cursor class, overridable in connect_info attributes
20 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
22 __PACKAGE__->mk_group_accessors('inherited' => qw/
23 sql_limit_dialect sql_quote_char sql_name_sep
26 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
28 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
29 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
31 __PACKAGE__->sql_name_sep('.');
33 __PACKAGE__->mk_group_accessors('simple' => qw/
34 _connect_info _dbic_connect_attributes _driver_determined
35 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
36 _perform_autoinc_retrieval _autoinc_supplied_for_op
39 # the values for these accessors are picked out (and deleted) from
40 # the attribute hashref passed to connect_info
41 my @storage_options = qw/
42 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
43 disable_sth_caching unsafe auto_savepoint
45 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
48 # capability definitions, using a 2-tiered accessor system
51 # A driver/user may define _use_X, which blindly without any checks says:
52 # "(do not) use this capability", (use_dbms_capability is an "inherited"
55 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
56 # accessor, which in turn calls _determine_supports_X, and stores the return
57 # in a special slot on the storage object, which is wiped every time a $dbh
58 # reconnection takes place (it is not guaranteed that upon reconnection we
59 # will get the same rdbms version). _determine_supports_X does not need to
60 # exist on a driver, as we ->can for it before calling.
62 my @capabilities = (qw/
64 insert_returning_bound
73 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
74 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
76 # on by default, not strictly a capability (pending rewrite)
77 __PACKAGE__->_use_join_optimizer (1);
78 sub _determine_supports_join_optimizer { 1 };
80 # Each of these methods need _determine_driver called before itself
81 # in order to function reliably. We also need to separate accessors
82 # from plain old method calls, since an accessor called as a setter
83 # does *not* need the driver determination loop fired (and in fact
84 # can produce hard to find bugs, like e.g. losing on_connect_*
85 # semantics on fresh connections)
87 # The construct below is simply a parameterized around()
88 my $storage_accessor_idx = { map { $_ => 1 } qw(
95 for my $meth (keys %$storage_accessor_idx, qw(
110 with_deferred_fk_checks
112 get_use_dbms_capability
119 my $orig = __PACKAGE__->can ($meth)
120 or die "$meth is not a ::Storage::DBI method!";
122 my $is_getter = $storage_accessor_idx->{$meth} ? 0 : 1;
125 __PACKAGE__ ."::$meth", sprintf( <<'EOC', $is_getter, perlstring $meth ), { '$orig' => \$orig };
128 # only fire when invoked on an instance, a valid class-based invocation
129 # would e.g. be setting a default for an inherited accessor
132 ! $_[0]->{_driver_determined}
134 ! $_[0]->{_in_determine_driver}
136 # if this is a known *setter* - just set it, no need to connect
137 # and determine the driver
140 # Only try to determine stuff if we have *something* that either is or can
141 # provide a DSN. Allows for bare $schema's generated with a plain ->connect()
142 # to still be marginally useful
143 $_[0]->_dbi_connect_info->[0]
145 $_[0]->_determine_driver;
147 # work around http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
148 goto $_[0]->can(%2$s) unless DBIx::Class::_ENV_::BROKEN_GOTO;
150 my $cref = $_[0]->can(%2$s);
160 DBIx::Class::Storage::DBI - DBI storage handler
164 my $schema = MySchema->connect('dbi:SQLite:my.db');
166 $schema->storage->debug(1);
168 my @stuff = $schema->storage->dbh_do(
170 my ($storage, $dbh, @args) = @_;
171 $dbh->do("DROP TABLE authors");
176 $schema->resultset('Book')->search({
177 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
182 This class represents the connection to an RDBMS via L<DBI>. See
183 L<DBIx::Class::Storage> for general information. This pod only
184 documents DBI-specific methods and behaviors.
191 my $new = shift->next::method(@_);
193 $new->_sql_maker_opts({});
194 $new->_dbh_details({});
195 $new->{_in_do_block} = 0;
197 # read below to see what this does
198 $new->_arm_global_destructor;
203 # This is hack to work around perl shooting stuff in random
204 # order on exit(). If we do not walk the remaining storage
205 # objects in an END block, there is a *small but real* chance
206 # of a fork()ed child to kill the parent's shared DBI handle,
207 # *before perl reaches the DESTROY in this package*
208 # Yes, it is ugly and effective.
209 # Additionally this registry is used by the CLONE method to
210 # make sure no handles are shared between threads
212 my %seek_and_destroy;
214 sub _arm_global_destructor {
216 # quick "garbage collection" pass - prevents the registry
217 # from slowly growing with a bunch of undef-valued keys
218 defined $seek_and_destroy{$_} or delete $seek_and_destroy{$_}
219 for keys %seek_and_destroy;
222 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
227 local $?; # just in case the DBI destructor changes it somehow
229 # destroy just the object if not native to this process
230 $_->_verify_pid for (grep
232 values %seek_and_destroy
237 # As per DBI's recommendation, DBIC disconnects all handles as
238 # soon as possible (DBIC will reconnect only on demand from within
240 my @instances = grep { defined $_ } values %seek_and_destroy;
241 %seek_and_destroy = ();
246 $_->transaction_depth(0);
249 # properly renumber existing refs
250 $_->_arm_global_destructor
256 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
257 # some databases spew warnings on implicit disconnect
258 local $SIG{__WARN__} = sub {};
261 # this op is necessary, since the very last perl runtime statement
262 # triggers a global destruction shootout, and the $SIG localization
263 # may very well be destroyed before perl actually gets to do the
268 # handle pid changes correctly - do not destroy parent's connection
271 my $pid = $_[0]->_conn_pid;
273 if( defined $pid and $pid != $$ and my $dbh = $_[0]->_dbh ) {
274 $dbh->{InactiveDestroy} = 1;
276 $_[0]->transaction_depth(0);
277 $_[0]->savepoints([]);
285 This method is normally called by L<DBIx::Class::Schema/connection>, which
286 encapsulates its argument list in an arrayref before passing them here.
288 The argument list may contain:
294 The same 4-element argument set one would normally pass to
295 L<DBI/connect>, optionally followed by
296 L<extra attributes|/DBIx::Class specific connection attributes>
297 recognized by DBIx::Class:
299 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
303 A single code reference which returns a connected
304 L<DBI database handle|DBI/connect> optionally followed by
305 L<extra attributes|/DBIx::Class specific connection attributes> recognized
308 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
312 A single hashref with all the attributes and the dsn/user/password
315 $connect_info_args = [{
323 $connect_info_args = [{
324 dbh_maker => sub { DBI->connect (...) },
329 This is particularly useful for L<Catalyst> based applications, allowing the
330 following config (L<Config::General> style):
335 dsn dbi:mysql:database=test
342 The C<dsn>/C<user>/C<password> combination can be substituted by the
343 C<dbh_maker> key whose value is a coderef that returns a connected
344 L<DBI database handle|DBI/connect>
348 Please note that the L<DBI> docs recommend that you always explicitly
349 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
350 recommends that it be set to I<1>, and that you perform transactions
351 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
352 to I<1> if you do not do explicitly set it to zero. This is the default
353 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
355 =head3 DBIx::Class specific connection attributes
357 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
358 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
359 the following connection options. These options can be mixed in with your other
360 L<DBI> connection attributes, or placed in a separate hashref
361 (C<\%extra_attributes>) as shown above.
363 Every time C<connect_info> is invoked, any previous settings for
364 these options will be cleared before setting the new ones, regardless of
365 whether any options are specified in the new C<connect_info>.
372 Specifies things to do immediately after connecting or re-connecting to
373 the database. Its value may contain:
379 This contains one SQL statement to execute.
381 =item an array reference
383 This contains SQL statements to execute in order. Each element contains
384 a string or a code reference that returns a string.
386 =item a code reference
388 This contains some code to execute. Unlike code references within an
389 array reference, its return value is ignored.
393 =item on_disconnect_do
395 Takes arguments in the same form as L</on_connect_do> and executes them
396 immediately before disconnecting from the database.
398 Note, this only runs if you explicitly call L</disconnect> on the
401 =item on_connect_call
403 A more generalized form of L</on_connect_do> that calls the specified
404 C<connect_call_METHOD> methods in your storage driver.
406 on_connect_do => 'select 1'
410 on_connect_call => [ [ do_sql => 'select 1' ] ]
412 Its values may contain:
418 Will call the C<connect_call_METHOD> method.
420 =item a code reference
422 Will execute C<< $code->($storage) >>
424 =item an array reference
426 Each value can be a method name or code reference.
428 =item an array of arrays
430 For each array, the first item is taken to be the C<connect_call_> method name
431 or code reference, and the rest are parameters to it.
435 Some predefined storage methods you may use:
441 Executes a SQL string or a code reference that returns a SQL string. This is
442 what L</on_connect_do> and L</on_disconnect_do> use.
450 Will execute the scalar as SQL.
454 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
455 attributes hashref and bind values.
457 =item a code reference
459 Will execute C<< $code->($storage) >> and execute the return array refs as
466 Execute any statements necessary to initialize the database session to return
467 and accept datetime/timestamp values used with
468 L<DBIx::Class::InflateColumn::DateTime>.
470 Only necessary for some databases, see your specific storage driver for
471 implementation details.
475 =item on_disconnect_call
477 Takes arguments in the same form as L</on_connect_call> and executes them
478 immediately before disconnecting from the database.
480 Calls the C<disconnect_call_METHOD> methods as opposed to the
481 C<connect_call_METHOD> methods called by L</on_connect_call>.
483 Note, this only runs if you explicitly call L</disconnect> on the
486 =item disable_sth_caching
488 If set to a true value, this option will disable the caching of
489 statement handles via L<DBI/prepare_cached>.
493 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
494 default L</sql_limit_dialect> setting of the storage (if any). For a list
495 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
499 When true automatically sets L</quote_char> and L</name_sep> to the characters
500 appropriate for your particular RDBMS. This option is preferred over specifying
501 L</quote_char> directly.
505 Specifies what characters to use to quote table and column names.
507 C<quote_char> expects either a single character, in which case is it
508 is placed on either side of the table/column name, or an arrayref of length
509 2 in which case the table/column name is placed between the elements.
511 For example under MySQL you should use C<< quote_char => '`' >>, and for
512 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
516 This parameter is only useful in conjunction with C<quote_char>, and is used to
517 specify the character that separates elements (schemas, tables, columns) from
518 each other. If unspecified it defaults to the most commonly used C<.>.
522 This Storage driver normally installs its own C<HandleError>, sets
523 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
524 all database handles, including those supplied by a coderef. It does this
525 so that it can have consistent and useful error behavior.
527 If you set this option to a true value, Storage will not do its usual
528 modifications to the database handle's attributes, and instead relies on
529 the settings in your connect_info DBI options (or the values you set in
530 your connection coderef, in the case that you are connecting via coderef).
532 Note that your custom settings can cause Storage to malfunction,
533 especially if you set a C<HandleError> handler that suppresses exceptions
534 and/or disable C<RaiseError>.
538 If this option is true, L<DBIx::Class> will use savepoints when nesting
539 transactions, making it possible to recover from failure in the inner
540 transaction without having to abort all outer transactions.
544 Use this argument to supply a cursor class other than the default
545 L<DBIx::Class::Storage::DBI::Cursor>.
549 Some real-life examples of arguments to L</connect_info> and
550 L<DBIx::Class::Schema/connect>
552 # Simple SQLite connection
553 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
556 ->connect_info([ sub { DBI->connect(...) } ]);
558 # Connect via subref in hashref
560 dbh_maker => sub { DBI->connect(...) },
561 on_connect_do => 'alter session ...',
564 # A bit more complicated
571 { quote_char => q{"} },
575 # Equivalent to the previous example
581 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
585 # Same, but with hashref as argument
586 # See parse_connect_info for explanation
589 dsn => 'dbi:Pg:dbname=foo',
591 password => 'my_pg_password',
598 # Subref + DBIx::Class-specific connection options
601 sub { DBI->connect(...) },
605 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
606 disable_sth_caching => 1,
616 my ($self, $info) = @_;
618 return $self->_connect_info if !$info;
620 $self->_connect_info($info); # copy for _connect_info
622 $info = $self->_normalize_connect_info($info)
623 if ref $info eq 'ARRAY';
626 %{ $self->_default_dbi_connect_attributes || {} },
627 %{ $info->{attributes} || {} },
630 my @args = @{ $info->{arguments} };
632 if (keys %attrs and ref $args[0] ne 'CODE') {
634 'You provided explicit AutoCommit => 0 in your connection_info. '
635 . 'This is almost universally a bad idea (see the footnotes of '
636 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
637 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
639 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
641 push @args, \%attrs if keys %attrs;
644 # this is the authoritative "always an arrayref" thing fed to DBI->connect
645 # OR a single-element coderef-based $dbh factory
646 $self->_dbi_connect_info(\@args);
648 # extract the individual storage options
649 for my $storage_opt (keys %{ $info->{storage_options} }) {
650 my $value = $info->{storage_options}{$storage_opt};
652 $self->$storage_opt($value);
655 # Extract the individual sqlmaker options
657 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
658 # the new set of options
659 $self->_sql_maker(undef);
660 $self->_sql_maker_opts({});
662 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
663 my $value = $info->{sql_maker_options}{$sql_maker_opt};
665 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
669 # save attributes in a separate accessor so they are always
670 # introspectable, even in case of a CODE $dbhmaker
671 $self->_dbic_connect_attributes (\%attrs);
673 return $self->_connect_info;
676 sub _dbi_connect_info {
679 return $self->{_dbi_connect_info} = $_[0]
682 my $conninfo = $self->{_dbi_connect_info} || [];
684 # last ditch effort to grab a DSN
685 if ( ! defined $conninfo->[0] and $ENV{DBI_DSN} ) {
686 my @new_conninfo = @$conninfo;
687 $new_conninfo[0] = $ENV{DBI_DSN};
688 $conninfo = \@new_conninfo;
695 sub _normalize_connect_info {
696 my ($self, $info_arg) = @_;
699 my @args = @$info_arg; # take a shallow copy for further mutilation
701 # combine/pre-parse arguments depending on invocation style
704 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
705 %attrs = %{ $args[1] || {} };
708 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
709 %attrs = %{$args[0]};
711 if (my $code = delete $attrs{dbh_maker}) {
714 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
717 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
718 . "to the result of 'dbh_maker'",
720 join (', ', map { "'$_'" } (@ignored) ),
725 @args = delete @attrs{qw/dsn user password/};
728 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
730 % { $args[3] || {} },
731 % { $args[4] || {} },
733 @args = @args[0,1,2];
736 $info{arguments} = \@args;
738 my @storage_opts = grep exists $attrs{$_},
739 @storage_options, 'cursor_class';
741 @{ $info{storage_options} }{@storage_opts} =
742 delete @attrs{@storage_opts} if @storage_opts;
744 my @sql_maker_opts = grep exists $attrs{$_},
745 qw/limit_dialect quote_char name_sep quote_names/;
747 @{ $info{sql_maker_options} }{@sql_maker_opts} =
748 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
750 $info{attributes} = \%attrs if %attrs;
755 sub _default_dbi_connect_attributes () {
760 ShowErrorStatement => 1,
766 This method is deprecated in favour of setting via L</connect_info>.
770 =head2 on_disconnect_do
772 This method is deprecated in favour of setting via L</connect_info>.
776 sub _parse_connect_do {
777 my ($self, $type) = @_;
779 my $val = $self->$type;
780 return () if not defined $val;
785 push @res, [ 'do_sql', $val ];
786 } elsif (ref($val) eq 'CODE') {
788 } elsif (ref($val) eq 'ARRAY') {
789 push @res, map { [ 'do_sql', $_ ] } @$val;
791 $self->throw_exception("Invalid type for $type: ".ref($val));
799 Arguments: ($subref | $method_name), @extra_coderef_args?
801 Execute the given $subref or $method_name using the new exception-based
802 connection management.
804 The first two arguments will be the storage object that C<dbh_do> was called
805 on and a database handle to use. Any additional arguments will be passed
806 verbatim to the called subref as arguments 2 and onwards.
808 Using this (instead of $self->_dbh or $self->dbh) ensures correct
809 exception handling and reconnection (or failover in future subclasses).
811 Your subref should have no side-effects outside of the database, as
812 there is the potential for your subref to be partially double-executed
813 if the database connection was stale/dysfunctional.
817 my @stuff = $schema->storage->dbh_do(
819 my ($storage, $dbh, @cols) = @_;
820 my $cols = join(q{, }, @cols);
821 $dbh->selectrow_array("SELECT $cols FROM foo");
830 my $run_target = shift; # either a coderef or a method name
832 # short circuit when we know there is no need for a runner
834 # FIXME - assumption may be wrong
835 # the rationale for the txn_depth check is that if this block is a part
836 # of a larger transaction, everything up to that point is screwed anyway
837 return $self->$run_target($self->_get_dbh, @_)
838 if $self->{_in_do_block} or $self->transaction_depth;
840 # take a ref instead of a copy, to preserve @_ aliasing
841 # semantics within the coderef, but only if needed
842 # (pseudoforking doesn't like this trick much)
843 my $args = @_ ? \@_ : [];
845 DBIx::Class::Storage::BlockRunner->new(
848 retry_handler => sub {
849 $_[0]->failed_attempt_count == 1
851 ! $_[0]->storage->connected
854 $self->$run_target ($self->_get_dbh, @$args )
859 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
860 shift->next::method(@_);
865 Our C<disconnect> method also performs a rollback first if the
866 database is not in C<AutoCommit> mode.
872 if( my $dbh = $_[0]->_dbh ) {
874 $_[0]->_do_connection_actions(disconnect_call_ => $_) for (
875 ( $_[0]->on_disconnect_call || () ),
876 $_[0]->_parse_connect_do ('on_disconnect_do')
879 # stops the "implicit rollback on disconnect" warning
880 $_[0]->_exec_txn_rollback unless $_[0]->_dbh_autocommit;
882 %{ $dbh->{CachedKids} } = ();
888 =head2 with_deferred_fk_checks
892 =item Arguments: C<$coderef>
894 =item Return Value: The return value of $coderef
898 Storage specific method to run the code ref with FK checks deferred or
899 in MySQL's case disabled entirely.
903 # Storage subclasses should override this
904 sub with_deferred_fk_checks {
905 #my ($self, $sub) = @_;
913 =item Arguments: none
915 =item Return Value: 1|0
919 Verifies that the current database handle is active and ready to execute
920 an SQL statement (e.g. the connection did not get stale, server is still
921 answering, etc.) This method is used internally by L</dbh>.
926 return 0 unless $_[0]->_seems_connected;
929 local $_[0]->_dbh->{RaiseError} = 1;
934 sub _seems_connected {
935 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
937 ($_[0]->_dbh || return 0)->FETCH('Active');
941 ($_[0]->_dbh || return 0)->ping;
944 sub ensure_connected {
945 $_[0]->connected || ( $_[0]->_populate_dbh && 1 );
950 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
951 is guaranteed to be healthy by implicitly calling L</connected>, and if
952 necessary performing a reconnection before returning. Keep in mind that this
953 is very B<expensive> on some database engines. Consider using L</dbh_do>
959 # maybe save a ping call
961 ? ( $_[0]->ensure_connected and $_[0]->_dbh )
962 : $_[0]->_populate_dbh
966 # this is the internal "get dbh or connect (don't check)" method
968 $_[0]->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
969 $_[0]->_dbh || $_[0]->_populate_dbh;
972 # *DELIBERATELY* not a setter (for the time being)
973 # Too intertwined with everything else for any kind of sanity
977 $self->throw_exception('sql_maker() is not a setter method') if @_;
979 unless ($self->_sql_maker) {
980 my $sql_maker_class = $self->sql_maker_class;
982 my %opts = %{$self->_sql_maker_opts||{}};
986 $self->sql_limit_dialect
989 my $s_class = (ref $self) || $self;
991 "Your storage class ($s_class) does not set sql_limit_dialect and you "
992 . 'have not supplied an explicit limit_dialect in your connection_info. '
993 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
994 . 'databases but can be (and often is) painfully slow. '
995 . "Please file an RT ticket against '$s_class'"
996 ) if $self->_dbi_connect_info->[0];
1002 my ($quote_char, $name_sep);
1004 if ($opts{quote_names}) {
1005 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
1006 my $s_class = (ref $self) || $self;
1008 "You requested 'quote_names' but your storage class ($s_class) does "
1009 . 'not explicitly define a default sql_quote_char and you have not '
1010 . 'supplied a quote_char as part of your connection_info. DBIC will '
1011 .q{default to the ANSI SQL standard quote '"', which works most of }
1012 . "the time. Please file an RT ticket against '$s_class'."
1018 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1021 $self->_sql_maker($sql_maker_class->new(
1022 bindtype=>'columns',
1023 array_datatypes => 1,
1024 limit_dialect => $dialect,
1025 ($quote_char ? (quote_char => $quote_char) : ()),
1026 name_sep => ($name_sep || '.'),
1030 return $self->_sql_maker;
1033 # nothing to do by default
1039 $_[0]->_dbh(undef); # in case ->connected failed we might get sent here
1041 $_[0]->_dbh_details({}); # reset everything we know
1043 # FIXME - this needs reenabling with the proper "no reset on same DSN" check
1044 #$_[0]->_sql_maker(undef); # this may also end up being different
1046 $_[0]->_dbh($_[0]->_connect);
1048 $_[0]->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1050 $_[0]->_determine_driver;
1052 # Always set the transaction depth on connect, since
1053 # there is no transaction in progress by definition
1054 $_[0]->{transaction_depth} = $_[0]->_dbh_autocommit ? 0 : 1;
1056 $_[0]->_run_connection_actions unless $_[0]->{_in_determine_driver};
1061 sub _run_connection_actions {
1063 $_[0]->_do_connection_actions(connect_call_ => $_) for (
1064 ( $_[0]->on_connect_call || () ),
1065 $_[0]->_parse_connect_do ('on_connect_do'),
1071 sub set_use_dbms_capability {
1072 $_[0]->set_inherited ($_[1], $_[2]);
1075 sub get_use_dbms_capability {
1076 my ($self, $capname) = @_;
1078 my $use = $self->get_inherited ($capname);
1081 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1085 sub set_dbms_capability {
1086 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1089 sub get_dbms_capability {
1090 my ($self, $capname) = @_;
1092 my $cap = $self->_dbh_details->{capability}{$capname};
1094 unless (defined $cap) {
1095 if (my $meth = $self->can ("_determine$capname")) {
1096 $cap = $self->$meth ? 1 : 0;
1102 $self->set_dbms_capability ($capname, $cap);
1112 unless ($info = $self->_dbh_details->{info}) {
1116 my $server_version = try {
1117 $self->_get_server_version
1119 # driver determination *may* use this codepath
1120 # in which case we must rethrow
1121 $self->throw_exception($_) if $self->{_in_determine_driver};
1123 # $server_version on failure
1127 if (defined $server_version) {
1128 $info->{dbms_version} = $server_version;
1130 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1131 my @verparts = split (/\./, $numeric_version);
1137 # consider only up to 3 version parts, iff not more than 3 digits
1139 while (@verparts && @use_parts < 3) {
1140 my $p = shift @verparts;
1142 push @use_parts, $p;
1144 push @use_parts, 0 while @use_parts < 3;
1146 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1150 $self->_dbh_details->{info} = $info;
1156 sub _get_server_version {
1157 shift->_dbh_get_info('SQL_DBMS_VER');
1161 my ($self, $info) = @_;
1163 if ($info =~ /[^0-9]/) {
1164 require DBI::Const::GetInfoType;
1165 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1166 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1167 unless defined $info;
1170 $self->_get_dbh->get_info($info);
1173 sub _describe_connection {
1174 require DBI::Const::GetInfoReturn;
1180 $drv = $self->_extract_driver_from_connect_info;
1181 $self->ensure_connected;
1184 $drv = "DBD::$drv" if $drv;
1187 DBIC_DSN => $self->_dbi_connect_info->[0],
1188 DBI_VER => DBI->VERSION,
1189 DBIC_VER => DBIx::Class->VERSION,
1190 DBIC_DRIVER => ref $self,
1193 DBD_VER => try { $drv->VERSION },
1197 # try to grab data even if we never managed to connect
1198 # will cover us in cases of an oddly broken half-connect
1200 #keys %DBI::Const::GetInfoType::GetInfoType,
1202 SQL_CURSOR_COMMIT_BEHAVIOR
1203 SQL_CURSOR_ROLLBACK_BEHAVIOR
1204 SQL_CURSOR_SENSITIVITY
1205 SQL_DATA_SOURCE_NAME
1208 SQL_DEFAULT_TXN_ISOLATION
1213 SQL_EXPRESSIONS_IN_ORDERBY
1216 SQL_IDENTIFIER_QUOTE_CHAR
1217 SQL_MAX_CATALOG_NAME_LEN
1218 SQL_MAX_COLUMN_NAME_LEN
1219 SQL_MAX_IDENTIFIER_LEN
1220 SQL_MAX_TABLE_NAME_LEN
1221 SQL_MULTIPLE_ACTIVE_TXN
1222 SQL_MULT_RESULT_SETS
1223 SQL_NEED_LONG_DATA_LEN
1224 SQL_NON_NULLABLE_COLUMNS
1226 SQL_QUALIFIER_NAME_SEPARATOR
1227 SQL_QUOTED_IDENTIFIER_CASE
1229 SQL_TXN_ISOLATION_OPTION
1232 # some drivers barf on things they do not know about instead
1233 # of returning undef
1234 my $v = try { $self->_dbh_get_info($inf) };
1235 next unless defined $v;
1237 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1238 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1239 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1245 sub _determine_driver {
1248 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1249 my $started_connected = 0;
1250 local $self->{_in_determine_driver} = 1;
1252 if (ref($self) eq __PACKAGE__) {
1254 if ($self->_dbh) { # we are connected
1255 $driver = $self->_dbh->{Driver}{Name};
1256 $started_connected = 1;
1259 $driver = $self->_extract_driver_from_connect_info;
1263 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1264 if ($self->load_optional_class($storage_class)) {
1265 mro::set_mro($storage_class, 'c3');
1266 bless $self, $storage_class;
1270 $self->_warn_undetermined_driver(
1271 'This version of DBIC does not yet seem to supply a driver for '
1272 . "your particular RDBMS and/or connection method ('$driver')."
1277 $self->_warn_undetermined_driver(
1278 'Unable to extract a driver name from connect info - this '
1279 . 'should not have happened.'
1284 $self->_driver_determined(1);
1286 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1288 if ($self->can('source_bind_attributes')) {
1289 $self->throw_exception(
1290 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1291 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1292 . 'If you are not sure how to proceed please contact the development team via '
1293 . DBIx::Class::_ENV_::HELP_URL
1297 $self->_init; # run driver-specific initializations
1299 $self->_run_connection_actions
1300 if !$started_connected && defined $self->_dbh;
1304 sub _extract_driver_from_connect_info {
1309 # if connect_info is a CODEREF, we have no choice but to connect
1311 ref $self->_dbi_connect_info->[0]
1313 reftype $self->_dbi_connect_info->[0] eq 'CODE'
1315 $self->_populate_dbh;
1316 $drv = $self->_dbh->{Driver}{Name};
1319 # try to use dsn to not require being connected, the driver may still
1320 # force a connection later in _rebless to determine version
1321 # (dsn may not be supplied at all if all we do is make a mock-schema)
1322 ($drv) = ($self->_dbi_connect_info->[0] || '') =~ /^dbi:([^:]+):/i;
1323 $drv ||= $ENV{DBI_DRIVER};
1329 sub _determine_connector_driver {
1330 my ($self, $conn) = @_;
1332 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1335 $self->_warn_undetermined_driver(
1336 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1337 . "$conn connector - this should not have happened."
1342 $dbtype =~ s/\W/_/gi;
1344 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1345 return if $self->isa($subclass);
1347 if ($self->load_optional_class($subclass)) {
1348 bless $self, $subclass;
1352 $self->_warn_undetermined_driver(
1353 'This version of DBIC does not yet seem to supply a driver for '
1354 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1359 sub _warn_undetermined_driver {
1360 my ($self, $msg) = @_;
1362 require Data::Dumper::Concise;
1364 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1365 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1366 . "does not go away, file a bugreport including the following info:\n"
1367 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1371 sub _do_connection_actions {
1373 my $method_prefix = shift;
1376 if (not ref($call)) {
1377 my $method = $method_prefix . $call;
1379 } elsif (ref($call) eq 'CODE') {
1381 } elsif (ref($call) eq 'ARRAY') {
1382 if (ref($call->[0]) ne 'ARRAY') {
1383 $self->_do_connection_actions($method_prefix, $_) for @$call;
1385 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1388 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1394 sub connect_call_do_sql {
1396 $self->_do_query(@_);
1399 sub disconnect_call_do_sql {
1401 $self->_do_query(@_);
1404 =head2 connect_call_datetime_setup
1406 A no-op stub method, provided so that one can always safely supply the
1407 L<connection option|/DBIx::Class specific connection attributes>
1409 on_connect_call => 'datetime_setup'
1411 This way one does not need to know in advance whether the underlying
1412 storage requires any sort of hand-holding when dealing with calendar
1417 sub connect_call_datetime_setup { 1 }
1420 my ($self, $action) = @_;
1422 if (ref $action eq 'CODE') {
1423 $action = $action->($self);
1424 $self->_do_query($_) foreach @$action;
1427 # Most debuggers expect ($sql, @bind), so we need to exclude
1428 # the attribute hash which is the second argument to $dbh->do
1429 # furthermore the bind values are usually to be presented
1430 # as named arrayref pairs, so wrap those here too
1431 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1432 my $sql = shift @do_args;
1433 my $attrs = shift @do_args;
1434 my @bind = map { [ undef, $_ ] } @do_args;
1437 $_[0]->_query_start($sql, \@bind);
1438 $_[1]->do($sql, $attrs, @do_args);
1439 $_[0]->_query_end($sql, \@bind);
1449 my $info = $self->_dbi_connect_info;
1451 $self->throw_exception("You did not provide any connection_info")
1452 unless defined $info->[0];
1454 my ($old_connect_via, $dbh);
1456 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1458 # this odd anonymous coderef dereference is in fact really
1459 # necessary to avoid the unwanted effect described in perl5
1462 # in addition the coderef itself can't reside inside the try{} block below
1463 # as it somehow triggers a leak under perl -d
1464 my $dbh_error_handler_installer = sub {
1465 weaken (my $weak_self = $_[0]);
1467 # the coderef is blessed so we can distinguish it from externally
1468 # supplied handles (which must be preserved)
1469 $_[1]->{HandleError} = bless sub {
1471 $weak_self->throw_exception("DBI Exception: $_[0]");
1474 # the handler may be invoked by something totally out of
1476 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1478 }, '__DBIC__DBH__ERROR__HANDLER__';
1482 if(ref $info->[0] eq 'CODE') {
1483 $dbh = $info->[0]->();
1487 $dbh = DBI->connect(@$info);
1490 die $DBI::errstr unless $dbh;
1492 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1493 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1495 ref $info->[0] eq 'CODE'
1496 ? "Connection coderef $info->[0] returned a"
1497 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1498 ) unless $dbh->FETCH('Active');
1500 # sanity checks unless asked otherwise
1501 unless ($self->unsafe) {
1503 $self->throw_exception(
1504 'Refusing clobbering of {HandleError} installed on externally supplied '
1505 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1506 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1508 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1509 # request, or an external handle. Complain and set anyway
1510 unless ($dbh->{RaiseError}) {
1511 carp( ref $info->[0] eq 'CODE'
1513 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1514 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1515 .'attribute has been supplied'
1517 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1518 .'unsafe => 1. Toggling RaiseError back to true'
1521 $dbh->{RaiseError} = 1;
1524 $dbh_error_handler_installer->($self, $dbh);
1528 $self->throw_exception("DBI Connection failed: $_")
1531 $self->_dbh_autocommit($dbh->{AutoCommit});
1536 # this means we have not yet connected and do not know the AC status
1537 # (e.g. coderef $dbh), need a full-fledged connection check
1538 if (! defined $_[0]->_dbh_autocommit) {
1539 $_[0]->ensure_connected;
1541 # Otherwise simply connect or re-connect on pid changes
1546 shift->next::method(@_);
1549 sub _exec_txn_begin {
1552 # if the user is utilizing txn_do - good for him, otherwise we need to
1553 # ensure that the $dbh is healthy on BEGIN.
1554 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1555 # will be replaced by a failure of begin_work itself (which will be
1556 # then retried on reconnect)
1557 if ($self->{_in_do_block}) {
1558 $self->_dbh->begin_work;
1560 $self->dbh_do(sub { $_[1]->begin_work });
1567 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1568 unless $self->_seems_connected;
1570 # esoteric case for folks using external $dbh handles
1571 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1572 carp "Storage transaction_depth 0 does not match "
1573 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1574 $self->transaction_depth(1);
1577 $self->next::method(@_);
1579 # if AutoCommit is disabled txn_depth never goes to 0
1580 # as a new txn is started immediately on commit
1581 $self->transaction_depth(1) if (
1582 !$self->transaction_depth
1584 defined $self->_dbh_autocommit
1586 ! $self->_dbh_autocommit
1590 sub _exec_txn_commit {
1591 shift->_dbh->commit;
1597 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1598 unless $self->_seems_connected;
1600 # esoteric case for folks using external $dbh handles
1601 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1602 carp "Storage transaction_depth 0 does not match "
1603 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1604 $self->transaction_depth(1);
1607 $self->next::method(@_);
1609 # if AutoCommit is disabled txn_depth never goes to 0
1610 # as a new txn is started immediately on commit
1611 $self->transaction_depth(1) if (
1612 !$self->transaction_depth
1614 defined $self->_dbh_autocommit
1616 ! $self->_dbh_autocommit
1620 sub _exec_txn_rollback {
1621 shift->_dbh->rollback;
1624 # generate the DBI-specific stubs, which then fallback to ::Storage proper
1625 quote_sub __PACKAGE__ . "::$_" => sprintf (<<'EOS', $_) for qw(svp_begin svp_release svp_rollback);
1626 $_[0]->throw_exception('Unable to %s() on a disconnected storage')
1627 unless $_[0]->_seems_connected;
1628 shift->next::method(@_);
1631 # This used to be the top-half of _execute. It was split out to make it
1632 # easier to override in NoBindVars without duping the rest. It takes up
1633 # all of _execute's args, and emits $sql, @bind.
1634 sub _prep_for_execute {
1635 #my ($self, $op, $ident, $args) = @_;
1636 return shift->_gen_sql_bind(@_)
1640 my ($self, $op, $ident, $args) = @_;
1642 my ($colinfos, $from);
1643 if ( blessed($ident) ) {
1644 $from = $ident->from;
1645 $colinfos = $ident->columns_info;
1649 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1651 $bind = $self->_resolve_bindattrs(
1652 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1656 ! $ENV{DBIC_DT_SEARCH_OK}
1665 $_->[1]->isa('DateTime')
1668 carp_unique 'DateTime objects passed to search() are not supported '
1669 . 'properly (InflateColumn::DateTime formats and settings are not '
1670 . 'respected.) See "Formatting DateTime objects in queries" in '
1671 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1672 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1675 return( $sql, $bind );
1678 sub _resolve_bindattrs {
1679 my ($self, $ident, $bind, $colinfos) = @_;
1681 my $resolve_bindinfo = sub {
1682 #my $infohash = shift;
1684 $colinfos ||= { %{ $self->_resolve_column_info($ident) } };
1687 if (my $col = $_[0]->{dbic_colname}) {
1688 $ret = { %{$_[0]} };
1690 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1691 if $colinfos->{$col}{data_type};
1693 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1694 if $colinfos->{$col}{size};
1702 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1703 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1704 : (ref $_->[0] eq 'HASH') ? [(
1707 exists $_->[0]{dbd_attrs}
1709 $_->[0]{sqlt_datatype}
1711 : $resolve_bindinfo->($_->[0])
1714 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1715 : [ $resolve_bindinfo->(
1716 { dbic_colname => $_->[0] }
1721 ! exists $resolved->[0]{dbd_attrs}
1723 ! $resolved->[0]{sqlt_datatype}
1725 length ref $resolved->[1]
1727 ! is_plain_value $resolved->[1]
1729 require Data::Dumper;
1730 local $Data::Dumper::Maxdepth = 1;
1731 local $Data::Dumper::Terse = 1;
1732 local $Data::Dumper::Useqq = 1;
1733 local $Data::Dumper::Indent = 0;
1734 local $Data::Dumper::Pad = ' ';
1735 $self->throw_exception(
1736 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1737 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1746 sub _format_for_trace {
1747 #my ($self, $bind) = @_;
1749 ### Turn @bind from something like this:
1750 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1752 ### ( "'1'", "'3'" )
1755 defined( $_ && $_->[1] )
1762 my ( $self, $sql, $bind ) = @_;
1764 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1769 my ( $self, $sql, $bind ) = @_;
1771 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1775 sub _dbi_attrs_for_bind {
1776 my ($self, $ident, $bind) = @_;
1780 for (map { $_->[0] } @$bind) {
1782 if (exists $_->{dbd_attrs}) {
1785 elsif($_->{sqlt_datatype}) {
1786 # cache the result in the dbh_details hash, as it can not change unless
1787 # we connect to something else
1788 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1789 if (not exists $cache->{$_->{sqlt_datatype}}) {
1790 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1792 $cache->{$_->{sqlt_datatype}};
1795 undef; # always push something at this position
1804 my ($self, $op, $ident, @args) = @_;
1806 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1808 # not even a PID check - we do not care about the state of the _dbh.
1809 # All we need is to get the appropriate drivers loaded if they aren't
1810 # already so that the assumption in ad7c50fc26e holds
1811 $self->_populate_dbh unless $self->_dbh;
1813 $self->dbh_do( _dbh_execute => # retry over disconnects
1816 $self->_dbi_attrs_for_bind($ident, $bind),
1821 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1823 $self->_query_start( $sql, $bind );
1825 my $sth = $self->_bind_sth_params(
1826 $self->_prepare_sth($dbh, $sql),
1831 # Can this fail without throwing an exception anyways???
1832 my $rv = $sth->execute();
1833 $self->throw_exception(
1834 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1837 $self->_query_end( $sql, $bind );
1839 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1843 my ($self, $dbh, $sql) = @_;
1845 # 3 is the if_active parameter which avoids active sth re-use
1846 my $sth = $self->disable_sth_caching
1847 ? $dbh->prepare($sql)
1848 : $dbh->prepare_cached($sql, {}, 3);
1850 # XXX You would think RaiseError would make this impossible,
1851 # but apparently that's not true :(
1852 $self->throw_exception(
1855 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1856 .'an exception and/or setting $dbh->errstr',
1858 ? substr($sql, 0, 20) . '...'
1861 'DBD::' . $dbh->{Driver}{Name},
1868 sub _bind_sth_params {
1869 my ($self, $sth, $bind, $bind_attrs) = @_;
1871 for my $i (0 .. $#$bind) {
1872 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1873 $sth->bind_param_inout(
1874 $i + 1, # bind params counts are 1-based
1876 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1881 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
1882 my $v = ( length ref $bind->[$i][1] and is_plain_value $bind->[$i][1] )
1889 # The temp-var is CRUCIAL - DO NOT REMOVE IT, breaks older DBD::SQLite RT#79576
1899 sub _prefetch_autovalues {
1900 my ($self, $source, $colinfo, $to_insert) = @_;
1903 for my $col (keys %$colinfo) {
1905 $colinfo->{$col}{auto_nextval}
1908 ! exists $to_insert->{$col}
1910 is_literal_value($to_insert->{$col})
1913 $values{$col} = $self->_sequence_fetch(
1915 ( $colinfo->{$col}{sequence} ||=
1916 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1926 my ($self, $source, $to_insert) = @_;
1928 my $col_infos = $source->columns_info;
1930 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1932 # fuse the values, but keep a separate list of prefetched_values so that
1933 # they can be fused once again with the final return
1934 $to_insert = { %$to_insert, %$prefetched_values };
1936 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1937 # Investigate what does it take to s/defined/exists/
1938 my %pcols = map { $_ => 1 } $source->primary_columns;
1939 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1940 for my $col ($source->columns) {
1941 if ($col_infos->{$col}{is_auto_increment}) {
1942 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1943 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1946 # nothing to retrieve when explicit values are supplied
1948 defined $to_insert->{$col} and ! is_literal_value($to_insert->{$col})
1951 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1952 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1955 $col_infos->{$col}{retrieve_on_insert}
1959 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1960 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1962 my ($sqla_opts, @ir_container);
1963 if (%retrieve_cols and $self->_use_insert_returning) {
1964 $sqla_opts->{returning_container} = \@ir_container
1965 if $self->_use_insert_returning_bound;
1967 $sqla_opts->{returning} = [
1968 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1972 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1974 my %returned_cols = %$to_insert;
1975 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1976 @ir_container = try {
1977 local $SIG{__WARN__} = sub {};
1978 my @r = $sth->fetchrow_array;
1981 } unless @ir_container;
1983 @returned_cols{@$retlist} = @ir_container if @ir_container;
1986 # pull in PK if needed and then everything else
1987 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1989 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1990 unless $self->can('last_insert_id');
1992 my @pri_values = $self->last_insert_id($source, @missing_pri);
1994 $self->throw_exception( "Can't get last insert id" )
1995 unless (@pri_values == @missing_pri);
1997 @returned_cols{@missing_pri} = @pri_values;
1998 delete @retrieve_cols{@missing_pri};
2001 # if there is more left to pull
2002 if (%retrieve_cols) {
2003 $self->throw_exception(
2004 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
2007 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
2009 my $cur = DBIx::Class::ResultSet->new($source, {
2010 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
2011 select => \@left_to_fetch,
2014 @returned_cols{@left_to_fetch} = $cur->next;
2016 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
2017 if scalar $cur->next;
2021 return { %$prefetched_values, %returned_cols };
2026 'insert_bulk() should have never been exposed as a public method and '
2027 . 'calling it is depecated as of Aug 2014. If you believe having a genuine '
2028 . 'use for this method please contact the development team via '
2029 . DBIx::Class::_ENV_::HELP_URL
2032 return '0E0' unless @{$_[3]||[]};
2034 shift->_insert_bulk(@_);
2038 my ($self, $source, $cols, $data) = @_;
2040 $self->throw_exception('Calling _insert_bulk without a dataset to process makes no sense')
2041 unless @{$data||[]};
2043 my $colinfos = $source->columns_info($cols);
2045 local $self->{_autoinc_supplied_for_op} =
2046 (grep { $_->{is_auto_increment} } values %$colinfos)
2051 # get a slice type index based on first row of data
2052 # a "column" in this context may refer to more than one bind value
2053 # e.g. \[ '?, ?', [...], [...] ]
2055 # construct the value type index - a description of values types for every
2056 # per-column slice of $data:
2058 # nonexistent - nonbind literal
2060 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2062 # also construct the column hash to pass to the SQL generator. For plain
2063 # (non literal) values - convert the members of the first row into a
2064 # literal+bind combo, with extra positional info in the bind attr hashref.
2065 # This will allow us to match the order properly, and is so contrived
2066 # because a user-supplied literal/bind (or something else specific to a
2067 # resultsource and/or storage driver) can inject extra binds along the
2068 # way, so one can't rely on "shift positions" ordering at all. Also we
2069 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2070 # can be later matched up by address), because we want to supply a real
2071 # value on which perhaps e.g. datatype checks will be performed
2072 my ($proto_data, $serialized_bind_type_by_col_idx);
2073 for my $col_idx (0..$#$cols) {
2074 my $colname = $cols->[$col_idx];
2075 if (ref $data->[0][$col_idx] eq 'SCALAR') {
2076 # no bind value at all - no type
2078 $proto_data->{$colname} = $data->[0][$col_idx];
2080 elsif (ref $data->[0][$col_idx] eq 'REF' and ref ${$data->[0][$col_idx]} eq 'ARRAY' ) {
2081 # repack, so we don't end up mangling the original \[]
2082 my ($sql, @bind) = @${$data->[0][$col_idx]};
2084 # normalization of user supplied stuff
2085 my $resolved_bind = $self->_resolve_bindattrs(
2086 $source, \@bind, $colinfos,
2089 # store value-less (attrs only) bind info - we will be comparing all
2090 # supplied binds against this for sanity
2091 $serialized_bind_type_by_col_idx->{$col_idx} = serialize [ map { $_->[0] } @$resolved_bind ];
2093 $proto_data->{$colname} = \[ $sql, map { [
2094 # inject slice order to use for $proto_bind construction
2095 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $col_idx, _literal_bind_subindex => $_+1 }
2097 $resolved_bind->[$_][1]
2102 $serialized_bind_type_by_col_idx->{$col_idx} = undef;
2104 $proto_data->{$colname} = \[ '?', [
2105 { dbic_colname => $colname, _bind_data_slice_idx => $col_idx }
2107 $data->[0][$col_idx]
2112 my ($sql, $proto_bind) = $self->_prep_for_execute (
2118 if (! @$proto_bind and keys %$serialized_bind_type_by_col_idx) {
2119 # if the bindlist is empty and we had some dynamic binds, this means the
2120 # storage ate them away (e.g. the NoBindVars component) and interpolated
2121 # them directly into the SQL. This obviously can't be good for multi-inserts
2122 $self->throw_exception('Unable to invoke fast-path insert without storage placeholder support');
2126 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2128 # use an error reporting closure for convenience (less to pass)
2129 my $bad_slice_report_cref = sub {
2130 my ($msg, $r_idx, $c_idx) = @_;
2131 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2135 require Data::Dumper::Concise;
2136 local $Data::Dumper::Maxdepth = 5;
2137 Data::Dumper::Concise::Dumper ({
2138 map { $cols->[$_] =>
2146 for my $col_idx (0..$#$cols) {
2147 my $reference_val = $data->[0][$col_idx];
2149 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2150 my $val = $data->[$row_idx][$col_idx];
2152 if (! exists $serialized_bind_type_by_col_idx->{$col_idx}) { # literal no binds
2153 if (ref $val ne 'SCALAR') {
2154 $bad_slice_report_cref->(
2155 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2160 elsif ($$val ne $$reference_val) {
2161 $bad_slice_report_cref->(
2162 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2168 elsif (! defined $serialized_bind_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2169 if (is_literal_value($val)) {
2170 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2173 else { # binds from a \[], compare type and attrs
2174 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2175 $bad_slice_report_cref->(
2176 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2181 # start drilling down and bail out early on identical refs
2183 $reference_val != $val
2185 $$reference_val != $$val
2187 if (${$val}->[0] ne ${$reference_val}->[0]) {
2188 $bad_slice_report_cref->(
2189 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2194 # need to check the bind attrs - a bind will happen only once for
2195 # the entire dataset, so any changes further down will be ignored.
2197 $serialized_bind_type_by_col_idx->{$col_idx}
2202 @{$self->_resolve_bindattrs(
2203 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2207 $bad_slice_report_cref->(
2208 'Differing bind attributes on literal/bind values not supported',
2218 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2219 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2221 my $guard = $self->txn_scope_guard;
2223 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2224 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2227 # proto bind contains the information on which pieces of $data to pull
2228 # $cols is passed in only for prettier error-reporting
2229 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2232 # bind_param_array doesn't work if there are no binds
2233 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2237 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2241 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2244 # execute_for_fetch is capable of returning data just fine (it means it
2245 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2246 # is the void-populate fast-path we will just ignore this altogether
2247 # for the time being.
2248 sub _dbh_execute_for_fetch {
2249 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2251 # If we have any bind attributes to take care of, we will bind the
2252 # proto-bind data (which will never be used by execute_for_fetch)
2253 # However since column bindtypes are "sticky", this is sufficient
2254 # to get the DBD to apply the bindtype to all values later on
2255 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2257 for my $i (0 .. $#$proto_bind) {
2259 $i+1, # DBI bind indexes are 1-based
2260 $proto_bind->[$i][1],
2262 ) if defined $bind_attrs->[$i];
2265 # At this point $data slots named in the _bind_data_slice_idx of
2266 # each piece of $proto_bind are either \[]s or plain values to be
2267 # passed in. Construct the dispensing coderef. *NOTE* the order
2268 # of $data will differ from this of the ?s in the SQL (due to
2269 # alphabetical ordering by colname). We actually do want to
2270 # preserve this behavior so that prepare_cached has a better
2271 # chance of matching on unrelated calls
2273 my $fetch_row_idx = -1; # saner loop this way
2274 my $fetch_tuple = sub {
2275 return undef if ++$fetch_row_idx > $#$data;
2278 my $v = ! defined $_->{_literal_bind_subindex}
2280 ? $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2282 # There are no attributes to resolve here - we already did everything
2283 # when we constructed proto_bind. However we still want to sanity-check
2284 # what the user supplied, so pass stuff through to the resolver *anyway*
2285 : $self->_resolve_bindattrs (
2286 undef, # a fake rsrc
2287 [ ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}->[ $_->{_literal_bind_subindex} ] ],
2288 {}, # a fake column_info bag
2292 # FIXME SUBOPTIMAL - DBI needs fixing to always stringify regardless of DBD
2293 # For the time being forcibly stringify whatever is stringifiable
2294 (length ref $v and is_plain_value $v)
2298 } map { $_->[0] } @$proto_bind ];
2301 my $tuple_status = [];
2304 $rv = $sth->execute_for_fetch(
2313 # Not all DBDs are create equal. Some throw on error, some return
2314 # an undef $rv, and some set $sth->err - try whatever we can
2315 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2318 ( !defined $rv or $sth->err )
2321 # Statement must finish even if there was an exception.
2326 $err = shift unless defined $err
2331 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2333 $self->throw_exception("Unexpected populate error: $err")
2334 if ($i > $#$tuple_status);
2336 require Data::Dumper::Concise;
2337 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2338 ($tuple_status->[$i][1] || $err),
2339 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2346 sub _dbh_execute_inserts_with_no_binds {
2347 my ($self, $sth, $count) = @_;
2351 my $dbh = $self->_get_dbh;
2352 local $dbh->{RaiseError} = 1;
2353 local $dbh->{PrintError} = 0;
2355 $sth->execute foreach 1..$count;
2361 # Make sure statement is finished even if there was an exception.
2366 $err = shift unless defined $err;
2369 $self->throw_exception($err) if defined $err;
2375 #my ($self, $source, @args) = @_;
2376 shift->_execute('update', @_);
2381 #my ($self, $source, @args) = @_;
2382 shift->_execute('delete', @_);
2387 $self->_execute($self->_select_args(@_));
2390 sub _select_args_to_query {
2393 $self->throw_exception(
2394 "Unable to generate limited query representation with 'software_limit' enabled"
2395 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2397 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2398 # = $self->_select_args($ident, $select, $cond, $attrs);
2399 my ($op, $ident, @args) =
2400 $self->_select_args(@_);
2402 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2403 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2405 # reuse the bind arrayref
2406 unshift @{$bind}, "($sql)";
2411 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2413 # FIXME - that kind of caching would be nice to have
2414 # however currently we *may* pass the same $orig_attrs
2415 # with different ident/select/where
2416 # the whole interface needs to be rethought, since it
2417 # was centered around the flawed SQLA API. We can do
2418 # soooooo much better now. But that is also another
2421 # 'select', $orig_attrs->{!args_as_stored_at_the_end_of_this_method!}
2422 #) if $orig_attrs->{!args_as_stored_at_the_end_of_this_method!};
2424 my $sql_maker = $self->sql_maker;
2433 # Sanity check the attributes (SQLMaker does it too, but
2434 # in case of a software_limit we'll never reach there)
2435 if (defined $attrs->{offset}) {
2436 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2437 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2440 if (defined $attrs->{rows}) {
2441 $self->throw_exception("The rows attribute must be a positive integer if present")
2442 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2444 elsif ($attrs->{offset}) {
2445 # MySQL actually recommends this approach. I cringe.
2446 $attrs->{rows} = $sql_maker->__max_int;
2449 # see if we will need to tear the prefetch apart to satisfy group_by == select
2450 # this is *extremely tricky* to get right, I am still not sure I did
2452 my ($prefetch_needs_subquery, @limit_args);
2454 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2455 # we already know there is a valid group_by (we made it) and we know it is
2456 # intended to be based *only* on non-multi stuff
2457 # short circuit the group_by parsing below
2458 $prefetch_needs_subquery = 1;
2461 # The rationale is that even if we do *not* have collapse, we still
2462 # need to wrap the core grouped select/group_by in a subquery
2463 # so that databases that care about group_by/select equivalence
2464 # are happy (this includes MySQL in strict_mode)
2465 # If any of the other joined tables are referenced in the group_by
2466 # however - the user is on their own
2467 ( $prefetch_needs_subquery or ! $attrs->{_simple_passthrough_construction} )
2471 @{$attrs->{group_by}}
2473 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2474 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2477 # no aliases other than our own in group_by
2478 # if there are - do not allow subquery even if limit is present
2479 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2481 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2482 # active collapse with a limit - that one is a no-brainer unless
2483 # overruled by a group_by above
2484 $prefetch_needs_subquery = 1;
2487 if ($prefetch_needs_subquery) {
2488 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2490 elsif (! $attrs->{software_limit} ) {
2492 $attrs->{rows} || (),
2493 $attrs->{offset} || (),
2497 # try to simplify the joinmap further (prune unreferenced type-single joins)
2499 ! $prefetch_needs_subquery # already pruned
2503 reftype $attrs->{from} eq 'ARRAY'
2505 @{$attrs->{from}} != 1
2507 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2510 # FIXME this is a gross, inefficient, largely incorrect and fragile hack
2511 # during the result inflation stage we *need* to know what was the aliastype
2512 # map as sqla saw it when the final pieces of SQL were being assembled
2513 # Originally we simply carried around the entirety of $attrs, but this
2514 # resulted in resultsets that are being reused growing continuously, as
2515 # the hash in question grew deeper and deeper.
2516 # Instead hand-pick what to take with us here (we actually don't need much
2517 # at this point just the map itself)
2518 $orig_attrs->{_last_sqlmaker_alias_map} = $attrs->{_aliastypes};
2521 # my $alias2source = $self->_resolve_ident_sources ($ident);
2523 # This would be the point to deflate anything found in $attrs->{where}
2524 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2525 # expect a result object. And all we have is a resultsource (it is trivial
2526 # to extract deflator coderefs via $alias2source above).
2528 # I don't see a way forward other than changing the way deflators are
2529 # invoked, and that's just bad...
2532 return ( 'select', @{$attrs}{qw(from select where)}, $attrs, @limit_args );
2535 # Returns a counting SELECT for a simple count
2536 # query. Abstracted so that a storage could override
2537 # this to { count => 'firstcol' } or whatever makes
2538 # sense as a performance optimization
2540 #my ($self, $source, $rs_attrs) = @_;
2541 return { count => '*' };
2548 =item Arguments: $ident, $select, $condition, $attrs
2552 Handle a SQL select statement.
2558 my ($ident, $select, $condition, $attrs) = @_;
2559 return $self->cursor_class->new($self, \@_, $attrs);
2564 my ($rv, $sth, @bind) = $self->_select(@_);
2565 my @row = $sth->fetchrow_array;
2566 my @nextrow = $sth->fetchrow_array if @row;
2567 if(@row && @nextrow) {
2568 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2570 # Need to call finish() to work round broken DBDs
2575 =head2 sql_limit_dialect
2577 This is an accessor for the default SQL limit dialect used by a particular
2578 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2579 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2580 see L<DBIx::Class::SQLMaker::LimitDialects>.
2584 sub _dbh_columns_info_for {
2585 my ($self, $dbh, $table) = @_;
2589 if (! DBIx::Class::_ENV_::STRESSTEST_COLUMN_INFO_UNAWARE_STORAGE and $dbh->can('column_info')) {
2591 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2592 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2594 while ( my $info = $sth->fetchrow_hashref() ){
2596 $column_info{data_type} = $info->{TYPE_NAME};
2597 $column_info{size} = $info->{COLUMN_SIZE};
2598 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2599 $column_info{default_value} = $info->{COLUMN_DEF};
2600 my $col_name = $info->{COLUMN_NAME};
2601 $col_name =~ s/^\"(.*)\"$/$1/;
2603 $result{$col_name} = \%column_info;
2609 return \%result if keys %result;
2612 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2615 ### The acrobatics with lc names is necessary to support both the legacy
2616 ### API that used NAME_lc exclusively, *AND* at the same time work properly
2617 ### with column names differing in cas eonly (thanks pg!)
2619 my ($columns, $seen_lcs);
2621 ++$seen_lcs->{lc($_)} and $columns->{$_} = {
2622 idx => scalar keys %$columns,
2625 } for @{$sth->{NAME}};
2627 $seen_lcs->{$_->{lc_name}} == 1
2629 $_->{name} = $_->{lc_name}
2630 for values %$columns;
2632 for ( values %$columns ) {
2634 data_type => $sth->{TYPE}->[$_->{idx}],
2635 size => $sth->{PRECISION}->[$_->{idx}],
2636 is_nullable => $sth->{NULLABLE}->[$_->{idx}] ? 1 : 0,
2639 if ($inf->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2640 @{$inf}{qw( data_type size)} = ($1, $2);
2643 $result{$_->{name}} = $inf;
2648 if ($dbh->can('type_info')) {
2649 for my $inf (values %result) {
2650 next if ! defined $inf->{data_type};
2652 $inf->{data_type} = (
2655 $dbh->type_info( $inf->{data_type} )
2666 # FIXME - this may be an artifact of the DBD::Pg implmentation alone
2667 # needs more testing in the future...
2668 $inf->{size} -= 4 if (
2669 ( $inf->{size}||0 > 4 )
2671 $inf->{data_type} =~ qr/^text$/i
2680 sub columns_info_for {
2681 my ($self, $table) = @_;
2682 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2685 =head2 last_insert_id
2687 Return the row id of the last insert.
2691 sub _dbh_last_insert_id {
2692 my ($self, $dbh, $source, $col) = @_;
2694 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2696 return $id if defined $id;
2698 my $class = ref $self;
2699 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2702 sub last_insert_id {
2704 $self->_dbh_last_insert_id ($self->_dbh, @_);
2707 =head2 _native_data_type
2711 =item Arguments: $type_name
2715 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2716 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2717 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2719 The default implementation returns C<undef>, implement in your Storage driver if
2720 you need this functionality.
2722 Should map types from other databases to the native RDBMS type, for example
2723 C<VARCHAR2> to C<VARCHAR>.
2725 Types with modifiers should map to the underlying data type. For example,
2726 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2728 Composite types should map to the container type, for example
2729 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2733 sub _native_data_type {
2734 #my ($self, $data_type) = @_;
2738 # Check if placeholders are supported at all
2739 sub _determine_supports_placeholders {
2741 my $dbh = $self->_get_dbh;
2743 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2744 # but it is inaccurate more often than not
2746 local $dbh->{PrintError} = 0;
2747 local $dbh->{RaiseError} = 1;
2748 $dbh->do('select ?', {}, 1);
2756 # Check if placeholders bound to non-string types throw exceptions
2758 sub _determine_supports_typeless_placeholders {
2760 my $dbh = $self->_get_dbh;
2763 local $dbh->{PrintError} = 0;
2764 local $dbh->{RaiseError} = 1;
2765 # this specifically tests a bind that is NOT a string
2766 $dbh->do('select 1 where 1 = ?', {}, 1);
2776 Returns the database driver name.
2781 shift->_get_dbh->{Driver}->{Name};
2784 =head2 bind_attribute_by_data_type
2786 Given a datatype from column info, returns a database specific bind
2787 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2788 let the database planner just handle it.
2790 This method is always called after the driver has been determined and a DBI
2791 connection has been established. Therefore you can refer to C<DBI::$constant>
2792 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2793 the correct modules.
2797 sub bind_attribute_by_data_type {
2801 =head2 is_datatype_numeric
2803 Given a datatype from column_info, returns a boolean value indicating if
2804 the current RDBMS considers it a numeric value. This controls how
2805 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2806 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2807 be performed instead of the usual C<eq>.
2811 sub is_datatype_numeric {
2812 #my ($self, $dt) = @_;
2814 return 0 unless $_[1];
2817 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2822 =head2 create_ddl_dir
2826 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2830 Creates a SQL file based on the Schema, for each of the specified
2831 database engines in C<\@databases> in the given directory.
2832 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2834 Given a previous version number, this will also create a file containing
2835 the ALTER TABLE statements to transform the previous schema into the
2836 current one. Note that these statements may contain C<DROP TABLE> or
2837 C<DROP COLUMN> statements that can potentially destroy data.
2839 The file names are created using the C<ddl_filename> method below, please
2840 override this method in your schema if you would like a different file
2841 name format. For the ALTER file, the same format is used, replacing
2842 $version in the name with "$preversion-$version".
2844 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2845 The most common value for this would be C<< { add_drop_table => 1 } >>
2846 to have the SQL produced include a C<DROP TABLE> statement for each table
2847 created. For quoting purposes supply C<quote_identifiers>.
2849 If no arguments are passed, then the following default values are assumed:
2853 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2855 =item version - $schema->schema_version
2857 =item directory - './'
2859 =item preversion - <none>
2863 By default, C<\%sqlt_args> will have
2865 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2867 merged with the hash passed in. To disable any of those features, pass in a
2868 hashref like the following
2870 { ignore_constraint_names => 0, # ... other options }
2873 WARNING: You are strongly advised to check all SQL files created, before applying
2878 sub create_ddl_dir {
2879 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2882 carp "No directory given, using ./\n";
2887 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2889 $self->throw_exception(
2890 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2894 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2896 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2897 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2899 my $schema_version = $schema->schema_version || '1.x';
2900 $version ||= $schema_version;
2903 add_drop_table => 1,
2904 ignore_constraint_names => 1,
2905 ignore_index_names => 1,
2906 quote_identifiers => $self->sql_maker->_quoting_enabled,
2910 if (my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('deploy')) {
2911 $self->throw_exception("Can't create a ddl file without $missing");
2914 my $sqlt = SQL::Translator->new( $sqltargs );
2916 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2917 my $sqlt_schema = $sqlt->translate({ data => $schema })
2918 or $self->throw_exception ($sqlt->error);
2920 foreach my $db (@$databases) {
2922 $sqlt->{schema} = $sqlt_schema;
2923 $sqlt->producer($db);
2926 my $filename = $schema->ddl_filename($db, $version, $dir);
2927 if (-e $filename && ($version eq $schema_version )) {
2928 # if we are dumping the current version, overwrite the DDL
2929 carp "Overwriting existing DDL file - $filename";
2933 my $output = $sqlt->translate;
2935 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2938 if(!open($file, ">$filename")) {
2939 $self->throw_exception("Can't open $filename for writing ($!)");
2942 print $file $output;
2945 next unless ($preversion);
2947 require SQL::Translator::Diff;
2949 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2950 if(!-e $prefilename) {
2951 carp("No previous schema file found ($prefilename)");
2955 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2957 carp("Overwriting existing diff file - $difffile");
2963 my $t = SQL::Translator->new($sqltargs);
2968 or $self->throw_exception ($t->error);
2970 my $out = $t->translate( $prefilename )
2971 or $self->throw_exception ($t->error);
2973 $source_schema = $t->schema;
2975 $source_schema->name( $prefilename )
2976 unless ( $source_schema->name );
2979 # The "new" style of producers have sane normalization and can support
2980 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2981 # And we have to diff parsed SQL against parsed SQL.
2982 my $dest_schema = $sqlt_schema;
2984 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2985 my $t = SQL::Translator->new($sqltargs);
2990 or $self->throw_exception ($t->error);
2992 my $out = $t->translate( $filename )
2993 or $self->throw_exception ($t->error);
2995 $dest_schema = $t->schema;
2997 $dest_schema->name( $filename )
2998 unless $dest_schema->name;
3002 # FIXME - this is a terrible workaround for
3003 # https://github.com/dbsrgits/sql-translator/commit/2d23c1e
3004 # Fixing it in this sloppy manner so that we don't hve to
3005 # lockstep an SQLT release as well. Needs to be removed at
3006 # some point, and SQLT dep bumped
3007 local $SQL::Translator::Producer::SQLite::NO_QUOTES
3008 if $SQL::Translator::Producer::SQLite::NO_QUOTES;
3010 SQL::Translator::Diff::schema_diff($source_schema, $db,
3016 if(!open $file, ">$difffile") {
3017 $self->throw_exception("Can't write to $difffile ($!)");
3025 =head2 deployment_statements
3029 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
3033 Returns the statements used by L<DBIx::Class::Storage/deploy>
3034 and L<DBIx::Class::Schema/deploy>.
3036 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
3037 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
3039 C<$directory> is used to return statements from files in a previously created
3040 L</create_ddl_dir> directory and is optional. The filenames are constructed
3041 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
3043 If no C<$directory> is specified then the statements are constructed on the
3044 fly using L<SQL::Translator> and C<$version> is ignored.
3046 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
3050 sub deployment_statements {
3051 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
3052 $type ||= $self->sqlt_type;
3053 $version ||= $schema->schema_version || '1.x';
3055 my $filename = $schema->ddl_filename($type, $version, $dir);
3058 # FIXME replace this block when a proper sane sql parser is available
3060 open($file, "<$filename")
3061 or $self->throw_exception("Can't open $filename ($!)");
3064 return join('', @rows);
3067 if (my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') ) {
3068 $self->throw_exception("Can't deploy without a pregenerated 'ddl_dir' directory or $missing");
3071 # sources needs to be a parser arg, but for simplicity allow at top level
3073 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
3074 if exists $sqltargs->{sources};
3076 $sqltargs->{quote_identifiers} = $self->sql_maker->_quoting_enabled
3077 unless exists $sqltargs->{quote_identifiers};
3079 my $tr = SQL::Translator->new(
3080 producer => "SQL::Translator::Producer::${type}",
3082 parser => 'SQL::Translator::Parser::DBIx::Class',
3086 return preserve_context {
3089 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
3090 unless defined $_[0];
3094 # FIXME deploy() currently does not accurately report sql errors
3095 # Will always return true while errors are warned
3097 my ($self, $schema, $type, $sqltargs, $dir) = @_;
3101 return if($line =~ /^--/);
3102 # next if($line =~ /^DROP/m);
3103 return if($line =~ /^BEGIN TRANSACTION/m);
3104 return if($line =~ /^COMMIT/m);
3105 return if $line =~ /^\s+$/; # skip whitespace only
3106 $self->_query_start($line);
3108 # do a dbh_do cycle here, as we need some error checking in
3109 # place (even though we will ignore errors)
3110 $self->dbh_do (sub { $_[1]->do($line) });
3112 carp qq{$_ (running "${line}")};
3114 $self->_query_end($line);
3116 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
3117 if (@statements > 1) {
3118 foreach my $statement (@statements) {
3119 $deploy->( $statement );
3122 elsif (@statements == 1) {
3123 # split on single line comments and end of statements
3124 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3130 =head2 datetime_parser
3132 Returns the datetime parser class
3136 sub datetime_parser {
3138 return $self->{datetime_parser} ||= do {
3139 $self->build_datetime_parser(@_);
3143 =head2 datetime_parser_type
3145 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3147 =head2 build_datetime_parser
3149 See L</datetime_parser>
3153 sub build_datetime_parser {
3155 my $type = $self->datetime_parser_type(@_);
3160 =head2 is_replicating
3162 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3163 replicate from a master database. Default is undef, which is the result
3164 returned by databases that don't support replication.
3168 sub is_replicating {
3173 =head2 lag_behind_master
3175 Returns a number that represents a certain amount of lag behind a master db
3176 when a given storage is replicating. The number is database dependent, but
3177 starts at zero and increases with the amount of lag. Default in undef
3181 sub lag_behind_master {
3185 =head2 relname_to_table_alias
3189 =item Arguments: $relname, $join_count
3191 =item Return Value: $alias
3195 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3198 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3199 way these aliases are named.
3201 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3202 otherwise C<"$relname">.
3206 sub relname_to_table_alias {
3207 my ($self, $relname, $join_count) = @_;
3209 my $alias = ($join_count && $join_count > 1 ?
3210 join('_', $relname, $join_count) : $relname);
3215 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3216 # version and it may be necessary to amend or override it for a specific storage
3217 # if such binds are necessary.
3218 sub _max_column_bytesize {
3219 my ($self, $attr) = @_;
3223 if ($attr->{sqlt_datatype}) {
3224 my $data_type = lc($attr->{sqlt_datatype});
3226 if ($attr->{sqlt_size}) {
3228 # String/sized-binary types
3229 if ($data_type =~ /^(?:
3230 l? (?:var)? char(?:acter)? (?:\s*varying)?
3232 (?:var)? binary (?:\s*varying)?
3237 $max_size = $attr->{sqlt_size};
3239 # Other charset/unicode types, assume scale of 4
3240 elsif ($data_type =~ /^(?:
3241 national \s* character (?:\s*varying)?
3250 $max_size = $attr->{sqlt_size} * 4;
3254 if (!$max_size and !$self->_is_lob_type($data_type)) {
3255 $max_size = 100 # for all other (numeric?) datatypes
3259 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3262 # Determine if a data_type is some type of BLOB
3264 my ($self, $data_type) = @_;
3265 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3266 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3267 |varchar|character\s*varying|nvarchar
3268 |national\s*character\s*varying))?\z/xi);
3271 sub _is_binary_lob_type {
3272 my ($self, $data_type) = @_;
3273 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3274 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3277 sub _is_text_lob_type {
3278 my ($self, $data_type) = @_;
3279 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3280 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3281 |national\s*character\s*varying))\z/xi);
3284 # Determine if a data_type is some type of a binary type
3285 sub _is_binary_type {
3286 my ($self, $data_type) = @_;
3287 $data_type && ($self->_is_binary_lob_type($data_type)
3288 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3295 =head2 DBIx::Class and AutoCommit
3297 DBIx::Class can do some wonderful magic with handling exceptions,
3298 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3299 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3300 transaction support.
3302 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3303 in an assumed transaction between commits, and you're telling us you'd
3304 like to manage that manually. A lot of the magic protections offered by
3305 this module will go away. We can't protect you from exceptions due to database
3306 disconnects because we don't know anything about how to restart your
3307 transactions. You're on your own for handling all sorts of exceptional
3308 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3311 =head1 FURTHER QUESTIONS?
3313 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
3315 =head1 COPYRIGHT AND LICENSE
3317 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
3318 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
3319 redistribute it and/or modify it under the same terms as the
3320 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.