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 Sub::Name 'subname';
14 use Context::Preserve 'preserve_context';
17 use Data::Compare (); # no imports!!! guard against insane architecture
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 _dbi_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. This is a purely DRY optimization
84 # get_(use)_dbms_capability need to be called on the correct Storage
85 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
86 # _determine_supports_X which obv. needs a correct driver as well
87 my @rdbms_specific_methods = qw/
100 with_deferred_fk_checks
102 get_use_dbms_capability
109 for my $meth (@rdbms_specific_methods) {
111 my $orig = __PACKAGE__->can ($meth)
112 or die "$meth is not a ::Storage::DBI method!";
115 no warnings qw/redefine/;
116 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
118 # only fire when invoked on an instance, a valid class-based invocation
119 # would e.g. be setting a default for an inherited accessor
122 ! $_[0]->_driver_determined
124 ! $_[0]->{_in_determine_driver}
126 $_[0]->_determine_driver;
128 # This for some reason crashes and burns on perl 5.8.1
129 # IFF the method ends up throwing an exception
130 #goto $_[0]->can ($meth);
132 my $cref = $_[0]->can ($meth);
142 DBIx::Class::Storage::DBI - DBI storage handler
146 my $schema = MySchema->connect('dbi:SQLite:my.db');
148 $schema->storage->debug(1);
150 my @stuff = $schema->storage->dbh_do(
152 my ($storage, $dbh, @args) = @_;
153 $dbh->do("DROP TABLE authors");
158 $schema->resultset('Book')->search({
159 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
164 This class represents the connection to an RDBMS via L<DBI>. See
165 L<DBIx::Class::Storage> for general information. This pod only
166 documents DBI-specific methods and behaviors.
173 my $new = shift->next::method(@_);
175 $new->_sql_maker_opts({});
176 $new->_dbh_details({});
177 $new->{_in_do_block} = 0;
179 # read below to see what this does
180 $new->_arm_global_destructor;
185 # This is hack to work around perl shooting stuff in random
186 # order on exit(). If we do not walk the remaining storage
187 # objects in an END block, there is a *small but real* chance
188 # of a fork()ed child to kill the parent's shared DBI handle,
189 # *before perl reaches the DESTROY in this package*
190 # Yes, it is ugly and effective.
191 # Additionally this registry is used by the CLONE method to
192 # make sure no handles are shared between threads
194 my %seek_and_destroy;
196 sub _arm_global_destructor {
198 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
203 local $?; # just in case the DBI destructor changes it somehow
205 # destroy just the object if not native to this process
206 $_->_verify_pid for (grep
208 values %seek_and_destroy
213 # As per DBI's recommendation, DBIC disconnects all handles as
214 # soon as possible (DBIC will reconnect only on demand from within
216 my @instances = grep { defined $_ } values %seek_and_destroy;
217 %seek_and_destroy = ();
222 $_->transaction_depth(0);
225 # properly renumber existing refs
226 $_->_arm_global_destructor
234 # some databases spew warnings on implicit disconnect
235 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
236 local $SIG{__WARN__} = sub {};
239 # this op is necessary, since the very last perl runtime statement
240 # triggers a global destruction shootout, and the $SIG localization
241 # may very well be destroyed before perl actually gets to do the
246 # handle pid changes correctly - do not destroy parent's connection
250 my $pid = $self->_conn_pid;
251 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
252 $dbh->{InactiveDestroy} = 1;
254 $self->transaction_depth(0);
255 $self->savepoints([]);
263 This method is normally called by L<DBIx::Class::Schema/connection>, which
264 encapsulates its argument list in an arrayref before passing them here.
266 The argument list may contain:
272 The same 4-element argument set one would normally pass to
273 L<DBI/connect>, optionally followed by
274 L<extra attributes|/DBIx::Class specific connection attributes>
275 recognized by DBIx::Class:
277 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
281 A single code reference which returns a connected
282 L<DBI database handle|DBI/connect> optionally followed by
283 L<extra attributes|/DBIx::Class specific connection attributes> recognized
286 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
290 A single hashref with all the attributes and the dsn/user/password
293 $connect_info_args = [{
301 $connect_info_args = [{
302 dbh_maker => sub { DBI->connect (...) },
307 This is particularly useful for L<Catalyst> based applications, allowing the
308 following config (L<Config::General> style):
313 dsn dbi:mysql:database=test
320 The C<dsn>/C<user>/C<password> combination can be substituted by the
321 C<dbh_maker> key whose value is a coderef that returns a connected
322 L<DBI database handle|DBI/connect>
326 Please note that the L<DBI> docs recommend that you always explicitly
327 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
328 recommends that it be set to I<1>, and that you perform transactions
329 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
330 to I<1> if you do not do explicitly set it to zero. This is the default
331 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
333 =head3 DBIx::Class specific connection attributes
335 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
336 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
337 the following connection options. These options can be mixed in with your other
338 L<DBI> connection attributes, or placed in a separate hashref
339 (C<\%extra_attributes>) as shown above.
341 Every time C<connect_info> is invoked, any previous settings for
342 these options will be cleared before setting the new ones, regardless of
343 whether any options are specified in the new C<connect_info>.
350 Specifies things to do immediately after connecting or re-connecting to
351 the database. Its value may contain:
357 This contains one SQL statement to execute.
359 =item an array reference
361 This contains SQL statements to execute in order. Each element contains
362 a string or a code reference that returns a string.
364 =item a code reference
366 This contains some code to execute. Unlike code references within an
367 array reference, its return value is ignored.
371 =item on_disconnect_do
373 Takes arguments in the same form as L</on_connect_do> and executes them
374 immediately before disconnecting from the database.
376 Note, this only runs if you explicitly call L</disconnect> on the
379 =item on_connect_call
381 A more generalized form of L</on_connect_do> that calls the specified
382 C<connect_call_METHOD> methods in your storage driver.
384 on_connect_do => 'select 1'
388 on_connect_call => [ [ do_sql => 'select 1' ] ]
390 Its values may contain:
396 Will call the C<connect_call_METHOD> method.
398 =item a code reference
400 Will execute C<< $code->($storage) >>
402 =item an array reference
404 Each value can be a method name or code reference.
406 =item an array of arrays
408 For each array, the first item is taken to be the C<connect_call_> method name
409 or code reference, and the rest are parameters to it.
413 Some predefined storage methods you may use:
419 Executes a SQL string or a code reference that returns a SQL string. This is
420 what L</on_connect_do> and L</on_disconnect_do> use.
428 Will execute the scalar as SQL.
432 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
433 attributes hashref and bind values.
435 =item a code reference
437 Will execute C<< $code->($storage) >> and execute the return array refs as
444 Execute any statements necessary to initialize the database session to return
445 and accept datetime/timestamp values used with
446 L<DBIx::Class::InflateColumn::DateTime>.
448 Only necessary for some databases, see your specific storage driver for
449 implementation details.
453 =item on_disconnect_call
455 Takes arguments in the same form as L</on_connect_call> and executes them
456 immediately before disconnecting from the database.
458 Calls the C<disconnect_call_METHOD> methods as opposed to the
459 C<connect_call_METHOD> methods called by L</on_connect_call>.
461 Note, this only runs if you explicitly call L</disconnect> on the
464 =item disable_sth_caching
466 If set to a true value, this option will disable the caching of
467 statement handles via L<DBI/prepare_cached>.
471 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
472 default L</sql_limit_dialect> setting of the storage (if any). For a list
473 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
477 When true automatically sets L</quote_char> and L</name_sep> to the characters
478 appropriate for your particular RDBMS. This option is preferred over specifying
479 L</quote_char> directly.
483 Specifies what characters to use to quote table and column names.
485 C<quote_char> expects either a single character, in which case is it
486 is placed on either side of the table/column name, or an arrayref of length
487 2 in which case the table/column name is placed between the elements.
489 For example under MySQL you should use C<< quote_char => '`' >>, and for
490 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
494 This parameter is only useful in conjunction with C<quote_char>, and is used to
495 specify the character that separates elements (schemas, tables, columns) from
496 each other. If unspecified it defaults to the most commonly used C<.>.
500 This Storage driver normally installs its own C<HandleError>, sets
501 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
502 all database handles, including those supplied by a coderef. It does this
503 so that it can have consistent and useful error behavior.
505 If you set this option to a true value, Storage will not do its usual
506 modifications to the database handle's attributes, and instead relies on
507 the settings in your connect_info DBI options (or the values you set in
508 your connection coderef, in the case that you are connecting via coderef).
510 Note that your custom settings can cause Storage to malfunction,
511 especially if you set a C<HandleError> handler that suppresses exceptions
512 and/or disable C<RaiseError>.
516 If this option is true, L<DBIx::Class> will use savepoints when nesting
517 transactions, making it possible to recover from failure in the inner
518 transaction without having to abort all outer transactions.
522 Use this argument to supply a cursor class other than the default
523 L<DBIx::Class::Storage::DBI::Cursor>.
527 Some real-life examples of arguments to L</connect_info> and
528 L<DBIx::Class::Schema/connect>
530 # Simple SQLite connection
531 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
534 ->connect_info([ sub { DBI->connect(...) } ]);
536 # Connect via subref in hashref
538 dbh_maker => sub { DBI->connect(...) },
539 on_connect_do => 'alter session ...',
542 # A bit more complicated
549 { quote_char => q{"} },
553 # Equivalent to the previous example
559 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
563 # Same, but with hashref as argument
564 # See parse_connect_info for explanation
567 dsn => 'dbi:Pg:dbname=foo',
569 password => 'my_pg_password',
576 # Subref + DBIx::Class-specific connection options
579 sub { DBI->connect(...) },
583 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
584 disable_sth_caching => 1,
594 my ($self, $info) = @_;
596 return $self->_connect_info if !$info;
598 $self->_connect_info($info); # copy for _connect_info
600 $info = $self->_normalize_connect_info($info)
601 if ref $info eq 'ARRAY';
603 for my $storage_opt (keys %{ $info->{storage_options} }) {
604 my $value = $info->{storage_options}{$storage_opt};
606 $self->$storage_opt($value);
609 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
610 # the new set of options
611 $self->_sql_maker(undef);
612 $self->_sql_maker_opts({});
614 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
615 my $value = $info->{sql_maker_options}{$sql_maker_opt};
617 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
621 %{ $self->_default_dbi_connect_attributes || {} },
622 %{ $info->{attributes} || {} },
625 my @args = @{ $info->{arguments} };
627 if (keys %attrs and ref $args[0] ne 'CODE') {
629 'You provided explicit AutoCommit => 0 in your connection_info. '
630 . 'This is almost universally a bad idea (see the footnotes of '
631 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
632 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
634 if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
636 push @args, \%attrs if keys %attrs;
638 $self->_dbi_connect_info(\@args);
641 # save attributes them in a separate accessor so they are always
642 # introspectable, even in case of a CODE $dbhmaker
643 $self->_dbic_connect_attributes (\%attrs);
645 return $self->_connect_info;
648 sub _normalize_connect_info {
649 my ($self, $info_arg) = @_;
652 my @args = @$info_arg; # take a shallow copy for further mutilation
654 # combine/pre-parse arguments depending on invocation style
657 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
658 %attrs = %{ $args[1] || {} };
661 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
662 %attrs = %{$args[0]};
664 if (my $code = delete $attrs{dbh_maker}) {
667 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
670 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
671 . "to the result of 'dbh_maker'",
673 join (', ', map { "'$_'" } (@ignored) ),
678 @args = delete @attrs{qw/dsn user password/};
681 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
683 % { $args[3] || {} },
684 % { $args[4] || {} },
686 @args = @args[0,1,2];
689 $info{arguments} = \@args;
691 my @storage_opts = grep exists $attrs{$_},
692 @storage_options, 'cursor_class';
694 @{ $info{storage_options} }{@storage_opts} =
695 delete @attrs{@storage_opts} if @storage_opts;
697 my @sql_maker_opts = grep exists $attrs{$_},
698 qw/limit_dialect quote_char name_sep quote_names/;
700 @{ $info{sql_maker_options} }{@sql_maker_opts} =
701 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
703 $info{attributes} = \%attrs if %attrs;
708 sub _default_dbi_connect_attributes () {
713 ShowErrorStatement => 1,
719 This method is deprecated in favour of setting via L</connect_info>.
723 =head2 on_disconnect_do
725 This method is deprecated in favour of setting via L</connect_info>.
729 sub _parse_connect_do {
730 my ($self, $type) = @_;
732 my $val = $self->$type;
733 return () if not defined $val;
738 push @res, [ 'do_sql', $val ];
739 } elsif (ref($val) eq 'CODE') {
741 } elsif (ref($val) eq 'ARRAY') {
742 push @res, map { [ 'do_sql', $_ ] } @$val;
744 $self->throw_exception("Invalid type for $type: ".ref($val));
752 Arguments: ($subref | $method_name), @extra_coderef_args?
754 Execute the given $subref or $method_name using the new exception-based
755 connection management.
757 The first two arguments will be the storage object that C<dbh_do> was called
758 on and a database handle to use. Any additional arguments will be passed
759 verbatim to the called subref as arguments 2 and onwards.
761 Using this (instead of $self->_dbh or $self->dbh) ensures correct
762 exception handling and reconnection (or failover in future subclasses).
764 Your subref should have no side-effects outside of the database, as
765 there is the potential for your subref to be partially double-executed
766 if the database connection was stale/dysfunctional.
770 my @stuff = $schema->storage->dbh_do(
772 my ($storage, $dbh, @cols) = @_;
773 my $cols = join(q{, }, @cols);
774 $dbh->selectrow_array("SELECT $cols FROM foo");
783 my $run_target = shift;
785 # short circuit when we know there is no need for a runner
787 # FIXME - asumption may be wrong
788 # the rationale for the txn_depth check is that if this block is a part
789 # of a larger transaction, everything up to that point is screwed anyway
790 return $self->$run_target($self->_get_dbh, @_)
791 if $self->{_in_do_block} or $self->transaction_depth;
793 # take a ref instead of a copy, to preserve @_ aliasing
794 # semantics within the coderef, but only if needed
795 # (pseudoforking doesn't like this trick much)
796 my $args = @_ ? \@_ : [];
798 DBIx::Class::Storage::BlockRunner->new(
800 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
802 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
807 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
808 shift->next::method(@_);
813 Our C<disconnect> method also performs a rollback first if the
814 database is not in C<AutoCommit> mode.
824 push @actions, ( $self->on_disconnect_call || () );
825 push @actions, $self->_parse_connect_do ('on_disconnect_do');
827 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
829 # stops the "implicit rollback on disconnect" warning
830 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
832 %{ $self->_dbh->{CachedKids} } = ();
833 $self->_dbh->disconnect;
838 =head2 with_deferred_fk_checks
842 =item Arguments: C<$coderef>
844 =item Return Value: The return value of $coderef
848 Storage specific method to run the code ref with FK checks deferred or
849 in MySQL's case disabled entirely.
853 # Storage subclasses should override this
854 sub with_deferred_fk_checks {
855 my ($self, $sub) = @_;
863 =item Arguments: none
865 =item Return Value: 1|0
869 Verifies that the current database handle is active and ready to execute
870 an SQL statement (e.g. the connection did not get stale, server is still
871 answering, etc.) This method is used internally by L</dbh>.
877 return 0 unless $self->_seems_connected;
880 local $self->_dbh->{RaiseError} = 1;
885 sub _seems_connected {
888 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
890 my $dbh = $self->_dbh
893 return $dbh->FETCH('Active');
899 my $dbh = $self->_dbh or return 0;
904 sub ensure_connected {
907 unless ($self->connected) {
908 $self->_populate_dbh;
914 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
915 is guaranteed to be healthy by implicitly calling L</connected>, and if
916 necessary performing a reconnection before returning. Keep in mind that this
917 is very B<expensive> on some database engines. Consider using L</dbh_do>
925 if (not $self->_dbh) {
926 $self->_populate_dbh;
928 $self->ensure_connected;
933 # this is the internal "get dbh or connect (don't check)" method
936 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
937 $self->_populate_dbh unless $self->_dbh;
943 unless ($self->_sql_maker) {
944 my $sql_maker_class = $self->sql_maker_class;
946 my %opts = %{$self->_sql_maker_opts||{}};
950 $self->sql_limit_dialect
953 my $s_class = (ref $self) || $self;
955 "Your storage class ($s_class) does not set sql_limit_dialect and you "
956 . 'have not supplied an explicit limit_dialect in your connection_info. '
957 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
958 . 'databases but can be (and often is) painfully slow. '
959 . "Please file an RT ticket against '$s_class' ."
966 my ($quote_char, $name_sep);
968 if ($opts{quote_names}) {
969 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
970 my $s_class = (ref $self) || $self;
972 "You requested 'quote_names' but your storage class ($s_class) does "
973 . 'not explicitly define a default sql_quote_char and you have not '
974 . 'supplied a quote_char as part of your connection_info. DBIC will '
975 .q{default to the ANSI SQL standard quote '"', which works most of }
976 . "the time. Please file an RT ticket against '$s_class'."
982 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
985 $self->_sql_maker($sql_maker_class->new(
987 array_datatypes => 1,
988 limit_dialect => $dialect,
989 ($quote_char ? (quote_char => $quote_char) : ()),
990 name_sep => ($name_sep || '.'),
994 return $self->_sql_maker;
997 # nothing to do by default
1004 my @info = @{$self->_dbi_connect_info || []};
1005 $self->_dbh(undef); # in case ->connected failed we might get sent here
1006 $self->_dbh_details({}); # reset everything we know
1008 $self->_dbh($self->_connect(@info));
1010 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1012 $self->_determine_driver;
1014 # Always set the transaction depth on connect, since
1015 # there is no transaction in progress by definition
1016 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1018 $self->_run_connection_actions unless $self->{_in_determine_driver};
1021 sub _run_connection_actions {
1025 push @actions, ( $self->on_connect_call || () );
1026 push @actions, $self->_parse_connect_do ('on_connect_do');
1028 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1033 sub set_use_dbms_capability {
1034 $_[0]->set_inherited ($_[1], $_[2]);
1037 sub get_use_dbms_capability {
1038 my ($self, $capname) = @_;
1040 my $use = $self->get_inherited ($capname);
1043 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1047 sub set_dbms_capability {
1048 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1051 sub get_dbms_capability {
1052 my ($self, $capname) = @_;
1054 my $cap = $self->_dbh_details->{capability}{$capname};
1056 unless (defined $cap) {
1057 if (my $meth = $self->can ("_determine$capname")) {
1058 $cap = $self->$meth ? 1 : 0;
1064 $self->set_dbms_capability ($capname, $cap);
1074 unless ($info = $self->_dbh_details->{info}) {
1078 my $server_version = try {
1079 $self->_get_server_version
1081 # driver determination *may* use this codepath
1082 # in which case we must rethrow
1083 $self->throw_exception($_) if $self->{_in_determine_driver};
1085 # $server_version on failure
1089 if (defined $server_version) {
1090 $info->{dbms_version} = $server_version;
1092 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1093 my @verparts = split (/\./, $numeric_version);
1099 # consider only up to 3 version parts, iff not more than 3 digits
1101 while (@verparts && @use_parts < 3) {
1102 my $p = shift @verparts;
1104 push @use_parts, $p;
1106 push @use_parts, 0 while @use_parts < 3;
1108 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1112 $self->_dbh_details->{info} = $info;
1118 sub _get_server_version {
1119 shift->_dbh_get_info('SQL_DBMS_VER');
1123 my ($self, $info) = @_;
1125 if ($info =~ /[^0-9]/) {
1126 require DBI::Const::GetInfoType;
1127 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1128 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1129 unless defined $info;
1132 $self->_get_dbh->get_info($info);
1135 sub _describe_connection {
1136 require DBI::Const::GetInfoReturn;
1139 $self->ensure_connected;
1142 DBIC_DSN => $self->_dbi_connect_info->[0],
1143 DBI_VER => DBI->VERSION,
1144 DBIC_VER => DBIx::Class->VERSION,
1145 DBIC_DRIVER => ref $self,
1149 #keys %DBI::Const::GetInfoType::GetInfoType,
1151 SQL_CURSOR_COMMIT_BEHAVIOR
1152 SQL_CURSOR_ROLLBACK_BEHAVIOR
1153 SQL_CURSOR_SENSITIVITY
1154 SQL_DATA_SOURCE_NAME
1157 SQL_DEFAULT_TXN_ISOLATION
1162 SQL_EXPRESSIONS_IN_ORDERBY
1165 SQL_IDENTIFIER_QUOTE_CHAR
1166 SQL_MAX_CATALOG_NAME_LEN
1167 SQL_MAX_COLUMN_NAME_LEN
1168 SQL_MAX_IDENTIFIER_LEN
1169 SQL_MAX_TABLE_NAME_LEN
1170 SQL_MULTIPLE_ACTIVE_TXN
1171 SQL_MULT_RESULT_SETS
1172 SQL_NEED_LONG_DATA_LEN
1173 SQL_NON_NULLABLE_COLUMNS
1175 SQL_QUALIFIER_NAME_SEPARATOR
1176 SQL_QUOTED_IDENTIFIER_CASE
1178 SQL_TXN_ISOLATION_OPTION
1181 # some drivers barf on things they do not know about instead
1182 # of returning undef
1183 my $v = try { $self->_dbh_get_info($inf) };
1184 next unless defined $v;
1186 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1187 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1188 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1194 sub _determine_driver {
1197 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1198 my $started_connected = 0;
1199 local $self->{_in_determine_driver} = 1;
1201 if (ref($self) eq __PACKAGE__) {
1203 if ($self->_dbh) { # we are connected
1204 $driver = $self->_dbh->{Driver}{Name};
1205 $started_connected = 1;
1208 # if connect_info is a CODEREF, we have no choice but to connect
1209 if (ref $self->_dbi_connect_info->[0] &&
1210 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1211 $self->_populate_dbh;
1212 $driver = $self->_dbh->{Driver}{Name};
1215 # try to use dsn to not require being connected, the driver may still
1216 # force a connection in _rebless to determine version
1217 # (dsn may not be supplied at all if all we do is make a mock-schema)
1218 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1219 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1220 $driver ||= $ENV{DBI_DRIVER};
1225 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1226 if ($self->load_optional_class($storage_class)) {
1227 mro::set_mro($storage_class, 'c3');
1228 bless $self, $storage_class;
1232 $self->_warn_undetermined_driver(
1233 'This version of DBIC does not yet seem to supply a driver for '
1234 . "your particular RDBMS and/or connection method ('$driver')."
1239 $self->_warn_undetermined_driver(
1240 'Unable to extract a driver name from connect info - this '
1241 . 'should not have happened.'
1246 $self->_driver_determined(1);
1248 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1250 if ($self->can('source_bind_attributes')) {
1251 $self->throw_exception(
1252 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1253 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1254 . 'If you are not sure how to proceed please contact the development team via '
1255 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1259 $self->_init; # run driver-specific initializations
1261 $self->_run_connection_actions
1262 if !$started_connected && defined $self->_dbh;
1266 sub _determine_connector_driver {
1267 my ($self, $conn) = @_;
1269 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1272 $self->_warn_undetermined_driver(
1273 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1274 . "$conn connector - this should not have happened."
1279 $dbtype =~ s/\W/_/gi;
1281 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1282 return if $self->isa($subclass);
1284 if ($self->load_optional_class($subclass)) {
1285 bless $self, $subclass;
1289 $self->_warn_undetermined_driver(
1290 'This version of DBIC does not yet seem to supply a driver for '
1291 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1296 sub _warn_undetermined_driver {
1297 my ($self, $msg) = @_;
1299 require Data::Dumper::Concise;
1301 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1302 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1303 . "does not go away, file a bugreport including the following info:\n"
1304 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1308 sub _do_connection_actions {
1310 my $method_prefix = shift;
1313 if (not ref($call)) {
1314 my $method = $method_prefix . $call;
1316 } elsif (ref($call) eq 'CODE') {
1318 } elsif (ref($call) eq 'ARRAY') {
1319 if (ref($call->[0]) ne 'ARRAY') {
1320 $self->_do_connection_actions($method_prefix, $_) for @$call;
1322 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1325 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1331 sub connect_call_do_sql {
1333 $self->_do_query(@_);
1336 sub disconnect_call_do_sql {
1338 $self->_do_query(@_);
1341 # override in db-specific backend when necessary
1342 sub connect_call_datetime_setup { 1 }
1345 my ($self, $action) = @_;
1347 if (ref $action eq 'CODE') {
1348 $action = $action->($self);
1349 $self->_do_query($_) foreach @$action;
1352 # Most debuggers expect ($sql, @bind), so we need to exclude
1353 # the attribute hash which is the second argument to $dbh->do
1354 # furthermore the bind values are usually to be presented
1355 # as named arrayref pairs, so wrap those here too
1356 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1357 my $sql = shift @do_args;
1358 my $attrs = shift @do_args;
1359 my @bind = map { [ undef, $_ ] } @do_args;
1362 $_[0]->_query_start($sql, \@bind);
1363 $_[1]->do($sql, $attrs, @do_args);
1364 $_[0]->_query_end($sql, \@bind);
1372 my ($self, @info) = @_;
1374 $self->throw_exception("You failed to provide any connection info")
1377 my ($old_connect_via, $dbh);
1379 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1382 if(ref $info[0] eq 'CODE') {
1383 $dbh = $info[0]->();
1387 $dbh = DBI->connect(@info);
1390 die $DBI::errstr unless $dbh;
1392 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1393 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1395 ref $info[0] eq 'CODE'
1396 ? "Connection coderef $info[0] returned a"
1397 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1398 ) unless $dbh->FETCH('Active');
1400 # sanity checks unless asked otherwise
1401 unless ($self->unsafe) {
1403 $self->throw_exception(
1404 'Refusing clobbering of {HandleError} installed on externally supplied '
1405 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1406 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1408 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1409 # request, or an external handle. Complain and set anyway
1410 unless ($dbh->{RaiseError}) {
1411 carp( ref $info[0] eq 'CODE'
1413 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1414 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1415 .'attribute has been supplied'
1417 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1418 .'unsafe => 1. Toggling RaiseError back to true'
1421 $dbh->{RaiseError} = 1;
1424 # this odd anonymous coderef dereference is in fact really
1425 # necessary to avoid the unwanted effect described in perl5
1428 my $weak_self = $_[0];
1431 # the coderef is blessed so we can distinguish it from externally
1432 # supplied handles (which must be preserved)
1433 $_[1]->{HandleError} = bless sub {
1435 $weak_self->throw_exception("DBI Exception: $_[0]");
1438 # the handler may be invoked by something totally out of
1440 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1442 }, '__DBIC__DBH__ERROR__HANDLER__';
1447 $self->throw_exception("DBI Connection failed: $_")
1450 $self->_dbh_autocommit($dbh->{AutoCommit});
1457 # this means we have not yet connected and do not know the AC status
1458 # (e.g. coderef $dbh), need a full-fledged connection check
1459 if (! defined $self->_dbh_autocommit) {
1460 $self->ensure_connected;
1462 # Otherwise simply connect or re-connect on pid changes
1467 $self->next::method(@_);
1470 sub _exec_txn_begin {
1473 # if the user is utilizing txn_do - good for him, otherwise we need to
1474 # ensure that the $dbh is healthy on BEGIN.
1475 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1476 # will be replaced by a failure of begin_work itself (which will be
1477 # then retried on reconnect)
1478 if ($self->{_in_do_block}) {
1479 $self->_dbh->begin_work;
1481 $self->dbh_do(sub { $_[1]->begin_work });
1488 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1489 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1492 # esoteric case for folks using external $dbh handles
1493 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1494 carp "Storage transaction_depth 0 does not match "
1495 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1496 $self->transaction_depth(1);
1499 $self->next::method(@_);
1501 # if AutoCommit is disabled txn_depth never goes to 0
1502 # as a new txn is started immediately on commit
1503 $self->transaction_depth(1) if (
1504 !$self->transaction_depth
1506 defined $self->_dbh_autocommit
1508 ! $self->_dbh_autocommit
1512 sub _exec_txn_commit {
1513 shift->_dbh->commit;
1519 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1520 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1523 # esoteric case for folks using external $dbh handles
1524 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1525 carp "Storage transaction_depth 0 does not match "
1526 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1527 $self->transaction_depth(1);
1530 $self->next::method(@_);
1532 # if AutoCommit is disabled txn_depth never goes to 0
1533 # as a new txn is started immediately on commit
1534 $self->transaction_depth(1) if (
1535 !$self->transaction_depth
1537 defined $self->_dbh_autocommit
1539 ! $self->_dbh_autocommit
1543 sub _exec_txn_rollback {
1544 shift->_dbh->rollback;
1547 # generate some identical methods
1548 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1550 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1552 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1553 $self->throw_exception("Unable to $meth() on a disconnected storage")
1555 $self->next::method(@_);
1559 # This used to be the top-half of _execute. It was split out to make it
1560 # easier to override in NoBindVars without duping the rest. It takes up
1561 # all of _execute's args, and emits $sql, @bind.
1562 sub _prep_for_execute {
1563 #my ($self, $op, $ident, $args) = @_;
1564 return shift->_gen_sql_bind(@_)
1568 my ($self, $op, $ident, $args) = @_;
1570 my ($colinfos, $from);
1571 if ( blessed($ident) ) {
1572 $from = $ident->from;
1573 $colinfos = $ident->columns_info;
1577 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1579 $bind = $self->_resolve_bindattrs(
1580 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1584 ! $ENV{DBIC_DT_SEARCH_OK}
1593 $_->[1]->isa('DateTime')
1596 carp_unique 'DateTime objects passed to search() are not supported '
1597 . 'properly (InflateColumn::DateTime formats and settings are not '
1598 . 'respected.) See "Formatting DateTime objects in queries" in '
1599 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1600 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1603 return( $sql, $bind );
1606 sub _resolve_bindattrs {
1607 my ($self, $ident, $bind, $colinfos) = @_;
1611 my $resolve_bindinfo = sub {
1612 #my $infohash = shift;
1614 %$colinfos = %{ $self->_resolve_column_info($ident) }
1615 unless keys %$colinfos;
1618 if (my $col = $_[0]->{dbic_colname}) {
1619 $ret = { %{$_[0]} };
1621 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1622 if $colinfos->{$col}{data_type};
1624 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1625 if $colinfos->{$col}{size};
1633 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1634 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1635 : (ref $_->[0] eq 'HASH') ? [ (exists $_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype})
1637 : $resolve_bindinfo->($_->[0])
1639 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1640 : [ $resolve_bindinfo->(
1641 { dbic_colname => $_->[0] }
1646 ! exists $resolved->[0]{dbd_attrs}
1648 ! $resolved->[0]{sqlt_datatype}
1650 length ref $resolved->[1]
1652 ! overload::Method($resolved->[1], '""')
1654 require Data::Dumper;
1655 local $Data::Dumper::Maxdepth = 1;
1656 local $Data::Dumper::Terse = 1;
1657 local $Data::Dumper::Useqq = 1;
1658 local $Data::Dumper::Indent = 0;
1659 local $Data::Dumper::Pad = ' ';
1660 $self->throw_exception(
1661 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1662 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1671 sub _format_for_trace {
1672 #my ($self, $bind) = @_;
1674 ### Turn @bind from something like this:
1675 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1677 ### ( "'1'", "'3'" )
1680 defined( $_ && $_->[1] )
1687 my ( $self, $sql, $bind ) = @_;
1689 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1694 my ( $self, $sql, $bind ) = @_;
1696 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1700 sub _dbi_attrs_for_bind {
1701 my ($self, $ident, $bind) = @_;
1705 for (map { $_->[0] } @$bind) {
1707 if (exists $_->{dbd_attrs}) {
1710 elsif($_->{sqlt_datatype}) {
1711 # cache the result in the dbh_details hash, as it can not change unless
1712 # we connect to something else
1713 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1714 if (not exists $cache->{$_->{sqlt_datatype}}) {
1715 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1717 $cache->{$_->{sqlt_datatype}};
1720 undef; # always push something at this position
1729 my ($self, $op, $ident, @args) = @_;
1731 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1733 # not even a PID check - we do not care about the state of the _dbh.
1734 # All we need is to get the appropriate drivers loaded if they aren't
1735 # already so that the assumption in ad7c50fc26e holds
1736 $self->_populate_dbh unless $self->_dbh;
1738 $self->dbh_do( _dbh_execute => # retry over disconnects
1741 $self->_dbi_attrs_for_bind($ident, $bind),
1746 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1748 $self->_query_start( $sql, $bind );
1750 my $sth = $self->_bind_sth_params(
1751 $self->_prepare_sth($dbh, $sql),
1756 # Can this fail without throwing an exception anyways???
1757 my $rv = $sth->execute();
1758 $self->throw_exception(
1759 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1762 $self->_query_end( $sql, $bind );
1764 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1768 my ($self, $dbh, $sql) = @_;
1770 # 3 is the if_active parameter which avoids active sth re-use
1771 my $sth = $self->disable_sth_caching
1772 ? $dbh->prepare($sql)
1773 : $dbh->prepare_cached($sql, {}, 3);
1775 # XXX You would think RaiseError would make this impossible,
1776 # but apparently that's not true :(
1777 $self->throw_exception(
1780 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1781 .'an exception and/or setting $dbh->errstr',
1783 ? substr($sql, 0, 20) . '...'
1786 'DBD::' . $dbh->{Driver}{Name},
1793 sub _bind_sth_params {
1794 my ($self, $sth, $bind, $bind_attrs) = @_;
1796 for my $i (0 .. $#$bind) {
1797 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1798 $sth->bind_param_inout(
1799 $i + 1, # bind params counts are 1-based
1801 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1806 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1807 # confirm with dbi-dev whether explicit stringification is needed
1808 my $v = ( length ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""') )
1823 sub _prefetch_autovalues {
1824 my ($self, $source, $colinfo, $to_insert) = @_;
1827 for my $col (keys %$colinfo) {
1829 $colinfo->{$col}{auto_nextval}
1832 ! exists $to_insert->{$col}
1834 ref $to_insert->{$col} eq 'SCALAR'
1836 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1839 $values{$col} = $self->_sequence_fetch(
1841 ( $colinfo->{$col}{sequence} ||=
1842 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1852 my ($self, $source, $to_insert) = @_;
1854 my $col_infos = $source->columns_info;
1856 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1858 # fuse the values, but keep a separate list of prefetched_values so that
1859 # they can be fused once again with the final return
1860 $to_insert = { %$to_insert, %$prefetched_values };
1862 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1863 # Investigate what does it take to s/defined/exists/
1864 my %pcols = map { $_ => 1 } $source->primary_columns;
1865 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1866 for my $col ($source->columns) {
1867 if ($col_infos->{$col}{is_auto_increment}) {
1868 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1869 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1872 # nothing to retrieve when explicit values are supplied
1873 next if (defined $to_insert->{$col} and ! (
1874 ref $to_insert->{$col} eq 'SCALAR'
1876 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1879 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1880 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1883 $col_infos->{$col}{retrieve_on_insert}
1887 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1888 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1890 my ($sqla_opts, @ir_container);
1891 if (%retrieve_cols and $self->_use_insert_returning) {
1892 $sqla_opts->{returning_container} = \@ir_container
1893 if $self->_use_insert_returning_bound;
1895 $sqla_opts->{returning} = [
1896 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1900 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1902 my %returned_cols = %$to_insert;
1903 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1904 @ir_container = try {
1905 local $SIG{__WARN__} = sub {};
1906 my @r = $sth->fetchrow_array;
1909 } unless @ir_container;
1911 @returned_cols{@$retlist} = @ir_container if @ir_container;
1914 # pull in PK if needed and then everything else
1915 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1917 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1918 unless $self->can('last_insert_id');
1920 my @pri_values = $self->last_insert_id($source, @missing_pri);
1922 $self->throw_exception( "Can't get last insert id" )
1923 unless (@pri_values == @missing_pri);
1925 @returned_cols{@missing_pri} = @pri_values;
1926 delete @retrieve_cols{@missing_pri};
1929 # if there is more left to pull
1930 if (%retrieve_cols) {
1931 $self->throw_exception(
1932 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1935 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1937 my $cur = DBIx::Class::ResultSet->new($source, {
1938 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1939 select => \@left_to_fetch,
1942 @returned_cols{@left_to_fetch} = $cur->next;
1944 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1945 if scalar $cur->next;
1949 return { %$prefetched_values, %returned_cols };
1953 my ($self, $source, $cols, $data) = @_;
1955 my @col_range = (0..$#$cols);
1957 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1958 # confirm with dbi-dev whether explicit stringification is needed
1960 # forcibly stringify whatever is stringifiable
1961 # ResultSet::populate() hands us a copy - safe to mangle
1962 for my $r (0 .. $#$data) {
1963 for my $c (0 .. $#{$data->[$r]}) {
1964 $data->[$r][$c] = "$data->[$r][$c]"
1965 if ( length ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1969 my $colinfos = $source->columns_info($cols);
1971 local $self->{_autoinc_supplied_for_op} =
1972 (first { $_->{is_auto_increment} } values %$colinfos)
1977 # get a slice type index based on first row of data
1978 # a "column" in this context may refer to more than one bind value
1979 # e.g. \[ '?, ?', [...], [...] ]
1981 # construct the value type index - a description of values types for every
1982 # per-column slice of $data:
1984 # nonexistent - nonbind literal
1986 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1988 # also construct the column hash to pass to the SQL generator. For plain
1989 # (non literal) values - convert the members of the first row into a
1990 # literal+bind combo, with extra positional info in the bind attr hashref.
1991 # This will allow us to match the order properly, and is so contrived
1992 # because a user-supplied literal/bind (or something else specific to a
1993 # resultsource and/or storage driver) can inject extra binds along the
1994 # way, so one can't rely on "shift positions" ordering at all. Also we
1995 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1996 # can be later matched up by address), because we want to supply a real
1997 # value on which perhaps e.g. datatype checks will be performed
1998 my ($proto_data, $value_type_by_col_idx);
1999 for my $i (@col_range) {
2000 my $colname = $cols->[$i];
2001 if (ref $data->[0][$i] eq 'SCALAR') {
2002 # no bind value at all - no type
2004 $proto_data->{$colname} = $data->[0][$i];
2006 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
2007 # repack, so we don't end up mangling the original \[]
2008 my ($sql, @bind) = @${$data->[0][$i]};
2010 # normalization of user supplied stuff
2011 my $resolved_bind = $self->_resolve_bindattrs(
2012 $source, \@bind, $colinfos,
2015 # store value-less (attrs only) bind info - we will be comparing all
2016 # supplied binds against this for sanity
2017 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
2019 $proto_data->{$colname} = \[ $sql, map { [
2020 # inject slice order to use for $proto_bind construction
2021 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
2023 $resolved_bind->[$_][1]
2028 $value_type_by_col_idx->{$i} = undef;
2030 $proto_data->{$colname} = \[ '?', [
2031 { dbic_colname => $colname, _bind_data_slice_idx => $i }
2038 my ($sql, $proto_bind) = $self->_prep_for_execute (
2044 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2045 # if the bindlist is empty and we had some dynamic binds, this means the
2046 # storage ate them away (e.g. the NoBindVars component) and interpolated
2047 # them directly into the SQL. This obviously can't be good for multi-inserts
2048 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2052 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2054 # use an error reporting closure for convenience (less to pass)
2055 my $bad_slice_report_cref = sub {
2056 my ($msg, $r_idx, $c_idx) = @_;
2057 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2061 require Data::Dumper::Concise;
2062 local $Data::Dumper::Maxdepth = 5;
2063 Data::Dumper::Concise::Dumper ({
2064 map { $cols->[$_] =>
2072 for my $col_idx (@col_range) {
2073 my $reference_val = $data->[0][$col_idx];
2075 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2076 my $val = $data->[$row_idx][$col_idx];
2078 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2079 if (ref $val ne 'SCALAR') {
2080 $bad_slice_report_cref->(
2081 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2086 elsif ($$val ne $$reference_val) {
2087 $bad_slice_report_cref->(
2088 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2094 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2095 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2096 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2099 else { # binds from a \[], compare type and attrs
2100 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2101 $bad_slice_report_cref->(
2102 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2107 # start drilling down and bail out early on identical refs
2109 $reference_val != $val
2111 $$reference_val != $$val
2113 if (${$val}->[0] ne ${$reference_val}->[0]) {
2114 $bad_slice_report_cref->(
2115 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2120 # need to check the bind attrs - a bind will happen only once for
2121 # the entire dataset, so any changes further down will be ignored.
2122 elsif (! Data::Compare::Compare(
2123 $value_type_by_col_idx->{$col_idx},
2127 @{$self->_resolve_bindattrs(
2128 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2132 $bad_slice_report_cref->(
2133 'Differing bind attributes on literal/bind values not supported',
2143 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2144 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2146 my $guard = $self->txn_scope_guard;
2148 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2149 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2152 # proto bind contains the information on which pieces of $data to pull
2153 # $cols is passed in only for prettier error-reporting
2154 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2157 # bind_param_array doesn't work if there are no binds
2158 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2162 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2166 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2169 # execute_for_fetch is capable of returning data just fine (it means it
2170 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2171 # is the void-populate fast-path we will just ignore this altogether
2172 # for the time being.
2173 sub _dbh_execute_for_fetch {
2174 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2176 my @idx_range = ( 0 .. $#$proto_bind );
2178 # If we have any bind attributes to take care of, we will bind the
2179 # proto-bind data (which will never be used by execute_for_fetch)
2180 # However since column bindtypes are "sticky", this is sufficient
2181 # to get the DBD to apply the bindtype to all values later on
2183 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2185 for my $i (@idx_range) {
2187 $i+1, # DBI bind indexes are 1-based
2188 $proto_bind->[$i][1],
2190 ) if defined $bind_attrs->[$i];
2193 # At this point $data slots named in the _bind_data_slice_idx of
2194 # each piece of $proto_bind are either \[]s or plain values to be
2195 # passed in. Construct the dispensing coderef. *NOTE* the order
2196 # of $data will differ from this of the ?s in the SQL (due to
2197 # alphabetical ordering by colname). We actually do want to
2198 # preserve this behavior so that prepare_cached has a better
2199 # chance of matching on unrelated calls
2201 my $fetch_row_idx = -1; # saner loop this way
2202 my $fetch_tuple = sub {
2203 return undef if ++$fetch_row_idx > $#$data;
2205 return [ map { defined $_->{_literal_bind_subindex}
2206 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2207 ->[ $_->{_literal_bind_subindex} ]
2209 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2210 } map { $_->[0] } @$proto_bind];
2213 my $tuple_status = [];
2216 $rv = $sth->execute_for_fetch(
2225 # Not all DBDs are create equal. Some throw on error, some return
2226 # an undef $rv, and some set $sth->err - try whatever we can
2227 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2230 ( !defined $rv or $sth->err )
2233 # Statement must finish even if there was an exception.
2238 $err = shift unless defined $err
2243 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2245 $self->throw_exception("Unexpected populate error: $err")
2246 if ($i > $#$tuple_status);
2248 require Data::Dumper::Concise;
2249 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2250 ($tuple_status->[$i][1] || $err),
2251 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2258 sub _dbh_execute_inserts_with_no_binds {
2259 my ($self, $sth, $count) = @_;
2263 my $dbh = $self->_get_dbh;
2264 local $dbh->{RaiseError} = 1;
2265 local $dbh->{PrintError} = 0;
2267 $sth->execute foreach 1..$count;
2273 # Make sure statement is finished even if there was an exception.
2278 $err = shift unless defined $err;
2281 $self->throw_exception($err) if defined $err;
2287 #my ($self, $source, @args) = @_;
2288 shift->_execute('update', @_);
2293 #my ($self, $source, @args) = @_;
2294 shift->_execute('delete', @_);
2299 $self->_execute($self->_select_args(@_));
2302 sub _select_args_to_query {
2305 $self->throw_exception(
2306 "Unable to generate limited query representation with 'software_limit' enabled"
2307 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2309 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2310 # = $self->_select_args($ident, $select, $cond, $attrs);
2311 my ($op, $ident, @args) =
2312 $self->_select_args(@_);
2314 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2315 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2317 # reuse the bind arrayref
2318 unshift @{$bind}, "($sql)";
2323 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2326 'select', @{$orig_attrs->{_sqlmaker_select_args}}
2327 ) if $orig_attrs->{_sqlmaker_select_args};
2329 my $sql_maker = $self->sql_maker;
2330 my $alias2source = $self->_resolve_ident_sources ($ident);
2338 # limit dialects use this stuff
2339 # yes, some CDBICompat crap does not supply an {alias} >.<
2340 ( $orig_attrs->{alias} and $alias2source->{$orig_attrs->{alias}} )
2341 ? ( _rsroot_rsrc => $alias2source->{$orig_attrs->{alias}} )
2346 # Sanity check the attributes (SQLMaker does it too, but
2347 # in case of a software_limit we'll never reach there)
2348 if (defined $attrs->{offset}) {
2349 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2350 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2353 if (defined $attrs->{rows}) {
2354 $self->throw_exception("The rows attribute must be a positive integer if present")
2355 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2357 elsif ($attrs->{offset}) {
2358 # MySQL actually recommends this approach. I cringe.
2359 $attrs->{rows} = $sql_maker->__max_int;
2362 # see if we will need to tear the prefetch apart to satisfy group_by == select
2363 # this is *extremely tricky* to get right, I am still not sure I did
2365 my ($prefetch_needs_subquery, @limit_args);
2367 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2368 # we already know there is a valid group_by and we know it is intended
2369 # to be based *only* on the main result columns
2370 # short circuit the group_by parsing below
2371 $prefetch_needs_subquery = 1;
2374 # The rationale is that even if we do *not* have collapse, we still
2375 # need to wrap the core grouped select/group_by in a subquery
2376 # so that databases that care about group_by/select equivalence
2377 # are happy (this includes MySQL in strict_mode)
2378 # If any of the other joined tables are referenced in the group_by
2379 # however - the user is on their own
2380 ( $prefetch_needs_subquery or $attrs->{_related_results_construction} )
2384 @{$attrs->{group_by}}
2386 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2387 $self->_resolve_aliastypes_from_select_args( $attrs->{from}, undef, undef, { group_by => $attrs->{group_by} } )
2390 # no aliases other than our own in group_by
2391 # if there are - do not allow subquery even if limit is present
2392 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2394 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2395 # active collapse with a limit - that one is a no-brainer unless
2396 # overruled by a group_by above
2397 $prefetch_needs_subquery = 1;
2400 if ($prefetch_needs_subquery) {
2401 ($ident, $select, $where, $attrs) =
2402 $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2404 elsif (! $attrs->{software_limit} ) {
2406 $attrs->{rows} || (),
2407 $attrs->{offset} || (),
2411 # try to simplify the joinmap further (prune unreferenced type-single joins)
2413 ! $prefetch_needs_subquery # already pruned
2417 reftype $ident eq 'ARRAY'
2421 ($ident, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2425 # This would be the point to deflate anything found in $where
2426 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2427 # expect a result object. And all we have is a resultsource (it is trivial
2428 # to extract deflator coderefs via $alias2source above).
2430 # I don't see a way forward other than changing the way deflators are
2431 # invoked, and that's just bad...
2434 return ( 'select', @{ $orig_attrs->{_sqlmaker_select_args} = [
2435 $ident, $select, $where, $attrs, @limit_args
2439 # Returns a counting SELECT for a simple count
2440 # query. Abstracted so that a storage could override
2441 # this to { count => 'firstcol' } or whatever makes
2442 # sense as a performance optimization
2444 #my ($self, $source, $rs_attrs) = @_;
2445 return { count => '*' };
2452 =item Arguments: $ident, $select, $condition, $attrs
2456 Handle a SQL select statement.
2462 my ($ident, $select, $condition, $attrs) = @_;
2463 return $self->cursor_class->new($self, \@_, $attrs);
2468 my ($rv, $sth, @bind) = $self->_select(@_);
2469 my @row = $sth->fetchrow_array;
2470 my @nextrow = $sth->fetchrow_array if @row;
2471 if(@row && @nextrow) {
2472 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2474 # Need to call finish() to work round broken DBDs
2479 =head2 sql_limit_dialect
2481 This is an accessor for the default SQL limit dialect used by a particular
2482 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2483 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2484 see L<DBIx::Class::SQLMaker::LimitDialects>.
2488 sub _dbh_columns_info_for {
2489 my ($self, $dbh, $table) = @_;
2491 if ($dbh->can('column_info')) {
2495 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2496 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2498 while ( my $info = $sth->fetchrow_hashref() ){
2500 $column_info{data_type} = $info->{TYPE_NAME};
2501 $column_info{size} = $info->{COLUMN_SIZE};
2502 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2503 $column_info{default_value} = $info->{COLUMN_DEF};
2504 my $col_name = $info->{COLUMN_NAME};
2505 $col_name =~ s/^\"(.*)\"$/$1/;
2507 $result{$col_name} = \%column_info;
2512 return \%result if !$caught && scalar keys %result;
2516 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2518 my @columns = @{$sth->{NAME_lc}};
2519 for my $i ( 0 .. $#columns ){
2521 $column_info{data_type} = $sth->{TYPE}->[$i];
2522 $column_info{size} = $sth->{PRECISION}->[$i];
2523 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2525 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2526 $column_info{data_type} = $1;
2527 $column_info{size} = $2;
2530 $result{$columns[$i]} = \%column_info;
2534 foreach my $col (keys %result) {
2535 my $colinfo = $result{$col};
2536 my $type_num = $colinfo->{data_type};
2538 if(defined $type_num && $dbh->can('type_info')) {
2539 my $type_info = $dbh->type_info($type_num);
2540 $type_name = $type_info->{TYPE_NAME} if $type_info;
2541 $colinfo->{data_type} = $type_name if $type_name;
2548 sub columns_info_for {
2549 my ($self, $table) = @_;
2550 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2553 =head2 last_insert_id
2555 Return the row id of the last insert.
2559 sub _dbh_last_insert_id {
2560 my ($self, $dbh, $source, $col) = @_;
2562 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2564 return $id if defined $id;
2566 my $class = ref $self;
2567 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2570 sub last_insert_id {
2572 $self->_dbh_last_insert_id ($self->_dbh, @_);
2575 =head2 _native_data_type
2579 =item Arguments: $type_name
2583 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2584 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2585 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2587 The default implementation returns C<undef>, implement in your Storage driver if
2588 you need this functionality.
2590 Should map types from other databases to the native RDBMS type, for example
2591 C<VARCHAR2> to C<VARCHAR>.
2593 Types with modifiers should map to the underlying data type. For example,
2594 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2596 Composite types should map to the container type, for example
2597 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2601 sub _native_data_type {
2602 #my ($self, $data_type) = @_;
2606 # Check if placeholders are supported at all
2607 sub _determine_supports_placeholders {
2609 my $dbh = $self->_get_dbh;
2611 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2612 # but it is inaccurate more often than not
2614 local $dbh->{PrintError} = 0;
2615 local $dbh->{RaiseError} = 1;
2616 $dbh->do('select ?', {}, 1);
2624 # Check if placeholders bound to non-string types throw exceptions
2626 sub _determine_supports_typeless_placeholders {
2628 my $dbh = $self->_get_dbh;
2631 local $dbh->{PrintError} = 0;
2632 local $dbh->{RaiseError} = 1;
2633 # this specifically tests a bind that is NOT a string
2634 $dbh->do('select 1 where 1 = ?', {}, 1);
2644 Returns the database driver name.
2649 shift->_get_dbh->{Driver}->{Name};
2652 =head2 bind_attribute_by_data_type
2654 Given a datatype from column info, returns a database specific bind
2655 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2656 let the database planner just handle it.
2658 This method is always called after the driver has been determined and a DBI
2659 connection has been established. Therefore you can refer to C<DBI::$constant>
2660 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2661 the correct modules.
2665 sub bind_attribute_by_data_type {
2669 =head2 is_datatype_numeric
2671 Given a datatype from column_info, returns a boolean value indicating if
2672 the current RDBMS considers it a numeric value. This controls how
2673 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2674 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2675 be performed instead of the usual C<eq>.
2679 sub is_datatype_numeric {
2680 #my ($self, $dt) = @_;
2682 return 0 unless $_[1];
2685 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2690 =head2 create_ddl_dir
2694 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2698 Creates a SQL file based on the Schema, for each of the specified
2699 database engines in C<\@databases> in the given directory.
2700 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2702 Given a previous version number, this will also create a file containing
2703 the ALTER TABLE statements to transform the previous schema into the
2704 current one. Note that these statements may contain C<DROP TABLE> or
2705 C<DROP COLUMN> statements that can potentially destroy data.
2707 The file names are created using the C<ddl_filename> method below, please
2708 override this method in your schema if you would like a different file
2709 name format. For the ALTER file, the same format is used, replacing
2710 $version in the name with "$preversion-$version".
2712 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2713 The most common value for this would be C<< { add_drop_table => 1 } >>
2714 to have the SQL produced include a C<DROP TABLE> statement for each table
2715 created. For quoting purposes supply C<quote_identifiers>.
2717 If no arguments are passed, then the following default values are assumed:
2721 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2723 =item version - $schema->schema_version
2725 =item directory - './'
2727 =item preversion - <none>
2731 By default, C<\%sqlt_args> will have
2733 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2735 merged with the hash passed in. To disable any of those features, pass in a
2736 hashref like the following
2738 { ignore_constraint_names => 0, # ... other options }
2741 WARNING: You are strongly advised to check all SQL files created, before applying
2746 sub create_ddl_dir {
2747 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2750 carp "No directory given, using ./\n";
2755 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2757 $self->throw_exception(
2758 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2762 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2764 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2765 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2767 my $schema_version = $schema->schema_version || '1.x';
2768 $version ||= $schema_version;
2771 add_drop_table => 1,
2772 ignore_constraint_names => 1,
2773 ignore_index_names => 1,
2777 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2778 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2781 my $sqlt = SQL::Translator->new( $sqltargs );
2783 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2784 my $sqlt_schema = $sqlt->translate({ data => $schema })
2785 or $self->throw_exception ($sqlt->error);
2787 foreach my $db (@$databases) {
2789 $sqlt->{schema} = $sqlt_schema;
2790 $sqlt->producer($db);
2793 my $filename = $schema->ddl_filename($db, $version, $dir);
2794 if (-e $filename && ($version eq $schema_version )) {
2795 # if we are dumping the current version, overwrite the DDL
2796 carp "Overwriting existing DDL file - $filename";
2800 my $output = $sqlt->translate;
2802 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2805 if(!open($file, ">$filename")) {
2806 $self->throw_exception("Can't open $filename for writing ($!)");
2809 print $file $output;
2812 next unless ($preversion);
2814 require SQL::Translator::Diff;
2816 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2817 if(!-e $prefilename) {
2818 carp("No previous schema file found ($prefilename)");
2822 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2824 carp("Overwriting existing diff file - $difffile");
2830 my $t = SQL::Translator->new($sqltargs);
2835 or $self->throw_exception ($t->error);
2837 my $out = $t->translate( $prefilename )
2838 or $self->throw_exception ($t->error);
2840 $source_schema = $t->schema;
2842 $source_schema->name( $prefilename )
2843 unless ( $source_schema->name );
2846 # The "new" style of producers have sane normalization and can support
2847 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2848 # And we have to diff parsed SQL against parsed SQL.
2849 my $dest_schema = $sqlt_schema;
2851 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2852 my $t = SQL::Translator->new($sqltargs);
2857 or $self->throw_exception ($t->error);
2859 my $out = $t->translate( $filename )
2860 or $self->throw_exception ($t->error);
2862 $dest_schema = $t->schema;
2864 $dest_schema->name( $filename )
2865 unless $dest_schema->name;
2868 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2872 if(!open $file, ">$difffile") {
2873 $self->throw_exception("Can't write to $difffile ($!)");
2881 =head2 deployment_statements
2885 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2889 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2891 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2892 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2894 C<$directory> is used to return statements from files in a previously created
2895 L</create_ddl_dir> directory and is optional. The filenames are constructed
2896 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2898 If no C<$directory> is specified then the statements are constructed on the
2899 fly using L<SQL::Translator> and C<$version> is ignored.
2901 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2905 sub deployment_statements {
2906 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2907 $type ||= $self->sqlt_type;
2908 $version ||= $schema->schema_version || '1.x';
2910 my $filename = $schema->ddl_filename($type, $version, $dir);
2913 # FIXME replace this block when a proper sane sql parser is available
2915 open($file, "<$filename")
2916 or $self->throw_exception("Can't open $filename ($!)");
2919 return join('', @rows);
2922 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2923 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2926 # sources needs to be a parser arg, but for simplicty allow at top level
2928 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2929 if exists $sqltargs->{sources};
2931 my $tr = SQL::Translator->new(
2932 producer => "SQL::Translator::Producer::${type}",
2934 parser => 'SQL::Translator::Parser::DBIx::Class',
2938 return preserve_context {
2941 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2942 unless defined $_[0];
2946 # FIXME deploy() currently does not accurately report sql errors
2947 # Will always return true while errors are warned
2949 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2953 return if($line =~ /^--/);
2954 # next if($line =~ /^DROP/m);
2955 return if($line =~ /^BEGIN TRANSACTION/m);
2956 return if($line =~ /^COMMIT/m);
2957 return if $line =~ /^\s+$/; # skip whitespace only
2958 $self->_query_start($line);
2960 # do a dbh_do cycle here, as we need some error checking in
2961 # place (even though we will ignore errors)
2962 $self->dbh_do (sub { $_[1]->do($line) });
2964 carp qq{$_ (running "${line}")};
2966 $self->_query_end($line);
2968 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2969 if (@statements > 1) {
2970 foreach my $statement (@statements) {
2971 $deploy->( $statement );
2974 elsif (@statements == 1) {
2975 # split on single line comments and end of statements
2976 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2982 =head2 datetime_parser
2984 Returns the datetime parser class
2988 sub datetime_parser {
2990 return $self->{datetime_parser} ||= do {
2991 $self->build_datetime_parser(@_);
2995 =head2 datetime_parser_type
2997 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
2999 =head2 build_datetime_parser
3001 See L</datetime_parser>
3005 sub build_datetime_parser {
3007 my $type = $self->datetime_parser_type(@_);
3012 =head2 is_replicating
3014 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3015 replicate from a master database. Default is undef, which is the result
3016 returned by databases that don't support replication.
3020 sub is_replicating {
3025 =head2 lag_behind_master
3027 Returns a number that represents a certain amount of lag behind a master db
3028 when a given storage is replicating. The number is database dependent, but
3029 starts at zero and increases with the amount of lag. Default in undef
3033 sub lag_behind_master {
3037 =head2 relname_to_table_alias
3041 =item Arguments: $relname, $join_count
3043 =item Return Value: $alias
3047 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3050 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3051 way these aliases are named.
3053 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3054 otherwise C<"$relname">.
3058 sub relname_to_table_alias {
3059 my ($self, $relname, $join_count) = @_;
3061 my $alias = ($join_count && $join_count > 1 ?
3062 join('_', $relname, $join_count) : $relname);
3067 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3068 # version and it may be necessary to amend or override it for a specific storage
3069 # if such binds are necessary.
3070 sub _max_column_bytesize {
3071 my ($self, $attr) = @_;
3075 if ($attr->{sqlt_datatype}) {
3076 my $data_type = lc($attr->{sqlt_datatype});
3078 if ($attr->{sqlt_size}) {
3080 # String/sized-binary types
3081 if ($data_type =~ /^(?:
3082 l? (?:var)? char(?:acter)? (?:\s*varying)?
3084 (?:var)? binary (?:\s*varying)?
3089 $max_size = $attr->{sqlt_size};
3091 # Other charset/unicode types, assume scale of 4
3092 elsif ($data_type =~ /^(?:
3093 national \s* character (?:\s*varying)?
3102 $max_size = $attr->{sqlt_size} * 4;
3106 if (!$max_size and !$self->_is_lob_type($data_type)) {
3107 $max_size = 100 # for all other (numeric?) datatypes
3111 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3114 # Determine if a data_type is some type of BLOB
3116 my ($self, $data_type) = @_;
3117 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3118 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3119 |varchar|character\s*varying|nvarchar
3120 |national\s*character\s*varying))?\z/xi);
3123 sub _is_binary_lob_type {
3124 my ($self, $data_type) = @_;
3125 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3126 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3129 sub _is_text_lob_type {
3130 my ($self, $data_type) = @_;
3131 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3132 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3133 |national\s*character\s*varying))\z/xi);
3136 # Determine if a data_type is some type of a binary type
3137 sub _is_binary_type {
3138 my ($self, $data_type) = @_;
3139 $data_type && ($self->_is_binary_lob_type($data_type)
3140 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3147 =head2 DBIx::Class and AutoCommit
3149 DBIx::Class can do some wonderful magic with handling exceptions,
3150 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3151 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3152 transaction support.
3154 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3155 in an assumed transaction between commits, and you're telling us you'd
3156 like to manage that manually. A lot of the magic protections offered by
3157 this module will go away. We can't protect you from exceptions due to database
3158 disconnects because we don't know anything about how to restart your
3159 transactions. You're on your own for handling all sorts of exceptional
3160 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3164 =head1 AUTHOR AND CONTRIBUTORS
3166 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3170 You may distribute this code under the same terms as Perl itself.