1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
7 use base qw/DBIx::Class::Storage::DBIHacks DBIx::Class::Storage/;
10 use DBIx::Class::Carp;
11 use Scalar::Util qw/refaddr weaken reftype blessed/;
12 use List::Util qw/first/;
13 use Sub::Name 'subname';
14 use Context::Preserve 'preserve_context';
17 use Data::Compare (); # no imports!!! guard against insane architecture
20 # default cursor class, overridable in connect_info attributes
21 __PACKAGE__->cursor_class('DBIx::Class::Storage::DBI::Cursor');
23 __PACKAGE__->mk_group_accessors('inherited' => qw/
24 sql_limit_dialect sql_quote_char sql_name_sep
27 __PACKAGE__->mk_group_accessors('component_class' => qw/sql_maker_class datetime_parser_type/);
29 __PACKAGE__->sql_maker_class('DBIx::Class::SQLMaker');
30 __PACKAGE__->datetime_parser_type('DateTime::Format::MySQL'); # historic default
32 __PACKAGE__->sql_name_sep('.');
34 __PACKAGE__->mk_group_accessors('simple' => qw/
35 _connect_info _dbi_connect_info _dbic_connect_attributes _driver_determined
36 _dbh _dbh_details _conn_pid _sql_maker _sql_maker_opts _dbh_autocommit
37 _perform_autoinc_retrieval _autoinc_supplied_for_op
40 # the values for these accessors are picked out (and deleted) from
41 # the attribute hashref passed to connect_info
42 my @storage_options = qw/
43 on_connect_call on_disconnect_call on_connect_do on_disconnect_do
44 disable_sth_caching unsafe auto_savepoint
46 __PACKAGE__->mk_group_accessors('simple' => @storage_options);
49 # capability definitions, using a 2-tiered accessor system
52 # A driver/user may define _use_X, which blindly without any checks says:
53 # "(do not) use this capability", (use_dbms_capability is an "inherited"
56 # If _use_X is undef, _supports_X is then queried. This is a "simple" style
57 # accessor, which in turn calls _determine_supports_X, and stores the return
58 # in a special slot on the storage object, which is wiped every time a $dbh
59 # reconnection takes place (it is not guaranteed that upon reconnection we
60 # will get the same rdbms version). _determine_supports_X does not need to
61 # exist on a driver, as we ->can for it before calling.
63 my @capabilities = (qw/
65 insert_returning_bound
74 __PACKAGE__->mk_group_accessors( dbms_capability => map { "_supports_$_" } @capabilities );
75 __PACKAGE__->mk_group_accessors( use_dbms_capability => map { "_use_$_" } (@capabilities ) );
77 # on by default, not strictly a capability (pending rewrite)
78 __PACKAGE__->_use_join_optimizer (1);
79 sub _determine_supports_join_optimizer { 1 };
81 # Each of these methods need _determine_driver called before itself
82 # in order to function reliably. This is a purely DRY optimization
84 # get_(use)_dbms_capability need to be called on the correct Storage
85 # class, as _use_X may be hardcoded class-wide, and _supports_X calls
86 # _determine_supports_X which obv. needs a correct driver as well
87 my @rdbms_specific_methods = qw/
100 with_deferred_fk_checks
102 get_use_dbms_capability
109 for my $meth (@rdbms_specific_methods) {
111 my $orig = __PACKAGE__->can ($meth)
112 or die "$meth is not a ::Storage::DBI method!";
115 no warnings qw/redefine/;
116 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
118 # only fire when invoked on an instance, a valid class-based invocation
119 # would e.g. be setting a default for an inherited accessor
122 ! $_[0]->{_driver_determined}
124 ! $_[0]->{_in_determine_driver}
126 ($_[0]->_dbi_connect_info||[])->[0]
128 $_[0]->_determine_driver;
130 # This for some reason crashes and burns on perl 5.8.1
131 # IFF the method ends up throwing an exception
132 #goto $_[0]->can ($meth);
134 my $cref = $_[0]->can ($meth);
144 DBIx::Class::Storage::DBI - DBI storage handler
148 my $schema = MySchema->connect('dbi:SQLite:my.db');
150 $schema->storage->debug(1);
152 my @stuff = $schema->storage->dbh_do(
154 my ($storage, $dbh, @args) = @_;
155 $dbh->do("DROP TABLE authors");
160 $schema->resultset('Book')->search({
161 written_on => $schema->storage->datetime_parser->format_datetime(DateTime->now)
166 This class represents the connection to an RDBMS via L<DBI>. See
167 L<DBIx::Class::Storage> for general information. This pod only
168 documents DBI-specific methods and behaviors.
175 my $new = shift->next::method(@_);
177 $new->_sql_maker_opts({});
178 $new->_dbh_details({});
179 $new->{_in_do_block} = 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;
219 %seek_and_destroy = ();
224 $_->transaction_depth(0);
227 # properly renumber existing refs
228 $_->_arm_global_destructor
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;
256 $self->transaction_depth(0);
257 $self->savepoints([]);
265 This method is normally called by L<DBIx::Class::Schema/connection>, which
266 encapsulates its argument list in an arrayref before passing them here.
268 The argument list may contain:
274 The same 4-element argument set one would normally pass to
275 L<DBI/connect>, optionally followed by
276 L<extra attributes|/DBIx::Class specific connection attributes>
277 recognized by DBIx::Class:
279 $connect_info_args = [ $dsn, $user, $password, \%dbi_attributes?, \%extra_attributes? ];
283 A single code reference which returns a connected
284 L<DBI database handle|DBI/connect> optionally followed by
285 L<extra attributes|/DBIx::Class specific connection attributes> recognized
288 $connect_info_args = [ sub { DBI->connect (...) }, \%extra_attributes? ];
292 A single hashref with all the attributes and the dsn/user/password
295 $connect_info_args = [{
303 $connect_info_args = [{
304 dbh_maker => sub { DBI->connect (...) },
309 This is particularly useful for L<Catalyst> based applications, allowing the
310 following config (L<Config::General> style):
315 dsn dbi:mysql:database=test
322 The C<dsn>/C<user>/C<password> combination can be substituted by the
323 C<dbh_maker> key whose value is a coderef that returns a connected
324 L<DBI database handle|DBI/connect>
328 Please note that the L<DBI> docs recommend that you always explicitly
329 set C<AutoCommit> to either I<0> or I<1>. L<DBIx::Class> further
330 recommends that it be set to I<1>, and that you perform transactions
331 via our L<DBIx::Class::Schema/txn_do> method. L<DBIx::Class> will set it
332 to I<1> if you do not do explicitly set it to zero. This is the default
333 for most DBDs. See L</DBIx::Class and AutoCommit> for details.
335 =head3 DBIx::Class specific connection attributes
337 In addition to the standard L<DBI|DBI/ATTRIBUTES COMMON TO ALL HANDLES>
338 L<connection|DBI/Database Handle Attributes> attributes, DBIx::Class recognizes
339 the following connection options. These options can be mixed in with your other
340 L<DBI> connection attributes, or placed in a separate hashref
341 (C<\%extra_attributes>) as shown above.
343 Every time C<connect_info> is invoked, any previous settings for
344 these options will be cleared before setting the new ones, regardless of
345 whether any options are specified in the new C<connect_info>.
352 Specifies things to do immediately after connecting or re-connecting to
353 the database. Its value may contain:
359 This contains one SQL statement to execute.
361 =item an array reference
363 This contains SQL statements to execute in order. Each element contains
364 a string or a code reference that returns a string.
366 =item a code reference
368 This contains some code to execute. Unlike code references within an
369 array reference, its return value is ignored.
373 =item on_disconnect_do
375 Takes arguments in the same form as L</on_connect_do> and executes them
376 immediately before disconnecting from the database.
378 Note, this only runs if you explicitly call L</disconnect> on the
381 =item on_connect_call
383 A more generalized form of L</on_connect_do> that calls the specified
384 C<connect_call_METHOD> methods in your storage driver.
386 on_connect_do => 'select 1'
390 on_connect_call => [ [ do_sql => 'select 1' ] ]
392 Its values may contain:
398 Will call the C<connect_call_METHOD> method.
400 =item a code reference
402 Will execute C<< $code->($storage) >>
404 =item an array reference
406 Each value can be a method name or code reference.
408 =item an array of arrays
410 For each array, the first item is taken to be the C<connect_call_> method name
411 or code reference, and the rest are parameters to it.
415 Some predefined storage methods you may use:
421 Executes a SQL string or a code reference that returns a SQL string. This is
422 what L</on_connect_do> and L</on_disconnect_do> use.
430 Will execute the scalar as SQL.
434 Taken to be arguments to L<DBI/do>, the SQL string optionally followed by the
435 attributes hashref and bind values.
437 =item a code reference
439 Will execute C<< $code->($storage) >> and execute the return array refs as
446 Execute any statements necessary to initialize the database session to return
447 and accept datetime/timestamp values used with
448 L<DBIx::Class::InflateColumn::DateTime>.
450 Only necessary for some databases, see your specific storage driver for
451 implementation details.
455 =item on_disconnect_call
457 Takes arguments in the same form as L</on_connect_call> and executes them
458 immediately before disconnecting from the database.
460 Calls the C<disconnect_call_METHOD> methods as opposed to the
461 C<connect_call_METHOD> methods called by L</on_connect_call>.
463 Note, this only runs if you explicitly call L</disconnect> on the
466 =item disable_sth_caching
468 If set to a true value, this option will disable the caching of
469 statement handles via L<DBI/prepare_cached>.
473 Sets a specific SQL::Abstract::Limit-style limit dialect, overriding the
474 default L</sql_limit_dialect> setting of the storage (if any). For a list
475 of available limit dialects see L<DBIx::Class::SQLMaker::LimitDialects>.
479 When true automatically sets L</quote_char> and L</name_sep> to the characters
480 appropriate for your particular RDBMS. This option is preferred over specifying
481 L</quote_char> directly.
485 Specifies what characters to use to quote table and column names.
487 C<quote_char> expects either a single character, in which case is it
488 is placed on either side of the table/column name, or an arrayref of length
489 2 in which case the table/column name is placed between the elements.
491 For example under MySQL you should use C<< quote_char => '`' >>, and for
492 SQL Server you should use C<< quote_char => [qw/[ ]/] >>.
496 This parameter is only useful in conjunction with C<quote_char>, and is used to
497 specify the character that separates elements (schemas, tables, columns) from
498 each other. If unspecified it defaults to the most commonly used C<.>.
502 This Storage driver normally installs its own C<HandleError>, sets
503 C<RaiseError> and C<ShowErrorStatement> on, and sets C<PrintError> off on
504 all database handles, including those supplied by a coderef. It does this
505 so that it can have consistent and useful error behavior.
507 If you set this option to a true value, Storage will not do its usual
508 modifications to the database handle's attributes, and instead relies on
509 the settings in your connect_info DBI options (or the values you set in
510 your connection coderef, in the case that you are connecting via coderef).
512 Note that your custom settings can cause Storage to malfunction,
513 especially if you set a C<HandleError> handler that suppresses exceptions
514 and/or disable C<RaiseError>.
518 If this option is true, L<DBIx::Class> will use savepoints when nesting
519 transactions, making it possible to recover from failure in the inner
520 transaction without having to abort all outer transactions.
524 Use this argument to supply a cursor class other than the default
525 L<DBIx::Class::Storage::DBI::Cursor>.
529 Some real-life examples of arguments to L</connect_info> and
530 L<DBIx::Class::Schema/connect>
532 # Simple SQLite connection
533 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
536 ->connect_info([ sub { DBI->connect(...) } ]);
538 # Connect via subref in hashref
540 dbh_maker => sub { DBI->connect(...) },
541 on_connect_do => 'alter session ...',
544 # A bit more complicated
551 { quote_char => q{"} },
555 # Equivalent to the previous example
561 { AutoCommit => 1, quote_char => q{"}, name_sep => q{.} },
565 # Same, but with hashref as argument
566 # See parse_connect_info for explanation
569 dsn => 'dbi:Pg:dbname=foo',
571 password => 'my_pg_password',
578 # Subref + DBIx::Class-specific connection options
581 sub { DBI->connect(...) },
585 on_connect_do => ['SET search_path TO myschema,otherschema,public'],
586 disable_sth_caching => 1,
596 my ($self, $info) = @_;
598 return $self->_connect_info if !$info;
600 $self->_connect_info($info); # copy for _connect_info
602 $info = $self->_normalize_connect_info($info)
603 if ref $info eq 'ARRAY';
605 for my $storage_opt (keys %{ $info->{storage_options} }) {
606 my $value = $info->{storage_options}{$storage_opt};
608 $self->$storage_opt($value);
611 # Kill sql_maker/_sql_maker_opts, so we get a fresh one with only
612 # the new set of options
613 $self->_sql_maker(undef);
614 $self->_sql_maker_opts({});
616 for my $sql_maker_opt (keys %{ $info->{sql_maker_options} }) {
617 my $value = $info->{sql_maker_options}{$sql_maker_opt};
619 $self->_sql_maker_opts->{$sql_maker_opt} = $value;
623 %{ $self->_default_dbi_connect_attributes || {} },
624 %{ $info->{attributes} || {} },
627 my @args = @{ $info->{arguments} };
629 if (keys %attrs and ref $args[0] ne 'CODE') {
631 'You provided explicit AutoCommit => 0 in your connection_info. '
632 . 'This is almost universally a bad idea (see the footnotes of '
633 . 'DBIx::Class::Storage::DBI for more info). If you still want to '
634 . 'do this you can set $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK} to disable '
636 ) if ! $attrs{AutoCommit} and ! $ENV{DBIC_UNSAFE_AUTOCOMMIT_OK};
638 push @args, \%attrs if keys %attrs;
640 $self->_dbi_connect_info(\@args);
643 # save attributes them in a separate accessor so they are always
644 # introspectable, even in case of a CODE $dbhmaker
645 $self->_dbic_connect_attributes (\%attrs);
647 return $self->_connect_info;
650 sub _normalize_connect_info {
651 my ($self, $info_arg) = @_;
654 my @args = @$info_arg; # take a shallow copy for further mutilation
656 # combine/pre-parse arguments depending on invocation style
659 if (ref $args[0] eq 'CODE') { # coderef with optional \%extra_attributes
660 %attrs = %{ $args[1] || {} };
663 elsif (ref $args[0] eq 'HASH') { # single hashref (i.e. Catalyst config)
664 %attrs = %{$args[0]};
666 if (my $code = delete $attrs{dbh_maker}) {
669 my @ignored = grep { delete $attrs{$_} } (qw/dsn user password/);
672 'Attribute(s) %s in connect_info were ignored, as they can not be applied '
673 . "to the result of 'dbh_maker'",
675 join (', ', map { "'$_'" } (@ignored) ),
680 @args = delete @attrs{qw/dsn user password/};
683 else { # otherwise assume dsn/user/password + \%attrs + \%extra_attrs
685 % { $args[3] || {} },
686 % { $args[4] || {} },
688 @args = @args[0,1,2];
691 $info{arguments} = \@args;
693 my @storage_opts = grep exists $attrs{$_},
694 @storage_options, 'cursor_class';
696 @{ $info{storage_options} }{@storage_opts} =
697 delete @attrs{@storage_opts} if @storage_opts;
699 my @sql_maker_opts = grep exists $attrs{$_},
700 qw/limit_dialect quote_char name_sep quote_names/;
702 @{ $info{sql_maker_options} }{@sql_maker_opts} =
703 delete @attrs{@sql_maker_opts} if @sql_maker_opts;
705 $info{attributes} = \%attrs if %attrs;
710 sub _default_dbi_connect_attributes () {
715 ShowErrorStatement => 1,
721 This method is deprecated in favour of setting via L</connect_info>.
725 =head2 on_disconnect_do
727 This method is deprecated in favour of setting via L</connect_info>.
731 sub _parse_connect_do {
732 my ($self, $type) = @_;
734 my $val = $self->$type;
735 return () if not defined $val;
740 push @res, [ 'do_sql', $val ];
741 } elsif (ref($val) eq 'CODE') {
743 } elsif (ref($val) eq 'ARRAY') {
744 push @res, map { [ 'do_sql', $_ ] } @$val;
746 $self->throw_exception("Invalid type for $type: ".ref($val));
754 Arguments: ($subref | $method_name), @extra_coderef_args?
756 Execute the given $subref or $method_name using the new exception-based
757 connection management.
759 The first two arguments will be the storage object that C<dbh_do> was called
760 on and a database handle to use. Any additional arguments will be passed
761 verbatim to the called subref as arguments 2 and onwards.
763 Using this (instead of $self->_dbh or $self->dbh) ensures correct
764 exception handling and reconnection (or failover in future subclasses).
766 Your subref should have no side-effects outside of the database, as
767 there is the potential for your subref to be partially double-executed
768 if the database connection was stale/dysfunctional.
772 my @stuff = $schema->storage->dbh_do(
774 my ($storage, $dbh, @cols) = @_;
775 my $cols = join(q{, }, @cols);
776 $dbh->selectrow_array("SELECT $cols FROM foo");
785 my $run_target = shift;
787 # short circuit when we know there is no need for a runner
789 # FIXME - asumption may be wrong
790 # the rationale for the txn_depth check is that if this block is a part
791 # of a larger transaction, everything up to that point is screwed anyway
792 return $self->$run_target($self->_get_dbh, @_)
793 if $self->{_in_do_block} or $self->transaction_depth;
795 # take a ref instead of a copy, to preserve @_ aliasing
796 # semantics within the coderef, but only if needed
797 # (pseudoforking doesn't like this trick much)
798 my $args = @_ ? \@_ : [];
800 DBIx::Class::Storage::BlockRunner->new(
802 run_code => sub { $self->$run_target ($self->_get_dbh, @$args ) },
804 retry_handler => sub { ! ( $_[0]->retried_count or $_[0]->storage->connected ) },
809 $_[0]->_get_dbh; # connects or reconnects on pid change, necessary to grab correct txn_depth
810 shift->next::method(@_);
815 Our C<disconnect> method also performs a rollback first if the
816 database is not in C<AutoCommit> mode.
826 push @actions, ( $self->on_disconnect_call || () );
827 push @actions, $self->_parse_connect_do ('on_disconnect_do');
829 $self->_do_connection_actions(disconnect_call_ => $_) for @actions;
831 # stops the "implicit rollback on disconnect" warning
832 $self->_exec_txn_rollback unless $self->_dbh_autocommit;
834 %{ $self->_dbh->{CachedKids} } = ();
835 $self->_dbh->disconnect;
840 =head2 with_deferred_fk_checks
844 =item Arguments: C<$coderef>
846 =item Return Value: The return value of $coderef
850 Storage specific method to run the code ref with FK checks deferred or
851 in MySQL's case disabled entirely.
855 # Storage subclasses should override this
856 sub with_deferred_fk_checks {
857 my ($self, $sub) = @_;
865 =item Arguments: none
867 =item Return Value: 1|0
871 Verifies that the current database handle is active and ready to execute
872 an SQL statement (e.g. the connection did not get stale, server is still
873 answering, etc.) This method is used internally by L</dbh>.
879 return 0 unless $self->_seems_connected;
882 local $self->_dbh->{RaiseError} = 1;
887 sub _seems_connected {
890 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
892 my $dbh = $self->_dbh
895 return $dbh->FETCH('Active');
901 my $dbh = $self->_dbh or return 0;
906 sub ensure_connected {
909 unless ($self->connected) {
910 $self->_populate_dbh;
916 Returns a C<$dbh> - a data base handle of class L<DBI>. The returned handle
917 is guaranteed to be healthy by implicitly calling L</connected>, and if
918 necessary performing a reconnection before returning. Keep in mind that this
919 is very B<expensive> on some database engines. Consider using L</dbh_do>
927 if (not $self->_dbh) {
928 $self->_populate_dbh;
930 $self->ensure_connected;
935 # this is the internal "get dbh or connect (don't check)" method
938 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
939 $self->_populate_dbh unless $self->_dbh;
945 unless ($self->_sql_maker) {
946 my $sql_maker_class = $self->sql_maker_class;
948 my %opts = %{$self->_sql_maker_opts||{}};
952 $self->sql_limit_dialect
955 my $s_class = (ref $self) || $self;
957 "Your storage class ($s_class) does not set sql_limit_dialect and you "
958 . 'have not supplied an explicit limit_dialect in your connection_info. '
959 . 'DBIC will attempt to use the GenericSubQ dialect, which works on most '
960 . 'databases but can be (and often is) painfully slow. '
961 . "Please file an RT ticket against '$s_class'"
962 ) if $self->_dbi_connect_info->[0];
968 my ($quote_char, $name_sep);
970 if ($opts{quote_names}) {
971 $quote_char = (delete $opts{quote_char}) || $self->sql_quote_char || do {
972 my $s_class = (ref $self) || $self;
974 "You requested 'quote_names' but your storage class ($s_class) does "
975 . 'not explicitly define a default sql_quote_char and you have not '
976 . 'supplied a quote_char as part of your connection_info. DBIC will '
977 .q{default to the ANSI SQL standard quote '"', which works most of }
978 . "the time. Please file an RT ticket against '$s_class'."
984 $name_sep = (delete $opts{name_sep}) || $self->sql_name_sep;
987 $self->_sql_maker($sql_maker_class->new(
989 array_datatypes => 1,
990 limit_dialect => $dialect,
991 ($quote_char ? (quote_char => $quote_char) : ()),
992 name_sep => ($name_sep || '.'),
996 return $self->_sql_maker;
999 # nothing to do by default
1006 my @info = @{$self->_dbi_connect_info || []};
1007 $self->_dbh(undef); # in case ->connected failed we might get sent here
1008 $self->_dbh_details({}); # reset everything we know
1010 $self->_dbh($self->_connect(@info));
1012 $self->_conn_pid($$) unless DBIx::Class::_ENV_::BROKEN_FORK; # on win32 these are in fact threads
1014 $self->_determine_driver;
1016 # Always set the transaction depth on connect, since
1017 # there is no transaction in progress by definition
1018 $self->{transaction_depth} = $self->_dbh_autocommit ? 0 : 1;
1020 $self->_run_connection_actions unless $self->{_in_determine_driver};
1023 sub _run_connection_actions {
1027 push @actions, ( $self->on_connect_call || () );
1028 push @actions, $self->_parse_connect_do ('on_connect_do');
1030 $self->_do_connection_actions(connect_call_ => $_) for @actions;
1035 sub set_use_dbms_capability {
1036 $_[0]->set_inherited ($_[1], $_[2]);
1039 sub get_use_dbms_capability {
1040 my ($self, $capname) = @_;
1042 my $use = $self->get_inherited ($capname);
1045 : do { $capname =~ s/^_use_/_supports_/; $self->get_dbms_capability ($capname) }
1049 sub set_dbms_capability {
1050 $_[0]->_dbh_details->{capability}{$_[1]} = $_[2];
1053 sub get_dbms_capability {
1054 my ($self, $capname) = @_;
1056 my $cap = $self->_dbh_details->{capability}{$capname};
1058 unless (defined $cap) {
1059 if (my $meth = $self->can ("_determine$capname")) {
1060 $cap = $self->$meth ? 1 : 0;
1066 $self->set_dbms_capability ($capname, $cap);
1076 unless ($info = $self->_dbh_details->{info}) {
1080 my $server_version = try {
1081 $self->_get_server_version
1083 # driver determination *may* use this codepath
1084 # in which case we must rethrow
1085 $self->throw_exception($_) if $self->{_in_determine_driver};
1087 # $server_version on failure
1091 if (defined $server_version) {
1092 $info->{dbms_version} = $server_version;
1094 my ($numeric_version) = $server_version =~ /^([\d\.]+)/;
1095 my @verparts = split (/\./, $numeric_version);
1101 # consider only up to 3 version parts, iff not more than 3 digits
1103 while (@verparts && @use_parts < 3) {
1104 my $p = shift @verparts;
1106 push @use_parts, $p;
1108 push @use_parts, 0 while @use_parts < 3;
1110 $info->{normalized_dbms_version} = sprintf "%d.%03d%03d", @use_parts;
1114 $self->_dbh_details->{info} = $info;
1120 sub _get_server_version {
1121 shift->_dbh_get_info('SQL_DBMS_VER');
1125 my ($self, $info) = @_;
1127 if ($info =~ /[^0-9]/) {
1128 require DBI::Const::GetInfoType;
1129 $info = $DBI::Const::GetInfoType::GetInfoType{$info};
1130 $self->throw_exception("Info type '$_[1]' not provided by DBI::Const::GetInfoType")
1131 unless defined $info;
1134 $self->_get_dbh->get_info($info);
1137 sub _describe_connection {
1138 require DBI::Const::GetInfoReturn;
1141 $self->ensure_connected;
1144 DBIC_DSN => $self->_dbi_connect_info->[0],
1145 DBI_VER => DBI->VERSION,
1146 DBIC_VER => DBIx::Class->VERSION,
1147 DBIC_DRIVER => ref $self,
1151 #keys %DBI::Const::GetInfoType::GetInfoType,
1153 SQL_CURSOR_COMMIT_BEHAVIOR
1154 SQL_CURSOR_ROLLBACK_BEHAVIOR
1155 SQL_CURSOR_SENSITIVITY
1156 SQL_DATA_SOURCE_NAME
1159 SQL_DEFAULT_TXN_ISOLATION
1164 SQL_EXPRESSIONS_IN_ORDERBY
1167 SQL_IDENTIFIER_QUOTE_CHAR
1168 SQL_MAX_CATALOG_NAME_LEN
1169 SQL_MAX_COLUMN_NAME_LEN
1170 SQL_MAX_IDENTIFIER_LEN
1171 SQL_MAX_TABLE_NAME_LEN
1172 SQL_MULTIPLE_ACTIVE_TXN
1173 SQL_MULT_RESULT_SETS
1174 SQL_NEED_LONG_DATA_LEN
1175 SQL_NON_NULLABLE_COLUMNS
1177 SQL_QUALIFIER_NAME_SEPARATOR
1178 SQL_QUOTED_IDENTIFIER_CASE
1180 SQL_TXN_ISOLATION_OPTION
1183 # some drivers barf on things they do not know about instead
1184 # of returning undef
1185 my $v = try { $self->_dbh_get_info($inf) };
1186 next unless defined $v;
1188 #my $key = sprintf( '%s(%s)', $inf, $DBI::Const::GetInfoType::GetInfoType{$inf} );
1189 my $expl = DBI::Const::GetInfoReturn::Explain($inf, $v);
1190 $res->{$inf} = DBI::Const::GetInfoReturn::Format($inf, $v) . ( $expl ? " ($expl)" : '' );
1196 sub _determine_driver {
1199 if ((not $self->_driver_determined) && (not $self->{_in_determine_driver})) {
1200 my $started_connected = 0;
1201 local $self->{_in_determine_driver} = 1;
1203 if (ref($self) eq __PACKAGE__) {
1205 if ($self->_dbh) { # we are connected
1206 $driver = $self->_dbh->{Driver}{Name};
1207 $started_connected = 1;
1210 # if connect_info is a CODEREF, we have no choice but to connect
1211 if (ref $self->_dbi_connect_info->[0] &&
1212 reftype $self->_dbi_connect_info->[0] eq 'CODE') {
1213 $self->_populate_dbh;
1214 $driver = $self->_dbh->{Driver}{Name};
1217 # try to use dsn to not require being connected, the driver may still
1218 # force a connection in _rebless to determine version
1219 # (dsn may not be supplied at all if all we do is make a mock-schema)
1220 my $dsn = $self->_dbi_connect_info->[0] || $ENV{DBI_DSN} || '';
1221 ($driver) = $dsn =~ /dbi:([^:]+):/i;
1222 $driver ||= $ENV{DBI_DRIVER};
1227 my $storage_class = "DBIx::Class::Storage::DBI::${driver}";
1228 if ($self->load_optional_class($storage_class)) {
1229 mro::set_mro($storage_class, 'c3');
1230 bless $self, $storage_class;
1234 $self->_warn_undetermined_driver(
1235 'This version of DBIC does not yet seem to supply a driver for '
1236 . "your particular RDBMS and/or connection method ('$driver')."
1241 $self->_warn_undetermined_driver(
1242 'Unable to extract a driver name from connect info - this '
1243 . 'should not have happened.'
1248 $self->_driver_determined(1);
1250 Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO;
1252 if ($self->can('source_bind_attributes')) {
1253 $self->throw_exception(
1254 "Your storage subclass @{[ ref $self ]} provides (or inherits) the method "
1255 . 'source_bind_attributes() for which support has been removed as of Jan 2013. '
1256 . 'If you are not sure how to proceed please contact the development team via '
1257 . 'http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT'
1261 $self->_init; # run driver-specific initializations
1263 $self->_run_connection_actions
1264 if !$started_connected && defined $self->_dbh;
1268 sub _determine_connector_driver {
1269 my ($self, $conn) = @_;
1271 my $dbtype = $self->_dbh_get_info('SQL_DBMS_NAME');
1274 $self->_warn_undetermined_driver(
1275 'Unable to retrieve RDBMS type (SQL_DBMS_NAME) of the engine behind your '
1276 . "$conn connector - this should not have happened."
1281 $dbtype =~ s/\W/_/gi;
1283 my $subclass = "DBIx::Class::Storage::DBI::${conn}::${dbtype}";
1284 return if $self->isa($subclass);
1286 if ($self->load_optional_class($subclass)) {
1287 bless $self, $subclass;
1291 $self->_warn_undetermined_driver(
1292 'This version of DBIC does not yet seem to supply a driver for '
1293 . "your particular RDBMS and/or connection method ('$conn/$dbtype')."
1298 sub _warn_undetermined_driver {
1299 my ($self, $msg) = @_;
1301 require Data::Dumper::Concise;
1303 carp_once ($msg . ' While we will attempt to continue anyway, the results '
1304 . 'are likely to be underwhelming. Please upgrade DBIC, and if this message '
1305 . "does not go away, file a bugreport including the following info:\n"
1306 . Data::Dumper::Concise::Dumper($self->_describe_connection)
1310 sub _do_connection_actions {
1312 my $method_prefix = shift;
1315 if (not ref($call)) {
1316 my $method = $method_prefix . $call;
1318 } elsif (ref($call) eq 'CODE') {
1320 } elsif (ref($call) eq 'ARRAY') {
1321 if (ref($call->[0]) ne 'ARRAY') {
1322 $self->_do_connection_actions($method_prefix, $_) for @$call;
1324 $self->_do_connection_actions($method_prefix, @$_) for @$call;
1327 $self->throw_exception (sprintf ("Don't know how to process conection actions of type '%s'", ref($call)) );
1333 sub connect_call_do_sql {
1335 $self->_do_query(@_);
1338 sub disconnect_call_do_sql {
1340 $self->_do_query(@_);
1343 # override in db-specific backend when necessary
1344 sub connect_call_datetime_setup { 1 }
1347 my ($self, $action) = @_;
1349 if (ref $action eq 'CODE') {
1350 $action = $action->($self);
1351 $self->_do_query($_) foreach @$action;
1354 # Most debuggers expect ($sql, @bind), so we need to exclude
1355 # the attribute hash which is the second argument to $dbh->do
1356 # furthermore the bind values are usually to be presented
1357 # as named arrayref pairs, so wrap those here too
1358 my @do_args = (ref $action eq 'ARRAY') ? (@$action) : ($action);
1359 my $sql = shift @do_args;
1360 my $attrs = shift @do_args;
1361 my @bind = map { [ undef, $_ ] } @do_args;
1364 $_[0]->_query_start($sql, \@bind);
1365 $_[1]->do($sql, $attrs, @do_args);
1366 $_[0]->_query_end($sql, \@bind);
1374 my ($self, @info) = @_;
1376 $self->throw_exception("You did not provide any connection_info")
1377 if ( ! defined $info[0] and ! $ENV{DBI_DSN} and ! $ENV{DBI_DRIVER} );
1379 my ($old_connect_via, $dbh);
1381 local $DBI::connect_via = 'connect' if $INC{'Apache/DBI.pm'} && $ENV{MOD_PERL};
1384 if(ref $info[0] eq 'CODE') {
1385 $dbh = $info[0]->();
1389 $dbh = DBI->connect(@info);
1392 die $DBI::errstr unless $dbh;
1394 die sprintf ("%s fresh DBI handle with a *false* 'Active' attribute. "
1395 . 'This handle is disconnected as far as DBIC is concerned, and we can '
1397 ref $info[0] eq 'CODE'
1398 ? "Connection coderef $info[0] returned a"
1399 : 'DBI->connect($schema->storage->connect_info) resulted in a'
1400 ) unless $dbh->FETCH('Active');
1402 # sanity checks unless asked otherwise
1403 unless ($self->unsafe) {
1405 $self->throw_exception(
1406 'Refusing clobbering of {HandleError} installed on externally supplied '
1407 ."DBI handle $dbh. Either remove the handler or use the 'unsafe' attribute."
1408 ) if $dbh->{HandleError} and ref $dbh->{HandleError} ne '__DBIC__DBH__ERROR__HANDLER__';
1410 # Default via _default_dbi_connect_attributes is 1, hence it was an explicit
1411 # request, or an external handle. Complain and set anyway
1412 unless ($dbh->{RaiseError}) {
1413 carp( ref $info[0] eq 'CODE'
1415 ? "The 'RaiseError' of the externally supplied DBI handle is set to false. "
1416 ."DBIx::Class will toggle it back to true, unless the 'unsafe' connect "
1417 .'attribute has been supplied'
1419 : 'RaiseError => 0 supplied in your connection_info, without an explicit '
1420 .'unsafe => 1. Toggling RaiseError back to true'
1423 $dbh->{RaiseError} = 1;
1426 # this odd anonymous coderef dereference is in fact really
1427 # necessary to avoid the unwanted effect described in perl5
1430 my $weak_self = $_[0];
1433 # the coderef is blessed so we can distinguish it from externally
1434 # supplied handles (which must be preserved)
1435 $_[1]->{HandleError} = bless sub {
1437 $weak_self->throw_exception("DBI Exception: $_[0]");
1440 # the handler may be invoked by something totally out of
1442 DBIx::Class::Exception->throw("DBI Exception (unhandled by DBIC, ::Schema GCed): $_[0]");
1444 }, '__DBIC__DBH__ERROR__HANDLER__';
1449 $self->throw_exception("DBI Connection failed: $_")
1452 $self->_dbh_autocommit($dbh->{AutoCommit});
1459 # this means we have not yet connected and do not know the AC status
1460 # (e.g. coderef $dbh), need a full-fledged connection check
1461 if (! defined $self->_dbh_autocommit) {
1462 $self->ensure_connected;
1464 # Otherwise simply connect or re-connect on pid changes
1469 $self->next::method(@_);
1472 sub _exec_txn_begin {
1475 # if the user is utilizing txn_do - good for him, otherwise we need to
1476 # ensure that the $dbh is healthy on BEGIN.
1477 # We do this via ->dbh_do instead of ->dbh, so that the ->dbh "ping"
1478 # will be replaced by a failure of begin_work itself (which will be
1479 # then retried on reconnect)
1480 if ($self->{_in_do_block}) {
1481 $self->_dbh->begin_work;
1483 $self->dbh_do(sub { $_[1]->begin_work });
1490 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1491 $self->throw_exception("Unable to txn_commit() on a disconnected storage")
1494 # esoteric case for folks using external $dbh handles
1495 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1496 carp "Storage transaction_depth 0 does not match "
1497 ."false AutoCommit of $self->{_dbh}, attempting COMMIT anyway";
1498 $self->transaction_depth(1);
1501 $self->next::method(@_);
1503 # if AutoCommit is disabled txn_depth never goes to 0
1504 # as a new txn is started immediately on commit
1505 $self->transaction_depth(1) if (
1506 !$self->transaction_depth
1508 defined $self->_dbh_autocommit
1510 ! $self->_dbh_autocommit
1514 sub _exec_txn_commit {
1515 shift->_dbh->commit;
1521 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1522 $self->throw_exception("Unable to txn_rollback() on a disconnected storage")
1525 # esoteric case for folks using external $dbh handles
1526 if (! $self->transaction_depth and ! $self->_dbh->FETCH('AutoCommit') ) {
1527 carp "Storage transaction_depth 0 does not match "
1528 ."false AutoCommit of $self->{_dbh}, attempting ROLLBACK anyway";
1529 $self->transaction_depth(1);
1532 $self->next::method(@_);
1534 # if AutoCommit is disabled txn_depth never goes to 0
1535 # as a new txn is started immediately on commit
1536 $self->transaction_depth(1) if (
1537 !$self->transaction_depth
1539 defined $self->_dbh_autocommit
1541 ! $self->_dbh_autocommit
1545 sub _exec_txn_rollback {
1546 shift->_dbh->rollback;
1549 # generate some identical methods
1550 for my $meth (qw/svp_begin svp_release svp_rollback/) {
1552 *{__PACKAGE__ ."::$meth"} = subname $meth => sub {
1554 $self->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
1555 $self->throw_exception("Unable to $meth() on a disconnected storage")
1557 $self->next::method(@_);
1561 # This used to be the top-half of _execute. It was split out to make it
1562 # easier to override in NoBindVars without duping the rest. It takes up
1563 # all of _execute's args, and emits $sql, @bind.
1564 sub _prep_for_execute {
1565 #my ($self, $op, $ident, $args) = @_;
1566 return shift->_gen_sql_bind(@_)
1570 my ($self, $op, $ident, $args) = @_;
1572 my ($colinfos, $from);
1573 if ( blessed($ident) ) {
1574 $from = $ident->from;
1575 $colinfos = $ident->columns_info;
1579 ($sql, @$bind) = $self->sql_maker->$op( ($from || $ident), @$args );
1581 $bind = $self->_resolve_bindattrs(
1582 $ident, [ @{$args->[2]{bind}||[]}, @$bind ], $colinfos
1586 ! $ENV{DBIC_DT_SEARCH_OK}
1595 $_->[1]->isa('DateTime')
1598 carp_unique 'DateTime objects passed to search() are not supported '
1599 . 'properly (InflateColumn::DateTime formats and settings are not '
1600 . 'respected.) See "Formatting DateTime objects in queries" in '
1601 . 'DBIx::Class::Manual::Cookbook. To disable this warning for good '
1602 . 'set $ENV{DBIC_DT_SEARCH_OK} to true'
1605 return( $sql, $bind );
1608 sub _resolve_bindattrs {
1609 my ($self, $ident, $bind, $colinfos) = @_;
1613 my $resolve_bindinfo = sub {
1614 #my $infohash = shift;
1616 %$colinfos = %{ $self->_resolve_column_info($ident) }
1617 unless keys %$colinfos;
1620 if (my $col = $_[0]->{dbic_colname}) {
1621 $ret = { %{$_[0]} };
1623 $ret->{sqlt_datatype} ||= $colinfos->{$col}{data_type}
1624 if $colinfos->{$col}{data_type};
1626 $ret->{sqlt_size} ||= $colinfos->{$col}{size}
1627 if $colinfos->{$col}{size};
1635 ( ref $_ ne 'ARRAY' or @$_ != 2 ) ? [ {}, $_ ]
1636 : ( ! defined $_->[0] ) ? [ {}, $_->[1] ]
1637 : (ref $_->[0] eq 'HASH') ? [ (exists $_->[0]{dbd_attrs} or $_->[0]{sqlt_datatype})
1639 : $resolve_bindinfo->($_->[0])
1641 : (ref $_->[0] eq 'SCALAR') ? [ { sqlt_datatype => ${$_->[0]} }, $_->[1] ]
1642 : [ $resolve_bindinfo->(
1643 { dbic_colname => $_->[0] }
1648 ! exists $resolved->[0]{dbd_attrs}
1650 ! $resolved->[0]{sqlt_datatype}
1652 length ref $resolved->[1]
1654 ! overload::Method($resolved->[1], '""')
1656 require Data::Dumper;
1657 local $Data::Dumper::Maxdepth = 1;
1658 local $Data::Dumper::Terse = 1;
1659 local $Data::Dumper::Useqq = 1;
1660 local $Data::Dumper::Indent = 0;
1661 local $Data::Dumper::Pad = ' ';
1662 $self->throw_exception(
1663 'You must supply a datatype/bindtype (see DBIx::Class::ResultSet/DBIC BIND VALUES) '
1664 . 'for non-scalar value '. Data::Dumper::Dumper ($resolved->[1])
1673 sub _format_for_trace {
1674 #my ($self, $bind) = @_;
1676 ### Turn @bind from something like this:
1677 ### ( [ "artist", 1 ], [ \%attrs, 3 ] )
1679 ### ( "'1'", "'3'" )
1682 defined( $_ && $_->[1] )
1689 my ( $self, $sql, $bind ) = @_;
1691 $self->debugobj->query_start( $sql, $self->_format_for_trace($bind) )
1696 my ( $self, $sql, $bind ) = @_;
1698 $self->debugobj->query_end( $sql, $self->_format_for_trace($bind) )
1702 sub _dbi_attrs_for_bind {
1703 my ($self, $ident, $bind) = @_;
1707 for (map { $_->[0] } @$bind) {
1709 if (exists $_->{dbd_attrs}) {
1712 elsif($_->{sqlt_datatype}) {
1713 # cache the result in the dbh_details hash, as it can not change unless
1714 # we connect to something else
1715 my $cache = $self->_dbh_details->{_datatype_map_cache} ||= {};
1716 if (not exists $cache->{$_->{sqlt_datatype}}) {
1717 $cache->{$_->{sqlt_datatype}} = $self->bind_attribute_by_data_type($_->{sqlt_datatype}) || undef;
1719 $cache->{$_->{sqlt_datatype}};
1722 undef; # always push something at this position
1731 my ($self, $op, $ident, @args) = @_;
1733 my ($sql, $bind) = $self->_prep_for_execute($op, $ident, \@args);
1735 # not even a PID check - we do not care about the state of the _dbh.
1736 # All we need is to get the appropriate drivers loaded if they aren't
1737 # already so that the assumption in ad7c50fc26e holds
1738 $self->_populate_dbh unless $self->_dbh;
1740 $self->dbh_do( _dbh_execute => # retry over disconnects
1743 $self->_dbi_attrs_for_bind($ident, $bind),
1748 my ($self, $dbh, $sql, $bind, $bind_attrs) = @_;
1750 $self->_query_start( $sql, $bind );
1752 my $sth = $self->_bind_sth_params(
1753 $self->_prepare_sth($dbh, $sql),
1758 # Can this fail without throwing an exception anyways???
1759 my $rv = $sth->execute();
1760 $self->throw_exception(
1761 $sth->errstr || $sth->err || 'Unknown error: execute() returned false, but error flags were not set...'
1764 $self->_query_end( $sql, $bind );
1766 return (wantarray ? ($rv, $sth, @$bind) : $rv);
1770 my ($self, $dbh, $sql) = @_;
1772 # 3 is the if_active parameter which avoids active sth re-use
1773 my $sth = $self->disable_sth_caching
1774 ? $dbh->prepare($sql)
1775 : $dbh->prepare_cached($sql, {}, 3);
1777 # XXX You would think RaiseError would make this impossible,
1778 # but apparently that's not true :(
1779 $self->throw_exception(
1782 sprintf( "\$dbh->prepare() of '%s' through %s failed *silently* without "
1783 .'an exception and/or setting $dbh->errstr',
1785 ? substr($sql, 0, 20) . '...'
1788 'DBD::' . $dbh->{Driver}{Name},
1795 sub _bind_sth_params {
1796 my ($self, $sth, $bind, $bind_attrs) = @_;
1798 for my $i (0 .. $#$bind) {
1799 if (ref $bind->[$i][1] eq 'SCALAR') { # any scalarrefs are assumed to be bind_inouts
1800 $sth->bind_param_inout(
1801 $i + 1, # bind params counts are 1-based
1803 $bind->[$i][0]{dbd_size} || $self->_max_column_bytesize($bind->[$i][0]), # size
1808 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1809 # confirm with dbi-dev whether explicit stringification is needed
1810 my $v = ( length ref $bind->[$i][1] and overload::Method($bind->[$i][1], '""') )
1825 sub _prefetch_autovalues {
1826 my ($self, $source, $colinfo, $to_insert) = @_;
1829 for my $col (keys %$colinfo) {
1831 $colinfo->{$col}{auto_nextval}
1834 ! exists $to_insert->{$col}
1836 ref $to_insert->{$col} eq 'SCALAR'
1838 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1841 $values{$col} = $self->_sequence_fetch(
1843 ( $colinfo->{$col}{sequence} ||=
1844 $self->_dbh_get_autoinc_seq($self->_get_dbh, $source, $col)
1854 my ($self, $source, $to_insert) = @_;
1856 my $col_infos = $source->columns_info;
1858 my $prefetched_values = $self->_prefetch_autovalues($source, $col_infos, $to_insert);
1860 # fuse the values, but keep a separate list of prefetched_values so that
1861 # they can be fused once again with the final return
1862 $to_insert = { %$to_insert, %$prefetched_values };
1864 # FIXME - we seem to assume undef values as non-supplied. This is wrong.
1865 # Investigate what does it take to s/defined/exists/
1866 my %pcols = map { $_ => 1 } $source->primary_columns;
1867 my (%retrieve_cols, $autoinc_supplied, $retrieve_autoinc_col);
1868 for my $col ($source->columns) {
1869 if ($col_infos->{$col}{is_auto_increment}) {
1870 $autoinc_supplied ||= 1 if defined $to_insert->{$col};
1871 $retrieve_autoinc_col ||= $col unless $autoinc_supplied;
1874 # nothing to retrieve when explicit values are supplied
1875 next if (defined $to_insert->{$col} and ! (
1876 ref $to_insert->{$col} eq 'SCALAR'
1878 (ref $to_insert->{$col} eq 'REF' and ref ${$to_insert->{$col}} eq 'ARRAY')
1881 # the 'scalar keys' is a trick to preserve the ->columns declaration order
1882 $retrieve_cols{$col} = scalar keys %retrieve_cols if (
1885 $col_infos->{$col}{retrieve_on_insert}
1889 local $self->{_autoinc_supplied_for_op} = $autoinc_supplied;
1890 local $self->{_perform_autoinc_retrieval} = $retrieve_autoinc_col;
1892 my ($sqla_opts, @ir_container);
1893 if (%retrieve_cols and $self->_use_insert_returning) {
1894 $sqla_opts->{returning_container} = \@ir_container
1895 if $self->_use_insert_returning_bound;
1897 $sqla_opts->{returning} = [
1898 sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols
1902 my ($rv, $sth) = $self->_execute('insert', $source, $to_insert, $sqla_opts);
1904 my %returned_cols = %$to_insert;
1905 if (my $retlist = $sqla_opts->{returning}) { # if IR is supported - we will get everything in one set
1906 @ir_container = try {
1907 local $SIG{__WARN__} = sub {};
1908 my @r = $sth->fetchrow_array;
1911 } unless @ir_container;
1913 @returned_cols{@$retlist} = @ir_container if @ir_container;
1916 # pull in PK if needed and then everything else
1917 if (my @missing_pri = grep { $pcols{$_} } keys %retrieve_cols) {
1919 $self->throw_exception( "Missing primary key but Storage doesn't support last_insert_id" )
1920 unless $self->can('last_insert_id');
1922 my @pri_values = $self->last_insert_id($source, @missing_pri);
1924 $self->throw_exception( "Can't get last insert id" )
1925 unless (@pri_values == @missing_pri);
1927 @returned_cols{@missing_pri} = @pri_values;
1928 delete @retrieve_cols{@missing_pri};
1931 # if there is more left to pull
1932 if (%retrieve_cols) {
1933 $self->throw_exception(
1934 'Unable to retrieve additional columns without a Primary Key on ' . $source->source_name
1937 my @left_to_fetch = sort { $retrieve_cols{$a} <=> $retrieve_cols{$b} } keys %retrieve_cols;
1939 my $cur = DBIx::Class::ResultSet->new($source, {
1940 where => { map { $_ => $returned_cols{$_} } (keys %pcols) },
1941 select => \@left_to_fetch,
1944 @returned_cols{@left_to_fetch} = $cur->next;
1946 $self->throw_exception('Duplicate row returned for PK-search after fresh insert')
1947 if scalar $cur->next;
1951 return { %$prefetched_values, %returned_cols };
1955 my ($self, $source, $cols, $data) = @_;
1957 my @col_range = (0..$#$cols);
1959 # FIXME SUBOPTIMAL - most likely this is not necessary at all
1960 # confirm with dbi-dev whether explicit stringification is needed
1962 # forcibly stringify whatever is stringifiable
1963 # ResultSet::populate() hands us a copy - safe to mangle
1964 for my $r (0 .. $#$data) {
1965 for my $c (0 .. $#{$data->[$r]}) {
1966 $data->[$r][$c] = "$data->[$r][$c]"
1967 if ( length ref $data->[$r][$c] and overload::Method($data->[$r][$c], '""') );
1971 my $colinfos = $source->columns_info($cols);
1973 local $self->{_autoinc_supplied_for_op} =
1974 (first { $_->{is_auto_increment} } values %$colinfos)
1979 # get a slice type index based on first row of data
1980 # a "column" in this context may refer to more than one bind value
1981 # e.g. \[ '?, ?', [...], [...] ]
1983 # construct the value type index - a description of values types for every
1984 # per-column slice of $data:
1986 # nonexistent - nonbind literal
1988 # [] of bindattrs - resolved attribute(s) of bind(s) passed via literal+bind \[] combo
1990 # also construct the column hash to pass to the SQL generator. For plain
1991 # (non literal) values - convert the members of the first row into a
1992 # literal+bind combo, with extra positional info in the bind attr hashref.
1993 # This will allow us to match the order properly, and is so contrived
1994 # because a user-supplied literal/bind (or something else specific to a
1995 # resultsource and/or storage driver) can inject extra binds along the
1996 # way, so one can't rely on "shift positions" ordering at all. Also we
1997 # can't just hand SQLA a set of some known "values" (e.g. hashrefs that
1998 # can be later matched up by address), because we want to supply a real
1999 # value on which perhaps e.g. datatype checks will be performed
2000 my ($proto_data, $value_type_by_col_idx);
2001 for my $i (@col_range) {
2002 my $colname = $cols->[$i];
2003 if (ref $data->[0][$i] eq 'SCALAR') {
2004 # no bind value at all - no type
2006 $proto_data->{$colname} = $data->[0][$i];
2008 elsif (ref $data->[0][$i] eq 'REF' and ref ${$data->[0][$i]} eq 'ARRAY' ) {
2009 # repack, so we don't end up mangling the original \[]
2010 my ($sql, @bind) = @${$data->[0][$i]};
2012 # normalization of user supplied stuff
2013 my $resolved_bind = $self->_resolve_bindattrs(
2014 $source, \@bind, $colinfos,
2017 # store value-less (attrs only) bind info - we will be comparing all
2018 # supplied binds against this for sanity
2019 $value_type_by_col_idx->{$i} = [ map { $_->[0] } @$resolved_bind ];
2021 $proto_data->{$colname} = \[ $sql, map { [
2022 # inject slice order to use for $proto_bind construction
2023 { %{$resolved_bind->[$_][0]}, _bind_data_slice_idx => $i, _literal_bind_subindex => $_+1 }
2025 $resolved_bind->[$_][1]
2030 $value_type_by_col_idx->{$i} = undef;
2032 $proto_data->{$colname} = \[ '?', [
2033 { dbic_colname => $colname, _bind_data_slice_idx => $i }
2040 my ($sql, $proto_bind) = $self->_prep_for_execute (
2046 if (! @$proto_bind and keys %$value_type_by_col_idx) {
2047 # if the bindlist is empty and we had some dynamic binds, this means the
2048 # storage ate them away (e.g. the NoBindVars component) and interpolated
2049 # them directly into the SQL. This obviously can't be good for multi-inserts
2050 $self->throw_exception('Cannot insert_bulk without support for placeholders');
2054 # FIXME - devise a flag "no babysitting" or somesuch to shut this off
2056 # use an error reporting closure for convenience (less to pass)
2057 my $bad_slice_report_cref = sub {
2058 my ($msg, $r_idx, $c_idx) = @_;
2059 $self->throw_exception(sprintf "%s for column '%s' in populate slice:\n%s",
2063 require Data::Dumper::Concise;
2064 local $Data::Dumper::Maxdepth = 5;
2065 Data::Dumper::Concise::Dumper ({
2066 map { $cols->[$_] =>
2074 for my $col_idx (@col_range) {
2075 my $reference_val = $data->[0][$col_idx];
2077 for my $row_idx (1..$#$data) { # we are comparing against what we got from [0] above, hence start from 1
2078 my $val = $data->[$row_idx][$col_idx];
2080 if (! exists $value_type_by_col_idx->{$col_idx}) { # literal no binds
2081 if (ref $val ne 'SCALAR') {
2082 $bad_slice_report_cref->(
2083 "Incorrect value (expecting SCALAR-ref \\'$$reference_val')",
2088 elsif ($$val ne $$reference_val) {
2089 $bad_slice_report_cref->(
2090 "Inconsistent literal SQL value (expecting \\'$$reference_val')",
2096 elsif (! defined $value_type_by_col_idx->{$col_idx} ) { # regular non-literal value
2097 if (ref $val eq 'SCALAR' or (ref $val eq 'REF' and ref $$val eq 'ARRAY') ) {
2098 $bad_slice_report_cref->("Literal SQL found where a plain bind value is expected", $row_idx, $col_idx);
2101 else { # binds from a \[], compare type and attrs
2102 if (ref $val ne 'REF' or ref $$val ne 'ARRAY') {
2103 $bad_slice_report_cref->(
2104 "Incorrect value (expecting ARRAYREF-ref \\['${$reference_val}->[0]', ... ])",
2109 # start drilling down and bail out early on identical refs
2111 $reference_val != $val
2113 $$reference_val != $$val
2115 if (${$val}->[0] ne ${$reference_val}->[0]) {
2116 $bad_slice_report_cref->(
2117 "Inconsistent literal/bind SQL (expecting \\['${$reference_val}->[0]', ... ])",
2122 # need to check the bind attrs - a bind will happen only once for
2123 # the entire dataset, so any changes further down will be ignored.
2124 elsif (! Data::Compare::Compare(
2125 $value_type_by_col_idx->{$col_idx},
2129 @{$self->_resolve_bindattrs(
2130 $source, [ @{$$val}[1 .. $#$$val] ], $colinfos,
2134 $bad_slice_report_cref->(
2135 'Differing bind attributes on literal/bind values not supported',
2145 # neither _dbh_execute_for_fetch, nor _dbh_execute_inserts_with_no_binds
2146 # are atomic (even if execute_for_fetch is a single call). Thus a safety
2148 my $guard = $self->txn_scope_guard;
2150 $self->_query_start( $sql, @$proto_bind ? [[undef => '__BULK_INSERT__' ]] : () );
2151 my $sth = $self->_prepare_sth($self->_dbh, $sql);
2154 # proto bind contains the information on which pieces of $data to pull
2155 # $cols is passed in only for prettier error-reporting
2156 $self->_dbh_execute_for_fetch( $source, $sth, $proto_bind, $cols, $data );
2159 # bind_param_array doesn't work if there are no binds
2160 $self->_dbh_execute_inserts_with_no_binds( $sth, scalar @$data );
2164 $self->_query_end( $sql, @$proto_bind ? [[ undef => '__BULK_INSERT__' ]] : () );
2168 return wantarray ? ($rv, $sth, @$proto_bind) : $rv;
2171 # execute_for_fetch is capable of returning data just fine (it means it
2172 # can be used for INSERT...RETURNING and UPDATE...RETURNING. Since this
2173 # is the void-populate fast-path we will just ignore this altogether
2174 # for the time being.
2175 sub _dbh_execute_for_fetch {
2176 my ($self, $source, $sth, $proto_bind, $cols, $data) = @_;
2178 my @idx_range = ( 0 .. $#$proto_bind );
2180 # If we have any bind attributes to take care of, we will bind the
2181 # proto-bind data (which will never be used by execute_for_fetch)
2182 # However since column bindtypes are "sticky", this is sufficient
2183 # to get the DBD to apply the bindtype to all values later on
2185 my $bind_attrs = $self->_dbi_attrs_for_bind($source, $proto_bind);
2187 for my $i (@idx_range) {
2189 $i+1, # DBI bind indexes are 1-based
2190 $proto_bind->[$i][1],
2192 ) if defined $bind_attrs->[$i];
2195 # At this point $data slots named in the _bind_data_slice_idx of
2196 # each piece of $proto_bind are either \[]s or plain values to be
2197 # passed in. Construct the dispensing coderef. *NOTE* the order
2198 # of $data will differ from this of the ?s in the SQL (due to
2199 # alphabetical ordering by colname). We actually do want to
2200 # preserve this behavior so that prepare_cached has a better
2201 # chance of matching on unrelated calls
2203 my $fetch_row_idx = -1; # saner loop this way
2204 my $fetch_tuple = sub {
2205 return undef if ++$fetch_row_idx > $#$data;
2207 return [ map { defined $_->{_literal_bind_subindex}
2208 ? ${ $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]}
2209 ->[ $_->{_literal_bind_subindex} ]
2211 : $data->[ $fetch_row_idx ]->[ $_->{_bind_data_slice_idx} ]
2212 } map { $_->[0] } @$proto_bind];
2215 my $tuple_status = [];
2218 $rv = $sth->execute_for_fetch(
2227 # Not all DBDs are create equal. Some throw on error, some return
2228 # an undef $rv, and some set $sth->err - try whatever we can
2229 $err = ($sth->errstr || 'UNKNOWN ERROR ($sth->errstr is unset)') if (
2232 ( !defined $rv or $sth->err )
2235 # Statement must finish even if there was an exception.
2240 $err = shift unless defined $err
2245 ++$i while $i <= $#$tuple_status && !ref $tuple_status->[$i];
2247 $self->throw_exception("Unexpected populate error: $err")
2248 if ($i > $#$tuple_status);
2250 require Data::Dumper::Concise;
2251 $self->throw_exception(sprintf "execute_for_fetch() aborted with '%s' at populate slice:\n%s",
2252 ($tuple_status->[$i][1] || $err),
2253 Data::Dumper::Concise::Dumper( { map { $cols->[$_] => $data->[$i][$_] } (0 .. $#$cols) } ),
2260 sub _dbh_execute_inserts_with_no_binds {
2261 my ($self, $sth, $count) = @_;
2265 my $dbh = $self->_get_dbh;
2266 local $dbh->{RaiseError} = 1;
2267 local $dbh->{PrintError} = 0;
2269 $sth->execute foreach 1..$count;
2275 # Make sure statement is finished even if there was an exception.
2280 $err = shift unless defined $err;
2283 $self->throw_exception($err) if defined $err;
2289 #my ($self, $source, @args) = @_;
2290 shift->_execute('update', @_);
2295 #my ($self, $source, @args) = @_;
2296 shift->_execute('delete', @_);
2301 $self->_execute($self->_select_args(@_));
2304 sub _select_args_to_query {
2307 $self->throw_exception(
2308 "Unable to generate limited query representation with 'software_limit' enabled"
2309 ) if ($_[3]->{software_limit} and ($_[3]->{offset} or $_[3]->{rows}) );
2311 # my ($op, $ident, $select, $cond, $rs_attrs, $rows, $offset)
2312 # = $self->_select_args($ident, $select, $cond, $attrs);
2313 my ($op, $ident, @args) =
2314 $self->_select_args(@_);
2316 # my ($sql, $prepared_bind) = $self->_gen_sql_bind($op, $ident, [ $select, $cond, $rs_attrs, $rows, $offset ]);
2317 my ($sql, $bind) = $self->_gen_sql_bind($op, $ident, \@args);
2319 # reuse the bind arrayref
2320 unshift @{$bind}, "($sql)";
2325 my ($self, $ident, $select, $where, $orig_attrs) = @_;
2328 'select', @{$orig_attrs->{_sqlmaker_select_args}}
2329 ) if $orig_attrs->{_sqlmaker_select_args};
2331 my $sql_maker = $self->sql_maker;
2332 my $alias2source = $self->_resolve_ident_sources ($ident);
2340 # limit dialects use this stuff
2341 # yes, some CDBICompat crap does not supply an {alias} >.<
2342 ( $orig_attrs->{alias} and $alias2source->{$orig_attrs->{alias}} )
2343 ? ( _rsroot_rsrc => $alias2source->{$orig_attrs->{alias}} )
2348 # Sanity check the attributes (SQLMaker does it too, but
2349 # in case of a software_limit we'll never reach there)
2350 if (defined $attrs->{offset}) {
2351 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
2352 if ( $attrs->{offset} =~ /\D/ or $attrs->{offset} < 0 );
2355 if (defined $attrs->{rows}) {
2356 $self->throw_exception("The rows attribute must be a positive integer if present")
2357 if ( $attrs->{rows} =~ /\D/ or $attrs->{rows} <= 0 );
2359 elsif ($attrs->{offset}) {
2360 # MySQL actually recommends this approach. I cringe.
2361 $attrs->{rows} = $sql_maker->__max_int;
2364 # see if we will need to tear the prefetch apart to satisfy group_by == select
2365 # this is *extremely tricky* to get right, I am still not sure I did
2367 my ($prefetch_needs_subquery, @limit_args);
2369 if ( $attrs->{_grouped_by_distinct} and $attrs->{collapse} ) {
2370 # we already know there is a valid group_by and we know it is intended
2371 # to be based *only* on the main result columns
2372 # short circuit the group_by parsing below
2373 $prefetch_needs_subquery = 1;
2376 # The rationale is that even if we do *not* have collapse, we still
2377 # need to wrap the core grouped select/group_by in a subquery
2378 # so that databases that care about group_by/select equivalence
2379 # are happy (this includes MySQL in strict_mode)
2380 # If any of the other joined tables are referenced in the group_by
2381 # however - the user is on their own
2382 ( $prefetch_needs_subquery or $attrs->{_related_results_construction} )
2386 @{$attrs->{group_by}}
2388 my $grp_aliases = try { # try{} because $attrs->{from} may be unreadable
2389 $self->_resolve_aliastypes_from_select_args( $attrs->{from}, undef, undef, { group_by => $attrs->{group_by} } )
2392 # no aliases other than our own in group_by
2393 # if there are - do not allow subquery even if limit is present
2394 $prefetch_needs_subquery = ! scalar grep { $_ ne $attrs->{alias} } keys %{ $grp_aliases->{grouping} || {} };
2396 elsif ( $attrs->{rows} && $attrs->{collapse} ) {
2397 # active collapse with a limit - that one is a no-brainer unless
2398 # overruled by a group_by above
2399 $prefetch_needs_subquery = 1;
2402 if ($prefetch_needs_subquery) {
2403 ($ident, $select, $where, $attrs) =
2404 $self->_adjust_select_args_for_complex_prefetch ($ident, $select, $where, $attrs);
2406 elsif (! $attrs->{software_limit} ) {
2408 $attrs->{rows} || (),
2409 $attrs->{offset} || (),
2413 # try to simplify the joinmap further (prune unreferenced type-single joins)
2415 ! $prefetch_needs_subquery # already pruned
2419 reftype $ident eq 'ARRAY'
2423 ($ident, $attrs->{_aliastypes}) = $self->_prune_unused_joins ($ident, $select, $where, $attrs);
2427 # This would be the point to deflate anything found in $where
2428 # (and leave $attrs->{bind} intact). Problem is - inflators historically
2429 # expect a result object. And all we have is a resultsource (it is trivial
2430 # to extract deflator coderefs via $alias2source above).
2432 # I don't see a way forward other than changing the way deflators are
2433 # invoked, and that's just bad...
2436 return ( 'select', @{ $orig_attrs->{_sqlmaker_select_args} = [
2437 $ident, $select, $where, $attrs, @limit_args
2441 # Returns a counting SELECT for a simple count
2442 # query. Abstracted so that a storage could override
2443 # this to { count => 'firstcol' } or whatever makes
2444 # sense as a performance optimization
2446 #my ($self, $source, $rs_attrs) = @_;
2447 return { count => '*' };
2454 =item Arguments: $ident, $select, $condition, $attrs
2458 Handle a SQL select statement.
2464 my ($ident, $select, $condition, $attrs) = @_;
2465 return $self->cursor_class->new($self, \@_, $attrs);
2470 my ($rv, $sth, @bind) = $self->_select(@_);
2471 my @row = $sth->fetchrow_array;
2472 my @nextrow = $sth->fetchrow_array if @row;
2473 if(@row && @nextrow) {
2474 carp "Query returned more than one row. SQL that returns multiple rows is DEPRECATED for ->find and ->single";
2476 # Need to call finish() to work round broken DBDs
2481 =head2 sql_limit_dialect
2483 This is an accessor for the default SQL limit dialect used by a particular
2484 storage driver. Can be overridden by supplying an explicit L</limit_dialect>
2485 to L<DBIx::Class::Schema/connect>. For a list of available limit dialects
2486 see L<DBIx::Class::SQLMaker::LimitDialects>.
2490 sub _dbh_columns_info_for {
2491 my ($self, $dbh, $table) = @_;
2493 if ($dbh->can('column_info')) {
2497 my ($schema,$tab) = $table =~ /^(.+?)\.(.+)$/ ? ($1,$2) : (undef,$table);
2498 my $sth = $dbh->column_info( undef,$schema, $tab, '%' );
2500 while ( my $info = $sth->fetchrow_hashref() ){
2502 $column_info{data_type} = $info->{TYPE_NAME};
2503 $column_info{size} = $info->{COLUMN_SIZE};
2504 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
2505 $column_info{default_value} = $info->{COLUMN_DEF};
2506 my $col_name = $info->{COLUMN_NAME};
2507 $col_name =~ s/^\"(.*)\"$/$1/;
2509 $result{$col_name} = \%column_info;
2514 return \%result if !$caught && scalar keys %result;
2518 my $sth = $dbh->prepare($self->sql_maker->select($table, undef, \'1 = 0'));
2520 my @columns = @{$sth->{NAME_lc}};
2521 for my $i ( 0 .. $#columns ){
2523 $column_info{data_type} = $sth->{TYPE}->[$i];
2524 $column_info{size} = $sth->{PRECISION}->[$i];
2525 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
2527 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
2528 $column_info{data_type} = $1;
2529 $column_info{size} = $2;
2532 $result{$columns[$i]} = \%column_info;
2536 foreach my $col (keys %result) {
2537 my $colinfo = $result{$col};
2538 my $type_num = $colinfo->{data_type};
2540 if(defined $type_num && $dbh->can('type_info')) {
2541 my $type_info = $dbh->type_info($type_num);
2542 $type_name = $type_info->{TYPE_NAME} if $type_info;
2543 $colinfo->{data_type} = $type_name if $type_name;
2550 sub columns_info_for {
2551 my ($self, $table) = @_;
2552 $self->_dbh_columns_info_for ($self->_get_dbh, $table);
2555 =head2 last_insert_id
2557 Return the row id of the last insert.
2561 sub _dbh_last_insert_id {
2562 my ($self, $dbh, $source, $col) = @_;
2564 my $id = try { $dbh->last_insert_id (undef, undef, $source->name, $col) };
2566 return $id if defined $id;
2568 my $class = ref $self;
2569 $self->throw_exception ("No storage specific _dbh_last_insert_id() method implemented in $class, and the generic DBI::last_insert_id() failed");
2572 sub last_insert_id {
2574 $self->_dbh_last_insert_id ($self->_dbh, @_);
2577 =head2 _native_data_type
2581 =item Arguments: $type_name
2585 This API is B<EXPERIMENTAL>, will almost definitely change in the future, and
2586 currently only used by L<::AutoCast|DBIx::Class::Storage::DBI::AutoCast> and
2587 L<::Sybase::ASE|DBIx::Class::Storage::DBI::Sybase::ASE>.
2589 The default implementation returns C<undef>, implement in your Storage driver if
2590 you need this functionality.
2592 Should map types from other databases to the native RDBMS type, for example
2593 C<VARCHAR2> to C<VARCHAR>.
2595 Types with modifiers should map to the underlying data type. For example,
2596 C<INTEGER AUTO_INCREMENT> should become C<INTEGER>.
2598 Composite types should map to the container type, for example
2599 C<ENUM(foo,bar,baz)> becomes C<ENUM>.
2603 sub _native_data_type {
2604 #my ($self, $data_type) = @_;
2608 # Check if placeholders are supported at all
2609 sub _determine_supports_placeholders {
2611 my $dbh = $self->_get_dbh;
2613 # some drivers provide a $dbh attribute (e.g. Sybase and $dbh->{syb_dynamic_supported})
2614 # but it is inaccurate more often than not
2616 local $dbh->{PrintError} = 0;
2617 local $dbh->{RaiseError} = 1;
2618 $dbh->do('select ?', {}, 1);
2626 # Check if placeholders bound to non-string types throw exceptions
2628 sub _determine_supports_typeless_placeholders {
2630 my $dbh = $self->_get_dbh;
2633 local $dbh->{PrintError} = 0;
2634 local $dbh->{RaiseError} = 1;
2635 # this specifically tests a bind that is NOT a string
2636 $dbh->do('select 1 where 1 = ?', {}, 1);
2646 Returns the database driver name.
2651 shift->_get_dbh->{Driver}->{Name};
2654 =head2 bind_attribute_by_data_type
2656 Given a datatype from column info, returns a database specific bind
2657 attribute for C<< $dbh->bind_param($val,$attribute) >> or nothing if we will
2658 let the database planner just handle it.
2660 This method is always called after the driver has been determined and a DBI
2661 connection has been established. Therefore you can refer to C<DBI::$constant>
2662 and/or C<DBD::$driver::$constant> directly, without worrying about loading
2663 the correct modules.
2667 sub bind_attribute_by_data_type {
2671 =head2 is_datatype_numeric
2673 Given a datatype from column_info, returns a boolean value indicating if
2674 the current RDBMS considers it a numeric value. This controls how
2675 L<DBIx::Class::Row/set_column> decides whether to mark the column as
2676 dirty - when the datatype is deemed numeric a C<< != >> comparison will
2677 be performed instead of the usual C<eq>.
2681 sub is_datatype_numeric {
2682 #my ($self, $dt) = @_;
2684 return 0 unless $_[1];
2687 numeric | int(?:eger)? | (?:tiny|small|medium|big)int | dec(?:imal)? | real | float | double (?: \s+ precision)? | (?:big)?serial
2692 =head2 create_ddl_dir
2696 =item Arguments: $schema, \@databases, $version, $directory, $preversion, \%sqlt_args
2700 Creates a SQL file based on the Schema, for each of the specified
2701 database engines in C<\@databases> in the given directory.
2702 (note: specify L<SQL::Translator> names, not L<DBI> driver names).
2704 Given a previous version number, this will also create a file containing
2705 the ALTER TABLE statements to transform the previous schema into the
2706 current one. Note that these statements may contain C<DROP TABLE> or
2707 C<DROP COLUMN> statements that can potentially destroy data.
2709 The file names are created using the C<ddl_filename> method below, please
2710 override this method in your schema if you would like a different file
2711 name format. For the ALTER file, the same format is used, replacing
2712 $version in the name with "$preversion-$version".
2714 See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>.
2715 The most common value for this would be C<< { add_drop_table => 1 } >>
2716 to have the SQL produced include a C<DROP TABLE> statement for each table
2717 created. For quoting purposes supply C<quote_identifiers>.
2719 If no arguments are passed, then the following default values are assumed:
2723 =item databases - ['MySQL', 'SQLite', 'PostgreSQL']
2725 =item version - $schema->schema_version
2727 =item directory - './'
2729 =item preversion - <none>
2733 By default, C<\%sqlt_args> will have
2735 { add_drop_table => 1, ignore_constraint_names => 1, ignore_index_names => 1 }
2737 merged with the hash passed in. To disable any of those features, pass in a
2738 hashref like the following
2740 { ignore_constraint_names => 0, # ... other options }
2743 WARNING: You are strongly advised to check all SQL files created, before applying
2748 sub create_ddl_dir {
2749 my ($self, $schema, $databases, $version, $dir, $preversion, $sqltargs) = @_;
2752 carp "No directory given, using ./\n";
2757 (require File::Path and File::Path::mkpath (["$dir"])) # mkpath does not like objects (i.e. Path::Class::Dir)
2759 $self->throw_exception(
2760 "Failed to create '$dir': " . ($! || $@ || 'error unknown')
2764 $self->throw_exception ("Directory '$dir' does not exist\n") unless(-d $dir);
2766 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
2767 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
2769 my $schema_version = $schema->schema_version || '1.x';
2770 $version ||= $schema_version;
2773 add_drop_table => 1,
2774 ignore_constraint_names => 1,
2775 ignore_index_names => 1,
2779 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
2780 $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2783 my $sqlt = SQL::Translator->new( $sqltargs );
2785 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
2786 my $sqlt_schema = $sqlt->translate({ data => $schema })
2787 or $self->throw_exception ($sqlt->error);
2789 foreach my $db (@$databases) {
2791 $sqlt->{schema} = $sqlt_schema;
2792 $sqlt->producer($db);
2795 my $filename = $schema->ddl_filename($db, $version, $dir);
2796 if (-e $filename && ($version eq $schema_version )) {
2797 # if we are dumping the current version, overwrite the DDL
2798 carp "Overwriting existing DDL file - $filename";
2802 my $output = $sqlt->translate;
2804 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
2807 if(!open($file, ">$filename")) {
2808 $self->throw_exception("Can't open $filename for writing ($!)");
2811 print $file $output;
2814 next unless ($preversion);
2816 require SQL::Translator::Diff;
2818 my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
2819 if(!-e $prefilename) {
2820 carp("No previous schema file found ($prefilename)");
2824 my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
2826 carp("Overwriting existing diff file - $difffile");
2832 my $t = SQL::Translator->new($sqltargs);
2837 or $self->throw_exception ($t->error);
2839 my $out = $t->translate( $prefilename )
2840 or $self->throw_exception ($t->error);
2842 $source_schema = $t->schema;
2844 $source_schema->name( $prefilename )
2845 unless ( $source_schema->name );
2848 # The "new" style of producers have sane normalization and can support
2849 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
2850 # And we have to diff parsed SQL against parsed SQL.
2851 my $dest_schema = $sqlt_schema;
2853 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
2854 my $t = SQL::Translator->new($sqltargs);
2859 or $self->throw_exception ($t->error);
2861 my $out = $t->translate( $filename )
2862 or $self->throw_exception ($t->error);
2864 $dest_schema = $t->schema;
2866 $dest_schema->name( $filename )
2867 unless $dest_schema->name;
2870 my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
2874 if(!open $file, ">$difffile") {
2875 $self->throw_exception("Can't write to $difffile ($!)");
2883 =head2 deployment_statements
2887 =item Arguments: $schema, $type, $version, $directory, $sqlt_args
2891 Returns the statements used by L</deploy> and L<DBIx::Class::Schema/deploy>.
2893 The L<SQL::Translator> (not L<DBI>) database driver name can be explicitly
2894 provided in C<$type>, otherwise the result of L</sqlt_type> is used as default.
2896 C<$directory> is used to return statements from files in a previously created
2897 L</create_ddl_dir> directory and is optional. The filenames are constructed
2898 from L<DBIx::Class::Schema/ddl_filename>, the schema name and the C<$version>.
2900 If no C<$directory> is specified then the statements are constructed on the
2901 fly using L<SQL::Translator> and C<$version> is ignored.
2903 See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>.
2907 sub deployment_statements {
2908 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
2909 $type ||= $self->sqlt_type;
2910 $version ||= $schema->schema_version || '1.x';
2912 my $filename = $schema->ddl_filename($type, $version, $dir);
2915 # FIXME replace this block when a proper sane sql parser is available
2917 open($file, "<$filename")
2918 or $self->throw_exception("Can't open $filename ($!)");
2921 return join('', @rows);
2924 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy') ) {
2925 $self->throw_exception("Can't deploy without a ddl_dir or " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
2928 # sources needs to be a parser arg, but for simplicty allow at top level
2930 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
2931 if exists $sqltargs->{sources};
2933 my $tr = SQL::Translator->new(
2934 producer => "SQL::Translator::Producer::${type}",
2936 parser => 'SQL::Translator::Parser::DBIx::Class',
2940 return preserve_context {
2943 $self->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
2944 unless defined $_[0];
2948 # FIXME deploy() currently does not accurately report sql errors
2949 # Will always return true while errors are warned
2951 my ($self, $schema, $type, $sqltargs, $dir) = @_;
2955 return if($line =~ /^--/);
2956 # next if($line =~ /^DROP/m);
2957 return if($line =~ /^BEGIN TRANSACTION/m);
2958 return if($line =~ /^COMMIT/m);
2959 return if $line =~ /^\s+$/; # skip whitespace only
2960 $self->_query_start($line);
2962 # do a dbh_do cycle here, as we need some error checking in
2963 # place (even though we will ignore errors)
2964 $self->dbh_do (sub { $_[1]->do($line) });
2966 carp qq{$_ (running "${line}")};
2968 $self->_query_end($line);
2970 my @statements = $schema->deployment_statements($type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
2971 if (@statements > 1) {
2972 foreach my $statement (@statements) {
2973 $deploy->( $statement );
2976 elsif (@statements == 1) {
2977 # split on single line comments and end of statements
2978 foreach my $line ( split(/\s*--.*\n|;\n/, $statements[0])) {
2984 =head2 datetime_parser
2986 Returns the datetime parser class
2990 sub datetime_parser {
2992 return $self->{datetime_parser} ||= do {
2993 $self->build_datetime_parser(@_);
2997 =head2 datetime_parser_type
2999 Defines the datetime parser class - currently defaults to L<DateTime::Format::MySQL>
3001 =head2 build_datetime_parser
3003 See L</datetime_parser>
3007 sub build_datetime_parser {
3009 my $type = $self->datetime_parser_type(@_);
3014 =head2 is_replicating
3016 A boolean that reports if a particular L<DBIx::Class::Storage::DBI> is set to
3017 replicate from a master database. Default is undef, which is the result
3018 returned by databases that don't support replication.
3022 sub is_replicating {
3027 =head2 lag_behind_master
3029 Returns a number that represents a certain amount of lag behind a master db
3030 when a given storage is replicating. The number is database dependent, but
3031 starts at zero and increases with the amount of lag. Default in undef
3035 sub lag_behind_master {
3039 =head2 relname_to_table_alias
3043 =item Arguments: $relname, $join_count
3045 =item Return Value: $alias
3049 L<DBIx::Class> uses L<DBIx::Class::Relationship> names as table aliases in
3052 This hook is to allow specific L<DBIx::Class::Storage> drivers to change the
3053 way these aliases are named.
3055 The default behavior is C<< "$relname_$join_count" if $join_count > 1 >>,
3056 otherwise C<"$relname">.
3060 sub relname_to_table_alias {
3061 my ($self, $relname, $join_count) = @_;
3063 my $alias = ($join_count && $join_count > 1 ?
3064 join('_', $relname, $join_count) : $relname);
3069 # The size in bytes to use for DBI's ->bind_param_inout, this is the generic
3070 # version and it may be necessary to amend or override it for a specific storage
3071 # if such binds are necessary.
3072 sub _max_column_bytesize {
3073 my ($self, $attr) = @_;
3077 if ($attr->{sqlt_datatype}) {
3078 my $data_type = lc($attr->{sqlt_datatype});
3080 if ($attr->{sqlt_size}) {
3082 # String/sized-binary types
3083 if ($data_type =~ /^(?:
3084 l? (?:var)? char(?:acter)? (?:\s*varying)?
3086 (?:var)? binary (?:\s*varying)?
3091 $max_size = $attr->{sqlt_size};
3093 # Other charset/unicode types, assume scale of 4
3094 elsif ($data_type =~ /^(?:
3095 national \s* character (?:\s*varying)?
3104 $max_size = $attr->{sqlt_size} * 4;
3108 if (!$max_size and !$self->_is_lob_type($data_type)) {
3109 $max_size = 100 # for all other (numeric?) datatypes
3113 $max_size || $self->_dbic_connect_attributes->{LongReadLen} || $self->_get_dbh->{LongReadLen} || 8000;
3116 # Determine if a data_type is some type of BLOB
3118 my ($self, $data_type) = @_;
3119 $data_type && ($data_type =~ /lob|bfile|text|image|bytea|memo/i
3120 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary
3121 |varchar|character\s*varying|nvarchar
3122 |national\s*character\s*varying))?\z/xi);
3125 sub _is_binary_lob_type {
3126 my ($self, $data_type) = @_;
3127 $data_type && ($data_type =~ /blob|bfile|image|bytea/i
3128 || $data_type =~ /^long(?:\s+(?:raw|bit\s*varying|varbit|binary))?\z/xi);
3131 sub _is_text_lob_type {
3132 my ($self, $data_type) = @_;
3133 $data_type && ($data_type =~ /^(?:clob|memo)\z/i
3134 || $data_type =~ /^long(?:\s+(?:varchar|character\s*varying|nvarchar
3135 |national\s*character\s*varying))\z/xi);
3138 # Determine if a data_type is some type of a binary type
3139 sub _is_binary_type {
3140 my ($self, $data_type) = @_;
3141 $data_type && ($self->_is_binary_lob_type($data_type)
3142 || $data_type =~ /(?:var)?(?:binary|bit|graphic)(?:\s*varying)?/i);
3149 =head2 DBIx::Class and AutoCommit
3151 DBIx::Class can do some wonderful magic with handling exceptions,
3152 disconnections, and transactions when you use C<< AutoCommit => 1 >>
3153 (the default) combined with L<txn_do|DBIx::Class::Storage/txn_do> for
3154 transaction support.
3156 If you set C<< AutoCommit => 0 >> in your connect info, then you are always
3157 in an assumed transaction between commits, and you're telling us you'd
3158 like to manage that manually. A lot of the magic protections offered by
3159 this module will go away. We can't protect you from exceptions due to database
3160 disconnects because we don't know anything about how to restart your
3161 transactions. You're on your own for handling all sorts of exceptional
3162 cases if you choose the C<< AutoCommit => 0 >> path, just as you would
3166 =head1 AUTHOR AND CONTRIBUTORS
3168 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
3172 You may distribute this code under the same terms as Perl itself.