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/
106 with_deferred_fk_checks
108 get_use_dbms_capability
115 for my $meth (@rdbms_specific_methods) {
117 my $orig = __PACKAGE__->can ($meth)
118 or die "$meth is not a ::Storage::DBI method!";
121 no warnings qw/redefine/;
122 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
124 # only fire when invoked on an instance, a valid class-based invocation
125 # would e.g. be setting a default for an inherited accessor
128 ! $_[0]->{_driver_determined}
130 ! $_[0]->{_in_determine_driver}
132 ($_[0]->_dbi_connect_info||[])->[0]
134 $_[0]->_determine_driver;
136 # This for some reason crashes and burns on perl 5.8.1
137 # IFF the method ends up throwing an exception
138 #goto $_[0]->can ($meth);
140 my $cref = $_[0]->can ($meth);
150 DBIx::Class::Storage::DBI - DBI storage handler
154 my $schema = MySchema->connect('dbi:SQLite:my.db');
156 $schema->storage->debug(1);
158 my @stuff = $schema->storage->dbh_do(
160 my ($storage, $dbh, @args) = @_;
161 $dbh->do("DROP TABLE authors");
166 $schema->resultset('Book')->search({
167 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
172 This class represents the connection to an RDBMS via L<DBI>. See
173 L<DBIx::Class::Storage> for general information. This pod only
174 documents DBI-specific methods and behaviors.
181 my $new = shift->next::method(@_);
183 $new->_sql_maker_opts({});
184 $new->_dbh_details({});
185 $new->{_in_do_block} = 0;
187 # read below to see what this does
188 $new->_arm_global_destructor;
193 # This is hack to work around perl shooting stuff in random
194 # order on exit(). If we do not walk the remaining storage
195 # objects in an END block, there is a *small but real* chance
196 # of a fork()ed child to kill the parent's shared DBI handle,
197 # *before perl reaches the DESTROY in this package*
198 # Yes, it is ugly and effective.
199 # Additionally this registry is used by the CLONE method to
200 # make sure no handles are shared between threads
202 my %seek_and_destroy;
204 sub _arm_global_destructor {
206 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
211 local $?; # just in case the DBI destructor changes it somehow
213 # destroy just the object if not native to this process
214 $_->_verify_pid for (grep
216 values %seek_and_destroy
221 # As per DBI's recommendation, DBIC disconnects all handles as
222 # soon as possible (DBIC will reconnect only on demand from within
224 my @instances = grep { defined $_ } values %seek_and_destroy;
225 %seek_and_destroy = ();
230 $_->transaction_depth(0);
233 # properly renumber existing refs
234 $_->_arm_global_destructor
242 # some databases spew warnings on implicit disconnect
243 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
244 local $SIG{__WARN__} = sub {};
247 # this op is necessary, since the very last perl runtime statement
248 # triggers a global destruction shootout, and the $SIG localization
249 # may very well be destroyed before perl actually gets to do the
254 # handle pid changes correctly - do not destroy parent's connection
258 my $pid = $self->_conn_pid;
259 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
260 $dbh->{InactiveDestroy} = 1;
262 $self->transaction_depth(0);
263 $self->savepoints([]);
271 This method is normally called by L<DBIx::Class::Schema/connection>, which
272 encapsulates its argument list in an arrayref before passing them here.
274 The argument list may contain:
280 The same 4-element argument set one would normally pass to
281 L<DBI/connect>, optionally followed by
282 L<extra attributes|/DBIx::Class specific connection attributes>
283 recognized by DBIx::Class:
285 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
289 A single code reference which returns a connected
290 L<DBI database handle|DBI/connect> optionally followed by
291 L<extra attributes|/DBIx::Class specific connection attributes> recognized
294 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
298 A single hashref with all the attributes and the dsn/user/password
301 $connect_info_args = [{
309 $connect_info_args = [{
310 dbh_maker => sub { DBI->connect (...) },
315 This is particularly useful for L<Catalyst> based applications, allowing the
316 following config (L<Config::General> style):
321 dsn dbi:mysql:database=test
328 The C<dsn>/C<user>/C<password> combination can be substituted by the
329 C<dbh_maker> key whose value is a coderef that returns a connected
330 L<DBI database handle|DBI/connect>
334 Please note that the L<DBI> docs recommend that you always explicitly
335 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
336 recommends that it be set to I<1>, and that you perform transactions
337 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
338 to I<1> if you do not do explicitly set it to zero. This is the default
339 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
341 =head3 DBIx::Class specific connection attributes
343 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
344 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
345 the following connection options. These options can be mixed in with your other
346 L<DBI> connection attributes, or placed in a separate hashref
347 (C<\%extra_attributes>) as shown above.
349 Every time C<connect_info> is invoked, any previous settings for
350 these options will be cleared before setting the new ones, regardless of
351 whether any options are specified in the new C<connect_info>.
358 Specifies things to do immediately after connecting or re-connecting to
359 the database. Its value may contain:
365 This contains one SQL statement to execute.
367 =item an array reference
369 This contains SQL statements to execute in order. Each element contains
370 a string or a code reference that returns a string.
372 =item a code reference
374 This contains some code to execute. Unlike code references within an
375 array reference, its return value is ignored.
379 =item on_disconnect_do
381 Takes arguments in the same form as L</on_connect_do> and executes them
382 immediately before disconnecting from the database.
384 Note, this only runs if you explicitly call L</disconnect> on the
387 =item on_connect_call
389 A more generalized form of L</on_connect_do> that calls the specified
390 C<connect_call_METHOD> methods in your storage driver.
392 on_connect_do => 'select 1'
396 on_connect_call => [ [ do_sql => 'select 1' ] ]
398 Its values may contain:
404 Will call the C<connect_call_METHOD> method.
406 =item a code reference
408 Will execute C<< $code->($storage) >>
410 =item an array reference
412 Each value can be a method name or code reference.
414 =item an array of arrays
416 For each array, the first item is taken to be the C<connect_call_> method name
417 or code reference, and the rest are parameters to it.
421 Some predefined storage methods you may use:
427 Executes a SQL string or a code reference that returns a SQL string. This is
428 what L</on_connect_do> and L</on_disconnect_do> use.
436 Will execute the scalar as SQL.
440 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
441 attributes hashref and bind values.
443 =item a code reference
445 Will execute C<< $code->($storage) >> and execute the return array refs as
452 Execute any statements necessary to initialize the database session to return
453 and accept datetime/timestamp values used with
454 L<DBIx::Class::InflateColumn::DateTime>.
456 Only necessary for some databases, see your specific storage driver for
457 implementation details.
461 =item on_disconnect_call
463 Takes arguments in the same form as L</on_connect_call> and executes them
464 immediately before disconnecting from the database.
466 Calls the C<disconnect_call_METHOD> methods as opposed to the
467 C<connect_call_METHOD> methods called by L</on_connect_call>.
469 Note, this only runs if you explicitly call L</disconnect> on the
472 =item disable_sth_caching
474 If set to a true value, this option will disable the caching of
475 statement handles via L<DBI/prepare_cached>.
479 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
480 default L</sql_limit_dialect> setting of the storage (if any). For a list
481 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
485 When true automatically sets L</quote_char> and L</name_sep> to the characters
486 appropriate for your particular RDBMS. This option is preferred over specifying
487 L</quote_char> directly.
491 Specifies what characters to use to quote table and column names.
493 C<quote_char> expects either a single character, in which case is it
494 is placed on either side of the table/column name, or an arrayref of length
495 2 in which case the table/column name is placed between the elements.
497 For example under MySQL you should use C<< quote_char => '`' >>, and for
498 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
502 This parameter is only useful in conjunction with C<quote_char>, and is used to
503 specify the character that separates elements (schemas, tables, columns) from
504 each other. If unspecified it defaults to the most commonly used C<.>.
508 This Storage driver normally installs its own C<HandleError>, sets
509 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
510 all database handles, including those supplied by a coderef. It does this
511 so that it can have consistent and useful error behavior.
513 If you set this option to a true value, Storage will not do its usual
514 modifications to the database handle's attributes, and instead relies on
515 the settings in your connect_info DBI options (or the values you set in
516 your connection coderef, in the case that you are connecting via coderef).
518 Note that your custom settings can cause Storage to malfunction,
519 especially if you set a C<HandleError> handler that suppresses exceptions
520 and/or disable C<RaiseError>.
524 If this option is true, L<DBIx::Class> will use savepoints when nesting
525 transactions, making it possible to recover from failure in the inner
526 transaction without having to abort all outer transactions.
530 Use this argument to supply a cursor class other than the default
531 L<DBIx::Class::Storage::DBI::Cursor>.
535 Some real-life examples of arguments to L</connect_info> and
536 L<DBIx::Class::Schema/connect>
538 # Simple SQLite connection
539 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
542 ->connect_info([ sub { DBI->connect(...) } ]);
544 # Connect via subref in hashref
546 dbh_maker => sub { DBI->connect(...) },
547 on_connect_do => 'alter session ...',
550 # A bit more complicated
557 { quote_char => q{"} },
561 # Equivalent to the previous example
567 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
571 # Same, but with hashref as argument
572 # See parse_connect_info for explanation
575 dsn => 'dbi:Pg:dbname=foo',
577 password => 'my_pg_password',
584 # Subref + DBIx::Class-specific connection options
587 sub { DBI->connect(...) },
591 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
592 disable_sth_caching => 1,
602 my ($self, $info) = @_;
604 return $self->_connect_info if !$info;
606 $self->_connect_info($info); # copy for _connect_info
608 $info = $self->_normalize_connect_info($info)
609 if ref $info eq 'ARRAY';
611 for my $storage_opt (keys %{ $info->{storage_options} }) {
612 my $value = $info->{storage_options}{$storage_opt};
614 $self->$storage_opt($value);
617 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
618 # the new set of options
619 $self->_sql_maker(undef);
620 $self->_sql_maker_opts({});
622 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
623 my $value = $info->{sql_maker_options}{$sql_maker_opt};
625 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
629 %{ $self->_default_dbi_connect_attributes || {} },
630 %{ $info->{attributes} || {} },
633 my @args = @{ $info->{arguments} };
635 if (keys %attrs and ref $args[0] ne 'CODE') {
637 'You provided explicit AutoCommit => 0 in your connection_info. '
638 . 'This is almost universally a bad idea (see the footnotes of '
639 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
640 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
642 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
644 push @args, \%attrs if keys %attrs;
646 $self->_dbi_connect_info(\@args);
649 # save attributes them in a separate accessor so they are always
650 # introspectable, even in case of a CODE $dbhmaker
651 $self->_dbic_connect_attributes (\%attrs);
653 return $self->_connect_info;
656 sub _normalize_connect_info {
657 my ($self, $info_arg) = @_;
660 my @args = @$info_arg; # take a shallow copy for further mutilation
662 # combine/pre-parse arguments depending on invocation style
665 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
666 %attrs = %{ $args[1] || {} };
669 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
670 %attrs = %{$args[0]};
672 if (my $code = delete $attrs{dbh_maker}) {
675 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
678 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
679 . "to the result of 'dbh_maker'",
681 join (', ', map { "'$_'" } (@ignored) ),
686 @args = delete @attrs{qw/dsn user password/};
689 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
691 % { $args[3] || {} },
692 % { $args[4] || {} },
694 @args = @args[0,1,2];
697 $info{arguments} = \@args;
699 my @storage_opts = grep exists $attrs{$_},
700 @storage_options, 'cursor_class';
702 @{ $info{storage_options} }{@storage_opts} =
703 delete @attrs{@storage_opts} if @storage_opts;
705 my @sql_maker_opts = grep exists $attrs{$_},
706 qw/limit_dialect quote_char name_sep quote_names/;
708 @{ $info{sql_maker_options} }{@sql_maker_opts} =
709 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
711 $info{attributes} = \%attrs if %attrs;
716 sub _default_dbi_connect_attributes () {
721 ShowErrorStatement => 1,
727 This method is deprecated in favour of setting via L</connect_info>.
731 =head2 on_disconnect_do
733 This method is deprecated in favour of setting via L</connect_info>.
737 sub _parse_connect_do {
738 my ($self, $type) = @_;
740 my $val = $self->$type;
741 return () if not defined $val;
746 push @res, [ 'do_sql', $val ];
747 } elsif (ref($val) eq 'CODE') {
749 } elsif (ref($val) eq 'ARRAY') {
750 push @res, map { [ 'do_sql', $_ ] } @$val;
752 $self->throw_exception("Invalid type for $type: ".ref($val));
760 Arguments: ($subref | $method_name), @extra_coderef_args?
762 Execute the given $subref or $method_name using the new exception-based
763 connection management.
765 The first two arguments will be the storage object that C<dbh_do> was called
766 on and a database handle to use. Any additional arguments will be passed
767 verbatim to the called subref as arguments 2 and onwards.
769 Using this (instead of $self->_dbh or $self->dbh) ensures correct
770 exception handling and reconnection (or failover in future subclasses).
772 Your subref should have no side-effects outside of the database, as
773 there is the potential for your subref to be partially double-executed
774 if the database connection was stale/dysfunctional.
778 my @stuff = $schema->storage->dbh_do(
780 my ($storage, $dbh, @cols) = @_;
781 my $cols = join(q{, }, @cols);
782 $dbh->selectrow_array("SELECT $cols FROM foo");
791 my $run_target = shift;
793 # short circuit when we know there is no need for a runner
795 # FIXME - assumption may be wrong
796 # the rationale for the txn_depth check is that if this block is a part
797 # of a larger transaction, everything up to that point is screwed anyway
798 return $self->$run_target($self->_get_dbh, @_)
799 if $self->{_in_do_block} or $self->transaction_depth;
801 # take a ref instead of a copy, to preserve @_ aliasing
802 # semantics within the coderef, but only if needed
803 # (pseudoforking doesn't like this trick much)
804 my $args = @_ ? \@_ : [];
806 DBIx::Class::Storage::BlockRunner->new(
808 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
810 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
815 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
816 shift->next::method(@_);
821 Our C<disconnect> method also performs a rollback first if the
822 database is not in C<AutoCommit> mode.
832 push @actions, ( $self->on_disconnect_call || () );
833 push @actions, $self->_parse_connect_do ('on_disconnect_do');
835 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
837 # stops the "implicit rollback on disconnect" warning
838 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
840 %{ $self->_dbh->{CachedKids} } = ();
841 $self->_dbh->disconnect;
846 =head2 with_deferred_fk_checks
850 =item Arguments: C<$coderef>
852 =item Return Value: The return value of $coderef
856 Storage specific method to run the code ref with FK checks deferred or
857 in MySQL's case disabled entirely.
861 # Storage subclasses should override this
862 sub with_deferred_fk_checks {
863 my ($self, $sub) = @_;
871 =item Arguments: none
873 =item Return Value: 1|0
877 Verifies that the current database handle is active and ready to execute
878 an SQL statement (e.g. the connection did not get stale, server is still
879 answering, etc.) This method is used internally by L</dbh>.
885 return 0 unless $self->_seems_connected;
888 local $self->_dbh->{RaiseError} = 1;
893 sub _seems_connected {
896 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
898 my $dbh = $self->_dbh
901 return $dbh->FETCH('Active');
907 my $dbh = $self->_dbh or return 0;
912 sub ensure_connected {
915 unless ($self->connected) {
916 $self->_populate_dbh;
922 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
923 is guaranteed to be healthy by implicitly calling L</connected>, and if
924 necessary performing a reconnection before returning. Keep in mind that this
925 is very B<expensive> on some database engines. Consider using L</dbh_do>
933 if (not $self->_dbh) {
934 $self->_populate_dbh;
936 $self->ensure_connected;
941 # this is the internal "get dbh or connect (don't check)" method
944 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
945 $self->_populate_dbh unless $self->_dbh;
951 unless ($self->_sql_maker) {
952 my $sql_maker_class = $self->sql_maker_class;
954 my %opts = %{$self->_sql_maker_opts||{}};
958 $self->sql_limit_dialect
961 my $s_class = (ref $self) || $self;
963 "Your storage class ($s_class) does not set sql_limit_dialect and you "
964 . 'have not supplied an explicit limit_dialect in your connection_info. '
965 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
966 . 'databases but can be (and often is) painfully slow. '
967 . "Please file an RT ticket against '$s_class'"
968 ) if $self->_dbi_connect_info->[0];
974 my ($quote_char, $name_sep);
976 if ($opts{quote_names}) {
977 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
978 my $s_class = (ref $self) || $self;
980 "You requested 'quote_names' but your storage class ($s_class) does "
981 . 'not explicitly define a default sql_quote_char and you have not '
982 . 'supplied a quote_char as part of your connection_info. DBIC will '
983 .q{default to the ANSI SQL standard quote '"', which works most of }
984 . "the time. Please file an RT ticket against '$s_class'."
990 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
993 $self->_sql_maker($sql_maker_class->new(
995 array_datatypes => 1,
996 limit_dialect => $dialect,
997 ($quote_char ? (quote_char => $quote_char) : ()),
998 name_sep => ($name_sep || '.'),
1002 return $self->_sql_maker;
1005 # nothing to do by default
1012 my @info = @{$self->_dbi_connect_info || []};
1013 $self->_dbh(undef); # in case ->connected failed we might get sent here
1014 $self->_dbh_details({}); # reset everything we know
1016 $self->_dbh($self->_connect(@info));
1018 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1020 $self->_determine_driver;
1022 # Always set the transaction depth on connect, since
1023 # there is no transaction in progress by definition
1024 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1026 $self->_run_connection_actions unless $self->{_in_determine_driver};
1029 sub _run_connection_actions {
1033 push @actions, ( $self->on_connect_call || () );
1034 push @actions, $self->_parse_connect_do ('on_connect_do');
1036 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1041 sub set_use_dbms_capability {
1042 $_[0]->set_inherited ($_[1], $_[2]);
1045 sub get_use_dbms_capability {
1046 my ($self, $capname) = @_;
1048 my $use = $self->get_inherited ($capname);
1051 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1055 sub set_dbms_capability {
1056 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1059 sub get_dbms_capability {
1060 my ($self, $capname) = @_;
1062 my $cap = $self->_dbh_details->{capability}{$capname};
1064 unless (defined $cap) {
1065 if (my $meth = $self->can ("_determine$capname")) {
1066 $cap = $self->$meth ? 1 : 0;
1072 $self->set_dbms_capability ($capname, $cap);
1082 unless ($info = $self->_dbh_details->{info}) {
1086 my $server_version = try {
1087 $self->_get_server_version
1089 # driver determination *may* use this codepath
1090 # in which case we must rethrow
1091 $self->throw_exception($_) if $self->{_in_determine_driver};
1093 # $server_version on failure
1097 if (defined $server_version) {
1098 $info->{dbms_version} = $server_version;
1100 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1101 my @verparts = split (/\./, $numeric_version);
1107 # consider only up to 3 version parts, iff not more than 3 digits
1109 while (@verparts && @use_parts < 3) {
1110 my $p = shift @verparts;
1112 push @use_parts, $p;
1114 push @use_parts, 0 while @use_parts < 3;
1116 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1120 $self->_dbh_details->{info} = $info;
1126 sub _get_server_version {
1127 shift->_dbh_get_info('SQL_DBMS_VER');
1131 my ($self, $info) = @_;
1133 if ($info =~ /[^0-9]/) {
1134 require DBI::Const::GetInfoType;
1135 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1136 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1137 unless defined $info;
1140 $self->_get_dbh->get_info($info);
1143 sub _describe_connection {
1144 require DBI::Const::GetInfoReturn;
1147 $self->ensure_connected;
1150 DBIC_DSN => $self->_dbi_connect_info->[0],
1151 DBI_VER => DBI->VERSION,
1152 DBIC_VER => DBIx::Class->VERSION,
1153 DBIC_DRIVER => ref $self,
1157 #keys %DBI::Const::GetInfoType::GetInfoType,
1159 SQL_CURSOR_COMMIT_BEHAVIOR
1160 SQL_CURSOR_ROLLBACK_BEHAVIOR
1161 SQL_CURSOR_SENSITIVITY
1162 SQL_DATA_SOURCE_NAME
1165 SQL_DEFAULT_TXN_ISOLATION
1170 SQL_EXPRESSIONS_IN_ORDERBY
1173 SQL_IDENTIFIER_QUOTE_CHAR
1174 SQL_MAX_CATALOG_NAME_LEN
1175 SQL_MAX_COLUMN_NAME_LEN
1176 SQL_MAX_IDENTIFIER_LEN
1177 SQL_MAX_TABLE_NAME_LEN
1178 SQL_MULTIPLE_ACTIVE_TXN
1179 SQL_MULT_RESULT_SETS
1180 SQL_NEED_LONG_DATA_LEN
1181 SQL_NON_NULLABLE_COLUMNS
1183 SQL_QUALIFIER_NAME_SEPARATOR
1184 SQL_QUOTED_IDENTIFIER_CASE
1186 SQL_TXN_ISOLATION_OPTION
1189 # some drivers barf on things they do not know about instead
1190 # of returning undef
1191 my $v = try { $self->_dbh_get_info($inf) };
1192 next unless defined $v;
1194 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1195 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1196 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1202 sub _determine_driver {
1205 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1206 my $started_connected = 0;
1207 local $self->{_in_determine_driver} = 1;
1209 if (ref($self) eq __PACKAGE__) {
1211 if ($self->_dbh) { # we are connected
1212 $driver = $self->_dbh->{Driver}{Name};
1213 $started_connected = 1;
1216 # if connect_info is a CODEREF, we have no choice but to connect
1217 if (ref $self->_dbi_connect_info->[0] &&
1218 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1219 $self->_populate_dbh;
1220 $driver = $self->_dbh->{Driver}{Name};
1223 # try to use dsn to not require being connected, the driver may still
1224 # force a connection in _rebless to determine version
1225 # (dsn may not be supplied at all if all we do is make a mock-schema)
1226 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1227 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1228 $driver ||= $ENV{DBI_DRIVER};
1233 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1234 if ($self->load_optional_class($storage_class)) {
1235 mro::set_mro($storage_class, 'c3');
1236 bless $self, $storage_class;
1240 $self->_warn_undetermined_driver(
1241 'This version of DBIC does not yet seem to supply a driver for '
1242 . "your particular RDBMS and/or connection method ('$driver')."
1247 $self->_warn_undetermined_driver(
1248 'Unable to extract a driver name from connect info - this '
1249 . 'should not have happened.'
1254 $self->_driver_determined(1);
1256 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1258 if ($self->can('source_bind_attributes')) {
1259 $self->throw_exception(
1260 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1261 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1262 . 'If you are not sure how to proceed please contact the development team via '
1263 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1267 $self->_init; # run driver-specific initializations
1269 $self->_run_connection_actions
1270 if !$started_connected && defined $self->_dbh;
1274 sub _determine_connector_driver {
1275 my ($self, $conn) = @_;
1277 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1280 $self->_warn_undetermined_driver(
1281 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1282 . "$conn connector - this should not have happened."
1287 $dbtype =~ s/\W/_/gi;
1289 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1290 return if $self->isa($subclass);
1292 if ($self->load_optional_class($subclass)) {
1293 bless $self, $subclass;
1297 $self->_warn_undetermined_driver(
1298 'This version of DBIC does not yet seem to supply a driver for '
1299 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1304 sub _warn_undetermined_driver {
1305 my ($self, $msg) = @_;
1307 require Data::Dumper::Concise;
1309 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1310 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1311 . "does not go away, file a bugreport including the following info:\n"
1312 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1316 sub _do_connection_actions {
1318 my $method_prefix = shift;
1321 if (not ref($call)) {
1322 my $method = $method_prefix . $call;
1324 } elsif (ref($call) eq 'CODE') {
1326 } elsif (ref($call) eq 'ARRAY') {
1327 if (ref($call->[0]) ne 'ARRAY') {
1328 $self->_do_connection_actions($method_prefix, $_) for @$call;
1330 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1333 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1339 sub connect_call_do_sql {
1341 $self->_do_query(@_);
1344 sub disconnect_call_do_sql {
1346 $self->_do_query(@_);
1349 # override in db-specific backend when necessary
1350 sub connect_call_datetime_setup { 1 }
1353 my ($self, $action) = @_;
1355 if (ref $action eq 'CODE') {
1356 $action = $action->($self);
1357 $self->_do_query($_) foreach @$action;
1360 # Most debuggers expect ($sql, @bind), so we need to exclude
1361 # the attribute hash which is the second argument to $dbh->do
1362 # furthermore the bind values are usually to be presented
1363 # as named arrayref pairs, so wrap those here too
1364 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1365 my $sql = shift @do_args;
1366 my $attrs = shift @do_args;
1367 my @bind = map { [ undef, $_ ] } @do_args;
1370 $_[0]->_query_start($sql, \@bind);
1371 $_[1]->do($sql, $attrs, @do_args);
1372 $_[0]->_query_end($sql, \@bind);
1380 my ($self, @info) = @_;
1382 $self->throw_exception("You did not provide any connection_info")
1383 if ( ! defined $info[0] and ! $ENV{DBI_DSN} and ! $ENV{DBI_DRIVER} );
1385 my ($old_connect_via, $dbh);
1387 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1389 # this odd anonymous coderef dereference is in fact really
1390 # necessary to avoid the unwanted effect described in perl5
1393 # in addition the coderef itself can't reside inside the try{} block below
1394 # as it somehow triggers a leak under perl -d
1395 my $dbh_error_handler_installer = sub {
1396 weaken (my $weak_self = $_[0]);
1398 # the coderef is blessed so we can distinguish it from externally
1399 # supplied handles (which must be preserved)
1400 $_[1]->{HandleError} = bless sub {
1402 $weak_self->throw_exception("DBI Exception: $_[0]");
1405 # the handler may be invoked by something totally out of
1407 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1409 }, '__DBIC__DBH__ERROR__HANDLER__';
1413 if(ref $info[0] eq 'CODE') {
1414 $dbh = $info[0]->();
1418 $dbh = DBI->connect(@info);
1421 die $DBI::errstr unless $dbh;
1423 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1424 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1426 ref $info[0] eq 'CODE'
1427 ? "Connection coderef $info[0] returned a"
1428 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1429 ) unless $dbh->FETCH('Active');
1431 # sanity checks unless asked otherwise
1432 unless ($self->unsafe) {
1434 $self->throw_exception(
1435 'Refusing clobbering of {HandleError} installed on externally supplied '
1436 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1437 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1439 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1440 # request, or an external handle. Complain and set anyway
1441 unless ($dbh->{RaiseError}) {
1442 carp( ref $info[0] eq 'CODE'
1444 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1445 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1446 .'attribute has been supplied'
1448 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1449 .'unsafe => 1. Toggling RaiseError back to true'
1452 $dbh->{RaiseError} = 1;
1455 $dbh_error_handler_installer->($self, $dbh);
1459 $self->throw_exception("DBI Connection failed: $_")
1462 $self->_dbh_autocommit($dbh->{AutoCommit});
1469 # this means we have not yet connected and do not know the AC status
1470 # (e.g. coderef $dbh), need a full-fledged connection check
1471 if (! defined $self->_dbh_autocommit) {
1472 $self->ensure_connected;
1474 # Otherwise simply connect or re-connect on pid changes
1479 $self->next::method(@_);
1482 sub _exec_txn_begin {
1485 # if the user is utilizing txn_do - good for him, otherwise we need to
1486 # ensure that the $dbh is healthy on BEGIN.
1487 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1488 # will be replaced by a failure of begin_work itself (which will be
1489 # then retried on reconnect)
1490 if ($self->{_in_do_block}) {
1491 $self->_dbh->begin_work;
1493 $self->dbh_do(sub { $_[1]->begin_work });
1500 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1501 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1504 # esoteric case for folks using external $dbh handles
1505 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1506 carp "Storage transaction_depth 0 does not match "
1507 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1508 $self->transaction_depth(1);
1511 $self->next::method(@_);
1513 # if AutoCommit is disabled txn_depth never goes to 0
1514 # as a new txn is started immediately on commit
1515 $self->transaction_depth(1) if (
1516 !$self->transaction_depth
1518 defined $self->_dbh_autocommit
1520 ! $self->_dbh_autocommit
1524 sub _exec_txn_commit {
1525 shift->_dbh->commit;
1531 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1532 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1535 # esoteric case for folks using external $dbh handles
1536 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1537 carp "Storage transaction_depth 0 does not match "
1538 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1539 $self->transaction_depth(1);
1542 $self->next::method(@_);
1544 # if AutoCommit is disabled txn_depth never goes to 0
1545 # as a new txn is started immediately on commit
1546 $self->transaction_depth(1) if (
1547 !$self->transaction_depth
1549 defined $self->_dbh_autocommit
1551 ! $self->_dbh_autocommit
1555 sub _exec_txn_rollback {
1556 shift->_dbh->rollback;
1559 # generate some identical methods
1560 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1562 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1564 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1565 $self->throw_exception("Unable to $meth() on a disconnected storage")
1567 $self->next::method(@_);
1571 # This used to be the top-half of _execute. It was split out to make it
1572 # easier to override in NoBindVars without duping the rest. It takes up
1573 # all of _execute's args, and emits $sql, @bind.
1574 sub _prep_for_execute {
1575 #my ($self, $op, $ident, $args) = @_;
1576 return shift->_gen_sql_bind(@_)
1580 my ($self, $op, $ident, $args) = @_;
1582 my ($colinfos, $from);
1583 if ( blessed($ident) ) {
1584 $from = $ident->from;
1585 $colinfos = $ident->columns_info;
1589 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1591 $bind = $self->_resolve_bindattrs(
1592 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1596 ! $ENV{DBIC_DT_SEARCH_OK}
1605 $_->[1]->isa('DateTime')
1608 carp_unique 'DateTime objects passed to search() are not supported '
1609 . 'properly (InflateColumn::DateTime formats and settings are not '
1610 . 'respected.) See "Formatting DateTime objects in queries" in '
1611 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1612 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1615 return( $sql, $bind );
1618 sub _resolve_bindattrs {
1619 my ($self, $ident, $bind, $colinfos) = @_;
1623 my $resolve_bindinfo = sub {
1624 #my $infohash = shift;
1626 %$colinfos = %{ $self->_resolve_column_info($ident) }
1627 unless keys %$colinfos;
1630 if (my $col = $_[0]->{dbic_colname}) {
1631 $ret = { %{$_[0]} };
1633 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1634 if $colinfos->{$col}{data_type};
1636 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1637 if $colinfos->{$col}{size};
1645 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1646 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1647 : (ref $_->[0] eq 'HASH') ? [ (exists $_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype})
1649 : $resolve_bindinfo->($_->[0])
1651 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1652 : [ $resolve_bindinfo->(
1653 { dbic_colname => $_->[0] }
1658 ! exists $resolved->[0]{dbd_attrs}
1660 ! $resolved->[0]{sqlt_datatype}
1662 length ref $resolved->[1]
1664 ! overload::Method($resolved->[1], '""')
1666 require Data::Dumper;
1667 local $Data::Dumper::Maxdepth = 1;
1668 local $Data::Dumper::Terse = 1;
1669 local $Data::Dumper::Useqq = 1;
1670 local $Data::Dumper::Indent = 0;
1671 local $Data::Dumper::Pad = ' ';
1672 $self->throw_exception(
1673 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1674 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1683 sub _format_for_trace {
1684 #my ($self, $bind) = @_;
1686 ### Turn @bind from something like this:
1687 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1689 ### ( "'1'", "'3'" )
1692 defined( $_ && $_->[1] )
1699 my ( $self, $sql, $bind ) = @_;
1701 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1706 my ( $self, $sql, $bind ) = @_;
1708 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1712 sub _dbi_attrs_for_bind {
1713 my ($self, $ident, $bind) = @_;
1717 for (map { $_->[0] } @$bind) {
1719 if (exists $_->{dbd_attrs}) {
1722 elsif($_->{sqlt_datatype}) {
1723 # cache the result in the dbh_details hash, as it can not change unless
1724 # we connect to something else
1725 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1726 if (not exists $cache->{$_->{sqlt_datatype}}) {
1727 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1729 $cache->{$_->{sqlt_datatype}};
1732 undef; # always push something at this position
1741 my ($self, $op, $ident, @args) = @_;
1743 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1745 # not even a PID check - we do not care about the state of the _dbh.
1746 # All we need is to get the appropriate drivers loaded if they aren't
1747 # already so that the assumption in ad7c50fc26e holds
1748 $self->_populate_dbh unless $self->_dbh;
1750 $self->dbh_do( _dbh_execute => # retry over disconnects
1753 $self->_dbi_attrs_for_bind($ident, $bind),
1758 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1760 $self->_query_start( $sql, $bind );
1762 my $sth = $self->_bind_sth_params(
1763 $self->_prepare_sth($dbh, $sql),
1768 # Can this fail without throwing an exception anyways???
1769 my $rv = $sth->execute();
1770 $self->throw_exception(
1771 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1774 $self->_query_end( $sql, $bind );
1776 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1780 my ($self, $dbh, $sql) = @_;
1782 # 3 is the if_active parameter which avoids active sth re-use
1783 my $sth = $self->disable_sth_caching
1784 ? $dbh->prepare($sql)
1785 : $dbh->prepare_cached($sql, {}, 3);
1787 # XXX You would think RaiseError would make this impossible,
1788 # but apparently that's not true :(
1789 $self->throw_exception(
1792 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1793 .'an exception and/or setting $dbh->errstr',
1795 ? substr($sql, 0, 20) . '...'
1798 'DBD::' . $dbh->{Driver}{Name},
1805 sub _bind_sth_params {
1806 my ($self, $sth, $bind, $bind_attrs) = @_;
1808 for my $i (0 .. $#$bind) {
1809 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1810 $sth->bind_param_inout(
1811 $i + 1, # bind params counts are 1-based
1813 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1818 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1819 # confirm with dbi-dev whether explicit stringification is needed
1820 my $v = ( length ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""') )
1835 sub _prefetch_autovalues {
1836 my ($self, $source, $colinfo, $to_insert) = @_;
1839 for my $col (keys %$colinfo) {
1841 $colinfo->{$col}{auto_nextval}
1844 ! exists $to_insert->{$col}
1846 ref $to_insert->{$col} eq 'SCALAR'
1848 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1851 $values{$col} = $self->_sequence_fetch(
1853 ( $colinfo->{$col}{sequence} ||=
1854 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1864 my ($self, $source, $to_insert) = @_;
1866 my $col_infos = $source->columns_info;
1868 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1870 # fuse the values, but keep a separate list of prefetched_values so that
1871 # they can be fused once again with the final return
1872 $to_insert = { %$to_insert, %$prefetched_values };
1874 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1875 # Investigate what does it take to s/defined/exists/
1876 my %pcols = map { $_ => 1 } $source->primary_columns;
1877 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1878 for my $col ($source->columns) {
1879 if ($col_infos->{$col}{is_auto_increment}) {
1880 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1881 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1884 # nothing to retrieve when explicit values are supplied
1885 next if (defined $to_insert->{$col} and ! (
1886 ref $to_insert->{$col} eq 'SCALAR'
1888 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1891 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1892 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1895 $col_infos->{$col}{retrieve_on_insert}
1899 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1900 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1902 my ($sqla_opts, @ir_container);
1903 if (%retrieve_cols and $self->_use_insert_returning) {
1904 $sqla_opts->{returning_container} = \@ir_container
1905 if $self->_use_insert_returning_bound;
1907 $sqla_opts->{returning} = [
1908 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1912 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1914 my %returned_cols = %$to_insert;
1915 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1916 @ir_container = try {
1917 local $SIG{__WARN__} = sub {};
1918 my @r = $sth->fetchrow_array;
1921 } unless @ir_container;
1923 @returned_cols{@$retlist} = @ir_container if @ir_container;
1926 # pull in PK if needed and then everything else
1927 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1929 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1930 unless $self->can('last_insert_id');
1932 my @pri_values = $self->last_insert_id($source, @missing_pri);
1934 $self->throw_exception( "Can't get last insert id" )
1935 unless (@pri_values == @missing_pri);
1937 @returned_cols{@missing_pri} = @pri_values;
1938 delete @retrieve_cols{@missing_pri};
1941 # if there is more left to pull
1942 if (%retrieve_cols) {
1943 $self->throw_exception(
1944 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1947 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1949 my $cur = DBIx::Class::ResultSet->new($source, {
1950 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1951 select => \@left_to_fetch,
1954 @returned_cols{@left_to_fetch} = $cur->next;
1956 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1957 if scalar $cur->next;
1961 return { %$prefetched_values, %returned_cols };
1965 my ($self, $source, $cols, $data) = @_;
1967 my @col_range = (0..$#$cols);
1969 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1970 # confirm with dbi-dev whether explicit stringification is needed
1972 # forcibly stringify whatever is stringifiable
1973 # ResultSet::populate() hands us a copy - safe to mangle
1974 # Check with Riba: is this still dangerous?
1975 for my $r (0 .. $#$data) {
1976 for my $c (0 .. $#{$data->[$r]}) {
1977 $data->[$r][$c] = "$data->[$r][$c]"
1978 if ( length ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1982 my $colinfos = $source->columns_info($cols);
1984 local $self->{_autoinc_supplied_for_op} =
1985 (first { $_->{is_auto_increment} } values %$colinfos)
1990 # get a slice type index based on first row of data
1991 # a "column" in this context may refer to more than one bind value
1992 # e.g. \[ '?, ?', [...], [...] ]
1994 # construct the value type index - a description of values types for every
1995 # per-column slice of $data:
1997 # nonexistent - nonbind literal
1999 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
2001 # also construct the column hash to pass to the SQL generator. For plain
2002 # (non literal) values - convert the members of the first row into a
2003 # literal+bind combo, with extra positional info in the bind attr hashref.
2004 # This will allow us to match the order properly, and is so contrived
2005 # because a user-supplied literal/bind (or something else specific to a
2006 # resultsource and/or storage driver) can inject extra binds along the
2007 # way, so one can't rely on "shift positions" ordering at all. Also we
2008 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
2009 # can be later matched up by address), because we want to supply a real
2010 # value on which perhaps e.g. datatype checks will be performed
2011 my ($proto_data, $value_type_by_col_idx);
2012 for my $i (@col_range) {
2013 my $colname = $cols->[$i];
2014 if (ref $data->[0][$i] eq 'SCALAR') {
2015 # no bind value at all - no type
2017 $proto_data->{$colname} = $data->[0][$i];
2019 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
2020 # repack, so we don't end up mangling the original \[]
2021 my ($sql, @bind) = @${$data->[0][$i]};
2023 # normalization of user supplied stuff
2024 my $resolved_bind = $self->_resolve_bindattrs(
2025 $source, \@bind, $colinfos,
2028 # store value-less (attrs only) bind info - we will be comparing all
2029 # supplied binds against this for sanity
2030 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
2032 $proto_data->{$colname} = \[ $sql, map { [
2033 # inject slice order to use for $proto_bind construction
2034 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
2036 $resolved_bind->[$_][1]
2041 $value_type_by_col_idx->{$i} = undef;
2043 $proto_data->{$colname} = \[ '?', [
2044 { dbic_colname => $colname, _bind_data_slice_idx => $i }
2051 my ($sql, $proto_bind) = $self->_prep_for_execute (
2057 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2058 # if the bindlist is empty and we had some dynamic binds, this means the
2059 # storage ate them away (e.g. the NoBindVars component) and interpolated
2060 # them directly into the SQL. This obviously can't be good for multi-inserts
2061 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2065 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2067 # use an error reporting closure for convenience (less to pass)
2068 my $bad_slice_report_cref = sub {
2069 my ($msg, $r_idx, $c_idx) = @_;
2070 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2074 require Data::Dumper::Concise;
2075 local $Data::Dumper::Maxdepth = 5;
2076 Data::Dumper::Concise::Dumper ({
2077 map { $cols->[$_] =>
2085 for my $col_idx (@col_range) {
2086 my $reference_val = $data->[0][$col_idx];
2088 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2089 my $val = $data->[$row_idx][$col_idx];
2091 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2092 if (ref $val ne 'SCALAR') {
2093 $bad_slice_report_cref->(
2094 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2099 elsif ($$val ne $$reference_val) {
2100 $bad_slice_report_cref->(
2101 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2107 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2108 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2109 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2112 else { # binds from a \[], compare type and attrs
2113 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2114 $bad_slice_report_cref->(
2115 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2120 # start drilling down and bail out early on identical refs
2122 $reference_val != $val
2124 $$reference_val != $$val
2126 if (${$val}->[0] ne ${$reference_val}->[0]) {
2127 $bad_slice_report_cref->(
2128 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2133 # need to check the bind attrs - a bind will happen only once for
2134 # the entire dataset, so any changes further down will be ignored.
2135 elsif (! Data::Compare::Compare(
2136 $value_type_by_col_idx->{$col_idx},
2140 @{$self->_resolve_bindattrs(
2141 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2145 $bad_slice_report_cref->(
2146 'Differing bind attributes on literal/bind values not supported',
2156 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2157 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2159 my $guard = $self->txn_scope_guard;
2161 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2162 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2165 # proto bind contains the information on which pieces of $data to pull
2166 # $cols is passed in only for prettier error-reporting
2167 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2170 # bind_param_array doesn't work if there are no binds
2171 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2175 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2179 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2182 # execute_for_fetch is capable of returning data just fine (it means it
2183 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2184 # is the void-populate fast-path we will just ignore this altogether
2185 # for the time being.
2186 sub _dbh_execute_for_fetch {
2187 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2189 my @idx_range = ( 0 .. $#$proto_bind );
2191 # If we have any bind attributes to take care of, we will bind the
2192 # proto-bind data (which will never be used by execute_for_fetch)
2193 # However since column bindtypes are "sticky", this is sufficient
2194 # to get the DBD to apply the bindtype to all values later on
2196 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2198 for my $i (@idx_range) {
2200 $i+1, # DBI bind indexes are 1-based
2201 $proto_bind->[$i][1],
2203 ) if defined $bind_attrs->[$i];
2206 # At this point $data slots named in the _bind_data_slice_idx of
2207 # each piece of $proto_bind are either \[]s or plain values to be
2208 # passed in. Construct the dispensing coderef. *NOTE* the order
2209 # of $data will differ from this of the ?s in the SQL (due to
2210 # alphabetical ordering by colname). We actually do want to
2211 # preserve this behavior so that prepare_cached has a better
2212 # chance of matching on unrelated calls
2214 my $fetch_row_idx = -1; # saner loop this way
2215 my $fetch_tuple = sub {
2216 return undef if ++$fetch_row_idx > $#$data;
2218 return [ map { defined $_->{_literal_bind_subindex}
2219 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2220 ->[ $_->{_literal_bind_subindex} ]
2222 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2223 } map { $_->[0] } @$proto_bind];
2226 my $tuple_status = [];
2229 $rv = $sth->execute_for_fetch(
2238 # Not all DBDs are create equal. Some throw on error, some return
2239 # an undef $rv, and some set $sth->err - try whatever we can
2240 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2243 ( !defined $rv or $sth->err )
2246 # Statement must finish even if there was an exception.
2251 $err = shift unless defined $err
2256 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2258 $self->throw_exception("Unexpected populate error: $err")
2259 if ($i > $#$tuple_status);
2261 require Data::Dumper::Concise;
2262 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2263 ($tuple_status->[$i][1] || $err),
2264 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2271 sub _dbh_execute_inserts_with_no_binds {
2272 my ($self, $sth, $count) = @_;
2276 my $dbh = $self->_get_dbh;
2277 local $dbh->{RaiseError} = 1;
2278 local $dbh->{PrintError} = 0;
2280 $sth->execute foreach 1..$count;
2286 # Make sure statement is finished even if there was an exception.
2291 $err = shift unless defined $err;
2294 $self->throw_exception($err) if defined $err;
2300 #my ($self, $source, @args) = @_;
2301 shift->_execute('update', @_);
2306 #my ($self, $source, @args) = @_;
2307 shift->_execute('delete', @_);
2312 $self->_execute($self->_select_args(@_));
2315 sub _select_args_to_query {
2318 $self->throw_exception(
2319 "Unable to generate limited query representation with 'software_limit' enabled"
2320 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2322 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2323 # = $self->_select_args($ident, $select, $cond, $attrs);
2324 my ($op, $ident, @args) =
2325 $self->_select_args(@_);
2327 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2328 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2330 # reuse the bind arrayref
2331 unshift @{$bind}, "($sql)";
2336 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2338 # FIXME - that kind of caching would be nice to have
2339 # however currently we *may* pass the same $orig_attrs
2340 # with different ident/select/where
2341 # the whole interface needs to be rethought, since it
2342 # was centered around the flawed SQLA API. We can do
2343 # soooooo much better now. But that is also another
2346 # 'select', @{$orig_attrs->{_sqlmaker_select_args}}
2347 #) if $orig_attrs->{_sqlmaker_select_args};
2349 my $sql_maker = $self->sql_maker;
2350 my $alias2source = $self->_resolve_ident_sources ($ident);
2358 # limit dialects use this stuff
2359 # yes, some CDBICompat crap does not supply an {alias} >.<
2360 ( $orig_attrs->{alias} and $alias2source->{$orig_attrs->{alias}} )
2361 ? ( _rsroot_rsrc => $alias2source->{$orig_attrs->{alias}} )
2366 # Sanity check the attributes (SQLMaker does it too, but
2367 # in case of a software_limit we'll never reach there)
2368 if (defined $attrs->{offset}) {
2369 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2370 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2373 if (defined $attrs->{rows}) {
2374 $self->throw_exception("The rows attribute must be a positive integer if present")
2375 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2377 elsif ($attrs->{offset}) {
2378 # MySQL actually recommends this approach. I cringe.
2379 $attrs->{rows} = $sql_maker->__max_int;
2382 # see if we will need to tear the prefetch apart to satisfy group_by == select
2383 # this is *extremely tricky* to get right, I am still not sure I did
2385 my ($prefetch_needs_subquery, @limit_args);
2387 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2388 # we already know there is a valid group_by (we made it) and we know it is
2389 # intended to be based *only* on non-multi stuff
2390 # short circuit the group_by parsing below
2391 $prefetch_needs_subquery = 1;
2394 # The rationale is that even if we do *not* have collapse, we still
2395 # need to wrap the core grouped select/group_by in a subquery
2396 # so that databases that care about group_by/select equivalence
2397 # are happy (this includes MySQL in strict_mode)
2398 # If any of the other joined tables are referenced in the group_by
2399 # however - the user is on their own
2400 ( $prefetch_needs_subquery or $attrs->{_related_results_construction} )
2404 @{$attrs->{group_by}}
2406 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2407 $self->_resolve_aliastypes_from_select_args({ from => $attrs->{from}, group_by => $attrs->{group_by} })
2410 # no aliases other than our own in group_by
2411 # if there are - do not allow subquery even if limit is present
2412 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2414 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2415 # active collapse with a limit - that one is a no-brainer unless
2416 # overruled by a group_by above
2417 $prefetch_needs_subquery = 1;
2420 if ($prefetch_needs_subquery) {
2421 $attrs = $self->_adjust_select_args_for_complex_prefetch ($attrs);
2423 elsif (! $attrs->{software_limit} ) {
2425 $attrs->{rows} || (),
2426 $attrs->{offset} || (),
2430 # try to simplify the joinmap further (prune unreferenced type-single joins)
2432 ! $prefetch_needs_subquery # already pruned
2436 reftype $attrs->{from} eq 'ARRAY'
2438 @{$attrs->{from}} != 1
2440 ($attrs->{from}, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($attrs);
2444 # This would be the point to deflate anything found in $attrs->{where}
2445 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2446 # expect a result object. And all we have is a resultsource (it is trivial
2447 # to extract deflator coderefs via $alias2source above).
2449 # I don't see a way forward other than changing the way deflators are
2450 # invoked, and that's just bad...
2453 return ( 'select', @{ $orig_attrs->{_sqlmaker_select_args} = [
2454 @{$attrs}{qw(from select where)}, $attrs, @limit_args
2458 # Returns a counting SELECT for a simple count
2459 # query. Abstracted so that a storage could override
2460 # this to { count => 'firstcol' } or whatever makes
2461 # sense as a performance optimization
2463 #my ($self, $source, $rs_attrs) = @_;
2464 return { count => '*' };
2471 =item Arguments: $ident, $select, $condition, $attrs
2475 Handle a SQL select statement.
2481 my ($ident, $select, $condition, $attrs) = @_;
2482 return $self->cursor_class->new($self, \@_, $attrs);
2487 my ($rv, $sth, @bind) = $self->_select(@_);
2488 my @row = $sth->fetchrow_array;
2489 my @nextrow = $sth->fetchrow_array if @row;
2490 if(@row && @nextrow) {
2491 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2493 # Need to call finish() to work round broken DBDs
2498 =head2 sql_limit_dialect
2500 This is an accessor for the default SQL limit dialect used by a particular
2501 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2502 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2503 see L<DBIx::Class::SQLMaker::LimitDialects>.
2507 sub _dbh_columns_info_for {
2508 my ($self, $dbh, $table) = @_;
2510 if ($dbh->can('column_info')) {
2514 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2515 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2517 while ( my $info = $sth->fetchrow_hashref() ){
2519 $column_info{data_type} = $info->{TYPE_NAME};
2520 $column_info{size} = $info->{COLUMN_SIZE};
2521 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2522 $column_info{default_value} = $info->{COLUMN_DEF};
2523 my $col_name = $info->{COLUMN_NAME};
2524 $col_name =~ s/^\"(.*)\"$/$1/;
2526 $result{$col_name} = \%column_info;
2531 return \%result if !$caught && scalar keys %result;
2535 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2537 my @columns = @{$sth->{NAME_lc}};
2538 for my $i ( 0 .. $#columns ){
2540 $column_info{data_type} = $sth->{TYPE}->[$i];
2541 $column_info{size} = $sth->{PRECISION}->[$i];
2542 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2544 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2545 $column_info{data_type} = $1;
2546 $column_info{size} = $2;
2549 $result{$columns[$i]} = \%column_info;
2553 foreach my $col (keys %result) {
2554 my $colinfo = $result{$col};
2555 my $type_num = $colinfo->{data_type};
2557 if(defined $type_num && $dbh->can('type_info')) {
2558 my $type_info = $dbh->type_info($type_num);
2559 $type_name = $type_info->{TYPE_NAME} if $type_info;
2560 $colinfo->{data_type} = $type_name if $type_name;
2567 sub columns_info_for {
2568 my ($self, $table) = @_;
2569 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2572 =head2 last_insert_id
2574 Return the row id of the last insert.
2578 sub _dbh_last_insert_id {
2579 my ($self, $dbh, $source, $col) = @_;
2581 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2583 return $id if defined $id;
2585 my $class = ref $self;
2586 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2589 sub last_insert_id {
2591 $self->_dbh_last_insert_id ($self->_dbh, @_);
2594 =head2 _native_data_type
2598 =item Arguments: $type_name
2602 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2603 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2604 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2606 The default implementation returns C<undef>, implement in your Storage driver if
2607 you need this functionality.
2609 Should map types from other databases to the native RDBMS type, for example
2610 C<VARCHAR2> to C<VARCHAR>.
2612 Types with modifiers should map to the underlying data type. For example,
2613 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2615 Composite types should map to the container type, for example
2616 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2620 sub _native_data_type {
2621 #my ($self, $data_type) = @_;
2625 # Check if placeholders are supported at all
2626 sub _determine_supports_placeholders {
2628 my $dbh = $self->_get_dbh;
2630 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2631 # but it is inaccurate more often than not
2633 local $dbh->{PrintError} = 0;
2634 local $dbh->{RaiseError} = 1;
2635 $dbh->do('select ?', {}, 1);
2643 # Check if placeholders bound to non-string types throw exceptions
2645 sub _determine_supports_typeless_placeholders {
2647 my $dbh = $self->_get_dbh;
2650 local $dbh->{PrintError} = 0;
2651 local $dbh->{RaiseError} = 1;
2652 # this specifically tests a bind that is NOT a string
2653 $dbh->do('select 1 where 1 = ?', {}, 1);
2663 Returns the database driver name.
2668 shift->_get_dbh->{Driver}->{Name};
2671 =head2 bind_attribute_by_data_type
2673 Given a datatype from column info, returns a database specific bind
2674 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2675 let the database planner just handle it.
2677 This method is always called after the driver has been determined and a DBI
2678 connection has been established. Therefore you can refer to C<DBI::$constant>
2679 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2680 the correct modules.
2684 sub bind_attribute_by_data_type {
2688 =head2 is_datatype_numeric
2690 Given a datatype from column_info, returns a boolean value indicating if
2691 the current RDBMS considers it a numeric value. This controls how
2692 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2693 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2694 be performed instead of the usual C<eq>.
2698 sub is_datatype_numeric {
2699 #my ($self, $dt) = @_;
2701 return 0 unless $_[1];
2704 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2709 =head2 create_ddl_dir
2713 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2717 Creates a SQL file based on the Schema, for each of the specified
2718 database engines in C<\@databases> in the given directory.
2719 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2721 Given a previous version number, this will also create a file containing
2722 the ALTER TABLE statements to transform the previous schema into the
2723 current one. Note that these statements may contain C<DROP TABLE> or
2724 C<DROP COLUMN> statements that can potentially destroy data.
2726 The file names are created using the C<ddl_filename> method below, please
2727 override this method in your schema if you would like a different file
2728 name format. For the ALTER file, the same format is used, replacing
2729 $version in the name with "$preversion-$version".
2731 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2732 The most common value for this would be C<< { add_drop_table => 1 } >>
2733 to have the SQL produced include a C<DROP TABLE> statement for each table
2734 created. For quoting purposes supply C<quote_identifiers>.
2736 If no arguments are passed, then the following default values are assumed:
2740 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2742 =item version - $schema->schema_version
2744 =item directory - './'
2746 =item preversion - <none>
2750 By default, C<\%sqlt_args> will have
2752 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2754 merged with the hash passed in. To disable any of those features, pass in a
2755 hashref like the following
2757 { ignore_constraint_names => 0, # ... other options }
2760 WARNING: You are strongly advised to check all SQL files created, before applying
2765 sub create_ddl_dir {
2766 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2769 carp "No directory given, using ./\n";
2774 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2776 $self->throw_exception(
2777 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2781 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2783 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2784 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2786 my $schema_version = $schema->schema_version || '1.x';
2787 $version ||= $schema_version;
2790 add_drop_table => 1,
2791 ignore_constraint_names => 1,
2792 ignore_index_names => 1,
2796 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2797 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2800 my $sqlt = SQL::Translator->new( $sqltargs );
2802 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2803 my $sqlt_schema = $sqlt->translate({ data => $schema })
2804 or $self->throw_exception ($sqlt->error);
2806 foreach my $db (@$databases) {
2808 $sqlt->{schema} = $sqlt_schema;
2809 $sqlt->producer($db);
2812 my $filename = $schema->ddl_filename($db, $version, $dir);
2813 if (-e $filename && ($version eq $schema_version )) {
2814 # if we are dumping the current version, overwrite the DDL
2815 carp "Overwriting existing DDL file - $filename";
2819 my $output = $sqlt->translate;
2821 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2824 if(!open($file, ">$filename")) {
2825 $self->throw_exception("Can't open $filename for writing ($!)");
2828 print $file $output;
2831 next unless ($preversion);
2833 require SQL::Translator::Diff;
2835 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2836 if(!-e $prefilename) {
2837 carp("No previous schema file found ($prefilename)");
2841 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2843 carp("Overwriting existing diff file - $difffile");
2849 my $t = SQL::Translator->new($sqltargs);
2854 or $self->throw_exception ($t->error);
2856 my $out = $t->translate( $prefilename )
2857 or $self->throw_exception ($t->error);
2859 $source_schema = $t->schema;
2861 $source_schema->name( $prefilename )
2862 unless ( $source_schema->name );
2865 # The "new" style of producers have sane normalization and can support
2866 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2867 # And we have to diff parsed SQL against parsed SQL.
2868 my $dest_schema = $sqlt_schema;
2870 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2871 my $t = SQL::Translator->new($sqltargs);
2876 or $self->throw_exception ($t->error);
2878 my $out = $t->translate( $filename )
2879 or $self->throw_exception ($t->error);
2881 $dest_schema = $t->schema;
2883 $dest_schema->name( $filename )
2884 unless $dest_schema->name;
2887 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2891 if(!open $file, ">$difffile") {
2892 $self->throw_exception("Can't write to $difffile ($!)");
2900 =head2 deployment_statements
2904 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2908 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2910 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2911 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2913 C<$directory> is used to return statements from files in a previously created
2914 L</create_ddl_dir> directory and is optional. The filenames are constructed
2915 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2917 If no C<$directory> is specified then the statements are constructed on the
2918 fly using L<SQL::Translator> and C<$version> is ignored.
2920 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2924 sub deployment_statements {
2925 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2926 $type ||= $self->sqlt_type;
2927 $version ||= $schema->schema_version || '1.x';
2929 my $filename = $schema->ddl_filename($type, $version, $dir);
2932 # FIXME replace this block when a proper sane sql parser is available
2934 open($file, "<$filename")
2935 or $self->throw_exception("Can't open $filename ($!)");
2938 return join('', @rows);
2941 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2942 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2945 # sources needs to be a parser arg, but for simplicity allow at top level
2947 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2948 if exists $sqltargs->{sources};
2950 my $tr = SQL::Translator->new(
2951 producer => "SQL::Translator::Producer::${type}",
2953 parser => 'SQL::Translator::Parser::DBIx::Class',
2957 return preserve_context {
2960 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2961 unless defined $_[0];
2965 # FIXME deploy() currently does not accurately report sql errors
2966 # Will always return true while errors are warned
2968 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2972 return if($line =~ /^--/);
2973 # next if($line =~ /^DROP/m);
2974 return if($line =~ /^BEGIN TRANSACTION/m);
2975 return if($line =~ /^COMMIT/m);
2976 return if $line =~ /^\s+$/; # skip whitespace only
2977 $self->_query_start($line);
2979 # do a dbh_do cycle here, as we need some error checking in
2980 # place (even though we will ignore errors)
2981 $self->dbh_do (sub { $_[1]->do($line) });
2983 carp qq{$_ (running "${line}")};
2985 $self->_query_end($line);
2987 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2988 if (@statements > 1) {
2989 foreach my $statement (@statements) {
2990 $deploy->( $statement );
2993 elsif (@statements == 1) {
2994 # split on single line comments and end of statements
2995 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
3001 =head2 datetime_parser
3003 Returns the datetime parser class
3007 sub datetime_parser {
3009 return $self->{datetime_parser} ||= do {
3010 $self->build_datetime_parser(@_);
3014 =head2 datetime_parser_type
3016 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3018 =head2 build_datetime_parser
3020 See L</datetime_parser>
3024 sub build_datetime_parser {
3026 my $type = $self->datetime_parser_type(@_);
3031 =head2 is_replicating
3033 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3034 replicate from a master database. Default is undef, which is the result
3035 returned by databases that don't support replication.
3039 sub is_replicating {
3044 =head2 lag_behind_master
3046 Returns a number that represents a certain amount of lag behind a master db
3047 when a given storage is replicating. The number is database dependent, but
3048 starts at zero and increases with the amount of lag. Default in undef
3052 sub lag_behind_master {
3056 =head2 relname_to_table_alias
3060 =item Arguments: $relname, $join_count
3062 =item Return Value: $alias
3066 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3069 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3070 way these aliases are named.
3072 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3073 otherwise C<"$relname">.
3077 sub relname_to_table_alias {
3078 my ($self, $relname, $join_count) = @_;
3080 my $alias = ($join_count && $join_count > 1 ?
3081 join('_', $relname, $join_count) : $relname);
3086 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3087 # version and it may be necessary to amend or override it for a specific storage
3088 # if such binds are necessary.
3089 sub _max_column_bytesize {
3090 my ($self, $attr) = @_;
3094 if ($attr->{sqlt_datatype}) {
3095 my $data_type = lc($attr->{sqlt_datatype});
3097 if ($attr->{sqlt_size}) {
3099 # String/sized-binary types
3100 if ($data_type =~ /^(?:
3101 l? (?:var)? char(?:acter)? (?:\s*varying)?
3103 (?:var)? binary (?:\s*varying)?
3108 $max_size = $attr->{sqlt_size};
3110 # Other charset/unicode types, assume scale of 4
3111 elsif ($data_type =~ /^(?:
3112 national \s* character (?:\s*varying)?
3121 $max_size = $attr->{sqlt_size} * 4;
3125 if (!$max_size and !$self->_is_lob_type($data_type)) {
3126 $max_size = 100 # for all other (numeric?) datatypes
3130 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3133 # Determine if a data_type is some type of BLOB
3135 my ($self, $data_type) = @_;
3136 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3137 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3138 |varchar|character\s*varying|nvarchar
3139 |national\s*character\s*varying))?\z/xi);
3142 sub _is_binary_lob_type {
3143 my ($self, $data_type) = @_;
3144 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3145 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3148 sub _is_text_lob_type {
3149 my ($self, $data_type) = @_;
3150 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3151 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3152 |national\s*character\s*varying))\z/xi);
3155 # Determine if a data_type is some type of a binary type
3156 sub _is_binary_type {
3157 my ($self, $data_type) = @_;
3158 $data_type && ($self->_is_binary_lob_type($data_type)
3159 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3166 =head2 DBIx::Class and AutoCommit
3168 DBIx::Class can do some wonderful magic with handling exceptions,
3169 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3170 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3171 transaction support.
3173 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3174 in an assumed transaction between commits, and you're telling us you'd
3175 like to manage that manually. A lot of the magic protections offered by
3176 this module will go away. We can't protect you from exceptions due to database
3177 disconnects because we don't know anything about how to restart your
3178 transactions. You're on your own for handling all sorts of exceptional
3179 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3183 =head1 AUTHOR AND CONTRIBUTORS
3185 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3189 You may distribute this code under the same terms as Perl itself.