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 # take a ref instead of a copy, to preserve @_ aliasing
797 # semantics within the coderef, but only if needed
798 # (pseudoforking doesn't like this trick much)
799 my $args = @_ ? \@_ : [];
801 DBIx::Class::Storage::BlockRunner->new(
803 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
805 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
810 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
811 shift->next::method(@_);
816 Our C<disconnect> method also performs a rollback first if the
817 database is not in C<AutoCommit> mode.
827 push @actions, ( $self->on_disconnect_call || () );
828 push @actions, $self->_parse_connect_do ('on_disconnect_do');
830 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
832 # stops the "implicit rollback on disconnect" warning
833 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
835 %{ $self->_dbh->{CachedKids} } = ();
836 $self->_dbh->disconnect;
842 =head2 with_deferred_fk_checks
846 =item Arguments: C<$coderef>
848 =item Return Value: The return value of $coderef
852 Storage specific method to run the code ref with FK checks deferred or
853 in MySQL's case disabled entirely.
857 # Storage subclasses should override this
858 sub with_deferred_fk_checks {
859 my ($self, $sub) = @_;
867 =item Arguments: none
869 =item Return Value: 1|0
873 Verifies that the current database handle is active and ready to execute
874 an SQL statement (e.g. the connection did not get stale, server is still
875 answering, etc.) This method is used internally by L</dbh>.
881 return 0 unless $self->_seems_connected;
884 local $self->_dbh->{RaiseError} = 1;
889 sub _seems_connected {
892 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
894 my $dbh = $self->_dbh
897 return $dbh->FETCH('Active');
903 my $dbh = $self->_dbh or return 0;
908 sub ensure_connected {
911 unless ($self->connected) {
912 $self->_populate_dbh;
918 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
919 is guaranteed to be healthy by implicitly calling L</connected>, and if
920 necessary performing a reconnection before returning. Keep in mind that this
921 is very B<expensive> on some database engines. Consider using L</dbh_do>
929 if (not $self->_dbh) {
930 $self->_populate_dbh;
932 $self->ensure_connected;
937 # this is the internal "get dbh or connect (don't check)" method
940 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
941 $self->_populate_dbh unless $self->_dbh;
947 unless ($self->_sql_maker) {
948 my $sql_maker_class = $self->sql_maker_class;
950 my %opts = %{$self->_sql_maker_opts||{}};
954 $self->sql_limit_dialect
957 my $s_class = (ref $self) || $self;
959 "Your storage class ($s_class) does not set sql_limit_dialect and you "
960 . 'have not supplied an explicit limit_dialect in your connection_info. '
961 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
962 . 'databases but can be (and often is) painfully slow. '
963 . "Please file an RT ticket against '$s_class' ."
970 my ($quote_char, $name_sep);
972 if ($opts{quote_names}) {
973 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
974 my $s_class = (ref $self) || $self;
976 "You requested 'quote_names' but your storage class ($s_class) does "
977 . 'not explicitly define a default sql_quote_char and you have not '
978 . 'supplied a quote_char as part of your connection_info. DBIC will '
979 .q{default to the ANSI SQL standard quote '"', which works most of }
980 . "the time. Please file an RT ticket against '$s_class'."
986 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
989 $self->_sql_maker($sql_maker_class->new(
991 array_datatypes => 1,
992 limit_dialect => $dialect,
993 ($quote_char ? (quote_char => $quote_char) : ()),
994 name_sep => ($name_sep || '.'),
998 return $self->_sql_maker;
1001 # nothing to do by default
1008 my @info = @{$self->_dbi_connect_info || []};
1009 $self->_dbh(undef); # in case ->connected failed we might get sent here
1010 $self->_dbh_details({}); # reset everything we know
1012 $self->_dbh($self->_connect(@info));
1014 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1016 $self->_determine_driver;
1018 # Always set the transaction depth on connect, since
1019 # there is no transaction in progress by definition
1020 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1022 $self->_run_connection_actions unless $self->{_in_determine_driver};
1025 sub _run_connection_actions {
1029 push @actions, ( $self->on_connect_call || () );
1030 push @actions, $self->_parse_connect_do ('on_connect_do');
1032 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1037 sub set_use_dbms_capability {
1038 $_[0]->set_inherited ($_[1], $_[2]);
1041 sub get_use_dbms_capability {
1042 my ($self, $capname) = @_;
1044 my $use = $self->get_inherited ($capname);
1047 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1051 sub set_dbms_capability {
1052 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1055 sub get_dbms_capability {
1056 my ($self, $capname) = @_;
1058 my $cap = $self->_dbh_details->{capability}{$capname};
1060 unless (defined $cap) {
1061 if (my $meth = $self->can ("_determine$capname")) {
1062 $cap = $self->$meth ? 1 : 0;
1068 $self->set_dbms_capability ($capname, $cap);
1078 unless ($info = $self->_dbh_details->{info}) {
1082 my $server_version = try {
1083 $self->_get_server_version
1085 # driver determination *may* use this codepath
1086 # in which case we must rethrow
1087 $self->throw_exception($_) if $self->{_in_determine_driver};
1089 # $server_version on failure
1093 if (defined $server_version) {
1094 $info->{dbms_version} = $server_version;
1096 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1097 my @verparts = split (/\./, $numeric_version);
1103 # consider only up to 3 version parts, iff not more than 3 digits
1105 while (@verparts && @use_parts < 3) {
1106 my $p = shift @verparts;
1108 push @use_parts, $p;
1110 push @use_parts, 0 while @use_parts < 3;
1112 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1116 $self->_dbh_details->{info} = $info;
1122 sub _get_server_version {
1123 shift->_dbh_get_info('SQL_DBMS_VER');
1127 my ($self, $info) = @_;
1129 if ($info =~ /[^0-9]/) {
1130 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1131 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1132 unless defined $info;
1135 return $self->_get_dbh->get_info($info);
1138 sub _describe_connection {
1139 require DBI::Const::GetInfoReturn;
1142 $self->ensure_connected;
1145 DBIC_DSN => $self->_dbi_connect_info->[0],
1146 DBI_VER => DBI->VERSION,
1147 DBIC_VER => DBIx::Class->VERSION,
1148 DBIC_DRIVER => ref $self,
1152 #keys %DBI::Const::GetInfoType::GetInfoType,
1154 SQL_CURSOR_COMMIT_BEHAVIOR
1155 SQL_CURSOR_ROLLBACK_BEHAVIOR
1156 SQL_CURSOR_SENSITIVITY
1157 SQL_DATA_SOURCE_NAME
1160 SQL_DEFAULT_TXN_ISOLATION
1165 SQL_EXPRESSIONS_IN_ORDERBY
1168 SQL_IDENTIFIER_QUOTE_CHAR
1169 SQL_MAX_CATALOG_NAME_LEN
1170 SQL_MAX_COLUMN_NAME_LEN
1171 SQL_MAX_IDENTIFIER_LEN
1172 SQL_MAX_TABLE_NAME_LEN
1173 SQL_MULTIPLE_ACTIVE_TXN
1174 SQL_MULT_RESULT_SETS
1175 SQL_NEED_LONG_DATA_LEN
1176 SQL_NON_NULLABLE_COLUMNS
1178 SQL_QUALIFIER_NAME_SEPARATOR
1179 SQL_QUOTED_IDENTIFIER_CASE
1181 SQL_TXN_ISOLATION_OPTION
1184 # some drivers barf on things they do not know about instead
1185 # of returning undef
1186 my $v = try { $self->_dbh_get_info($inf) };
1187 next unless defined $v;
1189 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1190 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1191 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1197 sub _determine_driver {
1200 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1201 my $started_connected = 0;
1202 local $self->{_in_determine_driver} = 1;
1204 if (ref($self) eq __PACKAGE__) {
1206 if ($self->_dbh) { # we are connected
1207 $driver = $self->_dbh->{Driver}{Name};
1208 $started_connected = 1;
1211 # if connect_info is a CODEREF, we have no choice but to connect
1212 if (ref $self->_dbi_connect_info->[0] &&
1213 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1214 $self->_populate_dbh;
1215 $driver = $self->_dbh->{Driver}{Name};
1218 # try to use dsn to not require being connected, the driver may still
1219 # force a connection in _rebless to determine version
1220 # (dsn may not be supplied at all if all we do is make a mock-schema)
1221 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1222 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1223 $driver ||= $ENV{DBI_DRIVER};
1228 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1229 if ($self->load_optional_class($storage_class)) {
1230 mro::set_mro($storage_class, 'c3');
1231 bless $self, $storage_class;
1235 $self->_warn_undetermined_driver(
1236 'This version of DBIC does not yet seem to supply a driver for '
1237 . "your particular RDBMS and/or connection method ('$driver')."
1242 $self->_warn_undetermined_driver(
1243 'Unable to extract a driver name from connect info - this '
1244 . 'should not have happened.'
1249 $self->_driver_determined(1);
1251 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1253 if ($self->can('source_bind_attributes')) {
1254 $self->throw_exception(
1255 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1256 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1257 . 'If you are not sure how to proceed please contact the development team via '
1258 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1262 $self->_init; # run driver-specific initializations
1264 $self->_run_connection_actions
1265 if !$started_connected && defined $self->_dbh;
1269 sub _determine_connector_driver {
1270 my ($self, $conn) = @_;
1272 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1275 $self->_warn_undetermined_driver(
1276 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1277 . "$conn connector - this should not have happened."
1282 $dbtype =~ s/\W/_/gi;
1284 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1285 return if $self->isa($subclass);
1287 if ($self->load_optional_class($subclass)) {
1288 bless $self, $subclass;
1292 $self->_warn_undetermined_driver(
1293 'This version of DBIC does not yet seem to supply a driver for '
1294 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1299 sub _warn_undetermined_driver {
1300 my ($self, $msg) = @_;
1302 require Data::Dumper::Concise;
1304 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1305 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1306 . "does not go away, file a bugreport including the following info:\n"
1307 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1311 sub _do_connection_actions {
1313 my $method_prefix = shift;
1316 if (not ref($call)) {
1317 my $method = $method_prefix . $call;
1319 } elsif (ref($call) eq 'CODE') {
1321 } elsif (ref($call) eq 'ARRAY') {
1322 if (ref($call->[0]) ne 'ARRAY') {
1323 $self->_do_connection_actions($method_prefix, $_) for @$call;
1325 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1328 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1334 sub connect_call_do_sql {
1336 $self->_do_query(@_);
1339 sub disconnect_call_do_sql {
1341 $self->_do_query(@_);
1344 # override in db-specific backend when necessary
1345 sub connect_call_datetime_setup { 1 }
1348 my ($self, $action) = @_;
1350 if (ref $action eq 'CODE') {
1351 $action = $action->($self);
1352 $self->_do_query($_) foreach @$action;
1355 # Most debuggers expect ($sql, @bind), so we need to exclude
1356 # the attribute hash which is the second argument to $dbh->do
1357 # furthermore the bind values are usually to be presented
1358 # as named arrayref pairs, so wrap those here too
1359 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1360 my $sql = shift @do_args;
1361 my $attrs = shift @do_args;
1362 my @bind = map { [ undef, $_ ] } @do_args;
1365 $_[0]->_query_start($sql, \@bind);
1366 $_[1]->do($sql, $attrs, @do_args);
1367 $_[0]->_query_end($sql, \@bind);
1375 my ($self, @info) = @_;
1377 $self->throw_exception("You failed to provide any connection info")
1380 my ($old_connect_via, $dbh);
1382 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1385 if(ref $info[0] eq 'CODE') {
1386 $dbh = $info[0]->();
1390 $dbh = DBI->connect(@info);
1393 die $DBI::errstr unless $dbh;
1395 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1396 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1398 ref $info[0] eq 'CODE'
1399 ? "Connection coderef $info[0] returned a"
1400 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1401 ) unless $dbh->FETCH('Active');
1403 # sanity checks unless asked otherwise
1404 unless ($self->unsafe) {
1406 $self->throw_exception(
1407 'Refusing clobbering of {HandleError} installed on externally supplied '
1408 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1409 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1411 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1412 # request, or an external handle. Complain and set anyway
1413 unless ($dbh->{RaiseError}) {
1414 carp( ref $info[0] eq 'CODE'
1416 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1417 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1418 .'attribute has been supplied'
1420 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1421 .'unsafe => 1. Toggling RaiseError back to true'
1424 $dbh->{RaiseError} = 1;
1427 # this odd anonymous coderef dereference is in fact really
1428 # necessary to avoid the unwanted effect described in perl5
1431 my $weak_self = $_[0];
1434 # the coderef is blessed so we can distinguish it from externally
1435 # supplied handles (which must be preserved)
1436 $_[1]->{HandleError} = bless sub {
1438 $weak_self->throw_exception("DBI Exception: $_[0]");
1441 # the handler may be invoked by something totally out of
1443 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1445 }, '__DBIC__DBH__ERROR__HANDLER__';
1450 $self->throw_exception("DBI Connection failed: $_")
1453 $self->_dbh_autocommit($dbh->{AutoCommit});
1460 # this means we have not yet connected and do not know the AC status
1461 # (e.g. coderef $dbh), need a full-fledged connection check
1462 if (! defined $self->_dbh_autocommit) {
1463 $self->ensure_connected;
1465 # Otherwise simply connect or re-connect on pid changes
1470 $self->next::method(@_);
1473 sub _exec_txn_begin {
1476 # if the user is utilizing txn_do - good for him, otherwise we need to
1477 # ensure that the $dbh is healthy on BEGIN.
1478 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1479 # will be replaced by a failure of begin_work itself (which will be
1480 # then retried on reconnect)
1481 if ($self->{_in_do_block}) {
1482 $self->_dbh->begin_work;
1484 $self->dbh_do(sub { $_[1]->begin_work });
1491 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1492 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1495 # esoteric case for folks using external $dbh handles
1496 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1497 carp "Storage transaction_depth 0 does not match "
1498 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1499 $self->transaction_depth(1);
1502 $self->next::method(@_);
1504 # if AutoCommit is disabled txn_depth never goes to 0
1505 # as a new txn is started immediately on commit
1506 $self->transaction_depth(1) if (
1507 !$self->transaction_depth
1509 defined $self->_dbh_autocommit
1511 ! $self->_dbh_autocommit
1515 sub _exec_txn_commit {
1516 shift->_dbh->commit;
1522 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1523 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1526 # esoteric case for folks using external $dbh handles
1527 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1528 carp "Storage transaction_depth 0 does not match "
1529 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1530 $self->transaction_depth(1);
1533 $self->next::method(@_);
1535 # if AutoCommit is disabled txn_depth never goes to 0
1536 # as a new txn is started immediately on commit
1537 $self->transaction_depth(1) if (
1538 !$self->transaction_depth
1540 defined $self->_dbh_autocommit
1542 ! $self->_dbh_autocommit
1546 sub _exec_txn_rollback {
1547 shift->_dbh->rollback;
1550 # generate some identical methods
1551 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1553 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1555 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1556 $self->throw_exception("Unable to $meth() on a disconnected storage")
1558 $self->next::method(@_);
1562 # This used to be the top-half of _execute. It was split out to make it
1563 # easier to override in NoBindVars without duping the rest. It takes up
1564 # all of _execute's args, and emits $sql, @bind.
1565 sub _prep_for_execute {
1566 #my ($self, $op, $ident, $args) = @_;
1567 return shift->_gen_sql_bind(@_)
1571 my ($self, $op, $ident, $args) = @_;
1573 my ($colinfos, $from);
1574 if ( blessed($ident) ) {
1575 $from = $ident->from;
1576 $colinfos = $ident->columns_info;
1579 my ($sql, @bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1582 ! $ENV{DBIC_DT_SEARCH_OK}
1586 first { blessed($_->[1]) && $_->[1]->isa('DateTime') } @bind
1588 carp_unique 'DateTime objects passed to search() are not supported '
1589 . 'properly (InflateColumn::DateTime formats and settings are not '
1590 . 'respected.) See "Formatting DateTime objects in queries" in '
1591 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1592 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1595 return( $sql, $self->_resolve_bindattrs(
1596 $ident, [ @{$args->[2]{bind}||[]}, @bind ], $colinfos
1600 sub _resolve_bindattrs {
1601 my ($self, $ident, $bind, $colinfos) = @_;
1605 my $resolve_bindinfo = sub {
1606 #my $infohash = shift;
1608 %$colinfos = %{ $self->_resolve_column_info($ident) }
1609 unless keys %$colinfos;
1612 if (my $col = $_[0]->{dbic_colname}) {
1613 $ret = { %{$_[0]} };
1615 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1616 if $colinfos->{$col}{data_type};
1618 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1619 if $colinfos->{$col}{size};
1626 if (ref $_ ne 'ARRAY') {
1629 elsif (! defined $_->[0]) {
1632 elsif (ref $_->[0] eq 'HASH') {
1634 ($_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype}) ? $_->[0] : $resolve_bindinfo->($_->[0]),
1638 elsif (ref $_->[0] eq 'SCALAR') {
1639 [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1642 [ $resolve_bindinfo->({ dbic_colname => $_->[0] }), $_->[1] ]
1647 sub _format_for_trace {
1648 #my ($self, $bind) = @_;
1650 ### Turn @bind from something like this:
1651 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1653 ### ( "'1'", "'3'" )
1656 defined( $_ && $_->[1] )
1663 my ( $self, $sql, $bind ) = @_;
1665 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1670 my ( $self, $sql, $bind ) = @_;
1672 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1676 sub _dbi_attrs_for_bind {
1677 my ($self, $ident, $bind) = @_;
1681 for (map { $_->[0] } @$bind) {
1683 if (exists $_->{dbd_attrs}) {
1686 elsif($_->{sqlt_datatype}) {
1687 # cache the result in the dbh_details hash, as it can not change unless
1688 # we connect to something else
1689 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1690 if (not exists $cache->{$_->{sqlt_datatype}}) {
1691 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1693 $cache->{$_->{sqlt_datatype}};
1696 undef; # always push something at this position
1705 my ($self, $op, $ident, @args) = @_;
1707 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1709 shift->dbh_do( _dbh_execute => # retry over disconnects
1712 $self->_dbi_attrs_for_bind($ident, $bind),
1717 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1719 $self->_query_start( $sql, $bind );
1721 my $sth = $self->_bind_sth_params(
1722 $self->_prepare_sth($dbh, $sql),
1727 # Can this fail without throwing an exception anyways???
1728 my $rv = $sth->execute();
1729 $self->throw_exception(
1730 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1733 $self->_query_end( $sql, $bind );
1735 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1739 my ($self, $dbh, $sql) = @_;
1741 # 3 is the if_active parameter which avoids active sth re-use
1742 my $sth = $self->disable_sth_caching
1743 ? $dbh->prepare($sql)
1744 : $dbh->prepare_cached($sql, {}, 3);
1746 # XXX You would think RaiseError would make this impossible,
1747 # but apparently that's not true :(
1748 $self->throw_exception(
1751 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1752 .'an exception and/or setting $dbh->errstr',
1754 ? substr($sql, 0, 20) . '...'
1757 'DBD::' . $dbh->{Driver}{Name},
1764 sub _bind_sth_params {
1765 my ($self, $sth, $bind, $bind_attrs) = @_;
1767 for my $i (0 .. $#$bind) {
1768 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1769 $sth->bind_param_inout(
1770 $i + 1, # bind params counts are 1-based
1772 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1777 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1778 # confirm with dbi-dev whether explicit stringification is needed
1779 my $v = ( length ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""') )
1794 sub _prefetch_autovalues {
1795 my ($self, $source, $colinfo, $to_insert) = @_;
1798 for my $col (keys %$colinfo) {
1800 $colinfo->{$col}{auto_nextval}
1803 ! exists $to_insert->{$col}
1805 ref $to_insert->{$col} eq 'SCALAR'
1807 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1810 $values{$col} = $self->_sequence_fetch(
1812 ( $colinfo->{$col}{sequence} ||=
1813 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1823 my ($self, $source, $to_insert) = @_;
1825 my $col_infos = $source->columns_info;
1827 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1829 # fuse the values, but keep a separate list of prefetched_values so that
1830 # they can be fused once again with the final return
1831 $to_insert = { %$to_insert, %$prefetched_values };
1833 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1834 # Investigate what does it take to s/defined/exists/
1835 my %pcols = map { $_ => 1 } $source->primary_columns;
1836 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1837 for my $col ($source->columns) {
1838 if ($col_infos->{$col}{is_auto_increment}) {
1839 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1840 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1843 # nothing to retrieve when explicit values are supplied
1844 next if (defined $to_insert->{$col} and ! (
1845 ref $to_insert->{$col} eq 'SCALAR'
1847 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1850 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1851 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1854 $col_infos->{$col}{retrieve_on_insert}
1858 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1859 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1861 my ($sqla_opts, @ir_container);
1862 if (%retrieve_cols and $self->_use_insert_returning) {
1863 $sqla_opts->{returning_container} = \@ir_container
1864 if $self->_use_insert_returning_bound;
1866 $sqla_opts->{returning} = [
1867 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1871 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1873 my %returned_cols = %$to_insert;
1874 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1875 @ir_container = try {
1876 local $SIG{__WARN__} = sub {};
1877 my @r = $sth->fetchrow_array;
1880 } unless @ir_container;
1882 @returned_cols{@$retlist} = @ir_container if @ir_container;
1885 # pull in PK if needed and then everything else
1886 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1888 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1889 unless $self->can('last_insert_id');
1891 my @pri_values = $self->last_insert_id($source, @missing_pri);
1893 $self->throw_exception( "Can't get last insert id" )
1894 unless (@pri_values == @missing_pri);
1896 @returned_cols{@missing_pri} = @pri_values;
1897 delete $retrieve_cols{$_} for @missing_pri;
1900 # if there is more left to pull
1901 if (%retrieve_cols) {
1902 $self->throw_exception(
1903 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1906 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1908 my $cur = DBIx::Class::ResultSet->new($source, {
1909 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1910 select => \@left_to_fetch,
1913 @returned_cols{@left_to_fetch} = $cur->next;
1915 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1916 if scalar $cur->next;
1920 return { %$prefetched_values, %returned_cols };
1924 my ($self, $source, $cols, $data) = @_;
1926 my @col_range = (0..$#$cols);
1928 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1929 # confirm with dbi-dev whether explicit stringification is needed
1931 # forcibly stringify whatever is stringifiable
1932 # ResultSet::populate() hands us a copy - safe to mangle
1933 for my $r (0 .. $#$data) {
1934 for my $c (0 .. $#{$data->[$r]}) {
1935 $data->[$r][$c] = "$data->[$r][$c]"
1936 if ( length ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1940 my $colinfos = $source->columns_info($cols);
1942 local $self->{_autoinc_supplied_for_op} =
1943 (first { $_->{is_auto_increment} } values %$colinfos)
1948 # get a slice type index based on first row of data
1949 # a "column" in this context may refer to more than one bind value
1950 # e.g. \[ '?, ?', [...], [...] ]
1952 # construct the value type index - a description of values types for every
1953 # per-column slice of $data:
1955 # nonexistent - nonbind literal
1957 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1959 # also construct the column hash to pass to the SQL generator. For plain
1960 # (non literal) values - convert the members of the first row into a
1961 # literal+bind combo, with extra positional info in the bind attr hashref.
1962 # This will allow us to match the order properly, and is so contrived
1963 # because a user-supplied literal/bind (or something else specific to a
1964 # resultsource and/or storage driver) can inject extra binds along the
1965 # way, so one can't rely on "shift positions" ordering at all. Also we
1966 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1967 # can be later matched up by address), because we want to supply a real
1968 # value on which perhaps e.g. datatype checks will be performed
1969 my ($proto_data, $value_type_by_col_idx);
1970 for my $i (@col_range) {
1971 my $colname = $cols->[$i];
1972 if (ref $data->[0][$i] eq 'SCALAR') {
1973 # no bind value at all - no type
1975 $proto_data->{$colname} = $data->[0][$i];
1977 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
1978 # repack, so we don't end up mangling the original \[]
1979 my ($sql, @bind) = @${$data->[0][$i]};
1981 # normalization of user supplied stuff
1982 my $resolved_bind = $self->_resolve_bindattrs(
1983 $source, \@bind, $colinfos,
1986 # store value-less (attrs only) bind info - we will be comparing all
1987 # supplied binds against this for sanity
1988 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
1990 $proto_data->{$colname} = \[ $sql, map { [
1991 # inject slice order to use for $proto_bind construction
1992 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
1994 $resolved_bind->[$_][1]
1999 $value_type_by_col_idx->{$i} = undef;
2001 $proto_data->{$colname} = \[ '?', [
2002 { dbic_colname => $colname, _bind_data_slice_idx => $i }
2009 my ($sql, $proto_bind) = $self->_prep_for_execute (
2015 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2016 # if the bindlist is empty and we had some dynamic binds, this means the
2017 # storage ate them away (e.g. the NoBindVars component) and interpolated
2018 # them directly into the SQL. This obviously can't be good for multi-inserts
2019 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2023 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2025 # use an error reporting closure for convenience (less to pass)
2026 my $bad_slice_report_cref = sub {
2027 my ($msg, $r_idx, $c_idx) = @_;
2028 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2032 require Data::Dumper::Concise;
2033 local $Data::Dumper::Maxdepth = 5;
2034 Data::Dumper::Concise::Dumper ({
2035 map { $cols->[$_] =>
2043 for my $col_idx (@col_range) {
2044 my $reference_val = $data->[0][$col_idx];
2046 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2047 my $val = $data->[$row_idx][$col_idx];
2049 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2050 if (ref $val ne 'SCALAR') {
2051 $bad_slice_report_cref->(
2052 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2057 elsif ($$val ne $$reference_val) {
2058 $bad_slice_report_cref->(
2059 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2065 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2066 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2067 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2070 else { # binds from a \[], compare type and attrs
2071 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2072 $bad_slice_report_cref->(
2073 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2078 # start drilling down and bail out early on identical refs
2080 $reference_val != $val
2082 $$reference_val != $$val
2084 if (${$val}->[0] ne ${$reference_val}->[0]) {
2085 $bad_slice_report_cref->(
2086 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2091 # need to check the bind attrs - a bind will happen only once for
2092 # the entire dataset, so any changes further down will be ignored.
2093 elsif (! Data::Compare::Compare(
2094 $value_type_by_col_idx->{$col_idx},
2098 @{$self->_resolve_bindattrs(
2099 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2103 $bad_slice_report_cref->(
2104 'Differing bind attributes on literal/bind values not supported',
2114 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2115 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2117 my $guard = $self->txn_scope_guard;
2119 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2120 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2123 # proto bind contains the information on which pieces of $data to pull
2124 # $cols is passed in only for prettier error-reporting
2125 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2128 # bind_param_array doesn't work if there are no binds
2129 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2133 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2137 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2140 # execute_for_fetch is capable of returning data just fine (it means it
2141 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2142 # is the void-populate fast-path we will just ignore this altogether
2143 # for the time being.
2144 sub _dbh_execute_for_fetch {
2145 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2147 my @idx_range = ( 0 .. $#$proto_bind );
2149 # If we have any bind attributes to take care of, we will bind the
2150 # proto-bind data (which will never be used by execute_for_fetch)
2151 # However since column bindtypes are "sticky", this is sufficient
2152 # to get the DBD to apply the bindtype to all values later on
2154 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2156 for my $i (@idx_range) {
2158 $i+1, # DBI bind indexes are 1-based
2159 $proto_bind->[$i][1],
2161 ) if defined $bind_attrs->[$i];
2164 # At this point $data slots named in the _bind_data_slice_idx of
2165 # each piece of $proto_bind are either \[]s or plain values to be
2166 # passed in. Construct the dispensing coderef. *NOTE* the order
2167 # of $data will differ from this of the ?s in the SQL (due to
2168 # alphabetical ordering by colname). We actually do want to
2169 # preserve this behavior so that prepare_cached has a better
2170 # chance of matching on unrelated calls
2172 my $fetch_row_idx = -1; # saner loop this way
2173 my $fetch_tuple = sub {
2174 return undef if ++$fetch_row_idx > $#$data;
2176 return [ map { defined $_->{_literal_bind_subindex}
2177 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2178 ->[ $_->{_literal_bind_subindex} ]
2180 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2181 } map { $_->[0] } @$proto_bind];
2184 my $tuple_status = [];
2187 $rv = $sth->execute_for_fetch(
2196 # Not all DBDs are create equal. Some throw on error, some return
2197 # an undef $rv, and some set $sth->err - try whatever we can
2198 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2201 ( !defined $rv or $sth->err )
2204 # Statement must finish even if there was an exception.
2209 $err = shift unless defined $err
2214 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2216 $self->throw_exception("Unexpected populate error: $err")
2217 if ($i > $#$tuple_status);
2219 require Data::Dumper::Concise;
2220 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2221 ($tuple_status->[$i][1] || $err),
2222 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2229 sub _dbh_execute_inserts_with_no_binds {
2230 my ($self, $sth, $count) = @_;
2234 my $dbh = $self->_get_dbh;
2235 local $dbh->{RaiseError} = 1;
2236 local $dbh->{PrintError} = 0;
2238 $sth->execute foreach 1..$count;
2244 # Make sure statement is finished even if there was an exception.
2249 $err = shift unless defined $err;
2252 $self->throw_exception($err) if defined $err;
2258 #my ($self, $source, @args) = @_;
2259 shift->_execute('update', @_);
2264 #my ($self, $source, @args) = @_;
2265 shift->_execute('delete', @_);
2270 $self->_execute($self->_select_args(@_));
2273 sub _select_args_to_query {
2276 $self->throw_exception(
2277 "Unable to generate limited query representation with 'software_limit' enabled"
2278 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2280 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2281 # = $self->_select_args($ident, $select, $cond, $attrs);
2282 my ($op, $ident, @args) =
2283 $self->_select_args(@_);
2285 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2286 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2288 # reuse the bind arrayref
2289 unshift @{$bind}, "($sql)";
2294 my ($self, $ident, $select, $where, $attrs) = @_;
2296 my $sql_maker = $self->sql_maker;
2297 my ($alias2source, $rs_alias) = $self->_resolve_ident_sources ($ident);
2304 $rs_alias && $alias2source->{$rs_alias}
2305 ? ( _rsroot_rsrc => $alias2source->{$rs_alias} )
2310 # Sanity check the attributes (SQLMaker does it too, but
2311 # in case of a software_limit we'll never reach there)
2312 if (defined $attrs->{offset}) {
2313 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2314 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2317 if (defined $attrs->{rows}) {
2318 $self->throw_exception("The rows attribute must be a positive integer if present")
2319 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2321 elsif ($attrs->{offset}) {
2322 # MySQL actually recommends this approach. I cringe.
2323 $attrs->{rows} = $sql_maker->__max_int;
2328 # see if we need to tear the prefetch apart otherwise delegate the limiting to the
2329 # storage, unless software limit was requested
2332 ( $attrs->{rows} && keys %{$attrs->{collapse}} )
2334 # grouped prefetch (to satisfy group_by == select)
2335 ( $attrs->{group_by}
2337 @{$attrs->{group_by}}
2339 $attrs->{_prefetch_selector_range}
2342 ($ident, $select, $where, $attrs)
2343 = $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2345 elsif (! $attrs->{software_limit} ) {
2347 $attrs->{rows} || (),
2348 $attrs->{offset} || (),
2352 # try to simplify the joinmap further (prune unreferenced type-single joins)
2356 reftype $ident eq 'ARRAY'
2360 $ident = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2364 # This would be the point to deflate anything found in $where
2365 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2366 # expect a result object. And all we have is a resultsource (it is trivial
2367 # to extract deflator coderefs via $alias2source above).
2369 # I don't see a way forward other than changing the way deflators are
2370 # invoked, and that's just bad...
2373 return ('select', $ident, $select, $where, $attrs, @limit);
2376 # Returns a counting SELECT for a simple count
2377 # query. Abstracted so that a storage could override
2378 # this to { count => 'firstcol' } or whatever makes
2379 # sense as a performance optimization
2381 #my ($self, $source, $rs_attrs) = @_;
2382 return { count => '*' };
2389 =item Arguments: $ident, $select, $condition, $attrs
2393 Handle a SQL select statement.
2399 my ($ident, $select, $condition, $attrs) = @_;
2400 return $self->cursor_class->new($self, \@_, $attrs);
2405 my ($rv, $sth, @bind) = $self->_select(@_);
2406 my @row = $sth->fetchrow_array;
2407 my @nextrow = $sth->fetchrow_array if @row;
2408 if(@row && @nextrow) {
2409 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2411 # Need to call finish() to work round broken DBDs
2416 =head2 sql_limit_dialect
2418 This is an accessor for the default SQL limit dialect used by a particular
2419 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2420 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2421 see L<DBIx::Class::SQLMaker::LimitDialects>.
2425 sub _dbh_columns_info_for {
2426 my ($self, $dbh, $table) = @_;
2428 if ($dbh->can('column_info')) {
2432 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2433 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2435 while ( my $info = $sth->fetchrow_hashref() ){
2437 $column_info{data_type} = $info->{TYPE_NAME};
2438 $column_info{size} = $info->{COLUMN_SIZE};
2439 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2440 $column_info{default_value} = $info->{COLUMN_DEF};
2441 my $col_name = $info->{COLUMN_NAME};
2442 $col_name =~ s/^\"(.*)\"$/$1/;
2444 $result{$col_name} = \%column_info;
2449 return \%result if !$caught && scalar keys %result;
2453 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2455 my @columns = @{$sth->{NAME_lc}};
2456 for my $i ( 0 .. $#columns ){
2458 $column_info{data_type} = $sth->{TYPE}->[$i];
2459 $column_info{size} = $sth->{PRECISION}->[$i];
2460 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2462 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2463 $column_info{data_type} = $1;
2464 $column_info{size} = $2;
2467 $result{$columns[$i]} = \%column_info;
2471 foreach my $col (keys %result) {
2472 my $colinfo = $result{$col};
2473 my $type_num = $colinfo->{data_type};
2475 if(defined $type_num && $dbh->can('type_info')) {
2476 my $type_info = $dbh->type_info($type_num);
2477 $type_name = $type_info->{TYPE_NAME} if $type_info;
2478 $colinfo->{data_type} = $type_name if $type_name;
2485 sub columns_info_for {
2486 my ($self, $table) = @_;
2487 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2490 =head2 last_insert_id
2492 Return the row id of the last insert.
2496 sub _dbh_last_insert_id {
2497 my ($self, $dbh, $source, $col) = @_;
2499 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2501 return $id if defined $id;
2503 my $class = ref $self;
2504 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2507 sub last_insert_id {
2509 $self->_dbh_last_insert_id ($self->_dbh, @_);
2512 =head2 _native_data_type
2516 =item Arguments: $type_name
2520 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2521 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2522 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2524 The default implementation returns C<undef>, implement in your Storage driver if
2525 you need this functionality.
2527 Should map types from other databases to the native RDBMS type, for example
2528 C<VARCHAR2> to C<VARCHAR>.
2530 Types with modifiers should map to the underlying data type. For example,
2531 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2533 Composite types should map to the container type, for example
2534 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2538 sub _native_data_type {
2539 #my ($self, $data_type) = @_;
2543 # Check if placeholders are supported at all
2544 sub _determine_supports_placeholders {
2546 my $dbh = $self->_get_dbh;
2548 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2549 # but it is inaccurate more often than not
2551 local $dbh->{PrintError} = 0;
2552 local $dbh->{RaiseError} = 1;
2553 $dbh->do('select ?', {}, 1);
2561 # Check if placeholders bound to non-string types throw exceptions
2563 sub _determine_supports_typeless_placeholders {
2565 my $dbh = $self->_get_dbh;
2568 local $dbh->{PrintError} = 0;
2569 local $dbh->{RaiseError} = 1;
2570 # this specifically tests a bind that is NOT a string
2571 $dbh->do('select 1 where 1 = ?', {}, 1);
2581 Returns the database driver name.
2586 shift->_get_dbh->{Driver}->{Name};
2589 =head2 bind_attribute_by_data_type
2591 Given a datatype from column info, returns a database specific bind
2592 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2593 let the database planner just handle it.
2595 This method is always called after the driver has been determined and a DBI
2596 connection has been established. Therefore you can refer to C<DBI::$constant>
2597 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2598 the correct modules.
2602 sub bind_attribute_by_data_type {
2606 =head2 is_datatype_numeric
2608 Given a datatype from column_info, returns a boolean value indicating if
2609 the current RDBMS considers it a numeric value. This controls how
2610 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2611 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2612 be performed instead of the usual C<eq>.
2616 sub is_datatype_numeric {
2617 #my ($self, $dt) = @_;
2619 return 0 unless $_[1];
2622 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2627 =head2 create_ddl_dir
2631 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2635 Creates a SQL file based on the Schema, for each of the specified
2636 database engines in C<\@databases> in the given directory.
2637 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2639 Given a previous version number, this will also create a file containing
2640 the ALTER TABLE statements to transform the previous schema into the
2641 current one. Note that these statements may contain C<DROP TABLE> or
2642 C<DROP COLUMN> statements that can potentially destroy data.
2644 The file names are created using the C<ddl_filename> method below, please
2645 override this method in your schema if you would like a different file
2646 name format. For the ALTER file, the same format is used, replacing
2647 $version in the name with "$preversion-$version".
2649 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2650 The most common value for this would be C<< { add_drop_table => 1 } >>
2651 to have the SQL produced include a C<DROP TABLE> statement for each table
2652 created. For quoting purposes supply C<quote_table_names> and
2653 C<quote_field_names>.
2655 If no arguments are passed, then the following default values are assumed:
2659 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2661 =item version - $schema->schema_version
2663 =item directory - './'
2665 =item preversion - <none>
2669 By default, C<\%sqlt_args> will have
2671 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2673 merged with the hash passed in. To disable any of those features, pass in a
2674 hashref like the following
2676 { ignore_constraint_names => 0, # ... other options }
2679 WARNING: You are strongly advised to check all SQL files created, before applying
2684 sub create_ddl_dir {
2685 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2688 carp "No directory given, using ./\n";
2693 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2695 $self->throw_exception(
2696 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2700 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2702 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2703 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2705 my $schema_version = $schema->schema_version || '1.x';
2706 $version ||= $schema_version;
2709 add_drop_table => 1,
2710 ignore_constraint_names => 1,
2711 ignore_index_names => 1,
2715 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2716 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2719 my $sqlt = SQL::Translator->new( $sqltargs );
2721 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2722 my $sqlt_schema = $sqlt->translate({ data => $schema })
2723 or $self->throw_exception ($sqlt->error);
2725 foreach my $db (@$databases) {
2727 $sqlt->{schema} = $sqlt_schema;
2728 $sqlt->producer($db);
2731 my $filename = $schema->ddl_filename($db, $version, $dir);
2732 if (-e $filename && ($version eq $schema_version )) {
2733 # if we are dumping the current version, overwrite the DDL
2734 carp "Overwriting existing DDL file - $filename";
2738 my $output = $sqlt->translate;
2740 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2743 if(!open($file, ">$filename")) {
2744 $self->throw_exception("Can't open $filename for writing ($!)");
2747 print $file $output;
2750 next unless ($preversion);
2752 require SQL::Translator::Diff;
2754 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2755 if(!-e $prefilename) {
2756 carp("No previous schema file found ($prefilename)");
2760 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2762 carp("Overwriting existing diff file - $difffile");
2768 my $t = SQL::Translator->new($sqltargs);
2773 or $self->throw_exception ($t->error);
2775 my $out = $t->translate( $prefilename )
2776 or $self->throw_exception ($t->error);
2778 $source_schema = $t->schema;
2780 $source_schema->name( $prefilename )
2781 unless ( $source_schema->name );
2784 # The "new" style of producers have sane normalization and can support
2785 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2786 # And we have to diff parsed SQL against parsed SQL.
2787 my $dest_schema = $sqlt_schema;
2789 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2790 my $t = SQL::Translator->new($sqltargs);
2795 or $self->throw_exception ($t->error);
2797 my $out = $t->translate( $filename )
2798 or $self->throw_exception ($t->error);
2800 $dest_schema = $t->schema;
2802 $dest_schema->name( $filename )
2803 unless $dest_schema->name;
2806 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2810 if(!open $file, ">$difffile") {
2811 $self->throw_exception("Can't write to $difffile ($!)");
2819 =head2 deployment_statements
2823 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2827 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2829 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2830 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2832 C<$directory> is used to return statements from files in a previously created
2833 L</create_ddl_dir> directory and is optional. The filenames are constructed
2834 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2836 If no C<$directory> is specified then the statements are constructed on the
2837 fly using L<SQL::Translator> and C<$version> is ignored.
2839 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2843 sub deployment_statements {
2844 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2845 $type ||= $self->sqlt_type;
2846 $version ||= $schema->schema_version || '1.x';
2848 my $filename = $schema->ddl_filename($type, $version, $dir);
2851 # FIXME replace this block when a proper sane sql parser is available
2853 open($file, "<$filename")
2854 or $self->throw_exception("Can't open $filename ($!)");
2857 return join('', @rows);
2860 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2861 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2864 # sources needs to be a parser arg, but for simplicty allow at top level
2866 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2867 if exists $sqltargs->{sources};
2869 my $tr = SQL::Translator->new(
2870 producer => "SQL::Translator::Producer::${type}",
2872 parser => 'SQL::Translator::Parser::DBIx::Class',
2876 return preserve_context {
2879 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2880 unless defined $_[0];
2884 # FIXME deploy() currently does not accurately report sql errors
2885 # Will always return true while errors are warned
2887 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2891 return if($line =~ /^--/);
2892 # next if($line =~ /^DROP/m);
2893 return if($line =~ /^BEGIN TRANSACTION/m);
2894 return if($line =~ /^COMMIT/m);
2895 return if $line =~ /^\s+$/; # skip whitespace only
2896 $self->_query_start($line);
2898 # do a dbh_do cycle here, as we need some error checking in
2899 # place (even though we will ignore errors)
2900 $self->dbh_do (sub { $_[1]->do($line) });
2902 carp qq{$_ (running "${line}")};
2904 $self->_query_end($line);
2906 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2907 if (@statements > 1) {
2908 foreach my $statement (@statements) {
2909 $deploy->( $statement );
2912 elsif (@statements == 1) {
2913 # split on single line comments and end of statements
2914 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2920 =head2 datetime_parser
2922 Returns the datetime parser class
2926 sub datetime_parser {
2928 return $self->{datetime_parser} ||= do {
2929 $self->build_datetime_parser(@_);
2933 =head2 datetime_parser_type
2935 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
2937 =head2 build_datetime_parser
2939 See L</datetime_parser>
2943 sub build_datetime_parser {
2945 my $type = $self->datetime_parser_type(@_);
2950 =head2 is_replicating
2952 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
2953 replicate from a master database. Default is undef, which is the result
2954 returned by databases that don't support replication.
2958 sub is_replicating {
2963 =head2 lag_behind_master
2965 Returns a number that represents a certain amount of lag behind a master db
2966 when a given storage is replicating. The number is database dependent, but
2967 starts at zero and increases with the amount of lag. Default in undef
2971 sub lag_behind_master {
2975 =head2 relname_to_table_alias
2979 =item Arguments: $relname, $join_count
2981 =item Return Value: $alias
2985 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
2988 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
2989 way these aliases are named.
2991 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
2992 otherwise C<"$relname">.
2996 sub relname_to_table_alias {
2997 my ($self, $relname, $join_count) = @_;
2999 my $alias = ($join_count && $join_count > 1 ?
3000 join('_', $relname, $join_count) : $relname);
3005 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3006 # version and it may be necessary to amend or override it for a specific storage
3007 # if such binds are necessary.
3008 sub _max_column_bytesize {
3009 my ($self, $attr) = @_;
3013 if ($attr->{sqlt_datatype}) {
3014 my $data_type = lc($attr->{sqlt_datatype});
3016 if ($attr->{sqlt_size}) {
3018 # String/sized-binary types
3019 if ($data_type =~ /^(?:
3020 l? (?:var)? char(?:acter)? (?:\s*varying)?
3022 (?:var)? binary (?:\s*varying)?
3027 $max_size = $attr->{sqlt_size};
3029 # Other charset/unicode types, assume scale of 4
3030 elsif ($data_type =~ /^(?:
3031 national \s* character (?:\s*varying)?
3040 $max_size = $attr->{sqlt_size} * 4;
3044 if (!$max_size and !$self->_is_lob_type($data_type)) {
3045 $max_size = 100 # for all other (numeric?) datatypes
3049 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3052 # Determine if a data_type is some type of BLOB
3054 my ($self, $data_type) = @_;
3055 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3056 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3057 |varchar|character\s*varying|nvarchar
3058 |national\s*character\s*varying))?\z/xi);
3061 sub _is_binary_lob_type {
3062 my ($self, $data_type) = @_;
3063 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3064 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3067 sub _is_text_lob_type {
3068 my ($self, $data_type) = @_;
3069 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3070 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3071 |national\s*character\s*varying))\z/xi);
3074 # Determine if a data_type is some type of a binary type
3075 sub _is_binary_type {
3076 my ($self, $data_type) = @_;
3077 $data_type && ($self->_is_binary_lob_type($data_type)
3078 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3085 =head2 DBIx::Class and AutoCommit
3087 DBIx::Class can do some wonderful magic with handling exceptions,
3088 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3089 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3090 transaction support.
3092 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3093 in an assumed transaction between commits, and you're telling us you'd
3094 like to manage that manually. A lot of the magic protections offered by
3095 this module will go away. We can't protect you from exceptions due to database
3096 disconnects because we don't know anything about how to restart your
3097 transactions. You're on your own for handling all sorts of exceptional
3098 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3102 =head1 AUTHOR AND CONTRIBUTORS
3104 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3108 You may distribute this code under the same terms as Perl itself.