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
18 use DBI::Const::GetInfoType (); # no import of retarded global hash
21 # default cursor class, overridable in connect_info attributes
22 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
24 __PACKAGE__->mk_group_accessors('inherited' => qw/
25 sql_limit_dialect sql_quote_char sql_name_sep
28 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
30 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
31 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
33 __PACKAGE__->sql_name_sep('.');
35 __PACKAGE__->mk_group_accessors('simple' => qw/
36 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
37 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
38 _perform_autoinc_retrieval _autoinc_supplied_for_op
41 # the values for these accessors are picked out (and deleted) from
42 # the attribute hashref passed to connect_info
43 my @storage_options = qw/
44 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
45 disable_sth_caching unsafe auto_savepoint
47 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
50 # capability definitions, using a 2-tiered accessor system
53 # A driver/user may define _use_X, which blindly without any checks says:
54 # "(do not) use this capability", (use_dbms_capability is an "inherited"
57 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
58 # accessor, which in turn calls _determine_supports_X, and stores the return
59 # in a special slot on the storage object, which is wiped every time a $dbh
60 # reconnection takes place (it is not guaranteed that upon reconnection we
61 # will get the same rdbms version). _determine_supports_X does not need to
62 # exist on a driver, as we ->can for it before calling.
64 my @capabilities = (qw/
66 insert_returning_bound
75 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
76 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
78 # on by default, not strictly a capability (pending rewrite)
79 __PACKAGE__->_use_join_optimizer (1);
80 sub _determine_supports_join_optimizer { 1 };
82 # Each of these methods need _determine_driver called before itself
83 # in order to function reliably. This is a purely DRY optimization
85 # get_(use)_dbms_capability need to be called on the correct Storage
86 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
87 # _determine_supports_X which obv. needs a correct driver as well
88 my @rdbms_specific_methods = qw/
101 with_deferred_fk_checks
103 get_use_dbms_capability
110 for my $meth (@rdbms_specific_methods) {
112 my $orig = __PACKAGE__->can ($meth)
113 or die "$meth is not a ::Storage::DBI method!";
116 no warnings qw/redefine/;
117 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
119 # only fire when invoked on an instance, a valid class-based invocation
120 # would e.g. be setting a default for an inherited accessor
123 ! $_[0]->_driver_determined
125 ! $_[0]->{_in_determine_driver}
127 $_[0]->_determine_driver;
129 # This for some reason crashes and burns on perl 5.8.1
130 # IFF the method ends up throwing an exception
131 #goto $_[0]->can ($meth);
133 my $cref = $_[0]->can ($meth);
143 DBIx::Class::Storage::DBI - DBI storage handler
147 my $schema = MySchema->connect('dbi:SQLite:my.db');
149 $schema->storage->debug(1);
151 my @stuff = $schema->storage->dbh_do(
153 my ($storage, $dbh, @args) = @_;
154 $dbh->do("DROP TABLE authors");
159 $schema->resultset('Book')->search({
160 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
165 This class represents the connection to an RDBMS via L<DBI>. See
166 L<DBIx::Class::Storage> for general information. This pod only
167 documents DBI-specific methods and behaviors.
174 my $new = shift->next::method(@_);
176 $new->_sql_maker_opts({});
177 $new->_dbh_details({});
178 $new->{_in_do_block} = 0;
179 $new->{_dbh_gen} = 0;
181 # read below to see what this does
182 $new->_arm_global_destructor;
187 # This is hack to work around perl shooting stuff in random
188 # order on exit(). If we do not walk the remaining storage
189 # objects in an END block, there is a *small but real* chance
190 # of a fork()ed child to kill the parent's shared DBI handle,
191 # *before perl reaches the DESTROY in this package*
192 # Yes, it is ugly and effective.
193 # Additionally this registry is used by the CLONE method to
194 # make sure no handles are shared between threads
196 my %seek_and_destroy;
198 sub _arm_global_destructor {
200 $seek_and_destroy{ refaddr($_[0]) } = $_[0]
205 local $?; # just in case the DBI destructor changes it somehow
207 # destroy just the object if not native to this process
208 $_->_verify_pid for (grep
210 values %seek_and_destroy
215 # As per DBI's recommendation, DBIC disconnects all handles as
216 # soon as possible (DBIC will reconnect only on demand from within
218 my @instances = grep { defined $_ } values %seek_and_destroy;
220 $_->{_dbh_gen}++; # so that existing cursors will drop as well
223 $_->transaction_depth(0);
227 # properly renumber all existing refs
228 %seek_and_destroy = ();
229 $_->_arm_global_destructor for @instances;
236 # some databases spew warnings on implicit disconnect
237 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
238 local $SIG{__WARN__} = sub {};
241 # this op is necessary, since the very last perl runtime statement
242 # triggers a global destruction shootout, and the $SIG localization
243 # may very well be destroyed before perl actually gets to do the
248 # handle pid changes correctly - do not destroy parent's connection
252 my $pid = $self->_conn_pid;
253 if( defined $pid and $pid != $$ and my $dbh = $self->_dbh ) {
254 $dbh->{InactiveDestroy} = 1;
257 $self->transaction_depth(0);
258 $self->savepoints([]);
266 This method is normally called by L<DBIx::Class::Schema/connection>, which
267 encapsulates its argument list in an arrayref before passing them here.
269 The argument list may contain:
275 The same 4-element argument set one would normally pass to
276 L<DBI/connect>, optionally followed by
277 L<extra attributes|/DBIx::Class specific connection attributes>
278 recognized by DBIx::Class:
280 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
284 A single code reference which returns a connected
285 L<DBI database handle|DBI/connect> optionally followed by
286 L<extra attributes|/DBIx::Class specific connection attributes> recognized
289 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
293 A single hashref with all the attributes and the dsn/user/password
296 $connect_info_args = [{
304 $connect_info_args = [{
305 dbh_maker => sub { DBI->connect (...) },
310 This is particularly useful for L<Catalyst> based applications, allowing the
311 following config (L<Config::General> style):
316 dsn dbi:mysql:database=test
323 The C<dsn>/C<user>/C<password> combination can be substituted by the
324 C<dbh_maker> key whose value is a coderef that returns a connected
325 L<DBI database handle|DBI/connect>
329 Please note that the L<DBI> docs recommend that you always explicitly
330 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
331 recommends that it be set to I<1>, and that you perform transactions
332 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
333 to I<1> if you do not do explicitly set it to zero. This is the default
334 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
336 =head3 DBIx::Class specific connection attributes
338 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
339 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
340 the following connection options. These options can be mixed in with your other
341 L<DBI> connection attributes, or placed in a separate hashref
342 (C<\%extra_attributes>) as shown above.
344 Every time C<connect_info> is invoked, any previous settings for
345 these options will be cleared before setting the new ones, regardless of
346 whether any options are specified in the new C<connect_info>.
353 Specifies things to do immediately after connecting or re-connecting to
354 the database. Its value may contain:
360 This contains one SQL statement to execute.
362 =item an array reference
364 This contains SQL statements to execute in order. Each element contains
365 a string or a code reference that returns a string.
367 =item a code reference
369 This contains some code to execute. Unlike code references within an
370 array reference, its return value is ignored.
374 =item on_disconnect_do
376 Takes arguments in the same form as L</on_connect_do> and executes them
377 immediately before disconnecting from the database.
379 Note, this only runs if you explicitly call L</disconnect> on the
382 =item on_connect_call
384 A more generalized form of L</on_connect_do> that calls the specified
385 C<connect_call_METHOD> methods in your storage driver.
387 on_connect_do => 'select 1'
391 on_connect_call => [ [ do_sql => 'select 1' ] ]
393 Its values may contain:
399 Will call the C<connect_call_METHOD> method.
401 =item a code reference
403 Will execute C<< $code->($storage) >>
405 =item an array reference
407 Each value can be a method name or code reference.
409 =item an array of arrays
411 For each array, the first item is taken to be the C<connect_call_> method name
412 or code reference, and the rest are parameters to it.
416 Some predefined storage methods you may use:
422 Executes a SQL string or a code reference that returns a SQL string. This is
423 what L</on_connect_do> and L</on_disconnect_do> use.
431 Will execute the scalar as SQL.
435 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
436 attributes hashref and bind values.
438 =item a code reference
440 Will execute C<< $code->($storage) >> and execute the return array refs as
447 Execute any statements necessary to initialize the database session to return
448 and accept datetime/timestamp values used with
449 L<DBIx::Class::InflateColumn::DateTime>.
451 Only necessary for some databases, see your specific storage driver for
452 implementation details.
456 =item on_disconnect_call
458 Takes arguments in the same form as L</on_connect_call> and executes them
459 immediately before disconnecting from the database.
461 Calls the C<disconnect_call_METHOD> methods as opposed to the
462 C<connect_call_METHOD> methods called by L</on_connect_call>.
464 Note, this only runs if you explicitly call L</disconnect> on the
467 =item disable_sth_caching
469 If set to a true value, this option will disable the caching of
470 statement handles via L<DBI/prepare_cached>.
474 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
475 default L</sql_limit_dialect> setting of the storage (if any). For a list
476 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
480 When true automatically sets L</quote_char> and L</name_sep> to the characters
481 appropriate for your particular RDBMS. This option is preferred over specifying
482 L</quote_char> directly.
486 Specifies what characters to use to quote table and column names.
488 C<quote_char> expects either a single character, in which case is it
489 is placed on either side of the table/column name, or an arrayref of length
490 2 in which case the table/column name is placed between the elements.
492 For example under MySQL you should use C<< quote_char => '`' >>, and for
493 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
497 This parameter is only useful in conjunction with C<quote_char>, and is used to
498 specify the character that separates elements (schemas, tables, columns) from
499 each other. If unspecified it defaults to the most commonly used C<.>.
503 This Storage driver normally installs its own C<HandleError>, sets
504 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
505 all database handles, including those supplied by a coderef. It does this
506 so that it can have consistent and useful error behavior.
508 If you set this option to a true value, Storage will not do its usual
509 modifications to the database handle's attributes, and instead relies on
510 the settings in your connect_info DBI options (or the values you set in
511 your connection coderef, in the case that you are connecting via coderef).
513 Note that your custom settings can cause Storage to malfunction,
514 especially if you set a C<HandleError> handler that suppresses exceptions
515 and/or disable C<RaiseError>.
519 If this option is true, L<DBIx::Class> will use savepoints when nesting
520 transactions, making it possible to recover from failure in the inner
521 transaction without having to abort all outer transactions.
525 Use this argument to supply a cursor class other than the default
526 L<DBIx::Class::Storage::DBI::Cursor>.
530 Some real-life examples of arguments to L</connect_info> and
531 L<DBIx::Class::Schema/connect>
533 # Simple SQLite connection
534 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
537 ->connect_info([ sub { DBI->connect(...) } ]);
539 # Connect via subref in hashref
541 dbh_maker => sub { DBI->connect(...) },
542 on_connect_do => 'alter session ...',
545 # A bit more complicated
552 { quote_char => q{"} },
556 # Equivalent to the previous example
562 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
566 # Same, but with hashref as argument
567 # See parse_connect_info for explanation
570 dsn => 'dbi:Pg:dbname=foo',
572 password => 'my_pg_password',
579 # Subref + DBIx::Class-specific connection options
582 sub { DBI->connect(...) },
586 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
587 disable_sth_caching => 1,
597 my ($self, $info) = @_;
599 return $self->_connect_info if !$info;
601 $self->_connect_info($info); # copy for _connect_info
603 $info = $self->_normalize_connect_info($info)
604 if ref $info eq 'ARRAY';
606 for my $storage_opt (keys %{ $info->{storage_options} }) {
607 my $value = $info->{storage_options}{$storage_opt};
609 $self->$storage_opt($value);
612 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
613 # the new set of options
614 $self->_sql_maker(undef);
615 $self->_sql_maker_opts({});
617 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
618 my $value = $info->{sql_maker_options}{$sql_maker_opt};
620 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
624 %{ $self->_default_dbi_connect_attributes || {} },
625 %{ $info->{attributes} || {} },
628 my @args = @{ $info->{arguments} };
630 if (keys %attrs and ref $args[0] ne 'CODE') {
632 'You provided explicit AutoCommit => 0 in your connection_info. '
633 . 'This is almost universally a bad idea (see the footnotes of '
634 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
635 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
637 if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
639 push @args, \%attrs if keys %attrs;
641 $self->_dbi_connect_info(\@args);
644 # save attributes them in a separate accessor so they are always
645 # introspectable, even in case of a CODE $dbhmaker
646 $self->_dbic_connect_attributes (\%attrs);
648 return $self->_connect_info;
651 sub _normalize_connect_info {
652 my ($self, $info_arg) = @_;
655 my @args = @$info_arg; # take a shallow copy for further mutilation
657 # combine/pre-parse arguments depending on invocation style
660 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
661 %attrs = %{ $args[1] || {} };
664 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
665 %attrs = %{$args[0]};
667 if (my $code = delete $attrs{dbh_maker}) {
670 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
673 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
674 . "to the result of 'dbh_maker'",
676 join (', ', map { "'$_'" } (@ignored) ),
681 @args = delete @attrs{qw/dsn user password/};
684 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
686 % { $args[3] || {} },
687 % { $args[4] || {} },
689 @args = @args[0,1,2];
692 $info{arguments} = \@args;
694 my @storage_opts = grep exists $attrs{$_},
695 @storage_options, 'cursor_class';
697 @{ $info{storage_options} }{@storage_opts} =
698 delete @attrs{@storage_opts} if @storage_opts;
700 my @sql_maker_opts = grep exists $attrs{$_},
701 qw/limit_dialect quote_char name_sep quote_names/;
703 @{ $info{sql_maker_options} }{@sql_maker_opts} =
704 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
706 $info{attributes} = \%attrs if %attrs;
711 sub _default_dbi_connect_attributes () {
716 ShowErrorStatement => 1,
722 This method is deprecated in favour of setting via L</connect_info>.
726 =head2 on_disconnect_do
728 This method is deprecated in favour of setting via L</connect_info>.
732 sub _parse_connect_do {
733 my ($self, $type) = @_;
735 my $val = $self->$type;
736 return () if not defined $val;
741 push @res, [ 'do_sql', $val ];
742 } elsif (ref($val) eq 'CODE') {
744 } elsif (ref($val) eq 'ARRAY') {
745 push @res, map { [ 'do_sql', $_ ] } @$val;
747 $self->throw_exception("Invalid type for $type: ".ref($val));
755 Arguments: ($subref | $method_name), @extra_coderef_args?
757 Execute the given $subref or $method_name using the new exception-based
758 connection management.
760 The first two arguments will be the storage object that C<dbh_do> was called
761 on and a database handle to use. Any additional arguments will be passed
762 verbatim to the called subref as arguments 2 and onwards.
764 Using this (instead of $self->_dbh or $self->dbh) ensures correct
765 exception handling and reconnection (or failover in future subclasses).
767 Your subref should have no side-effects outside of the database, as
768 there is the potential for your subref to be partially double-executed
769 if the database connection was stale/dysfunctional.
773 my @stuff = $schema->storage->dbh_do(
775 my ($storage, $dbh, @cols) = @_;
776 my $cols = join(q{, }, @cols);
777 $dbh->selectrow_array("SELECT $cols FROM foo");
786 my $run_target = shift;
788 # short circuit when we know there is no need for a runner
790 # FIXME - asumption may be wrong
791 # the rationale for the txn_depth check is that if this block is a part
792 # of a larger transaction, everything up to that point is screwed anyway
793 return $self->$run_target($self->_get_dbh, @_)
794 if $self->{_in_do_block} or $self->transaction_depth;
796 my $cref = (ref $run_target eq 'CODE')
798 : $self->can($run_target) || $self->throw_exception(sprintf (
799 'Can\'t locate object method "%s" via package "%s"',
801 (ref $self || $self),
805 # take a ref instead of a copy, to preserve @_ aliasing
806 # semantics within the coderef, but only if needed
807 # (pseudoforking doesn't like this trick much)
808 my $args = @_ ? \@_ : [];
809 unshift @$args, $self, $self->_get_dbh;
811 DBIx::Class::Storage::BlockRunner->new(
816 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
821 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
822 shift->next::method(@_);
827 Our C<disconnect> method also performs a rollback first if the
828 database is not in C<AutoCommit> mode.
838 push @actions, ( $self->on_disconnect_call || () );
839 push @actions, $self->_parse_connect_do ('on_disconnect_do');
841 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
843 # stops the "implicit rollback on disconnect" warning
844 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
846 %{ $self->_dbh->{CachedKids} } = ();
847 $self->_dbh->disconnect;
853 =head2 with_deferred_fk_checks
857 =item Arguments: C<$coderef>
859 =item Return Value: The return value of $coderef
863 Storage specific method to run the code ref with FK checks deferred or
864 in MySQL's case disabled entirely.
868 # Storage subclasses should override this
869 sub with_deferred_fk_checks {
870 my ($self, $sub) = @_;
878 =item Arguments: none
880 =item Return Value: 1|0
884 Verifies that the current database handle is active and ready to execute
885 an SQL statement (e.g. the connection did not get stale, server is still
886 answering, etc.) This method is used internally by L</dbh>.
892 return 0 unless $self->_seems_connected;
895 local $self->_dbh->{RaiseError} = 1;
900 sub _seems_connected {
903 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
905 my $dbh = $self->_dbh
908 return $dbh->FETCH('Active');
914 my $dbh = $self->_dbh or return 0;
919 sub ensure_connected {
922 unless ($self->connected) {
923 $self->_populate_dbh;
929 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
930 is guaranteed to be healthy by implicitly calling L</connected>, and if
931 necessary performing a reconnection before returning. Keep in mind that this
932 is very B<expensive> on some database engines. Consider using L</dbh_do>
940 if (not $self->_dbh) {
941 $self->_populate_dbh;
943 $self->ensure_connected;
948 # this is the internal "get dbh or connect (don't check)" method
951 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
952 $self->_populate_dbh unless $self->_dbh;
958 unless ($self->_sql_maker) {
959 my $sql_maker_class = $self->sql_maker_class;
961 my %opts = %{$self->_sql_maker_opts||{}};
965 $self->sql_limit_dialect
968 my $s_class = (ref $self) || $self;
970 "Your storage class ($s_class) does not set sql_limit_dialect and you "
971 . 'have not supplied an explicit limit_dialect in your connection_info. '
972 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
973 . 'databases but can be (and often is) painfully slow. '
974 . "Please file an RT ticket against '$s_class' ."
981 my ($quote_char, $name_sep);
983 if ($opts{quote_names}) {
984 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
985 my $s_class = (ref $self) || $self;
987 "You requested 'quote_names' but your storage class ($s_class) does "
988 . 'not explicitly define a default sql_quote_char and you have not '
989 . 'supplied a quote_char as part of your connection_info. DBIC will '
990 .q{default to the ANSI SQL standard quote '"', which works most of }
991 . "the time. Please file an RT ticket against '$s_class'."
997 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
1000 $self->_sql_maker($sql_maker_class->new(
1001 bindtype=>'columns',
1002 array_datatypes => 1,
1003 limit_dialect => $dialect,
1004 ($quote_char ? (quote_char => $quote_char) : ()),
1005 name_sep => ($name_sep || '.'),
1009 return $self->_sql_maker;
1012 # nothing to do by default
1019 my @info = @{$self->_dbi_connect_info || []};
1020 $self->_dbh(undef); # in case ->connected failed we might get sent here
1021 $self->_dbh_details({}); # reset everything we know
1023 $self->_dbh($self->_connect(@info));
1025 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1027 $self->_determine_driver;
1029 # Always set the transaction depth on connect, since
1030 # there is no transaction in progress by definition
1031 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1033 $self->_run_connection_actions unless $self->{_in_determine_driver};
1036 sub _run_connection_actions {
1040 push @actions, ( $self->on_connect_call || () );
1041 push @actions, $self->_parse_connect_do ('on_connect_do');
1043 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1048 sub set_use_dbms_capability {
1049 $_[0]->set_inherited ($_[1], $_[2]);
1052 sub get_use_dbms_capability {
1053 my ($self, $capname) = @_;
1055 my $use = $self->get_inherited ($capname);
1058 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1062 sub set_dbms_capability {
1063 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1066 sub get_dbms_capability {
1067 my ($self, $capname) = @_;
1069 my $cap = $self->_dbh_details->{capability}{$capname};
1071 unless (defined $cap) {
1072 if (my $meth = $self->can ("_determine$capname")) {
1073 $cap = $self->$meth ? 1 : 0;
1079 $self->set_dbms_capability ($capname, $cap);
1089 unless ($info = $self->_dbh_details->{info}) {
1093 my $server_version = try {
1094 $self->_get_server_version
1096 # driver determination *may* use this codepath
1097 # in which case we must rethrow
1098 $self->throw_exception($_) if $self->{_in_determine_driver};
1100 # $server_version on failure
1104 if (defined $server_version) {
1105 $info->{dbms_version} = $server_version;
1107 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1108 my @verparts = split (/\./, $numeric_version);
1114 # consider only up to 3 version parts, iff not more than 3 digits
1116 while (@verparts && @use_parts < 3) {
1117 my $p = shift @verparts;
1119 push @use_parts, $p;
1121 push @use_parts, 0 while @use_parts < 3;
1123 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1127 $self->_dbh_details->{info} = $info;
1133 sub _get_server_version {
1134 shift->_dbh_get_info('SQL_DBMS_VER');
1138 my ($self, $info) = @_;
1140 if ($info =~ /[^0-9]/) {
1141 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1142 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1143 unless defined $info;
1146 return $self->_get_dbh->get_info($info);
1149 sub _describe_connection {
1150 require DBI::Const::GetInfoReturn;
1153 $self->ensure_connected;
1156 DBIC_DSN => $self->_dbi_connect_info->[0],
1157 DBI_VER => DBI->VERSION,
1158 DBIC_VER => DBIx::Class->VERSION,
1159 DBIC_DRIVER => ref $self,
1163 #keys %DBI::Const::GetInfoType::GetInfoType,
1165 SQL_CURSOR_COMMIT_BEHAVIOR
1166 SQL_CURSOR_ROLLBACK_BEHAVIOR
1167 SQL_CURSOR_SENSITIVITY
1168 SQL_DATA_SOURCE_NAME
1171 SQL_DEFAULT_TXN_ISOLATION
1176 SQL_EXPRESSIONS_IN_ORDERBY
1179 SQL_IDENTIFIER_QUOTE_CHAR
1180 SQL_MAX_CATALOG_NAME_LEN
1181 SQL_MAX_COLUMN_NAME_LEN
1182 SQL_MAX_IDENTIFIER_LEN
1183 SQL_MAX_TABLE_NAME_LEN
1184 SQL_MULTIPLE_ACTIVE_TXN
1185 SQL_MULT_RESULT_SETS
1186 SQL_NEED_LONG_DATA_LEN
1187 SQL_NON_NULLABLE_COLUMNS
1189 SQL_QUALIFIER_NAME_SEPARATOR
1190 SQL_QUOTED_IDENTIFIER_CASE
1192 SQL_TXN_ISOLATION_OPTION
1195 my $v = $self->_dbh_get_info($inf);
1196 next unless defined $v;
1198 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1199 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1200 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1206 sub _determine_driver {
1209 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1210 my $started_connected = 0;
1211 local $self->{_in_determine_driver} = 1;
1213 if (ref($self) eq __PACKAGE__) {
1215 if ($self->_dbh) { # we are connected
1216 $driver = $self->_dbh->{Driver}{Name};
1217 $started_connected = 1;
1220 # if connect_info is a CODEREF, we have no choice but to connect
1221 if (ref $self->_dbi_connect_info->[0] &&
1222 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1223 $self->_populate_dbh;
1224 $driver = $self->_dbh->{Driver}{Name};
1227 # try to use dsn to not require being connected, the driver may still
1228 # force a connection in _rebless to determine version
1229 # (dsn may not be supplied at all if all we do is make a mock-schema)
1230 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1231 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1232 $driver ||= $ENV{DBI_DRIVER};
1237 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1238 if ($self->load_optional_class($storage_class)) {
1239 mro::set_mro($storage_class, 'c3');
1240 bless $self, $storage_class;
1244 $self->_warn_undetermined_driver(
1245 'This version of DBIC does not yet seem to supply a driver for '
1246 . "your particular RDBMS and/or connection method ('$driver')."
1251 $self->_warn_undetermined_driver(
1252 'Unable to extract a driver name from connect info - this '
1253 . 'should not have happened.'
1258 $self->_driver_determined(1);
1260 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1262 if ($self->can('source_bind_attributes')) {
1263 $self->throw_exception(
1264 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1265 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1266 . 'If you are not sure how to proceed please contact the development team via '
1267 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1271 $self->_init; # run driver-specific initializations
1273 $self->_run_connection_actions
1274 if !$started_connected && defined $self->_dbh;
1278 sub _determine_connector_driver {
1279 my ($self, $conn) = @_;
1281 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1284 $self->_warn_undetermined_driver(
1285 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1286 . "$conn connector - this should not have happened."
1291 $dbtype =~ s/\W/_/gi;
1293 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1294 return if $self->isa($subclass);
1296 if ($self->load_optional_class($subclass)) {
1297 bless $self, $subclass;
1301 $self->_warn_undetermined_driver(
1302 'This version of DBIC does not yet seem to supply a driver for '
1303 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1308 sub _warn_undetermined_driver {
1309 my ($self, $msg) = @_;
1311 require Data::Dumper::Concise;
1313 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1314 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1315 . "does not go away, file a bugreport including the following info:\n"
1316 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1320 sub _do_connection_actions {
1322 my $method_prefix = shift;
1325 if (not ref($call)) {
1326 my $method = $method_prefix . $call;
1328 } elsif (ref($call) eq 'CODE') {
1330 } elsif (ref($call) eq 'ARRAY') {
1331 if (ref($call->[0]) ne 'ARRAY') {
1332 $self->_do_connection_actions($method_prefix, $_) for @$call;
1334 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1337 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1343 sub connect_call_do_sql {
1345 $self->_do_query(@_);
1348 sub disconnect_call_do_sql {
1350 $self->_do_query(@_);
1353 # override in db-specific backend when necessary
1354 sub connect_call_datetime_setup { 1 }
1357 my ($self, $action) = @_;
1359 if (ref $action eq 'CODE') {
1360 $action = $action->($self);
1361 $self->_do_query($_) foreach @$action;
1364 # Most debuggers expect ($sql, @bind), so we need to exclude
1365 # the attribute hash which is the second argument to $dbh->do
1366 # furthermore the bind values are usually to be presented
1367 # as named arrayref pairs, so wrap those here too
1368 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1369 my $sql = shift @do_args;
1370 my $attrs = shift @do_args;
1371 my @bind = map { [ undef, $_ ] } @do_args;
1374 $_[0]->_query_start($sql, \@bind);
1375 $_[1]->do($sql, $attrs, @do_args);
1376 $_[0]->_query_end($sql, \@bind);
1384 my ($self, @info) = @_;
1386 $self->throw_exception("You failed to provide any connection info")
1389 my ($old_connect_via, $dbh);
1391 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1394 if(ref $info[0] eq 'CODE') {
1395 $dbh = $info[0]->();
1399 $dbh = DBI->connect(@info);
1406 unless ($self->unsafe) {
1408 $self->throw_exception(
1409 'Refusing clobbering of {HandleError} installed on externally supplied '
1410 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1411 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1413 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1414 # request, or an external handle. Complain and set anyway
1415 unless ($dbh->{RaiseError}) {
1416 carp( ref $info[0] eq 'CODE'
1418 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1419 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1420 .'attribute has been supplied'
1422 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1423 .'unsafe => 1. Toggling RaiseError back to true'
1426 $dbh->{RaiseError} = 1;
1429 # this odd anonymous coderef dereference is in fact really
1430 # necessary to avoid the unwanted effect described in perl5
1433 my $weak_self = $_[0];
1436 # the coderef is blessed so we can distinguish it from externally
1437 # supplied handles (which must be preserved)
1438 $_[1]->{HandleError} = bless sub {
1440 $weak_self->throw_exception("DBI Exception: $_[0]");
1443 # the handler may be invoked by something totally out of
1445 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1447 }, '__DBIC__DBH__ERROR__HANDLER__';
1452 $self->throw_exception("DBI Connection failed: $_")
1455 $self->_dbh_autocommit($dbh->{AutoCommit});
1462 # this means we have not yet connected and do not know the AC status
1463 # (e.g. coderef $dbh), need a full-fledged connection check
1464 if (! defined $self->_dbh_autocommit) {
1465 $self->ensure_connected;
1467 # Otherwise simply connect or re-connect on pid changes
1472 $self->next::method(@_);
1475 sub _exec_txn_begin {
1478 # if the user is utilizing txn_do - good for him, otherwise we need to
1479 # ensure that the $dbh is healthy on BEGIN.
1480 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1481 # will be replaced by a failure of begin_work itself (which will be
1482 # then retried on reconnect)
1483 if ($self->{_in_do_block}) {
1484 $self->_dbh->begin_work;
1486 $self->dbh_do(sub { $_[1]->begin_work });
1493 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1494 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1497 # esoteric case for folks using external $dbh handles
1498 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1499 carp "Storage transaction_depth 0 does not match "
1500 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1501 $self->transaction_depth(1);
1504 $self->next::method(@_);
1506 # if AutoCommit is disabled txn_depth never goes to 0
1507 # as a new txn is started immediately on commit
1508 $self->transaction_depth(1) if (
1509 !$self->transaction_depth
1511 defined $self->_dbh_autocommit
1513 ! $self->_dbh_autocommit
1517 sub _exec_txn_commit {
1518 shift->_dbh->commit;
1524 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1525 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1528 # esoteric case for folks using external $dbh handles
1529 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1530 carp "Storage transaction_depth 0 does not match "
1531 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1532 $self->transaction_depth(1);
1535 $self->next::method(@_);
1537 # if AutoCommit is disabled txn_depth never goes to 0
1538 # as a new txn is started immediately on commit
1539 $self->transaction_depth(1) if (
1540 !$self->transaction_depth
1542 defined $self->_dbh_autocommit
1544 ! $self->_dbh_autocommit
1548 sub _exec_txn_rollback {
1549 shift->_dbh->rollback;
1552 # generate some identical methods
1553 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1555 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1557 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1558 $self->throw_exception("Unable to $meth() on a disconnected storage")
1560 $self->next::method(@_);
1564 # This used to be the top-half of _execute. It was split out to make it
1565 # easier to override in NoBindVars without duping the rest. It takes up
1566 # all of _execute's args, and emits $sql, @bind.
1567 sub _prep_for_execute {
1568 #my ($self, $op, $ident, $args) = @_;
1569 return shift->_gen_sql_bind(@_)
1573 my ($self, $op, $ident, $args) = @_;
1575 my ($colinfos, $from);
1576 if ( blessed($ident) ) {
1577 $from = $ident->from;
1578 $colinfos = $ident->columns_info;
1581 my ($sql, @bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1584 ! $ENV{DBIC_DT_SEARCH_OK}
1588 first { blessed($_->[1]) && $_->[1]->isa('DateTime') } @bind
1590 carp_unique 'DateTime objects passed to search() are not supported '
1591 . 'properly (InflateColumn::DateTime formats and settings are not '
1592 . 'respected.) See "Formatting DateTime objects in queries" in '
1593 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1594 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1597 return( $sql, $self->_resolve_bindattrs(
1598 $ident, [ @{$args->[2]{bind}||[]}, @bind ], $colinfos
1602 sub _resolve_bindattrs {
1603 my ($self, $ident, $bind, $colinfos) = @_;
1607 my $resolve_bindinfo = sub {
1608 #my $infohash = shift;
1610 %$colinfos = %{ $self->_resolve_column_info($ident) }
1611 unless keys %$colinfos;
1614 if (my $col = $_[0]->{dbic_colname}) {
1615 $ret = { %{$_[0]} };
1617 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1618 if $colinfos->{$col}{data_type};
1620 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1621 if $colinfos->{$col}{size};
1628 if (ref $_ ne 'ARRAY') {
1631 elsif (! defined $_->[0]) {
1634 elsif (ref $_->[0] eq 'HASH') {
1636 ($_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype}) ? $_->[0] : $resolve_bindinfo->($_->[0]),
1640 elsif (ref $_->[0] eq 'SCALAR') {
1641 [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1644 [ $resolve_bindinfo->({ dbic_colname => $_->[0] }), $_->[1] ]
1649 sub _format_for_trace {
1650 #my ($self, $bind) = @_;
1652 ### Turn @bind from something like this:
1653 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1655 ### ( "'1'", "'3'" )
1658 defined( $_ && $_->[1] )
1665 my ( $self, $sql, $bind ) = @_;
1667 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1672 my ( $self, $sql, $bind ) = @_;
1674 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1678 sub _dbi_attrs_for_bind {
1679 my ($self, $ident, $bind) = @_;
1683 for (map { $_->[0] } @$bind) {
1685 if (exists $_->{dbd_attrs}) {
1688 elsif($_->{sqlt_datatype}) {
1689 # cache the result in the dbh_details hash, as it can not change unless
1690 # we connect to something else
1691 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1692 if (not exists $cache->{$_->{sqlt_datatype}}) {
1693 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1695 $cache->{$_->{sqlt_datatype}};
1698 undef; # always push something at this position
1707 my ($self, $op, $ident, @args) = @_;
1709 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1711 shift->dbh_do( # retry over disconnects
1720 my ($self, undef, $sql, $bind, $ident) = @_;
1722 $self->_query_start( $sql, $bind );
1724 my $bind_attrs = $self->_dbi_attrs_for_bind($ident, $bind);
1726 my $sth = $self->_sth($sql);
1728 for my $i (0 .. $#$bind) {
1729 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1730 $sth->bind_param_inout(
1731 $i + 1, # bind params counts are 1-based
1733 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1740 (ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""'))
1749 # Can this fail without throwing an exception anyways???
1750 my $rv = $sth->execute();
1751 $self->throw_exception(
1752 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1755 $self->_query_end( $sql, $bind );
1757 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1760 sub _prefetch_autovalues {
1761 my ($self, $source, $colinfo, $to_insert) = @_;
1764 for my $col (keys %$colinfo) {
1766 $colinfo->{$col}{auto_nextval}
1769 ! exists $to_insert->{$col}
1771 ref $to_insert->{$col} eq 'SCALAR'
1773 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1776 $values{$col} = $self->_sequence_fetch(
1778 ( $colinfo->{$col}{sequence} ||=
1779 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1789 my ($self, $source, $to_insert) = @_;
1791 my $col_infos = $source->columns_info;
1793 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1795 # fuse the values, but keep a separate list of prefetched_values so that
1796 # they can be fused once again with the final return
1797 $to_insert = { %$to_insert, %$prefetched_values };
1799 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1800 # Investigate what does it take to s/defined/exists/
1801 my %pcols = map { $_ => 1 } $source->primary_columns;
1802 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1803 for my $col ($source->columns) {
1804 if ($col_infos->{$col}{is_auto_increment}) {
1805 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1806 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1809 # nothing to retrieve when explicit values are supplied
1810 next if (defined $to_insert->{$col} and ! (
1811 ref $to_insert->{$col} eq 'SCALAR'
1813 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1816 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1817 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1820 $col_infos->{$col}{retrieve_on_insert}
1824 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1825 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1827 my ($sqla_opts, @ir_container);
1828 if (%retrieve_cols and $self->_use_insert_returning) {
1829 $sqla_opts->{returning_container} = \@ir_container
1830 if $self->_use_insert_returning_bound;
1832 $sqla_opts->{returning} = [
1833 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1837 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1839 my %returned_cols = %$to_insert;
1840 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1841 @ir_container = try {
1842 local $SIG{__WARN__} = sub {};
1843 my @r = $sth->fetchrow_array;
1846 } unless @ir_container;
1848 @returned_cols{@$retlist} = @ir_container if @ir_container;
1851 # pull in PK if needed and then everything else
1852 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1854 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1855 unless $self->can('last_insert_id');
1857 my @pri_values = $self->last_insert_id($source, @missing_pri);
1859 $self->throw_exception( "Can't get last insert id" )
1860 unless (@pri_values == @missing_pri);
1862 @returned_cols{@missing_pri} = @pri_values;
1863 delete $retrieve_cols{$_} for @missing_pri;
1866 # if there is more left to pull
1867 if (%retrieve_cols) {
1868 $self->throw_exception(
1869 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1872 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1874 my $cur = DBIx::Class::ResultSet->new($source, {
1875 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1876 select => \@left_to_fetch,
1879 @returned_cols{@left_to_fetch} = $cur->next;
1881 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1882 if scalar $cur->next;
1886 return { %$prefetched_values, %returned_cols };
1890 my ($self, $source, $cols, $data) = @_;
1892 my @col_range = (0..$#$cols);
1894 # FIXME - perhaps this is not even needed? does DBI stringify?
1896 # forcibly stringify whatever is stringifiable
1897 # ResultSet::populate() hands us a copy - safe to mangle
1898 for my $r (0 .. $#$data) {
1899 for my $c (0 .. $#{$data->[$r]}) {
1900 $data->[$r][$c] = "$data->[$r][$c]"
1901 if ( ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1905 my $colinfos = $source->columns_info($cols);
1907 local $self->{_autoinc_supplied_for_op} =
1908 (first { $_->{is_auto_increment} } values %$colinfos)
1913 # get a slice type index based on first row of data
1914 # a "column" in this context may refer to more than one bind value
1915 # e.g. \[ '?, ?', [...], [...] ]
1917 # construct the value type index - a description of values types for every
1918 # per-column slice of $data:
1920 # nonexistent - nonbind literal
1922 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1924 # also construct the column hash to pass to the SQL generator. For plain
1925 # (non literal) values - convert the members of the first row into a
1926 # literal+bind combo, with extra positional info in the bind attr hashref.
1927 # This will allow us to match the order properly, and is so contrived
1928 # because a user-supplied literal/bind (or something else specific to a
1929 # resultsource and/or storage driver) can inject extra binds along the
1930 # way, so one can't rely on "shift positions" ordering at all. Also we
1931 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1932 # can be later matched up by address), because we want to supply a real
1933 # value on which perhaps e.g. datatype checks will be performed
1934 my ($proto_data, $value_type_by_col_idx);
1935 for my $i (@col_range) {
1936 my $colname = $cols->[$i];
1937 if (ref $data->[0][$i] eq 'SCALAR') {
1938 # no bind value at all - no type
1940 $proto_data->{$colname} = $data->[0][$i];
1942 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
1943 # repack, so we don't end up mangling the original \[]
1944 my ($sql, @bind) = @${$data->[0][$i]};
1946 # normalization of user supplied stuff
1947 my $resolved_bind = $self->_resolve_bindattrs(
1948 $source, \@bind, $colinfos,
1951 # store value-less (attrs only) bind info - we will be comparing all
1952 # supplied binds against this for sanity
1953 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
1955 $proto_data->{$colname} = \[ $sql, map { [
1956 # inject slice order to use for $proto_bind construction
1957 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
1959 $resolved_bind->[$_][1]
1964 $value_type_by_col_idx->{$i} = undef;
1966 $proto_data->{$colname} = \[ '?', [
1967 { dbic_colname => $colname, _bind_data_slice_idx => $i }
1974 my ($sql, $proto_bind) = $self->_prep_for_execute (
1980 if (! @$proto_bind and keys %$value_type_by_col_idx) {
1981 # if the bindlist is empty and we had some dynamic binds, this means the
1982 # storage ate them away (e.g. the NoBindVars component) and interpolated
1983 # them directly into the SQL. This obviously can't be good for multi-inserts
1984 $self->throw_exception('Cannot insert_bulk without support for placeholders');
1988 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
1990 # use an error reporting closure for convenience (less to pass)
1991 my $bad_slice_report_cref = sub {
1992 my ($msg, $r_idx, $c_idx) = @_;
1993 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
1997 require Data::Dumper::Concise;
1998 local $Data::Dumper::Maxdepth = 5;
1999 Data::Dumper::Concise::Dumper ({
2000 map { $cols->[$_] =>
2008 for my $col_idx (@col_range) {
2009 my $reference_val = $data->[0][$col_idx];
2011 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2012 my $val = $data->[$row_idx][$col_idx];
2014 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2015 if (ref $val ne 'SCALAR') {
2016 $bad_slice_report_cref->(
2017 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2022 elsif ($$val ne $$reference_val) {
2023 $bad_slice_report_cref->(
2024 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2030 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2031 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2032 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2035 else { # binds from a \[], compare type and attrs
2036 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2037 $bad_slice_report_cref->(
2038 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2043 # start drilling down and bail out early on identical refs
2045 $reference_val != $val
2047 $$reference_val != $$val
2049 if (${$val}->[0] ne ${$reference_val}->[0]) {
2050 $bad_slice_report_cref->(
2051 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2056 # need to check the bind attrs - a bind will happen only once for
2057 # the entire dataset, so any changes further down will be ignored.
2058 elsif (! Data::Compare::Compare(
2059 $value_type_by_col_idx->{$col_idx},
2063 @{$self->_resolve_bindattrs(
2064 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2068 $bad_slice_report_cref->(
2069 'Differing bind attributes on literal/bind values not supported',
2079 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2080 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2082 my $guard = $self->txn_scope_guard;
2084 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2085 my $sth = $self->_sth($sql);
2088 # proto bind contains the information on which pieces of $data to pull
2089 # $cols is passed in only for prettier error-reporting
2090 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2093 # bind_param_array doesn't work if there are no binds
2094 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2098 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2102 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2105 # execute_for_fetch is capable of returning data just fine (it means it
2106 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2107 # is the void-populate fast-path we will just ignore this altogether
2108 # for the time being.
2109 sub _dbh_execute_for_fetch {
2110 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2112 my @idx_range = ( 0 .. $#$proto_bind );
2114 # If we have any bind attributes to take care of, we will bind the
2115 # proto-bind data (which will never be used by execute_for_fetch)
2116 # However since column bindtypes are "sticky", this is sufficient
2117 # to get the DBD to apply the bindtype to all values later on
2119 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2121 for my $i (@idx_range) {
2123 $i+1, # DBI bind indexes are 1-based
2124 $proto_bind->[$i][1],
2126 ) if defined $bind_attrs->[$i];
2129 # At this point $data slots named in the _bind_data_slice_idx of
2130 # each piece of $proto_bind are either \[]s or plain values to be
2131 # passed in. Construct the dispensing coderef. *NOTE* the order
2132 # of $data will differ from this of the ?s in the SQL (due to
2133 # alphabetical ordering by colname). We actually do want to
2134 # preserve this behavior so that prepare_cached has a better
2135 # chance of matching on unrelated calls
2137 my $fetch_row_idx = -1; # saner loop this way
2138 my $fetch_tuple = sub {
2139 return undef if ++$fetch_row_idx > $#$data;
2141 return [ map { defined $_->{_literal_bind_subindex}
2142 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2143 ->[ $_->{_literal_bind_subindex} ]
2145 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2146 } map { $_->[0] } @$proto_bind];
2149 my $tuple_status = [];
2152 $rv = $sth->execute_for_fetch(
2161 # Not all DBDs are create equal. Some throw on error, some return
2162 # an undef $rv, and some set $sth->err - try whatever we can
2163 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2166 ( !defined $rv or $sth->err )
2169 # Statement must finish even if there was an exception.
2174 $err = shift unless defined $err
2179 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2181 $self->throw_exception("Unexpected populate error: $err")
2182 if ($i > $#$tuple_status);
2184 require Data::Dumper::Concise;
2185 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2186 ($tuple_status->[$i][1] || $err),
2187 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2194 sub _dbh_execute_inserts_with_no_binds {
2195 my ($self, $sth, $count) = @_;
2199 my $dbh = $self->_get_dbh;
2200 local $dbh->{RaiseError} = 1;
2201 local $dbh->{PrintError} = 0;
2203 $sth->execute foreach 1..$count;
2209 # Make sure statement is finished even if there was an exception.
2214 $err = shift unless defined $err;
2217 $self->throw_exception($err) if defined $err;
2223 #my ($self, $source, @args) = @_;
2224 shift->_execute('update', @_);
2229 #my ($self, $source, @args) = @_;
2230 shift->_execute('delete', @_);
2235 $self->_execute($self->_select_args(@_));
2238 sub _select_args_to_query {
2241 $self->throw_exception(
2242 "Unable to generate limited query representation with 'software_limit' enabled"
2243 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2245 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2246 # = $self->_select_args($ident, $select, $cond, $attrs);
2247 my ($op, $ident, @args) =
2248 $self->_select_args(@_);
2250 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2251 my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, \@args);
2252 $prepared_bind ||= [];
2255 ? ($sql, $prepared_bind)
2256 : \[ "($sql)", @$prepared_bind ]
2261 my ($self, $ident, $select, $where, $attrs) = @_;
2263 my $sql_maker = $self->sql_maker;
2264 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2271 $rs_alias && $alias2source->{$rs_alias}
2272 ? ( _rsroot_rsrc => $alias2source->{$rs_alias} )
2277 # Sanity check the attributes (SQLMaker does it too, but
2278 # in case of a software_limit we'll never reach there)
2279 if (defined $attrs->{offset}) {
2280 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2281 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2284 if (defined $attrs->{rows}) {
2285 $self->throw_exception("The rows attribute must be a positive integer if present")
2286 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2288 elsif ($attrs->{offset}) {
2289 # MySQL actually recommends this approach. I cringe.
2290 $attrs->{rows} = $sql_maker->__max_int;
2295 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2296 # storage, unless software limit was requested
2299 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2301 # grouped prefetch (to satisfy group_by == select)
2302 ( $attrs->{group_by}
2304 @{$attrs->{group_by}}
2306 $attrs->{_prefetch_selector_range}
2309 ($ident, $select, $where, $attrs)
2310 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2312 elsif (! $attrs->{software_limit} ) {
2314 $attrs->{rows} || (),
2315 $attrs->{offset} || (),
2319 # try to simplify the joinmap further (prune unreferenced type-single joins)
2323 reftype $ident eq 'ARRAY'
2327 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2331 # This would be the point to deflate anything found in $where
2332 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2333 # expect a result object. And all we have is a resultsource (it is trivial
2334 # to extract deflator coderefs via $alias2source above).
2336 # I don't see a way forward other than changing the way deflators are
2337 # invoked, and that's just bad...
2340 return ('select', $ident, $select, $where, $attrs, @limit);
2343 # Returns a counting SELECT for a simple count
2344 # query. Abstracted so that a storage could override
2345 # this to { count => 'firstcol' } or whatever makes
2346 # sense as a performance optimization
2348 #my ($self, $source, $rs_attrs) = @_;
2349 return { count => '*' };
2356 =item Arguments: $ident, $select, $condition, $attrs
2360 Handle a SQL select statement.
2366 my ($ident, $select, $condition, $attrs) = @_;
2367 return $self->cursor_class->new($self, \@_, $attrs);
2372 my ($rv, $sth, @bind) = $self->_select(@_);
2373 my @row = $sth->fetchrow_array;
2374 my @nextrow = $sth->fetchrow_array if @row;
2375 if(@row && @nextrow) {
2376 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2378 # Need to call finish() to work round broken DBDs
2383 =head2 sql_limit_dialect
2385 This is an accessor for the default SQL limit dialect used by a particular
2386 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2387 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2388 see L<DBIx::Class::SQLMaker::LimitDialects>.
2393 my ($self, $dbh, $sql) = @_;
2395 # 3 is the if_active parameter which avoids active sth re-use
2396 my $sth = $self->disable_sth_caching
2397 ? $dbh->prepare($sql)
2398 : $dbh->prepare_cached($sql, {}, 3);
2400 # XXX You would think RaiseError would make this impossible,
2401 # but apparently that's not true :(
2402 $self->throw_exception(
2405 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
2406 .'an exception and/or setting $dbh->errstr',
2408 ? substr($sql, 0, 20) . '...'
2411 'DBD::' . $dbh->{Driver}{Name},
2419 carp_unique 'sth was mistakenly marked/documented as public, stop calling it (will be removed before DBIC v0.09)';
2424 my ($self, $sql) = @_;
2425 $self->dbh_do('_dbh_sth', $sql); # retry over disconnects
2428 sub _dbh_columns_info_for {
2429 my ($self, $dbh, $table) = @_;
2431 if ($dbh->can('column_info')) {
2435 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2436 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2438 while ( my $info = $sth->fetchrow_hashref() ){
2440 $column_info{data_type} = $info->{TYPE_NAME};
2441 $column_info{size} = $info->{COLUMN_SIZE};
2442 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2443 $column_info{default_value} = $info->{COLUMN_DEF};
2444 my $col_name = $info->{COLUMN_NAME};
2445 $col_name =~ s/^\"(.*)\"$/$1/;
2447 $result{$col_name} = \%column_info;
2452 return \%result if !$caught && scalar keys %result;
2456 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2458 my @columns = @{$sth->{NAME_lc}};
2459 for my $i ( 0 .. $#columns ){
2461 $column_info{data_type} = $sth->{TYPE}->[$i];
2462 $column_info{size} = $sth->{PRECISION}->[$i];
2463 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2465 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2466 $column_info{data_type} = $1;
2467 $column_info{size} = $2;
2470 $result{$columns[$i]} = \%column_info;
2474 foreach my $col (keys %result) {
2475 my $colinfo = $result{$col};
2476 my $type_num = $colinfo->{data_type};
2478 if(defined $type_num && $dbh->can('type_info')) {
2479 my $type_info = $dbh->type_info($type_num);
2480 $type_name = $type_info->{TYPE_NAME} if $type_info;
2481 $colinfo->{data_type} = $type_name if $type_name;
2488 sub columns_info_for {
2489 my ($self, $table) = @_;
2490 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2493 =head2 last_insert_id
2495 Return the row id of the last insert.
2499 sub _dbh_last_insert_id {
2500 my ($self, $dbh, $source, $col) = @_;
2502 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2504 return $id if defined $id;
2506 my $class = ref $self;
2507 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2510 sub last_insert_id {
2512 $self->_dbh_last_insert_id ($self->_dbh, @_);
2515 =head2 _native_data_type
2519 =item Arguments: $type_name
2523 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2524 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2525 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2527 The default implementation returns C<undef>, implement in your Storage driver if
2528 you need this functionality.
2530 Should map types from other databases to the native RDBMS type, for example
2531 C<VARCHAR2> to C<VARCHAR>.
2533 Types with modifiers should map to the underlying data type. For example,
2534 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2536 Composite types should map to the container type, for example
2537 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2541 sub _native_data_type {
2542 #my ($self, $data_type) = @_;
2546 # Check if placeholders are supported at all
2547 sub _determine_supports_placeholders {
2549 my $dbh = $self->_get_dbh;
2551 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2552 # but it is inaccurate more often than not
2554 local $dbh->{PrintError} = 0;
2555 local $dbh->{RaiseError} = 1;
2556 $dbh->do('select ?', {}, 1);
2564 # Check if placeholders bound to non-string types throw exceptions
2566 sub _determine_supports_typeless_placeholders {
2568 my $dbh = $self->_get_dbh;
2571 local $dbh->{PrintError} = 0;
2572 local $dbh->{RaiseError} = 1;
2573 # this specifically tests a bind that is NOT a string
2574 $dbh->do('select 1 where 1 = ?', {}, 1);
2584 Returns the database driver name.
2589 shift->_get_dbh->{Driver}->{Name};
2592 =head2 bind_attribute_by_data_type
2594 Given a datatype from column info, returns a database specific bind
2595 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2596 let the database planner just handle it.
2598 This method is always called after the driver has been determined and a DBI
2599 connection has been established. Therefore you can refer to C<DBI::$constant>
2600 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2601 the correct modules.
2605 sub bind_attribute_by_data_type {
2609 =head2 is_datatype_numeric
2611 Given a datatype from column_info, returns a boolean value indicating if
2612 the current RDBMS considers it a numeric value. This controls how
2613 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2614 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2615 be performed instead of the usual C<eq>.
2619 sub is_datatype_numeric {
2620 #my ($self, $dt) = @_;
2622 return 0 unless $_[1];
2625 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2630 =head2 create_ddl_dir
2634 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2638 Creates a SQL file based on the Schema, for each of the specified
2639 database engines in C<\@databases> in the given directory.
2640 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2642 Given a previous version number, this will also create a file containing
2643 the ALTER TABLE statements to transform the previous schema into the
2644 current one. Note that these statements may contain C<DROP TABLE> or
2645 C<DROP COLUMN> statements that can potentially destroy data.
2647 The file names are created using the C<ddl_filename> method below, please
2648 override this method in your schema if you would like a different file
2649 name format. For the ALTER file, the same format is used, replacing
2650 $version in the name with "$preversion-$version".
2652 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2653 The most common value for this would be C<< { add_drop_table => 1 } >>
2654 to have the SQL produced include a C<DROP TABLE> statement for each table
2655 created. For quoting purposes supply C<quote_table_names> and
2656 C<quote_field_names>.
2658 If no arguments are passed, then the following default values are assumed:
2662 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2664 =item version - $schema->schema_version
2666 =item directory - './'
2668 =item preversion - <none>
2672 By default, C<\%sqlt_args> will have
2674 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2676 merged with the hash passed in. To disable any of those features, pass in a
2677 hashref like the following
2679 { ignore_constraint_names => 0, # ... other options }
2682 WARNING: You are strongly advised to check all SQL files created, before applying
2687 sub create_ddl_dir {
2688 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2691 carp "No directory given, using ./\n";
2696 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2698 $self->throw_exception(
2699 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2703 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2705 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2706 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2708 my $schema_version = $schema->schema_version || '1.x';
2709 $version ||= $schema_version;
2712 add_drop_table => 1,
2713 ignore_constraint_names => 1,
2714 ignore_index_names => 1,
2718 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2719 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2722 my $sqlt = SQL::Translator->new( $sqltargs );
2724 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2725 my $sqlt_schema = $sqlt->translate({ data => $schema })
2726 or $self->throw_exception ($sqlt->error);
2728 foreach my $db (@$databases) {
2730 $sqlt->{schema} = $sqlt_schema;
2731 $sqlt->producer($db);
2734 my $filename = $schema->ddl_filename($db, $version, $dir);
2735 if (-e $filename && ($version eq $schema_version )) {
2736 # if we are dumping the current version, overwrite the DDL
2737 carp "Overwriting existing DDL file - $filename";
2741 my $output = $sqlt->translate;
2743 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2746 if(!open($file, ">$filename")) {
2747 $self->throw_exception("Can't open $filename for writing ($!)");
2750 print $file $output;
2753 next unless ($preversion);
2755 require SQL::Translator::Diff;
2757 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2758 if(!-e $prefilename) {
2759 carp("No previous schema file found ($prefilename)");
2763 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2765 carp("Overwriting existing diff file - $difffile");
2771 my $t = SQL::Translator->new($sqltargs);
2776 or $self->throw_exception ($t->error);
2778 my $out = $t->translate( $prefilename )
2779 or $self->throw_exception ($t->error);
2781 $source_schema = $t->schema;
2783 $source_schema->name( $prefilename )
2784 unless ( $source_schema->name );
2787 # The "new" style of producers have sane normalization and can support
2788 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2789 # And we have to diff parsed SQL against parsed SQL.
2790 my $dest_schema = $sqlt_schema;
2792 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2793 my $t = SQL::Translator->new($sqltargs);
2798 or $self->throw_exception ($t->error);
2800 my $out = $t->translate( $filename )
2801 or $self->throw_exception ($t->error);
2803 $dest_schema = $t->schema;
2805 $dest_schema->name( $filename )
2806 unless $dest_schema->name;
2809 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2813 if(!open $file, ">$difffile") {
2814 $self->throw_exception("Can't write to $difffile ($!)");
2822 =head2 deployment_statements
2826 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2830 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2832 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2833 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2835 C<$directory> is used to return statements from files in a previously created
2836 L</create_ddl_dir> directory and is optional. The filenames are constructed
2837 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2839 If no C<$directory> is specified then the statements are constructed on the
2840 fly using L<SQL::Translator> and C<$version> is ignored.
2842 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2846 sub deployment_statements {
2847 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2848 $type ||= $self->sqlt_type;
2849 $version ||= $schema->schema_version || '1.x';
2851 my $filename = $schema->ddl_filename($type, $version, $dir);
2854 # FIXME replace this block when a proper sane sql parser is available
2856 open($file, "<$filename")
2857 or $self->throw_exception("Can't open $filename ($!)");
2860 return join('', @rows);
2863 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2864 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2867 # sources needs to be a parser arg, but for simplicty allow at top level
2869 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2870 if exists $sqltargs->{sources};
2872 my $tr = SQL::Translator->new(
2873 producer => "SQL::Translator::Producer::${type}",
2875 parser => 'SQL::Translator::Parser::DBIx::Class',
2879 return preserve_context {
2882 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2883 unless defined $_[0];
2887 # FIXME deploy() currently does not accurately report sql errors
2888 # Will always return true while errors are warned
2890 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2894 return if($line =~ /^--/);
2895 # next if($line =~ /^DROP/m);
2896 return if($line =~ /^BEGIN TRANSACTION/m);
2897 return if($line =~ /^COMMIT/m);
2898 return if $line =~ /^\s+$/; # skip whitespace only
2899 $self->_query_start($line);
2901 # do a dbh_do cycle here, as we need some error checking in
2902 # place (even though we will ignore errors)
2903 $self->dbh_do (sub { $_[1]->do($line) });
2905 carp qq{$_ (running "${line}")};
2907 $self->_query_end($line);
2909 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2910 if (@statements > 1) {
2911 foreach my $statement (@statements) {
2912 $deploy->( $statement );
2915 elsif (@statements == 1) {
2916 # split on single line comments and end of statements
2917 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2923 =head2 datetime_parser
2925 Returns the datetime parser class
2929 sub datetime_parser {
2931 return $self->{datetime_parser} ||= do {
2932 $self->build_datetime_parser(@_);
2936 =head2 datetime_parser_type
2938 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
2940 =head2 build_datetime_parser
2942 See L</datetime_parser>
2946 sub build_datetime_parser {
2948 my $type = $self->datetime_parser_type(@_);
2953 =head2 is_replicating
2955 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2956 replicate from a master database. Default is undef, which is the result
2957 returned by databases that don't support replication.
2961 sub is_replicating {
2966 =head2 lag_behind_master
2968 Returns a number that represents a certain amount of lag behind a master db
2969 when a given storage is replicating. The number is database dependent, but
2970 starts at zero and increases with the amount of lag. Default in undef
2974 sub lag_behind_master {
2978 =head2 relname_to_table_alias
2982 =item Arguments: $relname, $join_count
2984 =item Return Value: $alias
2988 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2991 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2992 way these aliases are named.
2994 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2995 otherwise C<"$relname">.
2999 sub relname_to_table_alias {
3000 my ($self, $relname, $join_count) = @_;
3002 my $alias = ($join_count && $join_count > 1 ?
3003 join('_', $relname, $join_count) : $relname);
3008 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3009 # version and it may be necessary to amend or override it for a specific storage
3010 # if such binds are necessary.
3011 sub _max_column_bytesize {
3012 my ($self, $attr) = @_;
3016 if ($attr->{sqlt_datatype}) {
3017 my $data_type = lc($attr->{sqlt_datatype});
3019 if ($attr->{sqlt_size}) {
3021 # String/sized-binary types
3022 if ($data_type =~ /^(?:
3023 l? (?:var)? char(?:acter)? (?:\s*varying)?
3025 (?:var)? binary (?:\s*varying)?
3030 $max_size = $attr->{sqlt_size};
3032 # Other charset/unicode types, assume scale of 4
3033 elsif ($data_type =~ /^(?:
3034 national \s* character (?:\s*varying)?
3043 $max_size = $attr->{sqlt_size} * 4;
3047 if (!$max_size and !$self->_is_lob_type($data_type)) {
3048 $max_size = 100 # for all other (numeric?) datatypes
3052 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3055 # Determine if a data_type is some type of BLOB
3057 my ($self, $data_type) = @_;
3058 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3059 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3060 |varchar|character\s*varying|nvarchar
3061 |national\s*character\s*varying))?\z/xi);
3064 sub _is_binary_lob_type {
3065 my ($self, $data_type) = @_;
3066 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3067 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3070 sub _is_text_lob_type {
3071 my ($self, $data_type) = @_;
3072 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3073 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3074 |national\s*character\s*varying))\z/xi);
3077 # Determine if a data_type is some type of a binary type
3078 sub _is_binary_type {
3079 my ($self, $data_type) = @_;
3080 $data_type && ($self->_is_binary_lob_type($data_type)
3081 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3088 =head2 DBIx::Class and AutoCommit
3090 DBIx::Class can do some wonderful magic with handling exceptions,
3091 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3092 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3093 transaction support.
3095 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3096 in an assumed transaction between commits, and you're telling us you'd
3097 like to manage that manually. A lot of the magic protections offered by
3098 this module will go away. We can't protect you from exceptions due to database
3099 disconnects because we don't know anything about how to restart your
3100 transactions. You're on your own for handling all sorts of exceptional
3101 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3105 =head1 AUTHOR AND CONTRIBUTORS
3107 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3111 You may distribute this code under the same terms as Perl itself.